1 import * as ffmpeg from 'fluent-ffmpeg'
2 import { readFile, remove, writeFile } from 'fs-extra'
3 import { dirname, join } from 'path'
4 import { FFMPEG_NICE, VIDEO_LIVE, VIDEO_TRANSCODING_ENCODERS } from '@server/initializers/constants'
5 import { VideoResolution } from '../../shared/models/videos'
6 import { checkFFmpegEncoders } from '../initializers/checker-before-init'
7 import { CONFIG } from '../initializers/config'
8 import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
9 import { processImage } from './image-utils'
10 import { logger } from './logger'
14 * Functions that run transcoding/muxing ffmpeg processes
15 * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
19 // ---------------------------------------------------------------------------
21 // ---------------------------------------------------------------------------
25 export type EncoderOptionsBuilder = (params: {
27 resolution: VideoResolution
30 }) => Promise<EncoderOptions> | EncoderOptions
34 export interface EncoderOptions {
36 outputOptions: string[]
41 export interface EncoderProfile <T> {
42 [ profile: string ]: T
47 export type AvailableEncoders = {
48 [ id in 'live' | 'vod' ]: {
49 [ encoder in 'libx264' | 'aac' | 'libfdk_aac' ]?: EncoderProfile<EncoderOptionsBuilder>
53 // ---------------------------------------------------------------------------
55 // ---------------------------------------------------------------------------
57 function convertWebPToJPG (path: string, destination: string): Promise<void> {
58 const command = ffmpeg(path)
61 return runCommand(command)
67 newSize: { width: number, height: number }
69 const command = ffmpeg(path)
71 .size(`${newSize.width}x${newSize.height}`)
74 return runCommand(command)
77 async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
78 const pendingImageName = 'pending-' + imageName
81 filename: pendingImageName,
86 const pendingImagePath = join(folder, pendingImageName)
89 await new Promise<string>((res, rej) => {
90 ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
92 .on('end', () => res(imageName))
96 const destination = join(folder, imageName)
97 await processImage(pendingImagePath, destination, size)
99 logger.error('Cannot generate image from video %s.', fromPath, { err })
102 await remove(pendingImagePath)
104 logger.debug('Cannot remove pending image path after generation error.', { err })
109 // ---------------------------------------------------------------------------
110 // Transcode meta function
111 // ---------------------------------------------------------------------------
113 type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
115 interface BaseTranscodeOptions {
116 type: TranscodeOptionsType
121 availableEncoders: AvailableEncoders
124 resolution: VideoResolution
126 isPortraitMode?: boolean
129 interface HLSTranscodeOptions extends BaseTranscodeOptions {
133 videoFilename: string
137 interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions {
141 videoFilename: string
145 interface QuickTranscodeOptions extends BaseTranscodeOptions {
146 type: 'quick-transcode'
149 interface VideoTranscodeOptions extends BaseTranscodeOptions {
153 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
158 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
162 type TranscodeOptions =
164 | HLSFromTSTranscodeOptions
165 | VideoTranscodeOptions
166 | MergeAudioTranscodeOptions
167 | OnlyAudioTranscodeOptions
168 | QuickTranscodeOptions
171 [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise<ffmpeg.FfmpegCommand> | ffmpeg.FfmpegCommand
173 'quick-transcode': buildQuickTranscodeCommand,
174 'hls': buildHLSVODCommand,
175 'hls-from-ts': buildHLSVODFromTSCommand,
176 'merge-audio': buildAudioMergeCommand,
177 'only-audio': buildOnlyAudioCommand,
178 'video': buildx264VODCommand
181 async function transcode (options: TranscodeOptions) {
182 logger.debug('Will run transcode.', { options })
184 let command = getFFmpeg(options.inputPath, 'vod')
185 .output(options.outputPath)
187 command = await builders[options.type](command, options)
189 await runCommand(command)
191 await fixHLSPlaylistIfNeeded(options)
194 // ---------------------------------------------------------------------------
195 // Live muxing/transcoding functions
196 // ---------------------------------------------------------------------------
198 async function getLiveTranscodingCommand (options: {
201 resolutions: number[]
204 availableEncoders: AvailableEncoders
207 const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
208 const input = rtmpUrl
210 const command = getFFmpeg(input, 'live')
212 const varStreamMap: string[] = []
214 command.complexFilter([
218 options: resolutions.length,
219 outputs: resolutions.map(r => `vtemp${r}`)
222 ...resolutions.map(r => ({
225 options: `w=-2:h=${r}`,
230 command.outputOption('-preset superfast')
231 command.outputOption('-sc_threshold 0')
233 addDefaultEncoderGlobalParams({ command })
235 for (let i = 0; i < resolutions.length; i++) {
236 const resolution = resolutions[i]
237 const resolutionFPS = computeFPS(fps, resolution)
239 const baseEncoderBuilderParams = {
246 videoType: 'live' as 'live'
250 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' }))
251 if (!builderResult) {
252 throw new Error('No available live video encoder found')
255 command.outputOption(`-map [vout${resolution}]`)
257 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
259 logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult)
261 command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
262 command.addOutputOptions(builderResult.result.outputOptions)
266 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' }))
267 if (!builderResult) {
268 throw new Error('No available live audio encoder found')
271 command.outputOption('-map a:0')
273 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
275 logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult)
277 command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
278 command.addOutputOptions(builderResult.result.outputOptions)
281 varStreamMap.push(`v:${i},a:${i}`)
284 addDefaultLiveHLSParams(command, outPath)
286 command.outputOption('-var_stream_map', varStreamMap.join(' '))
291 function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
292 const command = getFFmpeg(rtmpUrl, 'live')
294 command.outputOption('-c:v copy')
295 command.outputOption('-c:a copy')
296 command.outputOption('-map 0:a?')
297 command.outputOption('-map 0:v?')
299 addDefaultLiveHLSParams(command, outPath)
304 function buildStreamSuffix (base: string, streamNum?: number) {
305 if (streamNum !== undefined) {
306 return `${base}:${streamNum}`
312 // ---------------------------------------------------------------------------
315 getLiveTranscodingCommand,
316 getLiveMuxingCommand,
320 generateImageFromVideoFile,
322 TranscodeOptionsType,
326 // ---------------------------------------------------------------------------
328 // ---------------------------------------------------------------------------
330 // ---------------------------------------------------------------------------
332 function addDefaultEncoderGlobalParams (options: {
333 command: ffmpeg.FfmpegCommand
335 const { command } = options
337 // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
338 command.outputOption('-max_muxing_queue_size 1024')
339 // strip all metadata
340 .outputOption('-map_metadata -1')
341 // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
342 .outputOption('-b_strategy 1')
343 // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
344 .outputOption('-bf 16')
345 // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
346 .outputOption('-pix_fmt yuv420p')
349 function addDefaultEncoderParams (options: {
350 command: ffmpeg.FfmpegCommand
351 encoder: 'libx264' | string
355 const { command, encoder, fps, streamNum } = options
357 if (encoder === 'libx264') {
358 // 3.1 is the minimal resource allocation for our highest supported resolution
359 command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
362 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
363 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
364 // https://superuser.com/a/908325
365 command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
370 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
371 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
372 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
373 command.outputOption('-hls_flags delete_segments+independent_segments')
374 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
375 command.outputOption('-master_pl_name master.m3u8')
376 command.outputOption(`-f hls`)
378 command.output(join(outPath, '%v.m3u8'))
381 // ---------------------------------------------------------------------------
382 // Transcode VOD command builders
383 // ---------------------------------------------------------------------------
385 async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
386 let fps = await getVideoFileFPS(options.inputPath)
387 fps = computeFPS(fps, options.resolution)
389 command = await presetVideo(command, options.inputPath, options, fps)
391 if (options.resolution !== undefined) {
392 // '?x720' or '720x?' for example
393 const size = options.isPortraitMode === true
394 ? `${options.resolution}x?`
395 : `?x${options.resolution}`
397 command = command.size(size)
403 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
404 command = command.loop(undefined)
406 command = await presetVideo(command, options.audioPath, options)
408 command.outputOption('-preset:v veryfast')
410 command = command.input(options.audioPath)
411 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
412 .outputOption('-tune stillimage')
413 .outputOption('-shortest')
418 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
419 command = presetOnlyAudio(command)
424 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
425 command = presetCopy(command)
427 command = command.outputOption('-map_metadata -1') // strip all metadata
428 .outputOption('-movflags faststart')
433 function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPath: string) {
434 return command.outputOption('-hls_time 4')
435 .outputOption('-hls_list_size 0')
436 .outputOption('-hls_playlist_type vod')
437 .outputOption('-hls_segment_filename ' + outputPath)
438 .outputOption('-hls_segment_type fmp4')
439 .outputOption('-f hls')
440 .outputOption('-hls_flags single_file')
443 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
444 const videoPath = getHLSVideoPath(options)
446 if (options.copyCodecs) command = presetCopy(command)
447 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
448 else command = await buildx264VODCommand(command, options)
450 addCommonHLSVODCommandOptions(command, videoPath)
455 async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) {
456 const videoPath = getHLSVideoPath(options)
458 command.outputOption('-c copy')
459 // Required for example when copying an AAC stream from an MPEG-TS
460 // Since it's a bitstream filter, we don't need to reencode the audio
461 command.outputOption('-bsf:a aac_adtstoasc')
463 addCommonHLSVODCommandOptions(command, videoPath)
468 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
469 if (options.type !== 'hls' && options.type !== 'hls-from-ts') return
471 const fileContent = await readFile(options.outputPath)
473 const videoFileName = options.hlsPlaylist.videoFilename
474 const videoFilePath = getHLSVideoPath(options)
476 // Fix wrong mapping with some ffmpeg versions
477 const newContent = fileContent.toString()
478 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
480 await writeFile(options.outputPath, newContent)
483 function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
484 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
487 // ---------------------------------------------------------------------------
488 // Transcoding presets
489 // ---------------------------------------------------------------------------
491 async function getEncoderBuilderResult (options: {
495 availableEncoders: AvailableEncoders
498 videoType: 'vod' | 'live'
504 const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
506 const encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[streamType]
508 for (const encoder of encodersToTry) {
509 if (!(await checkFFmpegEncoders()).get(encoder) || !availableEncoders[videoType][encoder]) continue
511 const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = availableEncoders[videoType][encoder]
512 let builder = builderProfiles[profile]
515 logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
516 builder = builderProfiles.default
519 const result = await builder({ input, resolution: resolution, fps, streamNum })
524 // If we don't have output options, then copy the input stream
525 encoder: result.copy === true
534 async function presetVideo (
535 command: ffmpeg.FfmpegCommand,
537 transcodeOptions: TranscodeOptions,
540 let localCommand = command
542 .outputOption('-movflags faststart')
544 addDefaultEncoderGlobalParams({ command })
547 const parsedAudio = await getAudioStream(input)
549 let streamsToProcess = [ 'AUDIO', 'VIDEO' ]
551 if (!parsedAudio.audioStream) {
552 localCommand = localCommand.noAudio()
553 streamsToProcess = [ 'VIDEO' ]
556 for (const streamType of streamsToProcess) {
557 const { profile, resolution, availableEncoders } = transcodeOptions
559 const builderResult = await getEncoderBuilderResult({
566 videoType: 'vod' as 'vod'
569 if (!builderResult) {
570 throw new Error('No available encoder found for stream ' + streamType)
573 logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult)
575 if (streamType === 'VIDEO') {
576 localCommand.videoCodec(builderResult.encoder)
577 } else if (streamType === 'AUDIO') {
578 localCommand.audioCodec(builderResult.encoder)
581 command.addOutputOptions(builderResult.result.outputOptions)
582 addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
588 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
595 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
602 // ---------------------------------------------------------------------------
604 // ---------------------------------------------------------------------------
606 function getFFmpeg (input: string, type: 'live' | 'vod') {
607 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
608 const command = ffmpeg(input, { niceness: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR })
610 const threads = type === 'live'
611 ? CONFIG.LIVE.TRANSCODING.THREADS
612 : CONFIG.TRANSCODING.THREADS
615 // If we don't set any threads ffmpeg will chose automatically
616 command.outputOption('-threads ' + threads)
622 async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) {
623 return new Promise<void>((res, rej) => {
624 command.on('error', (err, stdout, stderr) => {
627 logger.error('Error in transcoding job.', { stdout, stderr })
631 command.on('end', () => {