mirror of https://github.com/Chocobozzz/PeerTube
				
				
				
			
		
			
				
	
	
		
			786 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			TypeScript
		
	
	
			
		
		
	
	
			786 lines
		
	
	
		
			23 KiB
		
	
	
	
		
			TypeScript
		
	
	
| import { Job } from 'bull'
 | |
| import ffmpeg, { FfmpegCommand, FilterSpecification, getAvailableEncoders } from 'fluent-ffmpeg'
 | |
| import { readFile, remove, writeFile } from 'fs-extra'
 | |
| import { dirname, join } from 'path'
 | |
| import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants'
 | |
| import { pick } from '@shared/core-utils'
 | |
| import {
 | |
|   AvailableEncoders,
 | |
|   EncoderOptions,
 | |
|   EncoderOptionsBuilder,
 | |
|   EncoderOptionsBuilderParams,
 | |
|   EncoderProfile,
 | |
|   VideoResolution
 | |
| } from '../../shared/models/videos'
 | |
| import { CONFIG } from '../initializers/config'
 | |
| import { execPromise, promisify0 } from './core-utils'
 | |
| import { computeFPS, ffprobePromise, getAudioStream, getVideoFileBitrate, getVideoFileFPS, getVideoFileResolution } from './ffprobe-utils'
 | |
| import { processImage } from './image-utils'
 | |
| import { logger, loggerTagsFactory } from './logger'
 | |
| 
 | |
| const lTags = loggerTagsFactory('ffmpeg')
 | |
| 
 | |
| /**
 | |
|  *
 | |
|  * Functions that run transcoding/muxing ffmpeg processes
 | |
|  * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
 | |
|  *
 | |
|  */
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Encoder options
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| type StreamType = 'audio' | 'video'
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Encoders support
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| // Detect supported encoders by ffmpeg
 | |
| let supportedEncoders: Map<string, boolean>
 | |
| async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise<Map<string, boolean>> {
 | |
|   if (supportedEncoders !== undefined) {
 | |
|     return supportedEncoders
 | |
|   }
 | |
| 
 | |
|   const getAvailableEncodersPromise = promisify0(getAvailableEncoders)
 | |
|   const availableFFmpegEncoders = await getAvailableEncodersPromise()
 | |
| 
 | |
|   const searchEncoders = new Set<string>()
 | |
|   for (const type of [ 'live', 'vod' ]) {
 | |
|     for (const streamType of [ 'audio', 'video' ]) {
 | |
|       for (const encoder of peertubeAvailableEncoders.encodersToTry[type][streamType]) {
 | |
|         searchEncoders.add(encoder)
 | |
|       }
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   supportedEncoders = new Map<string, boolean>()
 | |
| 
 | |
|   for (const searchEncoder of searchEncoders) {
 | |
|     supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
 | |
|   }
 | |
| 
 | |
|   logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders, ...lTags() })
 | |
| 
 | |
|   return supportedEncoders
 | |
| }
 | |
| 
 | |
| function resetSupportedEncoders () {
 | |
|   supportedEncoders = undefined
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Image manipulation
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| function convertWebPToJPG (path: string, destination: string): Promise<void> {
 | |
|   const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
 | |
|     .output(destination)
 | |
| 
 | |
|   return runCommand({ command, silent: true })
 | |
| }
 | |
| 
 | |
| function processGIF (
 | |
|   path: string,
 | |
|   destination: string,
 | |
|   newSize: { width: number, height: number }
 | |
| ): Promise<void> {
 | |
|   const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
 | |
|     .fps(20)
 | |
|     .size(`${newSize.width}x${newSize.height}`)
 | |
|     .output(destination)
 | |
| 
 | |
|   return runCommand({ command })
 | |
| }
 | |
| 
 | |
| async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
 | |
|   const pendingImageName = 'pending-' + imageName
 | |
| 
 | |
|   const options = {
 | |
|     filename: pendingImageName,
 | |
|     count: 1,
 | |
|     folder
 | |
|   }
 | |
| 
 | |
|   const pendingImagePath = join(folder, pendingImageName)
 | |
| 
 | |
|   try {
 | |
|     await new Promise<string>((res, rej) => {
 | |
|       ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
 | |
|         .on('error', rej)
 | |
|         .on('end', () => res(imageName))
 | |
|         .thumbnail(options)
 | |
|     })
 | |
| 
 | |
|     const destination = join(folder, imageName)
 | |
|     await processImage(pendingImagePath, destination, size)
 | |
|   } catch (err) {
 | |
|     logger.error('Cannot generate image from video %s.', fromPath, { err, ...lTags() })
 | |
| 
 | |
|     try {
 | |
|       await remove(pendingImagePath)
 | |
|     } catch (err) {
 | |
|       logger.debug('Cannot remove pending image path after generation error.', { err, ...lTags() })
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Transcode meta function
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
 | |
| 
 | |
| interface BaseTranscodeOptions {
 | |
|   type: TranscodeOptionsType
 | |
| 
 | |
|   inputPath: string
 | |
|   outputPath: string
 | |
| 
 | |
|   availableEncoders: AvailableEncoders
 | |
|   profile: string
 | |
| 
 | |
|   resolution: number
 | |
| 
 | |
|   isPortraitMode?: boolean
 | |
| 
 | |
|   job?: Job
 | |
| }
 | |
| 
 | |
| interface HLSTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'hls'
 | |
|   copyCodecs: boolean
 | |
|   hlsPlaylist: {
 | |
|     videoFilename: string
 | |
|   }
 | |
| }
 | |
| 
 | |
| interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'hls-from-ts'
 | |
| 
 | |
|   isAAC: boolean
 | |
| 
 | |
|   hlsPlaylist: {
 | |
|     videoFilename: string
 | |
|   }
 | |
| }
 | |
| 
 | |
| interface QuickTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'quick-transcode'
 | |
| }
 | |
| 
 | |
| interface VideoTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'video'
 | |
| }
 | |
| 
 | |
| interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'merge-audio'
 | |
|   audioPath: string
 | |
| }
 | |
| 
 | |
| interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
 | |
|   type: 'only-audio'
 | |
| }
 | |
| 
 | |
| type TranscodeOptions =
 | |
|   HLSTranscodeOptions
 | |
|   | HLSFromTSTranscodeOptions
 | |
|   | VideoTranscodeOptions
 | |
|   | MergeAudioTranscodeOptions
 | |
|   | OnlyAudioTranscodeOptions
 | |
|   | QuickTranscodeOptions
 | |
| 
 | |
| const builders: {
 | |
|   [ type in TranscodeOptionsType ]: (c: FfmpegCommand, o?: TranscodeOptions) => Promise<FfmpegCommand> | FfmpegCommand
 | |
| } = {
 | |
|   'quick-transcode': buildQuickTranscodeCommand,
 | |
|   'hls': buildHLSVODCommand,
 | |
|   'hls-from-ts': buildHLSVODFromTSCommand,
 | |
|   'merge-audio': buildAudioMergeCommand,
 | |
|   'only-audio': buildOnlyAudioCommand,
 | |
|   'video': buildx264VODCommand
 | |
| }
 | |
| 
 | |
| async function transcode (options: TranscodeOptions) {
 | |
|   logger.debug('Will run transcode.', { options, ...lTags() })
 | |
| 
 | |
|   let command = getFFmpeg(options.inputPath, 'vod')
 | |
|     .output(options.outputPath)
 | |
| 
 | |
|   command = await builders[options.type](command, options)
 | |
| 
 | |
|   await runCommand({ command, job: options.job })
 | |
| 
 | |
|   await fixHLSPlaylistIfNeeded(options)
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Live muxing/transcoding functions
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| async function getLiveTranscodingCommand (options: {
 | |
|   inputUrl: string
 | |
| 
 | |
|   outPath: string
 | |
|   masterPlaylistName: string
 | |
| 
 | |
|   resolutions: number[]
 | |
| 
 | |
|   // Input information
 | |
|   fps: number
 | |
|   bitrate: number
 | |
|   ratio: number
 | |
| 
 | |
|   availableEncoders: AvailableEncoders
 | |
|   profile: string
 | |
| }) {
 | |
|   const { inputUrl, outPath, resolutions, fps, bitrate, availableEncoders, profile, masterPlaylistName, ratio } = options
 | |
| 
 | |
|   const command = getFFmpeg(inputUrl, 'live')
 | |
| 
 | |
|   const varStreamMap: string[] = []
 | |
| 
 | |
|   const complexFilter: FilterSpecification[] = [
 | |
|     {
 | |
|       inputs: '[v:0]',
 | |
|       filter: 'split',
 | |
|       options: resolutions.length,
 | |
|       outputs: resolutions.map(r => `vtemp${r}`)
 | |
|     }
 | |
|   ]
 | |
| 
 | |
|   command.outputOption('-sc_threshold 0')
 | |
| 
 | |
|   addDefaultEncoderGlobalParams({ command })
 | |
| 
 | |
|   for (let i = 0; i < resolutions.length; i++) {
 | |
|     const resolution = resolutions[i]
 | |
|     const resolutionFPS = computeFPS(fps, resolution)
 | |
| 
 | |
|     const baseEncoderBuilderParams = {
 | |
|       input: inputUrl,
 | |
| 
 | |
|       availableEncoders,
 | |
|       profile,
 | |
| 
 | |
|       inputBitrate: bitrate,
 | |
|       inputRatio: ratio,
 | |
| 
 | |
|       resolution,
 | |
|       fps: resolutionFPS,
 | |
| 
 | |
|       streamNum: i,
 | |
|       videoType: 'live' as 'live'
 | |
|     }
 | |
| 
 | |
|     {
 | |
|       const streamType: StreamType = 'video'
 | |
|       const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType })
 | |
|       if (!builderResult) {
 | |
|         throw new Error('No available live video encoder found')
 | |
|       }
 | |
| 
 | |
|       command.outputOption(`-map [vout${resolution}]`)
 | |
| 
 | |
|       addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
 | |
| 
 | |
|       logger.debug(
 | |
|         'Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult,
 | |
|         { fps: resolutionFPS, resolution, ...lTags() }
 | |
|       )
 | |
| 
 | |
|       command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
 | |
|       applyEncoderOptions(command, builderResult.result)
 | |
| 
 | |
|       complexFilter.push({
 | |
|         inputs: `vtemp${resolution}`,
 | |
|         filter: getScaleFilter(builderResult.result),
 | |
|         options: `w=-2:h=${resolution}`,
 | |
|         outputs: `vout${resolution}`
 | |
|       })
 | |
|     }
 | |
| 
 | |
|     {
 | |
|       const streamType: StreamType = 'audio'
 | |
|       const builderResult = await getEncoderBuilderResult({ ...baseEncoderBuilderParams, streamType })
 | |
|       if (!builderResult) {
 | |
|         throw new Error('No available live audio encoder found')
 | |
|       }
 | |
| 
 | |
|       command.outputOption('-map a:0')
 | |
| 
 | |
|       addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
 | |
| 
 | |
|       logger.debug(
 | |
|         'Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult,
 | |
|         { fps: resolutionFPS, resolution, ...lTags() }
 | |
|       )
 | |
| 
 | |
|       command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
 | |
|       applyEncoderOptions(command, builderResult.result)
 | |
|     }
 | |
| 
 | |
|     varStreamMap.push(`v:${i},a:${i}`)
 | |
|   }
 | |
| 
 | |
|   command.complexFilter(complexFilter)
 | |
| 
 | |
|   addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
 | |
| 
 | |
|   command.outputOption('-var_stream_map', varStreamMap.join(' '))
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function getLiveMuxingCommand (inputUrl: string, outPath: string, masterPlaylistName: string) {
 | |
|   const command = getFFmpeg(inputUrl, 'live')
 | |
| 
 | |
|   command.outputOption('-c:v copy')
 | |
|   command.outputOption('-c:a copy')
 | |
|   command.outputOption('-map 0:a?')
 | |
|   command.outputOption('-map 0:v?')
 | |
| 
 | |
|   addDefaultLiveHLSParams(command, outPath, masterPlaylistName)
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function buildStreamSuffix (base: string, streamNum?: number) {
 | |
|   if (streamNum !== undefined) {
 | |
|     return `${base}:${streamNum}`
 | |
|   }
 | |
| 
 | |
|   return base
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Default options
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| function addDefaultEncoderGlobalParams (options: {
 | |
|   command: FfmpegCommand
 | |
| }) {
 | |
|   const { command } = options
 | |
| 
 | |
|   // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
 | |
|   command.outputOption('-max_muxing_queue_size 1024')
 | |
|          // strip all metadata
 | |
|          .outputOption('-map_metadata -1')
 | |
|          // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
 | |
|          .outputOption('-b_strategy 1')
 | |
|          // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
 | |
|          .outputOption('-bf 16')
 | |
|          // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
 | |
|          .outputOption('-pix_fmt yuv420p')
 | |
| }
 | |
| 
 | |
| function addDefaultEncoderParams (options: {
 | |
|   command: FfmpegCommand
 | |
|   encoder: 'libx264' | string
 | |
|   streamNum?: number
 | |
|   fps?: number
 | |
| }) {
 | |
|   const { command, encoder, fps, streamNum } = options
 | |
| 
 | |
|   if (encoder === 'libx264') {
 | |
|     // 3.1 is the minimal resource allocation for our highest supported resolution
 | |
|     command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
 | |
| 
 | |
|     if (fps) {
 | |
|       // Keyframe interval of 2 seconds for faster seeking and resolution switching.
 | |
|       // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
 | |
|       // https://superuser.com/a/908325
 | |
|       command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
 | |
|     }
 | |
|   }
 | |
| }
 | |
| 
 | |
| function addDefaultLiveHLSParams (command: FfmpegCommand, outPath: string, masterPlaylistName: string) {
 | |
|   command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
 | |
|   command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
 | |
|   command.outputOption('-hls_flags delete_segments+independent_segments')
 | |
|   command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
 | |
|   command.outputOption('-master_pl_name ' + masterPlaylistName)
 | |
|   command.outputOption(`-f hls`)
 | |
| 
 | |
|   command.output(join(outPath, '%v.m3u8'))
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Transcode VOD command builders
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| async function buildx264VODCommand (command: FfmpegCommand, options: TranscodeOptions) {
 | |
|   let fps = await getVideoFileFPS(options.inputPath)
 | |
|   fps = computeFPS(fps, options.resolution)
 | |
| 
 | |
|   let scaleFilterValue: string
 | |
| 
 | |
|   if (options.resolution !== undefined) {
 | |
|     scaleFilterValue = options.isPortraitMode === true
 | |
|       ? `w=${options.resolution}:h=-2`
 | |
|       : `w=-2:h=${options.resolution}`
 | |
|   }
 | |
| 
 | |
|   command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue })
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| async function buildAudioMergeCommand (command: FfmpegCommand, options: MergeAudioTranscodeOptions) {
 | |
|   command = command.loop(undefined)
 | |
| 
 | |
|   const scaleFilterValue = getScaleCleanerValue()
 | |
|   command = await presetVideo({ command, input: options.audioPath, transcodeOptions: options, scaleFilterValue })
 | |
| 
 | |
|   command.outputOption('-preset:v veryfast')
 | |
| 
 | |
|   command = command.input(options.audioPath)
 | |
|                    .outputOption('-tune stillimage')
 | |
|                    .outputOption('-shortest')
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function buildOnlyAudioCommand (command: FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
 | |
|   command = presetOnlyAudio(command)
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function buildQuickTranscodeCommand (command: FfmpegCommand) {
 | |
|   command = presetCopy(command)
 | |
| 
 | |
|   command = command.outputOption('-map_metadata -1') // strip all metadata
 | |
|                    .outputOption('-movflags faststart')
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function addCommonHLSVODCommandOptions (command: FfmpegCommand, outputPath: string) {
 | |
|   return command.outputOption('-hls_time 4')
 | |
|                 .outputOption('-hls_list_size 0')
 | |
|                 .outputOption('-hls_playlist_type vod')
 | |
|                 .outputOption('-hls_segment_filename ' + outputPath)
 | |
|                 .outputOption('-hls_segment_type fmp4')
 | |
|                 .outputOption('-f hls')
 | |
|                 .outputOption('-hls_flags single_file')
 | |
| }
 | |
| 
 | |
| async function buildHLSVODCommand (command: FfmpegCommand, options: HLSTranscodeOptions) {
 | |
|   const videoPath = getHLSVideoPath(options)
 | |
| 
 | |
|   if (options.copyCodecs) command = presetCopy(command)
 | |
|   else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
 | |
|   else command = await buildx264VODCommand(command, options)
 | |
| 
 | |
|   addCommonHLSVODCommandOptions(command, videoPath)
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function buildHLSVODFromTSCommand (command: FfmpegCommand, options: HLSFromTSTranscodeOptions) {
 | |
|   const videoPath = getHLSVideoPath(options)
 | |
| 
 | |
|   command.outputOption('-c copy')
 | |
| 
 | |
|   if (options.isAAC) {
 | |
|     // Required for example when copying an AAC stream from an MPEG-TS
 | |
|     // Since it's a bitstream filter, we don't need to reencode the audio
 | |
|     command.outputOption('-bsf:a aac_adtstoasc')
 | |
|   }
 | |
| 
 | |
|   addCommonHLSVODCommandOptions(command, videoPath)
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
 | |
|   if (options.type !== 'hls' && options.type !== 'hls-from-ts') return
 | |
| 
 | |
|   const fileContent = await readFile(options.outputPath)
 | |
| 
 | |
|   const videoFileName = options.hlsPlaylist.videoFilename
 | |
|   const videoFilePath = getHLSVideoPath(options)
 | |
| 
 | |
|   // Fix wrong mapping with some ffmpeg versions
 | |
|   const newContent = fileContent.toString()
 | |
|                                 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
 | |
| 
 | |
|   await writeFile(options.outputPath, newContent)
 | |
| }
 | |
| 
 | |
| function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
 | |
|   return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Transcoding presets
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| // Run encoder builder depending on available encoders
 | |
| // Try encoders by priority: if the encoder is available, run the chosen profile or fallback to the default one
 | |
| // If the default one does not exist, check the next encoder
 | |
| async function getEncoderBuilderResult (options: EncoderOptionsBuilderParams & {
 | |
|   streamType: 'video' | 'audio'
 | |
|   input: string
 | |
| 
 | |
|   availableEncoders: AvailableEncoders
 | |
|   profile: string
 | |
| 
 | |
|   videoType: 'vod' | 'live'
 | |
| }) {
 | |
|   const { availableEncoders, profile, streamType, videoType } = options
 | |
| 
 | |
|   const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
 | |
|   const encoders = availableEncoders.available[videoType]
 | |
| 
 | |
|   for (const encoder of encodersToTry) {
 | |
|     if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
 | |
|       logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder, lTags())
 | |
|       continue
 | |
|     }
 | |
| 
 | |
|     if (!encoders[encoder]) {
 | |
|       logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder, lTags())
 | |
|       continue
 | |
|     }
 | |
| 
 | |
|     // An object containing available profiles for this encoder
 | |
|     const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder]
 | |
|     let builder = builderProfiles[profile]
 | |
| 
 | |
|     if (!builder) {
 | |
|       logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder, lTags())
 | |
|       builder = builderProfiles.default
 | |
| 
 | |
|       if (!builder) {
 | |
|         logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder, lTags())
 | |
|         continue
 | |
|       }
 | |
|     }
 | |
| 
 | |
|     const result = await builder(pick(options, [ 'input', 'resolution', 'inputBitrate', 'fps', 'inputRatio', 'streamNum' ]))
 | |
| 
 | |
|     return {
 | |
|       result,
 | |
| 
 | |
|       // If we don't have output options, then copy the input stream
 | |
|       encoder: result.copy === true
 | |
|         ? 'copy'
 | |
|         : encoder
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   return null
 | |
| }
 | |
| 
 | |
| async function presetVideo (options: {
 | |
|   command: FfmpegCommand
 | |
|   input: string
 | |
|   transcodeOptions: TranscodeOptions
 | |
|   fps?: number
 | |
|   scaleFilterValue?: string
 | |
| }) {
 | |
|   const { command, input, transcodeOptions, fps, scaleFilterValue } = options
 | |
| 
 | |
|   let localCommand = command
 | |
|     .format('mp4')
 | |
|     .outputOption('-movflags faststart')
 | |
| 
 | |
|   addDefaultEncoderGlobalParams({ command })
 | |
| 
 | |
|   const probe = await ffprobePromise(input)
 | |
| 
 | |
|   // Audio encoder
 | |
|   const parsedAudio = await getAudioStream(input, probe)
 | |
|   const bitrate = await getVideoFileBitrate(input, probe)
 | |
|   const { ratio } = await getVideoFileResolution(input, probe)
 | |
| 
 | |
|   let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
 | |
| 
 | |
|   if (!parsedAudio.audioStream) {
 | |
|     localCommand = localCommand.noAudio()
 | |
|     streamsToProcess = [ 'video' ]
 | |
|   }
 | |
| 
 | |
|   for (const streamType of streamsToProcess) {
 | |
|     const { profile, resolution, availableEncoders } = transcodeOptions
 | |
| 
 | |
|     const builderResult = await getEncoderBuilderResult({
 | |
|       streamType,
 | |
|       input,
 | |
|       resolution,
 | |
|       availableEncoders,
 | |
|       profile,
 | |
|       fps,
 | |
|       inputBitrate: bitrate,
 | |
|       inputRatio: ratio,
 | |
|       videoType: 'vod' as 'vod'
 | |
|     })
 | |
| 
 | |
|     if (!builderResult) {
 | |
|       throw new Error('No available encoder found for stream ' + streamType)
 | |
|     }
 | |
| 
 | |
|     logger.debug(
 | |
|       'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
 | |
|       builderResult.encoder, streamType, input, profile, builderResult,
 | |
|       { resolution, fps, ...lTags() }
 | |
|     )
 | |
| 
 | |
|     if (streamType === 'video') {
 | |
|       localCommand.videoCodec(builderResult.encoder)
 | |
| 
 | |
|       if (scaleFilterValue) {
 | |
|         localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`)
 | |
|       }
 | |
|     } else if (streamType === 'audio') {
 | |
|       localCommand.audioCodec(builderResult.encoder)
 | |
|     }
 | |
| 
 | |
|     applyEncoderOptions(localCommand, builderResult.result)
 | |
|     addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
 | |
|   }
 | |
| 
 | |
|   return localCommand
 | |
| }
 | |
| 
 | |
| function presetCopy (command: FfmpegCommand): FfmpegCommand {
 | |
|   return command
 | |
|     .format('mp4')
 | |
|     .videoCodec('copy')
 | |
|     .audioCodec('copy')
 | |
| }
 | |
| 
 | |
| function presetOnlyAudio (command: FfmpegCommand): FfmpegCommand {
 | |
|   return command
 | |
|     .format('mp4')
 | |
|     .audioCodec('copy')
 | |
|     .noVideo()
 | |
| }
 | |
| 
 | |
| function applyEncoderOptions (command: FfmpegCommand, options: EncoderOptions): FfmpegCommand {
 | |
|   return command
 | |
|     .inputOptions(options.inputOptions ?? [])
 | |
|     .outputOptions(options.outputOptions ?? [])
 | |
| }
 | |
| 
 | |
| function getScaleFilter (options: EncoderOptions): string {
 | |
|   if (options.scaleFilter) return options.scaleFilter.name
 | |
| 
 | |
|   return 'scale'
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| // Utils
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| function getFFmpeg (input: string, type: 'live' | 'vod') {
 | |
|   // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
 | |
|   const command = ffmpeg(input, {
 | |
|     niceness: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD,
 | |
|     cwd: CONFIG.STORAGE.TMP_DIR
 | |
|   })
 | |
| 
 | |
|   const threads = type === 'live'
 | |
|     ? CONFIG.LIVE.TRANSCODING.THREADS
 | |
|     : CONFIG.TRANSCODING.THREADS
 | |
| 
 | |
|   if (threads > 0) {
 | |
|     // If we don't set any threads ffmpeg will chose automatically
 | |
|     command.outputOption('-threads ' + threads)
 | |
|   }
 | |
| 
 | |
|   return command
 | |
| }
 | |
| 
 | |
| function getFFmpegVersion () {
 | |
|   return new Promise<string>((res, rej) => {
 | |
|     (ffmpeg() as any)._getFfmpegPath((err, ffmpegPath) => {
 | |
|       if (err) return rej(err)
 | |
|       if (!ffmpegPath) return rej(new Error('Could not find ffmpeg path'))
 | |
| 
 | |
|       return execPromise(`${ffmpegPath} -version`)
 | |
|         .then(stdout => {
 | |
|           const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/)
 | |
|           if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`))
 | |
| 
 | |
|           // Fix ffmpeg version that does not include patch version (4.4 for example)
 | |
|           let version = parsed[1]
 | |
|           if (version.match(/^\d+\.\d+$/)) {
 | |
|             version += '.0'
 | |
|           }
 | |
| 
 | |
|           return res(version)
 | |
|         })
 | |
|         .catch(err => rej(err))
 | |
|     })
 | |
|   })
 | |
| }
 | |
| 
 | |
| async function runCommand (options: {
 | |
|   command: FfmpegCommand
 | |
|   silent?: boolean // false
 | |
|   job?: Job
 | |
| }) {
 | |
|   const { command, silent = false, job } = options
 | |
| 
 | |
|   return new Promise<void>((res, rej) => {
 | |
|     let shellCommand: string
 | |
| 
 | |
|     command.on('start', cmdline => { shellCommand = cmdline })
 | |
| 
 | |
|     command.on('error', (err, stdout, stderr) => {
 | |
|       if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr, ...lTags() })
 | |
| 
 | |
|       rej(err)
 | |
|     })
 | |
| 
 | |
|     command.on('end', (stdout, stderr) => {
 | |
|       logger.debug('FFmpeg command ended.', { stdout, stderr, shellCommand, ...lTags() })
 | |
| 
 | |
|       res()
 | |
|     })
 | |
| 
 | |
|     if (job) {
 | |
|       command.on('progress', progress => {
 | |
|         if (!progress.percent) return
 | |
| 
 | |
|         job.progress(Math.round(progress.percent))
 | |
|           .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err, ...lTags() }))
 | |
|       })
 | |
|     }
 | |
| 
 | |
|     command.run()
 | |
|   })
 | |
| }
 | |
| 
 | |
| // Avoid "height not divisible by 2" error
 | |
| function getScaleCleanerValue () {
 | |
|   return 'trunc(iw/2)*2:trunc(ih/2)*2'
 | |
| }
 | |
| 
 | |
| // ---------------------------------------------------------------------------
 | |
| 
 | |
| export {
 | |
|   getLiveTranscodingCommand,
 | |
|   getLiveMuxingCommand,
 | |
|   buildStreamSuffix,
 | |
|   convertWebPToJPG,
 | |
|   processGIF,
 | |
|   generateImageFromVideoFile,
 | |
|   TranscodeOptions,
 | |
|   TranscodeOptionsType,
 | |
|   transcode,
 | |
|   runCommand,
 | |
|   getFFmpegVersion,
 | |
| 
 | |
|   resetSupportedEncoders,
 | |
| 
 | |
|   // builders
 | |
|   buildx264VODCommand
 | |
| }
 |