1 import { Job } from 'bull'
2 import { TranscodeVODOptionsType } from '@server/helpers/ffmpeg'
3 import { addTranscodingJob, getTranscodingJobPriority } from '@server/lib/video'
4 import { VideoPathManager } from '@server/lib/video-path-manager'
5 import { moveToFailedTranscodingState, moveToNextState } from '@server/lib/video-state'
6 import { UserModel } from '@server/models/user/user'
7 import { VideoJobInfoModel } from '@server/models/video/video-job-info'
8 import { MUser, MUserId, MVideo, MVideoFullLight, MVideoWithFile } from '@server/types/models'
9 import { pick } from '@shared/core-utils'
11 HLSTranscodingPayload,
12 MergeAudioTranscodingPayload,
13 NewWebTorrentResolutionTranscodingPayload,
14 OptimizeTranscodingPayload,
16 VideoTranscodingPayload
17 } from '@shared/models'
18 import { retryTransactionWrapper } from '../../../helpers/database-utils'
19 import { computeLowerResolutionsToTranscode } from '../../../helpers/ffmpeg'
20 import { logger, loggerTagsFactory } from '../../../helpers/logger'
21 import { CONFIG } from '../../../initializers/config'
22 import { VideoModel } from '../../../models/video/video'
24 generateHlsPlaylistResolution,
26 optimizeOriginalVideofile,
27 transcodeNewWebTorrentResolution
28 } from '../../transcoding/transcoding'
29 import { Hooks } from '@server/lib/plugins/hooks'
31 type HandlerFunction = (job: Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<void>
33 const handlers: { [ id in VideoTranscodingPayload['type'] ]: HandlerFunction } = {
34 'new-resolution-to-hls': handleHLSJob,
35 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
36 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
37 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
40 const lTags = loggerTagsFactory('transcoding')
42 async function processVideoTranscoding (job: Job) {
43 const payload = job.data as VideoTranscodingPayload
44 logger.info('Processing transcoding job %d.', job.id, lTags(payload.videoUUID))
46 const video = await VideoModel.loadFull(payload.videoUUID)
47 // No video, maybe deleted?
49 logger.info('Do not process job %d, video does not exist.', job.id, lTags(payload.videoUUID))
53 const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
55 const handler = handlers[payload.type]
58 await moveToFailedTranscodingState(video)
59 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
61 throw new Error('Cannot find transcoding handler for ' + payload.type)
65 await handler(job, payload, video, user)
67 await moveToFailedTranscodingState(video)
69 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
77 // ---------------------------------------------------------------------------
80 processVideoTranscoding
83 // ---------------------------------------------------------------------------
85 // ---------------------------------------------------------------------------
87 async function handleHLSJob (job: Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
88 logger.info('Handling HLS transcoding job for %s.', video.uuid, lTags(video.uuid))
90 const videoFileInput = payload.copyCodecs
91 ? video.getWebTorrentFile(payload.resolution)
92 : video.getMaxQualityFile()
94 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
96 await VideoPathManager.Instance.makeAvailableVideoFile(videoFileInput.withVideoOrPlaylist(videoOrStreamingPlaylist), videoInputPath => {
97 return generateHlsPlaylistResolution({
100 resolution: payload.resolution,
101 copyCodecs: payload.copyCodecs,
102 isPortraitMode: payload.isPortraitMode || false,
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, payload.resolution, payload.isPortraitMode || false, 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, 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, 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 isPortraitMode: payload.isPortraitMode,
165 hasAudio: payload.hasAudio,
166 isNewVideo: payload.isNewVideo ?? true,
171 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
172 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
175 async function onVideoFirstWebTorrentTranscoding (
176 videoArg: MVideoWithFile,
177 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
178 transcodeType: TranscodeVODOptionsType,
181 const { resolution, isPortraitMode, audioStream } = await videoArg.probeMaxQualityFile()
183 // Maybe the video changed in database, refresh it
184 const videoDatabase = await VideoModel.loadFull(videoArg.uuid)
185 // Video does not exist anymore
186 if (!videoDatabase) return undefined
188 // Generate HLS version of the original file
189 const originalFileHLSPayload = {
193 hasAudio: !!audioStream,
194 resolution: videoDatabase.getMaxQualityFile().resolution,
195 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
196 copyCodecs: transcodeType !== 'quick-transcode',
199 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
200 const hasNewResolutions = await createLowerResolutionsJobs({
201 video: videoDatabase,
203 videoFileResolution: resolution,
204 hasAudio: !!audioStream,
207 isNewVideo: payload.isNewVideo ?? true
210 await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
212 // Move to next state if there are no other resolutions to generate
213 if (!hasHls && !hasNewResolutions) {
214 await retryTransactionWrapper(moveToNextState, { video: videoDatabase, isNewVideo: payload.isNewVideo })
218 async function onNewWebTorrentFileResolution (
221 payload: NewWebTorrentResolutionTranscodingPayload | MergeAudioTranscodingPayload
223 if (payload.createHLSIfNeeded) {
224 await createHlsJobIfEnabled(user, { hasAudio: true, copyCodecs: true, isMaxQuality: false, ...payload })
227 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
229 await retryTransactionWrapper(moveToNextState, { video, isNewVideo: payload.isNewVideo })
232 // ---------------------------------------------------------------------------
234 async function createHlsJobIfEnabled (user: MUserId, payload: {
238 isPortraitMode?: boolean
240 isMaxQuality: boolean
243 if (!payload || CONFIG.TRANSCODING.ENABLED !== true || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
246 priority: await getTranscodingJobPriority(user)
249 const hlsTranscodingPayload: HLSTranscodingPayload = {
250 type: 'new-resolution-to-hls',
251 autoDeleteWebTorrentIfNeeded: true,
253 ...pick(payload, [ 'videoUUID', 'resolution', 'isPortraitMode', 'copyCodecs', 'isMaxQuality', 'isNewVideo', 'hasAudio' ])
256 await addTranscodingJob(hlsTranscodingPayload, jobOptions)
261 async function createLowerResolutionsJobs (options: {
262 video: MVideoFullLight
264 videoFileResolution: number
265 isPortraitMode: boolean
268 type: 'hls' | 'webtorrent'
270 const { video, user, videoFileResolution, isPortraitMode, isNewVideo, hasAudio, type } = options
272 // Create transcoding jobs if there are enabled resolutions
273 const resolutionsEnabled = await Hooks.wrapObject(
274 computeLowerResolutionsToTranscode(videoFileResolution, 'vod'),
275 'filter:transcoding.auto.lower-resolutions-to-transcode.result',
279 const resolutionCreated: string[] = []
281 for (const resolution of resolutionsEnabled) {
282 if (resolution === VideoResolution.H_NOVIDEO && hasAudio === false) continue
284 let dataInput: VideoTranscodingPayload
286 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
287 // WebTorrent will create subsequent HLS job
289 type: 'new-resolution-to-webtorrent',
290 videoUUID: video.uuid,
294 createHLSIfNeeded: true,
298 resolutionCreated.push('webtorrent-' + resolution)
301 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
303 type: 'new-resolution-to-hls',
304 videoUUID: video.uuid,
310 autoDeleteWebTorrentIfNeeded: true,
314 resolutionCreated.push('hls-' + resolution)
317 if (!dataInput) continue
320 priority: await getTranscodingJobPriority(user)
323 await addTranscodingJob(dataInput, jobOptions)
326 if (resolutionCreated.length === 0) {
327 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid, lTags(video.uuid))
333 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
334 { resolutionCreated, ...lTags(video.uuid) }