1 import * as Bull from 'bull'
2 import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
3 import { getTranscodingJobPriority, publishAndFederateIfNeeded } from '@server/lib/video'
4 import { getVideoFilePath } from '@server/lib/video-paths'
5 import { UserModel } from '@server/models/user/user'
6 import { MUser, MUserId, MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
9 MergeAudioTranscodingPayload,
10 NewResolutionTranscodingPayload,
11 OptimizeTranscodingPayload,
12 VideoTranscodingPayload
13 } from '../../../../shared'
14 import { retryTransactionWrapper } from '../../../helpers/database-utils'
15 import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
16 import { logger } from '../../../helpers/logger'
17 import { CONFIG } from '../../../initializers/config'
18 import { VideoModel } from '../../../models/video/video'
19 import { federateVideoIfNeeded } from '../../activitypub/videos'
20 import { Notifier } from '../../notifier'
22 generateHlsPlaylistResolution,
24 optimizeOriginalVideofile,
25 transcodeNewWebTorrentResolution
26 } from '../../transcoding/video-transcoding'
27 import { JobQueue } from '../job-queue'
29 type HandlerFunction = (job: Bull.Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<any>
31 const handlers: { [ id: string ]: HandlerFunction } = {
32 // Deprecated, introduced in 3.1
34 'new-resolution-to-hls': handleHLSJob,
36 // Deprecated, introduced in 3.1
37 'new-resolution': handleNewWebTorrentResolutionJob,
38 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
40 // Deprecated, introduced in 3.1
41 'merge-audio': handleWebTorrentMergeAudioJob,
42 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
44 // Deprecated, introduced in 3.1
45 'optimize': handleWebTorrentOptimizeJob,
46 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
49 async function processVideoTranscoding (job: Bull.Job) {
50 const payload = job.data as VideoTranscodingPayload
51 logger.info('Processing video file in job %d.', job.id)
53 const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
54 // No video, maybe deleted?
56 logger.info('Do not process job %d, video does not exist.', job.id)
60 const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
62 const handler = handlers[payload.type]
65 throw new Error('Cannot find transcoding handler for ' + payload.type)
68 await handler(job, payload, video, user)
73 // ---------------------------------------------------------------------------
75 // ---------------------------------------------------------------------------
77 async function handleHLSJob (job: Bull.Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
78 const videoFileInput = payload.copyCodecs
79 ? video.getWebTorrentFile(payload.resolution)
80 : video.getMaxQualityFile()
82 const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
83 const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
85 await generateHlsPlaylistResolution({
88 resolution: payload.resolution,
89 copyCodecs: payload.copyCodecs,
90 isPortraitMode: payload.isPortraitMode || false,
94 await retryTransactionWrapper(onHlsPlaylistGeneration, video, user, payload)
97 async function handleNewWebTorrentResolutionJob (
99 payload: NewResolutionTranscodingPayload,
100 video: MVideoFullLight,
103 await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
105 await retryTransactionWrapper(onNewWebTorrentFileResolution, video, user, payload)
108 async function handleWebTorrentMergeAudioJob (job: Bull.Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
109 await mergeAudioVideofile(video, payload.resolution, job)
111 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, 'video', user)
114 async function handleWebTorrentOptimizeJob (job: Bull.Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
115 const transcodeType = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
117 await retryTransactionWrapper(onVideoFileOptimizer, video, payload, transcodeType, user)
120 // ---------------------------------------------------------------------------
122 async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
123 if (video === undefined) return undefined
125 if (payload.isMaxQuality && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
126 // Remove webtorrent files if not enabled
127 for (const file of video.VideoFiles) {
128 await video.removeFileAndTorrent(file)
132 video.VideoFiles = []
134 // Create HLS new resolution jobs
135 await createLowerResolutionsJobs(video, user, payload.resolution, payload.isPortraitMode, 'hls')
138 return publishAndFederateIfNeeded(video)
141 async function onVideoFileOptimizer (
142 videoArg: MVideoWithFile,
143 payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
144 transcodeType: TranscodeOptionsType,
147 if (videoArg === undefined) return undefined
149 // Outside the transaction (IO on disk)
150 const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
152 // Maybe the video changed in database, refresh it
153 const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid)
154 // Video does not exist anymore
155 if (!videoDatabase) return undefined
157 let videoPublished = false
159 // Generate HLS version of the original file
160 const originalFileHLSPayload = Object.assign({}, payload, {
162 resolution: videoDatabase.getMaxQualityFile().resolution,
163 // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
164 copyCodecs: transcodeType !== 'quick-transcode',
167 const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
169 const hasNewResolutions = await createLowerResolutionsJobs(videoDatabase, user, videoFileResolution, isPortraitMode, 'webtorrent')
171 if (!hasHls && !hasNewResolutions) {
172 // No transcoding to do, it's now published
173 videoPublished = await videoDatabase.publishIfNeededAndSave(undefined)
176 await federateVideoIfNeeded(videoDatabase, payload.isNewVideo)
178 if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
179 if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
182 async function onNewWebTorrentFileResolution (
185 payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
187 await publishAndFederateIfNeeded(video)
189 await createHlsJobIfEnabled(user, Object.assign({}, payload, { copyCodecs: true, isMaxQuality: false }))
192 // ---------------------------------------------------------------------------
195 processVideoTranscoding,
196 onNewWebTorrentFileResolution
199 // ---------------------------------------------------------------------------
201 async function createHlsJobIfEnabled (user: MUserId, payload: {
204 isPortraitMode?: boolean
206 isMaxQuality: boolean
208 if (!payload || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
211 priority: await getTranscodingJobPriority(user)
214 const hlsTranscodingPayload: HLSTranscodingPayload = {
215 type: 'new-resolution-to-hls',
216 videoUUID: payload.videoUUID,
217 resolution: payload.resolution,
218 isPortraitMode: payload.isPortraitMode,
219 copyCodecs: payload.copyCodecs,
220 isMaxQuality: payload.isMaxQuality
223 JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload }, jobOptions)
228 async function createLowerResolutionsJobs (
229 video: MVideoFullLight,
231 videoFileResolution: number,
232 isPortraitMode: boolean,
233 type: 'hls' | 'webtorrent'
235 // Create transcoding jobs if there are enabled resolutions
236 const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
237 const resolutionCreated: number[] = []
239 for (const resolution of resolutionsEnabled) {
240 let dataInput: VideoTranscodingPayload
242 if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
243 // WebTorrent will create subsequent HLS job
245 type: 'new-resolution-to-webtorrent',
246 videoUUID: video.uuid,
252 if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
254 type: 'new-resolution-to-hls',
255 videoUUID: video.uuid,
263 if (!dataInput) continue
265 resolutionCreated.push(resolution)
268 priority: await getTranscodingJobPriority(user)
271 JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput }, jobOptions)
274 if (resolutionCreated.length === 0) {
275 logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
281 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
282 { resolutionCreated }