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

   1 import * as Bull from 'bull'
   2 import { publishAndFederateIfNeeded } from '@server/lib/video'
   3 import { getVideoFilePath } from '@server/lib/video-paths'
   4 import { MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
   5 import {
   6   MergeAudioTranscodingPayload,
   7   NewResolutionTranscodingPayload,
   8   OptimizeTranscodingPayload,
   9   VideoTranscodingPayload
  10 } from '../../../../shared'
  11 import { retryTransactionWrapper } from '../../../helpers/database-utils'
  12 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
  13 import { logger } from '../../../helpers/logger'
  14 import { CONFIG } from '../../../initializers/config'
  15 import { sequelizeTypescript } from '../../../initializers/database'
  16 import { VideoModel } from '../../../models/video/video'
  17 import { federateVideoIfNeeded } from '../../activitypub/videos'
  18 import { Notifier } from '../../notifier'
  19 import { generateHlsPlaylist, mergeAudioVideofile, optimizeOriginalVideofile, transcodeNewResolution } from '../../video-transcoding'
  20 import { JobQueue } from '../job-queue'
  21 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
  22
  23 async function processVideoTranscoding (job: Bull.Job) {
  24   const payload = job.data as VideoTranscodingPayload
  25   logger.info('Processing video file in job %d.', job.id)
  26
  27   const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
  28   // No video, maybe deleted?
  29   if (!video) {
  30     logger.info('Do not process job %d, video does not exist.', job.id)
  31     return undefined
  32   }
  33
  34   if (payload.type === 'hls') {
  35     const videoFileInput = payload.copyCodecs
  36       ? video.getWebTorrentFile(payload.resolution)
  37       : video.getMaxQualityFile()
  38
  39     const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
  40     const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
  41
  42     await generateHlsPlaylist({
  43       video,
  44       videoInputPath,
  45       resolution: payload.resolution,
  46       copyCodecs: payload.copyCodecs,
  47       isPortraitMode: payload.isPortraitMode || false,
  48       job
  49     })
  50
  51     await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
  52   } else if (payload.type === 'new-resolution') {
  53     await transcodeNewResolution(video, payload.resolution, payload.isPortraitMode || false, job)
  54
  55     await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
  56   } else if (payload.type === 'merge-audio') {
  57     await mergeAudioVideofile(video, payload.resolution, job)
  58
  59     await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
  60   } else {
  61     const transcodeType = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
  62
  63     await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload, transcodeType)
  64   }
  65
  66   return video
  67 }
  68
  69 async function onHlsPlaylistGenerationSuccess (video: MVideoFullLight) {
  70   if (video === undefined) return undefined
  71
  72   // We generated the HLS playlist, we don't need the webtorrent files anymore if the admin disabled it
  73   if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
  74     for (const file of video.VideoFiles) {
  75       await video.removeFile(file)
  76       await file.destroy()
  77     }
  78
  79     video.VideoFiles = []
  80   }
  81
  82   return publishAndFederateIfNeeded(video)
  83 }
  84
  85 async function publishNewResolutionIfNeeded (video: MVideoUUID, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
  86   await publishAndFederateIfNeeded(video)
  87
  88   createHlsJobIfEnabled(Object.assign({}, payload, { copyCodecs: true }))
  89 }
  90
  91 async function onVideoFileOptimizerSuccess (
  92   videoArg: MVideoWithFile,
  93   payload: OptimizeTranscodingPayload,
  94   transcodeType: TranscodeOptionsType
  95 ) {
  96   if (videoArg === undefined) return undefined
  97
  98   // Outside the transaction (IO on disk)
  99   const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
 100
 101   const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
 102     // Maybe the video changed in database, refresh it
 103     const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
 104     // Video does not exist anymore
 105     if (!videoDatabase) return undefined
 106
 107     // Create transcoding jobs if there are enabled resolutions
 108     const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
 109     logger.info(
 110       'Resolutions computed for video %s and origin file resolution of %d.', videoDatabase.uuid, videoFileResolution,
 111       { resolutions: resolutionsEnabled }
 112     )
 113
 114     let videoPublished = false
 115
 116     // Generate HLS version of the max quality file
 117     const originalFileHLSPayload = Object.assign({}, payload, {
 118       isPortraitMode,
 119       resolution: videoDatabase.getMaxQualityFile().resolution,
 120       // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
 121       copyCodecs: transcodeType !== 'quick-transcode'
 122     })
 123     createHlsJobIfEnabled(originalFileHLSPayload)
 124
 125     if (resolutionsEnabled.length !== 0) {
 126       for (const resolution of resolutionsEnabled) {
 127         let dataInput: VideoTranscodingPayload
 128
 129         if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED) {
 130           dataInput = {
 131             type: 'new-resolution' as 'new-resolution',
 132             videoUUID: videoDatabase.uuid,
 133             resolution,
 134             isPortraitMode
 135           }
 136         } else if (CONFIG.TRANSCODING.HLS.ENABLED) {
 137           dataInput = {
 138             type: 'hls',
 139             videoUUID: videoDatabase.uuid,
 140             resolution,
 141             isPortraitMode,
 142             copyCodecs: false
 143           }
 144         }
 145
 146         JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
 147       }
 148
 149       logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
 150     } else {
 151       // No transcoding to do, it's now published
 152       videoPublished = await videoDatabase.publishIfNeededAndSave(t)
 153
 154       logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
 155     }
 156
 157     await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
 158
 159     return { videoDatabase, videoPublished }
 160   })
 161
 162   if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
 163   if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
 164 }
 165
 166 // ---------------------------------------------------------------------------
 167
 168 export {
 169   processVideoTranscoding,
 170   publishNewResolutionIfNeeded
 171 }
 172
 173 // ---------------------------------------------------------------------------
 174
 175 function createHlsJobIfEnabled (payload: { videoUUID: string, resolution: number, isPortraitMode?: boolean, copyCodecs: boolean }) {
 176   // Generate HLS playlist?
 177   if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
 178     const hlsTranscodingPayload = {
 179       type: 'hls' as 'hls',
 180       videoUUID: payload.videoUUID,
 181       resolution: payload.resolution,
 182       isPortraitMode: payload.isPortraitMode,
 183       copyCodecs: payload.copyCodecs
 184     }
 185
 186     return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })
 187   }
 188 }