]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blob - server/helpers/ffmpeg-utils.ts
Translated using Weblate (Russian)
[github/Chocobozzz/PeerTube.git] / server / helpers / ffmpeg-utils.ts
1 import { Job } from 'bull'
2 import * as ffmpeg from 'fluent-ffmpeg'
3 import { readFile, remove, writeFile } from 'fs-extra'
4 import { dirname, join } from 'path'
5 import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants'
6 import { AvailableEncoders, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos'
7 import { CONFIG } from '../initializers/config'
8 import { promisify0 } from './core-utils'
9 import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils'
10 import { processImage } from './image-utils'
11 import { logger } from './logger'
12
13 /**
14 *
15 * Functions that run transcoding/muxing ffmpeg processes
16 * Mainly called by lib/video-transcoding.ts and lib/live-manager.ts
17 *
18 */
19
20 // ---------------------------------------------------------------------------
21 // Encoder options
22 // ---------------------------------------------------------------------------
23
24 type StreamType = 'audio' | 'video'
25
26 // ---------------------------------------------------------------------------
27 // Encoders support
28 // ---------------------------------------------------------------------------
29
30 // Detect supported encoders by ffmpeg
31 let supportedEncoders: Map<string, boolean>
32 async function checkFFmpegEncoders (peertubeAvailableEncoders: AvailableEncoders): Promise<Map<string, boolean>> {
33 if (supportedEncoders !== undefined) {
34 return supportedEncoders
35 }
36
37 const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders)
38 const availableFFmpegEncoders = await getAvailableEncodersPromise()
39
40 const searchEncoders = new Set<string>()
41 for (const type of [ 'live', 'vod' ]) {
42 for (const streamType of [ 'audio', 'video' ]) {
43 for (const encoder of peertubeAvailableEncoders.encodersToTry[type][streamType]) {
44 searchEncoders.add(encoder)
45 }
46 }
47 }
48
49 supportedEncoders = new Map<string, boolean>()
50
51 for (const searchEncoder of searchEncoders) {
52 supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined)
53 }
54
55 logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders })
56
57 return supportedEncoders
58 }
59
60 function resetSupportedEncoders () {
61 supportedEncoders = undefined
62 }
63
64 // ---------------------------------------------------------------------------
65 // Image manipulation
66 // ---------------------------------------------------------------------------
67
68 function convertWebPToJPG (path: string, destination: string): Promise<void> {
69 const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
70 .output(destination)
71
72 return runCommand({ command, silent: true })
73 }
74
75 function processGIF (
76 path: string,
77 destination: string,
78 newSize: { width: number, height: number }
79 ): Promise<void> {
80 const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL })
81 .fps(20)
82 .size(`${newSize.width}x${newSize.height}`)
83 .output(destination)
84
85 return runCommand({ command })
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 // ---------------------------------------------------------------------------
121 // Transcode meta function
122 // ---------------------------------------------------------------------------
123
124 type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio'
125
126 interface BaseTranscodeOptions {
127 type: TranscodeOptionsType
128
129 inputPath: string
130 outputPath: string
131
132 availableEncoders: AvailableEncoders
133 profile: string
134
135 resolution: VideoResolution
136
137 isPortraitMode?: boolean
138
139 job?: Job
140 }
141
142 interface HLSTranscodeOptions extends BaseTranscodeOptions {
143 type: 'hls'
144 copyCodecs: boolean
145 hlsPlaylist: {
146 videoFilename: string
147 }
148 }
149
150 interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions {
151 type: 'hls-from-ts'
152
153 isAAC: boolean
154
155 hlsPlaylist: {
156 videoFilename: string
157 }
158 }
159
160 interface QuickTranscodeOptions extends BaseTranscodeOptions {
161 type: 'quick-transcode'
162 }
163
164 interface VideoTranscodeOptions extends BaseTranscodeOptions {
165 type: 'video'
166 }
167
168 interface MergeAudioTranscodeOptions extends BaseTranscodeOptions {
169 type: 'merge-audio'
170 audioPath: string
171 }
172
173 interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions {
174 type: 'only-audio'
175 }
176
177 type TranscodeOptions =
178 HLSTranscodeOptions
179 | HLSFromTSTranscodeOptions
180 | VideoTranscodeOptions
181 | MergeAudioTranscodeOptions
182 | OnlyAudioTranscodeOptions
183 | QuickTranscodeOptions
184
185 const builders: {
186 [ type in TranscodeOptionsType ]: (c: ffmpeg.FfmpegCommand, o?: TranscodeOptions) => Promise<ffmpeg.FfmpegCommand> | ffmpeg.FfmpegCommand
187 } = {
188 'quick-transcode': buildQuickTranscodeCommand,
189 'hls': buildHLSVODCommand,
190 'hls-from-ts': buildHLSVODFromTSCommand,
191 'merge-audio': buildAudioMergeCommand,
192 'only-audio': buildOnlyAudioCommand,
193 'video': buildx264VODCommand
194 }
195
196 async function transcode (options: TranscodeOptions) {
197 logger.debug('Will run transcode.', { options })
198
199 let command = getFFmpeg(options.inputPath, 'vod')
200 .output(options.outputPath)
201
202 command = await builders[options.type](command, options)
203
204 await runCommand({ command, job: options.job })
205
206 await fixHLSPlaylistIfNeeded(options)
207 }
208
209 // ---------------------------------------------------------------------------
210 // Live muxing/transcoding functions
211 // ---------------------------------------------------------------------------
212
213 async function getLiveTranscodingCommand (options: {
214 rtmpUrl: string
215 outPath: string
216 resolutions: number[]
217 fps: number
218
219 availableEncoders: AvailableEncoders
220 profile: string
221 }) {
222 const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options
223 const input = rtmpUrl
224
225 const command = getFFmpeg(input, 'live')
226
227 const varStreamMap: string[] = []
228
229 command.complexFilter([
230 {
231 inputs: '[v:0]',
232 filter: 'split',
233 options: resolutions.length,
234 outputs: resolutions.map(r => `vtemp${r}`)
235 },
236
237 ...resolutions.map(r => ({
238 inputs: `vtemp${r}`,
239 filter: 'scale',
240 options: `w=-2:h=${r}`,
241 outputs: `vout${r}`
242 }))
243 ])
244
245 command.outputOption('-preset superfast')
246 command.outputOption('-sc_threshold 0')
247
248 addDefaultEncoderGlobalParams({ command })
249
250 for (let i = 0; i < resolutions.length; i++) {
251 const resolution = resolutions[i]
252 const resolutionFPS = computeFPS(fps, resolution)
253
254 const baseEncoderBuilderParams = {
255 input,
256
257 availableEncoders,
258 profile,
259
260 fps: resolutionFPS,
261 resolution,
262 streamNum: i,
263 videoType: 'live' as 'live'
264 }
265
266 {
267 const streamType: StreamType = 'video'
268 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
269 if (!builderResult) {
270 throw new Error('No available live video encoder found')
271 }
272
273 command.outputOption(`-map [vout${resolution}]`)
274
275 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
276
277 logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult)
278
279 command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`)
280 command.addOutputOptions(builderResult.result.outputOptions)
281 }
282
283 {
284 const streamType: StreamType = 'audio'
285 const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType }))
286 if (!builderResult) {
287 throw new Error('No available live audio encoder found')
288 }
289
290 command.outputOption('-map a:0')
291
292 addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i })
293
294 logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult)
295
296 command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`)
297 command.addOutputOptions(builderResult.result.outputOptions)
298 }
299
300 varStreamMap.push(`v:${i},a:${i}`)
301 }
302
303 addDefaultLiveHLSParams(command, outPath)
304
305 command.outputOption('-var_stream_map', varStreamMap.join(' '))
306
307 return command
308 }
309
310 function getLiveMuxingCommand (rtmpUrl: string, outPath: string) {
311 const command = getFFmpeg(rtmpUrl, 'live')
312
313 command.outputOption('-c:v copy')
314 command.outputOption('-c:a copy')
315 command.outputOption('-map 0:a?')
316 command.outputOption('-map 0:v?')
317
318 addDefaultLiveHLSParams(command, outPath)
319
320 return command
321 }
322
323 function buildStreamSuffix (base: string, streamNum?: number) {
324 if (streamNum !== undefined) {
325 return `${base}:${streamNum}`
326 }
327
328 return base
329 }
330
331 // ---------------------------------------------------------------------------
332 // Default options
333 // ---------------------------------------------------------------------------
334
335 function addDefaultEncoderGlobalParams (options: {
336 command: ffmpeg.FfmpegCommand
337 }) {
338 const { command } = options
339
340 // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375
341 command.outputOption('-max_muxing_queue_size 1024')
342 // strip all metadata
343 .outputOption('-map_metadata -1')
344 // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it
345 .outputOption('-b_strategy 1')
346 // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16
347 .outputOption('-bf 16')
348 // allows import of source material with incompatible pixel formats (e.g. MJPEG video)
349 .outputOption('-pix_fmt yuv420p')
350 }
351
352 function addDefaultEncoderParams (options: {
353 command: ffmpeg.FfmpegCommand
354 encoder: 'libx264' | string
355 streamNum?: number
356 fps?: number
357 }) {
358 const { command, encoder, fps, streamNum } = options
359
360 if (encoder === 'libx264') {
361 // 3.1 is the minimal resource allocation for our highest supported resolution
362 command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1')
363
364 if (fps) {
365 // Keyframe interval of 2 seconds for faster seeking and resolution switching.
366 // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html
367 // https://superuser.com/a/908325
368 command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2))
369 }
370 }
371 }
372
373 function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) {
374 command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS)
375 command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE)
376 command.outputOption('-hls_flags delete_segments+independent_segments')
377 command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`)
378 command.outputOption('-master_pl_name master.m3u8')
379 command.outputOption(`-f hls`)
380
381 command.output(join(outPath, '%v.m3u8'))
382 }
383
384 // ---------------------------------------------------------------------------
385 // Transcode VOD command builders
386 // ---------------------------------------------------------------------------
387
388 async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) {
389 let fps = await getVideoFileFPS(options.inputPath)
390 fps = computeFPS(fps, options.resolution)
391
392 command = await presetVideo(command, options.inputPath, options, fps)
393
394 if (options.resolution !== undefined) {
395 // '?x720' or '720x?' for example
396 const size = options.isPortraitMode === true
397 ? `${options.resolution}x?`
398 : `?x${options.resolution}`
399
400 command = command.size(size)
401 }
402
403 return command
404 }
405
406 async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) {
407 command = command.loop(undefined)
408
409 command = await presetVideo(command, options.audioPath, options)
410
411 command.outputOption('-preset:v veryfast')
412
413 command = command.input(options.audioPath)
414 .videoFilter('scale=trunc(iw/2)*2:trunc(ih/2)*2') // Avoid "height not divisible by 2" error
415 .outputOption('-tune stillimage')
416 .outputOption('-shortest')
417
418 return command
419 }
420
421 function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) {
422 command = presetOnlyAudio(command)
423
424 return command
425 }
426
427 function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) {
428 command = presetCopy(command)
429
430 command = command.outputOption('-map_metadata -1') // strip all metadata
431 .outputOption('-movflags faststart')
432
433 return command
434 }
435
436 function addCommonHLSVODCommandOptions (command: ffmpeg.FfmpegCommand, outputPath: string) {
437 return command.outputOption('-hls_time 4')
438 .outputOption('-hls_list_size 0')
439 .outputOption('-hls_playlist_type vod')
440 .outputOption('-hls_segment_filename ' + outputPath)
441 .outputOption('-hls_segment_type fmp4')
442 .outputOption('-f hls')
443 .outputOption('-hls_flags single_file')
444 }
445
446 async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) {
447 const videoPath = getHLSVideoPath(options)
448
449 if (options.copyCodecs) command = presetCopy(command)
450 else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command)
451 else command = await buildx264VODCommand(command, options)
452
453 addCommonHLSVODCommandOptions(command, videoPath)
454
455 return command
456 }
457
458 async function buildHLSVODFromTSCommand (command: ffmpeg.FfmpegCommand, options: HLSFromTSTranscodeOptions) {
459 const videoPath = getHLSVideoPath(options)
460
461 command.outputOption('-c copy')
462
463 if (options.isAAC) {
464 // Required for example when copying an AAC stream from an MPEG-TS
465 // Since it's a bitstream filter, we don't need to reencode the audio
466 command.outputOption('-bsf:a aac_adtstoasc')
467 }
468
469 addCommonHLSVODCommandOptions(command, videoPath)
470
471 return command
472 }
473
474 async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) {
475 if (options.type !== 'hls' && options.type !== 'hls-from-ts') return
476
477 const fileContent = await readFile(options.outputPath)
478
479 const videoFileName = options.hlsPlaylist.videoFilename
480 const videoFilePath = getHLSVideoPath(options)
481
482 // Fix wrong mapping with some ffmpeg versions
483 const newContent = fileContent.toString()
484 .replace(`#EXT-X-MAP:URI="${videoFilePath}",`, `#EXT-X-MAP:URI="${videoFileName}",`)
485
486 await writeFile(options.outputPath, newContent)
487 }
488
489 function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) {
490 return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}`
491 }
492
493 // ---------------------------------------------------------------------------
494 // Transcoding presets
495 // ---------------------------------------------------------------------------
496
497 // Run encoder builder depending on available encoders
498 // Try encoders by priority: if the encoder is available, run the chosen profile or fallback to the default one
499 // If the default one does not exist, check the next encoder
500 async function getEncoderBuilderResult (options: {
501 streamType: 'video' | 'audio'
502 input: string
503
504 availableEncoders: AvailableEncoders
505 profile: string
506
507 videoType: 'vod' | 'live'
508
509 resolution: number
510 fps?: number
511 streamNum?: number
512 }) {
513 const { availableEncoders, input, profile, resolution, streamType, fps, streamNum, videoType } = options
514
515 const encodersToTry = availableEncoders.encodersToTry[videoType][streamType]
516 const encoders = availableEncoders.available[videoType]
517
518 for (const encoder of encodersToTry) {
519 if (!(await checkFFmpegEncoders(availableEncoders)).get(encoder)) {
520 logger.debug('Encoder %s not available in ffmpeg, skipping.', encoder)
521 continue
522 }
523
524 if (!encoders[encoder]) {
525 logger.debug('Encoder %s not available in peertube encoders, skipping.', encoder)
526 continue
527 }
528
529 // An object containing available profiles for this encoder
530 const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder]
531 let builder = builderProfiles[profile]
532
533 if (!builder) {
534 logger.debug('Profile %s for encoder %s not available. Fallback to default.', profile, encoder)
535 builder = builderProfiles.default
536
537 if (!builder) {
538 logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder)
539 continue
540 }
541 }
542
543 const result = await builder({ input, resolution: resolution, fps, streamNum })
544
545 return {
546 result,
547
548 // If we don't have output options, then copy the input stream
549 encoder: result.copy === true
550 ? 'copy'
551 : encoder
552 }
553 }
554
555 return null
556 }
557
558 async function presetVideo (
559 command: ffmpeg.FfmpegCommand,
560 input: string,
561 transcodeOptions: TranscodeOptions,
562 fps?: number
563 ) {
564 let localCommand = command
565 .format('mp4')
566 .outputOption('-movflags faststart')
567
568 addDefaultEncoderGlobalParams({ command })
569
570 // Audio encoder
571 const parsedAudio = await getAudioStream(input)
572
573 let streamsToProcess: StreamType[] = [ 'audio', 'video' ]
574
575 if (!parsedAudio.audioStream) {
576 localCommand = localCommand.noAudio()
577 streamsToProcess = [ 'video' ]
578 }
579
580 for (const streamType of streamsToProcess) {
581 const { profile, resolution, availableEncoders } = transcodeOptions
582
583 const builderResult = await getEncoderBuilderResult({
584 streamType,
585 input,
586 resolution,
587 availableEncoders,
588 profile,
589 fps,
590 videoType: 'vod' as 'vod'
591 })
592
593 if (!builderResult) {
594 throw new Error('No available encoder found for stream ' + streamType)
595 }
596
597 logger.debug(
598 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.',
599 builderResult.encoder, streamType, input, profile, builderResult
600 )
601
602 if (streamType === 'video') {
603 localCommand.videoCodec(builderResult.encoder)
604 } else if (streamType === 'audio') {
605 localCommand.audioCodec(builderResult.encoder)
606 }
607
608 command.addOutputOptions(builderResult.result.outputOptions)
609 addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps })
610 }
611
612 return localCommand
613 }
614
615 function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
616 return command
617 .format('mp4')
618 .videoCodec('copy')
619 .audioCodec('copy')
620 }
621
622 function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand {
623 return command
624 .format('mp4')
625 .audioCodec('copy')
626 .noVideo()
627 }
628
629 // ---------------------------------------------------------------------------
630 // Utils
631 // ---------------------------------------------------------------------------
632
633 function getFFmpeg (input: string, type: 'live' | 'vod') {
634 // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems
635 const command = ffmpeg(input, {
636 niceness: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD,
637 cwd: CONFIG.STORAGE.TMP_DIR
638 })
639
640 const threads = type === 'live'
641 ? CONFIG.LIVE.TRANSCODING.THREADS
642 : CONFIG.TRANSCODING.THREADS
643
644 if (threads > 0) {
645 // If we don't set any threads ffmpeg will chose automatically
646 command.outputOption('-threads ' + threads)
647 }
648
649 return command
650 }
651
652 async function runCommand (options: {
653 command: ffmpeg.FfmpegCommand
654 silent?: boolean // false
655 job?: Job
656 }) {
657 const { command, silent = false, job } = options
658
659 return new Promise<void>((res, rej) => {
660 command.on('error', (err, stdout, stderr) => {
661 if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr })
662
663 rej(err)
664 })
665
666 command.on('end', (stdout, stderr) => {
667 logger.debug('FFmpeg command ended.', { stdout, stderr })
668
669 res()
670 })
671
672 if (job) {
673 command.on('progress', progress => {
674 if (!progress.percent) return
675
676 job.progress(Math.round(progress.percent))
677 .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err }))
678 })
679 }
680
681 command.run()
682 })
683 }
684
685 // ---------------------------------------------------------------------------
686
687 export {
688 getLiveTranscodingCommand,
689 getLiveMuxingCommand,
690 buildStreamSuffix,
691 convertWebPToJPG,
692 processGIF,
693 generateImageFromVideoFile,
694 TranscodeOptions,
695 TranscodeOptionsType,
696 transcode,
697 runCommand,
698
699 resetSupportedEncoders,
700
701 // builders
702 buildx264VODCommand
703 }