From c07902b9083ab5756436cd020bed5bdfa51028bf Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 11 May 2021 10:57:25 +0200 Subject: Move transcoding files in their own directory --- .../lib/transcoding/video-transcoding-profiles.ts | 256 +++++++++++++++ server/lib/transcoding/video-transcoding.ts | 358 +++++++++++++++++++++ 2 files changed, 614 insertions(+) create mode 100644 server/lib/transcoding/video-transcoding-profiles.ts create mode 100644 server/lib/transcoding/video-transcoding.ts (limited to 'server/lib/transcoding') diff --git a/server/lib/transcoding/video-transcoding-profiles.ts b/server/lib/transcoding/video-transcoding-profiles.ts new file mode 100644 index 000000000..c5ea72a5f --- /dev/null +++ b/server/lib/transcoding/video-transcoding-profiles.ts @@ -0,0 +1,256 @@ +import { logger } from '@server/helpers/logger' +import { AvailableEncoders, EncoderOptionsBuilder, getTargetBitrate, VideoResolution } from '../../../shared/models/videos' +import { buildStreamSuffix, resetSupportedEncoders } from '../../helpers/ffmpeg-utils' +import { + canDoQuickAudioTranscode, + ffprobePromise, + getAudioStream, + getMaxAudioBitrate, + getVideoFileBitrate, + getVideoStreamFromFile +} from '../../helpers/ffprobe-utils' +import { VIDEO_TRANSCODING_FPS } from '../../initializers/constants' + +/** + * + * Available encoders and profiles for the transcoding jobs + * These functions are used by ffmpeg-utils that will get the encoders and options depending on the chosen profile + * + */ + +// Resources: +// * https://slhck.info/video/2017/03/01/rate-control.html +// * https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate + +const defaultX264VODOptionsBuilder: EncoderOptionsBuilder = async ({ input, resolution, fps }) => { + const targetBitrate = await buildTargetBitrate({ input, resolution, fps }) + if (!targetBitrate) return { outputOptions: [ ] } + + return { + outputOptions: [ + `-preset veryfast`, + `-r ${fps}`, + `-maxrate ${targetBitrate}`, + `-bufsize ${targetBitrate * 2}` + ] + } +} + +const defaultX264LiveOptionsBuilder: EncoderOptionsBuilder = async ({ resolution, fps, streamNum }) => { + const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS) + + return { + outputOptions: [ + `-preset veryfast`, + `${buildStreamSuffix('-r:v', streamNum)} ${fps}`, + `${buildStreamSuffix('-b:v', streamNum)} ${targetBitrate}`, + `-maxrate ${targetBitrate}`, + `-bufsize ${targetBitrate * 2}` + ] + } +} + +const defaultAACOptionsBuilder: EncoderOptionsBuilder = async ({ input, streamNum }) => { + const probe = await ffprobePromise(input) + + if (await canDoQuickAudioTranscode(input, probe)) { + logger.debug('Copy audio stream %s by AAC encoder.', input) + return { copy: true, outputOptions: [ ] } + } + + const parsedAudio = await getAudioStream(input, probe) + + // We try to reduce the ceiling bitrate by making rough matches of bitrates + // Of course this is far from perfect, but it might save some space in the end + + const audioCodecName = parsedAudio.audioStream['codec_name'] + + const bitrate = getMaxAudioBitrate(audioCodecName, parsedAudio.bitrate) + + logger.debug('Calculating audio bitrate of %s by AAC encoder.', input, { bitrate: parsedAudio.bitrate, audioCodecName }) + + if (bitrate !== undefined && bitrate !== -1) { + return { outputOptions: [ buildStreamSuffix('-b:a', streamNum), bitrate + 'k' ] } + } + + return { outputOptions: [ ] } +} + +const defaultLibFDKAACVODOptionsBuilder: EncoderOptionsBuilder = ({ streamNum }) => { + return { outputOptions: [ buildStreamSuffix('-q:a', streamNum), '5' ] } +} + +// Used to get and update available encoders +class VideoTranscodingProfilesManager { + private static instance: VideoTranscodingProfilesManager + + // 1 === less priority + private readonly encodersPriorities = { + vod: this.buildDefaultEncodersPriorities(), + live: this.buildDefaultEncodersPriorities() + } + + private readonly availableEncoders = { + vod: { + libx264: { + default: defaultX264VODOptionsBuilder + }, + aac: { + default: defaultAACOptionsBuilder + }, + libfdk_aac: { + default: defaultLibFDKAACVODOptionsBuilder + } + }, + live: { + libx264: { + default: defaultX264LiveOptionsBuilder + }, + aac: { + default: defaultAACOptionsBuilder + } + } + } + + private availableProfiles = { + vod: [] as string[], + live: [] as string[] + } + + private constructor () { + this.buildAvailableProfiles() + } + + getAvailableEncoders (): AvailableEncoders { + return { + available: this.availableEncoders, + encodersToTry: { + vod: { + video: this.getEncodersByPriority('vod', 'video'), + audio: this.getEncodersByPriority('vod', 'audio') + }, + live: { + video: this.getEncodersByPriority('live', 'video'), + audio: this.getEncodersByPriority('live', 'audio') + } + } + } + } + + getAvailableProfiles (type: 'vod' | 'live') { + return this.availableProfiles[type] + } + + addProfile (options: { + type: 'vod' | 'live' + encoder: string + profile: string + builder: EncoderOptionsBuilder + }) { + const { type, encoder, profile, builder } = options + + const encoders = this.availableEncoders[type] + + if (!encoders[encoder]) encoders[encoder] = {} + encoders[encoder][profile] = builder + + this.buildAvailableProfiles() + } + + removeProfile (options: { + type: 'vod' | 'live' + encoder: string + profile: string + }) { + const { type, encoder, profile } = options + + delete this.availableEncoders[type][encoder][profile] + this.buildAvailableProfiles() + } + + addEncoderPriority (type: 'vod' | 'live', streamType: 'audio' | 'video', encoder: string, priority: number) { + this.encodersPriorities[type][streamType].push({ name: encoder, priority }) + + resetSupportedEncoders() + } + + removeEncoderPriority (type: 'vod' | 'live', streamType: 'audio' | 'video', encoder: string, priority: number) { + this.encodersPriorities[type][streamType] = this.encodersPriorities[type][streamType] + .filter(o => o.name !== encoder && o.priority !== priority) + + resetSupportedEncoders() + } + + private getEncodersByPriority (type: 'vod' | 'live', streamType: 'audio' | 'video') { + return this.encodersPriorities[type][streamType] + .sort((e1, e2) => { + if (e1.priority > e2.priority) return -1 + else if (e1.priority === e2.priority) return 0 + + return 1 + }) + .map(e => e.name) + } + + private buildAvailableProfiles () { + for (const type of [ 'vod', 'live' ]) { + const result = new Set() + + const encoders = this.availableEncoders[type] + + for (const encoderName of Object.keys(encoders)) { + for (const profile of Object.keys(encoders[encoderName])) { + result.add(profile) + } + } + + this.availableProfiles[type] = Array.from(result) + } + + logger.debug('Available transcoding profiles built.', { availableProfiles: this.availableProfiles }) + } + + private buildDefaultEncodersPriorities () { + return { + video: [ + { name: 'libx264', priority: 100 } + ], + + // Try the first one, if not available try the second one etc + audio: [ + // we favor VBR, if a good AAC encoder is available + { name: 'libfdk_aac', priority: 200 }, + { name: 'aac', priority: 100 } + ] + } + } + + static get Instance () { + return this.instance || (this.instance = new this()) + } +} + +// --------------------------------------------------------------------------- + +export { + VideoTranscodingProfilesManager +} + +// --------------------------------------------------------------------------- +async function buildTargetBitrate (options: { + input: string + resolution: VideoResolution + fps: number +}) { + const { input, resolution, fps } = options + const probe = await ffprobePromise(input) + + const videoStream = await getVideoStreamFromFile(input, probe) + if (!videoStream) return undefined + + const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS) + + // Don't transcode to an higher bitrate than the original file + const fileBitrate = await getVideoFileBitrate(input, probe) + return Math.min(targetBitrate, fileBitrate) +} diff --git a/server/lib/transcoding/video-transcoding.ts b/server/lib/transcoding/video-transcoding.ts new file mode 100644 index 000000000..5df192575 --- /dev/null +++ b/server/lib/transcoding/video-transcoding.ts @@ -0,0 +1,358 @@ +import { Job } from 'bull' +import { copyFile, ensureDir, move, remove, stat } from 'fs-extra' +import { basename, extname as extnameUtil, join } from 'path' +import { createTorrentAndSetInfoHash } from '@server/helpers/webtorrent' +import { MStreamingPlaylistFilesVideo, MVideoFile, MVideoFullLight } from '@server/types/models' +import { VideoResolution } from '../../../shared/models/videos' +import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type' +import { transcode, TranscodeOptions, TranscodeOptionsType } from '../../helpers/ffmpeg-utils' +import { canDoQuickTranscode, getDurationFromVideoFile, getMetadataFromFile, getVideoFileFPS } from '../../helpers/ffprobe-utils' +import { logger } from '../../helpers/logger' +import { CONFIG } from '../../initializers/config' +import { HLS_STREAMING_PLAYLIST_DIRECTORY, P2P_MEDIA_LOADER_PEER_VERSION, WEBSERVER } from '../../initializers/constants' +import { VideoFileModel } from '../../models/video/video-file' +import { VideoStreamingPlaylistModel } from '../../models/video/video-streaming-playlist' +import { updateMasterHLSPlaylist, updateSha256VODSegments } from '../hls' +import { generateVideoFilename, generateVideoStreamingPlaylistName, getVideoFilePath } from '../video-paths' +import { VideoTranscodingProfilesManager } from './video-transcoding-profiles' + +/** + * + * Functions that run transcoding functions, update the database, cleanup files, create torrent files... + * Mainly called by the job queue + * + */ + +// Optimize the original video file and replace it. The resolution is not changed. +async function optimizeOriginalVideofile (video: MVideoFullLight, inputVideoFile: MVideoFile, job?: Job) { + const transcodeDirectory = CONFIG.STORAGE.TMP_DIR + const newExtname = '.mp4' + + const videoInputPath = getVideoFilePath(video, inputVideoFile) + const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname) + + const transcodeType: TranscodeOptionsType = await canDoQuickTranscode(videoInputPath) + ? 'quick-transcode' + : 'video' + + const transcodeOptions: TranscodeOptions = { + type: transcodeType, + + inputPath: videoInputPath, + outputPath: videoTranscodedPath, + + availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(), + profile: CONFIG.TRANSCODING.PROFILE, + + resolution: inputVideoFile.resolution, + + job + } + + // Could be very long! + await transcode(transcodeOptions) + + try { + await remove(videoInputPath) + + // Important to do this before getVideoFilename() to take in account the new filename + inputVideoFile.extname = newExtname + inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname) + + const videoOutputPath = getVideoFilePath(video, inputVideoFile) + + await onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath) + + return transcodeType + } catch (err) { + // Auto destruction... + video.destroy().catch(err => logger.error('Cannot destruct video after transcoding failure.', { err })) + + throw err + } +} + +// Transcode the original video file to a lower resolution. +async function transcodeNewWebTorrentResolution (video: MVideoFullLight, resolution: VideoResolution, isPortrait: boolean, job: Job) { + const transcodeDirectory = CONFIG.STORAGE.TMP_DIR + const extname = '.mp4' + + // We are sure it's x264 in mp4 because optimizeOriginalVideofile was already executed + const videoInputPath = getVideoFilePath(video, video.getMaxQualityFile()) + + const newVideoFile = new VideoFileModel({ + resolution, + extname, + filename: generateVideoFilename(video, false, resolution, extname), + size: 0, + videoId: video.id + }) + + const videoOutputPath = getVideoFilePath(video, newVideoFile) + const videoTranscodedPath = join(transcodeDirectory, newVideoFile.filename) + + const transcodeOptions = resolution === VideoResolution.H_NOVIDEO + ? { + type: 'only-audio' as 'only-audio', + + inputPath: videoInputPath, + outputPath: videoTranscodedPath, + + availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(), + profile: CONFIG.TRANSCODING.PROFILE, + + resolution, + + job + } + : { + type: 'video' as 'video', + inputPath: videoInputPath, + outputPath: videoTranscodedPath, + + availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(), + profile: CONFIG.TRANSCODING.PROFILE, + + resolution, + isPortraitMode: isPortrait, + + job + } + + await transcode(transcodeOptions) + + return onWebTorrentVideoFileTranscoding(video, newVideoFile, videoTranscodedPath, videoOutputPath) +} + +// Merge an image with an audio file to create a video +async function mergeAudioVideofile (video: MVideoFullLight, resolution: VideoResolution, job: Job) { + const transcodeDirectory = CONFIG.STORAGE.TMP_DIR + const newExtname = '.mp4' + + const inputVideoFile = video.getMinQualityFile() + + const audioInputPath = getVideoFilePath(video, inputVideoFile) + const videoTranscodedPath = join(transcodeDirectory, video.id + '-transcoded' + newExtname) + + // If the user updates the video preview during transcoding + const previewPath = video.getPreview().getPath() + const tmpPreviewPath = join(CONFIG.STORAGE.TMP_DIR, basename(previewPath)) + await copyFile(previewPath, tmpPreviewPath) + + const transcodeOptions = { + type: 'merge-audio' as 'merge-audio', + + inputPath: tmpPreviewPath, + outputPath: videoTranscodedPath, + + availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(), + profile: CONFIG.TRANSCODING.PROFILE, + + audioPath: audioInputPath, + resolution, + + job + } + + try { + await transcode(transcodeOptions) + + await remove(audioInputPath) + await remove(tmpPreviewPath) + } catch (err) { + await remove(tmpPreviewPath) + throw err + } + + // Important to do this before getVideoFilename() to take in account the new file extension + inputVideoFile.extname = newExtname + inputVideoFile.filename = generateVideoFilename(video, false, inputVideoFile.resolution, newExtname) + + const videoOutputPath = getVideoFilePath(video, inputVideoFile) + // ffmpeg generated a new video file, so update the video duration + // See https://trac.ffmpeg.org/ticket/5456 + video.duration = await getDurationFromVideoFile(videoTranscodedPath) + await video.save() + + return onWebTorrentVideoFileTranscoding(video, inputVideoFile, videoTranscodedPath, videoOutputPath) +} + +// Concat TS segments from a live video to a fragmented mp4 HLS playlist +async function generateHlsPlaylistResolutionFromTS (options: { + video: MVideoFullLight + concatenatedTsFilePath: string + resolution: VideoResolution + isPortraitMode: boolean + isAAC: boolean +}) { + return generateHlsPlaylistCommon({ + video: options.video, + resolution: options.resolution, + isPortraitMode: options.isPortraitMode, + inputPath: options.concatenatedTsFilePath, + type: 'hls-from-ts' as 'hls-from-ts', + isAAC: options.isAAC + }) +} + +// Generate an HLS playlist from an input file, and update the master playlist +function generateHlsPlaylistResolution (options: { + video: MVideoFullLight + videoInputPath: string + resolution: VideoResolution + copyCodecs: boolean + isPortraitMode: boolean + job?: Job +}) { + return generateHlsPlaylistCommon({ + video: options.video, + resolution: options.resolution, + copyCodecs: options.copyCodecs, + isPortraitMode: options.isPortraitMode, + inputPath: options.videoInputPath, + type: 'hls' as 'hls', + job: options.job + }) +} + +// --------------------------------------------------------------------------- + +export { + generateHlsPlaylistResolution, + generateHlsPlaylistResolutionFromTS, + optimizeOriginalVideofile, + transcodeNewWebTorrentResolution, + mergeAudioVideofile +} + +// --------------------------------------------------------------------------- + +async function onWebTorrentVideoFileTranscoding ( + video: MVideoFullLight, + videoFile: MVideoFile, + transcodingPath: string, + outputPath: string +) { + const stats = await stat(transcodingPath) + const fps = await getVideoFileFPS(transcodingPath) + const metadata = await getMetadataFromFile(transcodingPath) + + await move(transcodingPath, outputPath, { overwrite: true }) + + videoFile.size = stats.size + videoFile.fps = fps + videoFile.metadata = metadata + + await createTorrentAndSetInfoHash(video, videoFile) + + await VideoFileModel.customUpsert(videoFile, 'video', undefined) + video.VideoFiles = await video.$get('VideoFiles') + + return video +} + +async function generateHlsPlaylistCommon (options: { + type: 'hls' | 'hls-from-ts' + video: MVideoFullLight + inputPath: string + resolution: VideoResolution + copyCodecs?: boolean + isAAC?: boolean + isPortraitMode: boolean + + job?: Job +}) { + const { type, video, inputPath, resolution, copyCodecs, isPortraitMode, isAAC, job } = options + const transcodeDirectory = CONFIG.STORAGE.TMP_DIR + + const videoTranscodedBasePath = join(transcodeDirectory, type) + await ensureDir(videoTranscodedBasePath) + + const videoFilename = generateVideoStreamingPlaylistName(video.uuid, resolution) + const playlistFilename = VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution) + const playlistFileTranscodePath = join(videoTranscodedBasePath, playlistFilename) + + const transcodeOptions = { + type, + + inputPath, + outputPath: playlistFileTranscodePath, + + availableEncoders: VideoTranscodingProfilesManager.Instance.getAvailableEncoders(), + profile: CONFIG.TRANSCODING.PROFILE, + + resolution, + copyCodecs, + isPortraitMode, + + isAAC, + + hlsPlaylist: { + videoFilename + }, + + job + } + + await transcode(transcodeOptions) + + const playlistUrl = WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsMasterPlaylistStaticPath(video.uuid) + + // Create or update the playlist + const [ videoStreamingPlaylist ] = await VideoStreamingPlaylistModel.upsert({ + videoId: video.id, + playlistUrl, + segmentsSha256Url: WEBSERVER.URL + VideoStreamingPlaylistModel.getHlsSha256SegmentsStaticPath(video.uuid, video.isLive), + p2pMediaLoaderInfohashes: [], + p2pMediaLoaderPeerVersion: P2P_MEDIA_LOADER_PEER_VERSION, + + type: VideoStreamingPlaylistType.HLS + }, { returning: true }) as [ MStreamingPlaylistFilesVideo, boolean ] + videoStreamingPlaylist.Video = video + + // Build the new playlist file + const extname = extnameUtil(videoFilename) + const newVideoFile = new VideoFileModel({ + resolution, + extname, + size: 0, + filename: generateVideoFilename(video, true, resolution, extname), + fps: -1, + videoStreamingPlaylistId: videoStreamingPlaylist.id + }) + + const videoFilePath = getVideoFilePath(videoStreamingPlaylist, newVideoFile) + + // Move files from tmp transcoded directory to the appropriate place + const baseHlsDirectory = join(HLS_STREAMING_PLAYLIST_DIRECTORY, video.uuid) + await ensureDir(baseHlsDirectory) + + // Move playlist file + const playlistPath = join(baseHlsDirectory, playlistFilename) + await move(playlistFileTranscodePath, playlistPath, { overwrite: true }) + // Move video file + await move(join(videoTranscodedBasePath, videoFilename), videoFilePath, { overwrite: true }) + + const stats = await stat(videoFilePath) + + newVideoFile.size = stats.size + newVideoFile.fps = await getVideoFileFPS(videoFilePath) + newVideoFile.metadata = await getMetadataFromFile(videoFilePath) + + await createTorrentAndSetInfoHash(videoStreamingPlaylist, newVideoFile) + + await VideoFileModel.customUpsert(newVideoFile, 'streaming-playlist', undefined) + videoStreamingPlaylist.VideoFiles = await videoStreamingPlaylist.$get('VideoFiles') + + videoStreamingPlaylist.p2pMediaLoaderInfohashes = VideoStreamingPlaylistModel.buildP2PMediaLoaderInfoHashes( + playlistUrl, videoStreamingPlaylist.VideoFiles + ) + await videoStreamingPlaylist.save() + + video.setHLSPlaylist(videoStreamingPlaylist) + + await updateMasterHLSPlaylist(video) + await updateSha256VODSegments(video) + + return playlistPath +} -- cgit v1.2.3