1 import * as ffmpeg from 'fluent-ffmpeg'
2 import { VideoFileMetadata } from '@shared/models/videos/video-file-metadata'
3 import { getMaxBitrate, VideoResolution } from '../../shared/models/videos'
4 import { CONFIG } from '../initializers/config'
5 import { VIDEO_TRANSCODING_FPS } from '../initializers/constants'
6 import { logger } from './logger'
10 * Helpers to run ffprobe and extract data from the JSON output
14 function ffprobePromise (path: string) {
15 return new Promise<ffmpeg.FfprobeData>((res, rej) => {
16 ffmpeg.ffprobe(path, (err, data) => {
17 if (err) return rej(err)
24 async function getAudioStream (videoPath: string, existingProbe?: ffmpeg.FfprobeData) {
25 // without position, ffprobe considers the last input only
26 // we make it consider the first input only
27 // if you pass a file path to pos, then ffprobe acts on that file directly
28 const data = existingProbe || await ffprobePromise(videoPath)
30 if (Array.isArray(data.streams)) {
31 const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio')
35 absolutePath: data.format.filename,
37 bitrate: parseInt(audioStream['bit_rate'] + '', 10)
42 return { absolutePath: data.format.filename }
45 function getMaxAudioBitrate (type: 'aac' | 'mp3' | string, bitrate: number) {
46 const maxKBitrate = 384
47 const kToBits = (kbits: number) => kbits * 1000
49 // If we did not manage to get the bitrate, use an average value
50 if (!bitrate) return 256
54 case bitrate > kToBits(maxKBitrate):
58 return -1 // we interpret it as a signal to copy the audio stream as is
63 a 192kbit/sec mp3 doesn't hold as much information as a 192kbit/sec aac.
64 That's why, when using aac, we can go to lower kbit/sec. The equivalences
65 made here are not made to be accurate, especially with good mp3 encoders.
68 case bitrate <= kToBits(192):
71 case bitrate <= kToBits(384):
79 async function getVideoStreamSize (path: string, existingProbe?: ffmpeg.FfprobeData) {
80 const videoStream = await getVideoStreamFromFile(path, existingProbe)
82 return videoStream === null
83 ? { width: 0, height: 0 }
84 : { width: videoStream.width, height: videoStream.height }
87 async function getVideoStreamCodec (path: string) {
88 const videoStream = await getVideoStreamFromFile(path)
90 if (!videoStream) return ''
92 const videoCodec = videoStream.codec_tag_string
94 if (videoCodec === 'vp09') return 'vp09.00.50.08'
95 if (videoCodec === 'hev1') return 'hev1.1.6.L93.B0'
97 const baseProfileMatrix = {
110 let baseProfile = baseProfileMatrix[videoCodec][videoStream.profile]
112 logger.warn('Cannot get video profile codec of %s.', path, { videoStream })
113 baseProfile = baseProfileMatrix[videoCodec]['High'] // Fallback
116 if (videoCodec === 'av01') {
117 const level = videoStream.level
119 // Guess the tier indicator and bit depth
120 return `${videoCodec}.${baseProfile}.${level}M.08`
123 // Default, h264 codec
124 let level = videoStream.level.toString(16)
125 if (level.length === 1) level = `0${level}`
127 return `${videoCodec}.${baseProfile}${level}`
130 async function getAudioStreamCodec (path: string, existingProbe?: ffmpeg.FfprobeData) {
131 const { audioStream } = await getAudioStream(path, existingProbe)
133 if (!audioStream) return ''
135 const audioCodecName = audioStream.codec_name
137 if (audioCodecName === 'opus') return 'opus'
138 if (audioCodecName === 'vorbis') return 'vorbis'
139 if (audioCodecName === 'aac') return 'mp4a.40.2'
141 logger.warn('Cannot get audio codec of %s.', path, { audioStream })
143 return 'mp4a.40.2' // Fallback
146 async function getVideoFileResolution (path: string, existingProbe?: ffmpeg.FfprobeData) {
147 const size = await getVideoStreamSize(path, existingProbe)
150 videoFileResolution: Math.min(size.height, size.width),
151 isPortraitMode: size.height > size.width
155 async function getVideoFileFPS (path: string, existingProbe?: ffmpeg.FfprobeData) {
156 const videoStream = await getVideoStreamFromFile(path, existingProbe)
157 if (videoStream === null) return 0
159 for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) {
160 const valuesText: string = videoStream[key]
161 if (!valuesText) continue
163 const [ frames, seconds ] = valuesText.split('/')
164 if (!frames || !seconds) continue
166 const result = parseInt(frames, 10) / parseInt(seconds, 10)
167 if (result > 0) return Math.round(result)
173 async function getMetadataFromFile (path: string, existingProbe?: ffmpeg.FfprobeData) {
174 const metadata = existingProbe || await ffprobePromise(path)
176 return new VideoFileMetadata(metadata)
179 async function getVideoFileBitrate (path: string, existingProbe?: ffmpeg.FfprobeData) {
180 const metadata = await getMetadataFromFile(path, existingProbe)
182 return metadata.format.bit_rate as number
185 async function getDurationFromVideoFile (path: string, existingProbe?: ffmpeg.FfprobeData) {
186 const metadata = await getMetadataFromFile(path, existingProbe)
188 return Math.round(metadata.format.duration)
191 async function getVideoStreamFromFile (path: string, existingProbe?: ffmpeg.FfprobeData) {
192 const metadata = await getMetadataFromFile(path, existingProbe)
194 return metadata.streams.find(s => s.codec_type === 'video') || null
197 function computeResolutionsToTranscode (videoFileResolution: number, type: 'vod' | 'live') {
198 const configResolutions = type === 'vod'
199 ? CONFIG.TRANSCODING.RESOLUTIONS
200 : CONFIG.LIVE.TRANSCODING.RESOLUTIONS
202 const resolutionsEnabled: number[] = []
204 // Put in the order we want to proceed jobs
205 const resolutions = [
206 VideoResolution.H_NOVIDEO,
207 VideoResolution.H_480P,
208 VideoResolution.H_360P,
209 VideoResolution.H_720P,
210 VideoResolution.H_240P,
211 VideoResolution.H_1080P,
212 VideoResolution.H_1440P,
216 for (const resolution of resolutions) {
217 if (configResolutions[resolution + 'p'] === true && videoFileResolution > resolution) {
218 resolutionsEnabled.push(resolution)
222 return resolutionsEnabled
225 async function canDoQuickTranscode (path: string): Promise<boolean> {
226 if (CONFIG.TRANSCODING.PROFILE !== 'default') return false
228 const probe = await ffprobePromise(path)
230 return await canDoQuickVideoTranscode(path, probe) &&
231 await canDoQuickAudioTranscode(path, probe)
234 async function canDoQuickVideoTranscode (path: string, probe?: ffmpeg.FfprobeData): Promise<boolean> {
235 const videoStream = await getVideoStreamFromFile(path, probe)
236 const fps = await getVideoFileFPS(path, probe)
237 const bitRate = await getVideoFileBitrate(path, probe)
238 const resolution = await getVideoFileResolution(path, probe)
240 // If ffprobe did not manage to guess the bitrate
241 if (!bitRate) return false
243 // check video params
244 if (videoStream == null) return false
245 if (videoStream['codec_name'] !== 'h264') return false
246 if (videoStream['pix_fmt'] !== 'yuv420p') return false
247 if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) return false
248 if (bitRate > getMaxBitrate(resolution.videoFileResolution, fps, VIDEO_TRANSCODING_FPS)) return false
253 async function canDoQuickAudioTranscode (path: string, probe?: ffmpeg.FfprobeData): Promise<boolean> {
254 const parsedAudio = await getAudioStream(path, probe)
256 if (!parsedAudio.audioStream) return true
258 if (parsedAudio.audioStream['codec_name'] !== 'aac') return false
260 const audioBitrate = parsedAudio.bitrate
261 if (!audioBitrate) return false
263 const maxAudioBitrate = getMaxAudioBitrate('aac', audioBitrate)
264 if (maxAudioBitrate !== -1 && audioBitrate > maxAudioBitrate) return false
266 const channelLayout = parsedAudio.audioStream['channel_layout']
267 // Causes playback issues with Chrome
268 if (!channelLayout || channelLayout === 'unknown') return false
273 function getClosestFramerateStandard (fps: number, type: 'HD_STANDARD' | 'STANDARD'): number {
274 return VIDEO_TRANSCODING_FPS[type].slice(0)
275 .sort((a, b) => fps % a - fps % b)[0]
278 function computeFPS (fpsArg: number, resolution: VideoResolution) {
282 // On small/medium resolutions, limit FPS
283 resolution !== undefined &&
284 resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
285 fps > VIDEO_TRANSCODING_FPS.AVERAGE
287 // Get closest standard framerate by modulo: downsampling has to be done to a divisor of the nominal fps value
288 fps = getClosestFramerateStandard(fps, 'STANDARD')
292 if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = getClosestFramerateStandard(fps, 'HD_STANDARD')
293 else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN
298 // ---------------------------------------------------------------------------
304 getVideoFileResolution,
307 getVideoStreamFromFile,
308 getDurationFromVideoFile,
313 getClosestFramerateStandard,
314 computeResolutionsToTranscode,
317 canDoQuickVideoTranscode,
318 canDoQuickAudioTranscode