1 import { Job } from 'bullmq'
2 import { TranscodeVODOptionsType } from '@server/helpers/ffmpeg'
3 import { Hooks } from '@server/lib/plugins/hooks'
4 import { buildTranscodingJob, getTranscodingJobPriority } from '@server/lib/video'
5 import { VideoPathManager } from '@server/lib/video-path-manager'
6 import { moveToFailedTranscodingState, moveToNextState } from '@server/lib/video-state'
7 import { UserModel } from '@server/models/user/user'
8 import { VideoJobInfoModel } from '@server/models/video/video-job-info'
9 import { MUser, MUserId, MVideo, MVideoFullLight, MVideoWithFile } from '@server/types/models'
10 import { pick } from '@shared/core-utils'
12 HLSTranscodingPayload,
13 MergeAudioTranscodingPayload,
14 NewWebTorrentResolutionTranscodingPayload,
15 OptimizeTranscodingPayload,
17 VideoTranscodingPayload
18 } from '@shared/models'
19 import { retryTransactionWrapper } from '../../../helpers/database-utils'
20 import { computeResolutionsToTranscode } from '../../../helpers/ffmpeg'
21 import { logger, loggerTagsFactory } from '../../../helpers/logger'
22 import { CONFIG } from '../../../initializers/config'
23 import { VideoModel } from '../../../models/video/video'
25 generateHlsPlaylistResolution,
27 optimizeOriginalVideofile,
28 transcodeNewWebTorrentResolution
29 } from '../../transcoding/transcoding'
30 import { JobQueue } from '../job-queue'
32 type HandlerFunction = (job: Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<void>
34 const handlers: { [ id in VideoTranscodingPayload['type'] ]: HandlerFunction } = {
35 'new-resolution-to-hls': handleHLSJob,
36 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
37 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
38 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
41 const lTags = loggerTagsFactory('transcoding')
43 async function processVideoTranscoding (job: Job) {
44 const payload = job.data as VideoTranscodingPayload
45 logger.info('Processing transcoding job %s.', job.id, lTags(payload.videoUUID))
47 const video = await VideoModel.loadFull(payload.videoUUID)
48 // No video, maybe deleted?
50 logger.info('Do not process job %d, video does not exist.', job.id, lTags(payload.videoUUID))
54 const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
56 const handler = handlers[payload.type]
59 await moveToFailedTranscodingState(video)
60 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
62 throw new Error('Cannot find transcoding handler for ' + payload.type)
66 await handler(job, payload, video, user)
68 await moveToFailedTranscodingState(video)
70 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
78 // ---------------------------------------------------------------------------
81 processVideoTranscoding
84 // ---------------------------------------------------------------------------
86 // ---------------------------------------------------------------------------
88 async function handleHLSJob (job: Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
89 logger.info('Handling HLS transcoding job for %s.', video.uuid, lTags(video.uuid))
91 const videoFileInput = payload.copyCodecs
92 ? video.getWebTorrentFile(payload.resolution)
93 : video.getMaxQualityFile()
95 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
97 const inputFileMutexReleaser = await VideoPathManager.Instance.lockFiles(video.uuid)
100 await videoFileInput.getVideo().reload()
102 await VideoPathManager.Instance.makeAvailableVideoFile(videoFileInput.withVideoOrPlaylist(videoOrStreamingPlaylist), videoInputPath => {
103 return generateHlsPlaylistResolution({
106 inputFileMutexReleaser,
107 resolution: payload.resolution,
108 copyCodecs: payload.copyCodecs,
113 inputFileMutexReleaser()
116 logger.info('HLS transcoding job for %s ended.', video.uuid, lTags(video.uuid))
118 await onHlsPlaylistGeneration(video, user, payload)
121 async function handleNewWebTorrentResolutionJob (
123 payload: NewWebTorrentResolutionTranscodingPayload,
124 video: MVideoFullLight,
127 logger.info('Handling WebTorrent transcoding job for %s.', video.uuid, lTags(video.uuid))
129 await transcodeNewWebTorrentResolution({ video, resolution: payload.resolution, job })
131 logger.info('WebTorrent transcoding job for %s ended.', video.uuid, lTags(video.uuid))
133 await onNewWebTorrentFileResolution(video, user, payload)
136 async function handleWebTorrentMergeAudioJob (job: Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
137 logger.info('Handling merge audio transcoding job for %s.', video.uuid, lTags(video.uuid))
139 await mergeAudioVideofile({ video, resolution: payload.resolution, job })
141 logger.info('Merge audio transcoding job for %s ended.', video.uuid, lTags(video.uuid))
143 await onVideoFirstWebTorrentTranscoding(video, payload, 'video', user)
146 async function handleWebTorrentOptimizeJob (job: Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
147 logger.info('Handling optimize transcoding job for %s.', video.uuid, lTags(video.uuid))
149 const { transcodeType } = await optimizeOriginalVideofile({ video, inputVideoFile: video.getMaxQualityFile(), job })
151 logger.info('Optimize transcoding job for %s ended.', video.uuid, lTags(video.uuid))
153 await onVideoFirstWebTorrentTranscoding(video, payload, transcodeType, user)
156 // ---------------------------------------------------------------------------
158 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
159 if (payload.isMaxQuality && payload.autoDeleteWebTorrentIfNeeded && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
160 // Remove webtorrent files if not enabled
161 for (const file of video.VideoFiles) {
162 await video.removeWebTorrentFile(file)
166 video.VideoFiles = []
168 // Create HLS new resolution jobs
169 await createLowerResolutionsJobs({
172 videoFileResolution: payload.resolution,
173 hasAudio: payload.hasAudio,
174 isNewVideo: payload.isNewVideo ?? true,
179 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
180 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
183 async function onVideoFirstWebTorrentTranscoding (
184 videoArg: MVideoWithFile,
185 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
186 transcodeType: TranscodeVODOptionsType,
189 const mutexReleaser = await VideoPathManager.Instance.lockFiles(videoArg.uuid)
192 // Maybe the video changed in database, refresh it
193 const videoDatabase = await VideoModel.loadFull(videoArg.uuid)
194 // Video does not exist anymore
195 if (!videoDatabase) return undefined
197 const { resolution, audioStream } = await videoDatabase.probeMaxQualityFile()
199 // Generate HLS version of the original file
200 const originalFileHLSPayload = {
203 hasAudio: !!audioStream,
204 resolution: videoDatabase.getMaxQualityFile().resolution,
205 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
206 copyCodecs: transcodeType !== 'quick-transcode',
209 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
210 const hasNewResolutions = await createLowerResolutionsJobs({
211 video: videoDatabase,
213 videoFileResolution: resolution,
214 hasAudio: !!audioStream,
216 isNewVideo: payload.isNewVideo ?? true
219 await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
221 // Move to next state if there are no other resolutions to generate
222 if (!hasHls && !hasNewResolutions) {
223 await retryTransactionWrapper(moveToNextState, { video: videoDatabase, isNewVideo: payload.isNewVideo })
230 async function onNewWebTorrentFileResolution (
233 payload: NewWebTorrentResolutionTranscodingPayload | MergeAudioTranscodingPayload
235 if (payload.createHLSIfNeeded) {
236 await createHlsJobIfEnabled(user, { hasAudio: true, copyCodecs: true, isMaxQuality: false, ...payload })
239 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
241 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
244 // ---------------------------------------------------------------------------
246 async function createHlsJobIfEnabled (user: MUserId, payload: {
251 isMaxQuality: boolean
254 if (!payload || CONFIG.TRANSCODING.ENABLED !== true || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
257 priority: await getTranscodingJobPriority(user)
260 const hlsTranscodingPayload: HLSTranscodingPayload = {
261 type: 'new-resolution-to-hls',
262 autoDeleteWebTorrentIfNeeded: true,
264 ...pick(payload, [ 'videoUUID', 'resolution', 'copyCodecs', 'isMaxQuality', 'isNewVideo', 'hasAudio' ])
267 await JobQueue.Instance.createJob(await buildTranscodingJob(hlsTranscodingPayload, jobOptions))
272 async function createLowerResolutionsJobs (options: {
273 video: MVideoFullLight
275 videoFileResolution: number
278 type: 'hls' | 'webtorrent'
280 const { video, user, videoFileResolution, isNewVideo, hasAudio, type } = options
282 // Create transcoding jobs if there are enabled resolutions
283 const resolutionsEnabled = await Hooks.wrapObject(
284 computeResolutionsToTranscode({ input: videoFileResolution, type: 'vod', includeInput: false, strictLower: true }),
285 'filter:transcoding.auto.resolutions-to-transcode.result',
289 const resolutionCreated: string[] = []
291 for (const resolution of resolutionsEnabled) {
292 if (resolution === VideoResolution.H_NOVIDEO && hasAudio === false) continue
294 let dataInput: VideoTranscodingPayload
296 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
297 // WebTorrent will create subsequent HLS job
299 type: 'new-resolution-to-webtorrent',
300 videoUUID: video.uuid,
303 createHLSIfNeeded: true,
307 resolutionCreated.push('webtorrent-' + resolution)
310 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
312 type: 'new-resolution-to-hls',
313 videoUUID: video.uuid,
318 autoDeleteWebTorrentIfNeeded: true,
322 resolutionCreated.push('hls-' + resolution)
325 if (!dataInput) continue
328 priority: await getTranscodingJobPriority(user)
331 await JobQueue.Instance.createJob(await buildTranscodingJob(dataInput, jobOptions))
334 if (resolutionCreated.length === 0) {
335 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid, lTags(video.uuid))
341 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
342 { resolutionCreated, ...lTags(video.uuid) }