+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, VIDEO_TRANSCODING_FPS } 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, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos'
import { CONFIG } from '../initializers/config'
-import { getAudioStream, getClosestFramerateStandard, getVideoFileFPS } from './ffprobe-utils'
+import { 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 (
path: string,
destination: string,
- newSize: { width: number, height: number },
- keepOriginal = false
+ newSize: { width: number, height: number }
): Promise<void> {
- return new Promise<void>(async (res, rej) => {
- if (path === destination) {
- throw new Error('FFmpeg needs an input path different that the output path.')
- }
-
- logger.debug('Processing gif %s to %s.', path, destination)
+ const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
+ .fps(20)
+ .size(`${newSize.width}x${newSize.height}`)
+ .output(destination)
- try {
- const command = ffmpeg(path)
- .fps(20)
- .size(`${newSize.width}x${newSize.height}`)
- .output(destination)
-
- command.on('error', (err, stdout, stderr) => {
- logger.error('Error in ffmpeg gif resizing process.', { stdout, stderr })
- return rej(err)
- })
- .on('end', async () => {
- if (keepOriginal !== true) await remove(path)
- res()
- })
- .run()
- } catch (err) {
- return rej(err)
- }
- })
+ return runCommand({ command })
}
async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
// Transcode meta function
// ---------------------------------------------------------------------------
-type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
+type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
interface BaseTranscodeOptions {
type: TranscodeOptionsType
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
} = {
'quick-transcode': buildQuickTranscodeCommand,
'hls': buildHLSVODCommand,
+ 'hls-from-ts': buildHLSVODFromTSCommand,
'merge-audio': buildAudioMergeCommand,
'only-audio': buildOnlyAudioCommand,
'video': buildx264VODCommand
async function transcode (options: TranscodeOptions) {
logger.debug('Will run transcode.', { options })
- let command = getFFmpeg(options.inputPath)
+ let command = getFFmpeg(options.inputPath, 'vod')
.output(options.outputPath)
command = await builders[options.type](command, options)
- await runCommand(command)
+ await runCommand({ command, job: options.job })
await fixHLSPlaylistIfNeeded(options)
}
outPath: string
resolutions: number[]
fps: number
- deleteSegments: boolean
availableEncoders: AvailableEncoders
profile: string
}) {
- const { rtmpUrl, outPath, resolutions, fps, deleteSegments, availableEncoders, profile } = options
+ const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
const input = rtmpUrl
- const command = getFFmpeg(input)
- command.inputOption('-fflags nobuffer')
+ const command = getFFmpeg(input, 'live')
const varStreamMap: string[] = []
])
command.outputOption('-preset superfast')
+ command.outputOption('-sc_threshold 0')
+
+ addDefaultEncoderGlobalParams({ command })
for (let i = 0; i < resolutions.length; i++) {
const resolution = resolutions[i]
- const baseEncoderBuilderParams = { input, availableEncoders, profile, fps, resolution, streamNum: i, videoType: 'live' as 'live' }
+ const resolutionFPS = computeFPS(fps, resolution)
+
+ const baseEncoderBuilderParams = {
+ input,
+
+ availableEncoders,
+ profile,
+
+ fps: resolutionFPS,
+ resolution,
+ streamNum: i,
+ videoType: 'live' as 'live'
+ }
{
- 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')
}
command.outputOption(`-map [vout${resolution}]`)
- addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps, streamNum: i })
+ 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)
}
{
- 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')
}
command.outputOption('-map a:0')
- addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps, streamNum: i })
+ 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)
varStreamMap.push(`v:${i},a:${i}`)
}
- addDefaultLiveHLSParams(command, outPath, deleteSegments)
+ addDefaultLiveHLSParams(command, outPath)
command.outputOption('-var_stream_map', varStreamMap.join(' '))
return command
}
-function getLiveMuxingCommand (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)
+ addDefaultLiveHLSParams(command, outPath)
return command
}
-async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: string[], outputPath: string) {
- const concatFilePath = join(hlsDirectory, 'concat.txt')
-
- function cleaner () {
- remove(concatFilePath)
- .catch(err => logger.error('Cannot remove concat file in %s.', hlsDirectory, { err }))
- }
-
- // First concat the ts files to a mp4 file
- const content = segmentFiles.map(f => 'file ' + f)
- .join('\n')
-
- await writeFile(concatFilePath, content + '\n')
-
- const command = getFFmpeg(concatFilePath)
- command.inputOption('-safe 0')
- command.inputOption('-f concat')
-
- command.outputOption('-c:v copy')
- command.audioFilter('aresample=async=1:first_pts=0')
- command.output(outputPath)
-
- return runCommand(command, cleaner)
-}
-
function buildStreamSuffix (base: string, streamNum?: number) {
if (streamNum !== undefined) {
return `${base}:${streamNum}`
return base
}
-// ---------------------------------------------------------------------------
-
-export {
- getLiveTranscodingCommand,
- getLiveMuxingCommand,
- buildStreamSuffix,
- convertWebPToJPG,
- processGIF,
- generateImageFromVideoFile,
- TranscodeOptions,
- TranscodeOptionsType,
- transcode,
- hlsPlaylistToFragmentedMP4
-}
-
-// ---------------------------------------------------------------------------
-
// ---------------------------------------------------------------------------
// Default options
// ---------------------------------------------------------------------------
+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
if (encoder === 'libx264') {
// 3.1 is the minimal resource allocation for our highest supported resolution
- command.outputOption('-level 3.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(buildStreamSuffix('-pix_fmt', streamNum) + ' yuv420p')
- // strip all metadata
- .outputOption('-map_metadata -1')
- // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
- .outputOption(buildStreamSuffix('-max_muxing_queue_size', streamNum) + ' 1024')
+ 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('-g ' + (fps * 2))
+ command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
}
}
}
-function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) {
+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_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`)
async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
let fps = await getVideoFileFPS(options.inputPath)
- if (
- // On small/medium resolutions, limit FPS
- options.resolution !== undefined &&
- options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
- fps > VIDEO_TRANSCODING_FPS.AVERAGE
- ) {
- // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value
- fps = getClosestFramerateStandard(fps, 'STANDARD')
- }
+ fps = computeFPS(fps, options.resolution)
command = await presetVideo(command, options.inputPath, options, fps)
command = command.size(size)
}
- // 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
-
- command = command.withFPS(fps)
-
return command
}
command = await presetVideo(command, options.audioPath, options)
- /*
- MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html
- Our target situation is closer to a livestream than a stream,
- since we want to reduce as much a possible the encoding burden,
- although not to the point of a livestream where there is a hard
- constraint on the frames per second to be encoded.
- */
command.outputOption('-preset:v veryfast')
command = command.input(options.audioPath)
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)
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
+}
+
+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)
}
-function getHLSVideoPath (options: HLSTranscodeOptions) {
+function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
}
// 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 })
.format('mp4')
.outputOption('-movflags faststart')
+ addDefaultEncoderGlobalParams({ command })
+
// 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') {
+ } else if (streamType === 'audio') {
localCommand.audioCodec(builderResult.encoder)
}
// Utils
// ---------------------------------------------------------------------------
-function getFFmpeg (input: string) {
+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
+ })
- if (CONFIG.TRANSCODING.THREADS > 0) {
+ 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 ' + CONFIG.TRANSCODING.THREADS)
+ command.outputOption('-threads ' + threads)
}
return command
}
-async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) {
+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()
})
}
+
+// ---------------------------------------------------------------------------
+
+export {
+ getLiveTranscodingCommand,
+ getLiveMuxingCommand,
+ buildStreamSuffix,
+ convertWebPToJPG,
+ processGIF,
+ generateImageFromVideoFile,
+ TranscodeOptions,
+ TranscodeOptionsType,
+ transcode,
+ runCommand,
+
+ resetSupportedEncoders,
+
+ // builders
+ buildx264VODCommand
+}
projects / github / Chocobozzz / PeerTube.git / blobdiff