+import { Job } from 'bull'
import * as ffmpeg from 'fluent-ffmpeg'
import { readFile, remove, writeFile } from 'fs-extra'
import { dirname, join } from 'path'
-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 { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants'
+import { AvailableEncoders, EncoderOptions, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos'
import { CONFIG } from '../initializers/config'
+import { execPromise, promisify0 } from './core-utils'
import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
import { processImage } from './image-utils'
import { logger } from './logger'
// Encoder options
// ---------------------------------------------------------------------------
-// Options builders
+type StreamType = 'audio' | 'video'
-export type EncoderOptionsBuilder = (params: {
- input: string
- resolution: VideoResolution
- fps?: number
- streamNum?: number
-}) => Promise<EncoderOptions> | EncoderOptions
+// ---------------------------------------------------------------------------
+// Encoders support
+// ---------------------------------------------------------------------------
-// Options types
+// Detect supported encoders by ffmpeg
+let supportedEncoders: Map<string, boolean>
+async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise<Map<string, boolean>> {
+ if (supportedEncoders !== undefined) {
+ return supportedEncoders
+ }
-export interface EncoderOptions {
- copy?: boolean
- outputOptions: string[]
-}
+ const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders)
+ const availableFFmpegEncoders = await getAvailableEncodersPromise()
-// All our encoders
+ 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)
+ }
+ }
+ }
-export interface EncoderProfile <T> {
- [ profile: string ]: T
+ supportedEncoders = new Map<string, boolean>()
- default: T
+ for (const searchEncoder of searchEncoders) {
+ supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
+ }
+
+ logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders })
+
+ return supportedEncoders
}
-export type AvailableEncoders = {
- [ id in 'live' | 'vod' ]: {
- [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile<EncoderOptionsBuilder>
- }
+function resetSupportedEncoders () {
+ supportedEncoders = undefined
}
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
function convertWebPToJPG (path: string, destination: string): Promise<void> {
- const command = ffmpeg(path)
+ const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
.output(destination)
- return runCommand(command)
+ return runCommand({ command, silent: true })
}
function processGIF (
destination: string,
newSize: { width: number, height: number }
): Promise<void> {
- const command = ffmpeg(path)
+ const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
.fps(20)
.size(`${newSize.width}x${newSize.height}`)
.output(destination)
- return runCommand(command)
+ return runCommand({ command })
}
async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
availableEncoders: AvailableEncoders
profile: string
- resolution: VideoResolution
+ resolution: number
isPortraitMode?: boolean
+
+ job?: Job
}
interface HLSTranscodeOptions extends BaseTranscodeOptions {
command = await builders[options.type](command, options)
- await runCommand(command)
+ await runCommand({ command, job: options.job })
await fixHLSPlaylistIfNeeded(options)
}
const varStreamMap: string[] = []
- command.complexFilter([
+ const complexFilter: ffmpeg.FilterSpecification[] = [
{
inputs: '[v:0]',
filter: 'split',
options: resolutions.length,
outputs: resolutions.map(r => `vtemp${r}`)
- },
-
- ...resolutions.map(r => ({
- inputs: `vtemp${r}`,
- filter: 'scale',
- options: `w=-2:h=${r}`,
- outputs: `vout${r}`
- }))
- ])
+ }
+ ]
- command.outputOption('-preset superfast')
command.outputOption('-sc_threshold 0')
addDefaultEncoderGlobalParams({ command })
const baseEncoderBuilderParams = {
input,
+
availableEncoders,
profile,
+
fps: resolutionFPS,
resolution,
streamNum: i,
}
{
- const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' }))
+ const streamType: StreamType = 'video'
+ const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
if (!builderResult) {
throw new Error('No available live video encoder found')
}
addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
- logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult)
+ logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult)
command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
- command.addOutputOptions(builderResult.result.outputOptions)
+ applyEncoderOptions(command, builderResult.result)
+
+ complexFilter.push({
+ inputs: `vtemp${resolution}`,
+ filter: getScaleFilter(builderResult.result),
+ options: `w=-2:h=${resolution}`,
+ outputs: `vout${resolution}`
+ })
}
{
- const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' }))
+ const streamType: StreamType = 'audio'
+ const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
if (!builderResult) {
throw new Error('No available live audio encoder found')
}
addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
- logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult)
+ logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult)
command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
- command.addOutputOptions(builderResult.result.outputOptions)
+ applyEncoderOptions(command, builderResult.result)
}
varStreamMap.push(`v:${i},a:${i}`)
}
+ command.complexFilter(complexFilter)
+
addDefaultLiveHLSParams(command, outPath)
command.outputOption('-var_stream_map', varStreamMap.join(' '))
let fps = await getVideoFileFPS(options.inputPath)
fps = computeFPS(fps, options.resolution)
- command = await presetVideo(command, options.inputPath, options, 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}`
}
+ command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue })
+
return command
}
async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
command = command.loop(undefined)
- command = await presetVideo(command, options.audioPath, options)
+ 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')
// Transcoding presets
// ---------------------------------------------------------------------------
+// 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: {
- streamType: string
+ streamType: 'video' | 'audio'
input: string
availableEncoders: AvailableEncoders
}) {
const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
- const encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[streamType]
+ const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
+ const encoders = availableEncoders.available[videoType]
for (const encoder of encodersToTry) {
- if (!(await checkFFmpegEncoders()).get(encoder) || !availableEncoders[videoType][encoder]) continue
+ if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
+ logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder)
+ continue
+ }
- const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = availableEncoders[videoType][encoder]
+ if (!encoders[encoder]) {
+ logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder)
+ continue
+ }
+
+ // An object containing available profiles for this encoder
+ const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder]
let builder = builderProfiles[profile]
if (!builder) {
logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
builder = builderProfiles.default
+
+ if (!builder) {
+ logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder)
+ continue
+ }
}
- const result = await builder({ input, resolution: resolution, fps, streamNum })
+ const result = await builder({ input, resolution, fps, streamNum })
return {
result,
return null
}
-async function presetVideo (
- command: ffmpeg.FfmpegCommand,
- input: string,
- transcodeOptions: TranscodeOptions,
+async function presetVideo (options: {
+ command: ffmpeg.FfmpegCommand
+ input: string
+ transcodeOptions: TranscodeOptions
fps?: number
-) {
+ scaleFilterValue?: string
+}) {
+ const { command, input, transcodeOptions, fps, scaleFilterValue } = options
+
let localCommand = command
.format('mp4')
.outputOption('-movflags faststart')
// Audio encoder
const parsedAudio = await getAudioStream(input)
- let streamsToProcess = [ 'AUDIO', 'VIDEO' ]
+ let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
if (!parsedAudio.audioStream) {
localCommand = localCommand.noAudio()
- streamsToProcess = [ 'VIDEO' ]
+ streamsToProcess = [ 'video' ]
}
for (const streamType of streamsToProcess) {
throw new Error('No available encoder found for stream ' + streamType)
}
- logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult)
+ logger.debug(
+ 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
+ builderResult.encoder, streamType, input, profile, builderResult
+ )
- if (streamType === 'VIDEO') {
+ if (streamType === 'video') {
localCommand.videoCodec(builderResult.encoder)
- } else if (streamType === 'AUDIO') {
+
+ if (scaleFilterValue) {
+ localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`)
+ }
+ } else if (streamType === 'audio') {
localCommand.audioCodec(builderResult.encoder)
}
- command.addOutputOptions(builderResult.result.outputOptions)
+ applyEncoderOptions(localCommand, builderResult.result)
addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
}
.noVideo()
}
+function applyEncoderOptions (command: ffmpeg.FfmpegCommand, options: EncoderOptions): ffmpeg.FfmpegCommand {
+ return command
+ .inputOptions(options.inputOptions ?? [])
+ .outputOptions(options.outputOptions ?? [])
+}
+
+function getScaleFilter (options: EncoderOptions): string {
+ if (options.scaleFilter) return options.scaleFilter.name
+
+ return 'scale'
+}
+
// ---------------------------------------------------------------------------
// Utils
// ---------------------------------------------------------------------------
return command
}
-async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) {
+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: ffmpeg.FfmpegCommand
+ silent?: boolean // false
+ job?: Job
+}) {
+ const { command, silent = false, job } = options
+
return new Promise<void>((res, rej) => {
command.on('error', (err, stdout, stderr) => {
- if (onEnd) onEnd()
+ if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr })
- logger.error('Error in transcoding job.', { stdout, stderr })
rej(err)
})
- command.on('end', () => {
- if (onEnd) onEnd()
+ 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()
})
}
+// Avoid "height not divisible by 2" error
+function getScaleCleanerValue () {
+ return 'trunc(iw/2)*2:trunc(ih/2)*2'
+}
+
// ---------------------------------------------------------------------------
export {
TranscodeOptionsType,
transcode,
runCommand,
+ getFFmpegVersion,
+
+ resetSupportedEncoders,
// builders
buildx264VODCommand
projects / github / Chocobozzz / PeerTube.git / blobdiff