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

   1 import * as Bull 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 } 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: Bull.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 async function processVideoTranscoding (job: Bull.Job) {
  38   const payload = job.data as VideoTranscodingPayload
  39   logger.info('Processing video file in job %d.', job.id)
  40
  41   const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
  42   // No video, maybe deleted?
  43   if (!video) {
  44     logger.info('Do not process job %d, video does not exist.', job.id)
  45     return undefined
  46   }
  47
  48   const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
  49
  50   const handler = handlers[payload.type]
  51
  52   if (!handler) {
  53     throw new Error('Cannot find transcoding handler for ' + payload.type)
  54   }
  55
  56   await handler(job, payload, video, user)
  57
  58   return video
  59 }
  60
  61 // ---------------------------------------------------------------------------
  62 // Job handlers
  63 // ---------------------------------------------------------------------------
  64
  65 async function handleHLSJob (job: Bull.Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
  66   const videoFileInput = payload.copyCodecs
  67     ? video.getWebTorrentFile(payload.resolution)
  68     : video.getMaxQualityFile()
  69
  70   const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
  71
  72   await VideoPathManager.Instance.makeAvailableVideoFile(videoOrStreamingPlaylist, videoFileInput, videoInputPath => {
  73     return generateHlsPlaylistResolution({
  74       video,
  75       videoInputPath,
  76       resolution: payload.resolution,
  77       copyCodecs: payload.copyCodecs,
  78       isPortraitMode: payload.isPortraitMode || false,
  79       job
  80     })
  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({
 125       video,
 126       user,
 127       videoFileResolution: payload.resolution,
 128       isPortraitMode: payload.isPortraitMode,
 129       isNewVideo: payload.isNewVideo ?? true,
 130       type: 'hls'
 131     })
 132   }
 133
 134   await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
 135   await moveToNextState(video, payload.isNewVideo)
 136 }
 137
 138 async function onVideoFileOptimizer (
 139   videoArg: MVideoWithFile,
 140   payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
 141   transcodeType: TranscodeOptionsType,
 142   user: MUserId
 143 ) {
 144   if (videoArg === undefined) return undefined
 145
 146   // Outside the transaction (IO on disk)
 147   const { resolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
 148
 149   // Maybe the video changed in database, refresh it
 150   const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
 151   // Video does not exist anymore
 152   if (!videoDatabase) return undefined
 153
 154   // Generate HLS version of the original file
 155   const originalFileHLSPayload = {
 156     ...payload,
 157
 158     isPortraitMode,
 159     resolution: videoDatabase.getMaxQualityFile().resolution,
 160     // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
 161     copyCodecs: transcodeType !== 'quick-transcode',
 162     isMaxQuality: true
 163   }
 164   const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
 165   const hasNewResolutions = await createLowerResolutionsJobs({
 166     video: videoDatabase,
 167     user,
 168     videoFileResolution: resolution,
 169     isPortraitMode,
 170     type: 'webtorrent',
 171     isNewVideo: payload.isNewVideo ?? true
 172   })
 173
 174   await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
 175
 176   // Move to next state if there are no other resolutions to generate
 177   if (!hasHls && !hasNewResolutions) {
 178     await moveToNextState(videoDatabase, payload.isNewVideo)
 179   }
 180 }
 181
 182 async function onNewWebTorrentFileResolution (
 183   video: MVideo,
 184   user: MUserId,
 185   payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
 186 ) {
 187   await createHlsJobIfEnabled(user, { ...payload, copyCodecs: true, isMaxQuality: false })
 188   await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
 189
 190   await moveToNextState(video, payload.isNewVideo)
 191 }
 192
 193 async function createHlsJobIfEnabled (user: MUserId, payload: {
 194   videoUUID: string
 195   resolution: number
 196   isPortraitMode?: boolean
 197   copyCodecs: boolean
 198   isMaxQuality: boolean
 199   isNewVideo?: boolean
 200 }) {
 201   if (!payload || CONFIG.TRANSCODING.ENABLED !== true || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
 202
 203   const jobOptions = {
 204     priority: await getTranscodingJobPriority(user)
 205   }
 206
 207   const hlsTranscodingPayload: HLSTranscodingPayload = {
 208     type: 'new-resolution-to-hls',
 209     videoUUID: payload.videoUUID,
 210     resolution: payload.resolution,
 211     isPortraitMode: payload.isPortraitMode,
 212     copyCodecs: payload.copyCodecs,
 213     isMaxQuality: payload.isMaxQuality,
 214     isNewVideo: payload.isNewVideo
 215   }
 216
 217   await addTranscodingJob(hlsTranscodingPayload, jobOptions)
 218
 219   return true
 220 }
 221
 222 // ---------------------------------------------------------------------------
 223
 224 export {
 225   processVideoTranscoding,
 226   createHlsJobIfEnabled,
 227   onNewWebTorrentFileResolution
 228 }
 229
 230 // ---------------------------------------------------------------------------
 231
 232 async function createLowerResolutionsJobs (options: {
 233   video: MVideoFullLight
 234   user: MUserId
 235   videoFileResolution: number
 236   isPortraitMode: boolean
 237   isNewVideo: boolean
 238   type: 'hls' | 'webtorrent'
 239 }) {
 240   const { video, user, videoFileResolution, isPortraitMode, isNewVideo, type } = options
 241
 242   // Create transcoding jobs if there are enabled resolutions
 243   const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
 244   const resolutionCreated: number[] = []
 245
 246   for (const resolution of resolutionsEnabled) {
 247     let dataInput: VideoTranscodingPayload
 248
 249     if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
 250       // WebTorrent will create subsequent HLS job
 251       dataInput = {
 252         type: 'new-resolution-to-webtorrent',
 253         videoUUID: video.uuid,
 254         resolution,
 255         isPortraitMode,
 256         isNewVideo
 257       }
 258     }
 259
 260     if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
 261       dataInput = {
 262         type: 'new-resolution-to-hls',
 263         videoUUID: video.uuid,
 264         resolution,
 265         isPortraitMode,
 266         copyCodecs: false,
 267         isMaxQuality: false,
 268         isNewVideo
 269       }
 270     }
 271
 272     if (!dataInput) continue
 273
 274     resolutionCreated.push(resolution)
 275
 276     const jobOptions = {
 277       priority: await getTranscodingJobPriority(user)
 278     }
 279
 280     await addTranscodingJob(dataInput, jobOptions)
 281   }
 282
 283   if (resolutionCreated.length === 0) {
 284     logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
 285
 286     return false
 287   }
 288
 289   logger.info(
 290     'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
 291     { resolutionCreated }
 292   )
 293
 294   return true
 295 }