X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=ec24f357be15e0c0dcd61e27699d15224bcc5f18;hb=3233acdadf34045b51da91d42bcd6b3cbf3036f4;hp=7d46130ec206fce06a3fe7e2de4f3bb0cc61b7ff;hpb=529b37527cff5203a0689a15ce73dcee6e1eece2;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 7d46130ec..ec24f357b 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,12 +1,20 @@ import { Job } from 'bull' -import * as ffmpeg from 'fluent-ffmpeg' +import ffmpeg, { FfmpegCommand, FilterSpecification, getAvailableEncoders } from 'fluent-ffmpeg' import { readFile, remove, writeFile } from 'fs-extra' import { dirname, join } from 'path' import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants' -import { VideoResolution } from '../../shared/models/videos' -import { checkFFmpegEncoders } from '../initializers/checker-before-init' +import { pick } from '@shared/core-utils' +import { + AvailableEncoders, + EncoderOptions, + EncoderOptionsBuilder, + EncoderOptionsBuilderParams, + EncoderProfile, + VideoResolution +} from '../../shared/models/videos' import { CONFIG } from '../initializers/config' -import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils' +import { execPromise, promisify0 } from './core-utils' +import { computeFPS, ffprobePromise, getAudioStream, getVideoFileBitrate, getVideoFileFPS, getVideoFileResolution } from './ffprobe-utils' import { processImage } from './image-utils' import { logger } from './logger' @@ -21,46 +29,45 @@ import { logger } from './logger' // Encoder options // --------------------------------------------------------------------------- -// Options builders - -export type EncoderOptionsBuilder = (params: { - input: string - resolution: VideoResolution - fps?: number - streamNum?: number -}) => Promise | EncoderOptions +type StreamType = 'audio' | 'video' -// Options types +// --------------------------------------------------------------------------- +// Encoders support +// --------------------------------------------------------------------------- -export interface EncoderOptions { - copy?: boolean - outputOptions: string[] -} +// Detect supported encoders by ffmpeg +let supportedEncoders: Map +async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise> { + if (supportedEncoders !== undefined) { + return supportedEncoders + } -// All our encoders + const getAvailableEncodersPromise = promisify0(getAvailableEncoders) + const availableFFmpegEncoders = await getAvailableEncodersPromise() -export interface EncoderProfile { - [ profile: string ]: T + 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) + } + } + } - default: T -} + supportedEncoders = new Map() -export type AvailableEncoders = { - live: { - [ encoder: string ]: EncoderProfile + for (const searchEncoder of searchEncoders) { + supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) } - vod: { - [ encoder: string ]: EncoderProfile - } + logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders }) - encodersToTry: { - video: string[] - audio: string[] - } + return supportedEncoders } -type StreamType = 'audio' | 'video' +function resetSupportedEncoders () { + supportedEncoders = undefined +} // --------------------------------------------------------------------------- // Image manipulation @@ -70,7 +77,7 @@ function convertWebPToJPG (path: string, destination: string): Promise { const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) .output(destination) - return runCommand(command) + return runCommand({ command, silent: true }) } function processGIF ( @@ -83,7 +90,7 @@ function processGIF ( .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 }) { @@ -133,7 +140,7 @@ interface BaseTranscodeOptions { availableEncoders: AvailableEncoders profile: string - resolution: VideoResolution + resolution: number isPortraitMode?: boolean @@ -184,7 +191,7 @@ type TranscodeOptions = | QuickTranscodeOptions const builders: { - [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise | ffmpeg.FfmpegCommand + [ type in TranscodeOptionsType ]: (c: FfmpegCommand, o?: TranscodeOptions) => Promise | FfmpegCommand } = { 'quick-transcode': buildQuickTranscodeCommand, 'hls': buildHLSVODCommand, @@ -202,7 +209,7 @@ async function transcode (options: TranscodeOptions) { command = await builders[options.type](command, options) - await runCommand(command, options.job) + await runCommand({ command, job: options.job }) await fixHLSPlaylistIfNeeded(options) } @@ -212,38 +219,36 @@ async function transcode (options: TranscodeOptions) { // --------------------------------------------------------------------------- async function getLiveTranscodingCommand (options: { - rtmpUrl: string + inputUrl: string + outPath: string + masterPlaylistName: string + resolutions: number[] + + // Input information fps: number + bitrate: number + ratio: number availableEncoders: AvailableEncoders profile: string }) { - const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options - const input = rtmpUrl + const { inputUrl, outPath, resolutions, fps, bitrate, availableEncoders, profile, masterPlaylistName, ratio } = options - const command = getFFmpeg(input, 'live') + const command = getFFmpeg(inputUrl, 'live') 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') addDefaultEncoderGlobalParams({ command }) @@ -253,20 +258,24 @@ async function getLiveTranscodingCommand (options: { const resolutionFPS = computeFPS(fps, resolution) const baseEncoderBuilderParams = { - input, + input: inputUrl, availableEncoders, profile, - fps: resolutionFPS, + inputBitrate: bitrate, + inputRatio: ratio, + resolution, + fps: resolutionFPS, + streamNum: i, videoType: 'live' as 'live' } { const streamType: StreamType = 'video' - const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) + const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType }) if (!builderResult) { throw new Error('No available live video encoder found') } @@ -275,15 +284,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 streamType: StreamType = 'audio' - const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) + const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType }) if (!builderResult) { throw new Error('No available live audio encoder found') } @@ -292,31 +308,33 @@ 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}`) } - addDefaultLiveHLSParams(command, outPath) + command.complexFilter(complexFilter) + + addDefaultLiveHLSParams(command, outPath, masterPlaylistName) command.outputOption('-var_stream_map', varStreamMap.join(' ')) return command } -function getLiveMuxingCommand (rtmpUrl: string, outPath: string) { - const command = getFFmpeg(rtmpUrl, 'live') +function getLiveMuxingCommand (inputUrl: string, outPath: string, masterPlaylistName: string) { + const command = getFFmpeg(inputUrl, 'live') command.outputOption('-c:v copy') command.outputOption('-c:a copy') command.outputOption('-map 0:a?') command.outputOption('-map 0:v?') - addDefaultLiveHLSParams(command, outPath) + addDefaultLiveHLSParams(command, outPath, masterPlaylistName) return command } @@ -334,7 +352,7 @@ function buildStreamSuffix (base: string, streamNum?: number) { // --------------------------------------------------------------------------- function addDefaultEncoderGlobalParams (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand }) { const { command } = options @@ -351,7 +369,7 @@ function addDefaultEncoderGlobalParams (options: { } function addDefaultEncoderParams (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand encoder: 'libx264' | string streamNum?: number fps?: number @@ -371,12 +389,12 @@ function addDefaultEncoderParams (options: { } } -function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) { +function addDefaultLiveHLSParams (command: FfmpegCommand, outPath: string, masterPlaylistName: string) { command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS) command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE) command.outputOption('-hls_flags delete_segments+independent_segments') command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`) - command.outputOption('-master_pl_name master.m3u8') + command.outputOption('-master_pl_name ' + masterPlaylistName) command.outputOption(`-f hls`) command.output(join(outPath, '%v.m3u8')) @@ -386,46 +404,45 @@ function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string // Transcode VOD command builders // --------------------------------------------------------------------------- -async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) { +async function buildx264VODCommand (command: FfmpegCommand, options: TranscodeOptions) { 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) { +async function buildAudioMergeCommand (command: FfmpegCommand, options: MergeAudioTranscodeOptions) { command = command.loop(undefined) - command = await presetVideo(command, options.audioPath, options) + const scaleFilterValue = getScaleCleanerValue() + 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') return command } -function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) { +function buildOnlyAudioCommand (command: FfmpegCommand, _options: OnlyAudioTranscodeOptions) { command = presetOnlyAudio(command) return command } -function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { +function buildQuickTranscodeCommand (command: FfmpegCommand) { command = presetCopy(command) command = command.outputOption('-map_metadata -1') // strip all metadata @@ -434,7 +451,7 @@ function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { return command } -function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPath: string) { +function addCommonHLSVODCommandOptions (command: FfmpegCommand, outputPath: string) { return command.outputOption('-hls_time 4') .outputOption('-hls_list_size 0') .outputOption('-hls_playlist_type vod') @@ -444,7 +461,7 @@ function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPat .outputOption('-hls_flags single_file') } -async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { +async function buildHLSVODCommand (command: FfmpegCommand, options: HLSTranscodeOptions) { const videoPath = getHLSVideoPath(options) if (options.copyCodecs) command = presetCopy(command) @@ -456,7 +473,7 @@ async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTr return command } -async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) { +function buildHLSVODFromTSCommand (command: FfmpegCommand, options: HLSFromTSTranscodeOptions) { const videoPath = getHLSVideoPath(options) command.outputOption('-c copy') @@ -498,7 +515,7 @@ function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptio // 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: { +async function getEncoderBuilderResult (options: EncoderOptionsBuilderParams & { streamType: 'video' | 'audio' input: string @@ -506,18 +523,22 @@ async function getEncoderBuilderResult (options: { profile: string videoType: 'vod' | 'live' - - resolution: number - fps?: number - streamNum?: number }) { - const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options + const { availableEncoders, profile, streamType, videoType } = options - const encodersToTry = availableEncoders.encodersToTry[streamType] - const encoders = availableEncoders[videoType] + const encodersToTry = availableEncoders.encodersToTry[videoType][streamType] + const encoders = availableEncoders.available[videoType] for (const encoder of encodersToTry) { - if (!(await checkFFmpegEncoders()).get(encoder) || !encoders[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 + } // An object containing available profiles for this encoder const builderProfiles: EncoderProfile = encoders[encoder] @@ -533,7 +554,7 @@ async function getEncoderBuilderResult (options: { } } - const result = await builder({ input, resolution: resolution, fps, streamNum }) + const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ])) return { result, @@ -548,26 +569,33 @@ async function getEncoderBuilderResult (options: { return null } -async function presetVideo ( - command: ffmpeg.FfmpegCommand, - input: string, - transcodeOptions: TranscodeOptions, +async function presetVideo (options: { + command: FfmpegCommand + input: string + transcodeOptions: TranscodeOptions fps?: number -) { + scaleFilterValue?: string +}) { + const { command, input, transcodeOptions, fps, scaleFilterValue } = options + let localCommand = command .format('mp4') .outputOption('-movflags faststart') addDefaultEncoderGlobalParams({ command }) + const probe = await ffprobePromise(input) + // Audio encoder - const parsedAudio = await getAudioStream(input) + const parsedAudio = await getAudioStream(input, probe) + const bitrate = await getVideoFileBitrate(input, probe) + const { ratio } = await getVideoFileResolution(input, probe) let streamsToProcess: StreamType[] = [ 'audio', 'video' ] if (!parsedAudio.audioStream) { localCommand = localCommand.noAudio() - streamsToProcess = [ 'audio' ] + streamsToProcess = [ 'video' ] } for (const streamType of streamsToProcess) { @@ -580,6 +608,8 @@ async function presetVideo ( availableEncoders, profile, fps, + inputBitrate: bitrate, + inputRatio: ratio, videoType: 'vod' as 'vod' }) @@ -587,35 +617,54 @@ 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') { localCommand.videoCodec(builderResult.encoder) + + 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 }) } return localCommand } -function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { +function presetCopy (command: FfmpegCommand): FfmpegCommand { return command .format('mp4') .videoCodec('copy') .audioCodec('copy') } -function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { +function presetOnlyAudio (command: FfmpegCommand): FfmpegCommand { return command .format('mp4') .audioCodec('copy') .noVideo() } +function applyEncoderOptions (command: FfmpegCommand, options: EncoderOptions): FfmpegCommand { + return command + .inputOptions(options.inputOptions ?? []) + .outputOptions(options.outputOptions ?? []) +} + +function getScaleFilter (options: EncoderOptions): string { + if (options.scaleFilter) return options.scaleFilter.name + + return 'scale' +} + // --------------------------------------------------------------------------- // Utils // --------------------------------------------------------------------------- @@ -639,15 +688,50 @@ function getFFmpeg (input: string, type: 'live' | 'vod') { return command } -async function runCommand (command: ffmpeg.FfmpegCommand, job?: Job) { +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: FfmpegCommand + silent?: boolean // false + job?: Job +}) { + const { command, silent = false, job } = options + return new Promise((res, rej) => { + let shellCommand: string + + command.on('start', cmdline => { shellCommand = cmdline }) + command.on('error', (err, stdout, stderr) => { - logger.error('Error in transcoding job.', { stdout, stderr }) + if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr }) + rej(err) }) command.on('end', (stdout, stderr) => { - logger.debug('FFmpeg command ended.', { stdout, stderr }) + logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand }) res() }) @@ -665,6 +749,11 @@ async function runCommand (command: ffmpeg.FfmpegCommand, job?: Job) { }) } +// Avoid "height not divisible by 2" error +function getScaleCleanerValue () { + return 'trunc(iw/2)*2:trunc(ih/2)*2' +} + // --------------------------------------------------------------------------- export { @@ -678,6 +767,9 @@ export { TranscodeOptionsType, transcode, runCommand, + getFFmpegVersion, + + resetSupportedEncoders, // builders buildx264VODCommand