+import { Job } from 'bull'
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 { 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_FPS } from '../initializers/constants'
+import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
import { processImage } from './image-utils'
import { logger } from './logger'
/**
- * A toolbox to play with audio
+ *
+ * Functions that run transcoding/muxing ffmpeg processes
+ * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
+ *
*/
-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
+// ---------------------------------------------------------------------------
+// Encoder options
+// ---------------------------------------------------------------------------
- const baseProfileMatrix = {
- High: '6400',
- Main: '4D40',
- Baseline: '42E0'
- }
+// Options builders
- let baseProfile = baseProfileMatrix[videoStream.profile]
- if (!baseProfile) {
- logger.warn('Cannot get video profile codec of %s.', path, { videoStream })
- baseProfile = baseProfileMatrix['High'] // Fallback
- }
+export type EncoderOptionsBuilder = (params: {
+ input: string
+ resolution: VideoResolution
+ fps?: number
+ streamNum?: number
+}) => Promise<EncoderOptions> | EncoderOptions
- let level = videoStream.level.toString(16)
- if (level.length === 1) level = `0${level}`
+// Options types
- return `${videoCodec}.${baseProfile}${level}`
+export interface EncoderOptions {
+ copy?: boolean
+ outputOptions: string[]
}
-async function getAudioStreamCodec (path: string) {
- const { audioStream } = await audio.get(path)
-
- if (!audioStream) return ''
+// All our encoders
- const audioCodec = audioStream.codec_name
- if (audioCodec === 'aac') return 'mp4a.40.2'
+export interface EncoderProfile <T> {
+ [ profile: string ]: T
- logger.warn('Cannot get audio codec of %s.', path, { audioStream })
-
- return 'mp4a.40.2' // Fallback
+ default: T
}
-async function getVideoFileResolution (path: string) {
- const size = await getVideoStreamSize(path)
-
- return {
- videoFileResolution: Math.min(size.height, size.width),
- isPortraitMode: size.height > size.width
+export type AvailableEncoders = {
+ [ id in 'live' | 'vod' ]: {
+ [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile<EncoderOptionsBuilder>
}
}
-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 <T> (path: string, cb = metadata => metadata) {
- return new Promise<T>((res, rej) => {
- ffmpeg.ffprobe(path, (err, metadata) => {
- if (err) return rej(err)
+// ---------------------------------------------------------------------------
+// Image manipulation
+// ---------------------------------------------------------------------------
- return res(cb(new VideoFileMetadata(metadata)))
- })
- })
-}
+function convertWebPToJPG (path: string, destination: string): Promise<void> {
+ const command = ffmpeg(path)
+ .output(destination)
-async function getVideoFileBitrate (path: string) {
- return getMetadataFromFile<number>(path, metadata => metadata.format.bit_rate)
+ return runCommand(command)
}
-function getDurationFromVideoFile (path: string) {
- return getMetadataFromFile<number>(path, metadata => Math.floor(metadata.format.duration))
-}
+function processGIF (
+ path: string,
+ destination: string,
+ newSize: { width: number, height: number }
+): Promise<void> {
+ const command = ffmpeg(path)
+ .fps(20)
+ .size(`${newSize.width}x${newSize.height}`)
+ .output(destination)
-function getVideoStreamFromFile (path: string) {
- return getMetadataFromFile<any>(path, metadata => metadata.streams.find(s => s.codec_type === 'video') || null)
+ return runCommand(command)
}
async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
}
}
-type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-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
+
+ availableEncoders: AvailableEncoders
+ profile: string
+
resolution: VideoResolution
+
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'
}
type TranscodeOptions =
HLSTranscodeOptions
+ | HLSFromTSTranscodeOptions
| VideoTranscodeOptions
| MergeAudioTranscodeOptions
| OnlyAudioTranscodeOptions
| QuickTranscodeOptions
-function transcode (options: TranscodeOptions) {
- return new Promise<void>(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> | ffmpeg.FfmpegCommand
+} = {
+ 'quick-transcode': buildQuickTranscodeCommand,
+ 'hls': buildHLSVODCommand,
+ 'hls-from-ts': buildHLSVODFromTSCommand,
+ 'merge-audio': buildAudioMergeCommand,
+ 'only-audio': buildOnlyAudioCommand,
+ 'video': buildx264VODCommand
}
-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)
+async function transcode (options: TranscodeOptions) {
+ logger.debug('Will run transcode.', { options })
- // 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
+ let command = getFFmpeg(options.inputPath, 'vod')
+ .output(options.outputPath)
- // check audio params (if audio stream exists)
- if (parsedAudio.audioStream) {
- if (parsedAudio.audioStream['codec_name'] !== 'aac') return false
+ command = await builders[options.type](command, options)
- const maxAudioBitrate = audio.bitrate['aac'](parsedAudio.audioStream['bit_rate'])
- if (maxAudioBitrate !== -1 && parsedAudio.audioStream['bit_rate'] > maxAudioBitrate) return false
- }
+ await runCommand(command, options.job)
- return true
+ await fixHLSPlaylistIfNeeded(options)
}
-function getClosestFramerateStandard (fps: number, type: 'HD_STANDARD' | 'STANDARD'): number {
- return VIDEO_TRANSCODING_FPS[type].slice(0)
- .sort((a, b) => fps % a - fps % b)[0]
-}
+// ---------------------------------------------------------------------------
+// Live muxing/transcoding functions
+// ---------------------------------------------------------------------------
-function convertWebPToJPG (path: string, destination: string): Promise<void> {
- return new Promise<void>(async (res, rej) => {
- try {
- const command = ffmpeg(path).output(destination)
+async function getLiveTranscodingCommand (options: {
+ rtmpUrl: string
+ outPath: string
+ resolutions: number[]
+ fps: number
- 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)
- }
- })
-}
+ availableEncoders: AvailableEncoders
+ profile: string
+}) {
+ const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
+ const input = rtmpUrl
-function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: number[], deleteSegments: boolean) {
- const command = getFFmpeg(rtmpUrl)
- command.inputOption('-fflags nobuffer')
+ const command = getFFmpeg(input, 'live')
const varStreamMap: string[] = []
}))
])
- 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('-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,
+ 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, liveFPS, 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}`)
}
- addDefaultLiveHLSParams(command, outPath, deleteSegments)
+ addDefaultLiveHLSParams(command, outPath)
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')
+function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
+ const command = getFFmpeg(rtmpUrl, 'live')
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()
+ addDefaultLiveHLSParams(command, outPath)
return command
}
-function hlsPlaylistToFragmentedMP4 (playlistPath: string, outputPath: string) {
- const command = getFFmpeg(playlistPath)
-
- command.outputOption('-c copy')
- command.output(outputPath)
-
- command.run()
+function buildStreamSuffix (base: string, streamNum?: number) {
+ if (streamNum !== undefined) {
+ return `${base}:${streamNum}`
+ }
- return new Promise<string>((res, rej) => {
- command.on('error', err => rej(err))
- command.on('end', () => res())
- })
+ return base
}
// ---------------------------------------------------------------------------
-
-export {
- getVideoStreamCodec,
- getAudioStreamCodec,
- runLiveMuxing,
- convertWebPToJPG,
- getVideoStreamSize,
- getVideoFileResolution,
- getMetadataFromFile,
- getDurationFromVideoFile,
- runLiveTranscoding,
- generateImageFromVideoFile,
- TranscodeOptions,
- TranscodeOptionsType,
- transcode,
- getVideoFileFPS,
- computeResolutionsToTranscode,
- audio,
- hlsPlaylistToFragmentedMP4,
- getVideoFileBitrate,
- canDoQuickTranscode
-}
-
+// Default options
// ---------------------------------------------------------------------------
-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 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) {
- command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME)
+function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
+ 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_flags delete_segments+independent_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) {
+// ---------------------------------------------------------------------------
+// Transcode VOD command builders
+// ---------------------------------------------------------------------------
+
+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 presetH264(command, options.inputPath, options.resolution, fps)
+ 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
async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
command = command.loop(undefined)
- command = await presetH264VeryFast(command, options.audioPath, options.resolution)
+ command = await presetVideo(command, options.audioPath, options)
+
+ 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
return command
}
-function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, options: OnlyAudioTranscodeOptions) {
+function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
command = presetOnlyAudio(command)
return command
return command
}
+function addCommonHLSVODCommandOptions (command: ffmpeg.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: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
const videoPath = getHLSVideoPath(options)
if (options.copyCodecs) command = presetCopy(command)
else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
- else command = await buildx264Command(command, options)
+ 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}`
+async function buildHLSVODFromTSCommand (command: ffmpeg.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)
}
-/**
- * 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)
+function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
+ return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
+}
+
+// ---------------------------------------------------------------------------
+// Transcoding presets
+// ---------------------------------------------------------------------------
- localCommand = localCommand.outputOption('-preset:v veryfast')
+async function getEncoderBuilderResult (options: {
+ streamType: string
+ input: string
- /*
- 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.
- */
+ availableEncoders: AvailableEncoders
+ profile: string
- return localCommand
+ 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
}
-/**
- * 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 (
+ command: ffmpeg.FfmpegCommand,
+ input: string,
+ transcodeOptions: TranscodeOptions,
+ fps?: number
+) {
let localCommand = command
.format('mp4')
- .videoCodec('libx264')
.outputOption('-movflags faststart')
- addDefaultX264Params(localCommand)
+ addDefaultEncoderGlobalParams({ command })
+
+ // Audio encoder
+ const parsedAudio = await getAudioStream(input)
- const parsedAudio = await audio.get(input)
+ let streamsToProcess = [ '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,
+ videoType: 'vod' as 'vod'
+ })
+
+ if (!builderResult) {
+ throw new Error('No available encoder found for stream ' + streamType)
+ }
+
+ logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult)
+
+ if (streamType === 'VIDEO') {
+ localCommand.videoCodec(builderResult.encoder)
+ } else if (streamType === 'AUDIO') {
+ localCommand.audioCodec(builderResult.encoder)
+ }
+
+ command.addOutputOptions(builderResult.result.outputOptions)
+ addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
}
return localCommand
.noVideo()
}
-function getFFmpeg (input: string) {
+// ---------------------------------------------------------------------------
+// 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: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR })
+ 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 (CONFIG.TRANSCODING.THREADS > 0) {
+ if (threads > 0) {
// If we don't set any threads ffmpeg will chose automatically
- command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)
+ command.outputOption('-threads ' + threads)
}
return command
}
+
+async function runCommand (command: ffmpeg.FfmpegCommand, job?: Job) {
+ return new Promise<void>((res, rej) => {
+ command.on('error', (err, stdout, stderr) => {
+ logger.error('Error in transcoding job.', { stdout, stderr })
+ rej(err)
+ })
+
+ command.on('end', (stdout, stderr) => {
+ logger.debug('FFmpeg command ended.', { stdout, stderr })
+
+ 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 }))
+ })
+ }
+
+ command.run()
+ })
+}
+
+// ---------------------------------------------------------------------------
+
+export {
+ getLiveTranscodingCommand,
+ getLiveMuxingCommand,
+ buildStreamSuffix,
+ convertWebPToJPG,
+ processGIF,
+ generateImageFromVideoFile,
+ TranscodeOptions,
+ TranscodeOptionsType,
+ transcode,
+ runCommand,
+
+ // builders
+ buildx264VODCommand
+}
projects / github / Chocobozzz / PeerTube.git / blobdiff