PeerTube/server/lib/job-queue/handlers/video-transcoding.ts

211 lines
7.5 KiB
TypeScript
Raw Normal View History

2018-07-10 17:02:20 +02:00
import * as Bull from 'bull'
import { VideoResolution } from '../../../../shared'
2017-12-28 11:16:08 +01:00
import { logger } from '../../../helpers/logger'
2017-12-12 17:53:50 +01:00
import { VideoModel } from '../../../models/video/video'
import { JobQueue } from '../job-queue'
import { federateVideoIfNeeded } from '../../activitypub'
import { retryTransactionWrapper } from '../../../helpers/database-utils'
2019-04-11 11:33:44 +02:00
import { sequelizeTypescript } from '../../../initializers'
2018-08-14 15:28:30 +02:00
import { computeResolutionsToTranscode } from '../../../helpers/ffmpeg-utils'
import { generateHlsPlaylist, mergeAudioVideofile, optimizeOriginalVideofile, transcodeNewResolution } from '../../video-transcoding'
2018-12-26 10:36:24 +01:00
import { Notifier } from '../../notifier'
2019-04-11 11:33:44 +02:00
import { CONFIG } from '../../../initializers/config'
import { MVideoFullLight, MVideoUUID, MVideoWithFile } from '@server/typings/models'
2019-05-16 16:55:34 +02:00
interface BaseTranscodingPayload {
videoUUID: string
2019-01-29 08:37:25 +01:00
isNewVideo?: boolean
2019-05-16 16:55:34 +02:00
}
interface HLSTranscodingPayload extends BaseTranscodingPayload {
type: 'hls'
isPortraitMode?: boolean
resolution: VideoResolution
copyCodecs: boolean
2019-05-16 16:55:34 +02:00
}
interface NewResolutionTranscodingPayload extends BaseTranscodingPayload {
type: 'new-resolution'
2018-02-27 15:57:28 +01:00
isPortraitMode?: boolean
2019-05-16 16:55:34 +02:00
resolution: VideoResolution
}
interface MergeAudioTranscodingPayload extends BaseTranscodingPayload {
type: 'merge-audio'
resolution: VideoResolution
}
interface OptimizeTranscodingPayload extends BaseTranscodingPayload {
type: 'optimize'
}
2020-01-31 16:56:52 +01:00
export type VideoTranscodingPayload =
HLSTranscodingPayload
| NewResolutionTranscodingPayload
| OptimizeTranscodingPayload
| MergeAudioTranscodingPayload
2019-05-16 16:55:34 +02:00
async function processVideoTranscoding (job: Bull.Job) {
const payload = job.data as VideoTranscodingPayload
logger.info('Processing video file in job %d.', job.id)
const video = await VideoModel.loadAndPopulateAccountAndServerAndTags(payload.videoUUID)
// No video, maybe deleted?
if (!video) {
logger.info('Do not process job %d, video does not exist.', job.id)
return undefined
}
2019-05-16 16:55:34 +02:00
if (payload.type === 'hls') {
await generateHlsPlaylist(video, payload.resolution, payload.copyCodecs, payload.isPortraitMode || false)
2019-01-29 08:37:25 +01:00
await retryTransactionWrapper(onHlsPlaylistGenerationSuccess, video)
2019-05-16 16:55:34 +02:00
} else if (payload.type === 'new-resolution') {
await transcodeNewResolution(video, payload.resolution, payload.isPortraitMode || false)
2019-05-16 16:55:34 +02:00
await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
} else if (payload.type === 'merge-audio') {
await mergeAudioVideofile(video, payload.resolution)
await retryTransactionWrapper(publishNewResolutionIfNeeded, video, payload)
} else {
await optimizeOriginalVideofile(video)
2019-01-29 08:37:25 +01:00
await retryTransactionWrapper(onVideoFileOptimizerSuccess, video, payload)
}
2017-10-17 15:37:40 +02:00
return video
}
async function onHlsPlaylistGenerationSuccess (video: MVideoFullLight) {
2019-01-29 08:37:25 +01:00
if (video === undefined) return undefined
// We generated the HLS playlist, we don't need the webtorrent files anymore if the admin disabled it
if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED === false) {
for (const file of video.VideoFiles) {
await video.removeFile(file)
await file.destroy()
2018-06-28 16:58:15 +02:00
}
video.VideoFiles = []
}
return publishAndFederateIfNeeded(video)
}
2018-12-28 13:47:17 +01:00
async function publishNewResolutionIfNeeded (video: MVideoUUID, payload?: NewResolutionTranscodingPayload | MergeAudioTranscodingPayload) {
await publishAndFederateIfNeeded(video)
2019-01-29 08:37:25 +01:00
await createHlsJobIfEnabled(payload)
}
2019-08-15 11:53:26 +02:00
async function onVideoFileOptimizerSuccess (videoArg: MVideoWithFile, payload: OptimizeTranscodingPayload) {
if (videoArg === undefined) return undefined
2017-10-17 15:37:40 +02:00
// Outside the transaction (IO on disk)
const { videoFileResolution } = await videoArg.getMaxQualityResolution()
const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
// Maybe the video changed in database, refresh it
2020-01-31 16:56:52 +01:00
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
const hlsPayload = Object.assign({}, payload, { resolution: videoDatabase.getMaxQualityFile().resolution })
await createHlsJobIfEnabled(hlsPayload)
if (resolutionsEnabled.length !== 0) {
for (const resolution of resolutionsEnabled) {
let dataInput: VideoTranscodingPayload
if (CONFIG.TRANSCODING.WEBTORRENT.ENABLED) {
dataInput = {
type: 'new-resolution' as 'new-resolution',
videoUUID: videoDatabase.uuid,
resolution
}
} else if (CONFIG.TRANSCODING.HLS.ENABLED) {
dataInput = {
type: 'hls',
videoUUID: videoDatabase.uuid,
resolution,
isPortraitMode: false,
copyCodecs: false
}
}
2020-01-31 16:56:52 +01:00
JobQueue.Instance.createJob({ type: 'video-transcoding', payload: dataInput })
}
logger.info('Transcoding jobs created for uuid %s.', videoDatabase.uuid, { resolutionsEnabled })
} else {
// No transcoding to do, it's now published
videoPublished = await videoDatabase.publishIfNeededAndSave(t)
logger.info('No transcoding jobs created for video %s (no resolutions).', videoDatabase.uuid, { privacy: videoDatabase.privacy })
}
2019-01-29 08:37:25 +01:00
await federateVideoIfNeeded(videoDatabase, payload.isNewVideo, t)
2018-12-28 13:47:17 +01:00
return { videoDatabase, videoPublished }
})
2018-12-28 13:47:17 +01:00
2019-07-23 12:04:15 +02:00
if (payload.isNewVideo) Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
if (videoPublished) Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
}
// ---------------------------------------------------------------------------
export {
processVideoTranscoding,
2019-05-16 16:55:34 +02:00
publishNewResolutionIfNeeded
}
2019-01-29 08:37:25 +01:00
// ---------------------------------------------------------------------------
2019-05-16 16:55:34 +02:00
function createHlsJobIfEnabled (payload?: { videoUUID: string, resolution: number, isPortraitMode?: boolean }) {
2019-01-29 08:37:25 +01:00
// Generate HLS playlist?
if (payload && CONFIG.TRANSCODING.HLS.ENABLED) {
const hlsTranscodingPayload = {
2019-05-16 16:55:34 +02:00
type: 'hls' as 'hls',
2019-01-29 08:37:25 +01:00
videoUUID: payload.videoUUID,
resolution: payload.resolution,
isPortraitMode: payload.isPortraitMode,
copyCodecs: true
2019-01-29 08:37:25 +01:00
}
return JobQueue.Instance.createJob({ type: 'video-transcoding', payload: hlsTranscodingPayload })
2019-01-29 08:37:25 +01:00
}
}
async function publishAndFederateIfNeeded (video: MVideoUUID) {
const { videoDatabase, videoPublished } = await sequelizeTypescript.transaction(async t => {
// Maybe the video changed in database, refresh it
const videoDatabase = await VideoModel.loadAndPopulateAccountAndServerAndTags(video.uuid, t)
// Video does not exist anymore
if (!videoDatabase) return undefined
// We transcoded the video file in another format, now we can publish it
const videoPublished = await videoDatabase.publishIfNeededAndSave(t)
// If the video was not published, we consider it is a new one for other instances
await federateVideoIfNeeded(videoDatabase, videoPublished, t)
return { videoDatabase, videoPublished }
})
if (videoPublished) {
Notifier.Instance.notifyOnNewVideoIfNeeded(videoDatabase)
Notifier.Instance.notifyOnVideoPublishedAfterTranscoding(videoDatabase)
}
}