X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=62002596664441c7f244311853119b2aee13f767;hb=db8b2f56c014a3fa207501f74e0bb5088ea41719;hp=7c997877cff112a07d4caad0b3cc06d771637164;hpb=ce4a50b99b6aa9f0a6c4ff1023b36bd47ebe8f71;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 7c997877c..620025966 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,10 +1,11 @@ +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, EncoderProfile, VideoResolution } from '../../shared/models/videos' import { CONFIG } from '../initializers/config' +import { promisify0 } from './core-utils' import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils' import { processImage } from './image-utils' import { logger } from './logger' @@ -20,34 +21,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) + } + } + } -// All our encoders + supportedEncoders = new Map() -export interface EncoderProfile { - [ profile: string ]: T + for (const searchEncoder of searchEncoders) { + supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) + } + + 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 +66,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 +77,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 }) { @@ -110,7 +121,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 @@ -124,6 +135,8 @@ interface BaseTranscodeOptions { resolution: VideoResolution isPortraitMode?: boolean + + job?: Job } interface HLSTranscodeOptions extends BaseTranscodeOptions { @@ -134,6 +147,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' } @@ -153,6 +176,7 @@ interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions { type TranscodeOptions = HLSTranscodeOptions + | HLSFromTSTranscodeOptions | VideoTranscodeOptions | MergeAudioTranscodeOptions | OnlyAudioTranscodeOptions @@ -163,6 +187,7 @@ const builders: { } = { 'quick-transcode': buildQuickTranscodeCommand, 'hls': buildHLSVODCommand, + 'hls-from-ts': buildHLSVODFromTSCommand, 'merge-audio': buildAudioMergeCommand, 'only-audio': buildOnlyAudioCommand, 'video': buildx264VODCommand @@ -171,12 +196,12 @@ const builders: { async function transcode (options: TranscodeOptions) { logger.debug('Will run transcode.', { options }) - 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) } @@ -190,16 +215,14 @@ async function getLiveTranscodingCommand (options: { outPath: string resolutions: number[] fps: number - deleteSegments: boolean availableEncoders: AvailableEncoders profile: string }) { - const { rtmpUrl, outPath, resolutions, fps, deleteSegments, availableEncoders, profile } = options + const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options const input = rtmpUrl - const command = getFFmpeg(input) - command.inputOption('-fflags nobuffer') + const command = getFFmpeg(input, 'live') const varStreamMap: string[] = [] @@ -220,6 +243,7 @@ async function getLiveTranscodingCommand (options: { ]) command.outputOption('-preset superfast') + command.outputOption('-sc_threshold 0') addDefaultEncoderGlobalParams({ command }) @@ -229,8 +253,10 @@ async function getLiveTranscodingCommand (options: { const baseEncoderBuilderParams = { input, + availableEncoders, profile, + fps: resolutionFPS, resolution, streamNum: i, @@ -238,7 +264,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') } @@ -247,14 +274,15 @@ 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) } { - 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') } @@ -263,7 +291,7 @@ 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) @@ -272,52 +300,26 @@ async function getLiveTranscodingCommand (options: { varStreamMap.push(`v:${i},a:${i}`) } - addDefaultLiveHLSParams(command, outPath, deleteSegments) + addDefaultLiveHLSParams(command, outPath) 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 (rtmpUrl: string, outPath: string) { + const command = getFFmpeg(rtmpUrl, '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) 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}` @@ -326,23 +328,6 @@ function buildStreamSuffix (base: string, streamNum?: number) { return base } -// --------------------------------------------------------------------------- - -export { - getLiveTranscodingCommand, - getLiveMuxingCommand, - buildStreamSuffix, - convertWebPToJPG, - processGIF, - generateImageFromVideoFile, - TranscodeOptions, - TranscodeOptionsType, - transcode, - hlsPlaylistToFragmentedMP4 -} - -// --------------------------------------------------------------------------- - // --------------------------------------------------------------------------- // Default options // --------------------------------------------------------------------------- @@ -385,14 +370,10 @@ function addDefaultEncoderParams (options: { } } -function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) { +function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: 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(`-f hls`) @@ -452,6 +433,16 @@ function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { return command } +function addCommonHLSVODCommandOptions (command: ffmpeg.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: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { const videoPath = getHLSVideoPath(options) @@ -459,19 +450,29 @@ async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTr 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 +} + +async function buildHLSVODFromTSCommand (command: ffmpeg.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) @@ -485,7 +486,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}` } @@ -493,8 +494,11 @@ function getHLSVideoPath (options: HLSTranscodeOptions) { // 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 @@ -508,17 +512,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 }) @@ -551,11 +570,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) { @@ -575,11 +594,14 @@ 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') { + } else if (streamType === 'audio') { localCommand.audioCodec(builderResult.encoder) } @@ -608,33 +630,74 @@ function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { // 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 + }) - if (CONFIG.TRANSCODING.THREADS > 0) { + const threads = type === 'live' + ? CONFIG.LIVE.TRANSCODING.THREADS + : CONFIG.TRANSCODING.THREADS + + 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) { +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, + + resetSupportedEncoders, + + // builders + buildx264VODCommand +}