X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=df3926658d54594b60056936e6a75717c9e9889c;hb=daf6e4801052d3ca6be2fafd20bae2323b1ce175;hp=b063cedcb33c7dd013367762d45a7f1497fd10f6;hpb=31c82cd914e13dbf53280d0aad0740d70c414441;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index b063cedcb..df3926658 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,201 +1,13 @@ import * as ffmpeg from 'fluent-ffmpeg' import { readFile, remove, writeFile } from 'fs-extra' import { dirname, join } from 'path' -import { VideoFileMetadata } from '@shared/models/videos/video-file-metadata' -import { getMaxBitrate, getTargetBitrate, VideoResolution } from '../../shared/models/videos' +import { getTargetBitrate, VideoResolution } from '../../shared/models/videos' import { checkFFmpegEncoders } from '../initializers/checker-before-init' import { CONFIG } from '../initializers/config' 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' -import { concat } from 'lodash' - -/** - * A toolbox to play with audio - */ -namespace audio { - export const get = (videoPath: 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(videoPath, 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 - } - } - } -} - -function computeResolutionsToTranscode (videoFileResolution: number, type: 'vod' | 'live') { - const configResolutions = type === 'vod' - ? CONFIG.TRANSCODING.RESOLUTIONS - : CONFIG.LIVE.TRANSCODING.RESOLUTIONS - - const resolutionsEnabled: number[] = [] - - // Put in the order we want to proceed jobs - const resolutions = [ - VideoResolution.H_NOVIDEO, - 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 && videoFileResolution > resolution) { - resolutionsEnabled.push(resolution) - } - } - - return resolutionsEnabled -} - -async function getVideoStreamSize (path: string) { - const videoStream = await getVideoStreamFromFile(path) - - return videoStream === null - ? { width: 0, height: 0 } - : { width: videoStream.width, height: videoStream.height } -} - -async function getVideoStreamCodec (path: string) { - const videoStream = await getVideoStreamFromFile(path) - - if (!videoStream) return '' - - const videoCodec = videoStream.codec_tag_string - - const baseProfileMatrix = { - High: '6400', - Main: '4D40', - Baseline: '42E0' - } - - let baseProfile = baseProfileMatrix[videoStream.profile] - if (!baseProfile) { - logger.warn('Cannot get video profile codec of %s.', path, { videoStream }) - baseProfile = baseProfileMatrix['High'] // Fallback - } - - let level = videoStream.level.toString(16) - if (level.length === 1) level = `0${level}` - - return `${videoCodec}.${baseProfile}${level}` -} - -async function getAudioStreamCodec (path: string) { - const { audioStream } = await audio.get(path) - - if (!audioStream) return '' - - const audioCodec = audioStream.codec_name - if (audioCodec === 'aac') return 'mp4a.40.2' - - logger.warn('Cannot get audio codec of %s.', path, { audioStream }) - - return 'mp4a.40.2' // Fallback -} - -async function getVideoFileResolution (path: string) { - const size = await getVideoStreamSize(path) - - return { - videoFileResolution: Math.min(size.height, size.width), - isPortraitMode: size.height > size.width - } -} - -async function getVideoFileFPS (path: string) { - const videoStream = await getVideoStreamFromFile(path) - if (videoStream === null) return 0 - - 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 getMetadataFromFile (path: string, cb = metadata => metadata) { - return new Promise((res, rej) => { - ffmpeg.ffprobe(path, (err, metadata) => { - if (err) return rej(err) - - return res(cb(new VideoFileMetadata(metadata))) - }) - }) -} - -async function getVideoFileBitrate (path: string) { - return getMetadataFromFile(path, metadata => metadata.format.bit_rate) -} - -function getDurationFromVideoFile (path: string) { - return getMetadataFromFile(path, metadata => Math.floor(metadata.format.duration)) -} - -function getVideoStreamFromFile (path: string) { - return getMetadataFromFile(path, metadata => metadata.streams.find(s => s.codec_type === 'video') || null) -} async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { const pendingImageName = 'pending-' + imageName @@ -229,6 +41,10 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima } } +// --------------------------------------------------------------------------- +// Transcode meta function +// --------------------------------------------------------------------------- + type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio' interface BaseTranscodeOptions { @@ -271,70 +87,27 @@ type TranscodeOptions = | OnlyAudioTranscodeOptions | QuickTranscodeOptions -function transcode (options: TranscodeOptions) { - return new Promise(async (res, rej) => { - try { - let command = getFFmpeg(options.inputPath) - .output(options.outputPath) - - if (options.type === 'quick-transcode') { - command = buildQuickTranscodeCommand(command) - } else if (options.type === 'hls') { - command = await buildHLSVODCommand(command, options) - } else if (options.type === 'merge-audio') { - command = await buildAudioMergeCommand(command, options) - } else if (options.type === 'only-audio') { - command = buildOnlyAudioCommand(command, options) - } else { - command = await buildx264Command(command, options) - } - - 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() - } catch (err) { - return rej(err) - } - }) +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 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 == null) return false - 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 - } +async function transcode (options: TranscodeOptions) { + logger.debug('Will run transcode.', { options }) - return true -} + let command = getFFmpeg(options.inputPath) + .output(options.outputPath) + + command = await builders[options.type](command, options) + + await runCommand(command) -function getClosestFramerateStandard (fps: number, type: 'HD_STANDARD' | 'STANDARD'): number { - return VIDEO_TRANSCODING_FPS[type].slice(0) - .sort((a, b) => fps % a - fps % b)[0] + await fixHLSPlaylistIfNeeded(options) } function convertWebPToJPG (path: string, destination: string): Promise { @@ -354,7 +127,41 @@ function convertWebPToJPG (path: string, destination: string): Promise { }) } -function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: number[], deleteSegments: boolean) { +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') @@ -376,23 +183,21 @@ function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: numb })) ]) - const liveFPS = VIDEO_TRANSCODING_FPS.AVERAGE - - command.withFps(liveFPS) - 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, liveFPS, VIDEO_TRANSCODING_FPS)}`) + command.outputOption(`-b:v:${i} ${getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)}`) command.outputOption(`-map a:0`) command.outputOption(`-c:a:${i} aac`) @@ -426,8 +231,14 @@ function runLiveMuxing (rtmpUrl: string, outPath: string, deleteSegments: boolea } async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: string[], outputPath: string) { - const concatFile = 'concat.txt' - const concatFilePath = join(hlsDirectory, concatFile) + 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') @@ -437,53 +248,44 @@ async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: s command.inputOption('-safe 0') command.inputOption('-f concat') - command.outputOption('-c copy') + command.outputOption('-c:v copy') + command.audioFilter('aresample=async=1:first_pts=0') command.output(outputPath) - command.run() - - function cleaner () { - remove(concatFile) - .catch(err => logger.error('Cannot remove concat file in %s.', hlsDirectory, { err })) - } + return runCommand(command, cleaner) +} +async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) { return new Promise((res, rej) => { - command.on('error', err => { - cleaner() + command.on('error', (err, stdout, stderr) => { + if (onEnd) onEnd() + logger.error('Error in transcoding job.', { stdout, stderr }) rej(err) }) command.on('end', () => { - cleaner() + if (onEnd) onEnd() res() }) + + command.run() }) } // --------------------------------------------------------------------------- export { - getVideoStreamCodec, - getAudioStreamCodec, runLiveMuxing, convertWebPToJPG, - getVideoStreamSize, - getVideoFileResolution, - getMetadataFromFile, - getDurationFromVideoFile, + processGIF, runLiveTranscoding, generateImageFromVideoFile, TranscodeOptions, TranscodeOptionsType, transcode, - getVideoFileFPS, - computeResolutionsToTranscode, - audio, - hlsPlaylistToFragmentedMP4, - getVideoFileBitrate, - canDoQuickTranscode + hlsPlaylistToFragmentedMP4 } // --------------------------------------------------------------------------- @@ -497,14 +299,14 @@ function addDefaultX264Params (command: ffmpeg.FfmpegCommand) { } function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) { - command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME) + 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-%d.ts')}`) + command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`) command.outputOption('-master_pl_name master.m3u8') command.outputOption(`-f hls`) @@ -555,7 +357,7 @@ async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: M return command } -function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, options: OnlyAudioTranscodeOptions) { +function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) { command = presetOnlyAudio(command) return command @@ -644,7 +446,7 @@ async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolut addDefaultX264Params(localCommand) - const parsedAudio = await audio.get(input) + const parsedAudio = await getAudioStream(input) if (!parsedAudio.audioStream) { localCommand = localCommand.noAudio() @@ -659,10 +461,9 @@ async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolut 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) {