X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fhelpers%2Fffmpeg-utils.ts;h=2fdf34cb7d6918245a95dc9752dea4c5244ce3a8;hb=1600235a2f4e30c5d4e7d4342d1c299845decc60;hp=037bf703a4bfae96ebfecd28986bd64e575f2b63;hpb=28e51e831bd121f063600a597d7b02f8fd846de9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/helpers/ffmpeg-utils.ts b/server/helpers/ffmpeg-utils.ts index 037bf703a..2fdf34cb7 100644 --- a/server/helpers/ffmpeg-utils.ts +++ b/server/helpers/ffmpeg-utils.ts @@ -1,11 +1,12 @@ import * as ffmpeg from 'fluent-ffmpeg' -import { join } from 'path' -import { VideoResolution, getTargetBitrate } from '../../shared/models/videos' -import { CONFIG, FFMPEG_NICE, VIDEO_TRANSCODING_FPS } from '../initializers' +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 { checkFFmpegEncoders } from '../initializers/checker-before-init' -import { remove } from 'fs-extra' +import { readFile, remove, writeFile } from 'fs-extra' +import { CONFIG } from '../initializers/config' function computeResolutionsToTranscode (videoFileHeight: number) { const resolutionsEnabled: number[] = [] @@ -29,19 +30,28 @@ function computeResolutionsToTranscode (videoFileHeight: number) { 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 videoStream = await getVideoFileStream(path) + const size = await getVideoFileSize(path) return { - videoFileResolution: Math.min(videoStream.height, videoStream.width), - isPortraitMode: videoStream.height > videoStream.width + videoFileResolution: Math.min(size.height, size.width), + isPortraitMode: size.height > size.width } } async function getVideoFileFPS (path: string) { - const videoStream = await getVideoFileStream(path) + const videoStream = await getVideoStreamFromFile(path) - for (const key of [ 'r_frame_rate' , 'avg_frame_rate' ]) { + for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) { const valuesText: string = videoStream[key] if (!valuesText) continue @@ -95,7 +105,7 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima }) const destination = join(folder, imageName) - await processImage({ path: pendingImagePath }, destination, size) + await processImage(pendingImagePath, destination, size) } catch (err) { logger.error('Cannot generate image from video %s.', fromPath, { err }) @@ -110,58 +120,88 @@ async function generateImageFromVideoFile (fromPath: string, folder: string, ima type TranscodeOptions = { inputPath: string outputPath: string - resolution?: VideoResolution + resolution: VideoResolution isPortraitMode?: boolean + doQuickTranscode?: Boolean + + hlsPlaylist?: { + videoFilename: string + } } function transcode (options: TranscodeOptions) { return new Promise(async (res, rej) => { - let fps = await getVideoFileFPS(options.inputPath) - // On small/medium resolutions, limit FPS - if ( - options.resolution !== undefined && - options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN && - fps > VIDEO_TRANSCODING_FPS.AVERAGE - ) { - fps = VIDEO_TRANSCODING_FPS.AVERAGE - } - - let command = ffmpeg(options.inputPath, { niceness: FFMPEG_NICE.TRANSCODING }) - .output(options.outputPath) - command = await presetH264(command, options.resolution, fps) + try { + let command = ffmpeg(options.inputPath, { niceness: FFMPEG_NICE.TRANSCODING }) + .output(options.outputPath) - if (CONFIG.TRANSCODING.THREADS > 0) { - // if we don't set any threads ffmpeg will chose automatically - command = command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) - } + if (options.doQuickTranscode) { + if (options.hlsPlaylist) { + throw(Error("Quick transcode and HLS can't be used at the same time")) + } - if (options.resolution !== undefined) { - // '?x720' or '720x?' for example - const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}` - command = command.size(size) - } + command + .format('mp4') + .addOption('-c:v copy') + .addOption('-c:a copy') + .outputOption('-map_metadata -1') // strip all metadata + .outputOption('-movflags faststart') + } else if (options.hlsPlaylist) { + command = await buildHLSCommand(command, options) + } else { + command = await buildx264Command(command, options) + } - if (fps) { - // Hard FPS limits - if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = VIDEO_TRANSCODING_FPS.MAX - else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN + if (CONFIG.TRANSCODING.THREADS > 0) { + // if we don't set any threads ffmpeg will chose automatically + command = command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS) + } - command = command.withFPS(fps) + command + .on('error', (err, stdout, stderr) => { + logger.error('Error in transcoding job.', { stdout, stderr }) + return rej(err) + }) + .on('end', () => { + return onTranscodingSuccess(options) + .then(() => res()) + .catch(err => rej(err)) + }) + .run() + } catch (err) { + return rej(err) } - - command - .on('error', (err, stdout, stderr) => { - logger.error('Error in transcoding job.', { stdout, stderr }) - return rej(err) - }) - .on('end', res) - .run() }) } +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 (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 + } + + return true +} + // --------------------------------------------------------------------------- export { + getVideoFileSize, getVideoFileResolution, getDurationFromVideoFile, generateImageFromVideoFile, @@ -169,18 +209,84 @@ export { getVideoFileFPS, computeResolutionsToTranscode, audio, - getVideoFileBitrate + getVideoFileBitrate, + canDoQuickTranscode } // --------------------------------------------------------------------------- -function getVideoFileStream (path: string) { +async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) { + let fps = await getVideoFileFPS(options.inputPath) + // On small/medium resolutions, limit FPS + if ( + options.resolution !== undefined && + options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN && + fps > VIDEO_TRANSCODING_FPS.AVERAGE + ) { + fps = VIDEO_TRANSCODING_FPS.AVERAGE + } + + command = await presetH264(command, options.resolution, fps) + + if (options.resolution !== undefined) { + // '?x720' or '720x?' for example + const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}` + command = command.size(size) + } + + if (fps) { + // Hard FPS limits + if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = VIDEO_TRANSCODING_FPS.MAX + else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN + + command = command.withFPS(fps) + } + + return command +} + +async function buildHLSCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) { + const videoPath = getHLSVideoPath(options) + + command = await presetCopy(command) + + 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') + + return command +} + +function getHLSVideoPath (options: TranscodeOptions) { + return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}` +} + +async function onTranscodingSuccess (options: TranscodeOptions) { + if (!options.hlsPlaylist) return + + // Fix wrong mapping with some ffmpeg versions + const fileContent = await readFile(options.outputPath) + + const videoFileName = options.hlsPlaylist.videoFilename + const videoFilePath = getHLSVideoPath(options) + + const newContent = fileContent.toString() + .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`) + + 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) throw new Error('Cannot find video stream of ' + path) + if (!videoStream) return rej(new Error('Cannot find video stream of ' + path)) return res(videoStream) }) @@ -194,11 +300,10 @@ function getVideoFileStream (path: string) { * and quality. Superfast and ultrafast will give you better * performance, but then quality is noticeably worse. */ -async function presetH264VeryFast (ffmpeg: ffmpeg, resolution: VideoResolution, fps: number): ffmpeg { - const localFfmpeg = await presetH264(ffmpeg, resolution, fps) - localFfmpeg - .outputOption('-preset:v veryfast') - .outputOption(['--aq-mode=2', '--aq-strength=1.3']) +async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, resolution: VideoResolution, fps: number): Promise { + let localCommand = await presetH264(command, resolution, fps) + localCommand = localCommand.outputOption('-preset:v veryfast') + .outputOption([ '--aq-mode=2', '--aq-strength=1.3' ]) /* MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html Our target situation is closer to a livestream than a stream, @@ -210,31 +315,39 @@ async function presetH264VeryFast (ffmpeg: ffmpeg, resolution: VideoResolution, Make up for most of the loss of grain and macroblocking with less computing power. */ + + return localCommand } /** * A preset optimised for a stillimage audio video */ -async function presetStillImageWithAudio (ffmpeg: ffmpeg, resolution: VideoResolution, fps: number): ffmpeg { - const localFfmpeg = await presetH264VeryFast(ffmpeg, resolution, fps) - localFfmpeg - .outputOption('-tune stillimage') +async function presetStillImageWithAudio ( + command: ffmpeg.FfmpegCommand, + resolution: VideoResolution, + fps: number +): Promise { + let localCommand = await presetH264VeryFast(command, resolution, fps) + localCommand = localCommand.outputOption('-tune stillimage') + + return localCommand } /** * A toolbox to play with audio */ namespace audio { - export const get = (_ffmpeg, pos: number | string = 0) => { + export const get = (option: ffmpeg.FfmpegCommand | 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) => { - _ffmpeg.ffprobe(pos, (err,data) => { + + 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') + const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio') if (audioStream) { return res({ absolutePath: data.format.filename, @@ -242,8 +355,15 @@ namespace audio { }) } } + return res({ absolutePath: data.format.filename }) - }) + } + + if (typeof option === 'string') { + return ffmpeg.ffprobe(option, parseFfprobe) + } + + return option.ffprobe(parseFfprobe) }) } @@ -285,50 +405,55 @@ namespace audio { * As for the audio, quality '5' is the highest and ensures 96-112kbps/channel * See https://trac.ffmpeg.org/wiki/Encode/AAC#fdk_vbr */ -async function presetH264 (ffmpeg: ffmpeg, resolution: VideoResolution, fps: number): ffmpeg { - let localFfmpeg = ffmpeg +async function presetH264 (command: ffmpeg.FfmpegCommand, resolution: VideoResolution, fps: number): Promise { + 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 _audio = await audio.get(localFfmpeg) - if (!_audio.audioStream) { - return localFfmpeg.noAudio() - } + const parsedAudio = await audio.get(localCommand) - // we favor VBR, if a good AAC encoder is available - if ((await checkFFmpegEncoders()).get('libfdk_aac')) { - return localFfmpeg + if (!parsedAudio.audioStream) { + localCommand = localCommand.noAudio() + } else if ((await checkFFmpegEncoders()).get('libfdk_aac')) { // we favor VBR, if a good AAC encoder is available + localCommand = localCommand .audioCodec('libfdk_aac') .audioQuality(5) + } else { + // we try to reduce the ceiling bitrate by making rough correspondances of bitrates + // of course this is far from perfect, but it might save some space in the end + const audioCodecName = parsedAudio.audioStream[ 'codec_name' ] + let bitrate: number + if (audio.bitrate[ audioCodecName ]) { + localCommand = localCommand.audioCodec('aac') + + bitrate = audio.bitrate[ audioCodecName ](parsedAudio.audioStream[ 'bit_rate' ]) + if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate) + } } - // we try to reduce the ceiling bitrate by making rough correspondances of bitrates - // of course this is far from perfect, but it might save some space in the end - const audioCodecName = _audio.audioStream['codec_name'] - let bitrate: number - if (audio.bitrate[audioCodecName]) { - bitrate = audio.bitrate[audioCodecName](_audio.audioStream['bit_rate']) - - if (bitrate === -1) return localFfmpeg.audioCodec('copy') - } - - if (bitrate !== undefined) return localFfmpeg.audioBitrate(bitrate) - // Constrained Encoding (VBV) // https://slhck.info/video/2017/03/01/rate-control.html // https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS) - localFfmpeg = localFfmpeg.outputOptions([`-maxrate ${ targetBitrate }`, `-bufsize ${ targetBitrate * 2 }`]) + localCommand = localCommand.outputOptions([`-maxrate ${ targetBitrate }`, `-bufsize ${ targetBitrate * 2 }`]) // 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 - localFfmpeg = localFfmpeg.outputOption(`-g ${ fps * 2 }`) + localCommand = localCommand.outputOption(`-g ${ fps * 2 }`) - return localFfmpeg + return localCommand +} + +async function presetCopy (command: ffmpeg.FfmpegCommand): Promise { + return command + .format('mp4') + .videoCodec('copy') + .audioCodec('copy') }