1 import { Job } from 'bull'
2 import * as ffmpeg from 'fluent-ffmpeg'
3 import { readFile, remove, writeFile } from 'fs-extra'
4 import { dirname, join } from 'path'
5 import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants'
6 import { AvailableEncoders, EncoderOptionsBuilder, EncoderOptions, EncoderProfile, VideoResolution } from '../../shared/models/videos'
7 import { CONFIG } from '../initializers/config'
8 import { execPromise, promisify0 } from './core-utils'
9 import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
10 import { processImage } from './image-utils'
11 import { logger } from './logger'
12 import { FilterSpecification } from 'fluent-ffmpeg'
16 * Functions that run transcoding/muxing ffmpeg processes
17 * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
21 // ---------------------------------------------------------------------------
23 // ---------------------------------------------------------------------------
25 type StreamType = 'audio' | 'video'
27 // ---------------------------------------------------------------------------
29 // ---------------------------------------------------------------------------
31 // Detect supported encoders by ffmpeg
32 let supportedEncoders: Map<string, boolean>
33 async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise<Map<string, boolean>> {
34 if (supportedEncoders !== undefined) {
35 return supportedEncoders
38 const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders)
39 const availableFFmpegEncoders = await getAvailableEncodersPromise()
41 const searchEncoders = new Set<string>()
42 for (const type of [ 'live', 'vod' ]) {
43 for (const streamType of [ 'audio', 'video' ]) {
44 for (const encoder of peertubeAvailableEncoders.encodersToTry[type][streamType]) {
45 searchEncoders.add(encoder)
50 supportedEncoders = new Map<string, boolean>()
52 for (const searchEncoder of searchEncoders) {
53 supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
56 logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders })
58 return supportedEncoders
61 function resetSupportedEncoders () {
62 supportedEncoders = undefined
65 // ---------------------------------------------------------------------------
67 // ---------------------------------------------------------------------------
69 function convertWebPToJPG (path: string, destination: string): Promise<void> {
70 const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
73 return runCommand({ command, silent: true })
79 newSize: { width: number, height: number }
81 const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
83 .size(`${newSize.width}x${newSize.height}`)
86 return runCommand({ command })
89 async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
90 const pendingImageName = 'pending-' + imageName
93 filename: pendingImageName,
98 const pendingImagePath = join(folder, pendingImageName)
101 await new Promise<string>((res, rej) => {
102 ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
104 .on('end', () => res(imageName))
108 const destination = join(folder, imageName)
109 await processImage(pendingImagePath, destination, size)
111 logger.error('Cannot generate image from video %s.', fromPath, { err })
114 await remove(pendingImagePath)
116 logger.debug('Cannot remove pending image path after generation error.', { err })
121 // ---------------------------------------------------------------------------
122 // Transcode meta function
123 // ---------------------------------------------------------------------------
125 type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
127 interface BaseTranscodeOptions {
128 type: TranscodeOptionsType
133 availableEncoders: AvailableEncoders
136 resolution: VideoResolution
138 isPortraitMode?: boolean
143 interface HLSTranscodeOptions extends BaseTranscodeOptions {
147 videoFilename: string
151 interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions {
157 videoFilename: string
161 interface QuickTranscodeOptions extends BaseTranscodeOptions {
162 type: 'quick-transcode'
165 interface VideoTranscodeOptions extends BaseTranscodeOptions {
169 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
174 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
178 type TranscodeOptions =
180 | HLSFromTSTranscodeOptions
181 | VideoTranscodeOptions
182 | MergeAudioTranscodeOptions
183 | OnlyAudioTranscodeOptions
184 | QuickTranscodeOptions
187 [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise<ffmpeg.FfmpegCommand> | ffmpeg.FfmpegCommand
189 'quick-transcode': buildQuickTranscodeCommand,
190 'hls': buildHLSVODCommand,
191 'hls-from-ts': buildHLSVODFromTSCommand,
192 'merge-audio': buildAudioMergeCommand,
193 'only-audio': buildOnlyAudioCommand,
194 'video': buildx264VODCommand
197 async function transcode (options: TranscodeOptions) {
198 logger.debug('Will run transcode.', { options })
200 let command = getFFmpeg(options.inputPath, 'vod')
201 .output(options.outputPath)
203 command = await builders[options.type](command, options)
205 await runCommand({ command, job: options.job })
207 await fixHLSPlaylistIfNeeded(options)
210 // ---------------------------------------------------------------------------
211 // Live muxing/transcoding functions
212 // ---------------------------------------------------------------------------
214 async function getLiveTranscodingCommand (options: {
217 resolutions: number[]
220 availableEncoders: AvailableEncoders
223 const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
224 const input = rtmpUrl
226 const command = getFFmpeg(input, 'live')
228 const varStreamMap: string[] = []
230 const complexFilter: FilterSpecification[] = [
234 options: resolutions.length,
235 outputs: resolutions.map(r => `vtemp${r}`)
239 command.outputOption('-sc_threshold 0')
241 addDefaultEncoderGlobalParams({ command })
243 for (let i = 0; i < resolutions.length; i++) {
244 const resolution = resolutions[i]
245 const resolutionFPS = computeFPS(fps, resolution)
247 const baseEncoderBuilderParams = {
256 videoType: 'live' as 'live'
260 const streamType: StreamType = 'video'
261 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
262 if (!builderResult) {
263 throw new Error('No available live video encoder found')
266 command.outputOption(`-map [vout${resolution}]`)
268 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
270 logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult)
272 command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
273 applyEncoderOptions(command, builderResult.result)
276 inputs: `vtemp${resolution}`,
277 filter: getScaleFilter(builderResult.result),
278 options: `w=-2:h=${resolution}`,
279 outputs: `vout${resolution}`
284 const streamType: StreamType = 'audio'
285 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
286 if (!builderResult) {
287 throw new Error('No available live audio encoder found')
290 command.outputOption('-map a:0')
292 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
294 logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult)
296 command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
297 applyEncoderOptions(command, builderResult.result)
300 varStreamMap.push(`v:${i},a:${i}`)
303 command.complexFilter(complexFilter)
305 addDefaultLiveHLSParams(command, outPath)
307 command.outputOption('-var_stream_map', varStreamMap.join(' '))
312 function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
313 const command = getFFmpeg(rtmpUrl, 'live')
315 command.outputOption('-c:v copy')
316 command.outputOption('-c:a copy')
317 command.outputOption('-map 0:a?')
318 command.outputOption('-map 0:v?')
320 addDefaultLiveHLSParams(command, outPath)
325 function buildStreamSuffix (base: string, streamNum?: number) {
326 if (streamNum !== undefined) {
327 return `${base}:${streamNum}`
333 // ---------------------------------------------------------------------------
335 // ---------------------------------------------------------------------------
337 function addDefaultEncoderGlobalParams (options: {
338 command: ffmpeg.FfmpegCommand
340 const { command } = options
342 // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
343 command.outputOption('-max_muxing_queue_size 1024')
344 // strip all metadata
345 .outputOption('-map_metadata -1')
346 // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
347 .outputOption('-b_strategy 1')
348 // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
349 .outputOption('-bf 16')
350 // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
351 .outputOption('-pix_fmt yuv420p')
354 function addDefaultEncoderParams (options: {
355 command: ffmpeg.FfmpegCommand
356 encoder: 'libx264' | string
360 const { command, encoder, fps, streamNum } = options
362 if (encoder === 'libx264') {
363 // 3.1 is the minimal resource allocation for our highest supported resolution
364 command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
367 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
368 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
369 // https://superuser.com/a/908325
370 command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
375 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
376 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
377 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
378 command.outputOption('-hls_flags delete_segments+independent_segments')
379 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
380 command.outputOption('-master_pl_name master.m3u8')
381 command.outputOption(`-f hls`)
383 command.output(join(outPath, '%v.m3u8'))
386 // ---------------------------------------------------------------------------
387 // Transcode VOD command builders
388 // ---------------------------------------------------------------------------
390 async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
391 let fps = await getVideoFileFPS(options.inputPath)
392 fps = computeFPS(fps, options.resolution)
394 let scaleFilterValue: string
396 if (options.resolution !== undefined) {
397 scaleFilterValue = options.isPortraitMode === true
398 ? `w=${options.resolution}:h=-2`
399 : `w=-2:h=${options.resolution}`
402 command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue })
407 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
408 command = command.loop(undefined)
410 // Avoid "height not divisible by 2" error
411 const scaleFilterValue = 'trunc(iw/2)*2:trunc(ih/2)*2'
412 command = await presetVideo({ command, input: options.audioPath, transcodeOptions: options, scaleFilterValue })
414 command.outputOption('-preset:v veryfast')
416 command = command.input(options.audioPath)
417 .outputOption('-tune stillimage')
418 .outputOption('-shortest')
423 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
424 command = presetOnlyAudio(command)
429 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
430 command = presetCopy(command)
432 command = command.outputOption('-map_metadata -1') // strip all metadata
433 .outputOption('-movflags faststart')
438 function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPath: string) {
439 return command.outputOption('-hls_time 4')
440 .outputOption('-hls_list_size 0')
441 .outputOption('-hls_playlist_type vod')
442 .outputOption('-hls_segment_filename ' + outputPath)
443 .outputOption('-hls_segment_type fmp4')
444 .outputOption('-f hls')
445 .outputOption('-hls_flags single_file')
448 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
449 const videoPath = getHLSVideoPath(options)
451 if (options.copyCodecs) command = presetCopy(command)
452 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
453 else command = await buildx264VODCommand(command, options)
455 addCommonHLSVODCommandOptions(command, videoPath)
460 async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) {
461 const videoPath = getHLSVideoPath(options)
463 command.outputOption('-c copy')
466 // Required for example when copying an AAC stream from an MPEG-TS
467 // Since it's a bitstream filter, we don't need to reencode the audio
468 command.outputOption('-bsf:a aac_adtstoasc')
471 addCommonHLSVODCommandOptions(command, videoPath)
476 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
477 if (options.type !== 'hls' && options.type !== 'hls-from-ts') return
479 const fileContent = await readFile(options.outputPath)
481 const videoFileName = options.hlsPlaylist.videoFilename
482 const videoFilePath = getHLSVideoPath(options)
484 // Fix wrong mapping with some ffmpeg versions
485 const newContent = fileContent.toString()
486 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
488 await writeFile(options.outputPath, newContent)
491 function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
492 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
495 // ---------------------------------------------------------------------------
496 // Transcoding presets
497 // ---------------------------------------------------------------------------
499 // Run encoder builder depending on available encoders
500 // Try encoders by priority: if the encoder is available, run the chosen profile or fallback to the default one
501 // If the default one does not exist, check the next encoder
502 async function getEncoderBuilderResult (options: {
503 streamType: 'video' | 'audio'
506 availableEncoders: AvailableEncoders
509 videoType: 'vod' | 'live'
515 const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
517 const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
518 const encoders = availableEncoders.available[videoType]
520 for (const encoder of encodersToTry) {
521 if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
522 logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder)
526 if (!encoders[encoder]) {
527 logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder)
531 // An object containing available profiles for this encoder
532 const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder]
533 let builder = builderProfiles[profile]
536 logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
537 builder = builderProfiles.default
540 logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder)
545 const result = await builder({ input, resolution: resolution, fps, streamNum })
550 // If we don't have output options, then copy the input stream
551 encoder: result.copy === true
560 async function presetVideo (options: {
561 command: ffmpeg.FfmpegCommand
563 transcodeOptions: TranscodeOptions
565 scaleFilterValue?: string
567 const { command, input, transcodeOptions, fps, scaleFilterValue } = options
569 let localCommand = command
571 .outputOption('-movflags faststart')
573 addDefaultEncoderGlobalParams({ command })
576 const parsedAudio = await getAudioStream(input)
578 let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
580 if (!parsedAudio.audioStream) {
581 localCommand = localCommand.noAudio()
582 streamsToProcess = [ 'video' ]
585 for (const streamType of streamsToProcess) {
586 const { profile, resolution, availableEncoders } = transcodeOptions
588 const builderResult = await getEncoderBuilderResult({
595 videoType: 'vod' as 'vod'
598 if (!builderResult) {
599 throw new Error('No available encoder found for stream ' + streamType)
603 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
604 builderResult.encoder, streamType, input, profile, builderResult
607 if (streamType === 'video') {
608 localCommand.videoCodec(builderResult.encoder)
610 if (scaleFilterValue) {
611 localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`)
613 } else if (streamType === 'audio') {
614 localCommand.audioCodec(builderResult.encoder)
617 applyEncoderOptions(localCommand, builderResult.result)
618 addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
624 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
631 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
638 function applyEncoderOptions (command: ffmpeg.FfmpegCommand, options: EncoderOptions): ffmpeg.FfmpegCommand {
640 .inputOptions(options.inputOptions ?? [])
641 .outputOptions(options.outputOptions ?? [])
644 function getScaleFilter (options: EncoderOptions): string {
645 if (options.scaleFilter) return options.scaleFilter.name
650 // ---------------------------------------------------------------------------
652 // ---------------------------------------------------------------------------
654 function getFFmpeg (input: string, type: 'live' | 'vod') {
655 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
656 const command = ffmpeg(input, {
657 niceness: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD,
658 cwd: CONFIG.STORAGE.TMP_DIR
661 const threads = type === 'live'
662 ? CONFIG.LIVE.TRANSCODING.THREADS
663 : CONFIG.TRANSCODING.THREADS
666 // If we don't set any threads ffmpeg will chose automatically
667 command.outputOption('-threads ' + threads)
673 function getFFmpegVersion () {
674 return new Promise<string>((res, rej) => {
675 (ffmpeg() as any)._getFfmpegPath((err, ffmpegPath) => {
676 if (err) return rej(err)
677 if (!ffmpegPath) return rej(new Error('Could not find ffmpeg path'))
679 return execPromise(`${ffmpegPath} -version`)
681 const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/)
682 if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`))
684 // Fix ffmpeg version that does not include patch version (4.4 for example)
685 let version = parsed[1]
686 if (version.match(/^\d+\.\d+$/)) {
692 .catch(err => rej(err))
697 async function runCommand (options: {
698 command: ffmpeg.FfmpegCommand
699 silent?: boolean // false
702 const { command, silent = false, job } = options
704 return new Promise<void>((res, rej) => {
705 command.on('error', (err, stdout, stderr) => {
706 if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr })
711 command.on('end', (stdout, stderr) => {
712 logger.debug('FFmpeg command ended.', { stdout, stderr })
718 command.on('progress', progress => {
719 if (!progress.percent) return
721 job.progress(Math.round(progress.percent))
722 .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err }))
730 // ---------------------------------------------------------------------------
733 getLiveTranscodingCommand,
734 getLiveMuxingCommand,
738 generateImageFromVideoFile,
740 TranscodeOptionsType,
745 resetSupportedEncoders,