server/lib/live/live-manager.ts

   1
   2 import { readdir, readFile } from 'fs-extra'
   3 import { createServer, Server } from 'net'
   4 import { join } from 'path'
   5 import { createServer as createServerTLS, Server as ServerTLS } from 'tls'
   6 import {
   7   computeLowerResolutionsToTranscode,
   8   ffprobePromise,
   9   getLiveSegmentTime,
  10   getVideoStreamBitrate,
  11   getVideoStreamDimensionsInfo,
  12   getVideoStreamFPS
  13 } from '@server/helpers/ffmpeg'
  14 import { logger, loggerTagsFactory } from '@server/helpers/logger'
  15 import { CONFIG, registerConfigChangedHandler } from '@server/initializers/config'
  16 import { P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE } from '@server/initializers/constants'
  17 import { UserModel } from '@server/models/user/user'
  18 import { VideoModel } from '@server/models/video/video'
  19 import { VideoLiveModel } from '@server/models/video/video-live'
  20 import { VideoLiveSessionModel } from '@server/models/video/video-live-session'
  21 import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist'
  22 import { MStreamingPlaylistVideo, MVideo, MVideoLiveSession, MVideoLiveVideo } from '@server/types/models'
  23 import { wait } from '@shared/core-utils'
  24 import { LiveVideoError, VideoState, VideoStreamingPlaylistType } from '@shared/models'
  25 import { federateVideoIfNeeded } from '../activitypub/videos'
  26 import { JobQueue } from '../job-queue'
  27 import { generateHLSMasterPlaylistFilename, generateHlsSha256SegmentsFilename, getLiveReplayBaseDirectory } from '../paths'
  28 import { PeerTubeSocket } from '../peertube-socket'
  29 import { LiveQuotaStore } from './live-quota-store'
  30 import { LiveSegmentShaStore } from './live-segment-sha-store'
  31 import { cleanupPermanentLive } from './live-utils'
  32 import { MuxingSession } from './shared'
  33
  34 const NodeRtmpSession = require('node-media-server/src/node_rtmp_session')
  35 const context = require('node-media-server/src/node_core_ctx')
  36 const nodeMediaServerLogger = require('node-media-server/src/node_core_logger')
  37
  38 // Disable node media server logs
  39 nodeMediaServerLogger.setLogType(0)
  40
  41 const config = {
  42   rtmp: {
  43     port: CONFIG.LIVE.RTMP.PORT,
  44     chunk_size: VIDEO_LIVE.RTMP.CHUNK_SIZE,
  45     gop_cache: VIDEO_LIVE.RTMP.GOP_CACHE,
  46     ping: VIDEO_LIVE.RTMP.PING,
  47     ping_timeout: VIDEO_LIVE.RTMP.PING_TIMEOUT
  48   }
  49 }
  50
  51 const lTags = loggerTagsFactory('live')
  52
  53 class LiveManager {
  54
  55   private static instance: LiveManager
  56
  57   private readonly muxingSessions = new Map<string, MuxingSession>()
  58   private readonly videoSessions = new Map<number, string>()
  59
  60   private rtmpServer: Server
  61   private rtmpsServer: ServerTLS
  62
  63   private running = false
  64
  65   private constructor () {
  66   }
  67
  68   init () {
  69     const events = this.getContext().nodeEvent
  70     events.on('postPublish', (sessionId: string, streamPath: string) => {
  71       logger.debug('RTMP received stream', { id: sessionId, streamPath, ...lTags(sessionId) })
  72
  73       const splittedPath = streamPath.split('/')
  74       if (splittedPath.length !== 3 || splittedPath[1] !== VIDEO_LIVE.RTMP.BASE_PATH) {
  75         logger.warn('Live path is incorrect.', { streamPath, ...lTags(sessionId) })
  76         return this.abortSession(sessionId)
  77       }
  78
  79       const session = this.getContext().sessions.get(sessionId)
  80
  81       this.handleSession(sessionId, session.inputOriginUrl + streamPath, splittedPath[2])
  82         .catch(err => logger.error('Cannot handle sessions.', { err, ...lTags(sessionId) }))
  83     })
  84
  85     events.on('donePublish', sessionId => {
  86       logger.info('Live session ended.', { sessionId, ...lTags(sessionId) })
  87     })
  88
  89     registerConfigChangedHandler(() => {
  90       if (!this.running && CONFIG.LIVE.ENABLED === true) {
  91         this.run().catch(err => logger.error('Cannot run live server.', { err }))
  92         return
  93       }
  94
  95       if (this.running && CONFIG.LIVE.ENABLED === false) {
  96         this.stop()
  97       }
  98     })
  99
 100     // Cleanup broken lives, that were terminated by a server restart for example
 101     this.handleBrokenLives()
 102       .catch(err => logger.error('Cannot handle broken lives.', { err, ...lTags() }))
 103   }
 104
 105   async run () {
 106     this.running = true
 107
 108     if (CONFIG.LIVE.RTMP.ENABLED) {
 109       logger.info('Running RTMP server on port %d', CONFIG.LIVE.RTMP.PORT, lTags())
 110
 111       this.rtmpServer = createServer(socket => {
 112         const session = new NodeRtmpSession(config, socket)
 113
 114         session.inputOriginUrl = 'rtmp://127.0.0.1:' + CONFIG.LIVE.RTMP.PORT
 115         session.run()
 116       })
 117
 118       this.rtmpServer.on('error', err => {
 119         logger.error('Cannot run RTMP server.', { err, ...lTags() })
 120       })
 121
 122       this.rtmpServer.listen(CONFIG.LIVE.RTMP.PORT, CONFIG.LIVE.RTMP.HOSTNAME)
 123     }
 124
 125     if (CONFIG.LIVE.RTMPS.ENABLED) {
 126       logger.info('Running RTMPS server on port %d', CONFIG.LIVE.RTMPS.PORT, lTags())
 127
 128       const [ key, cert ] = await Promise.all([
 129         readFile(CONFIG.LIVE.RTMPS.KEY_FILE),
 130         readFile(CONFIG.LIVE.RTMPS.CERT_FILE)
 131       ])
 132       const serverOptions = { key, cert }
 133
 134       this.rtmpsServer = createServerTLS(serverOptions, socket => {
 135         const session = new NodeRtmpSession(config, socket)
 136
 137         session.inputOriginUrl = 'rtmps://127.0.0.1:' + CONFIG.LIVE.RTMPS.PORT
 138         session.run()
 139       })
 140
 141       this.rtmpsServer.on('error', err => {
 142         logger.error('Cannot run RTMPS server.', { err, ...lTags() })
 143       })
 144
 145       this.rtmpsServer.listen(CONFIG.LIVE.RTMPS.PORT, CONFIG.LIVE.RTMPS.HOSTNAME)
 146     }
 147   }
 148
 149   stop () {
 150     this.running = false
 151
 152     if (this.rtmpServer) {
 153       logger.info('Stopping RTMP server.', lTags())
 154
 155       this.rtmpServer.close()
 156       this.rtmpServer = undefined
 157     }
 158
 159     if (this.rtmpsServer) {
 160       logger.info('Stopping RTMPS server.', lTags())
 161
 162       this.rtmpsServer.close()
 163       this.rtmpsServer = undefined
 164     }
 165
 166     // Sessions is an object
 167     this.getContext().sessions.forEach((session: any) => {
 168       if (session instanceof NodeRtmpSession) {
 169         session.stop()
 170       }
 171     })
 172   }
 173
 174   isRunning () {
 175     return !!this.rtmpServer
 176   }
 177
 178   stopSessionOf (videoId: number, error: LiveVideoError | null) {
 179     const sessionId = this.videoSessions.get(videoId)
 180     if (!sessionId) return
 181
 182     this.saveEndingSession(videoId, error)
 183       .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
 184
 185     this.videoSessions.delete(videoId)
 186     this.abortSession(sessionId)
 187   }
 188
 189   private getContext () {
 190     return context
 191   }
 192
 193   private abortSession (sessionId: string) {
 194     const session = this.getContext().sessions.get(sessionId)
 195     if (session) {
 196       session.stop()
 197       this.getContext().sessions.delete(sessionId)
 198     }
 199
 200     const muxingSession = this.muxingSessions.get(sessionId)
 201     if (muxingSession) {
 202       // Muxing session will fire and event so we correctly cleanup the session
 203       muxingSession.abort()
 204
 205       this.muxingSessions.delete(sessionId)
 206     }
 207   }
 208
 209   private async handleSession (sessionId: string, inputUrl: string, streamKey: string) {
 210     const videoLive = await VideoLiveModel.loadByStreamKey(streamKey)
 211     if (!videoLive) {
 212       logger.warn('Unknown live video with stream key %s.', streamKey, lTags(sessionId))
 213       return this.abortSession(sessionId)
 214     }
 215
 216     const video = videoLive.Video
 217     if (video.isBlacklisted()) {
 218       logger.warn('Video is blacklisted. Refusing stream %s.', streamKey, lTags(sessionId, video.uuid))
 219       return this.abortSession(sessionId)
 220     }
 221
 222     // Cleanup old potential live files (could happen with a permanent live)
 223     LiveSegmentShaStore.Instance.cleanupShaSegments(video.uuid)
 224
 225     const oldStreamingPlaylist = await VideoStreamingPlaylistModel.loadHLSPlaylistByVideo(video.id)
 226     if (oldStreamingPlaylist) {
 227       if (!videoLive.permanentLive) throw new Error('Found previous session in a non permanent live: ' + video.uuid)
 228
 229       await cleanupPermanentLive(video, oldStreamingPlaylist)
 230     }
 231
 232     this.videoSessions.set(video.id, sessionId)
 233
 234     const now = Date.now()
 235     const probe = await ffprobePromise(inputUrl)
 236
 237     const [ { resolution, ratio }, fps, bitrate ] = await Promise.all([
 238       getVideoStreamDimensionsInfo(inputUrl, probe),
 239       getVideoStreamFPS(inputUrl, probe),
 240       getVideoStreamBitrate(inputUrl, probe)
 241     ])
 242
 243     logger.info(
 244       '%s probing took %d ms (bitrate: %d, fps: %d, resolution: %d)',
 245       inputUrl, Date.now() - now, bitrate, fps, resolution, lTags(sessionId, video.uuid)
 246     )
 247
 248     const allResolutions = this.buildAllResolutionsToTranscode(resolution)
 249
 250     logger.info(
 251       'Will mux/transcode live video of original resolution %d.', resolution,
 252       { allResolutions, ...lTags(sessionId, video.uuid) }
 253     )
 254
 255     const streamingPlaylist = await this.createLivePlaylist(video, allResolutions)
 256
 257     return this.runMuxingSession({
 258       sessionId,
 259       videoLive,
 260       streamingPlaylist,
 261       inputUrl,
 262       fps,
 263       bitrate,
 264       ratio,
 265       allResolutions
 266     })
 267   }
 268
 269   private async runMuxingSession (options: {
 270     sessionId: string
 271     videoLive: MVideoLiveVideo
 272     streamingPlaylist: MStreamingPlaylistVideo
 273     inputUrl: string
 274     fps: number
 275     bitrate: number
 276     ratio: number
 277     allResolutions: number[]
 278   }) {
 279     const { sessionId, videoLive, streamingPlaylist, allResolutions, fps, bitrate, ratio, inputUrl } = options
 280     const videoUUID = videoLive.Video.uuid
 281     const localLTags = lTags(sessionId, videoUUID)
 282
 283     const liveSession = await this.saveStartingSession(videoLive)
 284
 285     const user = await UserModel.loadByLiveId(videoLive.id)
 286     LiveQuotaStore.Instance.addNewLive(user.id, videoLive.id)
 287
 288     const muxingSession = new MuxingSession({
 289       context: this.getContext(),
 290       user,
 291       sessionId,
 292       videoLive,
 293       streamingPlaylist,
 294       inputUrl,
 295       bitrate,
 296       ratio,
 297       fps,
 298       allResolutions
 299     })
 300
 301     muxingSession.on('master-playlist-created', () => this.publishAndFederateLive(videoLive, localLTags))
 302
 303     muxingSession.on('bad-socket-health', ({ videoId }) => {
 304       logger.error(
 305         'Too much data in client socket stream (ffmpeg is too slow to transcode the video).' +
 306         ' Stopping session of video %s.', videoUUID,
 307         localLTags
 308       )
 309
 310       this.stopSessionOf(videoId, LiveVideoError.BAD_SOCKET_HEALTH)
 311     })
 312
 313     muxingSession.on('duration-exceeded', ({ videoId }) => {
 314       logger.info('Stopping session of %s: max duration exceeded.', videoUUID, localLTags)
 315
 316       this.stopSessionOf(videoId, LiveVideoError.DURATION_EXCEEDED)
 317     })
 318
 319     muxingSession.on('quota-exceeded', ({ videoId }) => {
 320       logger.info('Stopping session of %s: user quota exceeded.', videoUUID, localLTags)
 321
 322       this.stopSessionOf(videoId, LiveVideoError.QUOTA_EXCEEDED)
 323     })
 324
 325     muxingSession.on('ffmpeg-error', ({ videoId }) => {
 326       this.stopSessionOf(videoId, LiveVideoError.FFMPEG_ERROR)
 327     })
 328
 329     muxingSession.on('ffmpeg-end', ({ videoId }) => {
 330       this.onMuxingFFmpegEnd(videoId, sessionId)
 331     })
 332
 333     muxingSession.on('after-cleanup', ({ videoId }) => {
 334       this.muxingSessions.delete(sessionId)
 335
 336       LiveQuotaStore.Instance.removeLive(user.id, videoLive.id)
 337
 338       muxingSession.destroy()
 339
 340       return this.onAfterMuxingCleanup({ videoId, liveSession })
 341         .catch(err => logger.error('Error in end transmuxing.', { err, ...localLTags }))
 342     })
 343
 344     this.muxingSessions.set(sessionId, muxingSession)
 345
 346     muxingSession.runMuxing()
 347       .catch(err => {
 348         logger.error('Cannot run muxing.', { err, ...localLTags })
 349         this.abortSession(sessionId)
 350       })
 351   }
 352
 353   private async publishAndFederateLive (live: MVideoLiveVideo, localLTags: { tags: string[] }) {
 354     const videoId = live.videoId
 355
 356     try {
 357       const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
 358
 359       logger.info('Will publish and federate live %s.', video.url, localLTags)
 360
 361       video.state = VideoState.PUBLISHED
 362       video.publishedAt = new Date()
 363       await video.save()
 364
 365       live.Video = video
 366
 367       await wait(getLiveSegmentTime(live.latencyMode) * 1000 * VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION)
 368
 369       try {
 370         await federateVideoIfNeeded(video, false)
 371       } catch (err) {
 372         logger.error('Cannot federate live video %s.', video.url, { err, ...localLTags })
 373       }
 374
 375       PeerTubeSocket.Instance.sendVideoLiveNewState(video)
 376     } catch (err) {
 377       logger.error('Cannot save/federate live video %d.', videoId, { err, ...localLTags })
 378     }
 379   }
 380
 381   private onMuxingFFmpegEnd (videoId: number, sessionId: string) {
 382     this.videoSessions.delete(videoId)
 383
 384     this.saveEndingSession(videoId, null)
 385       .catch(err => logger.error('Cannot save ending session.', { err, ...lTags(sessionId) }))
 386   }
 387
 388   private async onAfterMuxingCleanup (options: {
 389     videoId: number | string
 390     liveSession?: MVideoLiveSession
 391     cleanupNow?: boolean // Default false
 392   }) {
 393     const { videoId, liveSession: liveSessionArg, cleanupNow = false } = options
 394
 395     try {
 396       const fullVideo = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
 397       if (!fullVideo) return
 398
 399       const live = await VideoLiveModel.loadByVideoId(fullVideo.id)
 400
 401       const liveSession = liveSessionArg ?? await VideoLiveSessionModel.findCurrentSessionOf(fullVideo.id)
 402
 403       // On server restart during a live
 404       if (!liveSession.endDate) {
 405         liveSession.endDate = new Date()
 406         await liveSession.save()
 407       }
 408
 409       JobQueue.Instance.createJob({
 410         type: 'video-live-ending',
 411         payload: {
 412           videoId: fullVideo.id,
 413
 414           replayDirectory: live.saveReplay
 415             ? await this.findReplayDirectory(fullVideo)
 416             : undefined,
 417
 418           liveSessionId: liveSession.id,
 419           streamingPlaylistId: fullVideo.getHLSPlaylist()?.id,
 420
 421           publishedAt: fullVideo.publishedAt.toISOString()
 422         }
 423       }, { delay: cleanupNow ? 0 : VIDEO_LIVE.CLEANUP_DELAY })
 424
 425       fullVideo.state = live.permanentLive
 426         ? VideoState.WAITING_FOR_LIVE
 427         : VideoState.LIVE_ENDED
 428
 429       await fullVideo.save()
 430
 431       PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo)
 432
 433       await federateVideoIfNeeded(fullVideo, false)
 434     } catch (err) {
 435       logger.error('Cannot save/federate new video state of live streaming of video %d.', videoId, { err, ...lTags(videoId + '') })
 436     }
 437   }
 438
 439   private async handleBrokenLives () {
 440     const videoUUIDs = await VideoModel.listPublishedLiveUUIDs()
 441
 442     for (const uuid of videoUUIDs) {
 443       await this.onAfterMuxingCleanup({ videoId: uuid, cleanupNow: true })
 444     }
 445   }
 446
 447   private async findReplayDirectory (video: MVideo) {
 448     const directory = getLiveReplayBaseDirectory(video)
 449     const files = await readdir(directory)
 450
 451     if (files.length === 0) return undefined
 452
 453     return join(directory, files.sort().reverse()[0])
 454   }
 455
 456   private buildAllResolutionsToTranscode (originResolution: number) {
 457     const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED
 458       ? computeLowerResolutionsToTranscode(originResolution, 'live')
 459       : []
 460
 461     return resolutionsEnabled.concat([ originResolution ])
 462   }
 463
 464   private async createLivePlaylist (video: MVideo, allResolutions: number[]): Promise<MStreamingPlaylistVideo> {
 465     const playlist = await VideoStreamingPlaylistModel.loadOrGenerate(video)
 466
 467     playlist.playlistFilename = generateHLSMasterPlaylistFilename(true)
 468     playlist.segmentsSha256Filename = generateHlsSha256SegmentsFilename(true)
 469
 470     playlist.p2pMediaLoaderPeerVersion = P2P_MEDIA_LOADER_PEER_VERSION
 471     playlist.type = VideoStreamingPlaylistType.HLS
 472
 473     playlist.assignP2PMediaLoaderInfoHashes(video, allResolutions)
 474
 475     return playlist.save()
 476   }
 477
 478   private saveStartingSession (videoLive: MVideoLiveVideo) {
 479     const liveSession = new VideoLiveSessionModel({
 480       startDate: new Date(),
 481       liveVideoId: videoLive.videoId
 482     })
 483
 484     return liveSession.save()
 485   }
 486
 487   private async saveEndingSession (videoId: number, error: LiveVideoError | null) {
 488     const liveSession = await VideoLiveSessionModel.findCurrentSessionOf(videoId)
 489     liveSession.endDate = new Date()
 490     liveSession.error = error
 491
 492     return liveSession.save()
 493   }
 494
 495   static get Instance () {
 496     return this.instance || (this.instance = new this())
 497   }
 498 }
 499
 500 // ---------------------------------------------------------------------------
 501
 502 export {
 503   LiveManager
 504 }