1 import { Job } from 'bull'
2 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
3 import { addTranscodingJob, getTranscodingJobPriority } from '@server/lib/video'
4 import { VideoPathManager } from '@server/lib/video-path-manager'
5 import { 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'
10 HLSTranscodingPayload,
11 MergeAudioTranscodingPayload,
12 NewResolutionTranscodingPayload,
13 OptimizeTranscodingPayload,
14 VideoTranscodingPayload
15 } from '../../../../shared'
16 import { retryTransactionWrapper } from '../../../helpers/database-utils'
17 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
18 import { logger, loggerTagsFactory } from '../../../helpers/logger'
19 import { CONFIG } from '../../../initializers/config'
20 import { VideoModel } from '../../../models/video/video'
22 generateHlsPlaylistResolution,
24 optimizeOriginalVideofile,
25 transcodeNewWebTorrentResolution
26 } from '../../transcoding/video-transcoding'
28 type HandlerFunction = (job: Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<void>
30 const handlers: { [ id in VideoTranscodingPayload['type'] ]: HandlerFunction } = {
31 'new-resolution-to-hls': handleHLSJob,
32 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
33 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
34 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
37 const lTags = loggerTagsFactory('transcoding')
39 async function processVideoTranscoding (job: Job) {
40 const payload = job.data as VideoTranscodingPayload
41 logger.info('Processing transcoding job %d.', job.id, lTags(payload.videoUUID))
43 const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
44 // No video, maybe deleted?
46 logger.info('Do not process job %d, video does not exist.', job.id, lTags(payload.videoUUID))
50 const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
52 const handler = handlers[payload.type]
55 throw new Error('Cannot find transcoding handler for ' + payload.type)
58 await handler(job, payload, video, user)
63 // ---------------------------------------------------------------------------
65 // ---------------------------------------------------------------------------
67 async function handleHLSJob (job: Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
68 logger.info('Handling HLS transcoding job for %s.', video.uuid, lTags(video.uuid))
70 const videoFileInput = payload.copyCodecs
71 ? video.getWebTorrentFile(payload.resolution)
72 : video.getMaxQualityFile()
74 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
76 await VideoPathManager.Instance.makeAvailableVideoFile(videoOrStreamingPlaylist, videoFileInput, videoInputPath => {
77 return generateHlsPlaylistResolution({
80 resolution: payload.resolution,
81 copyCodecs: payload.copyCodecs,
82 isPortraitMode: payload.isPortraitMode || false,
87 logger.info('HLS transcoding job for %s ended.', video.uuid, lTags(video.uuid))
89 await retryTransactionWrapper(onHlsPlaylistGeneration, video, user, payload)
92 async function handleNewWebTorrentResolutionJob (
94 payload: NewResolutionTranscodingPayload,
95 video: MVideoFullLight,
98 logger.info('Handling WebTorrent transcoding job for %s.', video.uuid, lTags(video.uuid))
100 await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
102 logger.info('WebTorrent transcoding job for %s ended.', video.uuid, lTags(video.uuid))
104 await retryTransactionWrapper(onNewWebTorrentFileResolution, video, user, payload)
107 async function handleWebTorrentMergeAudioJob (job: Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
108 logger.info('Handling merge audio transcoding job for %s.', video.uuid, lTags(video.uuid))
110 await mergeAudioVideofile(video, payload.resolution, job)
112 logger.info('Merge audio transcoding job for %s ended.', video.uuid, lTags(video.uuid))
114 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, 'video', user)
117 async function handleWebTorrentOptimizeJob (job: Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
118 logger.info('Handling optimize transcoding job for %s.', video.uuid, lTags(video.uuid))
120 const { transcodeType } = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
122 logger.info('Optimize transcoding job for %s ended.', video.uuid, lTags(video.uuid))
124 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, transcodeType, user)
127 // ---------------------------------------------------------------------------
129 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
130 if (payload.isMaxQuality && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
131 // Remove webtorrent files if not enabled
132 for (const file of video.VideoFiles) {
133 await video.removeFileAndTorrent(file)
137 video.VideoFiles = []
139 // Create HLS new resolution jobs
140 await createLowerResolutionsJobs({
143 videoFileResolution: payload.resolution,
144 isPortraitMode: payload.isPortraitMode,
145 isNewVideo: payload.isNewVideo ?? true,
150 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
151 await moveToNextState(video, payload.isNewVideo)
154 async function onVideoFileOptimizer (
155 videoArg: MVideoWithFile,
156 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
157 transcodeType: TranscodeOptionsType,
160 const { resolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
162 // Maybe the video changed in database, refresh it
163 const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
164 // Video does not exist anymore
165 if (!videoDatabase) return undefined
167 // Generate HLS version of the original file
168 const originalFileHLSPayload = {
172 resolution: videoDatabase.getMaxQualityFile().resolution,
173 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
174 copyCodecs: transcodeType !== 'quick-transcode',
177 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
178 const hasNewResolutions = await createLowerResolutionsJobs({
179 video: videoDatabase,
181 videoFileResolution: resolution,
184 isNewVideo: payload.isNewVideo ?? true
187 await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
189 // Move to next state if there are no other resolutions to generate
190 if (!hasHls && !hasNewResolutions) {
191 await moveToNextState(videoDatabase, payload.isNewVideo)
195 async function onNewWebTorrentFileResolution (
198 payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
200 await createHlsJobIfEnabled(user, { ...payload, copyCodecs: true, isMaxQuality: false })
201 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
203 await moveToNextState(video, payload.isNewVideo)
206 async function createHlsJobIfEnabled (user: MUserId, payload: {
209 isPortraitMode?: boolean
211 isMaxQuality: boolean
214 if (!payload || CONFIG.TRANSCODING.ENABLED !== true || 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,
227 isNewVideo: payload.isNewVideo
230 await addTranscodingJob(hlsTranscodingPayload, jobOptions)
235 // ---------------------------------------------------------------------------
238 processVideoTranscoding,
239 createHlsJobIfEnabled,
240 onNewWebTorrentFileResolution
243 // ---------------------------------------------------------------------------
245 async function createLowerResolutionsJobs (options: {
246 video: MVideoFullLight
248 videoFileResolution: number
249 isPortraitMode: boolean
251 type: 'hls' | 'webtorrent'
253 const { video, user, videoFileResolution, isPortraitMode, isNewVideo, type } = options
255 // Create transcoding jobs if there are enabled resolutions
256 const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
257 const resolutionCreated: string[] = []
259 for (const resolution of resolutionsEnabled) {
260 let dataInput: VideoTranscodingPayload
262 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
263 // WebTorrent will create subsequent HLS job
265 type: 'new-resolution-to-webtorrent',
266 videoUUID: video.uuid,
272 resolutionCreated.push('webtorrent-' + resolution)
275 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
277 type: 'new-resolution-to-hls',
278 videoUUID: video.uuid,
286 resolutionCreated.push('hls-' + resolution)
289 if (!dataInput) continue
292 priority: await getTranscodingJobPriority(user)
295 await addTranscodingJob(dataInput, jobOptions)
298 if (resolutionCreated.length === 0) {
299 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid, lTags(video.uuid))
305 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
306 { resolutionCreated, ...lTags(video.uuid) }