1 import * as Bull from 'bull'
2 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
3 import { getTranscodingJobPriority, publishAndFederateIfNeeded } from '@server/lib/video'
4 import { getVideoFilePath } from '@server/lib/video-paths'
5 import { UserModel } from '@server/models/account/user'
6 import { MUser, MUserId, MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
9 MergeAudioTranscodingPayload,
10 NewResolutionTranscodingPayload,
11 OptimizeTranscodingPayload,
12 VideoTranscodingPayload
13 } from '../../../../shared'
14 import { retryTransactionWrapper } from '../../../helpers/database-utils'
15 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
16 import { logger } from '../../../helpers/logger'
17 import { CONFIG } from '../../../initializers/config'
18 import { sequelizeTypescript } from '../../../initializers/database'
19 import { VideoModel } from '../../../models/video/video'
20 import { federateVideoIfNeeded } from '../../activitypub/videos'
21 import { Notifier } from '../../notifier'
23 generateHlsPlaylistResolution,
25 optimizeOriginalVideofile,
26 transcodeNewWebTorrentResolution
27 } from '../../transcoding/video-transcoding'
28 import { JobQueue } from '../job-queue'
30 type HandlerFunction = (job: Bull.Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<any>
32 const handlers: { [ id: string ]: HandlerFunction } = {
33 // Deprecated, introduced in 3.1
35 'new-resolution-to-hls': handleHLSJob,
37 // Deprecated, introduced in 3.1
38 'new-resolution': handleNewWebTorrentResolutionJob,
39 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
41 // Deprecated, introduced in 3.1
42 'merge-audio': handleWebTorrentMergeAudioJob,
43 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
45 // Deprecated, introduced in 3.1
46 'optimize': handleWebTorrentOptimizeJob,
47 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
50 async function processVideoTranscoding (job: Bull.Job) {
51 const payload = job.data as VideoTranscodingPayload
52 logger.info('Processing video file in job %d.', job.id)
54 const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
55 // No video, maybe deleted?
57 logger.info('Do not process job %d, video does not exist.', job.id)
61 const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
63 const handler = handlers[payload.type]
66 throw new Error('Cannot find transcoding handler for ' + payload.type)
69 await handler(job, payload, video, user)
74 // ---------------------------------------------------------------------------
76 // ---------------------------------------------------------------------------
78 async function handleHLSJob (job: Bull.Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
79 const videoFileInput = payload.copyCodecs
80 ? video.getWebTorrentFile(payload.resolution)
81 : video.getMaxQualityFile()
83 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
84 const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
86 await generateHlsPlaylistResolution({
89 resolution: payload.resolution,
90 copyCodecs: payload.copyCodecs,
91 isPortraitMode: payload.isPortraitMode || false,
95 await retryTransactionWrapper(onHlsPlaylistGeneration, video, user, payload)
98 async function handleNewWebTorrentResolutionJob (
100 payload: NewResolutionTranscodingPayload,
101 video: MVideoFullLight,
104 await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
106 await retryTransactionWrapper(onNewWebTorrentFileResolution, video, user, payload)
109 async function handleWebTorrentMergeAudioJob (job: Bull.Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
110 await mergeAudioVideofile(video, payload.resolution, job)
112 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, 'video', user)
115 async function handleWebTorrentOptimizeJob (job: Bull.Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
116 const transcodeType = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
118 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, transcodeType, user)
121 // ---------------------------------------------------------------------------
123 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
124 if (video === undefined) return undefined
126 if (payload.isMaxQuality && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
127 // Remove webtorrent files if not enabled
128 for (const file of video.VideoFiles) {
129 await video.removeFile(file)
130 await file.removeTorrent()
134 video.VideoFiles = []
136 // Create HLS new resolution jobs
137 await createLowerResolutionsJobs(video, user, payload.resolution, payload.isPortraitMode, 'hls')
140 return publishAndFederateIfNeeded(video)
143 async function onVideoFileOptimizer (
144 videoArg: MVideoWithFile,
145 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
146 transcodeType: TranscodeOptionsType,
149 if (videoArg === undefined) return undefined
151 // Outside the transaction (IO on disk)
152 const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
154 const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
155 // Maybe the video changed in database, refresh it
156 const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
157 // Video does not exist anymore
158 if (!videoDatabase) return undefined
160 let videoPublished = false
162 // Generate HLS version of the original file
163 const originalFileHLSPayload = Object.assign({}, payload, {
165 resolution: videoDatabase.getMaxQualityFile().resolution,
166 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
167 copyCodecs: transcodeType !== 'quick-transcode',
170 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
172 const hasNewResolutions = await createLowerResolutionsJobs(videoDatabase, user, videoFileResolution, isPortraitMode, 'webtorrent')
174 if (!hasHls && !hasNewResolutions) {
175 // No transcoding to do, it's now published
176 videoPublished = await videoDatabase.publishIfNeededAndSave(t)
179 await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
181 return { videoDatabase, videoPublished }
184 if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
185 if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
188 async function onNewWebTorrentFileResolution (
191 payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
193 await publishAndFederateIfNeeded(video)
195 await createHlsJobIfEnabled(user, Object.assign({}, payload, { copyCodecs: true, isMaxQuality: false }))
198 // ---------------------------------------------------------------------------
201 processVideoTranscoding,
202 onNewWebTorrentFileResolution
205 // ---------------------------------------------------------------------------
207 async function createHlsJobIfEnabled (user: MUserId, payload: {
210 isPortraitMode?: boolean
212 isMaxQuality: boolean
214 if (!payload || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
217 priority: await getTranscodingJobPriority(user)
220 const hlsTranscodingPayload: HLSTranscodingPayload = {
221 type: 'new-resolution-to-hls',
222 videoUUID: payload.videoUUID,
223 resolution: payload.resolution,
224 isPortraitMode: payload.isPortraitMode,
225 copyCodecs: payload.copyCodecs,
226 isMaxQuality: payload.isMaxQuality
229 JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload }, jobOptions)
234 async function createLowerResolutionsJobs (
235 video: MVideoFullLight,
237 videoFileResolution: number,
238 isPortraitMode: boolean,
239 type: 'hls' | 'webtorrent'
241 // Create transcoding jobs if there are enabled resolutions
242 const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
243 const resolutionCreated: number[] = []
245 for (const resolution of resolutionsEnabled) {
246 let dataInput: VideoTranscodingPayload
248 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
249 // WebTorrent will create subsequent HLS job
251 type: 'new-resolution-to-webtorrent',
252 videoUUID: video.uuid,
258 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
260 type: 'new-resolution-to-hls',
261 videoUUID: video.uuid,
269 if (!dataInput) continue
271 resolutionCreated.push(resolution)
274 priority: await getTranscodingJobPriority(user)
277 JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput }, jobOptions)
280 if (resolutionCreated.length === 0) {
281 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
287 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
288 { resolutionCreated }