server/lib/live-manager.ts

   1
   2 import * as chokidar from 'chokidar'
   3 import { FfmpegCommand } from 'fluent-ffmpeg'
   4 import { ensureDir, stat } from 'fs-extra'
   5 import { basename } from 'path'
   6 import { isTestInstance } from '@server/helpers/core-utils'
   7 import {
   8   computeResolutionsToTranscode,
   9   getVideoFileFPS,
  10   getVideoFileResolution,
  11   runLiveMuxing,
  12   runLiveTranscoding
  13 } from '@server/helpers/ffmpeg-utils'
  14 import { logger } from '@server/helpers/logger'
  15 import { CONFIG, registerConfigChangedHandler } from '@server/initializers/config'
  16 import { MEMOIZE_TTL, P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE, VIEW_LIFETIME, WEBSERVER } from '@server/initializers/constants'
  17 import { UserModel } from '@server/models/account/user'
  18 import { VideoModel } from '@server/models/video/video'
  19 import { VideoFileModel } from '@server/models/video/video-file'
  20 import { VideoLiveModel } from '@server/models/video/video-live'
  21 import { VideoStreamingPlaylistModel } from '@server/models/video/video-streaming-playlist'
  22 import { MStreamingPlaylist, MUserId, MVideoLive, MVideoLiveVideo } from '@server/types/models'
  23 import { VideoState, VideoStreamingPlaylistType } from '@shared/models'
  24 import { federateVideoIfNeeded } from './activitypub/videos'
  25 import { buildSha256Segment } from './hls'
  26 import { JobQueue } from './job-queue'
  27 import { PeerTubeSocket } from './peertube-socket'
  28 import { isAbleToUploadVideo } from './user'
  29 import { getHLSDirectory } from './video-paths'
  30
  31 import memoizee = require('memoizee')
  32 const NodeRtmpServer = require('node-media-server/node_rtmp_server')
  33 const context = require('node-media-server/node_core_ctx')
  34 const nodeMediaServerLogger = require('node-media-server/node_core_logger')
  35
  36 // Disable node media server logs
  37 nodeMediaServerLogger.setLogType(0)
  38
  39 const config = {
  40   rtmp: {
  41     port: CONFIG.LIVE.RTMP.PORT,
  42     chunk_size: VIDEO_LIVE.RTMP.CHUNK_SIZE,
  43     gop_cache: VIDEO_LIVE.RTMP.GOP_CACHE,
  44     ping: VIDEO_LIVE.RTMP.PING,
  45     ping_timeout: VIDEO_LIVE.RTMP.PING_TIMEOUT
  46   },
  47   transcoding: {
  48     ffmpeg: 'ffmpeg'
  49   }
  50 }
  51
  52 class LiveManager {
  53
  54   private static instance: LiveManager
  55
  56   private readonly transSessions = new Map<string, FfmpegCommand>()
  57   private readonly videoSessions = new Map<number, string>()
  58   // Values are Date().getTime()
  59   private readonly watchersPerVideo = new Map<number, number[]>()
  60   private readonly segmentsSha256 = new Map<string, Map<string, string>>()
  61   private readonly livesPerUser = new Map<number, { liveId: number, videoId: number, size: number }[]>()
  62
  63   private readonly isAbleToUploadVideoWithCache = memoizee((userId: number) => {
  64     return isAbleToUploadVideo(userId, 1000)
  65   }, { maxAge: MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD })
  66
  67   private rtmpServer: any
  68
  69   private constructor () {
  70   }
  71
  72   init () {
  73     const events = this.getContext().nodeEvent
  74     events.on('postPublish', (sessionId: string, streamPath: string) => {
  75       logger.debug('RTMP received stream', { id: sessionId, streamPath })
  76
  77       const splittedPath = streamPath.split('/')
  78       if (splittedPath.length !== 3 || splittedPath[1] !== VIDEO_LIVE.RTMP.BASE_PATH) {
  79         logger.warn('Live path is incorrect.', { streamPath })
  80         return this.abortSession(sessionId)
  81       }
  82
  83       this.handleSession(sessionId, streamPath, splittedPath[2])
  84         .catch(err => logger.error('Cannot handle sessions.', { err }))
  85     })
  86
  87     events.on('donePublish', sessionId => {
  88       logger.info('Live session ended.', { sessionId })
  89     })
  90
  91     registerConfigChangedHandler(() => {
  92       if (!this.rtmpServer && CONFIG.LIVE.ENABLED === true) {
  93         this.run()
  94         return
  95       }
  96
  97       if (this.rtmpServer && CONFIG.LIVE.ENABLED === false) {
  98         this.stop()
  99       }
 100     })
 101
 102     setInterval(() => this.updateLiveViews(), VIEW_LIFETIME.LIVE)
 103   }
 104
 105   run () {
 106     logger.info('Running RTMP server on port %d', config.rtmp.port)
 107
 108     this.rtmpServer = new NodeRtmpServer(config)
 109     this.rtmpServer.run()
 110   }
 111
 112   stop () {
 113     logger.info('Stopping RTMP server.')
 114
 115     this.rtmpServer.stop()
 116     this.rtmpServer = undefined
 117   }
 118
 119   isRunning () {
 120     return !!this.rtmpServer
 121   }
 122
 123   getSegmentsSha256 (videoUUID: string) {
 124     return this.segmentsSha256.get(videoUUID)
 125   }
 126
 127   stopSessionOf (videoId: number) {
 128     const sessionId = this.videoSessions.get(videoId)
 129     if (!sessionId) return
 130
 131     this.videoSessions.delete(videoId)
 132     this.abortSession(sessionId)
 133   }
 134
 135   getLiveQuotaUsedByUser (userId: number) {
 136     const currentLives = this.livesPerUser.get(userId)
 137     if (!currentLives) return 0
 138
 139     return currentLives.reduce((sum, obj) => sum + obj.size, 0)
 140   }
 141
 142   addViewTo (videoId: number) {
 143     if (this.videoSessions.has(videoId) === false) return
 144
 145     let watchers = this.watchersPerVideo.get(videoId)
 146
 147     if (!watchers) {
 148       watchers = []
 149       this.watchersPerVideo.set(videoId, watchers)
 150     }
 151
 152     watchers.push(new Date().getTime())
 153   }
 154
 155   private getContext () {
 156     return context
 157   }
 158
 159   private abortSession (id: string) {
 160     const session = this.getContext().sessions.get(id)
 161     if (session) {
 162       session.stop()
 163       this.getContext().sessions.delete(id)
 164     }
 165
 166     const transSession = this.transSessions.get(id)
 167     if (transSession) {
 168       transSession.kill('SIGINT')
 169       this.transSessions.delete(id)
 170     }
 171   }
 172
 173   private async handleSession (sessionId: string, streamPath: string, streamKey: string) {
 174     const videoLive = await VideoLiveModel.loadByStreamKey(streamKey)
 175     if (!videoLive) {
 176       logger.warn('Unknown live video with stream key %s.', streamKey)
 177       return this.abortSession(sessionId)
 178     }
 179
 180     const video = videoLive.Video
 181     if (video.isBlacklisted()) {
 182       logger.warn('Video is blacklisted. Refusing stream %s.', streamKey)
 183       return this.abortSession(sessionId)
 184     }
 185
 186     this.videoSessions.set(video.id, sessionId)
 187
 188     const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
 189
 190     const session = this.getContext().sessions.get(sessionId)
 191     const rtmpUrl = 'rtmp://127.0.0.1:' + config.rtmp.port + streamPath
 192
 193     const [ resolutionResult, fps ] = await Promise.all([
 194       getVideoFileResolution(rtmpUrl),
 195       getVideoFileFPS(rtmpUrl)
 196     ])
 197
 198     const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED
 199       ? computeResolutionsToTranscode(resolutionResult.videoFileResolution, 'live')
 200       : []
 201
 202     logger.info('Will mux/transcode live video of original resolution %d.', session.videoHeight, { resolutionsEnabled })
 203
 204     const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
 205       videoId: video.id,
 206       playlistUrl,
 207       segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
 208       p2pMediaLoaderInfohashes: VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(playlistUrl, resolutionsEnabled),
 209       p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
 210
 211       type: VideoStreamingPlaylistType.HLS
 212     }, { returning: true }) as [ MStreamingPlaylist, boolean ]
 213
 214     return this.runMuxing({
 215       sessionId,
 216       videoLive,
 217       playlist: videoStreamingPlaylist,
 218       originalResolution: session.videoHeight,
 219       rtmpUrl,
 220       fps,
 221       resolutionsEnabled
 222     })
 223   }
 224
 225   private async runMuxing (options: {
 226     sessionId: string
 227     videoLive: MVideoLiveVideo
 228     playlist: MStreamingPlaylist
 229     rtmpUrl: string
 230     fps: number
 231     resolutionsEnabled: number[]
 232     originalResolution: number
 233   }) {
 234     const { sessionId, videoLive, playlist, resolutionsEnabled, originalResolution, fps, rtmpUrl } = options
 235     const startStreamDateTime = new Date().getTime()
 236     const allResolutions = resolutionsEnabled.concat([ originalResolution ])
 237
 238     const user = await UserModel.loadByLiveId(videoLive.id)
 239     if (!this.livesPerUser.has(user.id)) {
 240       this.livesPerUser.set(user.id, [])
 241     }
 242
 243     const currentUserLive = { liveId: videoLive.id, videoId: videoLive.videoId, size: 0 }
 244     const livesOfUser = this.livesPerUser.get(user.id)
 245     livesOfUser.push(currentUserLive)
 246
 247     for (let i = 0; i < allResolutions.length; i++) {
 248       const resolution = allResolutions[i]
 249
 250       VideoFileModel.upsert({
 251         resolution,
 252         size: -1,
 253         extname: '.ts',
 254         infoHash: null,
 255         fps,
 256         videoStreamingPlaylistId: playlist.id
 257       }).catch(err => {
 258         logger.error('Cannot create file for live streaming.', { err })
 259       })
 260     }
 261
 262     const outPath = getHLSDirectory(videoLive.Video)
 263     await ensureDir(outPath)
 264
 265     const videoUUID = videoLive.Video.uuid
 266     const deleteSegments = videoLive.saveReplay === false
 267
 268     const ffmpegExec = CONFIG.LIVE.TRANSCODING.ENABLED
 269       ? runLiveTranscoding(rtmpUrl, outPath, allResolutions, fps, deleteSegments)
 270       : runLiveMuxing(rtmpUrl, outPath, deleteSegments)
 271
 272     logger.info('Running live muxing/transcoding for %s.', videoUUID)
 273     this.transSessions.set(sessionId, ffmpegExec)
 274
 275     const tsWatcher = chokidar.watch(outPath + '/*.ts')
 276
 277     let segmentsToProcess: string[] = []
 278
 279     const addHandler = segmentPath => {
 280       // Add sha hash of previous segments, because ffmpeg should have finished generating them
 281       for (const previousSegment of segmentsToProcess) {
 282         this.addSegmentSha(videoUUID, previousSegment)
 283           .catch(err => logger.error('Cannot add sha segment of video %s -> %s.', videoUUID, previousSegment, { err }))
 284       }
 285
 286       segmentsToProcess = [ segmentPath ]
 287
 288       // Duration constraint check
 289       if (this.isDurationConstraintValid(startStreamDateTime) !== true) {
 290         logger.info('Stopping session of %s: max duration exceeded.', videoUUID)
 291
 292         this.stopSessionOf(videoLive.videoId)
 293       }
 294
 295       // Check user quota if the user enabled replay saving
 296       if (videoLive.saveReplay === true) {
 297         stat(segmentPath)
 298           .then(segmentStat => {
 299             currentUserLive.size += segmentStat.size
 300           })
 301           .then(() => this.isQuotaConstraintValid(user, videoLive))
 302           .then(quotaValid => {
 303             if (quotaValid !== true) {
 304               logger.info('Stopping session of %s: user quota exceeded.', videoUUID)
 305
 306               this.stopSessionOf(videoLive.videoId)
 307             }
 308           })
 309           .catch(err => logger.error('Cannot stat %s or check quota of %d.', segmentPath, user.id, { err }))
 310       }
 311     }
 312
 313     const deleteHandler = segmentPath => this.removeSegmentSha(videoUUID, segmentPath)
 314
 315     tsWatcher.on('add', p => addHandler(p))
 316     tsWatcher.on('unlink', p => deleteHandler(p))
 317
 318     const masterWatcher = chokidar.watch(outPath + '/master.m3u8')
 319     masterWatcher.on('add', async () => {
 320       try {
 321         const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoLive.videoId)
 322
 323         video.state = VideoState.PUBLISHED
 324         await video.save()
 325         videoLive.Video = video
 326
 327         await federateVideoIfNeeded(video, false)
 328
 329         PeerTubeSocket.Instance.sendVideoLiveNewState(video)
 330       } catch (err) {
 331         logger.error('Cannot federate video %d.', videoLive.videoId, { err })
 332       } finally {
 333         masterWatcher.close()
 334           .catch(err => logger.error('Cannot close master watcher of %s.', outPath, { err }))
 335       }
 336     })
 337
 338     const onFFmpegEnded = () => {
 339       logger.info('RTMP transmuxing for video %s ended. Scheduling cleanup', rtmpUrl)
 340
 341       this.transSessions.delete(sessionId)
 342       this.watchersPerVideo.delete(videoLive.videoId)
 343
 344       Promise.all([ tsWatcher.close(), masterWatcher.close() ])
 345         .catch(err => logger.error('Cannot close watchers of %s.', outPath, { err }))
 346
 347       this.onEndTransmuxing(videoLive.Video.id)
 348         .catch(err => logger.error('Error in closed transmuxing.', { err }))
 349     }
 350
 351     ffmpegExec.on('error', (err, stdout, stderr) => {
 352       onFFmpegEnded()
 353
 354       // Don't care that we killed the ffmpeg process
 355       if (err?.message?.includes('Exiting normally')) return
 356
 357       logger.error('Live transcoding error.', { err, stdout, stderr })
 358
 359       this.abortSession(sessionId)
 360     })
 361
 362     ffmpegExec.on('end', () => onFFmpegEnded())
 363   }
 364
 365   private async onEndTransmuxing (videoId: number, cleanupNow = false) {
 366     try {
 367       const fullVideo = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
 368       if (!fullVideo) return
 369
 370       JobQueue.Instance.createJob({
 371         type: 'video-live-ending',
 372         payload: {
 373           videoId: fullVideo.id
 374         }
 375       }, { delay: cleanupNow ? 0 : VIDEO_LIVE.CLEANUP_DELAY })
 376
 377       fullVideo.state = VideoState.LIVE_ENDED
 378       await fullVideo.save()
 379
 380       PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo)
 381
 382       await federateVideoIfNeeded(fullVideo, false)
 383     } catch (err) {
 384       logger.error('Cannot save/federate new video state of live streaming.', { err })
 385     }
 386   }
 387
 388   private async addSegmentSha (videoUUID: string, segmentPath: string) {
 389     const segmentName = basename(segmentPath)
 390     logger.debug('Adding live sha segment %s.', segmentPath)
 391
 392     const shaResult = await buildSha256Segment(segmentPath)
 393
 394     if (!this.segmentsSha256.has(videoUUID)) {
 395       this.segmentsSha256.set(videoUUID, new Map())
 396     }
 397
 398     const filesMap = this.segmentsSha256.get(videoUUID)
 399     filesMap.set(segmentName, shaResult)
 400   }
 401
 402   private removeSegmentSha (videoUUID: string, segmentPath: string) {
 403     const segmentName = basename(segmentPath)
 404
 405     logger.debug('Removing live sha segment %s.', segmentPath)
 406
 407     const filesMap = this.segmentsSha256.get(videoUUID)
 408     if (!filesMap) {
 409       logger.warn('Unknown files map to remove sha for %s.', videoUUID)
 410       return
 411     }
 412
 413     if (!filesMap.has(segmentName)) {
 414       logger.warn('Unknown segment in files map for video %s and segment %s.', videoUUID, segmentPath)
 415       return
 416     }
 417
 418     filesMap.delete(segmentName)
 419   }
 420
 421   private isDurationConstraintValid (streamingStartTime: number) {
 422     const maxDuration = CONFIG.LIVE.MAX_DURATION
 423     // No limit
 424     if (maxDuration === null) return true
 425
 426     const now = new Date().getTime()
 427     const max = streamingStartTime + maxDuration
 428
 429     return now <= max
 430   }
 431
 432   private async isQuotaConstraintValid (user: MUserId, live: MVideoLive) {
 433     if (live.saveReplay !== true) return true
 434
 435     return this.isAbleToUploadVideoWithCache(user.id)
 436   }
 437
 438   private async updateLiveViews () {
 439     if (!this.isRunning()) return
 440
 441     if (!isTestInstance()) logger.info('Updating live video views.')
 442
 443     for (const videoId of this.watchersPerVideo.keys()) {
 444       const notBefore = new Date().getTime() - VIEW_LIFETIME.LIVE
 445
 446       const watchers = this.watchersPerVideo.get(videoId)
 447
 448       const numWatchers = watchers.length
 449
 450       const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
 451       video.views = numWatchers
 452       await video.save()
 453
 454       await federateVideoIfNeeded(video, false)
 455
 456       // Only keep not expired watchers
 457       const newWatchers = watchers.filter(w => w > notBefore)
 458       this.watchersPerVideo.set(videoId, newWatchers)
 459
 460       logger.debug('New live video views for %s is %d.', video.url, numWatchers)
 461     }
 462   }
 463
 464   static get Instance () {
 465     return this.instance || (this.instance = new this())
 466   }
 467 }
 468
 469 // ---------------------------------------------------------------------------
 470
 471 export {
 472   LiveManager
 473 }