X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=78ee5fa7f9a12f5f03f52cab8def28c9daab3731;hb=b65de1be4dcf626c552be613d531d3f6e23c6085;hp=69defccc4c6dd6b19e353fcb23e9c7a05e5a7bb4;hpb=6b67897e2eab96978daee40aeaf716835856d65d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 69defccc4..78ee5fa7f 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,13 +1,24 @@ -import * as ffmpeg from 'fluent-ffmpeg' +import { Job } from 'bull' +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, VIDEO_TRANSCODING_ENCODERS, VIDEO_TRANSCODING_FPS } 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 { pick } from '@shared/core-utils' +import { + AvailableEncoders, + EncoderOptions, + EncoderOptionsBuilder, + EncoderOptionsBuilderParams, + EncoderProfile, + VideoResolution +} from '../../shared/models/videos' import { CONFIG } from '../initializers/config' -import { getAudioStream, getClosestFramerateStandard, 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' +import { logger, loggerTagsFactory } from './logger' + +const lTags = loggerTagsFactory('ffmpeg') /** * @@ -20,34 +31,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(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) + } + } + } -// All our encoders + supportedEncoders = new Map() -export interface EncoderProfile { - [ profile: string ]: T + for (const searchEncoder of searchEncoders) { + supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) + } - default: T + logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders, ...lTags() }) + + return supportedEncoders } -export type AvailableEncoders = { - [ id in 'live' | 'vod' ]: { - [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile - } +function resetSupportedEncoders () { + supportedEncoders = undefined } // --------------------------------------------------------------------------- @@ -55,44 +76,23 @@ 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 ( path: string, destination: string, - newSize: { width: number, height: number }, - keepOriginal = false + newSize: { width: number, height: number } ): Promise { - return new Promise(async (res, rej) => { - if (path === destination) { - throw new Error('FFmpeg needs an input path different that the output path.') - } - - logger.debug('Processing gif %s to %s.', path, destination) + const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) + .fps(20) + .size(`${newSize.width}x${newSize.height}`) + .output(destination) - try { - const command = ffmpeg(path) - .fps(20) - .size(`${newSize.width}x${newSize.height}`) - .output(destination) - - command.on('error', (err, stdout, stderr) => { - logger.error('Error in ffmpeg gif resizing process.', { stdout, stderr }) - return rej(err) - }) - .on('end', async () => { - if (keepOriginal !== true) await remove(path) - res() - }) - .run() - } catch (err) { - return rej(err) - } - }) + return runCommand({ command }) } async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { @@ -117,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() }) } } } @@ -131,7 +131,7 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima // Transcode meta function // --------------------------------------------------------------------------- -type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio' +type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio' interface BaseTranscodeOptions { type: TranscodeOptionsType @@ -142,9 +142,11 @@ interface BaseTranscodeOptions { availableEncoders: AvailableEncoders profile: string - resolution: VideoResolution + resolution: number isPortraitMode?: boolean + + job?: Job } interface HLSTranscodeOptions extends BaseTranscodeOptions { @@ -155,6 +157,16 @@ interface HLSTranscodeOptions extends BaseTranscodeOptions { } } +interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions { + type: 'hls-from-ts' + + isAAC: boolean + + hlsPlaylist: { + videoFilename: string + } +} + interface QuickTranscodeOptions extends BaseTranscodeOptions { type: 'quick-transcode' } @@ -174,30 +186,32 @@ interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions { type TranscodeOptions = HLSTranscodeOptions + | HLSFromTSTranscodeOptions | VideoTranscodeOptions | MergeAudioTranscodeOptions | OnlyAudioTranscodeOptions | 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, + 'hls-from-ts': buildHLSVODFromTSCommand, 'merge-audio': buildAudioMergeCommand, 'only-audio': buildOnlyAudioCommand, 'video': buildx264VODCommand } async function transcode (options: TranscodeOptions) { - logger.debug('Will run transcode.', { options }) + logger.debug('Will run transcode.', { options, ...lTags() }) - let command = getFFmpeg(options.inputPath) + let command = getFFmpeg(options.inputPath, 'vod') .output(options.outputPath) command = await builders[options.type](command, options) - await runCommand(command) + await runCommand({ command, job: options.job }) await fixHLSPlaylistIfNeeded(options) } @@ -207,126 +221,132 @@ async function transcode (options: TranscodeOptions) { // --------------------------------------------------------------------------- async function getLiveTranscodingCommand (options: { - rtmpUrl: string + inputUrl: string + outPath: string + masterPlaylistName: string + resolutions: number[] + + // Input information fps: number - deleteSegments: boolean + bitrate: number + ratio: number availableEncoders: AvailableEncoders profile: string }) { - const { rtmpUrl, outPath, resolutions, fps, deleteSegments, availableEncoders, profile } = options - const input = rtmpUrl + const { inputUrl, outPath, resolutions, fps, bitrate, availableEncoders, profile, masterPlaylistName, ratio } = options - const command = getFFmpeg(input) - command.inputOption('-fflags nobuffer') + 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('-sc_threshold 0') - command.outputOption('-preset superfast') + addDefaultEncoderGlobalParams({ command }) for (let i = 0; i < resolutions.length; i++) { const resolution = resolutions[i] - const baseEncoderBuilderParams = { input, availableEncoders, profile, fps, resolution, streamNum: i, videoType: 'live' as 'live' } + const resolutionFPS = computeFPS(fps, resolution) + + const baseEncoderBuilderParams = { + input: inputUrl, + + availableEncoders, + profile, + + inputBitrate: bitrate, + inputRatio: ratio, + + resolution, + fps: resolutionFPS, + + streamNum: i, + videoType: 'live' as 'live' + } { - const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' })) + const streamType: StreamType = 'video' + const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType }) if (!builderResult) { throw new Error('No available live video encoder found') } command.outputOption(`-map [vout${resolution}]`) - addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps, streamNum: i }) + 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, fps: resolutionFPS, resolution, ...lTags() } + ) 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({ ...baseEncoderBuilderParams, streamType }) if (!builderResult) { throw new Error('No available live audio encoder found') } command.outputOption('-map a:0') - addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps, streamNum: i }) + 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, fps: resolutionFPS, resolution, ...lTags() } + ) 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, deleteSegments) + command.complexFilter(complexFilter) + + addDefaultLiveHLSParams(command, outPath, masterPlaylistName) command.outputOption('-var_stream_map', varStreamMap.join(' ')) return command } -function getLiveMuxingCommand (rtmpUrl: string, outPath: string, deleteSegments: boolean) { - const command = getFFmpeg(rtmpUrl) - command.inputOption('-fflags nobuffer') +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, deleteSegments) + addDefaultLiveHLSParams(command, outPath, masterPlaylistName) return command } -async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: string[], outputPath: string) { - const concatFilePath = join(hlsDirectory, 'concat.txt') - - function cleaner () { - remove(concatFilePath) - .catch(err => logger.error('Cannot remove concat file in %s.', hlsDirectory, { err })) - } - - // First concat the ts files to a mp4 file - const content = segmentFiles.map(f => 'file ' + f) - .join('\n') - - await writeFile(concatFilePath, content + '\n') - - const command = getFFmpeg(concatFilePath) - command.inputOption('-safe 0') - command.inputOption('-f concat') - - command.outputOption('-c:v copy') - command.audioFilter('aresample=async=1:first_pts=0') - command.output(outputPath) - - return runCommand(command, cleaner) -} - function buildStreamSuffix (base: string, streamNum?: number) { if (streamNum !== undefined) { return `${base}:${streamNum}` @@ -335,29 +355,25 @@ function buildStreamSuffix (base: string, streamNum?: number) { return base } -// --------------------------------------------------------------------------- - -export { - getLiveTranscodingCommand, - getLiveMuxingCommand, - buildStreamSuffix, - convertWebPToJPG, - processGIF, - generateImageFromVideoFile, - TranscodeOptions, - TranscodeOptionsType, - transcode, - hlsPlaylistToFragmentedMP4 -} - -// --------------------------------------------------------------------------- - // --------------------------------------------------------------------------- // Default options // --------------------------------------------------------------------------- +function addDefaultEncoderGlobalParams (options: { + command: FfmpegCommand +}) { + const { command } = options + + // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375 + command.outputOption('-max_muxing_queue_size 1024') + // strip all metadata + .outputOption('-map_metadata -1') + // 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 @@ -366,37 +382,23 @@ function addDefaultEncoderParams (options: { if (encoder === 'libx264') { // 3.1 is the minimal resource allocation for our highest supported resolution - command.outputOption('-level 3.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(buildStreamSuffix('-pix_fmt', streamNum) + ' yuv420p') - // strip all metadata - .outputOption('-map_metadata -1') - // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375 - .outputOption(buildStreamSuffix('-max_muxing_queue_size', streamNum) + ' 1024') + command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1') if (fps) { // Keyframe interval of 2 seconds for faster seeking and resolution switching. // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html // https://superuser.com/a/908325 - command.outputOption('-g ' + (fps * 2)) + command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2)) } } } -function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) { +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) - - if (deleteSegments === true) { - command.outputOption('-hls_flags delete_segments') - } - + 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')) @@ -406,67 +408,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) - if ( - // On small/medium resolutions, limit FPS - options.resolution !== undefined && - options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN && - fps > VIDEO_TRANSCODING_FPS.AVERAGE - ) { - // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value - fps = getClosestFramerateStandard(fps, 'STANDARD') - } + 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}` } - // Hard FPS limits - if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = getClosestFramerateStandard(fps, 'HD_STANDARD') - else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN - - command = command.withFPS(fps) + 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 }) - /* - MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html - Our target situation is closer to a livestream than a stream, - since we want to reduce as much a possible the encoding burden, - although not to the point of a livestream where there is a hard - constraint on the frames per second to be encoded. - */ 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 @@ -475,26 +455,46 @@ function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { return command } -async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { +function addCommonHLSVODCommandOptions (command: FfmpegCommand, outputPath: string) { + return command.outputOption('-hls_time 4') + .outputOption('-hls_list_size 0') + .outputOption('-hls_playlist_type vod') + .outputOption('-hls_segment_filename ' + outputPath) + .outputOption('-hls_segment_type fmp4') + .outputOption('-f hls') + .outputOption('-hls_flags single_file') +} + +async function buildHLSVODCommand (command: FfmpegCommand, options: HLSTranscodeOptions) { const videoPath = getHLSVideoPath(options) if (options.copyCodecs) command = presetCopy(command) else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command) else command = await buildx264VODCommand(command, options) - command = command.outputOption('-hls_time 4') - .outputOption('-hls_list_size 0') - .outputOption('-hls_playlist_type vod') - .outputOption('-hls_segment_filename ' + videoPath) - .outputOption('-hls_segment_type fmp4') - .outputOption('-f hls') - .outputOption('-hls_flags single_file') + addCommonHLSVODCommandOptions(command, videoPath) + + return command +} + +function buildHLSVODFromTSCommand (command: FfmpegCommand, options: HLSFromTSTranscodeOptions) { + const videoPath = getHLSVideoPath(options) + + command.outputOption('-c copy') + + 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) return command } async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) { - if (options.type !== 'hls') return + if (options.type !== 'hls' && options.type !== 'hls-from-ts') return const fileContent = await readFile(options.outputPath) @@ -508,7 +508,7 @@ async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) { await writeFile(options.outputPath, newContent) } -function getHLSVideoPath (options: HLSTranscodeOptions) { +function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) { return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}` } @@ -516,35 +516,49 @@ function getHLSVideoPath (options: HLSTranscodeOptions) { // Transcoding presets // --------------------------------------------------------------------------- -async function getEncoderBuilderResult (options: { - streamType: string +// 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: EncoderOptionsBuilderParams & { + streamType: 'video' | 'audio' input: string availableEncoders: AvailableEncoders 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: 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, lTags()) + continue + } - const builderProfiles: EncoderProfile = availableEncoders[videoType][encoder] + if (!encoders[encoder]) { + logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder, lTags()) + continue + } + + // 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) + 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, lTags()) + continue + } } - const result = await builder({ input, resolution: resolution, fps, streamNum }) + const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ])) return { result, @@ -559,24 +573,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 = [ 'AUDIO', 'VIDEO' ] + let streamsToProcess: StreamType[] = [ 'audio', 'video' ] if (!parsedAudio.audioStream) { localCommand = localCommand.noAudio() - streamsToProcess = [ 'VIDEO' ] + streamsToProcess = [ 'video' ] } for (const streamType of streamsToProcess) { @@ -589,6 +612,8 @@ async function presetVideo ( availableEncoders, profile, fps, + inputBitrate: bitrate, + inputRatio: ratio, videoType: 'vod' as 'vod' }) @@ -596,66 +621,161 @@ 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, resolution, fps, ...lTags() } + ) - 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 }) } 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 // --------------------------------------------------------------------------- -function getFFmpeg (input: string) { +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 + : CONFIG.TRANSCODING.THREADS - if (CONFIG.TRANSCODING.THREADS > 0) { + if (threads > 0) { // If we don't set any threads ffmpeg will chose automatically - command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) + command.outputOption('-threads ' + threads) } 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: 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) => { - if (onEnd) onEnd() + if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr, shellCommand, ...lTags() }) - 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, shellCommand, ...lTags() }) 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, ...lTags() })) + }) + } + command.run() }) } + +// Avoid "height not divisible by 2" error +function getScaleCleanerValue () { + return 'trunc(iw/2)*2:trunc(ih/2)*2' +} + +// --------------------------------------------------------------------------- + +export { + getLiveTranscodingCommand, + getLiveMuxingCommand, + buildStreamSuffix, + convertWebPToJPG, + processGIF, + generateImageFromVideoFile, + TranscodeOptions, + TranscodeOptionsType, + transcode, + runCommand, + getFFmpegVersion, + + resetSupportedEncoders, + + // builders + buildx264VODCommand +}