X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=df3926658d54594b60056936e6a75717c9e9889c;hb=daf6e4801052d3ca6be2fafd20bae2323b1ce175;hp=c0e9702a8511f66665b977d3777d7f4808a02b56;hpb=f6e0de3f48993b2c0ef9bd2c24d2d7443acc6ace;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index c0e9702a8..df3926658 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,90 +1,13 @@ import * as ffmpeg from 'fluent-ffmpeg' +import { readFile, remove, writeFile } from 'fs-extra' import { dirname, join } from 'path' -import { getTargetBitrate, getMaxBitrate, VideoResolution } from '../../shared/models/videos' -import { FFMPEG_NICE, VIDEO_TRANSCODING_FPS } from '../initializers/constants' -import { processImage } from './image-utils' -import { logger } from './logger' +import { getTargetBitrate, VideoResolution } from '../../shared/models/videos' import { checkFFmpegEncoders } from '../initializers/checker-before-init' -import { readFile, remove, writeFile } from 'fs-extra' import { CONFIG } from '../initializers/config' - -function computeResolutionsToTranscode (videoFileHeight: number) { - const resolutionsEnabled: number[] = [] - const configResolutions = CONFIG.TRANSCODING.RESOLUTIONS - - // Put in the order we want to proceed jobs - const resolutions = [ - VideoResolution.H_480P, - VideoResolution.H_360P, - VideoResolution.H_720P, - VideoResolution.H_240P, - VideoResolution.H_1080P, - VideoResolution.H_4K - ] - - for (const resolution of resolutions) { - if (configResolutions[ resolution + 'p' ] === true && videoFileHeight > resolution) { - resolutionsEnabled.push(resolution) - } - } - - return resolutionsEnabled -} - -async function getVideoFileSize (path: string) { - const videoStream = await getVideoStreamFromFile(path) - - return { - width: videoStream.width, - height: videoStream.height - } -} - -async function getVideoFileResolution (path: string) { - const size = await getVideoFileSize(path) - - return { - videoFileResolution: Math.min(size.height, size.width), - isPortraitMode: size.height > size.width - } -} - -async function getVideoFileFPS (path: string) { - const videoStream = await getVideoStreamFromFile(path) - - for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) { - const valuesText: string = videoStream[key] - if (!valuesText) continue - - const [ frames, seconds ] = valuesText.split('/') - if (!frames || !seconds) continue - - const result = parseInt(frames, 10) / parseInt(seconds, 10) - if (result > 0) return Math.round(result) - } - - return 0 -} - -async function getVideoFileBitrate (path: string) { - return new Promise((res, rej) => { - ffmpeg.ffprobe(path, (err, metadata) => { - if (err) return rej(err) - - return res(metadata.format.bit_rate) - }) - }) -} - -function getDurationFromVideoFile (path: string) { - return new Promise((res, rej) => { - ffmpeg.ffprobe(path, (err, metadata) => { - if (err) return rej(err) - - return res(Math.floor(metadata.format.duration)) - }) - }) -} +import { FFMPEG_NICE, VIDEO_LIVE, VIDEO_TRANSCODING_FPS } from '../initializers/constants' +import { getAudioStream, getClosestFramerateStandard, getMaxAudioBitrate, getVideoFileFPS } from './ffprobe-utils' +import { processImage } from './image-utils' +import { logger } from './logger' async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { const pendingImageName = 'pending-' + imageName @@ -118,7 +41,11 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima } } -type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' +// --------------------------------------------------------------------------- +// Transcode meta function +// --------------------------------------------------------------------------- + +type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio' interface BaseTranscodeOptions { type: TranscodeOptionsType @@ -130,6 +57,7 @@ interface BaseTranscodeOptions { interface HLSTranscodeOptions extends BaseTranscodeOptions { type: 'hls' + copyCodecs: boolean hlsPlaylist: { videoFilename: string } @@ -148,99 +76,253 @@ interface MergeAudioTranscodeOptions extends BaseTranscodeOptions { audioPath: string } -type TranscodeOptions = HLSTranscodeOptions | VideoTranscodeOptions | MergeAudioTranscodeOptions | QuickTranscodeOptions +interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions { + type: 'only-audio' +} + +type TranscodeOptions = + HLSTranscodeOptions + | VideoTranscodeOptions + | MergeAudioTranscodeOptions + | OnlyAudioTranscodeOptions + | QuickTranscodeOptions + +const builders: { + [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise | ffmpeg.FfmpegCommand +} = { + 'quick-transcode': buildQuickTranscodeCommand, + 'hls': buildHLSVODCommand, + 'merge-audio': buildAudioMergeCommand, + 'only-audio': buildOnlyAudioCommand, + 'video': buildx264Command +} + +async function transcode (options: TranscodeOptions) { + logger.debug('Will run transcode.', { options }) -function transcode (options: TranscodeOptions) { + let command = getFFmpeg(options.inputPath) + .output(options.outputPath) + + command = await builders[options.type](command, options) + + await runCommand(command) + + await fixHLSPlaylistIfNeeded(options) +} + +function convertWebPToJPG (path: string, destination: string): Promise { return new Promise(async (res, rej) => { try { - let command = ffmpeg(options.inputPath, { niceness: FFMPEG_NICE.TRANSCODING }) - .output(options.outputPath) - - if (options.type === 'quick-transcode') { - command = await buildQuickTranscodeCommand(command) - } else if (options.type === 'hls') { - command = await buildHLSCommand(command, options) - } else if (options.type === 'merge-audio') { - command = await buildAudioMergeCommand(command, options) - } else { - command = await buildx264Command(command, options) - } - - if (CONFIG.TRANSCODING.THREADS > 0) { - // if we don't set any threads ffmpeg will chose automatically - command = command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) - } - - command - .on('error', (err, stdout, stderr) => { - logger.error('Error in transcoding job.', { stdout, stderr }) - return rej(err) - }) - .on('end', () => { - return fixHLSPlaylistIfNeeded(options) - .then(() => res()) - .catch(err => rej(err)) - }) - .run() + const command = ffmpeg(path).output(destination) + + command.on('error', (err, stdout, stderr) => { + logger.error('Error in ffmpeg webp convert process.', { stdout, stderr }) + return rej(err) + }) + .on('end', () => res()) + .run() } catch (err) { return rej(err) } }) } -async function canDoQuickTranscode (path: string): Promise { - // NOTE: This could be optimized by running ffprobe only once (but it runs fast anyway) - const videoStream = await getVideoStreamFromFile(path) - const parsedAudio = await audio.get(path) - const fps = await getVideoFileFPS(path) - const bitRate = await getVideoFileBitrate(path) - const resolution = await getVideoFileResolution(path) - - // check video params - if (videoStream[ 'codec_name' ] !== 'h264') return false - if (videoStream[ 'pix_fmt' ] !== 'yuv420p') return false - if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) return false - if (bitRate > getMaxBitrate(resolution.videoFileResolution, fps, VIDEO_TRANSCODING_FPS)) return false - - // check audio params (if audio stream exists) - if (parsedAudio.audioStream) { - if (parsedAudio.audioStream[ 'codec_name' ] !== 'aac') return false - - const maxAudioBitrate = audio.bitrate[ 'aac' ](parsedAudio.audioStream[ 'bit_rate' ]) - if (maxAudioBitrate !== -1 && parsedAudio.audioStream[ 'bit_rate' ] > maxAudioBitrate) return false +function processGIF ( + path: string, + destination: string, + newSize: { width: number, height: number }, + keepOriginal = false +): 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) + + 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) + } + }) +} + +function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: number[], fps, deleteSegments: boolean) { + const command = getFFmpeg(rtmpUrl) + command.inputOption('-fflags nobuffer') + + const varStreamMap: string[] = [] + + command.complexFilter([ + { + 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('-b_strategy 1') + command.outputOption('-bf 16') + command.outputOption('-preset superfast') + command.outputOption('-level 3.1') + command.outputOption('-map_metadata -1') + command.outputOption('-pix_fmt yuv420p') + command.outputOption('-max_muxing_queue_size 1024') + command.outputOption('-g ' + (fps * 2)) + + for (let i = 0; i < resolutions.length; i++) { + const resolution = resolutions[i] + + command.outputOption(`-map [vout${resolution}]`) + command.outputOption(`-c:v:${i} libx264`) + command.outputOption(`-b:v:${i} ${getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)}`) + + command.outputOption(`-map a:0`) + command.outputOption(`-c:a:${i} aac`) + + varStreamMap.push(`v:${i},a:${i}`) + } + + addDefaultLiveHLSParams(command, outPath, deleteSegments) + + command.outputOption('-var_stream_map', varStreamMap.join(' ')) + + command.run() + + return command +} + +function runLiveMuxing (rtmpUrl: string, outPath: string, deleteSegments: boolean) { + const command = getFFmpeg(rtmpUrl) + command.inputOption('-fflags nobuffer') + + command.outputOption('-c:v copy') + command.outputOption('-c:a copy') + command.outputOption('-map 0:a?') + command.outputOption('-map 0:v?') + + addDefaultLiveHLSParams(command, outPath, deleteSegments) + + command.run() + + 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 })) } - return true + // 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) +} + +async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) { + return new Promise((res, rej) => { + command.on('error', (err, stdout, stderr) => { + if (onEnd) onEnd() + + logger.error('Error in transcoding job.', { stdout, stderr }) + rej(err) + }) + + command.on('end', () => { + if (onEnd) onEnd() + + res() + }) + + command.run() + }) } // --------------------------------------------------------------------------- export { - getVideoFileSize, - getVideoFileResolution, - getDurationFromVideoFile, + runLiveMuxing, + convertWebPToJPG, + processGIF, + runLiveTranscoding, generateImageFromVideoFile, TranscodeOptions, TranscodeOptionsType, transcode, - getVideoFileFPS, - computeResolutionsToTranscode, - audio, - getVideoFileBitrate, - canDoQuickTranscode + hlsPlaylistToFragmentedMP4 } // --------------------------------------------------------------------------- -async function buildx264Command (command: ffmpeg.FfmpegCommand, options: VideoTranscodeOptions) { +function addDefaultX264Params (command: ffmpeg.FfmpegCommand) { + command.outputOption('-level 3.1') // 3.1 is the minimal resource allocation for our highest supported resolution + .outputOption('-b_strategy 1') // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it + .outputOption('-bf 16') // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16 + .outputOption('-pix_fmt yuv420p') // allows import of source material with incompatible pixel formats (e.g. MJPEG video) + .outputOption('-map_metadata -1') // strip all metadata +} + +function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) { + 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_segment_filename ${join(outPath, '%v-%06d.ts')}`) + command.outputOption('-master_pl_name master.m3u8') + command.outputOption(`-f hls`) + + command.output(join(outPath, '%v.m3u8')) +} + +async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) { let fps = await getVideoFileFPS(options.inputPath) - // On small/medium resolutions, limit FPS 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 ) { - 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') } command = await presetH264(command, options.inputPath, options.resolution, fps) @@ -253,7 +335,7 @@ async function buildx264Command (command: ffmpeg.FfmpegCommand, options: VideoTr if (fps) { // Hard FPS limits - if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = VIDEO_TRANSCODING_FPS.MAX + 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) @@ -275,8 +357,14 @@ async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: M return command } -async function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { - command = await presetCopy(command) +function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) { + command = presetOnlyAudio(command) + + return command +} + +function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { + command = presetCopy(command) command = command.outputOption('-map_metadata -1') // strip all metadata .outputOption('-movflags faststart') @@ -284,10 +372,12 @@ async function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { return command } -async function buildHLSCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { +async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { const videoPath = getHLSVideoPath(options) - command = await presetCopy(command) + if (options.copyCodecs) command = presetCopy(command) + else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command) + else command = await buildx264Command(command, options) command = command.outputOption('-hls_time 4') .outputOption('-hls_list_size 0') @@ -319,19 +409,6 @@ async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) { await writeFile(options.outputPath, newContent) } -function getVideoStreamFromFile (path: string) { - return new Promise((res, rej) => { - ffmpeg.ffprobe(path, (err, metadata) => { - if (err) return rej(err) - - const videoStream = metadata.streams.find(s => s.codec_type === 'video') - if (!videoStream) return rej(new Error('Cannot find video stream of ' + path)) - - return res(videoStream) - }) - }) -} - /** * A slightly customised version of the 'veryfast' x264 preset * @@ -355,71 +432,6 @@ async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, input: string, return localCommand } -/** - * A toolbox to play with audio - */ -namespace audio { - export const get = (option: string) => { - // without position, ffprobe considers the last input only - // we make it consider the first input only - // if you pass a file path to pos, then ffprobe acts on that file directly - return new Promise<{ absolutePath: string, audioStream?: any }>((res, rej) => { - - function parseFfprobe (err: any, data: ffmpeg.FfprobeData) { - if (err) return rej(err) - - if ('streams' in data) { - const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio') - if (audioStream) { - return res({ - absolutePath: data.format.filename, - audioStream - }) - } - } - - return res({ absolutePath: data.format.filename }) - } - - return ffmpeg.ffprobe(option, parseFfprobe) - }) - } - - export namespace bitrate { - const baseKbitrate = 384 - - const toBits = (kbits: number) => kbits * 8000 - - export const aac = (bitrate: number): number => { - switch (true) { - case bitrate > toBits(baseKbitrate): - return baseKbitrate - - default: - return -1 // we interpret it as a signal to copy the audio stream as is - } - } - - export const mp3 = (bitrate: number): number => { - /* - a 192kbit/sec mp3 doesn't hold as much information as a 192kbit/sec aac. - That's why, when using aac, we can go to lower kbit/sec. The equivalences - made here are not made to be accurate, especially with good mp3 encoders. - */ - switch (true) { - case bitrate <= toBits(192): - return 128 - - case bitrate <= toBits(384): - return 256 - - default: - return baseKbitrate - } - } - } -} - /** * Standard profile, with variable bitrate audio and faststart. * @@ -430,14 +442,11 @@ async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolut let localCommand = command .format('mp4') .videoCodec('libx264') - .outputOption('-level 3.1') // 3.1 is the minimal ressource allocation for our highest supported resolution - .outputOption('-b_strategy 1') // NOTE: b-strategy 1 - heuristic algorythm, 16 is optimal B-frames for it - .outputOption('-bf 16') // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16 - .outputOption('-pix_fmt yuv420p') // allows import of source material with incompatible pixel formats (e.g. MJPEG video) - .outputOption('-map_metadata -1') // strip all metadata .outputOption('-movflags faststart') - const parsedAudio = await audio.get(input) + addDefaultX264Params(localCommand) + + const parsedAudio = await getAudioStream(input) if (!parsedAudio.audioStream) { localCommand = localCommand.noAudio() @@ -450,12 +459,11 @@ async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolut // of course this is far from perfect, but it might save some space in the end localCommand = localCommand.audioCodec('aac') - const audioCodecName = parsedAudio.audioStream[ 'codec_name' ] + const audioCodecName = parsedAudio.audioStream['codec_name'] - if (audio.bitrate[ audioCodecName ]) { - const bitrate = audio.bitrate[ audioCodecName ](parsedAudio.audioStream[ 'bit_rate' ]) - if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate) - } + const bitrate = getMaxAudioBitrate(audioCodecName, parsedAudio.bitrate) + + if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate) } if (fps) { @@ -474,9 +482,28 @@ async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolut return localCommand } -async function presetCopy (command: ffmpeg.FfmpegCommand): Promise { +function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { return command .format('mp4') .videoCodec('copy') .audioCodec('copy') } + +function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { + return command + .format('mp4') + .audioCodec('copy') + .noVideo() +} + +function getFFmpeg (input: string) { + // 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 }) + + if (CONFIG.TRANSCODING.THREADS > 0) { + // If we don't set any threads ffmpeg will chose automatically + command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) + } + + return command +}