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