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 await VideoPathManager.Instance.makeAvailableVideoFile(videoFileInput.withVideoOrPlaylist(videoOrStreamingPlaylist), videoInputPath => {
98 return generateHlsPlaylistResolution({
101 resolution: payload.resolution,
102 copyCodecs: payload.copyCodecs,
107 logger.info('HLS transcoding job for %s ended.', video.uuid, lTags(video.uuid))
109 await onHlsPlaylistGeneration(video, user, payload)
112 async function handleNewWebTorrentResolutionJob (
114 payload: NewWebTorrentResolutionTranscodingPayload,
115 video: MVideoFullLight,
118 logger.info('Handling WebTorrent transcoding job for %s.', video.uuid, lTags(video.uuid))
120 await transcodeNewWebTorrentResolution({ video, resolution: payload.resolution, job })
122 logger.info('WebTorrent transcoding job for %s ended.', video.uuid, lTags(video.uuid))
124 await onNewWebTorrentFileResolution(video, user, payload)
127 async function handleWebTorrentMergeAudioJob (job: Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
128 logger.info('Handling merge audio transcoding job for %s.', video.uuid, lTags(video.uuid))
130 await mergeAudioVideofile({ video, resolution: payload.resolution, job })
132 logger.info('Merge audio transcoding job for %s ended.', video.uuid, lTags(video.uuid))
134 await onVideoFirstWebTorrentTranscoding(video, payload, 'video', user)
137 async function handleWebTorrentOptimizeJob (job: Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
138 logger.info('Handling optimize transcoding job for %s.', video.uuid, lTags(video.uuid))
140 const { transcodeType } = await optimizeOriginalVideofile({ video, inputVideoFile: video.getMaxQualityFile(), job })
142 logger.info('Optimize transcoding job for %s ended.', video.uuid, lTags(video.uuid))
144 await onVideoFirstWebTorrentTranscoding(video, payload, transcodeType, user)
147 // ---------------------------------------------------------------------------
149 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
150 if (payload.isMaxQuality && payload.autoDeleteWebTorrentIfNeeded && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
151 // Remove webtorrent files if not enabled
152 for (const file of video.VideoFiles) {
153 await video.removeWebTorrentFile(file)
157 video.VideoFiles = []
159 // Create HLS new resolution jobs
160 await createLowerResolutionsJobs({
163 videoFileResolution: payload.resolution,
164 hasAudio: payload.hasAudio,
165 isNewVideo: payload.isNewVideo ?? true,
170 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
171 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
174 async function onVideoFirstWebTorrentTranscoding (
175 videoArg: MVideoWithFile,
176 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
177 transcodeType: TranscodeVODOptionsType,
180 const { resolution, audioStream } = await videoArg.probeMaxQualityFile()
182 // Maybe the video changed in database, refresh it
183 const videoDatabase = await VideoModel.loadFull(videoArg.uuid)
184 // Video does not exist anymore
185 if (!videoDatabase) return undefined
187 // Generate HLS version of the original file
188 const originalFileHLSPayload = {
191 hasAudio: !!audioStream,
192 resolution: videoDatabase.getMaxQualityFile().resolution,
193 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
194 copyCodecs: transcodeType !== 'quick-transcode',
197 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
198 const hasNewResolutions = await createLowerResolutionsJobs({
199 video: videoDatabase,
201 videoFileResolution: resolution,
202 hasAudio: !!audioStream,
204 isNewVideo: payload.isNewVideo ?? true
207 await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
209 // Move to next state if there are no other resolutions to generate
210 if (!hasHls && !hasNewResolutions) {
211 await retryTransactionWrapper(moveToNextState, { video: videoDatabase, isNewVideo: payload.isNewVideo })
215 async function onNewWebTorrentFileResolution (
218 payload: NewWebTorrentResolutionTranscodingPayload | MergeAudioTranscodingPayload
220 if (payload.createHLSIfNeeded) {
221 await createHlsJobIfEnabled(user, { hasAudio: true, copyCodecs: true, isMaxQuality: false, ...payload })
224 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
226 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
229 // ---------------------------------------------------------------------------
231 async function createHlsJobIfEnabled (user: MUserId, payload: {
236 isMaxQuality: boolean
239 if (!payload || CONFIG.TRANSCODING.ENABLED !== true || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
242 priority: await getTranscodingJobPriority(user)
245 const hlsTranscodingPayload: HLSTranscodingPayload = {
246 type: 'new-resolution-to-hls',
247 autoDeleteWebTorrentIfNeeded: true,
249 ...pick(payload, [ 'videoUUID', 'resolution', 'copyCodecs', 'isMaxQuality', 'isNewVideo', 'hasAudio' ])
252 await JobQueue.Instance.createJob(await buildTranscodingJob(hlsTranscodingPayload, jobOptions))
257 async function createLowerResolutionsJobs (options: {
258 video: MVideoFullLight
260 videoFileResolution: number
263 type: 'hls' | 'webtorrent'
265 const { video, user, videoFileResolution, isNewVideo, hasAudio, type } = options
267 // Create transcoding jobs if there are enabled resolutions
268 const resolutionsEnabled = await Hooks.wrapObject(
269 computeResolutionsToTranscode({ input: videoFileResolution, type: 'vod', includeInput: false, strictLower: true }),
270 'filter:transcoding.auto.resolutions-to-transcode.result',
274 const resolutionCreated: string[] = []
276 for (const resolution of resolutionsEnabled) {
277 if (resolution === VideoResolution.H_NOVIDEO && hasAudio === false) continue
279 let dataInput: VideoTranscodingPayload
281 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
282 // WebTorrent will create subsequent HLS job
284 type: 'new-resolution-to-webtorrent',
285 videoUUID: video.uuid,
288 createHLSIfNeeded: true,
292 resolutionCreated.push('webtorrent-' + resolution)
295 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
297 type: 'new-resolution-to-hls',
298 videoUUID: video.uuid,
303 autoDeleteWebTorrentIfNeeded: true,
307 resolutionCreated.push('hls-' + resolution)
310 if (!dataInput) continue
313 priority: await getTranscodingJobPriority(user)
316 await JobQueue.Instance.createJob(await buildTranscodingJob(dataInput, jobOptions))
319 if (resolutionCreated.length === 0) {
320 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid, lTags(video.uuid))
326 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
327 { resolutionCreated, ...lTags(video.uuid) }