import * as Bull from 'bull'
-import { VideoResolution, VideoState } from '../../../../shared'
+import { TranscodeOptionsType } from '@server/helpers/ffmpeg-utils'
+import { JOB_PRIORITY } from '@server/initializers/constants'
+import { getJobTranscodingPriorityMalus, publishAndFederateIfNeeded } from '@server/lib/video'
+import { getVideoFilePath } from '@server/lib/video-paths'
+import { UserModel } from '@server/models/account/user'
+import { MUser, MUserId, MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/types/models'
+import {
+ HLSTranscodingPayload,
+ MergeAudioTranscodingPayload,
+ NewResolutionTranscodingPayload,
+ OptimizeTranscodingPayload,
+ VideoTranscodingPayload
+} from '../../../../shared'
+import { retryTransactionWrapper } from '../../../helpers/database-utils'
+import { computeResolutionsToTranscode } from '../../../helpers/ffprobe-utils'
import { logger } from '../../../helpers/logger'
+import { CONFIG } from '../../../initializers/config'
+import { sequelizeTypescript } from '../../../initializers/database'
import { VideoModel } from '../../../models/video/video'
-import { JobQueue } from '../job-queue'
-import { federateVideoIfNeeded } from '../../activitypub'
-import { retryTransactionWrapper } from '../../../helpers/database-utils'
-import { sequelizeTypescript } from '../../../initializers'
-import * as Bluebird from 'bluebird'
-import { computeResolutionsToTranscode } from '../../../helpers/ffmpeg-utils'
-import { generateHlsPlaylist, optimizeVideofile, transcodeOriginalVideofile, mergeAudioVideofile } from '../../video-transcoding'
+import { federateVideoIfNeeded } from '../../activitypub/videos'
import { Notifier } from '../../notifier'
-import { CONFIG } from '../../../initializers/config'
+import {
+ generateHlsPlaylistResolution,
+ mergeAudioVideofile,
+ optimizeOriginalVideofile,
+ transcodeNewWebTorrentResolution
+} from '../../video-transcoding'
+import { JobQueue } from '../job-queue'
-interface BaseTranscodingPayload {
- videoUUID: string
- isNewVideo?: boolean
-}
+type HandlerFunction = (job: Bull.Job, payload: VideoTranscodingPayload, video: MVideoFullLight, user: MUser) => Promise<any>
-interface HLSTranscodingPayload extends BaseTranscodingPayload {
- type: 'hls'
- isPortraitMode?: boolean
- resolution: VideoResolution
-}
+const handlers: { [ id: string ]: HandlerFunction } = {
+ // Deprecated, introduced in 3.1
+ 'hls': handleHLSJob,
+ 'new-resolution-to-hls': handleHLSJob,
-interface NewResolutionTranscodingPayload extends BaseTranscodingPayload {
- type: 'new-resolution'
- isPortraitMode?: boolean
- resolution: VideoResolution
-}
+ // Deprecated, introduced in 3.1
+ 'new-resolution': handleNewWebTorrentResolutionJob,
+ 'new-resolution-to-webtorrent': handleNewWebTorrentResolutionJob,
-interface MergeAudioTranscodingPayload extends BaseTranscodingPayload {
- type: 'merge-audio'
- resolution: VideoResolution
-}
+ // Deprecated, introduced in 3.1
+ 'merge-audio': handleWebTorrentMergeAudioJob,
+ 'merge-audio-to-webtorrent': handleWebTorrentMergeAudioJob,
-interface OptimizeTranscodingPayload extends BaseTranscodingPayload {
- type: 'optimize'
+ // Deprecated, introduced in 3.1
+ 'optimize': handleWebTorrentOptimizeJob,
+ 'optimize-to-webtorrent': handleWebTorrentOptimizeJob
}
-export type VideoTranscodingPayload = HLSTranscodingPayload | NewResolutionTranscodingPayload
- | OptimizeTranscodingPayload | MergeAudioTranscodingPayload
-
async function processVideoTranscoding (job: Bull.Job) {
const payload = job.data as VideoTranscodingPayload
logger.info('Processing video file in job %d.', job.id)
return undefined
}
- if (payload.type === 'hls') {
- await generateHlsPlaylist(video, payload.resolution, payload.isPortraitMode || false)
-
- await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
- } else if (payload.type === 'new-resolution') {
- await transcodeOriginalVideofile(video, payload.resolution, payload.isPortraitMode || false)
+ const user = await UserModel.loadByChannelActorId(video.VideoChannel.actorId)
- await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
- } else if (payload.type === 'merge-audio') {
- await mergeAudioVideofile(video, payload.resolution)
+ const handler = handlers[payload.type]
- await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
- } else {
- await optimizeVideofile(video)
-
- await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload)
+ if (!handler) {
+ throw new Error('Cannot find transcoding handler for ' + payload.type)
}
+ await handler(job, payload, video, user)
+
return video
}
-async function onHlsPlaylistGenerationSuccess (video: VideoModel) {
- if (video === undefined) return undefined
-
- await sequelizeTypescript.transaction(async t => {
- // Maybe the video changed in database, refresh it
- let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
- // Video does not exist anymore
- if (!videoDatabase) return undefined
+// ---------------------------------------------------------------------------
+// Job handlers
+// ---------------------------------------------------------------------------
- // If the video was not published, we consider it is a new one for other instances
- await federateVideoIfNeeded(videoDatabase, false, t)
+async function handleHLSJob (job: Bull.Job, payload: HLSTranscodingPayload, video: MVideoFullLight, user: MUser) {
+ const videoFileInput = payload.copyCodecs
+ ? video.getWebTorrentFile(payload.resolution)
+ : video.getMaxQualityFile()
+
+ const videoOrStreamingPlaylist = videoFileInput.getVideoOrStreamingPlaylist()
+ const videoInputPath = getVideoFilePath(videoOrStreamingPlaylist, videoFileInput)
+
+ await generateHlsPlaylistResolution({
+ video,
+ videoInputPath,
+ resolution: payload.resolution,
+ copyCodecs: payload.copyCodecs,
+ isPortraitMode: payload.isPortraitMode || false,
+ job
})
+
+ await retryTransactionWrapper(onHlsPlaylistGeneration, video, user, payload)
}
-async function publishNewResolutionIfNeeded (video: VideoModel, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
- const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
- // Maybe the video changed in database, refresh it
- let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
- // Video does not exist anymore
- if (!videoDatabase) return undefined
+async function handleNewWebTorrentResolutionJob (
+ job: Bull.Job,
+ payload: NewResolutionTranscodingPayload,
+ video: MVideoFullLight,
+ user: MUserId
+) {
+ await transcodeNewWebTorrentResolution(video, payload.resolution, payload.isPortraitMode || false, job)
- let videoPublished = false
+ await retryTransactionWrapper(onNewWebTorrentFileResolution, video, user, payload)
+}
- // We transcoded the video file in another format, now we can publish it
- if (videoDatabase.state !== VideoState.PUBLISHED) {
- videoPublished = true
+async function handleWebTorrentMergeAudioJob (job: Bull.Job, payload: MergeAudioTranscodingPayload, video: MVideoFullLight, user: MUserId) {
+ await mergeAudioVideofile(video, payload.resolution, job)
- videoDatabase.state = VideoState.PUBLISHED
- videoDatabase.publishedAt = new Date()
- videoDatabase = await videoDatabase.save({ transaction: t })
- }
+ await retryTransactionWrapper(onVideoFileOptimizer, video, payload, 'video', user)
+}
- // If the video was not published, we consider it is a new one for other instances
- await federateVideoIfNeeded(videoDatabase, videoPublished, t)
+async function handleWebTorrentOptimizeJob (job: Bull.Job, payload: OptimizeTranscodingPayload, video: MVideoFullLight, user: MUserId) {
+ const transcodeType = await optimizeOriginalVideofile(video, video.getMaxQualityFile(), job)
- return { videoDatabase, videoPublished }
- })
+ await retryTransactionWrapper(onVideoFileOptimizer, video, payload, transcodeType, user)
+}
+
+// ---------------------------------------------------------------------------
+
+async function onHlsPlaylistGeneration (video: MVideoFullLight, user: MUser, payload: HLSTranscodingPayload) {
+ if (video === undefined) return undefined
+
+ if (payload.isMaxQuality && CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
+ // Remove webtorrent files if not enabled
+ for (const file of video.VideoFiles) {
+ await video.removeFile(file)
+ await file.removeTorrent()
+ await file.destroy()
+ }
- if (videoPublished) {
- Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
- Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
+ video.VideoFiles = []
+
+ // Create HLS new resolution jobs
+ await createLowerResolutionsJobs(video, user, payload.resolution, payload.isPortraitMode, 'hls')
}
- await createHlsJobIfEnabled(payload)
+ return publishAndFederateIfNeeded(video)
}
-async function onVideoFileOptimizerSuccess (videoArg: VideoModel, payload: OptimizeTranscodingPayload) {
+async function onVideoFileOptimizer (
+ videoArg: MVideoWithFile,
+ payload: OptimizeTranscodingPayload | MergeAudioTranscodingPayload,
+ transcodeType: TranscodeOptionsType,
+ user: MUserId
+) {
if (videoArg === undefined) return undefined
// Outside the transaction (IO on disk)
- const { videoFileResolution } = await videoArg.getOriginalFileResolution()
+ const { videoFileResolution, isPortraitMode } = await videoArg.getMaxQualityResolution()
const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
// Maybe the video changed in database, refresh it
- let videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
+ const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(videoArg.uuid, t)
// Video does not exist anymore
if (!videoDatabase) return undefined
- // Create transcoding jobs if there are enabled resolutions
- const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution)
- logger.info(
- 'Resolutions computed for video %s and origin file height of %d.', videoDatabase.uuid, videoFileResolution,
- { resolutions: resolutionsEnabled }
- )
-
let videoPublished = false
- if (resolutionsEnabled.length !== 0) {
- const tasks: (Bluebird<Bull.Job<any>> | Promise<Bull.Job<any>>)[] = []
-
- for (const resolution of resolutionsEnabled) {
- const dataInput = {
- type: 'new-resolution' as 'new-resolution',
- videoUUID: videoDatabase.uuid,
- resolution
- }
-
- const p = JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
- tasks.push(p)
- }
+ // Generate HLS version of the original file
+ const originalFileHLSPayload = Object.assign({}, payload, {
+ isPortraitMode,
+ resolution: videoDatabase.getMaxQualityFile().resolution,
+ // If we quick transcoded original file, force transcoding for HLS to avoid some weird playback issues
+ copyCodecs: transcodeType !== 'quick-transcode',
+ isMaxQuality: true
+ })
+ const hasHls = await createHlsJobIfEnabled(user, originalFileHLSPayload)
- await Promise.all(tasks)
-
- logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
- } else {
- videoPublished = true
+ const hasNewResolutions = await createLowerResolutionsJobs(videoDatabase, user, videoFileResolution, isPortraitMode, 'webtorrent')
+ if (!hasHls && !hasNewResolutions) {
// No transcoding to do, it's now published
- videoDatabase.state = VideoState.PUBLISHED
- videoDatabase = await videoDatabase.save({ transaction: t })
-
- logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
+ videoPublished = await videoDatabase.publishIfNeededAndSave(t)
}
await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
+}
- const hlsPayload = Object.assign({}, payload, { resolution: videoDatabase.getOriginalFile().resolution })
- await createHlsJobIfEnabled(hlsPayload)
+async function onNewWebTorrentFileResolution (
+ video: MVideoUUID,
+ user: MUserId,
+ payload: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload
+) {
+ await publishAndFederateIfNeeded(video)
+
+ await createHlsJobIfEnabled(user, Object.assign({}, payload, { copyCodecs: true, isMaxQuality: false }))
}
// ---------------------------------------------------------------------------
export {
processVideoTranscoding,
- publishNewResolutionIfNeeded
+ onNewWebTorrentFileResolution
}
// ---------------------------------------------------------------------------
-function createHlsJobIfEnabled (payload?: { videoUUID: string, resolution: number, isPortraitMode?: boolean }) {
- // Generate HLS playlist?
- if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
- const hlsTranscodingPayload = {
- type: 'hls' as 'hls',
- videoUUID: payload.videoUUID,
- resolution: payload.resolution,
- isPortraitMode: payload.isPortraitMode
+async function createHlsJobIfEnabled (user: MUserId, payload: {
+ videoUUID: string
+ resolution: number
+ isPortraitMode?: boolean
+ copyCodecs: boolean
+ isMaxQuality: boolean
+}) {
+ if (!payload || CONFIG.TRANSCODING.HLS.ENABLED !== true) return false
+
+ const jobOptions = {
+ priority: JOB_PRIORITY.TRANSCODING.NEW_RESOLUTION + await getJobTranscodingPriorityMalus(user)
+ }
+
+ const hlsTranscodingPayload: HLSTranscodingPayload = {
+ type: 'new-resolution-to-hls',
+ videoUUID: payload.videoUUID,
+ resolution: payload.resolution,
+ isPortraitMode: payload.isPortraitMode,
+ copyCodecs: payload.copyCodecs,
+ isMaxQuality: payload.isMaxQuality
+ }
+
+ JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload }, jobOptions)
+
+ return true
+}
+
+async function createLowerResolutionsJobs (
+ video: MVideoFullLight,
+ user: MUserId,
+ videoFileResolution: number,
+ isPortraitMode: boolean,
+ type: 'hls' | 'webtorrent'
+) {
+ // Create transcoding jobs if there are enabled resolutions
+ const resolutionsEnabled = computeResolutionsToTranscode(videoFileResolution, 'vod')
+ const resolutionCreated: number[] = []
+
+ for (const resolution of resolutionsEnabled) {
+ let dataInput: VideoTranscodingPayload
+
+ if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED && type === 'webtorrent') {
+ // WebTorrent will create subsequent HLS job
+ dataInput = {
+ type: 'new-resolution-to-webtorrent',
+ videoUUID: video.uuid,
+ resolution,
+ isPortraitMode
+ }
+ }
+
+ if (CONFIG.TRANSCODING.HLS.ENABLED && type === 'hls') {
+ dataInput = {
+ type: 'new-resolution-to-hls',
+ videoUUID: video.uuid,
+ resolution,
+ isPortraitMode,
+ copyCodecs: false,
+ isMaxQuality: false
+ }
}
- return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })
+ if (!dataInput) continue
+
+ resolutionCreated.push(resolution)
+
+ const jobOptions = {
+ priority: JOB_PRIORITY.TRANSCODING.NEW_RESOLUTION + await getJobTranscodingPriorityMalus(user)
+ }
+
+ JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput }, jobOptions)
}
+
+ if (resolutionCreated.length === 0) {
+ logger.info('No transcoding jobs created for video %s (no resolutions).', video.uuid)
+
+ return false
+ }
+
+ logger.info(
+ 'New resolutions %s transcoding jobs created for video %s and origin file resolution of %d.', type, video.uuid, videoFileResolution,
+ { resolutionCreated }
+ )
+
+ return true
}