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

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