1 import * as ffmpeg from 'fluent-ffmpeg'
2 import { readFile, remove, writeFile } from 'fs-extra'
3 import { dirname, join } from 'path'
4 import { VideoFileMetadata } from '@shared/models/videos/video-file-metadata'
5 import { getMaxBitrate, getTargetBitrate, VideoResolution } from '../../shared/models/videos'
6 import { checkFFmpegEncoders } from '../initializers/checker-before-init'
7 import { CONFIG } from '../initializers/config'
8 import { FFMPEG_NICE, VIDEO_LIVE, VIDEO_TRANSCODING_FPS } from '../initializers/constants'
9 import { processImage } from './image-utils'
10 import { logger } from './logger'
13 * A toolbox to play with audio
16 export const get = (videoPath: string) => {
17 // without position, ffprobe considers the last input only
18 // we make it consider the first input only
19 // if you pass a file path to pos, then ffprobe acts on that file directly
20 return new Promise<{ absolutePath: string, audioStream?: any }>((res, rej) => {
22 function parseFfprobe (err: any, data: ffmpeg.FfprobeData) {
23 if (err) return rej(err)
25 if ('streams' in data) {
26 const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio')
29 absolutePath: data.format.filename,
35 return res({ absolutePath: data.format.filename })
38 return ffmpeg.ffprobe(videoPath, parseFfprobe)
42 export namespace bitrate {
43 const baseKbitrate = 384
45 const toBits = (kbits: number) => kbits * 8000
47 export const aac = (bitrate: number): number => {
49 case bitrate > toBits(baseKbitrate):
53 return -1 // we interpret it as a signal to copy the audio stream as is
57 export const mp3 = (bitrate: number): number => {
59 a 192kbit/sec mp3 doesn't hold as much information as a 192kbit/sec aac.
60 That's why, when using aac, we can go to lower kbit/sec. The equivalences
61 made here are not made to be accurate, especially with good mp3 encoders.
64 case bitrate <= toBits(192):
67 case bitrate <= toBits(384):
77 function computeResolutionsToTranscode (videoFileResolution: number, type: 'vod' | 'live') {
78 const configResolutions = type === 'vod'
79 ? CONFIG.TRANSCODING.RESOLUTIONS
80 : CONFIG.LIVE.TRANSCODING.RESOLUTIONS
82 const resolutionsEnabled: number[] = []
84 // Put in the order we want to proceed jobs
86 VideoResolution.H_NOVIDEO,
87 VideoResolution.H_480P,
88 VideoResolution.H_360P,
89 VideoResolution.H_720P,
90 VideoResolution.H_240P,
91 VideoResolution.H_1080P,
95 for (const resolution of resolutions) {
96 if (configResolutions[resolution + 'p'] === true && videoFileResolution > resolution) {
97 resolutionsEnabled.push(resolution)
101 return resolutionsEnabled
104 async function getVideoStreamSize (path: string) {
105 const videoStream = await getVideoStreamFromFile(path)
107 return videoStream === null
108 ? { width: 0, height: 0 }
109 : { width: videoStream.width, height: videoStream.height }
112 async function getVideoStreamCodec (path: string) {
113 const videoStream = await getVideoStreamFromFile(path)
115 if (!videoStream) return ''
117 const videoCodec = videoStream.codec_tag_string
119 const baseProfileMatrix = {
125 let baseProfile = baseProfileMatrix[videoStream.profile]
127 logger.warn('Cannot get video profile codec of %s.', path, { videoStream })
128 baseProfile = baseProfileMatrix['High'] // Fallback
131 let level = videoStream.level.toString(16)
132 if (level.length === 1) level = `0${level}`
134 return `${videoCodec}.${baseProfile}${level}`
137 async function getAudioStreamCodec (path: string) {
138 const { audioStream } = await audio.get(path)
140 if (!audioStream) return ''
142 const audioCodec = audioStream.codec_name
143 if (audioCodec === 'aac') return 'mp4a.40.2'
145 logger.warn('Cannot get audio codec of %s.', path, { audioStream })
147 return 'mp4a.40.2' // Fallback
150 async function getVideoFileResolution (path: string) {
151 const size = await getVideoStreamSize(path)
154 videoFileResolution: Math.min(size.height, size.width),
155 isPortraitMode: size.height > size.width
159 async function getVideoFileFPS (path: string) {
160 const videoStream = await getVideoStreamFromFile(path)
161 if (videoStream === null) return 0
163 for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) {
164 const valuesText: string = videoStream[key]
165 if (!valuesText) continue
167 const [ frames, seconds ] = valuesText.split('/')
168 if (!frames || !seconds) continue
170 const result = parseInt(frames, 10) / parseInt(seconds, 10)
171 if (result > 0) return Math.round(result)
177 async function getMetadataFromFile <T> (path: string, cb = metadata => metadata) {
178 return new Promise<T>((res, rej) => {
179 ffmpeg.ffprobe(path, (err, metadata) => {
180 if (err) return rej(err)
182 return res(cb(new VideoFileMetadata(metadata)))
187 async function getVideoFileBitrate (path: string) {
188 return getMetadataFromFile<number>(path, metadata => metadata.format.bit_rate)
191 function getDurationFromVideoFile (path: string) {
192 return getMetadataFromFile<number>(path, metadata => Math.floor(metadata.format.duration))
195 function getVideoStreamFromFile (path: string) {
196 return getMetadataFromFile<any>(path, metadata => metadata.streams.find(s => s.codec_type === 'video') || null)
199 async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
200 const pendingImageName = 'pending-' + imageName
203 filename: pendingImageName,
208 const pendingImagePath = join(folder, pendingImageName)
211 await new Promise<string>((res, rej) => {
212 ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
214 .on('end', () => res(imageName))
218 const destination = join(folder, imageName)
219 await processImage(pendingImagePath, destination, size)
221 logger.error('Cannot generate image from video %s.', fromPath, { err })
224 await remove(pendingImagePath)
226 logger.debug('Cannot remove pending image path after generation error.', { err })
231 type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
233 interface BaseTranscodeOptions {
234 type: TranscodeOptionsType
237 resolution: VideoResolution
238 isPortraitMode?: boolean
241 interface HLSTranscodeOptions extends BaseTranscodeOptions {
245 videoFilename: string
249 interface QuickTranscodeOptions extends BaseTranscodeOptions {
250 type: 'quick-transcode'
253 interface VideoTranscodeOptions extends BaseTranscodeOptions {
257 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
262 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
266 type TranscodeOptions =
268 | VideoTranscodeOptions
269 | MergeAudioTranscodeOptions
270 | OnlyAudioTranscodeOptions
271 | QuickTranscodeOptions
273 function transcode (options: TranscodeOptions) {
274 return new Promise<void>(async (res, rej) => {
276 let command = getFFmpeg(options.inputPath)
277 .output(options.outputPath)
279 if (options.type === 'quick-transcode') {
280 command = buildQuickTranscodeCommand(command)
281 } else if (options.type === 'hls') {
282 command = await buildHLSVODCommand(command, options)
283 } else if (options.type === 'merge-audio') {
284 command = await buildAudioMergeCommand(command, options)
285 } else if (options.type === 'only-audio') {
286 command = buildOnlyAudioCommand(command, options)
288 command = await buildx264Command(command, options)
292 .on('error', (err, stdout, stderr) => {
293 logger.error('Error in transcoding job.', { stdout, stderr })
297 return fixHLSPlaylistIfNeeded(options)
299 .catch(err => rej(err))
308 async function canDoQuickTranscode (path: string): Promise<boolean> {
309 // NOTE: This could be optimized by running ffprobe only once (but it runs fast anyway)
310 const videoStream = await getVideoStreamFromFile(path)
311 const parsedAudio = await audio.get(path)
312 const fps = await getVideoFileFPS(path)
313 const bitRate = await getVideoFileBitrate(path)
314 const resolution = await getVideoFileResolution(path)
316 // check video params
317 if (videoStream == null) return false
318 if (videoStream['codec_name'] !== 'h264') return false
319 if (videoStream['pix_fmt'] !== 'yuv420p') return false
320 if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) return false
321 if (bitRate > getMaxBitrate(resolution.videoFileResolution, fps, VIDEO_TRANSCODING_FPS)) return false
323 // check audio params (if audio stream exists)
324 if (parsedAudio.audioStream) {
325 if (parsedAudio.audioStream['codec_name'] !== 'aac') return false
327 const maxAudioBitrate = audio.bitrate['aac'](parsedAudio.audioStream['bit_rate'])
328 if (maxAudioBitrate !== -1 && parsedAudio.audioStream['bit_rate'] > maxAudioBitrate) return false
334 function getClosestFramerateStandard (fps: number, type: 'HD_STANDARD' | 'STANDARD'): number {
335 return VIDEO_TRANSCODING_FPS[type].slice(0)
336 .sort((a, b) => fps % a - fps % b)[0]
339 function convertWebPToJPG (path: string, destination: string): Promise<void> {
340 return new Promise<void>(async (res, rej) => {
342 const command = ffmpeg(path).output(destination)
344 command.on('error', (err, stdout, stderr) => {
345 logger.error('Error in ffmpeg webp convert process.', { stdout, stderr })
348 .on('end', () => res())
356 function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: number[], deleteSegments: boolean) {
357 const command = getFFmpeg(rtmpUrl)
358 command.inputOption('-fflags nobuffer')
360 const varStreamMap: string[] = []
362 command.complexFilter([
366 options: resolutions.length,
367 outputs: resolutions.map(r => `vtemp${r}`)
370 ...resolutions.map(r => ({
373 options: `w=-2:h=${r}`,
378 const liveFPS = VIDEO_TRANSCODING_FPS.AVERAGE
380 command.withFps(liveFPS)
382 command.outputOption('-b_strategy 1')
383 command.outputOption('-bf 16')
384 command.outputOption('-preset superfast')
385 command.outputOption('-level 3.1')
386 command.outputOption('-map_metadata -1')
387 command.outputOption('-pix_fmt yuv420p')
389 for (let i = 0; i < resolutions.length; i++) {
390 const resolution = resolutions[i]
392 command.outputOption(`-map [vout${resolution}]`)
393 command.outputOption(`-c:v:${i} libx264`)
394 command.outputOption(`-b:v:${i} ${getTargetBitrate(resolution, liveFPS, VIDEO_TRANSCODING_FPS)}`)
396 command.outputOption(`-map a:0`)
397 command.outputOption(`-c:a:${i} aac`)
399 varStreamMap.push(`v:${i},a:${i}`)
402 addDefaultLiveHLSParams(command, outPath, deleteSegments)
404 command.outputOption('-var_stream_map', varStreamMap.join(' '))
411 function runLiveMuxing (rtmpUrl: string, outPath: string, deleteSegments: boolean) {
412 const command = getFFmpeg(rtmpUrl)
413 command.inputOption('-fflags nobuffer')
415 command.outputOption('-c:v copy')
416 command.outputOption('-c:a copy')
417 command.outputOption('-map 0:a?')
418 command.outputOption('-map 0:v?')
420 addDefaultLiveHLSParams(command, outPath, deleteSegments)
427 // ---------------------------------------------------------------------------
435 getVideoFileResolution,
437 getDurationFromVideoFile,
439 generateImageFromVideoFile,
441 TranscodeOptionsType,
444 computeResolutionsToTranscode,
450 // ---------------------------------------------------------------------------
452 function addDefaultX264Params (command: ffmpeg.FfmpegCommand) {
453 command.outputOption('-level 3.1') // 3.1 is the minimal resource allocation for our highest supported resolution
454 .outputOption('-b_strategy 1') // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
455 .outputOption('-bf 16') // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
456 .outputOption('-pix_fmt yuv420p') // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
457 .outputOption('-map_metadata -1') // strip all metadata
460 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) {
461 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME)
462 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
464 if (deleteSegments === true) {
465 command.outputOption('-hls_flags delete_segments')
468 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%d.ts')}`)
469 command.outputOption('-master_pl_name master.m3u8')
470 command.outputOption(`-f hls`)
472 command.output(join(outPath, '%v.m3u8'))
475 async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
476 let fps = await getVideoFileFPS(options.inputPath)
478 // On small/medium resolutions, limit FPS
479 options.resolution !== undefined &&
480 options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
481 fps > VIDEO_TRANSCODING_FPS.AVERAGE
483 // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value
484 fps = getClosestFramerateStandard(fps, 'STANDARD')
487 command = await presetH264(command, options.inputPath, options.resolution, fps)
489 if (options.resolution !== undefined) {
490 // '?x720' or '720x?' for example
491 const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}`
492 command = command.size(size)
497 if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = getClosestFramerateStandard(fps, 'HD_STANDARD')
498 else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN
500 command = command.withFPS(fps)
506 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
507 command = command.loop(undefined)
509 command = await presetH264VeryFast(command, options.audioPath, options.resolution)
511 command = command.input(options.audioPath)
512 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
513 .outputOption('-tune stillimage')
514 .outputOption('-shortest')
519 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, options: OnlyAudioTranscodeOptions) {
520 command = presetOnlyAudio(command)
525 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
526 command = presetCopy(command)
528 command = command.outputOption('-map_metadata -1') // strip all metadata
529 .outputOption('-movflags faststart')
534 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
535 const videoPath = getHLSVideoPath(options)
537 if (options.copyCodecs) command = presetCopy(command)
538 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
539 else command = await buildx264Command(command, options)
541 command = command.outputOption('-hls_time 4')
542 .outputOption('-hls_list_size 0')
543 .outputOption('-hls_playlist_type vod')
544 .outputOption('-hls_segment_filename ' + videoPath)
545 .outputOption('-hls_segment_type fmp4')
546 .outputOption('-f hls')
547 .outputOption('-hls_flags single_file')
552 function getHLSVideoPath (options: HLSTranscodeOptions) {
553 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
556 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
557 if (options.type !== 'hls') return
559 const fileContent = await readFile(options.outputPath)
561 const videoFileName = options.hlsPlaylist.videoFilename
562 const videoFilePath = getHLSVideoPath(options)
564 // Fix wrong mapping with some ffmpeg versions
565 const newContent = fileContent.toString()
566 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
568 await writeFile(options.outputPath, newContent)
572 * A slightly customised version of the 'veryfast' x264 preset
574 * The veryfast preset is right in the sweet spot of performance
575 * and quality. Superfast and ultrafast will give you better
576 * performance, but then quality is noticeably worse.
578 async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
579 let localCommand = await presetH264(command, input, resolution, fps)
581 localCommand = localCommand.outputOption('-preset:v veryfast')
584 MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html
585 Our target situation is closer to a livestream than a stream,
586 since we want to reduce as much a possible the encoding burden,
587 although not to the point of a livestream where there is a hard
588 constraint on the frames per second to be encoded.
595 * Standard profile, with variable bitrate audio and faststart.
597 * As for the audio, quality '5' is the highest and ensures 96-112kbps/channel
598 * See https://trac.ffmpeg.org/wiki/Encode/AAC#fdk_vbr
600 async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
601 let localCommand = command
603 .videoCodec('libx264')
604 .outputOption('-movflags faststart')
606 addDefaultX264Params(localCommand)
608 const parsedAudio = await audio.get(input)
610 if (!parsedAudio.audioStream) {
611 localCommand = localCommand.noAudio()
612 } else if ((await checkFFmpegEncoders()).get('libfdk_aac')) { // we favor VBR, if a good AAC encoder is available
613 localCommand = localCommand
614 .audioCodec('libfdk_aac')
617 // we try to reduce the ceiling bitrate by making rough matches of bitrates
618 // of course this is far from perfect, but it might save some space in the end
619 localCommand = localCommand.audioCodec('aac')
621 const audioCodecName = parsedAudio.audioStream['codec_name']
623 if (audio.bitrate[audioCodecName]) {
624 const bitrate = audio.bitrate[audioCodecName](parsedAudio.audioStream['bit_rate'])
625 if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate)
630 // Constrained Encoding (VBV)
631 // https://slhck.info/video/2017/03/01/rate-control.html
632 // https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate
633 const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)
634 localCommand = localCommand.outputOptions([ `-maxrate ${targetBitrate}`, `-bufsize ${targetBitrate * 2}` ])
636 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
637 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
638 // https://superuser.com/a/908325
639 localCommand = localCommand.outputOption(`-g ${fps * 2}`)
645 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
652 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
659 function getFFmpeg (input: string) {
660 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
661 const command = ffmpeg(input, { niceness: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR })
663 if (CONFIG.TRANSCODING.THREADS > 0) {
664 // If we don't set any threads ffmpeg will chose automatically
665 command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)