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 { 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'
10 HLSTranscodingPayload,
11 MergeAudioTranscodingPayload,
12 NewResolutionTranscodingPayload,
13 OptimizeTranscodingPayload,
14 VideoTranscodingPayload
15 } from '@shared/models'
16 import { retryTransactionWrapper } from '../../../helpers/database-utils'
17 import { computeLowerResolutionsToTranscode } 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 await moveToFailedTranscodingState(video)
56 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
58 throw new Error('Cannot find transcoding handler for ' + payload.type)
62 await handler(job, payload, video, user)
64 await moveToFailedTranscodingState(video)
66 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
74 // ---------------------------------------------------------------------------
77 processVideoTranscoding
80 // ---------------------------------------------------------------------------
82 // ---------------------------------------------------------------------------
84 async function handleHLSJob (job: Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
85 logger.info('Handling HLS transcoding job for %s.', video.uuid, lTags(video.uuid))
87 const videoFileInput = payload.copyCodecs
88 ? video.getWebTorrentFile(payload.resolution)
89 : video.getMaxQualityFile()
91 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
93 await VideoPathManager.Instance.makeAvailableVideoFile(videoFileInput.withVideoOrPlaylist(videoOrStreamingPlaylist), videoInputPath => {
94 return generateHlsPlaylistResolution({
97 resolution: payload.resolution,
98 copyCodecs: payload.copyCodecs,
99 isPortraitMode: payload.isPortraitMode || false,
104 logger.info('HLS transcoding job for %s ended.', video.uuid, lTags(video.uuid))
106 await onHlsPlaylistGeneration(video, user, payload)
109 async function handleNewWebTorrentResolutionJob (
111 payload: NewResolutionTranscodingPayload,
112 video: MVideoFullLight,
115 logger.info('Handling WebTorrent transcoding job for %s.', video.uuid, lTags(video.uuid))
117 await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
119 logger.info('WebTorrent transcoding job for %s ended.', video.uuid, lTags(video.uuid))
121 await onNewWebTorrentFileResolution(video, user, payload)
124 async function handleWebTorrentMergeAudioJob (job: Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
125 logger.info('Handling merge audio transcoding job for %s.', video.uuid, lTags(video.uuid))
127 await mergeAudioVideofile(video, payload.resolution, job)
129 logger.info('Merge audio transcoding job for %s ended.', video.uuid, lTags(video.uuid))
131 await onVideoFirstWebTorrentTranscoding(video, payload, 'video', user)
134 async function handleWebTorrentOptimizeJob (job: Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
135 logger.info('Handling optimize transcoding job for %s.', video.uuid, lTags(video.uuid))
137 const { transcodeType } = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
139 logger.info('Optimize transcoding job for %s ended.', video.uuid, lTags(video.uuid))
141 await onVideoFirstWebTorrentTranscoding(video, payload, transcodeType, user)
144 // ---------------------------------------------------------------------------
146 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
147 if (payload.isMaxQuality && payload.autoDeleteWebTorrentIfNeeded && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
148 // Remove webtorrent files if not enabled
149 for (const file of video.VideoFiles) {
150 await video.removeWebTorrentFileAndTorrent(file)
154 video.VideoFiles = []
156 // Create HLS new resolution jobs
157 await createLowerResolutionsJobs({
160 videoFileResolution: payload.resolution,
161 isPortraitMode: payload.isPortraitMode,
162 isNewVideo: payload.isNewVideo ?? true,
167 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
168 await retryTransactionWrapper(moveToNextState, video, payload.isNewVideo)
171 async function onVideoFirstWebTorrentTranscoding (
172 videoArg: MVideoWithFile,
173 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
174 transcodeType: TranscodeOptionsType,
177 const { resolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
179 // Maybe the video changed in database, refresh it
180 const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
181 // Video does not exist anymore
182 if (!videoDatabase) return undefined
184 // Generate HLS version of the original file
185 const originalFileHLSPayload = {
189 resolution: videoDatabase.getMaxQualityFile().resolution,
190 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
191 copyCodecs: transcodeType !== 'quick-transcode',
194 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
195 const hasNewResolutions = await createLowerResolutionsJobs({
196 video: videoDatabase,
198 videoFileResolution: resolution,
201 isNewVideo: payload.isNewVideo ?? true
204 await VideoJobInfoModel.decrease(videoDatabase.uuid, 'pendingTranscode')
206 // Move to next state if there are no other resolutions to generate
207 if (!hasHls && !hasNewResolutions) {
208 await retryTransactionWrapper(moveToNextState, videoDatabase, payload.isNewVideo)
212 async function onNewWebTorrentFileResolution (
215 payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
217 await createHlsJobIfEnabled(user, { ...payload, copyCodecs: true, isMaxQuality: false })
218 await VideoJobInfoModel.decrease(video.uuid, 'pendingTranscode')
220 await retryTransactionWrapper(moveToNextState, video, payload.isNewVideo)
223 // ---------------------------------------------------------------------------
225 async function createHlsJobIfEnabled (user: MUserId, payload: {
228 isPortraitMode?: boolean
230 isMaxQuality: boolean
233 if (!payload || CONFIG.TRANSCODING.ENABLED !== true || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
236 priority: await getTranscodingJobPriority(user)
239 const hlsTranscodingPayload: HLSTranscodingPayload = {
240 type: 'new-resolution-to-hls',
241 videoUUID: payload.videoUUID,
242 resolution: payload.resolution,
243 isPortraitMode: payload.isPortraitMode,
244 copyCodecs: payload.copyCodecs,
245 isMaxQuality: payload.isMaxQuality,
246 autoDeleteWebTorrentIfNeeded: true,
247 isNewVideo: payload.isNewVideo
250 await addTranscodingJob(hlsTranscodingPayload, jobOptions)
255 async function createLowerResolutionsJobs (options: {
256 video: MVideoFullLight
258 videoFileResolution: number
259 isPortraitMode: boolean
261 type: 'hls' | 'webtorrent'
263 const { video, user, videoFileResolution, isPortraitMode, isNewVideo, type } = options
265 // Create transcoding jobs if there are enabled resolutions
266 const resolutionsEnabled = computeLowerResolutionsToTranscode(videoFileResolution, 'vod')
267 const resolutionCreated: string[] = []
269 for (const resolution of resolutionsEnabled) {
270 let dataInput: VideoTranscodingPayload
272 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
273 // WebTorrent will create subsequent HLS job
275 type: 'new-resolution-to-webtorrent',
276 videoUUID: video.uuid,
282 resolutionCreated.push('webtorrent-' + resolution)
285 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
287 type: 'new-resolution-to-hls',
288 videoUUID: video.uuid,
293 autoDeleteWebTorrentIfNeeded: true,
297 resolutionCreated.push('hls-' + resolution)
300 if (!dataInput) continue
303 priority: await getTranscodingJobPriority(user)
306 await addTranscodingJob(dataInput, jobOptions)
309 if (resolutionCreated.length === 0) {
310 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid, lTags(video.uuid))
316 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
317 { resolutionCreated, ...lTags(video.uuid) }