]>
Commit | Line | Data |
---|---|---|
3b01f4c0 | 1 | import { Job } from 'bull' |
14d3270f | 2 | import * as ffmpeg from 'fluent-ffmpeg' |
053aed43 | 3 | import { readFile, remove, writeFile } from 'fs-extra' |
09209296 | 4 | import { dirname, join } from 'path' |
529b3752 | 5 | import { FFMPEG_NICE, VIDEO_LIVE } from '@server/initializers/constants' |
b7c8304c | 6 | import { AvailableEncoders, EncoderOptions, EncoderOptionsBuilder, EncoderProfile, VideoResolution } from '../../shared/models/videos' |
c6c0fa6c | 7 | import { CONFIG } from '../initializers/config' |
b7c8304c | 8 | import { execPromise, promisify0 } from './core-utils' |
884d2c39 | 9 | import { computeFPS, getAudioStream, getVideoFileFPS } from './ffprobe-utils' |
26670720 | 10 | import { processImage } from './image-utils' |
6fdc553a | 11 | import { logger } from './logger' |
14d3270f | 12 | |
6b67897e C |
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 | ||
9252a33d C |
20 | // --------------------------------------------------------------------------- |
21 | // Encoder options | |
22 | // --------------------------------------------------------------------------- | |
23 | ||
1896bca0 | 24 | type StreamType = 'audio' | 'video' |
9252a33d | 25 | |
1896bca0 C |
26 | // --------------------------------------------------------------------------- |
27 | // Encoders support | |
28 | // --------------------------------------------------------------------------- | |
9252a33d | 29 | |
1896bca0 C |
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 | } | |
9252a33d | 36 | |
1896bca0 C |
37 | const getAvailableEncodersPromise = promisify0(ffmpeg.getAvailableEncoders) |
38 | const availableFFmpegEncoders = await getAvailableEncodersPromise() | |
9252a33d | 39 | |
1896bca0 C |
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 | } | |
9252a33d | 48 | |
1896bca0 | 49 | supportedEncoders = new Map<string, boolean>() |
9252a33d | 50 | |
1896bca0 C |
51 | for (const searchEncoder of searchEncoders) { |
52 | supportedEncoders.set(searchEncoder, availableFFmpegEncoders[searchEncoder] !== undefined) | |
529b3752 C |
53 | } |
54 | ||
1896bca0 | 55 | logger.info('Built supported ffmpeg encoders.', { supportedEncoders, searchEncoders }) |
529b3752 | 56 | |
1896bca0 | 57 | return supportedEncoders |
9252a33d C |
58 | } |
59 | ||
1896bca0 C |
60 | function resetSupportedEncoders () { |
61 | supportedEncoders = undefined | |
62 | } | |
529b3752 | 63 | |
9252a33d C |
64 | // --------------------------------------------------------------------------- |
65 | // Image manipulation | |
66 | // --------------------------------------------------------------------------- | |
67 | ||
68 | function convertWebPToJPG (path: string, destination: string): Promise<void> { | |
a4a8cd39 | 69 | const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) |
9252a33d C |
70 | .output(destination) |
71 | ||
cd2c3dcd | 72 | return runCommand({ command, silent: true }) |
9252a33d C |
73 | } |
74 | ||
75 | function processGIF ( | |
76 | path: string, | |
77 | destination: string, | |
f619de0e | 78 | newSize: { width: number, height: number } |
9252a33d | 79 | ): Promise<void> { |
a4a8cd39 | 80 | const command = ffmpeg(path, { niceness: FFMPEG_NICE.THUMBNAIL }) |
f619de0e C |
81 | .fps(20) |
82 | .size(`${newSize.width}x${newSize.height}`) | |
83 | .output(destination) | |
9252a33d | 84 | |
cd2c3dcd | 85 | return runCommand({ command }) |
9252a33d C |
86 | } |
87 | ||
26670720 C |
88 | async function generateImageFromVideoFile (fromPath: string, folder: string, imageName: string, size: { width: number, height: number }) { |
89 | const pendingImageName = 'pending-' + imageName | |
90 | ||
14d3270f | 91 | const options = { |
26670720 | 92 | filename: pendingImageName, |
14d3270f C |
93 | count: 1, |
94 | folder | |
95 | } | |
96 | ||
26670720 | 97 | const pendingImagePath = join(folder, pendingImageName) |
6fdc553a C |
98 | |
99 | try { | |
100 | await new Promise<string>((res, rej) => { | |
7160878c | 101 | ffmpeg(fromPath, { niceness: FFMPEG_NICE.THUMBNAIL }) |
6fdc553a C |
102 | .on('error', rej) |
103 | .on('end', () => res(imageName)) | |
104 | .thumbnail(options) | |
105 | }) | |
106 | ||
107 | const destination = join(folder, imageName) | |
2fb5b3a5 | 108 | await processImage(pendingImagePath, destination, size) |
6fdc553a | 109 | } catch (err) { |
d5b7d911 | 110 | logger.error('Cannot generate image from video %s.', fromPath, { err }) |
6fdc553a C |
111 | |
112 | try { | |
62689b94 | 113 | await remove(pendingImagePath) |
6fdc553a | 114 | } catch (err) { |
d5b7d911 | 115 | logger.debug('Cannot remove pending image path after generation error.', { err }) |
6fdc553a C |
116 | } |
117 | } | |
14d3270f C |
118 | } |
119 | ||
daf6e480 C |
120 | // --------------------------------------------------------------------------- |
121 | // Transcode meta function | |
122 | // --------------------------------------------------------------------------- | |
123 | ||
2650d6d4 | 124 | type TranscodeOptionsType = 'hls' | 'hls-from-ts' | 'quick-transcode' | 'video' | 'merge-audio' | 'only-audio' |
536598cf C |
125 | |
126 | interface BaseTranscodeOptions { | |
127 | type: TranscodeOptionsType | |
9252a33d | 128 | |
14d3270f C |
129 | inputPath: string |
130 | outputPath: string | |
9252a33d C |
131 | |
132 | availableEncoders: AvailableEncoders | |
133 | profile: string | |
134 | ||
318b0bd0 | 135 | resolution: number |
9252a33d | 136 | |
056aa7f2 | 137 | isPortraitMode?: boolean |
3b01f4c0 C |
138 | |
139 | job?: Job | |
536598cf | 140 | } |
09209296 | 141 | |
536598cf C |
142 | interface HLSTranscodeOptions extends BaseTranscodeOptions { |
143 | type: 'hls' | |
d7a25329 | 144 | copyCodecs: boolean |
536598cf | 145 | hlsPlaylist: { |
4c280004 C |
146 | videoFilename: string |
147 | } | |
14d3270f C |
148 | } |
149 | ||
2650d6d4 C |
150 | interface HLSFromTSTranscodeOptions extends BaseTranscodeOptions { |
151 | type: 'hls-from-ts' | |
152 | ||
e772bdf1 C |
153 | isAAC: boolean |
154 | ||
2650d6d4 C |
155 | hlsPlaylist: { |
156 | videoFilename: string | |
157 | } | |
158 | } | |
159 | ||
536598cf C |
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 | ||
3a149e9f C |
173 | interface OnlyAudioTranscodeOptions extends BaseTranscodeOptions { |
174 | type: 'only-audio' | |
5c7d6508 | 175 | } |
176 | ||
a1587156 C |
177 | type TranscodeOptions = |
178 | HLSTranscodeOptions | |
2650d6d4 | 179 | | HLSFromTSTranscodeOptions |
3a149e9f C |
180 | | VideoTranscodeOptions |
181 | | MergeAudioTranscodeOptions | |
182 | | OnlyAudioTranscodeOptions | |
183 | | QuickTranscodeOptions | |
536598cf | 184 | |
daf6e480 C |
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, | |
2650d6d4 | 190 | 'hls-from-ts': buildHLSVODFromTSCommand, |
daf6e480 C |
191 | 'merge-audio': buildAudioMergeCommand, |
192 | 'only-audio': buildOnlyAudioCommand, | |
9252a33d | 193 | 'video': buildx264VODCommand |
daf6e480 C |
194 | } |
195 | ||
196 | async function transcode (options: TranscodeOptions) { | |
9e2b2e76 C |
197 | logger.debug('Will run transcode.', { options }) |
198 | ||
55223d65 | 199 | let command = getFFmpeg(options.inputPath, 'vod') |
daf6e480 | 200 | .output(options.outputPath) |
14d3270f | 201 | |
daf6e480 | 202 | command = await builders[options.type](command, options) |
7ed2c1a4 | 203 | |
cd2c3dcd | 204 | await runCommand({ command, job: options.job }) |
5ba49f26 | 205 | |
daf6e480 | 206 | await fixHLSPlaylistIfNeeded(options) |
837666fe RK |
207 | } |
208 | ||
9252a33d C |
209 | // --------------------------------------------------------------------------- |
210 | // Live muxing/transcoding functions | |
211 | // --------------------------------------------------------------------------- | |
123f6193 | 212 | |
5a547f69 C |
213 | async function getLiveTranscodingCommand (options: { |
214 | rtmpUrl: string | |
215 | outPath: string | |
216 | resolutions: number[] | |
217 | fps: number | |
5a547f69 C |
218 | |
219 | availableEncoders: AvailableEncoders | |
220 | profile: string | |
221 | }) { | |
937581b8 | 222 | const { rtmpUrl, outPath, resolutions, fps, availableEncoders, profile } = options |
5a547f69 C |
223 | const input = rtmpUrl |
224 | ||
55223d65 | 225 | const command = getFFmpeg(input, 'live') |
c6c0fa6c C |
226 | |
227 | const varStreamMap: string[] = [] | |
228 | ||
b110820d | 229 | const complexFilter: ffmpeg.FilterSpecification[] = [ |
c6c0fa6c C |
230 | { |
231 | inputs: '[v:0]', | |
232 | filter: 'split', | |
233 | options: resolutions.length, | |
234 | outputs: resolutions.map(r => `vtemp${r}`) | |
3e03b961 C |
235 | } |
236 | ] | |
c6c0fa6c | 237 | |
49bcdb0d | 238 | command.outputOption('-sc_threshold 0') |
c6c0fa6c | 239 | |
ce4a50b9 C |
240 | addDefaultEncoderGlobalParams({ command }) |
241 | ||
c6c0fa6c C |
242 | for (let i = 0; i < resolutions.length; i++) { |
243 | const resolution = resolutions[i] | |
884d2c39 C |
244 | const resolutionFPS = computeFPS(fps, resolution) |
245 | ||
246 | const baseEncoderBuilderParams = { | |
247 | input, | |
529b3752 | 248 | |
884d2c39 C |
249 | availableEncoders, |
250 | profile, | |
529b3752 | 251 | |
884d2c39 C |
252 | fps: resolutionFPS, |
253 | resolution, | |
254 | streamNum: i, | |
255 | videoType: 'live' as 'live' | |
256 | } | |
5a547f69 C |
257 | |
258 | { | |
529b3752 C |
259 | const streamType: StreamType = 'video' |
260 | const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) | |
5a547f69 C |
261 | if (!builderResult) { |
262 | throw new Error('No available live video encoder found') | |
263 | } | |
264 | ||
265 | command.outputOption(`-map [vout${resolution}]`) | |
266 | ||
884d2c39 | 267 | addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) |
5a547f69 | 268 | |
1896bca0 | 269 | logger.debug('Apply ffmpeg live video params from %s using %s profile.', builderResult.encoder, profile, builderResult) |
c6c0fa6c | 270 | |
5a547f69 | 271 | command.outputOption(`${buildStreamSuffix('-c:v', i)} ${builderResult.encoder}`) |
43f7a43c | 272 | applyEncoderOptions(command, builderResult.result) |
3e03b961 C |
273 | |
274 | complexFilter.push({ | |
275 | inputs: `vtemp${resolution}`, | |
276 | filter: getScaleFilter(builderResult.result), | |
277 | options: `w=-2:h=${resolution}`, | |
278 | outputs: `vout${resolution}` | |
279 | }) | |
5a547f69 C |
280 | } |
281 | ||
282 | { | |
529b3752 C |
283 | const streamType: StreamType = 'audio' |
284 | const builderResult = await getEncoderBuilderResult(Object.assign({}, baseEncoderBuilderParams, { streamType })) | |
5a547f69 C |
285 | if (!builderResult) { |
286 | throw new Error('No available live audio encoder found') | |
287 | } | |
c6c0fa6c | 288 | |
5a547f69 C |
289 | command.outputOption('-map a:0') |
290 | ||
884d2c39 | 291 | addDefaultEncoderParams({ command, encoder: builderResult.encoder, fps: resolutionFPS, streamNum: i }) |
5a547f69 | 292 | |
1896bca0 | 293 | logger.debug('Apply ffmpeg live audio params from %s using %s profile.', builderResult.encoder, profile, builderResult) |
5a547f69 C |
294 | |
295 | command.outputOption(`${buildStreamSuffix('-c:a', i)} ${builderResult.encoder}`) | |
43f7a43c | 296 | applyEncoderOptions(command, builderResult.result) |
5a547f69 | 297 | } |
c6c0fa6c C |
298 | |
299 | varStreamMap.push(`v:${i},a:${i}`) | |
300 | } | |
301 | ||
3e03b961 C |
302 | command.complexFilter(complexFilter) |
303 | ||
937581b8 | 304 | addDefaultLiveHLSParams(command, outPath) |
c6c0fa6c C |
305 | |
306 | command.outputOption('-var_stream_map', varStreamMap.join(' ')) | |
307 | ||
c6c0fa6c C |
308 | return command |
309 | } | |
310 | ||
937581b8 | 311 | function getLiveMuxingCommand (rtmpUrl: string, outPath: string) { |
55223d65 | 312 | const command = getFFmpeg(rtmpUrl, 'live') |
c6c0fa6c C |
313 | |
314 | command.outputOption('-c:v copy') | |
315 | command.outputOption('-c:a copy') | |
316 | command.outputOption('-map 0:a?') | |
317 | command.outputOption('-map 0:v?') | |
318 | ||
937581b8 | 319 | addDefaultLiveHLSParams(command, outPath) |
c6c0fa6c | 320 | |
c6c0fa6c C |
321 | return command |
322 | } | |
323 | ||
5a547f69 C |
324 | function buildStreamSuffix (base: string, streamNum?: number) { |
325 | if (streamNum !== undefined) { | |
326 | return `${base}:${streamNum}` | |
327 | } | |
328 | ||
329 | return base | |
330 | } | |
331 | ||
9252a33d C |
332 | // --------------------------------------------------------------------------- |
333 | // Default options | |
334 | // --------------------------------------------------------------------------- | |
335 | ||
ce4a50b9 C |
336 | function addDefaultEncoderGlobalParams (options: { |
337 | command: ffmpeg.FfmpegCommand | |
338 | }) { | |
339 | const { command } = options | |
340 | ||
341 | // avoid issues when transcoding some files: https://trac.ffmpeg.org/ticket/6375 | |
342 | command.outputOption('-max_muxing_queue_size 1024') | |
343 | // strip all metadata | |
344 | .outputOption('-map_metadata -1') | |
345 | // NOTE: b-strategy 1 - heuristic algorithm, 16 is optimal B-frames for it | |
346 | .outputOption('-b_strategy 1') | |
347 | // NOTE: Why 16: https://github.com/Chocobozzz/PeerTube/pull/774. b-strategy 2 -> B-frames<16 | |
348 | .outputOption('-bf 16') | |
349 | // allows import of source material with incompatible pixel formats (e.g. MJPEG video) | |
350 | .outputOption('-pix_fmt yuv420p') | |
351 | } | |
352 | ||
5a547f69 C |
353 | function addDefaultEncoderParams (options: { |
354 | command: ffmpeg.FfmpegCommand | |
355 | encoder: 'libx264' | string | |
356 | streamNum?: number | |
357 | fps?: number | |
358 | }) { | |
359 | const { command, encoder, fps, streamNum } = options | |
360 | ||
361 | if (encoder === 'libx264') { | |
362 | // 3.1 is the minimal resource allocation for our highest supported resolution | |
ce4a50b9 | 363 | command.outputOption(buildStreamSuffix('-level:v', streamNum) + ' 3.1') |
5a547f69 C |
364 | |
365 | if (fps) { | |
366 | // Keyframe interval of 2 seconds for faster seeking and resolution switching. | |
367 | // https://streaminglearningcenter.com/blogs/whats-the-right-keyframe-interval.html | |
368 | // https://superuser.com/a/908325 | |
ce4a50b9 | 369 | command.outputOption(buildStreamSuffix('-g:v', streamNum) + ' ' + (fps * 2)) |
5a547f69 C |
370 | } |
371 | } | |
c6c0fa6c C |
372 | } |
373 | ||
937581b8 | 374 | function addDefaultLiveHLSParams (command: ffmpeg.FfmpegCommand, outPath: string) { |
68e70a74 | 375 | command.outputOption('-hls_time ' + VIDEO_LIVE.SEGMENT_TIME_SECONDS) |
fb719404 | 376 | command.outputOption('-hls_list_size ' + VIDEO_LIVE.SEGMENTS_LIST_SIZE) |
49bcdb0d | 377 | command.outputOption('-hls_flags delete_segments+independent_segments') |
21226063 | 378 | command.outputOption(`-hls_segment_filename ${join(outPath, '%v-%06d.ts')}`) |
c6c0fa6c C |
379 | command.outputOption('-master_pl_name master.m3u8') |
380 | command.outputOption(`-f hls`) | |
381 | ||
382 | command.output(join(outPath, '%v.m3u8')) | |
383 | } | |
384 | ||
9252a33d C |
385 | // --------------------------------------------------------------------------- |
386 | // Transcode VOD command builders | |
387 | // --------------------------------------------------------------------------- | |
388 | ||
389 | async function buildx264VODCommand (command: ffmpeg.FfmpegCommand, options: TranscodeOptions) { | |
14aed608 | 390 | let fps = await getVideoFileFPS(options.inputPath) |
884d2c39 | 391 | fps = computeFPS(fps, options.resolution) |
14aed608 | 392 | |
3e03b961 | 393 | let scaleFilterValue: string |
14aed608 C |
394 | |
395 | if (options.resolution !== undefined) { | |
3e03b961 | 396 | scaleFilterValue = options.isPortraitMode === true |
a60696ab C |
397 | ? `w=${options.resolution}:h=-2` |
398 | : `w=-2:h=${options.resolution}` | |
14aed608 C |
399 | } |
400 | ||
3e03b961 C |
401 | command = await presetVideo({ command, input: options.inputPath, transcodeOptions: options, fps, scaleFilterValue }) |
402 | ||
14aed608 C |
403 | return command |
404 | } | |
405 | ||
536598cf C |
406 | async function buildAudioMergeCommand (command: ffmpeg.FfmpegCommand, options: MergeAudioTranscodeOptions) { |
407 | command = command.loop(undefined) | |
408 | ||
318b0bd0 | 409 | const scaleFilterValue = getScaleCleanerValue() |
3e03b961 | 410 | command = await presetVideo({ command, input: options.audioPath, transcodeOptions: options, scaleFilterValue }) |
9252a33d | 411 | |
9252a33d | 412 | command.outputOption('-preset:v veryfast') |
536598cf C |
413 | |
414 | command = command.input(options.audioPath) | |
536598cf C |
415 | .outputOption('-tune stillimage') |
416 | .outputOption('-shortest') | |
417 | ||
418 | return command | |
419 | } | |
420 | ||
daf6e480 | 421 | function buildOnlyAudioCommand (command: ffmpeg.FfmpegCommand, _options: OnlyAudioTranscodeOptions) { |
a1587156 | 422 | command = presetOnlyAudio(command) |
5c7d6508 | 423 | |
424 | return command | |
425 | } | |
426 | ||
a1587156 C |
427 | function buildQuickTranscodeCommand (command: ffmpeg.FfmpegCommand) { |
428 | command = presetCopy(command) | |
536598cf C |
429 | |
430 | command = command.outputOption('-map_metadata -1') // strip all metadata | |
431 | .outputOption('-movflags faststart') | |
432 | ||
433 | return command | |
434 | } | |
435 | ||
2650d6d4 C |
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 | ||
c6c0fa6c | 446 | async function buildHLSVODCommand (command: ffmpeg.FfmpegCommand, options: HLSTranscodeOptions) { |
14aed608 C |
447 | const videoPath = getHLSVideoPath(options) |
448 | ||
a1587156 | 449 | if (options.copyCodecs) command = presetCopy(command) |
1c320673 | 450 | else if (options.resolution === VideoResolution.H_NOVIDEO) command = presetOnlyAudio(command) |
9252a33d | 451 | else command = await buildx264VODCommand(command, options) |
14aed608 | 452 | |
2650d6d4 C |
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 | ||
3851e732 | 461 | command.outputOption('-c copy') |
e772bdf1 C |
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 | } | |
2650d6d4 C |
468 | |
469 | addCommonHLSVODCommandOptions(command, videoPath) | |
14aed608 C |
470 | |
471 | return command | |
472 | } | |
473 | ||
536598cf | 474 | async function fixHLSPlaylistIfNeeded (options: TranscodeOptions) { |
2650d6d4 | 475 | if (options.type !== 'hls' && options.type !== 'hls-from-ts') return |
7f8f8bdb | 476 | |
7f8f8bdb C |
477 | const fileContent = await readFile(options.outputPath) |
478 | ||
479 | const videoFileName = options.hlsPlaylist.videoFilename | |
480 | const videoFilePath = getHLSVideoPath(options) | |
481 | ||
536598cf | 482 | // Fix wrong mapping with some ffmpeg versions |
7f8f8bdb C |
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 | ||
2650d6d4 | 489 | function getHLSVideoPath (options: HLSTranscodeOptions | HLSFromTSTranscodeOptions) { |
9252a33d | 490 | return `${dirname(options.outputPath)}/${options.hlsPlaylist.videoFilename}` |
4176e227 RK |
491 | } |
492 | ||
9252a33d C |
493 | // --------------------------------------------------------------------------- |
494 | // Transcoding presets | |
495 | // --------------------------------------------------------------------------- | |
496 | ||
529b3752 C |
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 | |
5a547f69 | 500 | async function getEncoderBuilderResult (options: { |
529b3752 | 501 | streamType: 'video' | 'audio' |
5a547f69 C |
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 | ||
1896bca0 C |
515 | const encodersToTry = availableEncoders.encodersToTry[videoType][streamType] |
516 | const encoders = availableEncoders.available[videoType] | |
5a547f69 C |
517 | |
518 | for (const encoder of encodersToTry) { | |
1896bca0 C |
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 | } | |
5a547f69 | 528 | |
529b3752 C |
529 | // An object containing available profiles for this encoder |
530 | const builderProfiles: EncoderProfile<EncoderOptionsBuilder> = encoders[encoder] | |
5a547f69 C |
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 | |
529b3752 C |
536 | |
537 | if (!builder) { | |
538 | logger.debug('Default profile for encoder %s not available. Try next available encoder.', encoder) | |
539 | continue | |
540 | } | |
5a547f69 C |
541 | } |
542 | ||
318b0bd0 | 543 | const result = await builder({ input, resolution, fps, streamNum }) |
5a547f69 C |
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 | ||
3e03b961 C |
558 | async function presetVideo (options: { |
559 | command: ffmpeg.FfmpegCommand | |
560 | input: string | |
561 | transcodeOptions: TranscodeOptions | |
9252a33d | 562 | fps?: number |
3e03b961 C |
563 | scaleFilterValue?: string |
564 | }) { | |
565 | const { command, input, transcodeOptions, fps, scaleFilterValue } = options | |
566 | ||
cdf4cb9e | 567 | let localCommand = command |
4176e227 | 568 | .format('mp4') |
4176e227 | 569 | .outputOption('-movflags faststart') |
4176e227 | 570 | |
ce4a50b9 C |
571 | addDefaultEncoderGlobalParams({ command }) |
572 | ||
9252a33d | 573 | // Audio encoder |
daf6e480 | 574 | const parsedAudio = await getAudioStream(input) |
4176e227 | 575 | |
529b3752 | 576 | let streamsToProcess: StreamType[] = [ 'audio', 'video' ] |
9252a33d | 577 | |
cdf4cb9e C |
578 | if (!parsedAudio.audioStream) { |
579 | localCommand = localCommand.noAudio() | |
1896bca0 | 580 | streamsToProcess = [ 'video' ] |
9252a33d | 581 | } |
536598cf | 582 | |
5a547f69 C |
583 | for (const streamType of streamsToProcess) { |
584 | const { profile, resolution, availableEncoders } = transcodeOptions | |
585 | ||
586 | const builderResult = await getEncoderBuilderResult({ | |
587 | streamType, | |
588 | input, | |
589 | resolution, | |
590 | availableEncoders, | |
591 | profile, | |
592 | fps, | |
593 | videoType: 'vod' as 'vod' | |
594 | }) | |
9252a33d | 595 | |
5a547f69 C |
596 | if (!builderResult) { |
597 | throw new Error('No available encoder found for stream ' + streamType) | |
598 | } | |
9252a33d | 599 | |
1896bca0 C |
600 | logger.debug( |
601 | 'Apply ffmpeg params from %s for %s stream of input %s using %s profile.', | |
602 | builderResult.encoder, streamType, input, profile, builderResult | |
603 | ) | |
9252a33d | 604 | |
529b3752 | 605 | if (streamType === 'video') { |
5a547f69 | 606 | localCommand.videoCodec(builderResult.encoder) |
3e03b961 C |
607 | |
608 | if (scaleFilterValue) { | |
609 | localCommand.outputOption(`-vf ${getScaleFilter(builderResult.result)}=${scaleFilterValue}`) | |
610 | } | |
529b3752 | 611 | } else if (streamType === 'audio') { |
5a547f69 | 612 | localCommand.audioCodec(builderResult.encoder) |
9252a33d | 613 | } |
3e03b961 | 614 | |
43f7a43c | 615 | applyEncoderOptions(localCommand, builderResult.result) |
5a547f69 | 616 | addDefaultEncoderParams({ command: localCommand, encoder: builderResult.encoder, fps }) |
536598cf | 617 | } |
bcf21a37 | 618 | |
cdf4cb9e | 619 | return localCommand |
4176e227 | 620 | } |
14aed608 | 621 | |
a1587156 | 622 | function presetCopy (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { |
14aed608 C |
623 | return command |
624 | .format('mp4') | |
625 | .videoCodec('copy') | |
626 | .audioCodec('copy') | |
627 | } | |
5c7d6508 | 628 | |
a1587156 | 629 | function presetOnlyAudio (command: ffmpeg.FfmpegCommand): ffmpeg.FfmpegCommand { |
5c7d6508 | 630 | return command |
631 | .format('mp4') | |
632 | .audioCodec('copy') | |
633 | .noVideo() | |
634 | } | |
c6c0fa6c | 635 | |
43f7a43c TLC |
636 | function applyEncoderOptions (command: ffmpeg.FfmpegCommand, options: EncoderOptions): ffmpeg.FfmpegCommand { |
637 | return command | |
638 | .inputOptions(options.inputOptions ?? []) | |
43f7a43c TLC |
639 | .outputOptions(options.outputOptions ?? []) |
640 | } | |
641 | ||
3e03b961 C |
642 | function getScaleFilter (options: EncoderOptions): string { |
643 | if (options.scaleFilter) return options.scaleFilter.name | |
644 | ||
645 | return 'scale' | |
646 | } | |
647 | ||
9252a33d C |
648 | // --------------------------------------------------------------------------- |
649 | // Utils | |
650 | // --------------------------------------------------------------------------- | |
651 | ||
55223d65 | 652 | function getFFmpeg (input: string, type: 'live' | 'vod') { |
c6c0fa6c | 653 | // We set cwd explicitly because ffmpeg appears to create temporary files when trancoding which fails in read-only file systems |
7abb6060 RK |
654 | const command = ffmpeg(input, { |
655 | niceness: type === 'live' ? FFMPEG_NICE.LIVE : FFMPEG_NICE.VOD, | |
656 | cwd: CONFIG.STORAGE.TMP_DIR | |
657 | }) | |
c6c0fa6c | 658 | |
55223d65 C |
659 | const threads = type === 'live' |
660 | ? CONFIG.LIVE.TRANSCODING.THREADS | |
661 | : CONFIG.TRANSCODING.THREADS | |
662 | ||
663 | if (threads > 0) { | |
c6c0fa6c | 664 | // If we don't set any threads ffmpeg will chose automatically |
55223d65 | 665 | command.outputOption('-threads ' + threads) |
c6c0fa6c C |
666 | } |
667 | ||
668 | return command | |
669 | } | |
9252a33d | 670 | |
ae71acca C |
671 | function getFFmpegVersion () { |
672 | return new Promise<string>((res, rej) => { | |
673 | (ffmpeg() as any)._getFfmpegPath((err, ffmpegPath) => { | |
674 | if (err) return rej(err) | |
675 | if (!ffmpegPath) return rej(new Error('Could not find ffmpeg path')) | |
676 | ||
677 | return execPromise(`${ffmpegPath} -version`) | |
678 | .then(stdout => { | |
60f1f615 | 679 | const parsed = stdout.match(/ffmpeg version .?(\d+\.\d+(\.\d+)?)/) |
ae71acca C |
680 | if (!parsed || !parsed[1]) return rej(new Error(`Could not find ffmpeg version in ${stdout}`)) |
681 | ||
60f1f615 C |
682 | // Fix ffmpeg version that does not include patch version (4.4 for example) |
683 | let version = parsed[1] | |
1ff9f1cd | 684 | if (version.match(/^\d+\.\d+$/)) { |
60f1f615 C |
685 | version += '.0' |
686 | } | |
687 | ||
688 | return res(version) | |
ae71acca C |
689 | }) |
690 | .catch(err => rej(err)) | |
691 | }) | |
692 | }) | |
693 | } | |
694 | ||
cd2c3dcd C |
695 | async function runCommand (options: { |
696 | command: ffmpeg.FfmpegCommand | |
697 | silent?: boolean // false | |
698 | job?: Job | |
699 | }) { | |
700 | const { command, silent = false, job } = options | |
701 | ||
9252a33d C |
702 | return new Promise<void>((res, rej) => { |
703 | command.on('error', (err, stdout, stderr) => { | |
cd2c3dcd C |
704 | if (silent !== true) logger.error('Error in ffmpeg.', { stdout, stderr }) |
705 | ||
9252a33d C |
706 | rej(err) |
707 | }) | |
708 | ||
dd9c7929 C |
709 | command.on('end', (stdout, stderr) => { |
710 | logger.debug('FFmpeg command ended.', { stdout, stderr }) | |
711 | ||
9252a33d C |
712 | res() |
713 | }) | |
714 | ||
3b01f4c0 C |
715 | if (job) { |
716 | command.on('progress', progress => { | |
717 | if (!progress.percent) return | |
718 | ||
719 | job.progress(Math.round(progress.percent)) | |
720 | .catch(err => logger.warn('Cannot set ffmpeg job progress.', { err })) | |
721 | }) | |
722 | } | |
723 | ||
9252a33d C |
724 | command.run() |
725 | }) | |
726 | } | |
09849603 | 727 | |
318b0bd0 C |
728 | // Avoid "height not divisible by 2" error |
729 | function getScaleCleanerValue () { | |
730 | return 'trunc(iw/2)*2:trunc(ih/2)*2' | |
731 | } | |
732 | ||
09849603 RK |
733 | // --------------------------------------------------------------------------- |
734 | ||
735 | export { | |
736 | getLiveTranscodingCommand, | |
737 | getLiveMuxingCommand, | |
738 | buildStreamSuffix, | |
739 | convertWebPToJPG, | |
740 | processGIF, | |
741 | generateImageFromVideoFile, | |
742 | TranscodeOptions, | |
743 | TranscodeOptionsType, | |
744 | transcode, | |
745 | runCommand, | |
ae71acca | 746 | getFFmpegVersion, |
09849603 | 747 | |
1896bca0 C |
748 | resetSupportedEncoders, |
749 | ||
09849603 RK |
750 | // builders |
751 | buildx264VODCommand | |
752 | } |