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[]
194 availableEncoders: AvailableEncoders
197 const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
198 const input = rtmpUrl
200 const command = getFFmpeg(input)
201 command.inputOption('-fflags nobuffer')
203 const varStreamMap: string[] = []
205 command.complexFilter([
209 options: resolutions.length,
210 outputs: resolutions.map(r => `vtemp${r}`)
213 ...resolutions.map(r => ({
216 options: `w=-2:h=${r}`,
221 command.outputOption('-preset superfast')
223 addDefaultEncoderGlobalParams({ command })
225 for (let i = 0; i < resolutions.length; i++) {
226 const resolution = resolutions[i]
227 const resolutionFPS = computeFPS(fps, resolution)
229 const baseEncoderBuilderParams = {
236 videoType: 'live' as 'live'
240 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'VIDEO' }))
241 if (!builderResult) {
242 throw new Error('No available live video encoder found')
245 command.outputOption(`-map [vout${resolution}]`)
247 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
249 logger.debug('Apply ffmpeg live video params from %s.', builderResult.encoder, builderResult)
251 command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
252 command.addOutputOptions(builderResult.result.outputOptions)
256 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType: 'AUDIO' }))
257 if (!builderResult) {
258 throw new Error('No available live audio encoder found')
261 command.outputOption('-map a:0')
263 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
265 logger.debug('Apply ffmpeg live audio params from %s.', builderResult.encoder, builderResult)
267 command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
268 command.addOutputOptions(builderResult.result.outputOptions)
271 varStreamMap.push(`v:${i},a:${i}`)
274 addDefaultLiveHLSParams(command, outPath)
276 command.outputOption('-var_stream_map', varStreamMap.join(' '))
281 function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
282 const command = getFFmpeg(rtmpUrl)
283 command.inputOption('-fflags nobuffer')
285 command.outputOption('-c:v copy')
286 command.outputOption('-c:a copy')
287 command.outputOption('-map 0:a?')
288 command.outputOption('-map 0:v?')
290 addDefaultLiveHLSParams(command, outPath)
295 async function hlsPlaylistToFragmentedMP4 (replayDirectory: string, segmentFiles: string[], outputPath: string) {
296 const concatFilePath = join(replayDirectory, 'concat.txt')
298 function cleaner () {
299 remove(concatFilePath)
300 .catch(err => logger.error('Cannot remove concat file in %s.', replayDirectory, { err }))
303 // First concat the ts files to a mp4 file
304 const content = segmentFiles.map(f => 'file ' + f)
307 await writeFile(concatFilePath, content + '\n')
309 const command = getFFmpeg(concatFilePath)
310 command.inputOption('-safe 0')
311 command.inputOption('-f concat')
313 command.outputOption('-c:v copy')
314 command.audioFilter('aresample=async=1:first_pts=0')
315 command.output(outputPath)
317 return runCommand(command, cleaner)
320 function buildStreamSuffix (base: string, streamNum?: number) {
321 if (streamNum !== undefined) {
322 return `${base}:${streamNum}`
328 // ---------------------------------------------------------------------------
331 getLiveTranscodingCommand,
332 getLiveMuxingCommand,
336 generateImageFromVideoFile,
338 TranscodeOptionsType,
340 hlsPlaylistToFragmentedMP4
343 // ---------------------------------------------------------------------------
345 // ---------------------------------------------------------------------------
347 // ---------------------------------------------------------------------------
349 function addDefaultEncoderGlobalParams (options: {
350 command: ffmpeg.FfmpegCommand
352 const { command } = options
354 // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
355 command.outputOption('-max_muxing_queue_size 1024')
356 // strip all metadata
357 .outputOption('-map_metadata -1')
358 // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
359 .outputOption('-b_strategy 1')
360 // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
361 .outputOption('-bf 16')
362 // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
363 .outputOption('-pix_fmt yuv420p')
366 function addDefaultEncoderParams (options: {
367 command: ffmpeg.FfmpegCommand
368 encoder: 'libx264' | string
372 const { command, encoder, fps, streamNum } = options
374 if (encoder === 'libx264') {
375 // 3.1 is the minimal resource allocation for our highest supported resolution
376 command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
379 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
380 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
381 // https://superuser.com/a/908325
382 command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
387 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
388 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
389 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
390 command.outputOption('-hls_flags delete_segments')
391 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
392 command.outputOption('-master_pl_name master.m3u8')
393 command.outputOption(`-f hls`)
395 command.output(join(outPath, '%v.m3u8'))
398 // ---------------------------------------------------------------------------
399 // Transcode VOD command builders
400 // ---------------------------------------------------------------------------
402 async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
403 let fps = await getVideoFileFPS(options.inputPath)
404 fps = computeFPS(fps, options.resolution)
406 command = await presetVideo(command, options.inputPath, options, fps)
408 if (options.resolution !== undefined) {
409 // '?x720' or '720x?' for example
410 const size = options.isPortraitMode === true
411 ? `${options.resolution}x?`
412 : `?x${options.resolution}`
414 command = command.size(size)
420 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
421 command = command.loop(undefined)
423 command = await presetVideo(command, options.audioPath, options)
425 command.outputOption('-preset:v veryfast')
427 command = command.input(options.audioPath)
428 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
429 .outputOption('-tune stillimage')
430 .outputOption('-shortest')
435 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
436 command = presetOnlyAudio(command)
441 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
442 command = presetCopy(command)
444 command = command.outputOption('-map_metadata -1') // strip all metadata
445 .outputOption('-movflags faststart')
450 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
451 const videoPath = getHLSVideoPath(options)
453 if (options.copyCodecs) command = presetCopy(command)
454 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
455 else command = await buildx264VODCommand(command, options)
457 command = command.outputOption('-hls_time 4')
458 .outputOption('-hls_list_size 0')
459 .outputOption('-hls_playlist_type vod')
460 .outputOption('-hls_segment_filename ' + videoPath)
461 .outputOption('-hls_segment_type fmp4')
462 .outputOption('-f hls')
463 .outputOption('-hls_flags single_file')
468 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
469 if (options.type !== 'hls') 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) {
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) {
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 if (CONFIG.TRANSCODING.THREADS > 0) {
611 // If we don't set any threads ffmpeg will chose automatically
612 command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)
618 async function runCommand (command: ffmpeg.FfmpegCommand, onEnd?: Function) {
619 return new Promise<void>((res, rej) => {
620 command.on('error', (err, stdout, stderr) => {
623 logger.error('Error in transcoding job.', { stdout, stderr })
627 command.on('end', () => {