server/helpers/ffmpeg-utils.ts

   1 import * as ffmpeg from 'fluent-ffmpeg'
   2 import { dirname, join } from 'path'
   3 import { getTargetBitrate, getMaxBitrate, VideoResolution } from '../../shared/models/videos'
   4 import { FFMPEG_NICE, VIDEO_TRANSCODING_FPS } from '../initializers/constants'
   5 import { processImage } from './image-utils'
   6 import { logger } from './logger'
   7 import { checkFFmpegEncoders } from '../initializers/checker-before-init'
   8 import { readFile, remove, writeFile } from 'fs-extra'
   9 import { CONFIG } from '../initializers/config'
  10
  11 function computeResolutionsToTranscode (videoFileHeight: number) {
  12   const resolutionsEnabled: number[] = []
  13   const configResolutions = CONFIG.TRANSCODING.RESOLUTIONS
  14
  15   // Put in the order we want to proceed jobs
  16   const resolutions = [
  17     VideoResolution.H_480P,
  18     VideoResolution.H_360P,
  19     VideoResolution.H_720P,
  20     VideoResolution.H_240P,
  21     VideoResolution.H_1080P
  22   ]
  23
  24   for (const resolution of resolutions) {
  25     if (configResolutions[ resolution + 'p' ] === true && videoFileHeight > resolution) {
  26       resolutionsEnabled.push(resolution)
  27     }
  28   }
  29
  30   return resolutionsEnabled
  31 }
  32
  33 async function getVideoFileSize (path: string) {
  34   const videoStream = await getVideoStreamFromFile(path)
  35
  36   return {
  37     width: videoStream.width,
  38     height: videoStream.height
  39   }
  40 }
  41
  42 async function getVideoFileResolution (path: string) {
  43   const size = await getVideoFileSize(path)
  44
  45   return {
  46     videoFileResolution: Math.min(size.height, size.width),
  47     isPortraitMode: size.height > size.width
  48   }
  49 }
  50
  51 async function getVideoFileFPS (path: string) {
  52   const videoStream = await getVideoStreamFromFile(path)
  53
  54   for (const key of [ 'avg_frame_rate', 'r_frame_rate' ]) {
  55     const valuesText: string = videoStream[key]
  56     if (!valuesText) continue
  57
  58     const [ frames, seconds ] = valuesText.split('/')
  59     if (!frames || !seconds) continue
  60
  61     const result = parseInt(frames, 10) / parseInt(seconds, 10)
  62     if (result > 0) return Math.round(result)
  63   }
  64
  65   return 0
  66 }
  67
  68 async function getVideoFileBitrate (path: string) {
  69   return new Promise<number>((res, rej) => {
  70     ffmpeg.ffprobe(path, (err, metadata) => {
  71       if (err) return rej(err)
  72
  73       return res(metadata.format.bit_rate)
  74     })
  75   })
  76 }
  77
  78 function getDurationFromVideoFile (path: string) {
  79   return new Promise<number>((res, rej) => {
  80     ffmpeg.ffprobe(path, (err, metadata) => {
  81       if (err) return rej(err)
  82
  83       return res(Math.floor(metadata.format.duration))
  84     })
  85   })
  86 }
  87
  88 async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) {
  89   const pendingImageName = 'pending-' + imageName
  90
  91   const options = {
  92     filename: pendingImageName,
  93     count: 1,
  94     folder
  95   }
  96
  97   const pendingImagePath = join(folder, pendingImageName)
  98
  99   try {
 100     await new Promise<string>((res, rej) => {
 101       ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL })
 102         .on('error', rej)
 103         .on('end', () => res(imageName))
 104         .thumbnail(options)
 105     })
 106
 107     const destination = join(folder, imageName)
 108     await processImage(pendingImagePath, destination, size)
 109   } catch (err) {
 110     logger.error('Cannot generate image from video %s.', fromPath, { err })
 111
 112     try {
 113       await remove(pendingImagePath)
 114     } catch (err) {
 115       logger.debug('Cannot remove pending image path after generation error.', { err })
 116     }
 117   }
 118 }
 119
 120 type TranscodeOptions = {
 121   inputPath: string
 122   outputPath: string
 123   resolution: VideoResolution
 124   isPortraitMode?: boolean
 125   doQuickTranscode?: Boolean
 126
 127   hlsPlaylist?: {
 128     videoFilename: string
 129   }
 130 }
 131
 132 function transcode (options: TranscodeOptions) {
 133   return new Promise<void>(async (res, rej) => {
 134     try {
 135       let command = ffmpeg(options.inputPath, { niceness: FFMPEG_NICE.TRANSCODING })
 136         .output(options.outputPath)
 137
 138       if (options.doQuickTranscode) {
 139         if (options.hlsPlaylist) {
 140           throw(Error("Quick transcode and HLS can't be used at the same time"))
 141         }
 142         command
 143           .format('mp4')
 144           .addOption('-c:v copy')
 145           .addOption('-c:a copy')
 146           .outputOption('-map_metadata -1') // strip all metadata
 147           .outputOption('-movflags faststart')
 148       } else if (options.hlsPlaylist) {
 149         command = await buildHLSCommand(command, options)
 150       } else {
 151         command = await buildx264Command(command, options)
 152       }
 153
 154       if (CONFIG.TRANSCODING.THREADS > 0) {
 155         // if we don't set any threads ffmpeg will chose automatically
 156         command = command.outputOption('-threads ' + CONFIG.TRANSCODING.THREADS)
 157       }
 158
 159       command
 160         .on('error', (err, stdout, stderr) => {
 161           logger.error('Error in transcoding job.', { stdout, stderr })
 162           return rej(err)
 163         })
 164         .on('end', () => {
 165           return onTranscodingSuccess(options)
 166             .then(() => res())
 167             .catch(err => rej(err))
 168         })
 169         .run()
 170     } catch (err) {
 171       return rej(err)
 172     }
 173   })
 174 }
 175
 176 async function canDoQuickTranscode (path: string): Promise<boolean> {
 177   // NOTE: This could be optimized by running ffprobe only once (but it runs fast anyway)
 178   const videoStream = await getVideoStreamFromFile(path)
 179   const parsedAudio = await audio.get(path)
 180   const fps = await getVideoFileFPS(path)
 181   const bitRate = await getVideoFileBitrate(path)
 182   const resolution = await getVideoFileResolution(path)
 183
 184   // check video params
 185   if (videoStream[ 'codec_name' ] !== 'h264') {
 186     return false
 187   }
 188   if (fps < VIDEO_TRANSCODING_FPS.MIN || fps > VIDEO_TRANSCODING_FPS.MAX) {
 189     return false
 190   }
 191   if (bitRate > getMaxBitrate(resolution.videoFileResolution, fps, VIDEO_TRANSCODING_FPS)) {
 192     return false
 193   }
 194
 195     // check audio params (if audio stream exists)
 196   if (parsedAudio.audioStream) {
 197     if (parsedAudio.audioStream[ 'codec_name' ] !== 'aac') {
 198       return false
 199     }
 200     const maxAudioBitrate = audio.bitrate[ 'aac' ](parsedAudio.audioStream[ 'bit_rate' ])
 201     if (maxAudioBitrate !== -1 && parsedAudio.audioStream[ 'bit_rate' ] > maxAudioBitrate) {
 202       return false
 203     }
 204   }
 205
 206   return true
 207 }
 208
 209 // ---------------------------------------------------------------------------
 210
 211 export {
 212   getVideoFileSize,
 213   getVideoFileResolution,
 214   getDurationFromVideoFile,
 215   generateImageFromVideoFile,
 216   transcode,
 217   getVideoFileFPS,
 218   computeResolutionsToTranscode,
 219   audio,
 220   getVideoFileBitrate,
 221   canDoQuickTranscode
 222 }
 223
 224 // ---------------------------------------------------------------------------
 225
 226 async function buildx264Command (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
 227   let fps = await getVideoFileFPS(options.inputPath)
 228   // On small/medium resolutions, limit FPS
 229   if (
 230     options.resolution !== undefined &&
 231     options.resolution < VIDEO_TRANSCODING_FPS.KEEP_ORIGIN_FPS_RESOLUTION_MIN &&
 232     fps > VIDEO_TRANSCODING_FPS.AVERAGE
 233   ) {
 234     fps = VIDEO_TRANSCODING_FPS.AVERAGE
 235   }
 236
 237   command = await presetH264(command, options.resolution, fps)
 238
 239   if (options.resolution !== undefined) {
 240     // '?x720' or '720x?' for example
 241     const size = options.isPortraitMode === true ? `${options.resolution}x?` : `?x${options.resolution}`
 242     command = command.size(size)
 243   }
 244
 245   if (fps) {
 246     // Hard FPS limits
 247     if (fps > VIDEO_TRANSCODING_FPS.MAX) fps = VIDEO_TRANSCODING_FPS.MAX
 248     else if (fps < VIDEO_TRANSCODING_FPS.MIN) fps = VIDEO_TRANSCODING_FPS.MIN
 249
 250     command = command.withFPS(fps)
 251   }
 252
 253   return command
 254 }
 255
 256 async function buildHLSCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
 257   const videoPath = getHLSVideoPath(options)
 258
 259   command = await presetCopy(command)
 260
 261   command = command.outputOption('-hls_time 4')
 262                    .outputOption('-hls_list_size 0')
 263                    .outputOption('-hls_playlist_type vod')
 264                    .outputOption('-hls_segment_filename ' + videoPath)
 265                    .outputOption('-hls_segment_type fmp4')
 266                    .outputOption('-f hls')
 267                    .outputOption('-hls_flags single_file')
 268
 269   return command
 270 }
 271
 272 function getHLSVideoPath (options: TranscodeOptions) {
 273   return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
 274 }
 275
 276 async function onTranscodingSuccess (options: TranscodeOptions) {
 277   if (!options.hlsPlaylist) return
 278
 279   // Fix wrong mapping with some ffmpeg versions
 280   const fileContent = await readFile(options.outputPath)
 281
 282   const videoFileName = options.hlsPlaylist.videoFilename
 283   const videoFilePath = getHLSVideoPath(options)
 284
 285   const newContent = fileContent.toString()
 286                                 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
 287
 288   await writeFile(options.outputPath, newContent)
 289 }
 290
 291 function getVideoStreamFromFile (path: string) {
 292   return new Promise<any>((res, rej) => {
 293     ffmpeg.ffprobe(path, (err, metadata) => {
 294       if (err) return rej(err)
 295
 296       const videoStream = metadata.streams.find(s => s.codec_type === 'video')
 297       if (!videoStream) return rej(new Error('Cannot find video stream of ' + path))
 298
 299       return res(videoStream)
 300     })
 301   })
 302 }
 303
 304 /**
 305  * A slightly customised version of the 'veryfast' x264 preset
 306  *
 307  * The veryfast preset is right in the sweet spot of performance
 308  * and quality. Superfast and ultrafast will give you better
 309  * performance, but then quality is noticeably worse.
 310  */
 311 async function presetH264VeryFast (command: ffmpeg.FfmpegCommand, resolution: VideoResolution, fps: number): Promise<ffmpeg.FfmpegCommand> {
 312   let localCommand = await presetH264(command, resolution, fps)
 313   localCommand = localCommand.outputOption('-preset:v veryfast')
 314              .outputOption([ '--aq-mode=2', '--aq-strength=1.3' ])
 315   /*
 316   MAIN reference: https://slhck.info/video/2017/03/01/rate-control.html
 317   Our target situation is closer to a livestream than a stream,
 318   since we want to reduce as much a possible the encoding burden,
 319   altough not to the point of a livestream where there is a hard
 320   constraint on the frames per second to be encoded.
 321
 322   why '--aq-mode=2 --aq-strength=1.3' instead of '-profile:v main'?
 323     Make up for most of the loss of grain and macroblocking
 324     with less computing power.
 325   */
 326
 327   return localCommand
 328 }
 329
 330 /**
 331  * A preset optimised for a stillimage audio video
 332  */
 333 async function presetStillImageWithAudio (
 334   command: ffmpeg.FfmpegCommand,
 335   resolution: VideoResolution,
 336   fps: number
 337 ): Promise<ffmpeg.FfmpegCommand> {
 338   let localCommand = await presetH264VeryFast(command, resolution, fps)
 339   localCommand = localCommand.outputOption('-tune stillimage')
 340
 341   return localCommand
 342 }
 343
 344 /**
 345  * A toolbox to play with audio
 346  */
 347 namespace audio {
 348   export const get = (option: ffmpeg.FfmpegCommand | string) => {
 349     // without position, ffprobe considers the last input only
 350     // we make it consider the first input only
 351     // if you pass a file path to pos, then ffprobe acts on that file directly
 352     return new Promise<{ absolutePath: string, audioStream?: any }>((res, rej) => {
 353
 354       function parseFfprobe (err: any, data: ffmpeg.FfprobeData) {
 355         if (err) return rej(err)
 356
 357         if ('streams' in data) {
 358           const audioStream = data.streams.find(stream => stream['codec_type'] === 'audio')
 359           if (audioStream) {
 360             return res({
 361               absolutePath: data.format.filename,
 362               audioStream
 363             })
 364           }
 365         }
 366
 367         return res({ absolutePath: data.format.filename })
 368       }
 369
 370       if (typeof option === 'string') {
 371         return ffmpeg.ffprobe(option, parseFfprobe)
 372       }
 373
 374       return option.ffprobe(parseFfprobe)
 375     })
 376   }
 377
 378   export namespace bitrate {
 379     const baseKbitrate = 384
 380
 381     const toBits = (kbits: number): number => { return kbits * 8000 }
 382
 383     export const aac = (bitrate: number): number => {
 384       switch (true) {
 385       case bitrate > toBits(baseKbitrate):
 386         return baseKbitrate
 387       default:
 388         return -1 // we interpret it as a signal to copy the audio stream as is
 389       }
 390     }
 391
 392     export const mp3 = (bitrate: number): number => {
 393       /*
 394       a 192kbit/sec mp3 doesn't hold as much information as a 192kbit/sec aac.
 395       That's why, when using aac, we can go to lower kbit/sec. The equivalences
 396       made here are not made to be accurate, especially with good mp3 encoders.
 397       */
 398       switch (true) {
 399       case bitrate <= toBits(192):
 400         return 128
 401       case bitrate <= toBits(384):
 402         return 256
 403       default:
 404         return baseKbitrate
 405       }
 406     }
 407   }
 408 }
 409
 410 /**
 411  * Standard profile, with variable bitrate audio and faststart.
 412  *
 413  * As for the audio, quality '5' is the highest and ensures 96-112kbps/channel
 414  * See https://trac.ffmpeg.org/wiki/Encode/AAC#fdk_vbr
 415  */
 416 async function presetH264 (command: ffmpeg.FfmpegCommand, resolution: VideoResolution, fps: number): Promise<ffmpeg.FfmpegCommand> {
 417   let localCommand = command
 418     .format('mp4')
 419     .videoCodec('libx264')
 420     .outputOption('-level 3.1') // 3.1 is the minimal ressource allocation for our highest supported resolution
 421     .outputOption('-b_strategy 1') // NOTE: b-strategy 1 - heuristic algorythm, 16 is optimal B-frames for it
 422     .outputOption('-bf 16') // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
 423     .outputOption('-pix_fmt yuv420p') // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
 424     .outputOption('-map_metadata -1') // strip all metadata
 425     .outputOption('-movflags faststart')
 426
 427   const parsedAudio = await audio.get(localCommand)
 428
 429   if (!parsedAudio.audioStream) {
 430     localCommand = localCommand.noAudio()
 431   } else if ((await checkFFmpegEncoders()).get('libfdk_aac')) { // we favor VBR, if a good AAC encoder is available
 432     localCommand = localCommand
 433       .audioCodec('libfdk_aac')
 434       .audioQuality(5)
 435   } else {
 436     // we try to reduce the ceiling bitrate by making rough correspondances of bitrates
 437     // of course this is far from perfect, but it might save some space in the end
 438     const audioCodecName = parsedAudio.audioStream[ 'codec_name' ]
 439     let bitrate: number
 440     if (audio.bitrate[ audioCodecName ]) {
 441       localCommand = localCommand.audioCodec('aac')
 442
 443       bitrate = audio.bitrate[ audioCodecName ](parsedAudio.audioStream[ 'bit_rate' ])
 444       if (bitrate !== undefined && bitrate !== -1) localCommand = localCommand.audioBitrate(bitrate)
 445     }
 446   }
 447
 448   // Constrained Encoding (VBV)
 449   // https://slhck.info/video/2017/03/01/rate-control.html
 450   // https://trac.ffmpeg.org/wiki/Limiting%20the%20output%20bitrate
 451   const targetBitrate = getTargetBitrate(resolution, fps, VIDEO_TRANSCODING_FPS)
 452   localCommand = localCommand.outputOptions([`-maxrate ${ targetBitrate }`, `-bufsize ${ targetBitrate * 2 }`])
 453
 454   // Keyframe interval of 2 seconds for faster seeking and resolution switching.
 455   // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
 456   // https://superuser.com/a/908325
 457   localCommand = localCommand.outputOption(`-g ${ fps * 2 }`)
 458
 459   return localCommand
 460 }
 461
 462 async function presetCopy (command: ffmpeg.FfmpegCommand): Promise<ffmpeg.FfmpegCommand> {
 463   return command
 464     .format('mp4')
 465     .videoCodec('copy')
 466     .audioCodec('copy')
 467 }