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