-import * as ffmpeg from 'fluent-ffmpeg'
-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 { Job } from 'bull'
+import ffmpeg, { FfmpegCommand, FilterSpecification, getAvailableEncoders } from 'fluent-ffmpeg'
import { readFile, remove, writeFile } from 'fs-extra'
+import { dirname, join } from 'path'
+import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants'
+import { pick } from '@shared/core-utils'
+import {
+ AvailableEncoders,
+ EncoderOptions,
+ EncoderOptionsBuilder,
+ EncoderOptionsBuilderParams,
+ EncoderProfile,
+ VideoResolution
+} from '../../shared/models/videos'
import { CONFIG } from '../initializers/config'
+import { execPromise, promisify0 } from './core-utils'
+import { computeFPS, ffprobePromise, getAudioStream, getVideoFileBitrate, getVideoFileFPS, getVideoFileResolution } from './ffprobe-utils'
+import { processImage } from './image-utils'
+import { logger, loggerTagsFactory } from './logger'
-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_NOVIDEO,
- VideoResolution.H_480P,
- VideoResolution.H_360P,
- VideoResolution.H_720P,
- VideoResolution.H_240P,
- VideoResolution.H_1080P,
- VideoResolution.H_4K
- ]
+const lTags = loggerTagsFactory('ffmpeg')
- for (const resolution of resolutions) {
- if (configResolutions[ resolution + 'p' ] === true && videoFileHeight > resolution) {
- resolutionsEnabled.push(resolution)
- }
- }
+/**
+ *
+ * Functions that run transcoding/muxing ffmpeg processes
+ * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
+ *
+ */
- return resolutionsEnabled
-}
+// ---------------------------------------------------------------------------
+// Encoder options
+// ---------------------------------------------------------------------------
-async function getVideoFileSize (path: string) {
- const videoStream = await getVideoStreamFromFile(path)
+type StreamType = 'audio' | 'video'
- return videoStream == null
- ? {
- width: 0,
- height: 0
- }
- : {
- width: videoStream.width,
- height: videoStream.height
- }
-}
-
-async function getVideoFileResolution (path: string) {
- const size = await getVideoFileSize(path)
+// ---------------------------------------------------------------------------
+// Encoders support
+// ---------------------------------------------------------------------------
- return {
- videoFileResolution: Math.min(size.height, size.width),
- isPortraitMode: size.height > size.width
+// Detect supported encoders by ffmpeg
+let supportedEncoders: Map<string, boolean>
+async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise<Map<string, boolean>> {
+ if (supportedEncoders !== undefined) {
+ return supportedEncoders
}
-}
-async function getVideoFileFPS (path: string) {
- const videoStream = await getVideoStreamFromFile(path)
+ const getAvailableEncodersPromise = promisify0(getAvailableEncoders)
+ const availableFFmpegEncoders = await getAvailableEncodersPromise()
- if (videoStream == null) {
- return 0
+ const searchEncoders = new Set<string>()
+ for (const type of [ 'live', 'vod' ]) {
+ for (const streamType of [ 'audio', 'video' ]) {
+ for (const encoder of peertubeAvailableEncoders.encodersToTry[type][streamType]) {
+ searchEncoders.add(encoder)
+ }
+ }
}
- 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
+ supportedEncoders = new Map<string, boolean>()
- const result = parseInt(frames, 10) / parseInt(seconds, 10)
- if (result > 0) return Math.round(result)
+ for (const searchEncoder of searchEncoders) {
+ supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
}
- return 0
-}
+ logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders, ...lTags() })
-async function getVideoFileBitrate (path: string) {
- return new Promise<number>((res, rej) => {
- ffmpeg.ffprobe(path, (err, metadata) => {
- if (err) return rej(err)
+ return supportedEncoders
+}
- return res(metadata.format.bit_rate)
- })
- })
+function resetSupportedEncoders () {
+ supportedEncoders = undefined
}
-function getDurationFromVideoFile (path: string) {
- return new Promise<number>((res, rej) => {
- ffmpeg.ffprobe(path, (err, metadata) => {
- if (err) return rej(err)
+// ---------------------------------------------------------------------------
+// Image manipulation
+// ---------------------------------------------------------------------------
- return res(Math.floor(metadata.format.duration))
- })
- })
+function convertWebPToJPG (path: string, destination: string): Promise<void> {
+ const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
+ .output(destination)
+
+ return runCommand({ command, silent: true })
+}
+
+function processGIF (
+ path: string,
+ destination: string,
+ newSize: { width: number, height: number }
+): Promise<void> {
+ const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
+ .fps(20)
+ .size(`${newSize.width}x${newSize.height}`)
+ .output(destination)
+
+ return runCommand({ command })
}
async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
const destination = join(folder, imageName)
await processImage(pendingImagePath, destination, size)
} catch (err) {
- logger.error('Cannot generate image from video %s.', fromPath, { err })
+ logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() })
try {
await remove(pendingImagePath)
} catch (err) {
- logger.debug('Cannot remove pending image path after generation error.', { err })
+ logger.debug('Cannot remove pending image path after generation error.', { err, ...lTags() })
}
}
}
-type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'split-audio'
+// ---------------------------------------------------------------------------
+// Transcode meta function
+// ---------------------------------------------------------------------------
+
+type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
interface BaseTranscodeOptions {
type: TranscodeOptionsType
+
inputPath: string
outputPath: string
- resolution: VideoResolution
+
+ availableEncoders: AvailableEncoders
+ profile: string
+
+ resolution: number
+
isPortraitMode?: boolean
+
+ job?: Job
}
interface HLSTranscodeOptions extends BaseTranscodeOptions {
}
}
+interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions {
+ type: 'hls-from-ts'
+
+ isAAC: boolean
+
+ hlsPlaylist: {
+ videoFilename: string
+ }
+}
+
interface QuickTranscodeOptions extends BaseTranscodeOptions {
type: 'quick-transcode'
}
audioPath: string
}
-interface SplitAudioTranscodeOptions extends BaseTranscodeOptions {
- type: 'split-audio'
+interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
+ type: 'only-audio'
+}
+
+type TranscodeOptions =
+ HLSTranscodeOptions
+ | HLSFromTSTranscodeOptions
+ | VideoTranscodeOptions
+ | MergeAudioTranscodeOptions
+ | OnlyAudioTranscodeOptions
+ | QuickTranscodeOptions
+
+const builders: {
+ [ type in TranscodeOptionsType ]: (c: FfmpegCommand, o?: TranscodeOptions) => Promise<FfmpegCommand> | FfmpegCommand
+} = {
+ 'quick-transcode': buildQuickTranscodeCommand,
+ 'hls': buildHLSVODCommand,
+ 'hls-from-ts': buildHLSVODFromTSCommand,
+ 'merge-audio': buildAudioMergeCommand,
+ 'only-audio': buildOnlyAudioCommand,
+ 'video': buildx264VODCommand
}
-type TranscodeOptions = HLSTranscodeOptions | VideoTranscodeOptions | MergeAudioTranscodeOptions | SplitAudioTranscodeOptions | QuickTranscodeOptions
+async function transcode (options: TranscodeOptions) {
+ logger.debug('Will run transcode.', { options, ...lTags() })
-function transcode (options: TranscodeOptions) {
- return new Promise<void>(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 if (options.type === 'split-audio') {
- command = await buildAudioSplitCommand(command, options)
- } else {
- command = await buildx264Command(command, options)
+ let command = getFFmpeg(options.inputPath, 'vod')
+ .output(options.outputPath)
+
+ command = await builders[options.type](command, options)
+
+ await runCommand({ command, job: options.job })
+
+ await fixHLSPlaylistIfNeeded(options)
+}
+
+// ---------------------------------------------------------------------------
+// Live muxing/transcoding functions
+// ---------------------------------------------------------------------------
+
+async function getLiveTranscodingCommand (options: {
+ inputUrl: string
+
+ outPath: string
+ masterPlaylistName: string
+
+ resolutions: number[]
+
+ // Input information
+ fps: number
+ bitrate: number
+ ratio: number
+
+ availableEncoders: AvailableEncoders
+ profile: string
+}) {
+ const { inputUrl, outPath, resolutions, fps, bitrate, availableEncoders, profile, masterPlaylistName, ratio } = options
+
+ const command = getFFmpeg(inputUrl, 'live')
+
+ const varStreamMap: string[] = []
+
+ const complexFilter: FilterSpecification[] = [
+ {
+ inputs: '[v:0]',
+ filter: 'split',
+ options: resolutions.length,
+ outputs: resolutions.map(r => `vtemp${r}`)
+ }
+ ]
+
+ command.outputOption('-sc_threshold 0')
+
+ addDefaultEncoderGlobalParams({ command })
+
+ for (let i = 0; i < resolutions.length; i++) {
+ const resolution = resolutions[i]
+ const resolutionFPS = computeFPS(fps, resolution)
+
+ const baseEncoderBuilderParams = {
+ input: inputUrl,
+
+ availableEncoders,
+ profile,
+
+ inputBitrate: bitrate,
+ inputRatio: ratio,
+
+ resolution,
+ fps: resolutionFPS,
+
+ streamNum: i,
+ videoType: 'live' as 'live'
+ }
+
+ {
+ const streamType: StreamType = 'video'
+ const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType })
+ if (!builderResult) {
+ throw new Error('No available live video encoder found')
}
- if (CONFIG.TRANSCODING.THREADS > 0) {
- // if we don't set any threads ffmpeg will chose automatically
- command = command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)
+ command.outputOption(`-map [vout${resolution}]`)
+
+ addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
+
+ logger.debug(
+ 'Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile,
+ { builderResult, fps: resolutionFPS, resolution, ...lTags() }
+ )
+
+ command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
+ applyEncoderOptions(command, builderResult.result)
+
+ complexFilter.push({
+ inputs: `vtemp${resolution}`,
+ filter: getScaleFilter(builderResult.result),
+ options: `w=-2:h=${resolution}`,
+ outputs: `vout${resolution}`
+ })
+ }
+
+ {
+ const streamType: StreamType = 'audio'
+ const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType })
+ if (!builderResult) {
+ throw new Error('No available live audio encoder found')
}
- 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)
+ command.outputOption('-map a:0')
+
+ addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
+
+ logger.debug(
+ 'Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile,
+ { builderResult, fps: resolutionFPS, resolution, ...lTags() }
+ )
+
+ command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
+ applyEncoderOptions(command, builderResult.result)
}
- })
+
+ varStreamMap.push(`v:${i},a:${i}`)
+ }
+
+ command.complexFilter(complexFilter)
+
+ addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
+
+ command.outputOption('-var_stream_map', varStreamMap.join(' '))
+
+ return command
}
-async function canDoQuickTranscode (path: string): Promise<boolean> {
- // 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)
+function getLiveMuxingCommand (inputUrl: string, outPath: string, masterPlaylistName: string) {
+ const command = getFFmpeg(inputUrl, 'live')
- // 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
+ command.outputOption('-c:v copy')
+ command.outputOption('-c:a copy')
+ command.outputOption('-map 0:a?')
+ command.outputOption('-map 0:v?')
- // check audio params (if audio stream exists)
- if (parsedAudio.audioStream) {
- if (parsedAudio.audioStream[ 'codec_name' ] !== 'aac') return false
+ addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
- const maxAudioBitrate = audio.bitrate[ 'aac' ](parsedAudio.audioStream[ 'bit_rate' ])
- if (maxAudioBitrate !== -1 && parsedAudio.audioStream[ 'bit_rate' ] > maxAudioBitrate) return false
+ return command
+}
+
+function buildStreamSuffix (base: string, streamNum?: number) {
+ if (streamNum !== undefined) {
+ return `${base}:${streamNum}`
}
- return true
+ return base
}
+// ---------------------------------------------------------------------------
+// Default options
// ---------------------------------------------------------------------------
-export {
- getVideoFileSize,
- getVideoFileResolution,
- getDurationFromVideoFile,
- generateImageFromVideoFile,
- TranscodeOptions,
- TranscodeOptionsType,
- transcode,
- getVideoFileFPS,
- computeResolutionsToTranscode,
- audio,
- getVideoFileBitrate,
- canDoQuickTranscode
+function addDefaultEncoderGlobalParams (options: {
+ command: 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')
+ // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
+ .outputOption('-pix_fmt yuv420p')
+}
+
+function addDefaultEncoderParams (options: {
+ command: 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: FfmpegCommand, outPath: string, masterPlaylistName: string) {
+ command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
+ command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
+ command.outputOption('-hls_flags delete_segments+independent_segments')
+ command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
+ command.outputOption('-master_pl_name ' + masterPlaylistName)
+ command.outputOption(`-f hls`)
+
+ command.output(join(outPath, '%v.m3u8'))
}
+// ---------------------------------------------------------------------------
+// Transcode VOD command builders
// ---------------------------------------------------------------------------
-async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
+async function buildx264VODCommand (command: 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
- }
+ fps = computeFPS(fps, options.resolution)
- command = await presetH264(command, options.inputPath, options.resolution, fps)
+ let scaleFilterValue: string
if (options.resolution !== undefined) {
- // '?x720' or '720x?' for example
- const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}`
- command = command.size(size)
+ scaleFilterValue = options.isPortraitMode === true
+ ? `w=${options.resolution}:h=-2`
+ : `w=-2:h=${options.resolution}`
}
- 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)
- }
+ command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue })
return command
}
-async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
+async function buildAudioMergeCommand (command: FfmpegCommand, options: MergeAudioTranscodeOptions) {
command = command.loop(undefined)
- command = await presetH264VeryFast(command, options.audioPath, options.resolution)
+ const scaleFilterValue = getScaleCleanerValue()
+ command = await presetVideo({ command, input: options.audioPath, transcodeOptions: options, scaleFilterValue })
+
+ command.outputOption('-preset:v veryfast')
command = command.input(options.audioPath)
- .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
.outputOption('-tune stillimage')
.outputOption('-shortest')
return command
}
-async function buildAudioSplitCommand (command: ffmpeg.FfmpegCommand, options: SplitAudioTranscodeOptions) {
- command = await presetAudioSplit(command)
+function buildOnlyAudioCommand (command: FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
+ command = presetOnlyAudio(command)
return command
}
-async function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
- command = await presetCopy(command)
+function buildQuickTranscodeCommand (command: FfmpegCommand) {
+ command = presetCopy(command)
command = command.outputOption('-map_metadata -1') // strip all metadata
.outputOption('-movflags faststart')
return command
}
-async function buildHLSCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
+function addCommonHLSVODCommandOptions (command: 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: FfmpegCommand, options: HLSTranscodeOptions) {
const videoPath = getHLSVideoPath(options)
- if (options.copyCodecs) command = await presetCopy(command)
- else command = await buildx264Command(command, options)
+ if (options.copyCodecs) command = presetCopy(command)
+ 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
}
-function getHLSVideoPath (options: HLSTranscodeOptions) {
- return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
+function buildHLSVODFromTSCommand (command: 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)
await writeFile(options.outputPath, newContent)
}
-function getVideoStreamFromFile (path: string) {
- return new Promise<any>((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)
- })
- })
+function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
+ return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
}
-/**
- * A slightly customised version of the 'veryfast' x264 preset
- *
- * The veryfast preset is right in the sweet spot of performance
- * and quality. Superfast and ultrafast will give you better
- * performance, but then quality is noticeably worse.
- */
-async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
- let localCommand = await presetH264(command, input, resolution, fps)
-
- localCommand = localCommand.outputOption('-preset:v veryfast')
+// ---------------------------------------------------------------------------
+// Transcoding presets
+// ---------------------------------------------------------------------------
- /*
- 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.
- */
+// 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: EncoderOptionsBuilderParams & {
+ streamType: 'video' | 'audio'
+ input: string
- return localCommand
-}
+ availableEncoders: AvailableEncoders
+ profile: string
-/**
- * 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
- })
- }
- }
+ videoType: 'vod' | 'live'
+}) {
+ const { availableEncoders, profile, streamType, videoType } = options
- return res({ absolutePath: data.format.filename })
- }
+ const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
+ const encoders = availableEncoders.available[videoType]
- return ffmpeg.ffprobe(option, parseFfprobe)
- })
- }
+ for (const encoder of encodersToTry) {
+ if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
+ logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder, lTags())
+ continue
+ }
- export namespace bitrate {
- const baseKbitrate = 384
+ if (!encoders[encoder]) {
+ logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder, lTags())
+ continue
+ }
- const toBits = (kbits: number) => kbits * 8000
+ // An object containing available profiles for this encoder
+ const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder]
+ let builder = builderProfiles[profile]
- export const aac = (bitrate: number): number => {
- switch (true) {
- case bitrate > toBits(baseKbitrate):
- return baseKbitrate
+ if (!builder) {
+ logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder, lTags())
+ builder = builderProfiles.default
- default:
- return -1 // we interpret it as a signal to copy the audio stream as is
+ if (!builder) {
+ logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder, lTags())
+ continue
}
}
- 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
- }
+ const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ]))
+
+ return {
+ result,
+
+ // If we don't have output options, then copy the input stream
+ encoder: result.copy === true
+ ? 'copy'
+ : encoder
}
}
+
+ return null
}
-/**
- * Standard profile, with variable bitrate audio and faststart.
- *
- * 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 (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
+async function presetVideo (options: {
+ command: FfmpegCommand
+ input: string
+ transcodeOptions: TranscodeOptions
+ fps?: number
+ scaleFilterValue?: string
+}) {
+ const { command, input, transcodeOptions, fps, scaleFilterValue } = options
+
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)
+ addDefaultEncoderGlobalParams({ command })
+
+ const probe = await ffprobePromise(input)
+
+ // Audio encoder
+ const parsedAudio = await getAudioStream(input, probe)
+ const bitrate = await getVideoFileBitrate(input, probe)
+ const { ratio } = await getVideoFileResolution(input, probe)
+
+ let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
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 matches of bitrates
- // 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' ]
-
- if (audio.bitrate[ audioCodecName ]) {
- const bitrate = audio.bitrate[ audioCodecName ](parsedAudio.audioStream[ 'bit_rate' ])
- if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate)
- }
+ streamsToProcess = [ 'video' ]
}
- if (fps) {
- // 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)
- 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
- localCommand = localCommand.outputOption(`-g ${fps * 2}`)
+ for (const streamType of streamsToProcess) {
+ const { profile, resolution, availableEncoders } = transcodeOptions
+
+ const builderResult = await getEncoderBuilderResult({
+ streamType,
+ input,
+ resolution,
+ availableEncoders,
+ profile,
+ fps,
+ inputBitrate: bitrate,
+ inputRatio: ratio,
+ videoType: 'vod' as 'vod'
+ })
+
+ if (!builderResult) {
+ throw new Error('No available encoder found for stream ' + streamType)
+ }
+
+ logger.debug(
+ 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
+ builderResult.encoder, streamType, input, profile,
+ { builderResult, resolution, fps, ...lTags() }
+ )
+
+ if (streamType === 'video') {
+ localCommand.videoCodec(builderResult.encoder)
+
+ if (scaleFilterValue) {
+ localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`)
+ }
+ } else if (streamType === 'audio') {
+ localCommand.audioCodec(builderResult.encoder)
+ }
+
+ applyEncoderOptions(localCommand, builderResult.result)
+ addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
}
return localCommand
}
-async function presetCopy (command: ffmpeg.FfmpegCommand): Promise<ffmpeg.FfmpegCommand> {
+function presetCopy (command: FfmpegCommand): FfmpegCommand {
return command
.format('mp4')
.videoCodec('copy')
.audioCodec('copy')
}
-
-async function presetAudioSplit (command: ffmpeg.FfmpegCommand): Promise<ffmpeg.FfmpegCommand> {
+function presetOnlyAudio (command: FfmpegCommand): FfmpegCommand {
return command
.format('mp4')
.audioCodec('copy')
.noVideo()
}
+
+function applyEncoderOptions (command: FfmpegCommand, options: EncoderOptions): FfmpegCommand {
+ return command
+ .inputOptions(options.inputOptions ?? [])
+ .outputOptions(options.outputOptions ?? [])
+}
+
+function getScaleFilter (options: EncoderOptions): string {
+ if (options.scaleFilter) return options.scaleFilter.name
+
+ return 'scale'
+}
+
+// ---------------------------------------------------------------------------
+// Utils
+// ---------------------------------------------------------------------------
+
+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: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD,
+ cwd: CONFIG.STORAGE.TMP_DIR
+ })
+
+ 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 ' + threads)
+ }
+
+ return command
+}
+
+function getFFmpegVersion () {
+ return new Promise<string>((res, rej) => {
+ (ffmpeg() as any)._getFfmpegPath((err, ffmpegPath) => {
+ if (err) return rej(err)
+ if (!ffmpegPath) return rej(new Error('Could not find ffmpeg path'))
+
+ return execPromise(`${ffmpegPath} -version`)
+ .then(stdout => {
+ const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/)
+ if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`))
+
+ // Fix ffmpeg version that does not include patch version (4.4 for example)
+ let version = parsed[1]
+ if (version.match(/^\d+\.\d+$/)) {
+ version += '.0'
+ }
+
+ return res(version)
+ })
+ .catch(err => rej(err))
+ })
+ })
+}
+
+async function runCommand (options: {
+ command: FfmpegCommand
+ silent?: boolean // false
+ job?: Job
+}) {
+ const { command, silent = false, job } = options
+
+ return new Promise<void>((res, rej) => {
+ let shellCommand: string
+
+ command.on('start', cmdline => { shellCommand = cmdline })
+
+ command.on('error', (err, stdout, stderr) => {
+ if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr, shellCommand, ...lTags() })
+
+ rej(err)
+ })
+
+ command.on('end', (stdout, stderr) => {
+ logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand, ...lTags() })
+
+ 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, ...lTags() }))
+ })
+ }
+
+ command.run()
+ })
+}
+
+// Avoid "height not divisible by 2" error
+function getScaleCleanerValue () {
+ return 'trunc(iw/2)*2:trunc(ih/2)*2'
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+ getLiveTranscodingCommand,
+ getLiveMuxingCommand,
+ buildStreamSuffix,
+ convertWebPToJPG,
+ processGIF,
+ generateImageFromVideoFile,
+ TranscodeOptions,
+ TranscodeOptionsType,
+ transcode,
+ runCommand,
+ getFFmpegVersion,
+
+ resetSupportedEncoders,
+
+ // builders
+ buildx264VODCommand
+}
projects / github / Chocobozzz / PeerTube.git / blobdiff