1 import { FfprobeData } from 'fluent-ffmpeg'
2 import { getMaxBitrate } from '@shared/core-utils'
10 getVideoStreamDimensionsInfo,
11 getVideoStreamDuration,
14 } from '@shared/extra-utils/ffprobe'
15 import { VideoResolution, VideoTranscodingFPS } from '@shared/models'
16 import { CONFIG } from '../../initializers/config'
17 import { VIDEO_TRANSCODING_FPS } from '../../initializers/constants'
18 import { logger } from '../logger'
22 * Helpers to run ffprobe and extract data from the JSON output
26 // ---------------------------------------------------------------------------
28 // ---------------------------------------------------------------------------
30 async function getVideoStreamCodec (path: string) {
31 const videoStream = await getVideoStream(path)
32 if (!videoStream) return ''
34 const videoCodec = videoStream.codec_tag_string
36 if (videoCodec === 'vp09') return 'vp09.00.50.08'
37 if (videoCodec === 'hev1') return 'hev1.1.6.L93.B0'
39 const baseProfileMatrix = {
52 let baseProfile = baseProfileMatrix[videoCodec][videoStream.profile]
54 logger.warn('Cannot get video profile codec of %s.', path, { videoStream })
55 baseProfile = baseProfileMatrix[videoCodec]['High'] // Fallback
58 if (videoCodec === 'av01') {
59 const level = videoStream.level
61 // Guess the tier indicator and bit depth
62 return `${videoCodec}.${baseProfile}.${level}M.08`
65 // Default, h264 codec
66 let level = videoStream.level.toString(16)
67 if (level.length === 1) level = `0${level}`
69 return `${videoCodec}.${baseProfile}${level}`
72 async function getAudioStreamCodec (path: string, existingProbe?: FfprobeData) {
73 const { audioStream } = await getAudioStream(path, existingProbe)
75 if (!audioStream) return ''
77 const audioCodecName = audioStream.codec_name
79 if (audioCodecName === 'opus') return 'opus'
80 if (audioCodecName === 'vorbis') return 'vorbis'
81 if (audioCodecName === 'aac') return 'mp4a.40.2'
82 if (audioCodecName === 'mp3') return 'mp4a.40.34'
84 logger.warn('Cannot get audio codec of %s.', path, { audioStream })
86 return 'mp4a.40.2' // Fallback
89 // ---------------------------------------------------------------------------
91 // ---------------------------------------------------------------------------
93 function computeResolutionsToTranscode (options: {
99 const { input, type, includeInput, strictLower } = options
101 const configResolutions = type === 'vod'
102 ? CONFIG.TRANSCODING.RESOLUTIONS
103 : CONFIG.LIVE.TRANSCODING.RESOLUTIONS
105 const resolutionsEnabled = new Set<number>()
107 // Put in the order we want to proceed jobs
108 const availableResolutions: VideoResolution[] = [
109 VideoResolution.H_NOVIDEO,
110 VideoResolution.H_480P,
111 VideoResolution.H_360P,
112 VideoResolution.H_720P,
113 VideoResolution.H_240P,
114 VideoResolution.H_144P,
115 VideoResolution.H_1080P,
116 VideoResolution.H_1440P,
120 for (const resolution of availableResolutions) {
121 // Resolution not enabled
122 if (configResolutions[resolution + 'p'] !== true) continue
123 // Too big resolution for input file
124 if (input < resolution) continue
125 // We only want lower resolutions than input file
126 if (strictLower && input === resolution) continue
128 resolutionsEnabled.add(resolution)
132 resolutionsEnabled.add(input)
135 return Array.from(resolutionsEnabled)
138 // ---------------------------------------------------------------------------
139 // Can quick transcode
140 // ---------------------------------------------------------------------------
142 async function canDoQuickTranscode (path: string): Promise<boolean> {
143 if (CONFIG.TRANSCODING.PROFILE !== 'default') return false
145 const probe = await ffprobePromise(path)
147 return await canDoQuickVideoTranscode(path, probe) &&
148 await canDoQuickAudioTranscode(path, probe)
151 async function canDoQuickAudioTranscode (path: string, probe?: FfprobeData): Promise<boolean> {
152 const parsedAudio = await getAudioStream(path, probe)
154 if (!parsedAudio.audioStream) return true
156 if (parsedAudio.audioStream['codec_name'] !== 'aac') return false
158 const audioBitrate = parsedAudio.bitrate
159 if (!audioBitrate) return false
161 const maxAudioBitrate = getMaxAudioBitrate('aac', audioBitrate)
162 if (maxAudioBitrate !== -1 && audioBitrate > maxAudioBitrate) return false
164 const channelLayout = parsedAudio.audioStream['channel_layout']
165 // Causes playback issues with Chrome
166 if (!channelLayout || channelLayout === 'unknown' || channelLayout === 'quad') return false
171 async function canDoQuickVideoTranscode (path: string, probe?: FfprobeData): Promise<boolean> {
172 const videoStream = await getVideoStream(path, probe)
173 const fps = await getVideoStreamFPS(path, probe)
174 const bitRate = await getVideoStreamBitrate(path, probe)
175 const resolutionData = await getVideoStreamDimensionsInfo(path, probe)
177 // If ffprobe did not manage to guess the bitrate
178 if (!bitRate) return false
180 // check video params
181 if (!videoStream) return false
182 if (videoStream['codec_name'] !== 'h264') return false
183 if (videoStream['pix_fmt'] !== 'yuv420p') return false
184 if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) return false
185 if (bitRate > getMaxBitrate({ ...resolutionData, fps })) return false
190 // ---------------------------------------------------------------------------
192 // ---------------------------------------------------------------------------
194 function getClosestFramerateStandard <K extends keyof Pick<VideoTranscodingFPS, 'HD_STANDARD' | 'STANDARD'>> (fps: number, type: K) {
195 return VIDEO_TRANSCODING_FPS[type].slice(0)
196 .sort((a, b) => fps % a - fps % b)[0]
199 function computeFPS (fpsArg: number, resolution: VideoResolution) {
203 // On small/medium resolutions, limit FPS
204 resolution !== undefined &&
205 resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
206 fps > VIDEO_TRANSCODING_FPS.AVERAGE
208 // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value
209 fps = getClosestFramerateStandard(fps, 'STANDARD')
213 if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = getClosestFramerateStandard(fps, 'HD_STANDARD')
215 if (fps < VIDEO_TRANSCODING_FPS.MIN) {
216 throw new Error(`Cannot compute FPS because ${fps} is lower than our minimum value ${VIDEO_TRANSCODING_FPS.MIN}`)
222 // ---------------------------------------------------------------------------
225 // Re export ffprobe utils
226 getVideoStreamDimensionsInfo,
230 getVideoStreamDuration,
235 getVideoStreamBitrate,
241 getClosestFramerateStandard,
243 computeResolutionsToTranscode,
246 canDoQuickVideoTranscode,
247 canDoQuickAudioTranscode