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

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