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' | '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 QuickTranscodeOptions extends BaseTranscodeOptions {
138 type: 'quick-transcode'
141 interface VideoTranscodeOptions extends BaseTranscodeOptions {
145 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
150 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
154 type TranscodeOptions =
156 | VideoTranscodeOptions
157 | MergeAudioTranscodeOptions
158 | OnlyAudioTranscodeOptions
159 | QuickTranscodeOptions
162 [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise<ffmpeg.FfmpegCommand> | ffmpeg.FfmpegCommand
164 'quick-transcode': buildQuickTranscodeCommand,
165 'hls': buildHLSVODCommand,
166 'merge-audio': buildAudioMergeCommand,
167 'only-audio': buildOnlyAudioCommand,
168 'video': buildx264VODCommand
171 async function transcode (options: TranscodeOptions) {
172 logger.debug('Will run transcode.', { options })
174 let command = getFFmpeg(options.inputPath)
175 .output(options.outputPath)
177 command = await builders[options.type](command, options)
179 await runCommand(command)
181 await fixHLSPlaylistIfNeeded(options)
184 // ---------------------------------------------------------------------------
185 // Live muxing/transcoding functions
186 // ---------------------------------------------------------------------------
188 async function getLiveTranscodingCommand (options: {
191 resolutions: number[]
193 deleteSegments: boolean
195 availableEncoders: AvailableEncoders
198 const { rtmpUrl, outPath, resolutions, fps, deleteSegments, availableEncoders, profile } = options
199 const input = rtmpUrl
201 const command = getFFmpeg(input)
202 command.inputOption('-fflags nobuffer')
204 const varStreamMap: string[] = []
206 command.complexFilter([
210 options: resolutions.length,
211 outputs: resolutions.map(r => `vtemp${r}`)
214 ...resolutions.map(r => ({
217 options: `w=-2:h=${r}`,
222 command.outputOption('-preset superfast')
224 addDefaultEncoderGlobalParams({ command })
226 for (let i = 0; i < resolutions.length; i++) {
227 const resolution = resolutions[i]
228 const resolutionFPS = computeFPS(fps, resolution)
230 const baseEncoderBuilderParams = {
237 videoType: 'live' as 'live'
241 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' }))
242 if (!builderResult) {
243 throw new Error('No available live video encoder found')
246 command.outputOption(`-map [vout${resolution}]`)
248 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
250 logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult)
252 command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
253 command.addOutputOptions(builderResult.result.outputOptions)
257 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' }))
258 if (!builderResult) {
259 throw new Error('No available live audio encoder found')
262 command.outputOption('-map a:0')
264 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
266 logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult)
268 command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
269 command.addOutputOptions(builderResult.result.outputOptions)
272 varStreamMap.push(`v:${i},a:${i}`)
275 addDefaultLiveHLSParams(command, outPath, deleteSegments)
277 command.outputOption('-var_stream_map', varStreamMap.join(' '))
282 function getLiveMuxingCommand (rtmpUrl: string, outPath: string, deleteSegments: boolean) {
283 const command = getFFmpeg(rtmpUrl)
284 command.inputOption('-fflags nobuffer')
286 command.outputOption('-c:v copy')
287 command.outputOption('-c:a copy')
288 command.outputOption('-map 0:a?')
289 command.outputOption('-map 0:v?')
291 addDefaultLiveHLSParams(command, outPath, deleteSegments)
296 async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: string[], outputPath: string) {
297 const concatFilePath = join(hlsDirectory, 'concat.txt')
299 function cleaner () {
300 remove(concatFilePath)
301 .catch(err => logger.error('Cannot remove concat file in %s.', hlsDirectory, { err }))
304 // First concat the ts files to a mp4 file
305 const content = segmentFiles.map(f => 'file ' + f)
308 await writeFile(concatFilePath, content + '\n')
310 const command = getFFmpeg(concatFilePath)
311 command.inputOption('-safe 0')
312 command.inputOption('-f concat')
314 command.outputOption('-c:v copy')
315 command.audioFilter('aresample=async=1:first_pts=0')
316 command.output(outputPath)
318 return runCommand(command, cleaner)
321 function buildStreamSuffix (base: string, streamNum?: number) {
322 if (streamNum !== undefined) {
323 return `${base}:${streamNum}`
329 // ---------------------------------------------------------------------------
332 getLiveTranscodingCommand,
333 getLiveMuxingCommand,
337 generateImageFromVideoFile,
339 TranscodeOptionsType,
341 hlsPlaylistToFragmentedMP4
344 // ---------------------------------------------------------------------------
346 // ---------------------------------------------------------------------------
348 // ---------------------------------------------------------------------------
350 function addDefaultEncoderGlobalParams (options: {
351 command: ffmpeg.FfmpegCommand
353 const { command } = options
355 // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
356 command.outputOption('-max_muxing_queue_size 1024')
357 // strip all metadata
358 .outputOption('-map_metadata -1')
359 // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
360 .outputOption('-b_strategy 1')
361 // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
362 .outputOption('-bf 16')
363 // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
364 .outputOption('-pix_fmt yuv420p')
367 function addDefaultEncoderParams (options: {
368 command: ffmpeg.FfmpegCommand
369 encoder: 'libx264' | string
373 const { command, encoder, fps, streamNum } = options
375 if (encoder === 'libx264') {
376 // 3.1 is the minimal resource allocation for our highest supported resolution
377 command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
380 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
381 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
382 // https://superuser.com/a/908325
383 command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
388 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) {
389 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
390 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
392 if (deleteSegments === true) {
393 command.outputOption('-hls_flags delete_segments')
396 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
397 command.outputOption('-master_pl_name master.m3u8')
398 command.outputOption(`-f hls`)
400 command.output(join(outPath, '%v.m3u8'))
403 // ---------------------------------------------------------------------------
404 // Transcode VOD command builders
405 // ---------------------------------------------------------------------------
407 async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
408 let fps = await getVideoFileFPS(options.inputPath)
409 fps = computeFPS(fps, options.resolution)
411 command = await presetVideo(command, options.inputPath, options, fps)
413 if (options.resolution !== undefined) {
414 // '?x720' or '720x?' for example
415 const size = options.isPortraitMode === true
416 ? `${options.resolution}x?`
417 : `?x${options.resolution}`
419 command = command.size(size)
425 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
426 command = command.loop(undefined)
428 command = await presetVideo(command, options.audioPath, options)
430 command.outputOption('-preset:v veryfast')
432 command = command.input(options.audioPath)
433 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
434 .outputOption('-tune stillimage')
435 .outputOption('-shortest')
440 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
441 command = presetOnlyAudio(command)
446 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
447 command = presetCopy(command)
449 command = command.outputOption('-map_metadata -1') // strip all metadata
450 .outputOption('-movflags faststart')
455 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
456 const videoPath = getHLSVideoPath(options)
458 if (options.copyCodecs) command = presetCopy(command)
459 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
460 else command = await buildx264VODCommand(command, options)
462 command = command.outputOption('-hls_time 4')
463 .outputOption('-hls_list_size 0')
464 .outputOption('-hls_playlist_type vod')
465 .outputOption('-hls_segment_filename ' + videoPath)
466 .outputOption('-hls_segment_type fmp4')
467 .outputOption('-f hls')
468 .outputOption('-hls_flags single_file')
473 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
474 if (options.type !== 'hls') return
476 const fileContent = await readFile(options.outputPath)
478 const videoFileName = options.hlsPlaylist.videoFilename
479 const videoFilePath = getHLSVideoPath(options)
481 // Fix wrong mapping with some ffmpeg versions
482 const newContent = fileContent.toString()
483 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
485 await writeFile(options.outputPath, newContent)
488 function getHLSVideoPath (options: HLSTranscodeOptions) {
489 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
492 // ---------------------------------------------------------------------------
493 // Transcoding presets
494 // ---------------------------------------------------------------------------
496 async function getEncoderBuilderResult (options: {
500 availableEncoders: AvailableEncoders
503 videoType: 'vod' | 'live'
509 const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
511 const encodersToTry: string[] = VIDEO_TRANSCODING_ENCODERS[streamType]
513 for (const encoder of encodersToTry) {
514 if (!(await checkFFmpegEncoders()).get(encoder) || !availableEncoders[videoType][encoder]) continue
516 const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = availableEncoders[videoType][encoder]
517 let builder = builderProfiles[profile]
520 logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
521 builder = builderProfiles.default
524 const result = await builder({ input, resolution: resolution, fps, streamNum })
529 // If we don't have output options, then copy the input stream
530 encoder: result.copy === true
539 async function presetVideo (
540 command: ffmpeg.FfmpegCommand,
542 transcodeOptions: TranscodeOptions,
545 let localCommand = command
547 .outputOption('-movflags faststart')
549 addDefaultEncoderGlobalParams({ command })
552 const parsedAudio = await getAudioStream(input)
554 let streamsToProcess = [ 'AUDIO', 'VIDEO' ]
556 if (!parsedAudio.audioStream) {
557 localCommand = localCommand.noAudio()
558 streamsToProcess = [ 'VIDEO' ]
561 for (const streamType of streamsToProcess) {
562 const { profile, resolution, availableEncoders } = transcodeOptions
564 const builderResult = await getEncoderBuilderResult({
571 videoType: 'vod' as 'vod'
574 if (!builderResult) {
575 throw new Error('No available encoder found for stream ' + streamType)
578 logger.debug('Apply ffmpeg params from %s.', builderResult.encoder, builderResult)
580 if (streamType === 'VIDEO') {
581 localCommand.videoCodec(builderResult.encoder)
582 } else if (streamType === 'AUDIO') {
583 localCommand.audioCodec(builderResult.encoder)
586 command.addOutputOptions(builderResult.result.outputOptions)
587 addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
593 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
600 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
607 // ---------------------------------------------------------------------------
609 // ---------------------------------------------------------------------------
611 function getFFmpeg (input: string) {
612 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
613 const command = ffmpeg(input, { niceness: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR })
615 if (CONFIG.TRANSCODING.THREADS > 0) {
616 // If we don't set any threads ffmpeg will chose automatically
617 command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)
623 async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) {
624 return new Promise<void>((res, rej) => {
625 command.on('error', (err, stdout, stderr) => {
628 logger.error('Error in transcoding job.', { stdout, stderr })
632 command.on('end', () => {