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'
11 import { concat } from 'lodash'
14 * A toolbox to play with audio
17 export const get = (videoPath: string) => {
18 // without position, ffprobe considers the last input only
19 // we make it consider the first input only
20 // if you pass a file path to pos, then ffprobe acts on that file directly
21 return new Promise<{ absolutePath: string, audioStream?: any }>((res, rej) => {
23 function parseFfprobe (err: any, data: ffmpeg.FfprobeData) {
24 if (err) return rej(err)
26 if ('streams' in data) {
27 const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio')
30 absolutePath: data.format.filename,
36 return res({ absolutePath: data.format.filename })
39 return ffmpeg.ffprobe(videoPath, parseFfprobe)
43 export namespace bitrate {
44 const baseKbitrate = 384
46 const toBits = (kbits: number) => kbits * 8000
48 export const aac = (bitrate: number): number => {
50 case bitrate > toBits(baseKbitrate):
54 return -1 // we interpret it as a signal to copy the audio stream as is
58 export const mp3 = (bitrate: number): number => {
60 a 192kbit/sec mp3 doesn't hold as much information as a 192kbit/sec aac.
61 That's why, when using aac, we can go to lower kbit/sec. The equivalences
62 made here are not made to be accurate, especially with good mp3 encoders.
65 case bitrate <= toBits(192):
68 case bitrate <= toBits(384):
78 function computeResolutionsToTranscode (videoFileResolution: number, type: 'vod' | 'live') {
79 const configResolutions = type === 'vod'
80 ? CONFIG.TRANSCODING.RESOLUTIONS
81 : CONFIG.LIVE.TRANSCODING.RESOLUTIONS
83 const resolutionsEnabled: number[] = []
85 // Put in the order we want to proceed jobs
87 VideoResolution.H_NOVIDEO,
88 VideoResolution.H_480P,
89 VideoResolution.H_360P,
90 VideoResolution.H_720P,
91 VideoResolution.H_240P,
92 VideoResolution.H_1080P,
96 for (const resolution of resolutions) {
97 if (configResolutions[resolution + 'p'] === true && videoFileResolution > resolution) {
98 resolutionsEnabled.push(resolution)
102 return resolutionsEnabled
105 async function getVideoStreamSize (path: string) {
106 const videoStream = await getVideoStreamFromFile(path)
108 return videoStream === null
109 ? { width: 0, height: 0 }
110 : { width: videoStream.width, height: videoStream.height }
113 async function getVideoStreamCodec (path: string) {
114 const videoStream = await getVideoStreamFromFile(path)
116 if (!videoStream) return ''
118 const videoCodec = videoStream.codec_tag_string
120 const baseProfileMatrix = {
126 let baseProfile = baseProfileMatrix[videoStream.profile]
128 logger.warn('Cannot get video profile codec of %s.', path, { videoStream })
129 baseProfile = baseProfileMatrix['High'] // Fallback
132 let level = videoStream.level.toString(16)
133 if (level.length === 1) level = `0${level}`
135 return `${videoCodec}.${baseProfile}${level}`
138 async function getAudioStreamCodec (path: string) {
139 const { audioStream } = await audio.get(path)
141 if (!audioStream) return ''
143 const audioCodec = audioStream.codec_name
144 if (audioCodec === 'aac') return 'mp4a.40.2'
146 logger.warn('Cannot get audio codec of %s.', path, { audioStream })
148 return 'mp4a.40.2' // Fallback
151 async function getVideoFileResolution (path: string) {
152 const size = await getVideoStreamSize(path)
155 videoFileResolution: Math.min(size.height, size.width),
156 isPortraitMode: size.height > size.width
160 async function getVideoFileFPS (path: string) {
161 const videoStream = await getVideoStreamFromFile(path)
162 if (videoStream === null) return 0
164 for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) {
165 const valuesText: string = videoStream[key]
166 if (!valuesText) continue
168 const [ frames, seconds ] = valuesText.split('/')
169 if (!frames || !seconds) continue
171 const result = parseInt(frames, 10) / parseInt(seconds, 10)
172 if (result > 0) return Math.round(result)
178 async function getMetadataFromFile <T> (path: string, cb = metadata => metadata) {
179 return new Promise<T>((res, rej) => {
180 ffmpeg.ffprobe(path, (err, metadata) => {
181 if (err) return rej(err)
183 return res(cb(new VideoFileMetadata(metadata)))
188 async function getVideoFileBitrate (path: string) {
189 return getMetadataFromFile<number>(path, metadata => metadata.format.bit_rate)
192 function getDurationFromVideoFile (path: string) {
193 return getMetadataFromFile<number>(path, metadata => Math.floor(metadata.format.duration))
196 function getVideoStreamFromFile (path: string) {
197 return getMetadataFromFile<any>(path, metadata => metadata.streams.find(s => s.codec_type === 'video') || null)
200 async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
201 const pendingImageName = 'pending-' + imageName
204 filename: pendingImageName,
209 const pendingImagePath = join(folder, pendingImageName)
212 await new Promise<string>((res, rej) => {
213 ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
215 .on('end', () => res(imageName))
219 const destination = join(folder, imageName)
220 await processImage(pendingImagePath, destination, size)
222 logger.error('Cannot generate image from video %s.', fromPath, { err })
225 await remove(pendingImagePath)
227 logger.debug('Cannot remove pending image path after generation error.', { err })
232 type TranscodeOptionsType = 'hls' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
234 interface BaseTranscodeOptions {
235 type: TranscodeOptionsType
238 resolution: VideoResolution
239 isPortraitMode?: boolean
242 interface HLSTranscodeOptions extends BaseTranscodeOptions {
246 videoFilename: string
250 interface QuickTranscodeOptions extends BaseTranscodeOptions {
251 type: 'quick-transcode'
254 interface VideoTranscodeOptions extends BaseTranscodeOptions {
258 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
263 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
267 type TranscodeOptions =
269 | VideoTranscodeOptions
270 | MergeAudioTranscodeOptions
271 | OnlyAudioTranscodeOptions
272 | QuickTranscodeOptions
274 function transcode (options: TranscodeOptions) {
275 return new Promise<void>(async (res, rej) => {
277 let command = getFFmpeg(options.inputPath)
278 .output(options.outputPath)
280 if (options.type === 'quick-transcode') {
281 command = buildQuickTranscodeCommand(command)
282 } else if (options.type === 'hls') {
283 command = await buildHLSVODCommand(command, options)
284 } else if (options.type === 'merge-audio') {
285 command = await buildAudioMergeCommand(command, options)
286 } else if (options.type === 'only-audio') {
287 command = buildOnlyAudioCommand(command, options)
289 command = await buildx264Command(command, options)
293 .on('error', (err, stdout, stderr) => {
294 logger.error('Error in transcoding job.', { stdout, stderr })
298 return fixHLSPlaylistIfNeeded(options)
300 .catch(err => rej(err))
309 async function canDoQuickTranscode (path: string): Promise<boolean> {
310 // NOTE: This could be optimized by running ffprobe only once (but it runs fast anyway)
311 const videoStream = await getVideoStreamFromFile(path)
312 const parsedAudio = await audio.get(path)
313 const fps = await getVideoFileFPS(path)
314 const bitRate = await getVideoFileBitrate(path)
315 const resolution = await getVideoFileResolution(path)
317 // check video params
318 if (videoStream == null) return false
319 if (videoStream['codec_name'] !== 'h264') return false
320 if (videoStream['pix_fmt'] !== 'yuv420p') return false
321 if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) return false
322 if (bitRate > getMaxBitrate(resolution.videoFileResolution, fps, VIDEO_TRANSCODING_FPS)) return false
324 // check audio params (if audio stream exists)
325 if (parsedAudio.audioStream) {
326 if (parsedAudio.audioStream['codec_name'] !== 'aac') return false
328 const maxAudioBitrate = audio.bitrate['aac'](parsedAudio.audioStream['bit_rate'])
329 if (maxAudioBitrate !== -1 && parsedAudio.audioStream['bit_rate'] > maxAudioBitrate) return false
335 function getClosestFramerateStandard (fps: number, type: 'HD_STANDARD' | 'STANDARD'): number {
336 return VIDEO_TRANSCODING_FPS[type].slice(0)
337 .sort((a, b) => fps % a - fps % b)[0]
340 function convertWebPToJPG (path: string, destination: string): Promise<void> {
341 return new Promise<void>(async (res, rej) => {
343 const command = ffmpeg(path).output(destination)
345 command.on('error', (err, stdout, stderr) => {
346 logger.error('Error in ffmpeg webp convert process.', { stdout, stderr })
349 .on('end', () => res())
357 function runLiveTranscoding (rtmpUrl: string, outPath: string, resolutions: number[], deleteSegments: boolean) {
358 const command = getFFmpeg(rtmpUrl)
359 command.inputOption('-fflags nobuffer')
361 const varStreamMap: string[] = []
363 command.complexFilter([
367 options: resolutions.length,
368 outputs: resolutions.map(r => `vtemp${r}`)
371 ...resolutions.map(r => ({
374 options: `w=-2:h=${r}`,
379 const liveFPS = VIDEO_TRANSCODING_FPS.AVERAGE
381 command.withFps(liveFPS)
383 command.outputOption('-b_strategy 1')
384 command.outputOption('-bf 16')
385 command.outputOption('-preset superfast')
386 command.outputOption('-level 3.1')
387 command.outputOption('-map_metadata -1')
388 command.outputOption('-pix_fmt yuv420p')
390 for (let i = 0; i < resolutions.length; i++) {
391 const resolution = resolutions[i]
393 command.outputOption(`-map [vout${resolution}]`)
394 command.outputOption(`-c:v:${i} libx264`)
395 command.outputOption(`-b:v:${i} ${getTargetBitrate(resolution, liveFPS, VIDEO_TRANSCODING_FPS)}`)
397 command.outputOption(`-map a:0`)
398 command.outputOption(`-c:a:${i} aac`)
400 varStreamMap.push(`v:${i},a:${i}`)
403 addDefaultLiveHLSParams(command, outPath, deleteSegments)
405 command.outputOption('-var_stream_map', varStreamMap.join(' '))
412 function runLiveMuxing (rtmpUrl: string, outPath: string, deleteSegments: boolean) {
413 const command = getFFmpeg(rtmpUrl)
414 command.inputOption('-fflags nobuffer')
416 command.outputOption('-c:v copy')
417 command.outputOption('-c:a copy')
418 command.outputOption('-map 0:a?')
419 command.outputOption('-map 0:v?')
421 addDefaultLiveHLSParams(command, outPath, deleteSegments)
428 async function hlsPlaylistToFragmentedMP4 (hlsDirectory: string, segmentFiles: string[], outputPath: string) {
429 const concatFile = 'concat.txt'
430 const concatFilePath = join(hlsDirectory, concatFile)
431 const content = segmentFiles.map(f => 'file ' + f)
434 await writeFile(concatFilePath, content + '\n')
436 const command = getFFmpeg(concatFilePath)
437 command.inputOption('-safe 0')
438 command.inputOption('-f concat')
440 command.outputOption('-c copy')
441 command.output(outputPath)
445 function cleaner () {
447 .catch(err => logger.error('Cannot remove concat file in %s.', hlsDirectory, { err }))
450 return new Promise<string>((res, rej) => {
451 command.on('error', err => {
457 command.on('end', () => {
465 // ---------------------------------------------------------------------------
473 getVideoFileResolution,
475 getDurationFromVideoFile,
477 generateImageFromVideoFile,
479 TranscodeOptionsType,
482 computeResolutionsToTranscode,
484 hlsPlaylistToFragmentedMP4,
489 // ---------------------------------------------------------------------------
491 function addDefaultX264Params (command: ffmpeg.FfmpegCommand) {
492 command.outputOption('-level 3.1') // 3.1 is the minimal resource allocation for our highest supported resolution
493 .outputOption('-b_strategy 1') // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
494 .outputOption('-bf 16') // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
495 .outputOption('-pix_fmt yuv420p') // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
496 .outputOption('-map_metadata -1') // strip all metadata
499 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string, deleteSegments: boolean) {
500 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME)
501 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
503 if (deleteSegments === true) {
504 command.outputOption('-hls_flags delete_segments')
507 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%d.ts')}`)
508 command.outputOption('-master_pl_name master.m3u8')
509 command.outputOption(`-f hls`)
511 command.output(join(outPath, '%v.m3u8'))
514 async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
515 let fps = await getVideoFileFPS(options.inputPath)
517 // On small/medium resolutions, limit FPS
518 options.resolution !== undefined &&
519 options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
520 fps > VIDEO_TRANSCODING_FPS.AVERAGE
522 // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value
523 fps = getClosestFramerateStandard(fps, 'STANDARD')
526 command = await presetH264(command, options.inputPath, options.resolution, fps)
528 if (options.resolution !== undefined) {
529 // '?x720' or '720x?' for example
530 const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}`
531 command = command.size(size)
536 if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = getClosestFramerateStandard(fps, 'HD_STANDARD')
537 else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN
539 command = command.withFPS(fps)
545 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
546 command = command.loop(undefined)
548 command = await presetH264VeryFast(command, options.audioPath, options.resolution)
550 command = command.input(options.audioPath)
551 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
552 .outputOption('-tune stillimage')
553 .outputOption('-shortest')
558 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, options: OnlyAudioTranscodeOptions) {
559 command = presetOnlyAudio(command)
564 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
565 command = presetCopy(command)
567 command = command.outputOption('-map_metadata -1') // strip all metadata
568 .outputOption('-movflags faststart')
573 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
574 const videoPath = getHLSVideoPath(options)
576 if (options.copyCodecs) command = presetCopy(command)
577 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
578 else command = await buildx264Command(command, options)
580 command = command.outputOption('-hls_time 4')
581 .outputOption('-hls_list_size 0')
582 .outputOption('-hls_playlist_type vod')
583 .outputOption('-hls_segment_filename ' + videoPath)
584 .outputOption('-hls_segment_type fmp4')
585 .outputOption('-f hls')
586 .outputOption('-hls_flags single_file')
591 function getHLSVideoPath (options: HLSTranscodeOptions) {
592 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
595 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
596 if (options.type !== 'hls') return
598 const fileContent = await readFile(options.outputPath)
600 const videoFileName = options.hlsPlaylist.videoFilename
601 const videoFilePath = getHLSVideoPath(options)
603 // Fix wrong mapping with some ffmpeg versions
604 const newContent = fileContent.toString()
605 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
607 await writeFile(options.outputPath, newContent)
611 * A slightly customised version of the 'veryfast' x264 preset
613 * The veryfast preset is right in the sweet spot of performance
614 * and quality. Superfast and ultrafast will give you better
615 * performance, but then quality is noticeably worse.
617 async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
618 let localCommand = await presetH264(command, input, resolution, fps)
620 localCommand = localCommand.outputOption('-preset:v veryfast')
623 MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html
624 Our target situation is closer to a livestream than a stream,
625 since we want to reduce as much a possible the encoding burden,
626 although not to the point of a livestream where there is a hard
627 constraint on the frames per second to be encoded.
634 * Standard profile, with variable bitrate audio and faststart.
636 * As for the audio, quality '5' is the highest and ensures 96-112kbps/channel
637 * See https://trac.ffmpeg.org/wiki/Encode/AAC#fdk_vbr
639 async function presetH264 (command: ffmpeg.FfmpegCommand, input: string, resolution: VideoResolution, fps?: number) {
640 let localCommand = command
642 .videoCodec('libx264')
643 .outputOption('-movflags faststart')
645 addDefaultX264Params(localCommand)
647 const parsedAudio = await audio.get(input)
649 if (!parsedAudio.audioStream) {
650 localCommand = localCommand.noAudio()
651 } else if ((await checkFFmpegEncoders()).get('libfdk_aac')) { // we favor VBR, if a good AAC encoder is available
652 localCommand = localCommand
653 .audioCodec('libfdk_aac')
656 // we try to reduce the ceiling bitrate by making rough matches of bitrates
657 // of course this is far from perfect, but it might save some space in the end
658 localCommand = localCommand.audioCodec('aac')
660 const audioCodecName = parsedAudio.audioStream['codec_name']
662 if (audio.bitrate[audioCodecName]) {
663 const bitrate = audio.bitrate[audioCodecName](parsedAudio.audioStream['bit_rate'])
664 if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate)
669 // Constrained Encoding (VBV)
670 // https://slhck.info/video/2017/03/01/rate-control.html
671 // https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate
672 const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)
673 localCommand = localCommand.outputOptions([ `-maxrate ${targetBitrate}`, `-bufsize ${targetBitrate * 2}` ])
675 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
676 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
677 // https://superuser.com/a/908325
678 localCommand = localCommand.outputOption(`-g ${fps * 2}`)
684 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
691 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
698 function getFFmpeg (input: string) {
699 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
700 const command = ffmpeg(input, { niceness: FFMPEG_NICE.TRANSCODING, cwd: CONFIG.STORAGE.TMP_DIR })
702 if (CONFIG.TRANSCODING.THREADS > 0) {
703 // If we don't set any threads ffmpeg will chose automatically
704 command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)