]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/lib/live-manager.ts
Split ffmpeg utils with ffprobe utils
[github/Chocobozzz/PeerTube.git] / server / lib / live-manager.ts
index fd9a859f901c1065234a0aad0fec0423cd671b56..4d2e9b1b390ee3e70e5d17947eb1d06f6cde09c0 100644 (file)
@@ -1,13 +1,14 @@
 
-import { AsyncQueue, queue } from 'async'
 import * as chokidar from 'chokidar'
 import { FfmpegCommand } from 'fluent-ffmpeg'
 import { ensureDir, stat } from 'fs-extra'
 import { basename } from 'path'
-import { computeResolutionsToTranscode, runLiveMuxing, runLiveTranscoding } from '@server/helpers/ffmpeg-utils'
+import { isTestInstance } from '@server/helpers/core-utils'
+import { runLiveMuxing, runLiveTranscoding } from '@server/helpers/ffmpeg-utils'
+import { computeResolutionsToTranscode, getVideoFileFPS, getVideoFileResolution } from '@server/helpers/ffprobe-utils'
 import { logger } from '@server/helpers/logger'
 import { CONFIG, registerConfigChangedHandler } from '@server/initializers/config'
-import { MEMOIZE_TTL, P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE, WEBSERVER } from '@server/initializers/constants'
+import { MEMOIZE_TTL, P2P_MEDIA_LOADER_PEER_VERSION, VIDEO_LIVE, VIEW_LIFETIME, WEBSERVER } from '@server/initializers/constants'
 import { UserModel } from '@server/models/account/user'
 import { VideoModel } from '@server/models/video/video'
 import { VideoFileModel } from '@server/models/video/video-file'
@@ -43,18 +44,14 @@ const config = {
   }
 }
 
-type SegmentSha256QueueParam = {
-  operation: 'update' | 'delete'
-  videoUUID: string
-  segmentPath: string
-}
-
 class LiveManager {
 
   private static instance: LiveManager
 
   private readonly transSessions = new Map<string, FfmpegCommand>()
   private readonly videoSessions = new Map<number, string>()
+  // Values are Date().getTime()
+  private readonly watchersPerVideo = new Map<number, number[]>()
   private readonly segmentsSha256 = new Map<string, Map<string, string>>()
   private readonly livesPerUser = new Map<number, { liveId: number, videoId: number, size: number }[]>()
 
@@ -62,7 +59,6 @@ class LiveManager {
     return isAbleToUploadVideo(userId, 1000)
   }, { maxAge: MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD })
 
-  private segmentsSha256Queue: AsyncQueue<SegmentSha256QueueParam>
   private rtmpServer: any
 
   private constructor () {
@@ -87,18 +83,6 @@ class LiveManager {
       logger.info('Live session ended.', { sessionId })
     })
 
-    this.segmentsSha256Queue = queue<SegmentSha256QueueParam, Error>((options, cb) => {
-      const promise = options.operation === 'update'
-        ? this.addSegmentSha(options)
-        : Promise.resolve(this.removeSegmentSha(options))
-
-      promise.then(() => cb())
-        .catch(err => {
-          logger.error('Cannot update/remove sha segment %s.', options.segmentPath, { err })
-          cb()
-        })
-    })
-
     registerConfigChangedHandler(() => {
       if (!this.rtmpServer && CONFIG.LIVE.ENABLED === true) {
         this.run()
@@ -109,10 +93,16 @@ class LiveManager {
         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 }))
+
+    setInterval(() => this.updateLiveViews(), VIEW_LIFETIME.LIVE)
   }
 
   run () {
-    logger.info('Running RTMP server.')
+    logger.info('Running RTMP server on port %d', config.rtmp.port)
 
     this.rtmpServer = new NodeRtmpServer(config)
     this.rtmpServer.run()
@@ -125,6 +115,10 @@ class LiveManager {
     this.rtmpServer = undefined
   }
 
+  isRunning () {
+    return !!this.rtmpServer
+  }
+
   getSegmentsSha256 (videoUUID: string) {
     return this.segmentsSha256.get(videoUUID)
   }
@@ -133,10 +127,28 @@ class LiveManager {
     const sessionId = this.videoSessions.get(videoId)
     if (!sessionId) return
 
+    this.videoSessions.delete(videoId)
     this.abortSession(sessionId)
+  }
+
+  getLiveQuotaUsedByUser (userId: number) {
+    const currentLives = this.livesPerUser.get(userId)
+    if (!currentLives) return 0
+
+    return currentLives.reduce((sum, obj) => sum + obj.size, 0)
+  }
+
+  addViewTo (videoId: number) {
+    if (this.videoSessions.has(videoId) === false) return
+
+    let watchers = this.watchersPerVideo.get(videoId)
 
-    this.onEndTransmuxing(videoId, true)
-      .catch(err => logger.error('Cannot end transmuxing of video %d.', videoId, { err }))
+    if (!watchers) {
+      watchers = []
+      this.watchersPerVideo.set(videoId, watchers)
+    }
+
+    watchers.push(new Date().getTime())
   }
 
   private getContext () {
@@ -175,17 +187,26 @@ class LiveManager {
     const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid)
 
     const session = this.getContext().sessions.get(sessionId)
+    const rtmpUrl = 'rtmp://127.0.0.1:' + config.rtmp.port + streamPath
+
+    const [ resolutionResult, fps ] = await Promise.all([
+      getVideoFileResolution(rtmpUrl),
+      getVideoFileFPS(rtmpUrl)
+    ])
+
     const resolutionsEnabled = CONFIG.LIVE.TRANSCODING.ENABLED
-      ? computeResolutionsToTranscode(session.videoHeight, 'live')
+      ? computeResolutionsToTranscode(resolutionResult.videoFileResolution, 'live')
       : []
 
-    logger.info('Will mux/transcode live video of original resolution %d.', session.videoHeight, { resolutionsEnabled })
+    const allResolutions = resolutionsEnabled.concat([ session.videoHeight ])
+
+    logger.info('Will mux/transcode live video of original resolution %d.', session.videoHeight, { allResolutions })
 
     const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({
       videoId: video.id,
       playlistUrl,
       segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive),
-      p2pMediaLoaderInfohashes: VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(playlistUrl, resolutionsEnabled),
+      p2pMediaLoaderInfohashes: VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes(playlistUrl, allResolutions),
       p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION,
 
       type: VideoStreamingPlaylistType.HLS
@@ -195,9 +216,9 @@ class LiveManager {
       sessionId,
       videoLive,
       playlist: videoStreamingPlaylist,
-      streamPath,
-      originalResolution: session.videoHeight,
-      resolutionsEnabled
+      rtmpUrl,
+      fps,
+      allResolutions
     })
   }
 
@@ -205,13 +226,12 @@ class LiveManager {
     sessionId: string
     videoLive: MVideoLiveVideo
     playlist: MStreamingPlaylist
-    streamPath: string
-    resolutionsEnabled: number[]
-    originalResolution: number
+    rtmpUrl: string
+    fps: number
+    allResolutions: number[]
   }) {
-    const { sessionId, videoLive, playlist, streamPath, resolutionsEnabled, originalResolution } = options
+    const { sessionId, videoLive, playlist, allResolutions, fps, rtmpUrl } = options
     const startStreamDateTime = new Date().getTime()
-    const allResolutions = resolutionsEnabled.concat([ originalResolution ])
 
     const user = await UserModel.loadByLiveId(videoLive.id)
     if (!this.livesPerUser.has(user.id)) {
@@ -230,7 +250,7 @@ class LiveManager {
         size: -1,
         extname: '.ts',
         infoHash: null,
-        fps: -1,
+        fps,
         videoStreamingPlaylistId: playlist.id
       }).catch(err => {
         logger.error('Cannot create file for live streaming.', { err })
@@ -240,28 +260,47 @@ class LiveManager {
     const outPath = getHLSDirectory(videoLive.Video)
     await ensureDir(outPath)
 
+    const videoUUID = videoLive.Video.uuid
     const deleteSegments = videoLive.saveReplay === false
 
-    const rtmpUrl = 'rtmp://127.0.0.1:' + config.rtmp.port + streamPath
     const ffmpegExec = CONFIG.LIVE.TRANSCODING.ENABLED
-      ? runLiveTranscoding(rtmpUrl, outPath, allResolutions, deleteSegments)
+      ? runLiveTranscoding(rtmpUrl, outPath, allResolutions, fps, deleteSegments)
       : runLiveMuxing(rtmpUrl, outPath, deleteSegments)
 
-    logger.info('Running live muxing/transcoding.')
+    logger.info('Running live muxing/transcoding for %s.', videoUUID)
     this.transSessions.set(sessionId, ffmpegExec)
 
-    const videoUUID = videoLive.Video.uuid
     const tsWatcher = chokidar.watch(outPath + '/*.ts')
 
-    const updateSegment = segmentPath => this.segmentsSha256Queue.push({ operation: 'update', segmentPath, videoUUID })
+    const segmentsToProcessPerPlaylist: { [playlistId: string]: string[] } = {}
+    const playlistIdMatcher = /^([\d+])-/
+
+    const processHashSegments = (segmentsToProcess: string[]) => {
+      // Add sha hash of previous segments, because ffmpeg should have finished generating them
+      for (const previousSegment of segmentsToProcess) {
+        this.addSegmentSha(videoUUID, previousSegment)
+          .catch(err => logger.error('Cannot add sha segment of video %s -> %s.', videoUUID, previousSegment, { err }))
+      }
+    }
 
     const addHandler = segmentPath => {
-      updateSegment(segmentPath)
+      logger.debug('Live add handler of %s.', segmentPath)
 
+      const playlistId = basename(segmentPath).match(playlistIdMatcher)[0]
+
+      const segmentsToProcess = segmentsToProcessPerPlaylist[playlistId] || []
+      processHashSegments(segmentsToProcess)
+
+      segmentsToProcessPerPlaylist[playlistId] = [ segmentPath ]
+
+      // Duration constraint check
       if (this.isDurationConstraintValid(startStreamDateTime) !== true) {
+        logger.info('Stopping session of %s: max duration exceeded.', videoUUID)
+
         this.stopSessionOf(videoLive.videoId)
       }
 
+      // Check user quota if the user enabled replay saving
       if (videoLive.saveReplay === true) {
         stat(segmentPath)
           .then(segmentStat => {
@@ -270,6 +309,8 @@ class LiveManager {
           .then(() => this.isQuotaConstraintValid(user, videoLive))
           .then(quotaValid => {
             if (quotaValid !== true) {
+              logger.info('Stopping session of %s: user quota exceeded.', videoUUID)
+
               this.stopSessionOf(videoLive.videoId)
             }
           })
@@ -277,10 +318,9 @@ class LiveManager {
       }
     }
 
-    const deleteHandler = segmentPath => this.segmentsSha256Queue.push({ operation: 'delete', segmentPath, videoUUID })
+    const deleteHandler = segmentPath => this.removeSegmentSha(videoUUID, segmentPath)
 
     tsWatcher.on('add', p => addHandler(p))
-    tsWatcher.on('change', p => updateSegment(p))
     tsWatcher.on('unlink', p => deleteHandler(p))
 
     const masterWatcher = chokidar.watch(outPath + '/master.m3u8')
@@ -292,11 +332,15 @@ class LiveManager {
         await video.save()
         videoLive.Video = video
 
-        await federateVideoIfNeeded(video, false)
+        setTimeout(() => {
+          federateVideoIfNeeded(video, false)
+            .catch(err => logger.error('Cannot federate live video %s.', video.url, { err }))
+
+          PeerTubeSocket.Instance.sendVideoLiveNewState(video)
+        }, VIDEO_LIVE.SEGMENT_TIME_SECONDS * 1000 * VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION)
 
-        PeerTubeSocket.Instance.sendVideoLiveNewState(video)
       } catch (err) {
-        logger.error('Cannot federate video %d.', videoLive.videoId, { err })
+        logger.error('Cannot save/federate live video %d.', videoLive.videoId, { err })
       } finally {
         masterWatcher.close()
           .catch(err => logger.error('Cannot close master watcher of %s.', outPath, { err }))
@@ -304,36 +348,42 @@ class LiveManager {
     })
 
     const onFFmpegEnded = () => {
-      logger.info('RTMP transmuxing for video %s ended. Scheduling cleanup', streamPath)
+      logger.info('RTMP transmuxing for video %s ended. Scheduling cleanup', rtmpUrl)
 
       this.transSessions.delete(sessionId)
+      this.watchersPerVideo.delete(videoLive.videoId)
 
-      Promise.all([ tsWatcher.close(), masterWatcher.close() ])
-        .catch(err => logger.error('Cannot close watchers of %s.', outPath, { err }))
+      setTimeout(() => {
+        // Wait latest segments generation, and close watchers
+
+        Promise.all([ tsWatcher.close(), masterWatcher.close() ])
+        .then(() => {
+          // Process remaining segments hash
+          for (const key of Object.keys(segmentsToProcessPerPlaylist)) {
+            processHashSegments(segmentsToProcessPerPlaylist[key])
+          }
+        })
+        .catch(err => logger.error('Cannot close watchers of %s or process remaining hash segments.', outPath, { err }))
 
-      this.onEndTransmuxing(videoLive.Video.id)
-        .catch(err => logger.error('Error in closed transmuxing.', { err }))
+        this.onEndTransmuxing(videoLive.Video.id)
+          .catch(err => logger.error('Error in closed transmuxing.', { err }))
+      }, 1000)
     }
 
     ffmpegExec.on('error', (err, stdout, stderr) => {
       onFFmpegEnded()
 
       // Don't care that we killed the ffmpeg process
-      if (err?.message?.includes('SIGINT')) return
+      if (err?.message?.includes('Exiting normally')) return
 
       logger.error('Live transcoding error.', { err, stdout, stderr })
+
+      this.abortSession(sessionId)
     })
 
     ffmpegExec.on('end', () => onFFmpegEnded())
   }
 
-  getLiveQuotaUsedByUser (userId: number) {
-    const currentLives = this.livesPerUser.get(userId)
-    if (!currentLives) return 0
-
-    return currentLives.reduce((sum, obj) => sum + obj.size, 0)
-  }
-
   private async onEndTransmuxing (videoId: number, cleanupNow = false) {
     try {
       const fullVideo = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
@@ -346,8 +396,7 @@ class LiveManager {
         }
       }, { delay: cleanupNow ? 0 : VIDEO_LIVE.CLEANUP_DELAY })
 
-      // FIXME: use end
-      fullVideo.state = VideoState.WAITING_FOR_LIVE
+      fullVideo.state = VideoState.LIVE_ENDED
       await fullVideo.save()
 
       PeerTubeSocket.Instance.sendVideoLiveNewState(fullVideo)
@@ -358,33 +407,33 @@ class LiveManager {
     }
   }
 
-  private async addSegmentSha (options: SegmentSha256QueueParam) {
-    const segmentName = basename(options.segmentPath)
-    logger.debug('Updating live sha segment %s.', options.segmentPath)
+  private async addSegmentSha (videoUUID: string, segmentPath: string) {
+    const segmentName = basename(segmentPath)
+    logger.debug('Adding live sha segment %s.', segmentPath)
 
-    const shaResult = await buildSha256Segment(options.segmentPath)
+    const shaResult = await buildSha256Segment(segmentPath)
 
-    if (!this.segmentsSha256.has(options.videoUUID)) {
-      this.segmentsSha256.set(options.videoUUID, new Map())
+    if (!this.segmentsSha256.has(videoUUID)) {
+      this.segmentsSha256.set(videoUUID, new Map())
     }
 
-    const filesMap = this.segmentsSha256.get(options.videoUUID)
+    const filesMap = this.segmentsSha256.get(videoUUID)
     filesMap.set(segmentName, shaResult)
   }
 
-  private removeSegmentSha (options: SegmentSha256QueueParam) {
-    const segmentName = basename(options.segmentPath)
+  private removeSegmentSha (videoUUID: string, segmentPath: string) {
+    const segmentName = basename(segmentPath)
 
-    logger.debug('Removing live sha segment %s.', options.segmentPath)
+    logger.debug('Removing live sha segment %s.', segmentPath)
 
-    const filesMap = this.segmentsSha256.get(options.videoUUID)
+    const filesMap = this.segmentsSha256.get(videoUUID)
     if (!filesMap) {
-      logger.warn('Unknown files map to remove sha for %s.', options.videoUUID)
+      logger.warn('Unknown files map to remove sha for %s.', videoUUID)
       return
     }
 
     if (!filesMap.has(segmentName)) {
-      logger.warn('Unknown segment in files map for video %s and segment %s.', options.videoUUID, options.segmentPath)
+      logger.warn('Unknown segment in files map for video %s and segment %s.', videoUUID, segmentPath)
       return
     }
 
@@ -408,6 +457,40 @@ class LiveManager {
     return this.isAbleToUploadVideoWithCache(user.id)
   }
 
+  private async updateLiveViews () {
+    if (!this.isRunning()) return
+
+    if (!isTestInstance()) logger.info('Updating live video views.')
+
+    for (const videoId of this.watchersPerVideo.keys()) {
+      const notBefore = new Date().getTime() - VIEW_LIFETIME.LIVE
+
+      const watchers = this.watchersPerVideo.get(videoId)
+
+      const numWatchers = watchers.length
+
+      const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoId)
+      video.views = numWatchers
+      await video.save()
+
+      await federateVideoIfNeeded(video, false)
+
+      // Only keep not expired watchers
+      const newWatchers = watchers.filter(w => w > notBefore)
+      this.watchersPerVideo.set(videoId, newWatchers)
+
+      logger.debug('New live video views for %s is %d.', video.url, numWatchers)
+    }
+  }
+
+  private async handleBrokenLives () {
+    const videoIds = await VideoModel.listPublishedLiveIds()
+
+    for (const id of videoIds) {
+      await this.onEndTransmuxing(id, true)
+    }
+  }
+
   static get Instance () {
     return this.instance || (this.instance = new this())
   }