1 import * as Bull from 'bull'
2 import { VideoResolution } 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 { sequelizeTypescript } from '../../../initializers'
9 import * as Bluebird from 'bluebird'
10 import { computeResolutionsToTranscode } from '../../../helpers/ffmpeg-utils'
11 import { generateHlsPlaylist, mergeAudioVideofile, optimizeOriginalVideofile, transcodeNewResolution } from '../../video-transcoding'
12 import { Notifier } from '../../notifier'
13 import { CONFIG } from '../../../initializers/config'
14 import { MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/typings/models'
16 interface BaseTranscodingPayload {
21 interface HLSTranscodingPayload extends BaseTranscodingPayload {
23 isPortraitMode?: boolean
24 resolution: VideoResolution
28 interface NewResolutionTranscodingPayload extends BaseTranscodingPayload {
29 type: 'new-resolution'
30 isPortraitMode?: boolean
31 resolution: VideoResolution
34 interface MergeAudioTranscodingPayload extends BaseTranscodingPayload {
36 resolution: VideoResolution
39 interface OptimizeTranscodingPayload extends BaseTranscodingPayload {
43 export type VideoTranscodingPayload = HLSTranscodingPayload | NewResolutionTranscodingPayload
44 | OptimizeTranscodingPayload | MergeAudioTranscodingPayload
46 async function processVideoTranscoding (job: Bull.Job) {
47 const payload = job.data as VideoTranscodingPayload
48 logger.info('Processing video file in job %d.', job.id)
50 const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
51 // No video, maybe deleted?
53 logger.info('Do not process job %d, video does not exist.', job.id)
57 if (payload.type === 'hls') {
58 await generateHlsPlaylist(video, payload.resolution, payload.copyCodecs, payload.isPortraitMode || false)
60 await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
61 } else if (payload.type === 'new-resolution') {
62 await transcodeNewResolution(video, payload.resolution, payload.isPortraitMode || false)
64 await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
65 } else if (payload.type === 'merge-audio') {
66 await mergeAudioVideofile(video, payload.resolution)
68 await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
70 await optimizeOriginalVideofile(video)
72 await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload)
78 async function onHlsPlaylistGenerationSuccess (video: MVideoFullLight) {
79 if (video === undefined) return undefined
81 // We generated the HLS playlist, we don't need the webtorrent files anymore if the admin disabled it
82 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
83 for (const file of video.VideoFiles) {
84 await video.removeFile(file)
91 return publishAndFederateIfNeeded(video)
94 async function publishNewResolutionIfNeeded (video: MVideoUUID, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
95 await publishAndFederateIfNeeded(video)
97 await createHlsJobIfEnabled(payload)
100 async function onVideoFileOptimizerSuccess (videoArg: MVideoWithFile, payload: OptimizeTranscodingPayload) {
101 if (videoArg === undefined) return undefined
103 // Outside the transaction (IO on disk)
104 const { videoFileResolution } = await videoArg.getMaxQualityResolution()
106 const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
107 // Maybe the video changed in database, refresh it
108 let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
109 // Video does not exist anymore
110 if (!videoDatabase) return undefined
112 // Create transcoding jobs if there are enabled resolutions
113 const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution)
115 'Resolutions computed for video %s and origin file height of %d.', videoDatabase.uuid, videoFileResolution,
116 { resolutions: resolutionsEnabled }
119 let videoPublished = false
121 const hlsPayload = Object.assign({}, payload, { resolution: videoDatabase.getMaxQualityFile().resolution })
122 await createHlsJobIfEnabled(hlsPayload)
124 if (resolutionsEnabled.length !== 0) {
125 const tasks: (Bluebird<Bull.Job<any>> | Promise<Bull.Job<any>>)[] = []
127 for (const resolution of resolutionsEnabled) {
128 let dataInput: VideoTranscodingPayload
130 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED) {
132 type: 'new-resolution' as 'new-resolution',
133 videoUUID: videoDatabase.uuid,
136 } else if (CONFIG.TRANSCODING.HLS.ENABLED) {
139 videoUUID: videoDatabase.uuid,
141 isPortraitMode: false,
146 const p = JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
150 await Promise.all(tasks)
152 logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
154 // No transcoding to do, it's now published
155 videoPublished = await videoDatabase.publishIfNeededAndSave(t)
157 logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
160 await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
162 return { videoDatabase, videoPublished }
165 if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
166 if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
169 // ---------------------------------------------------------------------------
172 processVideoTranscoding,
173 publishNewResolutionIfNeeded
176 // ---------------------------------------------------------------------------
178 function createHlsJobIfEnabled (payload?: { videoUUID: string, resolution: number, isPortraitMode?: boolean }) {
179 // Generate HLS playlist?
180 if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
181 const hlsTranscodingPayload = {
182 type: 'hls' as 'hls',
183 videoUUID: payload.videoUUID,
184 resolution: payload.resolution,
185 isPortraitMode: payload.isPortraitMode,
189 return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })
193 async function publishAndFederateIfNeeded (video: MVideoUUID) {
194 const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
195 // Maybe the video changed in database, refresh it
196 const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
197 // Video does not exist anymore
198 if (!videoDatabase) return undefined
200 // We transcoded the video file in another format, now we can publish it
201 const videoPublished = await videoDatabase.publishIfNeededAndSave(t)
203 // If the video was not published, we consider it is a new one for other instances
204 await federateVideoIfNeeded(videoDatabase, videoPublished, t)
206 return { videoDatabase, videoPublished }
209 if (videoPublished) {
210 Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
211 Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)