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.removeFile(file)
 129       await file.removeTorrent()
 130       await file.destroy()
 131     }
 132
 133     video.VideoFiles = []
 134
 135     // Create HLS new resolution jobs
 136     await createLowerResolutionsJobs(video, user, payload.resolution, payload.isPortraitMode, 'hls')
 137   }
 138
 139   return publishAndFederateIfNeeded(video)
 140 }
 141
 142 async function onVideoFileOptimizer (
 143   videoArg: MVideoWithFile,
 144   payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
 145   transcodeType: TranscodeOptionsType,
 146   user: MUserId
 147 ) {
 148   if (videoArg === undefined) return undefined
 149
 150   // Outside the transaction (IO on disk)
 151   const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
 152
 153   // Maybe the video changed in database, refresh it
 154   const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
 155   // Video does not exist anymore
 156   if (!videoDatabase) return undefined
 157
 158   let videoPublished = false
 159
 160   // Generate HLS version of the original file
 161   const originalFileHLSPayload = Object.assign({}, payload, {
 162     isPortraitMode,
 163     resolution: videoDatabase.getMaxQualityFile().resolution,
 164     // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
 165     copyCodecs: transcodeType !== 'quick-transcode',
 166     isMaxQuality: true
 167   })
 168   const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
 169
 170   const hasNewResolutions = await createLowerResolutionsJobs(videoDatabase, user, videoFileResolution, isPortraitMode, 'webtorrent')
 171
 172   if (!hasHls && !hasNewResolutions) {
 173     // No transcoding to do, it's now published
 174     videoPublished = await videoDatabase.publishIfNeededAndSave(undefined)
 175   }
 176
 177   await federateVideoIfNeeded(videoDatabase, payload.isNewVideo)
 178
 179   if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
 180   if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
 181 }
 182
 183 async function onNewWebTorrentFileResolution (
 184   video: MVideoUUID,
 185   user: MUserId,
 186   payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
 187 ) {
 188   await publishAndFederateIfNeeded(video)
 189
 190   await createHlsJobIfEnabled(user, Object.assign({}, payload, { copyCodecs: true, isMaxQuality: false }))
 191 }
 192
 193 // ---------------------------------------------------------------------------
 194
 195 export {
 196   processVideoTranscoding,
 197   onNewWebTorrentFileResolution
 198 }
 199
 200 // ---------------------------------------------------------------------------
 201
 202 async function createHlsJobIfEnabled (user: MUserId, payload: {
 203   videoUUID: string
 204   resolution: number
 205   isPortraitMode?: boolean
 206   copyCodecs: boolean
 207   isMaxQuality: boolean
 208 }) {
 209   if (!payload || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
 210
 211   const jobOptions = {
 212     priority: await getTranscodingJobPriority(user)
 213   }
 214
 215   const hlsTranscodingPayload: HLSTranscodingPayload = {
 216     type: 'new-resolution-to-hls',
 217     videoUUID: payload.videoUUID,
 218     resolution: payload.resolution,
 219     isPortraitMode: payload.isPortraitMode,
 220     copyCodecs: payload.copyCodecs,
 221     isMaxQuality: payload.isMaxQuality
 222   }
 223
 224   JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload }, jobOptions)
 225
 226   return true
 227 }
 228
 229 async function createLowerResolutionsJobs (
 230   video: MVideoFullLight,
 231   user: MUserId,
 232   videoFileResolution: number,
 233   isPortraitMode: boolean,
 234   type: 'hls' | 'webtorrent'
 235 ) {
 236   // Create transcoding jobs if there are enabled resolutions
 237   const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
 238   const resolutionCreated: number[] = []
 239
 240   for (const resolution of resolutionsEnabled) {
 241     let dataInput: VideoTranscodingPayload
 242
 243     if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
 244       // WebTorrent will create subsequent HLS job
 245       dataInput = {
 246         type: 'new-resolution-to-webtorrent',
 247         videoUUID: video.uuid,
 248         resolution,
 249         isPortraitMode
 250       }
 251     }
 252
 253     if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
 254       dataInput = {
 255         type: 'new-resolution-to-hls',
 256         videoUUID: video.uuid,
 257         resolution,
 258         isPortraitMode,
 259         copyCodecs: false,
 260         isMaxQuality: false
 261       }
 262     }
 263
 264     if (!dataInput) continue
 265
 266     resolutionCreated.push(resolution)
 267
 268     const jobOptions = {
 269       priority: await getTranscodingJobPriority(user)
 270     }
 271
 272     JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput }, jobOptions)
 273   }
 274
 275   if (resolutionCreated.length === 0) {
 276     logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
 277
 278     return false
 279   }
 280
 281   logger.info(
 282     'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
 283     { resolutionCreated }
 284   )
 285
 286   return true
 287 }