import { Job } from 'bull'
-import * as ffmpeg from 'fluent-ffmpeg'
+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 { AvailableEncoders, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos'
+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, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
+import { computeFPS, ffprobePromise, getAudioStream, getVideoFileBitrate, getVideoFileFPS, getVideoFileResolution } from './ffprobe-utils'
import { processImage } from './image-utils'
-import { logger } from './logger'
+import { logger, loggerTagsFactory } from './logger'
+
+const lTags = loggerTagsFactory('ffmpeg')
/**
*
return supportedEncoders
}
- const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders)
+ const getAvailableEncodersPromise = promisify0(getAvailableEncoders)
const availableFFmpegEncoders = await getAvailableEncodersPromise()
const searchEncoders = new Set<string>()
supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
}
- logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders })
+ logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders, ...lTags() })
return supportedEncoders
}
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() })
}
}
}
availableEncoders: AvailableEncoders
profile: string
- resolution: VideoResolution
+ resolution: number
isPortraitMode?: boolean
| QuickTranscodeOptions
const builders: {
- [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise<ffmpeg.FfmpegCommand> | ffmpeg.FfmpegCommand
+ [ type in TranscodeOptionsType ]: (c: FfmpegCommand, o?: TranscodeOptions) => Promise<FfmpegCommand> | FfmpegCommand
} = {
'quick-transcode': buildQuickTranscodeCommand,
'hls': buildHLSVODCommand,
}
async function transcode (options: TranscodeOptions) {
- logger.debug('Will run transcode.', { options })
+ logger.debug('Will run transcode.', { options, ...lTags() })
let command = getFFmpeg(options.inputPath, 'vod')
.output(options.outputPath)
// ---------------------------------------------------------------------------
async function getLiveTranscodingCommand (options: {
- rtmpUrl: string
+ inputUrl: string
+
outPath: string
+ masterPlaylistName: string
+
resolutions: number[]
+
+ // Input information
fps: number
+ bitrate: number
+ ratio: number
availableEncoders: AvailableEncoders
profile: string
}) {
- const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
- const input = rtmpUrl
+ const { inputUrl, outPath, resolutions, fps, bitrate, availableEncoders, profile, masterPlaylistName, ratio } = options
- const command = getFFmpeg(input, 'live')
+ const command = getFFmpeg(inputUrl, 'live')
const varStreamMap: string[] = []
- command.complexFilter([
+ const complexFilter: 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 resolutionFPS = computeFPS(fps, resolution)
const baseEncoderBuilderParams = {
- input,
+ input: inputUrl,
availableEncoders,
profile,
- fps: resolutionFPS,
+ inputBitrate: bitrate,
+ inputRatio: ratio,
+
resolution,
+ fps: resolutionFPS,
+
streamNum: i,
videoType: 'live' as 'live'
}
{
const streamType: StreamType = 'video'
- const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
+ const builderResult = await getEncoderBuilderResult({ ...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 using %s profile.', builderResult.encoder, profile, builderResult)
+ 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}`)
- 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 streamType: StreamType = 'audio'
- const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
+ const builderResult = await getEncoderBuilderResult({ ...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 using %s profile.', builderResult.encoder, profile, builderResult)
+ 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}`)
- command.addOutputOptions(builderResult.result.outputOptions)
+ applyEncoderOptions(command, builderResult.result)
}
varStreamMap.push(`v:${i},a:${i}`)
}
- addDefaultLiveHLSParams(command, outPath)
+ command.complexFilter(complexFilter)
+
+ addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
command.outputOption('-var_stream_map', varStreamMap.join(' '))
return command
}
-function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
- const command = getFFmpeg(rtmpUrl, 'live')
+function getLiveMuxingCommand (inputUrl: string, outPath: string, masterPlaylistName: string) {
+ const command = getFFmpeg(inputUrl, 'live')
command.outputOption('-c:v copy')
command.outputOption('-c:a copy')
command.outputOption('-map 0:a?')
command.outputOption('-map 0:v?')
- addDefaultLiveHLSParams(command, outPath)
+ addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
return command
}
// ---------------------------------------------------------------------------
function addDefaultEncoderGlobalParams (options: {
- command: ffmpeg.FfmpegCommand
+ command: FfmpegCommand
}) {
const { command } = options
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
+ command: FfmpegCommand
encoder: 'libx264' | string
streamNum?: number
fps?: number
}
}
-function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
+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 master.m3u8')
+ command.outputOption('-master_pl_name ' + masterPlaylistName)
command.outputOption(`-f hls`)
command.output(join(outPath, '%v.m3u8'))
// Transcode VOD command builders
// ---------------------------------------------------------------------------
-async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
+async function buildx264VODCommand (command: FfmpegCommand, options: TranscodeOptions) {
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) {
+async function buildAudioMergeCommand (command: 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')
return command
}
-function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
+function buildOnlyAudioCommand (command: FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
command = presetOnlyAudio(command)
return command
}
-function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
+function buildQuickTranscodeCommand (command: FfmpegCommand) {
command = presetCopy(command)
command = command.outputOption('-map_metadata -1') // strip all metadata
return command
}
-function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPath: string) {
+function addCommonHLSVODCommandOptions (command: FfmpegCommand, outputPath: string) {
return command.outputOption('-hls_time 4')
.outputOption('-hls_list_size 0')
.outputOption('-hls_playlist_type vod')
.outputOption('-hls_flags single_file')
}
-async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
+async function buildHLSVODCommand (command: FfmpegCommand, options: HLSTranscodeOptions) {
const videoPath = getHLSVideoPath(options)
if (options.copyCodecs) command = presetCopy(command)
return command
}
-async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) {
+function buildHLSVODFromTSCommand (command: FfmpegCommand, options: HLSFromTSTranscodeOptions) {
const videoPath = getHLSVideoPath(options)
command.outputOption('-c copy')
// 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: {
+async function getEncoderBuilderResult (options: EncoderOptionsBuilderParams & {
streamType: 'video' | 'audio'
input: string
profile: string
videoType: 'vod' | 'live'
-
- resolution: number
- fps?: number
- streamNum?: number
}) {
- const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
+ const { availableEncoders, profile, streamType, videoType } = options
const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
const encoders = availableEncoders.available[videoType]
for (const encoder of encodersToTry) {
if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
- logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder)
+ logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder, lTags())
continue
}
if (!encoders[encoder]) {
- logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder)
+ logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder, lTags())
continue
}
let builder = builderProfiles[profile]
if (!builder) {
- logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
+ logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder, lTags())
builder = builderProfiles.default
if (!builder) {
- logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder)
+ logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder, lTags())
continue
}
}
- const result = await builder({ input, resolution: resolution, fps, streamNum })
+ const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ]))
return {
result,
return null
}
-async function presetVideo (
- command: ffmpeg.FfmpegCommand,
- input: string,
- transcodeOptions: TranscodeOptions,
+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')
.outputOption('-movflags faststart')
addDefaultEncoderGlobalParams({ command })
+ const probe = await ffprobePromise(input)
+
// Audio encoder
- const parsedAudio = await getAudioStream(input)
+ const parsedAudio = await getAudioStream(input, probe)
+ const bitrate = await getVideoFileBitrate(input, probe)
+ const { ratio } = await getVideoFileResolution(input, probe)
let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
availableEncoders,
profile,
fps,
+ inputBitrate: bitrate,
+ inputRatio: ratio,
videoType: 'vod' as 'vod'
})
logger.debug(
'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
- builderResult.encoder, streamType, input, profile, builderResult
+ 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)
}
- command.addOutputOptions(builderResult.result.outputOptions)
+ applyEncoderOptions(localCommand, builderResult.result)
addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
}
return localCommand
}
-function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
+function presetCopy (command: FfmpegCommand): FfmpegCommand {
return command
.format('mp4')
.videoCodec('copy')
.audioCodec('copy')
}
-function presetOnlyAudio (command: ffmpeg.FfmpegCommand): 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
// ---------------------------------------------------------------------------
return execPromise(`${ffmpegPath} -version`)
.then(stdout => {
- const parsed = stdout.match(/ffmpeg version .(\d+\.\d+\.\d+)/)
+ const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/)
if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`))
- return res(parsed[1])
+ // 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
+ 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 })
+ 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 })
+ logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand, ...lTags() })
res()
})
if (!progress.percent) return
job.progress(Math.round(progress.percent))
- .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err }))
+ .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err, ...lTags() }))
})
}
})
}
+// Avoid "height not divisible by 2" error
+function getScaleCleanerValue () {
+ return 'trunc(iw/2)*2:trunc(ih/2)*2'
+}
+
// ---------------------------------------------------------------------------
export {
projects / github / Chocobozzz / PeerTube.git / blobdiff