server/lib/job-queue/handlers/video-transcoding.ts

   1 import * as Bull from 'bull'
   2 import { publishAndFederateIfNeeded } from '@server/lib/video'
   3 import { getVideoFilePath } from '@server/lib/video-paths'
   4 import { MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
   5 import {
   6   MergeAudioTranscodingPayload,
   7   NewResolutionTranscodingPayload,
   8   OptimizeTranscodingPayload,
   9   VideoTranscodingPayload
  10 } from '../../../../shared'
  11 import { retryTransactionWrapper } from '../../../helpers/database-utils'
  12 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
  13 import { logger } from '../../../helpers/logger'
  14 import { CONFIG } from '../../../initializers/config'
  15 import { sequelizeTypescript } from '../../../initializers/database'
  16 import { VideoModel } from '../../../models/video/video'
  17 import { federateVideoIfNeeded } from '../../activitypub/videos'
  18 import { Notifier } from '../../notifier'
  19 import { generateHlsPlaylist, mergeAudioVideofile, optimizeOriginalVideofile, transcodeNewResolution } from '../../video-transcoding'
  20 import { JobQueue } from '../job-queue'
  21 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
  22
  23 async function processVideoTranscoding (job: Bull.Job) {
  24   const payload = job.data as VideoTranscodingPayload
  25   logger.info('Processing video file in job %d.', job.id)
  26
  27   const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
  28   // No video, maybe deleted?
  29   if (!video) {
  30     logger.info('Do not process job %d, video does not exist.', job.id)
  31     return undefined
  32   }
  33
  34   if (payload.type === 'hls') {
  35     const videoFileInput = payload.copyCodecs
  36       ? video.getWebTorrentFile(payload.resolution)
  37       : video.getMaxQualityFile()
  38
  39     const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
  40     const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
  41
  42     await generateHlsPlaylist({
  43       video,
  44       videoInputPath,
  45       resolution: payload.resolution,
  46       copyCodecs: payload.copyCodecs,
  47       isPortraitMode: payload.isPortraitMode || false
  48     })
  49
  50     await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
  51   } else if (payload.type === 'new-resolution') {
  52     await transcodeNewResolution(video, payload.resolution, payload.isPortraitMode || false)
  53
  54     await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
  55   } else if (payload.type === 'merge-audio') {
  56     await mergeAudioVideofile(video, payload.resolution)
  57
  58     await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
  59   } else {
  60     const transcodeType = await optimizeOriginalVideofile(video)
  61
  62     await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload, transcodeType)
  63   }
  64
  65   return video
  66 }
  67
  68 async function onHlsPlaylistGenerationSuccess (video: MVideoFullLight) {
  69   if (video === undefined) return undefined
  70
  71   // We generated the HLS playlist, we don't need the webtorrent files anymore if the admin disabled it
  72   if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
  73     for (const file of video.VideoFiles) {
  74       await video.removeFile(file)
  75       await file.destroy()
  76     }
  77
  78     video.VideoFiles = []
  79   }
  80
  81   return publishAndFederateIfNeeded(video)
  82 }
  83
  84 async function publishNewResolutionIfNeeded (video: MVideoUUID, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
  85   await publishAndFederateIfNeeded(video)
  86
  87   createHlsJobIfEnabled(Object.assign({}, payload, { copyCodecs: true })
  88 }
  89
  90 async function onVideoFileOptimizerSuccess (
  91   videoArg: MVideoWithFile,
  92   payload: OptimizeTranscodingPayload,
  93   transcodeType: TranscodeOptionsType
  94 ) {
  95   if (videoArg === undefined) return undefined
  96
  97   // Outside the transaction (IO on disk)
  98   const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
  99
 100   const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
 101     // Maybe the video changed in database, refresh it
 102     const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
 103     // Video does not exist anymore
 104     if (!videoDatabase) return undefined
 105
 106     // Create transcoding jobs if there are enabled resolutions
 107     const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
 108     logger.info(
 109       'Resolutions computed for video %s and origin file resolution of %d.', videoDatabase.uuid, videoFileResolution,
 110       { resolutions: resolutionsEnabled }
 111     )
 112
 113     let videoPublished = false
 114
 115     // Generate HLS version of the max quality file
 116     const originalFileHLSPayload = Object.assign({}, payload, {
 117       isPortraitMode,
 118       resolution: videoDatabase.getMaxQualityFile().resolution,
 119       // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
 120       copyCodecs: transcodeType !== 'quick-transcode'
 121     })
 122     createHlsJobIfEnabled(originalFileHLSPayload)
 123
 124     if (resolutionsEnabled.length !== 0) {
 125       for (const resolution of resolutionsEnabled) {
 126         let dataInput: VideoTranscodingPayload
 127
 128         if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED) {
 129           dataInput = {
 130             type: 'new-resolution' as 'new-resolution',
 131             videoUUID: videoDatabase.uuid,
 132             resolution,
 133             isPortraitMode
 134           }
 135         } else if (CONFIG.TRANSCODING.HLS.ENABLED) {
 136           dataInput = {
 137             type: 'hls',
 138             videoUUID: videoDatabase.uuid,
 139             resolution,
 140             isPortraitMode,
 141             copyCodecs: false
 142           }
 143         }
 144
 145         JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
 146       }
 147
 148       logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
 149     } else {
 150       // No transcoding to do, it's now published
 151       videoPublished = await videoDatabase.publishIfNeededAndSave(t)
 152
 153       logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
 154     }
 155
 156     await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
 157
 158     return { videoDatabase, videoPublished }
 159   })
 160
 161   if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
 162   if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
 163 }
 164
 165 // ---------------------------------------------------------------------------
 166
 167 export {
 168   processVideoTranscoding,
 169   publishNewResolutionIfNeeded
 170 }
 171
 172 // ---------------------------------------------------------------------------
 173
 174 function createHlsJobIfEnabled (payload: { videoUUID: string, resolution: number, isPortraitMode?: boolean, copyCodecs: boolean }) {
 175   // Generate HLS playlist?
 176   if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
 177     const hlsTranscodingPayload = {
 178       type: 'hls' as 'hls',
 179       videoUUID: payload.videoUUID,
 180       resolution: payload.resolution,
 181       isPortraitMode: payload.isPortraitMode,
 182       copyCodecs: payload.copyCodecs
 183     }
 184
 185     return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })
 186   }
 187 }