import * as ffmpeg from 'fluent-ffmpeg'
import { readFile, remove, writeFile } from 'fs-extra'
import { dirname, join } from 'path'
-import { getTargetBitrate, VideoResolution } from '../../shared/models/videos'
+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 { CONFIG } from '../initializers/config'
-import { FFMPEG_NICE, VIDEO_LIVE, VIDEO_TRANSCODING_ENCODERS, VIDEO_TRANSCODING_FPS } from '../initializers/constants'
-import { getAudioStream, getClosestFramerateStandard, getVideoFileFPS } from './ffprobe-utils'
+import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
import { processImage } from './image-utils'
import { logger } from './logger'
+/**
+ *
+ * Functions that run transcoding/muxing ffmpeg processes
+ * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
+ *
+ */
+
// ---------------------------------------------------------------------------
// Encoder options
// ---------------------------------------------------------------------------
input: string
resolution: VideoResolution
fps?: number
+ streamNum?: number
}) => Promise<EncoderOptions> | EncoderOptions
// Options types
export interface EncoderOptions {
+ copy?: boolean
outputOptions: string[]
}
export type AvailableEncoders = {
[ id in 'live' | 'vod' ]: {
- [ encoder in 'libx264' | 'aac' | 'libfdkAAC' ]: EncoderProfile<EncoderOptionsBuilder>
+ [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile<EncoderOptionsBuilder>
}
}
function processGIF (
path: string,
destination: string,
- newSize: { width: number, height: number },
- keepOriginal = false
+ newSize: { width: number, height: number }
): Promise<void> {
- return new Promise<void>(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)
+ .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 }) {
// Live muxing/transcoding functions
// ---------------------------------------------------------------------------
-function getLiveTranscodingCommand (rtmpUrl: string, outPath: string, resolutions: number[], fps: number, deleteSegments: boolean) {
- const command = getFFmpeg(rtmpUrl)
+async function getLiveTranscodingCommand (options: {
+ rtmpUrl: string
+ outPath: string
+ resolutions: number[]
+ fps: number
+ deleteSegments: boolean
+
+ availableEncoders: AvailableEncoders
+ profile: string
+}) {
+ const { rtmpUrl, outPath, resolutions, fps, deleteSegments, availableEncoders, profile } = options
+ const input = rtmpUrl
+
+ const command = getFFmpeg(input)
command.inputOption('-fflags nobuffer')
const varStreamMap: string[] = []
}))
])
- addEncoderDefaultParams(command, 'libx264', fps)
-
command.outputOption('-preset superfast')
+ addDefaultEncoderGlobalParams({ command })
+
for (let i = 0; i < resolutions.length; i++) {
const resolution = resolutions[i]
+ const resolutionFPS = computeFPS(fps, resolution)
+
+ const baseEncoderBuilderParams = {
+ input,
+ availableEncoders,
+ profile,
+ fps: resolutionFPS,
+ resolution,
+ streamNum: i,
+ videoType: 'live' as 'live'
+ }
- command.outputOption(`-map [vout${resolution}]`)
- command.outputOption(`-c:v:${i} libx264`)
- command.outputOption(`-b:v:${i} ${getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)}`)
+ {
+ const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' }))
+ if (!builderResult) {
+ throw new Error('No available live video encoder found')
+ }
- command.outputOption(`-map a:0`)
- command.outputOption(`-c:a:${i} aac`)
+ command.outputOption(`-map [vout${resolution}]`)
+
+ addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
+
+ logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult)
+
+ command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
+ command.addOutputOptions(builderResult.result.outputOptions)
+ }
+
+ {
+ const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' }))
+ if (!builderResult) {
+ throw new Error('No available live audio encoder found')
+ }
+
+ command.outputOption('-map a:0')
+
+ addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
+
+ logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult)
+
+ command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
+ command.addOutputOptions(builderResult.result.outputOptions)
+ }
varStreamMap.push(`v:${i},a:${i}`)
}
return runCommand(command, cleaner)
}
+function buildStreamSuffix (base: string, streamNum?: number) {
+ if (streamNum !== undefined) {
+ return `${base}:${streamNum}`
+ }
+
+ return base
+}
+
// ---------------------------------------------------------------------------
export {
getLiveTranscodingCommand,
getLiveMuxingCommand,
+ buildStreamSuffix,
convertWebPToJPG,
processGIF,
generateImageFromVideoFile,
// Default options
// ---------------------------------------------------------------------------
-function addEncoderDefaultParams (command: ffmpeg.FfmpegCommand, encoder: 'libx264' | string, fps?: number) {
- if (encoder !== 'libx264') return
-
- 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
- .outputOption('-max_muxing_queue_size 1024') // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
- // 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
- .outputOption('-g ' + (fps * 2))
+function addDefaultEncoderGlobalParams (options: {
+ command: ffmpeg.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')
+ // 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('-pix_fmt yuv420p')
+}
+
+function addDefaultEncoderParams (options: {
+ command: ffmpeg.FfmpegCommand
+ encoder: 'libx264' | string
+ streamNum?: number
+ fps?: number
+}) {
+ const { command, encoder, fps, streamNum } = options
+
+ if (encoder === 'libx264') {
+ // 3.1 is the minimal resource allocation for our highest supported resolution
+ 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(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
+ }
+ }
}
function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) {
async function buildx264VODCommand (command: ffmpeg.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)
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 = getClosestFramerateStandard(fps, 'HD_STANDARD')
- else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN
+ const size = options.isPortraitMode === true
+ ? `${options.resolution}x?`
+ : `?x${options.resolution}`
- command = command.withFPS(fps)
+ command = command.size(size)
}
return command
command = await presetVideo(command, options.audioPath, options)
- /*
- 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)
// Transcoding presets
// ---------------------------------------------------------------------------
+async function getEncoderBuilderResult (options: {
+ streamType: string
+ 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 encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[streamType]
+
+ for (const encoder of encodersToTry) {
+ if (!(await checkFFmpegEncoders()).get(encoder) || !availableEncoders[videoType][encoder]) continue
+
+ const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = availableEncoders[videoType][encoder]
+ let builder = builderProfiles[profile]
+
+ if (!builder) {
+ logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
+ builder = builderProfiles.default
+ }
+
+ const result = await builder({ input, resolution: resolution, fps, streamNum })
+
+ return {
+ result,
+
+ // If we don't have output options, then copy the input stream
+ encoder: result.copy === true
+ ? 'copy'
+ : encoder
+ }
+ }
+
+ return null
+}
+
async function presetVideo (
command: ffmpeg.FfmpegCommand,
input: string,
.format('mp4')
.outputOption('-movflags faststart')
+ addDefaultEncoderGlobalParams({ command })
+
// Audio encoder
const parsedAudio = await getAudioStream(input)
let streamsToProcess = [ 'AUDIO', 'VIDEO' ]
- const streamsFound = {
- AUDIO: '',
- VIDEO: ''
- }
if (!parsedAudio.audioStream) {
localCommand = localCommand.noAudio()
streamsToProcess = [ 'VIDEO' ]
}
- for (const stream of streamsToProcess) {
- const encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[stream]
-
- for (const encoder of encodersToTry) {
- if (!(await checkFFmpegEncoders()).get(encoder)) continue
-
- const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = transcodeOptions.availableEncoders.vod[encoder]
- let builder = builderProfiles[transcodeOptions.profile]
-
- if (!builder) {
- logger.debug('Profile %s for encoder %s not available. Fallback to default.', transcodeOptions.profile, encoder)
- builder = builderProfiles.default
- }
-
- const builderResult = await builder({ input, resolution: transcodeOptions.resolution, fps })
-
- logger.debug('Apply ffmpeg params from %s.', encoder, builderResult)
+ for (const streamType of streamsToProcess) {
+ const { profile, resolution, availableEncoders } = transcodeOptions
+
+ const builderResult = await getEncoderBuilderResult({
+ streamType,
+ input,
+ resolution,
+ availableEncoders,
+ profile,
+ fps,
+ videoType: 'vod' as 'vod'
+ })
- localCommand.outputOptions(builderResult.outputOptions)
+ if (!builderResult) {
+ throw new Error('No available encoder found for stream ' + streamType)
+ }
- addEncoderDefaultParams(localCommand, encoder)
+ logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult)
- streamsFound[stream] = encoder
- break
+ if (streamType === 'VIDEO') {
+ localCommand.videoCodec(builderResult.encoder)
+ } else if (streamType === 'AUDIO') {
+ localCommand.audioCodec(builderResult.encoder)
}
- if (!streamsFound[stream]) {
- throw new Error('No available encoder found ' + encodersToTry.join(', '))
- }
+ command.addOutputOptions(builderResult.result.outputOptions)
+ addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
}
- localCommand.videoCodec(streamsFound.VIDEO)
-
return localCommand
}
projects / github / Chocobozzz / PeerTube.git / blobdiff