X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=78ee5fa7f9a12f5f03f52cab8def28c9daab3731;hb=75b7117f078461d2507572ba9da6527894e1b734;hp=61c8a6db26bd83ac84e7c3ce8bea14913164135d;hpb=421ff4618da64f0849353383f690a014024c40da;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 61c8a6db2..78ee5fa7f 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,14 +1,24 @@ 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 { AvailableEncoders, EncoderOptions, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos' +import { pick } from '@shared/core-utils' +import { + AvailableEncoders, + EncoderOptions, + EncoderOptionsBuilder, + EncoderOptionsBuilderParams, + 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 { computeFPS, ffprobePromise, getAudioStream, getVideoFileBitrate, getVideoFileFPS, getVideoFileResolution } from './ffprobe-utils' import { processImage } from './image-utils' -import { logger } from './logger' +import { logger, loggerTagsFactory } from './logger' + +const lTags = loggerTagsFactory('ffmpeg') /** * @@ -34,7 +44,7 @@ async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders return supportedEncoders } - const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders) + const getAvailableEncodersPromise = promisify0(getAvailableEncoders) const availableFFmpegEncoders = await getAvailableEncodersPromise() const searchEncoders = new Set() @@ -52,7 +62,7 @@ async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) } - logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders }) + logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders, ...lTags() }) return supportedEncoders } @@ -107,12 +117,12 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima const destination = join(folder, imageName) await processImage(pendingImagePath, destination, size) } catch (err) { - logger.error('Cannot generate image from video %s.', fromPath, { err }) + logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() }) try { await remove(pendingImagePath) } catch (err) { - logger.debug('Cannot remove pending image path after generation error.', { err }) + logger.debug('Cannot remove pending image path after generation error.', { err, ...lTags() }) } } } @@ -183,7 +193,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, @@ -194,7 +204,7 @@ const builders: { } async function transcode (options: TranscodeOptions) { - logger.debug('Will run transcode.', { options }) + logger.debug('Will run transcode.', { options, ...lTags() }) let command = getFFmpeg(options.inputPath, 'vod') .output(options.outputPath) @@ -211,25 +221,28 @@ 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, masterPlaylistName } = 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[] = [] - const complexFilter: ffmpeg.FilterSpecification[] = [ + const complexFilter: FilterSpecification[] = [ { inputs: '[v:0]', filter: 'split', @@ -247,20 +260,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') } @@ -269,7 +286,10 @@ async function getLiveTranscodingCommand (options: { addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) - logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult) + logger.debug( + 'Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, + { builderResult, fps: resolutionFPS, resolution, ...lTags() } + ) command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`) applyEncoderOptions(command, builderResult.result) @@ -284,7 +304,7 @@ async function getLiveTranscodingCommand (options: { { 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') } @@ -293,7 +313,10 @@ async function getLiveTranscodingCommand (options: { addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) - logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult) + logger.debug( + 'Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, + { builderResult, fps: resolutionFPS, resolution, ...lTags() } + ) command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`) applyEncoderOptions(command, builderResult.result) @@ -311,8 +334,8 @@ async function getLiveTranscodingCommand (options: { return command } -function getLiveMuxingCommand (rtmpUrl: string, outPath: string, masterPlaylistName: 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') @@ -337,7 +360,7 @@ function buildStreamSuffix (base: string, streamNum?: number) { // --------------------------------------------------------------------------- function addDefaultEncoderGlobalParams (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand }) { const { command } = options @@ -345,16 +368,12 @@ function addDefaultEncoderGlobalParams (options: { command.outputOption('-max_muxing_queue_size 1024') // strip all metadata .outputOption('-map_metadata -1') - // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it - .outputOption('-b_strategy 1') - // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16 - .outputOption('-bf 16') // allows import of source material with incompatible pixel formats (e.g. MJPEG video) .outputOption('-pix_fmt yuv420p') } function addDefaultEncoderParams (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand encoder: 'libx264' | string streamNum?: number fps?: number @@ -374,7 +393,7 @@ function addDefaultEncoderParams (options: { } } -function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, masterPlaylistName: 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') @@ -389,7 +408,7 @@ 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) @@ -406,7 +425,7 @@ async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: Tran return command } -async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) { +async function buildAudioMergeCommand (command: FfmpegCommand, options: MergeAudioTranscodeOptions) { command = command.loop(undefined) const scaleFilterValue = getScaleCleanerValue() @@ -421,13 +440,13 @@ async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: M 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 @@ -436,7 +455,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') @@ -446,7 +465,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) @@ -458,7 +477,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') @@ -500,7 +519,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 @@ -508,24 +527,20 @@ 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[videoType][streamType] const encoders = availableEncoders.available[videoType] for (const encoder of encodersToTry) { if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) { - logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder) + logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder, lTags()) continue } if (!encoders[encoder]) { - logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder) + logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder, lTags()) continue } @@ -534,16 +549,16 @@ async function getEncoderBuilderResult (options: { let builder = builderProfiles[profile] if (!builder) { - logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder) + logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder, lTags()) builder = builderProfiles.default if (!builder) { - logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder) + logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder, lTags()) continue } } - const result = await builder({ input, resolution, fps, streamNum }) + const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ])) return { result, @@ -559,7 +574,7 @@ async function getEncoderBuilderResult (options: { } async function presetVideo (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand input: string transcodeOptions: TranscodeOptions fps?: number @@ -573,8 +588,12 @@ async function presetVideo (options: { 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' ] @@ -593,6 +612,8 @@ async function presetVideo (options: { availableEncoders, profile, fps, + inputBitrate: bitrate, + inputRatio: ratio, videoType: 'vod' as 'vod' }) @@ -602,7 +623,8 @@ async function presetVideo (options: { logger.debug( 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.', - builderResult.encoder, streamType, input, profile, builderResult + builderResult.encoder, streamType, input, profile, + { builderResult, resolution, fps, ...lTags() } ) if (streamType === 'video') { @@ -622,21 +644,21 @@ async function presetVideo (options: { 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: ffmpeg.FfmpegCommand, options: EncoderOptions): ffmpeg.FfmpegCommand { +function applyEncoderOptions (command: FfmpegCommand, options: EncoderOptions): FfmpegCommand { return command .inputOptions(options.inputOptions ?? []) .outputOptions(options.outputOptions ?? []) @@ -696,7 +718,7 @@ function getFFmpegVersion () { } async function runCommand (options: { - command: ffmpeg.FfmpegCommand + command: FfmpegCommand silent?: boolean // false job?: Job }) { @@ -708,13 +730,13 @@ async function runCommand (options: { command.on('start', cmdline => { shellCommand = cmdline }) command.on('error', (err, stdout, stderr) => { - if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr }) + if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr, shellCommand, ...lTags() }) rej(err) }) command.on('end', (stdout, stderr) => { - logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand }) + logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand, ...lTags() }) res() }) @@ -724,7 +746,7 @@ async function runCommand (options: { if (!progress.percent) return job.progress(Math.round(progress.percent)) - .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err })) + .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err, ...lTags() })) }) }