X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=f79b70469d92d408793dd4955786e9335ee3a5ed;hb=ce4b4495ff3607045dc6d5656f72ebf5eb28cb73;hp=1093cb48306a2bba6fdbd281cb8bca414b47f567;hpb=49bcdb0d6699f19d359f40e974cdffd93a4b34c7;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 1093cb483..f79b70469 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,13 +1,15 @@ +import { Job } from 'bull' import * as ffmpeg from 'fluent-ffmpeg' import { readFile, remove, writeFile } from 'fs-extra' import { dirname, join } from 'path' -import { FFMPEG_NICE, VIDEO_LIVE, VIDEO_TRANSCODING_ENCODERS } from '@server/initializers/constants' -import { VideoResolution } from '../../shared/models/videos' -import { checkFFmpegEncoders } from '../initializers/checker-before-init' +import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants' +import { AvailableEncoders, EncoderOptionsBuilder, EncoderOptions, EncoderProfile, VideoResolution } from '../../shared/models/videos' import { CONFIG } from '../initializers/config' +import { execPromise, promisify0 } from './core-utils' import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils' import { processImage } from './image-utils' import { logger } from './logger' +import { FilterSpecification } from 'fluent-ffmpeg' /** * @@ -20,34 +22,44 @@ import { logger } from './logger' // Encoder options // --------------------------------------------------------------------------- -// Options builders +type StreamType = 'audio' | 'video' -export type EncoderOptionsBuilder = (params: { - input: string - resolution: VideoResolution - fps?: number - streamNum?: number -}) => Promise | EncoderOptions +// --------------------------------------------------------------------------- +// Encoders support +// --------------------------------------------------------------------------- -// Options types +// Detect supported encoders by ffmpeg +let supportedEncoders: Map +async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise> { + if (supportedEncoders !== undefined) { + return supportedEncoders + } -export interface EncoderOptions { - copy?: boolean - outputOptions: string[] -} + const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders) + const availableFFmpegEncoders = await getAvailableEncodersPromise() + + const searchEncoders = new Set() + for (const type of [ 'live', 'vod' ]) { + for (const streamType of [ 'audio', 'video' ]) { + for (const encoder of peertubeAvailableEncoders.encodersToTry[type][streamType]) { + searchEncoders.add(encoder) + } + } + } + + supportedEncoders = new Map() -// All our encoders + for (const searchEncoder of searchEncoders) { + supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) + } -export interface EncoderProfile { - [ profile: string ]: T + logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders }) - default: T + return supportedEncoders } -export type AvailableEncoders = { - [ id in 'live' | 'vod' ]: { - [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile - } +function resetSupportedEncoders () { + supportedEncoders = undefined } // --------------------------------------------------------------------------- @@ -55,10 +67,10 @@ export type AvailableEncoders = { // --------------------------------------------------------------------------- function convertWebPToJPG (path: string, destination: string): Promise { - const command = ffmpeg(path) + const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) .output(destination) - return runCommand(command) + return runCommand({ command, silent: true }) } function processGIF ( @@ -66,12 +78,12 @@ function processGIF ( destination: string, newSize: { width: number, height: number } ): Promise { - const command = ffmpeg(path) + const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) .fps(20) .size(`${newSize.width}x${newSize.height}`) .output(destination) - return runCommand(command) + return runCommand({ command }) } async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { @@ -124,6 +136,8 @@ interface BaseTranscodeOptions { resolution: VideoResolution isPortraitMode?: boolean + + job?: Job } interface HLSTranscodeOptions extends BaseTranscodeOptions { @@ -137,6 +151,8 @@ interface HLSTranscodeOptions extends BaseTranscodeOptions { interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions { type: 'hls-from-ts' + isAAC: boolean + hlsPlaylist: { videoFilename: string } @@ -186,7 +202,7 @@ async function transcode (options: TranscodeOptions) { command = await builders[options.type](command, options) - await runCommand(command) + await runCommand({ command, job: options.job }) await fixHLSPlaylistIfNeeded(options) } @@ -211,21 +227,14 @@ async function getLiveTranscodingCommand (options: { const varStreamMap: string[] = [] - command.complexFilter([ + const complexFilter: FilterSpecification[] = [ { inputs: '[v:0]', filter: 'split', options: resolutions.length, outputs: resolutions.map(r => `vtemp${r}`) - }, - - ...resolutions.map(r => ({ - inputs: `vtemp${r}`, - filter: 'scale', - options: `w=-2:h=${r}`, - outputs: `vout${r}` - })) - ]) + } + ] command.outputOption('-preset superfast') command.outputOption('-sc_threshold 0') @@ -238,8 +247,10 @@ async function getLiveTranscodingCommand (options: { const baseEncoderBuilderParams = { input, + availableEncoders, profile, + fps: resolutionFPS, resolution, streamNum: i, @@ -247,7 +258,8 @@ async function getLiveTranscodingCommand (options: { } { - const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' })) + const streamType: StreamType = 'video' + const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) if (!builderResult) { throw new Error('No available live video encoder found') } @@ -256,14 +268,22 @@ async function getLiveTranscodingCommand (options: { addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) - logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult) + logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult) command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`) - command.addOutputOptions(builderResult.result.outputOptions) + applyEncoderOptions(command, builderResult.result) + + complexFilter.push({ + inputs: `vtemp${resolution}`, + filter: getScaleFilter(builderResult.result), + options: `w=-2:h=${resolution}`, + outputs: `vout${resolution}` + }) } { - const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' })) + const streamType: StreamType = 'audio' + const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) if (!builderResult) { throw new Error('No available live audio encoder found') } @@ -272,15 +292,17 @@ async function getLiveTranscodingCommand (options: { addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) - logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult) + logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult) command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`) - command.addOutputOptions(builderResult.result.outputOptions) + applyEncoderOptions(command, builderResult.result) } varStreamMap.push(`v:${i},a:${i}`) } + command.complexFilter(complexFilter) + addDefaultLiveHLSParams(command, outPath) command.outputOption('-var_stream_map', varStreamMap.join(' ')) @@ -309,22 +331,6 @@ function buildStreamSuffix (base: string, streamNum?: number) { return base } -// --------------------------------------------------------------------------- - -export { - getLiveTranscodingCommand, - getLiveMuxingCommand, - buildStreamSuffix, - convertWebPToJPG, - processGIF, - generateImageFromVideoFile, - TranscodeOptions, - TranscodeOptionsType, - transcode -} - -// --------------------------------------------------------------------------- - // --------------------------------------------------------------------------- // Default options // --------------------------------------------------------------------------- @@ -386,29 +392,29 @@ async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: Tran let fps = await getVideoFileFPS(options.inputPath) fps = computeFPS(fps, options.resolution) - command = await presetVideo(command, options.inputPath, options, fps) + let scaleFilterValue: string if (options.resolution !== undefined) { - // '?x720' or '720x?' for example - const size = options.isPortraitMode === true - ? `${options.resolution}x?` - : `?x${options.resolution}` - - command = command.size(size) + scaleFilterValue = options.isPortraitMode === true + ? `w=${options.resolution}:h=-2` + : `w=-2:h=${options.resolution}` } + command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue }) + return command } async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) { command = command.loop(undefined) - command = await presetVideo(command, options.audioPath, options) + // Avoid "height not divisible by 2" error + const scaleFilterValue = 'trunc(iw/2)*2:trunc(ih/2)*2' + command = await presetVideo({ command, input: options.audioPath, transcodeOptions: options, scaleFilterValue }) command.outputOption('-preset:v veryfast') command = command.input(options.audioPath) - .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error .outputOption('-tune stillimage') .outputOption('-shortest') @@ -455,11 +461,13 @@ async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTr async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) { const videoPath = getHLSVideoPath(options) - command.inputOption('-safe 0') - command.inputOption('-f concat') + command.outputOption('-c copy') - command.outputOption('-c:v copy') - command.audioFilter('aresample=async=1:first_pts=0') + if (options.isAAC) { + // Required for example when copying an AAC stream from an MPEG-TS + // Since it's a bitstream filter, we don't need to reencode the audio + command.outputOption('-bsf:a aac_adtstoasc') + } addCommonHLSVODCommandOptions(command, videoPath) @@ -489,8 +497,11 @@ function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptio // Transcoding presets // --------------------------------------------------------------------------- +// Run encoder builder depending on available encoders +// Try encoders by priority: if the encoder is available, run the chosen profile or fallback to the default one +// If the default one does not exist, check the next encoder async function getEncoderBuilderResult (options: { - streamType: string + streamType: 'video' | 'audio' input: string availableEncoders: AvailableEncoders @@ -504,17 +515,32 @@ async function getEncoderBuilderResult (options: { }) { const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options - const encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[streamType] + const encodersToTry = availableEncoders.encodersToTry[videoType][streamType] + const encoders = availableEncoders.available[videoType] for (const encoder of encodersToTry) { - if (!(await checkFFmpegEncoders()).get(encoder) || !availableEncoders[videoType][encoder]) continue + if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) { + logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder) + continue + } + + if (!encoders[encoder]) { + logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder) + continue + } - const builderProfiles: EncoderProfile = availableEncoders[videoType][encoder] + // An object containing available profiles for this encoder + const builderProfiles: EncoderProfile = encoders[encoder] let builder = builderProfiles[profile] if (!builder) { logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder) builder = builderProfiles.default + + if (!builder) { + logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder) + continue + } } const result = await builder({ input, resolution: resolution, fps, streamNum }) @@ -532,12 +558,15 @@ async function getEncoderBuilderResult (options: { return null } -async function presetVideo ( - command: ffmpeg.FfmpegCommand, - input: string, - transcodeOptions: TranscodeOptions, +async function presetVideo (options: { + command: ffmpeg.FfmpegCommand + input: string + transcodeOptions: TranscodeOptions fps?: number -) { + scaleFilterValue?: string +}) { + const { command, input, transcodeOptions, fps, scaleFilterValue } = options + let localCommand = command .format('mp4') .outputOption('-movflags faststart') @@ -547,11 +576,11 @@ async function presetVideo ( // Audio encoder const parsedAudio = await getAudioStream(input) - let streamsToProcess = [ 'AUDIO', 'VIDEO' ] + let streamsToProcess: StreamType[] = [ 'audio', 'video' ] if (!parsedAudio.audioStream) { localCommand = localCommand.noAudio() - streamsToProcess = [ 'VIDEO' ] + streamsToProcess = [ 'video' ] } for (const streamType of streamsToProcess) { @@ -571,15 +600,22 @@ async function presetVideo ( throw new Error('No available encoder found for stream ' + streamType) } - logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult) + logger.debug( + 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.', + builderResult.encoder, streamType, input, profile, builderResult + ) - if (streamType === 'VIDEO') { + if (streamType === 'video') { localCommand.videoCodec(builderResult.encoder) - } else if (streamType === 'AUDIO') { + + if (scaleFilterValue) { + localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`) + } + } else if (streamType === 'audio') { localCommand.audioCodec(builderResult.encoder) } - command.addOutputOptions(builderResult.result.outputOptions) + applyEncoderOptions(localCommand, builderResult.result) addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps }) } @@ -600,13 +636,28 @@ function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { .noVideo() } +function applyEncoderOptions (command: ffmpeg.FfmpegCommand, options: EncoderOptions): ffmpeg.FfmpegCommand { + return command + .inputOptions(options.inputOptions ?? []) + .outputOptions(options.outputOptions ?? []) +} + +function getScaleFilter (options: EncoderOptions): string { + if (options.scaleFilter) return options.scaleFilter.name + + return 'scale' +} + // --------------------------------------------------------------------------- // Utils // --------------------------------------------------------------------------- function getFFmpeg (input: string, type: 'live' | 'vod') { // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems - const command = ffmpeg(input, { niceness: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR }) + const command = ffmpeg(input, { + niceness: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD, + cwd: CONFIG.STORAGE.TMP_DIR + }) const threads = type === 'live' ? CONFIG.LIVE.TRANSCODING.THREADS @@ -620,21 +671,80 @@ function getFFmpeg (input: string, type: 'live' | 'vod') { return command } -async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) { +function getFFmpegVersion () { + return new Promise((res, rej) => { + (ffmpeg() as any)._getFfmpegPath((err, ffmpegPath) => { + if (err) return rej(err) + if (!ffmpegPath) return rej(new Error('Could not find ffmpeg path')) + + return execPromise(`${ffmpegPath} -version`) + .then(stdout => { + const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/) + if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`)) + + // Fix ffmpeg version that does not include patch version (4.4 for example) + let version = parsed[1] + if (version.match(/^\d+\.\d+/)) { + version += '.0' + } + + return res(version) + }) + .catch(err => rej(err)) + }) + }) +} + +async function runCommand (options: { + command: ffmpeg.FfmpegCommand + silent?: boolean // false + job?: Job +}) { + const { command, silent = false, job } = options + return new Promise((res, rej) => { command.on('error', (err, stdout, stderr) => { - if (onEnd) onEnd() + if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr }) - logger.error('Error in transcoding job.', { stdout, stderr }) rej(err) }) - command.on('end', () => { - if (onEnd) onEnd() + command.on('end', (stdout, stderr) => { + logger.debug('FFmpeg command ended.', { stdout, stderr }) res() }) + if (job) { + command.on('progress', progress => { + if (!progress.percent) return + + job.progress(Math.round(progress.percent)) + .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err })) + }) + } + command.run() }) } + +// --------------------------------------------------------------------------- + +export { + getLiveTranscodingCommand, + getLiveMuxingCommand, + buildStreamSuffix, + convertWebPToJPG, + processGIF, + generateImageFromVideoFile, + TranscodeOptions, + TranscodeOptionsType, + transcode, + runCommand, + getFFmpegVersion, + + resetSupportedEncoders, + + // builders + buildx264VODCommand +}