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 { sequelizeTypescript } from '../../../initializers'
9 import * as Bluebird from 'bluebird'
10 import { computeResolutionsToTranscode } from '../../../helpers/ffmpeg-utils'
11 import { generateHlsPlaylist, optimizeVideofile, transcodeOriginalVideofile, mergeAudioVideofile } from '../../video-transcoding'
12 import { Notifier } from '../../notifier'
13 import { CONFIG } from '../../../initializers/config'
14 import { MVideoUUID, MVideoWithFile } from '@server/typings/models'
16 interface BaseTranscodingPayload {
21 interface HLSTranscodingPayload extends BaseTranscodingPayload {
23 isPortraitMode?: boolean
24 resolution: VideoResolution
27 interface NewResolutionTranscodingPayload extends BaseTranscodingPayload {
28 type: 'new-resolution'
29 isPortraitMode?: boolean
30 resolution: VideoResolution
33 interface MergeAudioTranscodingPayload extends BaseTranscodingPayload {
35 resolution: VideoResolution
38 interface OptimizeTranscodingPayload extends BaseTranscodingPayload {
42 export type VideoTranscodingPayload = HLSTranscodingPayload | NewResolutionTranscodingPayload
43 | OptimizeTranscodingPayload | MergeAudioTranscodingPayload
45 async function processVideoTranscoding (job: Bull.Job) {
46 const payload = job.data as VideoTranscodingPayload
47 logger.info('Processing video file in job %d.', job.id)
49 const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
50 // No video, maybe deleted?
52 logger.info('Do not process job %d, video does not exist.', job.id)
56 if (payload.type === 'hls') {
57 await generateHlsPlaylist(video, payload.resolution, payload.isPortraitMode || false)
59 await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
60 } else if (payload.type === 'new-resolution') {
61 await transcodeOriginalVideofile(video, payload.resolution, payload.isPortraitMode || false)
63 await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
64 } else if (payload.type === 'merge-audio') {
65 await mergeAudioVideofile(video, payload.resolution)
67 await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
69 await optimizeVideofile(video)
71 await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload)
77 async function onHlsPlaylistGenerationSuccess (video: MVideoUUID) {
78 if (video === undefined) return undefined
80 await sequelizeTypescript.transaction(async t => {
81 // Maybe the video changed in database, refresh it
82 let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
83 // Video does not exist anymore
84 if (!videoDatabase) return undefined
86 // If the video was not published, we consider it is a new one for other instances
87 await federateVideoIfNeeded(videoDatabase, false, t)
91 async function publishNewResolutionIfNeeded (video: MVideoUUID, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
92 const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
93 // Maybe the video changed in database, refresh it
94 let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
95 // Video does not exist anymore
96 if (!videoDatabase) return undefined
98 let videoPublished = false
100 // We transcoded the video file in another format, now we can publish it
101 if (videoDatabase.state !== VideoState.PUBLISHED) {
102 videoPublished = true
104 videoDatabase.state = VideoState.PUBLISHED
105 videoDatabase.publishedAt = new Date()
106 videoDatabase = await videoDatabase.save({ transaction: t })
109 // If the video was not published, we consider it is a new one for other instances
110 await federateVideoIfNeeded(videoDatabase, videoPublished, t)
112 return { videoDatabase, videoPublished }
115 if (videoPublished) {
116 Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
117 Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
120 await createHlsJobIfEnabled(payload)
123 async function onVideoFileOptimizerSuccess (videoArg: MVideoWithFile, payload: OptimizeTranscodingPayload) {
124 if (videoArg === undefined) return undefined
126 // Outside the transaction (IO on disk)
127 const { videoFileResolution } = await videoArg.getOriginalFileResolution()
129 const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
130 // Maybe the video changed in database, refresh it
131 let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
132 // Video does not exist anymore
133 if (!videoDatabase) return undefined
135 // Create transcoding jobs if there are enabled resolutions
136 const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution)
138 'Resolutions computed for video %s and origin file height of %d.', videoDatabase.uuid, videoFileResolution,
139 { resolutions: resolutionsEnabled }
142 let videoPublished = false
144 if (resolutionsEnabled.length !== 0) {
145 const tasks: (Bluebird<Bull.Job<any>> | Promise<Bull.Job<any>>)[] = []
147 for (const resolution of resolutionsEnabled) {
149 type: 'new-resolution' as 'new-resolution',
150 videoUUID: videoDatabase.uuid,
154 const p = JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
158 await Promise.all(tasks)
160 logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
162 videoPublished = true
164 // No transcoding to do, it's now published
165 videoDatabase.state = VideoState.PUBLISHED
166 videoDatabase = await videoDatabase.save({ transaction: t })
168 logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
171 await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
173 return { videoDatabase, videoPublished }
176 if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
177 if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
179 const hlsPayload = Object.assign({}, payload, { resolution: videoDatabase.getOriginalFile().resolution })
180 await createHlsJobIfEnabled(hlsPayload)
183 // ---------------------------------------------------------------------------
186 processVideoTranscoding,
187 publishNewResolutionIfNeeded
190 // ---------------------------------------------------------------------------
192 function createHlsJobIfEnabled (payload?: { videoUUID: string, resolution: number, isPortraitMode?: boolean }) {
193 // Generate HLS playlist?
194 if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
195 const hlsTranscodingPayload = {
196 type: 'hls' as 'hls',
197 videoUUID: payload.videoUUID,
198 resolution: payload.resolution,
199 isPortraitMode: payload.isPortraitMode
202 return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })