123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516 |
- import { readdir, readFile } from 'fs-extra'
- import { createServer, Server } from 'net'
- import { join } from 'path'
- import { createServer as createServerTLS, Server as ServerTLS } from 'tls'
- import {
- computeResolutionsToTranscode,
- ffprobePromise,
- getLiveSegmentTime,
- getVideoStreamBitrate,
- getVideoStreamDimensionsInfo,
- getVideoStreamFPS
- } from '@server/helpers/ffmpeg'
- import { logger, loggerTagsFactory } from '@server/helpers/logger'
- import { CONFIG, registerConfigChangedHandler } from '@server/initializers/config'
- import { P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE } from '@server/initializers/constants'
- import { UserModel } from '@server/models/user/user'
- import { VideoModel } from '@server/models/video/video'
- import { VideoLiveModel } from '@server/models/video/video-live'
- import { VideoLiveSessionModel } from '@server/models/video/video-live-session'
- import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist'
- import { MStreamingPlaylistVideo, MVideo, MVideoLiveSession, MVideoLiveVideo } from '@server/types/models'
- import { wait } from '@shared/core-utils'
- import { LiveVideoError, VideoState, VideoStreamingPlaylistType } from '@shared/models'
- import { federateVideoIfNeeded } from '../activitypub/videos'
- import { JobQueue } from '../job-queue'
- import { generateHLSMasterPlaylistFilename, generateHlsSha256SegmentsFilename, getLiveReplayBaseDirectory } from '../paths'
- import { PeerTubeSocket } from '../peertube-socket'
- import { Hooks } from '../plugins/hooks'
- import { LiveQuotaStore } from './live-quota-store'
- import { cleanupPermanentLive } from './live-utils'
- import { MuxingSession } from './shared'
- const NodeRtmpSession = require('node-media-server/src/node_rtmp_session')
- const context = require('node-media-server/src/node_core_ctx')
- const nodeMediaServerLogger = require('node-media-server/src/node_core_logger')
- // Disable node media server logs
- nodeMediaServerLogger.setLogType(0)
- const config = {
- rtmp: {
- port: CONFIG.LIVE.RTMP.PORT,
- chunk_size: VIDEO_LIVE.RTMP.CHUNK_SIZE,
- gop_cache: VIDEO_LIVE.RTMP.GOP_CACHE,
- ping: VIDEO_LIVE.RTMP.PING,
- ping_timeout: VIDEO_LIVE.RTMP.PING_TIMEOUT
- }
- }
- const lTags = loggerTagsFactory('live')
- class LiveManager {
- private static instance: LiveManager
- private readonly muxingSessions = new Map<string, MuxingSession>()
- private readonly videoSessions = new Map<number, string>()
- private rtmpServer: Server
- private rtmpsServer: ServerTLS
- private running = false
- private constructor () {
- }
- init () {
- const events = this.getContext().nodeEvent
- events.on('postPublish', (sessionId: string, streamPath: string) => {
- logger.debug('RTMP received stream', { id: sessionId, streamPath, ...lTags(sessionId) })
- const splittedPath = streamPath.split('/')
- if (splittedPath.length !== 3 || splittedPath[1] !== VIDEO_LIVE.RTMP.BASE_PATH) {
- logger.warn('Live path is incorrect.', { streamPath, ...lTags(sessionId) })
- return this.abortSession(sessionId)
- }
- const session = this.getContext().sessions.get(sessionId)
- this.handleSession(sessionId, session.inputOriginUrl + streamPath, splittedPath[2])
- .catch(err => logger.error('Cannot handle sessions.', { err, ...lTags(sessionId) }))
- })
- events.on('donePublish', sessionId => {
- logger.info('Live session ended.', { sessionId, ...lTags(sessionId) })
- })
- registerConfigChangedHandler(() => {
- if (!this.running && CONFIG.LIVE.ENABLED === true) {
- this.run().catch(err => logger.error('Cannot run live server.', { err }))
- return
- }
- if (this.running && CONFIG.LIVE.ENABLED === false) {
- this.stop()
- }
- })
- // Cleanup broken lives, that were terminated by a server restart for example
- this.handleBrokenLives()
- .catch(err => logger.error('Cannot handle broken lives.', { err, ...lTags() }))
- }
- async run () {
- this.running = true
- if (CONFIG.LIVE.RTMP.ENABLED) {
- logger.info('Running RTMP server on port %d', CONFIG.LIVE.RTMP.PORT, lTags())
- this.rtmpServer = createServer(socket => {
- const session = new NodeRtmpSession(config, socket)
- session.inputOriginUrl = 'rtmp://127.0.0.1:' + CONFIG.LIVE.RTMP.PORT
- session.run()
- })
- this.rtmpServer.on('error', err => {
- logger.error('Cannot run RTMP server.', { err, ...lTags() })
- })
- this.rtmpServer.listen(CONFIG.LIVE.RTMP.PORT, CONFIG.LIVE.RTMP.HOSTNAME)
- }
- if (CONFIG.LIVE.RTMPS.ENABLED) {
- logger.info('Running RTMPS server on port %d', CONFIG.LIVE.RTMPS.PORT, lTags())
- const [ key, cert ] = await Promise.all([
- readFile(CONFIG.LIVE.RTMPS.KEY_FILE),
- readFile(CONFIG.LIVE.RTMPS.CERT_FILE)
- ])
- const serverOptions = { key, cert }
- this.rtmpsServer = createServerTLS(serverOptions, socket => {
- const session = new NodeRtmpSession(config, socket)
- session.inputOriginUrl = 'rtmps://127.0.0.1:' + CONFIG.LIVE.RTMPS.PORT
- session.run()
- })
- this.rtmpsServer.on('error', err => {
- logger.error('Cannot run RTMPS server.', { err, ...lTags() })
- })
- this.rtmpsServer.listen(CONFIG.LIVE.RTMPS.PORT, CONFIG.LIVE.RTMPS.HOSTNAME)
- }
- }
- stop () {
- this.running = false
- if (this.rtmpServer) {
- logger.info('Stopping RTMP server.', lTags())
- this.rtmpServer.close()
- this.rtmpServer = undefined
- }
- if (this.rtmpsServer) {
- logger.info('Stopping RTMPS server.', lTags())
- this.rtmpsServer.close()
- this.rtmpsServer = undefined
- }
- // Sessions is an object
- this.getContext().sessions.forEach((session: any) => {
- if (session instanceof NodeRtmpSession) {
- session.stop()
- }
- })
- }
- isRunning () {
- return !!this.rtmpServer
- }
- stopSessionOf (videoId: number, error: LiveVideoError | null) {
- const sessionId = this.videoSessions.get(videoId)
- if (!sessionId) return
- this.saveEndingSession(videoId, error)
- .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
- this.videoSessions.delete(videoId)
- this.abortSession(sessionId)
- }
- private getContext () {
- return context
- }
- private abortSession (sessionId: string) {
- const session = this.getContext().sessions.get(sessionId)
- if (session) {
- session.stop()
- this.getContext().sessions.delete(sessionId)
- }
- const muxingSession = this.muxingSessions.get(sessionId)
- if (muxingSession) {
- // Muxing session will fire and event so we correctly cleanup the session
- muxingSession.abort()
- this.muxingSessions.delete(sessionId)
- }
- }
- private async handleSession (sessionId: string, inputUrl: string, streamKey: string) {
- const videoLive = await VideoLiveModel.loadByStreamKey(streamKey)
- if (!videoLive) {
- logger.warn('Unknown live video with stream key %s.', streamKey, lTags(sessionId))
- return this.abortSession(sessionId)
- }
- const video = videoLive.Video
- if (video.isBlacklisted()) {
- logger.warn('Video is blacklisted. Refusing stream %s.', streamKey, lTags(sessionId, video.uuid))
- return this.abortSession(sessionId)
- }
- // Cleanup old potential live (could happen with a permanent live)
- const oldStreamingPlaylist = await VideoStreamingPlaylistModel.loadHLSPlaylistByVideo(video.id)
- if (oldStreamingPlaylist) {
- if (!videoLive.permanentLive) throw new Error('Found previous session in a non permanent live: ' + video.uuid)
- await cleanupPermanentLive(video, oldStreamingPlaylist)
- }
- this.videoSessions.set(video.id, sessionId)
- const now = Date.now()
- const probe = await ffprobePromise(inputUrl)
- const [ { resolution, ratio }, fps, bitrate ] = await Promise.all([
- getVideoStreamDimensionsInfo(inputUrl, probe),
- getVideoStreamFPS(inputUrl, probe),
- getVideoStreamBitrate(inputUrl, probe)
- ])
- logger.info(
- '%s probing took %d ms (bitrate: %d, fps: %d, resolution: %d)',
- inputUrl, Date.now() - now, bitrate, fps, resolution, lTags(sessionId, video.uuid)
- )
- const allResolutions = await Hooks.wrapObject(
- this.buildAllResolutionsToTranscode(resolution),
- 'filter:transcoding.auto.lower-resolutions-to-transcode.result',
- { video }
- )
- logger.info(
- 'Will mux/transcode live video of original resolution %d.', resolution,
- { allResolutions, ...lTags(sessionId, video.uuid) }
- )
- const streamingPlaylist = await this.createLivePlaylist(video, allResolutions)
- return this.runMuxingSession({
- sessionId,
- videoLive,
- streamingPlaylist,
- inputUrl,
- fps,
- bitrate,
- ratio,
- allResolutions
- })
- }
- private async runMuxingSession (options: {
- sessionId: string
- videoLive: MVideoLiveVideo
- streamingPlaylist: MStreamingPlaylistVideo
- inputUrl: string
- fps: number
- bitrate: number
- ratio: number
- allResolutions: number[]
- }) {
- const { sessionId, videoLive, streamingPlaylist, allResolutions, fps, bitrate, ratio, inputUrl } = options
- const videoUUID = videoLive.Video.uuid
- const localLTags = lTags(sessionId, videoUUID)
- const liveSession = await this.saveStartingSession(videoLive)
- const user = await UserModel.loadByLiveId(videoLive.id)
- LiveQuotaStore.Instance.addNewLive(user.id, videoLive.id)
- const muxingSession = new MuxingSession({
- context: this.getContext(),
- user,
- sessionId,
- videoLive,
- streamingPlaylist,
- inputUrl,
- bitrate,
- ratio,
- fps,
- allResolutions
- })
- muxingSession.on('master-playlist-created', () => this.publishAndFederateLive(videoLive, localLTags))
- muxingSession.on('bad-socket-health', ({ videoId }) => {
- logger.error(
- 'Too much data in client socket stream (ffmpeg is too slow to transcode the video).' +
- ' Stopping session of video %s.', videoUUID,
- localLTags
- )
- this.stopSessionOf(videoId, LiveVideoError.BAD_SOCKET_HEALTH)
- })
- muxingSession.on('duration-exceeded', ({ videoId }) => {
- logger.info('Stopping session of %s: max duration exceeded.', videoUUID, localLTags)
- this.stopSessionOf(videoId, LiveVideoError.DURATION_EXCEEDED)
- })
- muxingSession.on('quota-exceeded', ({ videoId }) => {
- logger.info('Stopping session of %s: user quota exceeded.', videoUUID, localLTags)
- this.stopSessionOf(videoId, LiveVideoError.QUOTA_EXCEEDED)
- })
- muxingSession.on('ffmpeg-error', ({ videoId }) => {
- this.stopSessionOf(videoId, LiveVideoError.FFMPEG_ERROR)
- })
- muxingSession.on('ffmpeg-end', ({ videoId }) => {
- this.onMuxingFFmpegEnd(videoId, sessionId)
- })
- muxingSession.on('after-cleanup', ({ videoId }) => {
- this.muxingSessions.delete(sessionId)
- LiveQuotaStore.Instance.removeLive(user.id, videoLive.id)
- muxingSession.destroy()
- return this.onAfterMuxingCleanup({ videoId, liveSession })
- .catch(err => logger.error('Error in end transmuxing.', { err, ...localLTags }))
- })
- this.muxingSessions.set(sessionId, muxingSession)
- muxingSession.runMuxing()
- .catch(err => {
- logger.error('Cannot run muxing.', { err, ...localLTags })
- this.abortSession(sessionId)
- })
- }
- private async publishAndFederateLive (live: MVideoLiveVideo, localLTags: { tags: string[] }) {
- const videoId = live.videoId
- try {
- const video = await VideoModel.loadFull(videoId)
- logger.info('Will publish and federate live %s.', video.url, localLTags)
- video.state = VideoState.PUBLISHED
- video.publishedAt = new Date()
- await video.save()
- live.Video = video
- await wait(getLiveSegmentTime(live.latencyMode) * 1000 * VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION)
- try {
- await federateVideoIfNeeded(video, false)
- } catch (err) {
- logger.error('Cannot federate live video %s.', video.url, { err, ...localLTags })
- }
- PeerTubeSocket.Instance.sendVideoLiveNewState(video)
- } catch (err) {
- logger.error('Cannot save/federate live video %d.', videoId, { err, ...localLTags })
- }
- }
- private onMuxingFFmpegEnd (videoId: number, sessionId: string) {
- this.videoSessions.delete(videoId)
- this.saveEndingSession(videoId, null)
- .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
- }
- private async onAfterMuxingCleanup (options: {
- videoId: number | string
- liveSession?: MVideoLiveSession
- cleanupNow?: boolean // Default false
- }) {
- const { videoId, liveSession: liveSessionArg, cleanupNow = false } = options
- try {
- const fullVideo = await VideoModel.loadFull(videoId)
- if (!fullVideo) return
- const live = await VideoLiveModel.loadByVideoId(fullVideo.id)
- const liveSession = liveSessionArg ?? await VideoLiveSessionModel.findLatestSessionOf(fullVideo.id)
- // On server restart during a live
- if (!liveSession.endDate) {
- liveSession.endDate = new Date()
- await liveSession.save()
- }
- JobQueue.Instance.createJob({
- type: 'video-live-ending',
- payload: {
- videoId: fullVideo.id,
- replayDirectory: live.saveReplay
- ? await this.findReplayDirectory(fullVideo)
- : undefined,
- liveSessionId: liveSession.id,
- streamingPlaylistId: fullVideo.getHLSPlaylist()?.id,
- publishedAt: fullVideo.publishedAt.toISOString()
- }
- }, { delay: cleanupNow ? 0 : VIDEO_LIVE.CLEANUP_DELAY })
- fullVideo.state = live.permanentLive
- ? VideoState.WAITING_FOR_LIVE
- : VideoState.LIVE_ENDED
- await fullVideo.save()
- PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo)
- await federateVideoIfNeeded(fullVideo, false)
- } catch (err) {
- logger.error('Cannot save/federate new video state of live streaming of video %d.', videoId, { err, ...lTags(videoId + '') })
- }
- }
- private async handleBrokenLives () {
- const videoUUIDs = await VideoModel.listPublishedLiveUUIDs()
- for (const uuid of videoUUIDs) {
- await this.onAfterMuxingCleanup({ videoId: uuid, cleanupNow: true })
- }
- }
- private async findReplayDirectory (video: MVideo) {
- const directory = getLiveReplayBaseDirectory(video)
- const files = await readdir(directory)
- if (files.length === 0) return undefined
- return join(directory, files.sort().reverse()[0])
- }
- private buildAllResolutionsToTranscode (originResolution: number) {
- const includeInputResolution = CONFIG.LIVE.TRANSCODING.ALWAYS_TRANSCODE_ORIGINAL_RESOLUTION
- const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED
- ? computeResolutionsToTranscode({ inputResolution: originResolution, type: 'live', includeInputResolution })
- : []
- if (resolutionsEnabled.length === 0) {
- return [ originResolution ]
- }
- return resolutionsEnabled
- }
- private async createLivePlaylist (video: MVideo, allResolutions: number[]): Promise<MStreamingPlaylistVideo> {
- const playlist = await VideoStreamingPlaylistModel.loadOrGenerate(video)
- playlist.playlistFilename = generateHLSMasterPlaylistFilename(true)
- playlist.segmentsSha256Filename = generateHlsSha256SegmentsFilename(true)
- playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION
- playlist.type = VideoStreamingPlaylistType.HLS
- playlist.assignP2PMediaLoaderInfoHashes(video, allResolutions)
- return playlist.save()
- }
- private saveStartingSession (videoLive: MVideoLiveVideo) {
- const liveSession = new VideoLiveSessionModel({
- startDate: new Date(),
- liveVideoId: videoLive.videoId,
- saveReplay: videoLive.saveReplay,
- endingProcessed: false
- })
- return liveSession.save()
- }
- private async saveEndingSession (videoId: number, error: LiveVideoError | null) {
- const liveSession = await VideoLiveSessionModel.findCurrentSessionOf(videoId)
- if (!liveSession) return
- liveSession.endDate = new Date()
- liveSession.error = error
- return liveSession.save()
- }
- static get Instance () {
- return this.instance || (this.instance = new this())
- }
- }
- // ---------------------------------------------------------------------------
- export {
- LiveManager
- }
|