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

   1 import * as Bull from 'bull'
   2 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
   3 import { getTranscodingJobPriority, publishAndFederateIfNeeded } from '@server/lib/video'
   4 import { getVideoFilePath } from '@server/lib/video-paths'
   5 import { UserModel } from '@server/models/user/user'
   6 import { MUser, MUserId, MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
   7 import {
   8   HLSTranscodingPayload,
   9   MergeAudioTranscodingPayload,
  10   NewResolutionTranscodingPayload,
  11   OptimizeTranscodingPayload,
  12   VideoTranscodingPayload
  13 } from '../../../../shared'
  14 import { retryTransactionWrapper } from '../../../helpers/database-utils'
  15 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
  16 import { logger } from '../../../helpers/logger'
  17 import { CONFIG } from '../../../initializers/config'
  18 import { VideoModel } from '../../../models/video/video'
  19 import { federateVideoIfNeeded } from '../../activitypub/videos'
  20 import { Notifier } from '../../notifier'
  21 import {
  22   generateHlsPlaylistResolution,
  23   mergeAudioVideofile,
  24   optimizeOriginalVideofile,
  25   transcodeNewWebTorrentResolution
  26 } from '../../transcoding/video-transcoding'
  27 import { JobQueue } from '../job-queue'
  28
  29 type HandlerFunction = (job: Bull.Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<any>
  30
  31 const handlers: { [ id in VideoTranscodingPayload['type'] ]: HandlerFunction } = {
  32   'new-resolution-to-hls': handleHLSJob,
  33   'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
  34   'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
  35   'optimize-to-webtorrent': handleWebTorrentOptimizeJob
  36 }
  37
  38 async function processVideoTranscoding (job: Bull.Job) {
  39   const payload = job.data as VideoTranscodingPayload
  40   logger.info('Processing video file in job %d.', job.id)
  41
  42   const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
  43   // No video, maybe deleted?
  44   if (!video) {
  45     logger.info('Do not process job %d, video does not exist.', job.id)
  46     return undefined
  47   }
  48
  49   const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
  50
  51   const handler = handlers[payload.type]
  52
  53   if (!handler) {
  54     throw new Error('Cannot find transcoding handler for ' + payload.type)
  55   }
  56
  57   await handler(job, payload, video, user)
  58
  59   return video
  60 }
  61
  62 // ---------------------------------------------------------------------------
  63 // Job handlers
  64 // ---------------------------------------------------------------------------
  65
  66 async function handleHLSJob (job: Bull.Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
  67   const videoFileInput = payload.copyCodecs
  68     ? video.getWebTorrentFile(payload.resolution)
  69     : video.getMaxQualityFile()
  70
  71   const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
  72   const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
  73
  74   await generateHlsPlaylistResolution({
  75     video,
  76     videoInputPath,
  77     resolution: payload.resolution,
  78     copyCodecs: payload.copyCodecs,
  79     isPortraitMode: payload.isPortraitMode || false,
  80     job
  81   })
  82
  83   await retryTransactionWrapper(onHlsPlaylistGeneration, video, user, payload)
  84 }
  85
  86 async function handleNewWebTorrentResolutionJob (
  87   job: Bull.Job,
  88   payload: NewResolutionTranscodingPayload,
  89   video: MVideoFullLight,
  90   user: MUserId
  91 ) {
  92   await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
  93
  94   await retryTransactionWrapper(onNewWebTorrentFileResolution, video, user, payload)
  95 }
  96
  97 async function handleWebTorrentMergeAudioJob (job: Bull.Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
  98   await mergeAudioVideofile(video, payload.resolution, job)
  99
 100   await retryTransactionWrapper(onVideoFileOptimizer, video, payload, 'video', user)
 101 }
 102
 103 async function handleWebTorrentOptimizeJob (job: Bull.Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
 104   const transcodeType = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
 105
 106   await retryTransactionWrapper(onVideoFileOptimizer, video, payload, transcodeType, user)
 107 }
 108
 109 // ---------------------------------------------------------------------------
 110
 111 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
 112   if (video === undefined) return undefined
 113
 114   if (payload.isMaxQuality && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
 115     // Remove webtorrent files if not enabled
 116     for (const file of video.VideoFiles) {
 117       await video.removeFileAndTorrent(file)
 118       await file.destroy()
 119     }
 120
 121     video.VideoFiles = []
 122
 123     // Create HLS new resolution jobs
 124     await createLowerResolutionsJobs(video, user, payload.resolution, payload.isPortraitMode, 'hls')
 125   }
 126
 127   return publishAndFederateIfNeeded(video)
 128 }
 129
 130 async function onVideoFileOptimizer (
 131   videoArg: MVideoWithFile,
 132   payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
 133   transcodeType: TranscodeOptionsType,
 134   user: MUserId
 135 ) {
 136   if (videoArg === undefined) return undefined
 137
 138   // Outside the transaction (IO on disk)
 139   const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
 140
 141   // Maybe the video changed in database, refresh it
 142   const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
 143   // Video does not exist anymore
 144   if (!videoDatabase) return undefined
 145
 146   let videoPublished = false
 147
 148   // Generate HLS version of the original file
 149   const originalFileHLSPayload = Object.assign({}, payload, {
 150     isPortraitMode,
 151     resolution: videoDatabase.getMaxQualityFile().resolution,
 152     // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
 153     copyCodecs: transcodeType !== 'quick-transcode',
 154     isMaxQuality: true
 155   })
 156   const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
 157
 158   const hasNewResolutions = await createLowerResolutionsJobs(videoDatabase, user, videoFileResolution, isPortraitMode, 'webtorrent')
 159
 160   if (!hasHls && !hasNewResolutions) {
 161     // No transcoding to do, it's now published
 162     videoPublished = await videoDatabase.publishIfNeededAndSave(undefined)
 163   }
 164
 165   await federateVideoIfNeeded(videoDatabase, payload.isNewVideo)
 166
 167   if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
 168   if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
 169 }
 170
 171 async function onNewWebTorrentFileResolution (
 172   video: MVideoUUID,
 173   user: MUserId,
 174   payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
 175 ) {
 176   await publishAndFederateIfNeeded(video)
 177
 178   await createHlsJobIfEnabled(user, Object.assign({}, payload, { copyCodecs: true, isMaxQuality: false }))
 179 }
 180
 181 // ---------------------------------------------------------------------------
 182
 183 export {
 184   processVideoTranscoding,
 185   onNewWebTorrentFileResolution
 186 }
 187
 188 // ---------------------------------------------------------------------------
 189
 190 async function createHlsJobIfEnabled (user: MUserId, payload: {
 191   videoUUID: string
 192   resolution: number
 193   isPortraitMode?: boolean
 194   copyCodecs: boolean
 195   isMaxQuality: boolean
 196 }) {
 197   if (!payload || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
 198
 199   const jobOptions = {
 200     priority: await getTranscodingJobPriority(user)
 201   }
 202
 203   const hlsTranscodingPayload: HLSTranscodingPayload = {
 204     type: 'new-resolution-to-hls',
 205     videoUUID: payload.videoUUID,
 206     resolution: payload.resolution,
 207     isPortraitMode: payload.isPortraitMode,
 208     copyCodecs: payload.copyCodecs,
 209     isMaxQuality: payload.isMaxQuality
 210   }
 211
 212   JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload }, jobOptions)
 213
 214   return true
 215 }
 216
 217 async function createLowerResolutionsJobs (
 218   video: MVideoFullLight,
 219   user: MUserId,
 220   videoFileResolution: number,
 221   isPortraitMode: boolean,
 222   type: 'hls' | 'webtorrent'
 223 ) {
 224   // Create transcoding jobs if there are enabled resolutions
 225   const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
 226   const resolutionCreated: number[] = []
 227
 228   for (const resolution of resolutionsEnabled) {
 229     let dataInput: VideoTranscodingPayload
 230
 231     if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
 232       // WebTorrent will create subsequent HLS job
 233       dataInput = {
 234         type: 'new-resolution-to-webtorrent',
 235         videoUUID: video.uuid,
 236         resolution,
 237         isPortraitMode
 238       }
 239     }
 240
 241     if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
 242       dataInput = {
 243         type: 'new-resolution-to-hls',
 244         videoUUID: video.uuid,
 245         resolution,
 246         isPortraitMode,
 247         copyCodecs: false,
 248         isMaxQuality: false
 249       }
 250     }
 251
 252     if (!dataInput) continue
 253
 254     resolutionCreated.push(resolution)
 255
 256     const jobOptions = {
 257       priority: await getTranscodingJobPriority(user)
 258     }
 259
 260     JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput }, jobOptions)
 261   }
 262
 263   if (resolutionCreated.length === 0) {
 264     logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
 265
 266     return false
 267   }
 268
 269   logger.info(
 270     'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
 271     { resolutionCreated }
 272   )
 273
 274   return true
 275 }