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

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