]> jfr.im git - yt-dlp.git/blob - yt_dlp/postprocessor/ffmpeg.py
[reddit] Fix for quarantined subreddits (#848)
[yt-dlp.git] / yt_dlp / postprocessor / ffmpeg.py
1 from __future__ import unicode_literals
2
3 import io
4 import itertools
5 import os
6 import subprocess
7 import time
8 import re
9 import json
10
11
12 from .common import AudioConversionError, PostProcessor
13
14 from ..compat import compat_str, compat_numeric_types
15 from ..utils import (
16 encodeArgument,
17 encodeFilename,
18 get_exe_version,
19 is_outdated_version,
20 PostProcessingError,
21 prepend_extension,
22 shell_quote,
23 dfxp2srt,
24 ISO639Utils,
25 process_communicate_or_kill,
26 replace_extension,
27 traverse_obj,
28 variadic,
29 )
30
31
32 EXT_TO_OUT_FORMATS = {
33 'aac': 'adts',
34 'flac': 'flac',
35 'm4a': 'ipod',
36 'mka': 'matroska',
37 'mkv': 'matroska',
38 'mpg': 'mpeg',
39 'ogv': 'ogg',
40 'ts': 'mpegts',
41 'wma': 'asf',
42 'wmv': 'asf',
43 }
44 ACODECS = {
45 'mp3': 'libmp3lame',
46 'aac': 'aac',
47 'flac': 'flac',
48 'm4a': 'aac',
49 'opus': 'libopus',
50 'vorbis': 'libvorbis',
51 'wav': None,
52 }
53
54
55 class FFmpegPostProcessorError(PostProcessingError):
56 pass
57
58
59 class FFmpegPostProcessor(PostProcessor):
60 def __init__(self, downloader=None):
61 PostProcessor.__init__(self, downloader)
62 self._determine_executables()
63
64 def check_version(self):
65 if not self.available:
66 raise FFmpegPostProcessorError('ffmpeg not found. Please install or provide the path using --ffmpeg-location')
67
68 required_version = '10-0' if self.basename == 'avconv' else '1.0'
69 if is_outdated_version(
70 self._versions[self.basename], required_version):
71 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
72 self.basename, self.basename, required_version)
73 self.report_warning(warning)
74
75 @staticmethod
76 def get_versions(downloader=None):
77 return FFmpegPostProcessor(downloader)._versions
78
79 def _determine_executables(self):
80 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
81 prefer_ffmpeg = True
82
83 def get_ffmpeg_version(path):
84 ver = get_exe_version(path, args=['-version'])
85 if ver:
86 regexs = [
87 r'(?:\d+:)?([0-9.]+)-[0-9]+ubuntu[0-9.]+$', # Ubuntu, see [1]
88 r'n([0-9.]+)$', # Arch Linux
89 # 1. http://www.ducea.com/2006/06/17/ubuntu-package-version-naming-explanation/
90 ]
91 for regex in regexs:
92 mobj = re.match(regex, ver)
93 if mobj:
94 ver = mobj.group(1)
95 return ver
96
97 self.basename = None
98 self.probe_basename = None
99
100 self._paths = None
101 self._versions = None
102 if self._downloader:
103 prefer_ffmpeg = self.get_param('prefer_ffmpeg', True)
104 location = self.get_param('ffmpeg_location')
105 if location is not None:
106 if not os.path.exists(location):
107 self.report_warning(
108 'ffmpeg-location %s does not exist! '
109 'Continuing without ffmpeg.' % (location))
110 self._versions = {}
111 return
112 elif os.path.isdir(location):
113 dirname, basename = location, None
114 else:
115 basename = os.path.splitext(os.path.basename(location))[0]
116 basename = next((p for p in programs if basename.startswith(p)), 'ffmpeg')
117 dirname = os.path.dirname(os.path.abspath(location))
118 if basename in ('ffmpeg', 'ffprobe'):
119 prefer_ffmpeg = True
120
121 self._paths = dict(
122 (p, os.path.join(dirname, p)) for p in programs)
123 if basename:
124 self._paths[basename] = location
125 self._versions = dict(
126 (p, get_ffmpeg_version(self._paths[p])) for p in programs)
127 if self._versions is None:
128 self._versions = dict(
129 (p, get_ffmpeg_version(p)) for p in programs)
130 self._paths = dict((p, p) for p in programs)
131
132 if prefer_ffmpeg is False:
133 prefs = ('avconv', 'ffmpeg')
134 else:
135 prefs = ('ffmpeg', 'avconv')
136 for p in prefs:
137 if self._versions[p]:
138 self.basename = p
139 break
140
141 if prefer_ffmpeg is False:
142 prefs = ('avprobe', 'ffprobe')
143 else:
144 prefs = ('ffprobe', 'avprobe')
145 for p in prefs:
146 if self._versions[p]:
147 self.probe_basename = p
148 break
149
150 @property
151 def available(self):
152 return self.basename is not None
153
154 @property
155 def executable(self):
156 return self._paths[self.basename]
157
158 @property
159 def probe_available(self):
160 return self.probe_basename is not None
161
162 @property
163 def probe_executable(self):
164 return self._paths[self.probe_basename]
165
166 def get_audio_codec(self, path):
167 if not self.probe_available and not self.available:
168 raise PostProcessingError('ffprobe and ffmpeg not found. Please install or provide the path using --ffmpeg-location')
169 try:
170 if self.probe_available:
171 cmd = [
172 encodeFilename(self.probe_executable, True),
173 encodeArgument('-show_streams')]
174 else:
175 cmd = [
176 encodeFilename(self.executable, True),
177 encodeArgument('-i')]
178 cmd.append(encodeFilename(self._ffmpeg_filename_argument(path), True))
179 self.write_debug('%s command line: %s' % (self.basename, shell_quote(cmd)))
180 handle = subprocess.Popen(
181 cmd, stderr=subprocess.PIPE,
182 stdout=subprocess.PIPE, stdin=subprocess.PIPE)
183 stdout_data, stderr_data = process_communicate_or_kill(handle)
184 expected_ret = 0 if self.probe_available else 1
185 if handle.wait() != expected_ret:
186 return None
187 except (IOError, OSError):
188 return None
189 output = (stdout_data if self.probe_available else stderr_data).decode('ascii', 'ignore')
190 if self.probe_available:
191 audio_codec = None
192 for line in output.split('\n'):
193 if line.startswith('codec_name='):
194 audio_codec = line.split('=')[1].strip()
195 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
196 return audio_codec
197 else:
198 # Stream #FILE_INDEX:STREAM_INDEX[STREAM_ID](LANGUAGE): CODEC_TYPE: CODEC_NAME
199 mobj = re.search(
200 r'Stream\s*#\d+:\d+(?:\[0x[0-9a-f]+\])?(?:\([a-z]{3}\))?:\s*Audio:\s*([0-9a-z]+)',
201 output)
202 if mobj:
203 return mobj.group(1)
204 return None
205
206 def get_metadata_object(self, path, opts=[]):
207 if self.probe_basename != 'ffprobe':
208 if self.probe_available:
209 self.report_warning('Only ffprobe is supported for metadata extraction')
210 raise PostProcessingError('ffprobe not found. Please install or provide the path using --ffmpeg-location')
211 self.check_version()
212
213 cmd = [
214 encodeFilename(self.probe_executable, True),
215 encodeArgument('-hide_banner'),
216 encodeArgument('-show_format'),
217 encodeArgument('-show_streams'),
218 encodeArgument('-print_format'),
219 encodeArgument('json'),
220 ]
221
222 cmd += opts
223 cmd.append(encodeFilename(self._ffmpeg_filename_argument(path), True))
224 self.write_debug('ffprobe command line: %s' % shell_quote(cmd))
225 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
226 stdout, stderr = p.communicate()
227 return json.loads(stdout.decode('utf-8', 'replace'))
228
229 def get_stream_number(self, path, keys, value):
230 streams = self.get_metadata_object(path)['streams']
231 num = next(
232 (i for i, stream in enumerate(streams) if traverse_obj(stream, keys, casesense=False) == value),
233 None)
234 return num, len(streams)
235
236 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts, **kwargs):
237 return self.real_run_ffmpeg(
238 [(path, []) for path in input_paths],
239 [(out_path, opts)], **kwargs)
240
241 def real_run_ffmpeg(self, input_path_opts, output_path_opts, *, expected_retcodes=(0,)):
242 self.check_version()
243
244 oldest_mtime = min(
245 os.stat(encodeFilename(path)).st_mtime for path, _ in input_path_opts if path)
246
247 cmd = [encodeFilename(self.executable, True), encodeArgument('-y')]
248 # avconv does not have repeat option
249 if self.basename == 'ffmpeg':
250 cmd += [encodeArgument('-loglevel'), encodeArgument('repeat+info')]
251
252 def make_args(file, args, name, number):
253 keys = ['_%s%d' % (name, number), '_%s' % name]
254 if name == 'o' and number == 1:
255 keys.append('')
256 args += self._configuration_args(self.basename, keys)
257 if name == 'i':
258 args.append('-i')
259 return (
260 [encodeArgument(arg) for arg in args]
261 + [encodeFilename(self._ffmpeg_filename_argument(file), True)])
262
263 for arg_type, path_opts in (('i', input_path_opts), ('o', output_path_opts)):
264 cmd += itertools.chain.from_iterable(
265 make_args(path, list(opts), arg_type, i + 1)
266 for i, (path, opts) in enumerate(path_opts) if path)
267
268 self.write_debug('ffmpeg command line: %s' % shell_quote(cmd))
269 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
270 stdout, stderr = process_communicate_or_kill(p)
271 if p.returncode not in variadic(expected_retcodes):
272 stderr = stderr.decode('utf-8', 'replace').strip()
273 if self.get_param('verbose', False):
274 self.report_error(stderr)
275 raise FFmpegPostProcessorError(stderr.split('\n')[-1])
276 for out_path, _ in output_path_opts:
277 if out_path:
278 self.try_utime(out_path, oldest_mtime, oldest_mtime)
279 return stderr.decode('utf-8', 'replace')
280
281 def run_ffmpeg(self, path, out_path, opts, **kwargs):
282 return self.run_ffmpeg_multiple_files([path], out_path, opts, **kwargs)
283
284 def _ffmpeg_filename_argument(self, fn):
285 # Always use 'file:' because the filename may contain ':' (ffmpeg
286 # interprets that as a protocol) or can start with '-' (-- is broken in
287 # ffmpeg, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details)
288 # Also leave '-' intact in order not to break streaming to stdout.
289 if fn.startswith(('http://', 'https://')):
290 return fn
291 return 'file:' + fn if fn != '-' else fn
292
293
294 class FFmpegExtractAudioPP(FFmpegPostProcessor):
295 COMMON_AUDIO_EXTS = ('wav', 'flac', 'm4a', 'aiff', 'mp3', 'ogg', 'mka', 'opus', 'wma')
296 SUPPORTED_EXTS = ('best', 'aac', 'flac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav')
297
298 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
299 FFmpegPostProcessor.__init__(self, downloader)
300 self._preferredcodec = preferredcodec or 'best'
301 self._preferredquality = preferredquality
302 self._nopostoverwrites = nopostoverwrites
303
304 def run_ffmpeg(self, path, out_path, codec, more_opts):
305 if codec is None:
306 acodec_opts = []
307 else:
308 acodec_opts = ['-acodec', codec]
309 opts = ['-vn'] + acodec_opts + more_opts
310 try:
311 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
312 except FFmpegPostProcessorError as err:
313 raise AudioConversionError(err.msg)
314
315 @PostProcessor._restrict_to(images=False)
316 def run(self, information):
317 path = information['filepath']
318 orig_ext = information['ext']
319
320 if self._preferredcodec == 'best' and orig_ext in self.COMMON_AUDIO_EXTS:
321 self.to_screen('Skipping audio extraction since the file is already in a common audio format')
322 return [], information
323
324 filecodec = self.get_audio_codec(path)
325 if filecodec is None:
326 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
327
328 more_opts = []
329 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
330 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
331 # Lossless, but in another container
332 acodec = 'copy'
333 extension = 'm4a'
334 more_opts = ['-bsf:a', 'aac_adtstoasc']
335 elif filecodec in ['aac', 'flac', 'mp3', 'vorbis', 'opus']:
336 # Lossless if possible
337 acodec = 'copy'
338 extension = filecodec
339 if filecodec == 'aac':
340 more_opts = ['-f', 'adts']
341 if filecodec == 'vorbis':
342 extension = 'ogg'
343 else:
344 # MP3 otherwise.
345 acodec = 'libmp3lame'
346 extension = 'mp3'
347 more_opts = []
348 if self._preferredquality is not None:
349 if int(self._preferredquality) < 10:
350 more_opts += ['-q:a', self._preferredquality]
351 else:
352 more_opts += ['-b:a', self._preferredquality + 'k']
353 else:
354 # We convert the audio (lossy if codec is lossy)
355 acodec = ACODECS[self._preferredcodec]
356 extension = self._preferredcodec
357 more_opts = []
358 if self._preferredquality is not None:
359 # The opus codec doesn't support the -aq option
360 if int(self._preferredquality) < 10 and extension != 'opus':
361 more_opts += ['-q:a', self._preferredquality]
362 else:
363 more_opts += ['-b:a', self._preferredquality + 'k']
364 if self._preferredcodec == 'aac':
365 more_opts += ['-f', 'adts']
366 if self._preferredcodec == 'm4a':
367 more_opts += ['-bsf:a', 'aac_adtstoasc']
368 if self._preferredcodec == 'vorbis':
369 extension = 'ogg'
370 if self._preferredcodec == 'wav':
371 extension = 'wav'
372 more_opts += ['-f', 'wav']
373
374 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
375 new_path = prefix + sep + extension
376
377 information['filepath'] = new_path
378 information['ext'] = extension
379
380 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
381 if (new_path == path
382 or (self._nopostoverwrites and os.path.exists(encodeFilename(new_path)))):
383 self.to_screen('Post-process file %s exists, skipping' % new_path)
384 return [], information
385
386 try:
387 self.to_screen('Destination: ' + new_path)
388 self.run_ffmpeg(path, new_path, acodec, more_opts)
389 except AudioConversionError as e:
390 raise PostProcessingError(
391 'audio conversion failed: ' + e.msg)
392 except Exception:
393 raise PostProcessingError('error running ' + self.basename)
394
395 # Try to update the date time for extracted audio file.
396 if information.get('filetime') is not None:
397 self.try_utime(
398 new_path, time.time(), information['filetime'],
399 errnote='Cannot update utime of audio file')
400
401 return [path], information
402
403
404 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
405 SUPPORTED_EXTS = ('mp4', 'mkv', 'flv', 'webm', 'mov', 'avi', 'mp3', 'mka', 'm4a', 'ogg', 'opus')
406 FORMAT_RE = re.compile(r'{0}(?:/{0})*$'.format(r'(?:\w+>)?(?:%s)' % '|'.join(SUPPORTED_EXTS)))
407 _action = 'converting'
408
409 def __init__(self, downloader=None, preferedformat=None):
410 super(FFmpegVideoConvertorPP, self).__init__(downloader)
411 self._preferedformats = preferedformat.lower().split('/')
412
413 def _target_ext(self, source_ext):
414 for pair in self._preferedformats:
415 kv = pair.split('>')
416 if len(kv) == 1 or kv[0].strip() == source_ext:
417 return kv[-1].strip()
418
419 @staticmethod
420 def _options(target_ext):
421 if target_ext == 'avi':
422 return ['-c:v', 'libxvid', '-vtag', 'XVID']
423 return []
424
425 @PostProcessor._restrict_to(images=False)
426 def run(self, information):
427 path, source_ext = information['filepath'], information['ext'].lower()
428 target_ext = self._target_ext(source_ext)
429 _skip_msg = (
430 'could not find a mapping for %s' if not target_ext
431 else 'already is in target format %s' if source_ext == target_ext
432 else None)
433 if _skip_msg:
434 self.to_screen('Not %s media file "%s"; %s' % (self._action, path, _skip_msg % source_ext))
435 return [], information
436
437 prefix, sep, oldext = path.rpartition('.')
438 outpath = prefix + sep + target_ext
439 self.to_screen('%s video from %s to %s; Destination: %s' % (self._action.title(), source_ext, target_ext, outpath))
440 self.run_ffmpeg(path, outpath, self._options(target_ext))
441
442 information['filepath'] = outpath
443 information['format'] = information['ext'] = target_ext
444 return [path], information
445
446
447 class FFmpegVideoRemuxerPP(FFmpegVideoConvertorPP):
448 _action = 'remuxing'
449
450 @staticmethod
451 def _options(target_ext):
452 options = ['-c', 'copy', '-map', '0', '-dn']
453 if target_ext in ['mp4', 'm4a', 'mov']:
454 options.extend(['-movflags', '+faststart'])
455 return options
456
457
458 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
459 def __init__(self, downloader=None, already_have_subtitle=False):
460 super(FFmpegEmbedSubtitlePP, self).__init__(downloader)
461 self._already_have_subtitle = already_have_subtitle
462
463 @PostProcessor._restrict_to(images=False)
464 def run(self, information):
465 if information['ext'] not in ('mp4', 'webm', 'mkv'):
466 self.to_screen('Subtitles can only be embedded in mp4, webm or mkv files')
467 return [], information
468 subtitles = information.get('requested_subtitles')
469 if not subtitles:
470 self.to_screen('There aren\'t any subtitles to embed')
471 return [], information
472
473 filename = information['filepath']
474
475 ext = information['ext']
476 sub_langs, sub_names, sub_filenames = [], [], []
477 webm_vtt_warn = False
478 mp4_ass_warn = False
479
480 for lang, sub_info in subtitles.items():
481 if not os.path.exists(information.get('filepath', '')):
482 self.report_warning(f'Skipping embedding {lang} subtitle because the file is missing')
483 continue
484 sub_ext = sub_info['ext']
485 if sub_ext == 'json':
486 self.report_warning('JSON subtitles cannot be embedded')
487 elif ext != 'webm' or ext == 'webm' and sub_ext == 'vtt':
488 sub_langs.append(lang)
489 sub_names.append(sub_info.get('name'))
490 sub_filenames.append(sub_info['filepath'])
491 else:
492 if not webm_vtt_warn and ext == 'webm' and sub_ext != 'vtt':
493 webm_vtt_warn = True
494 self.report_warning('Only WebVTT subtitles can be embedded in webm files')
495 if not mp4_ass_warn and ext == 'mp4' and sub_ext == 'ass':
496 mp4_ass_warn = True
497 self.report_warning('ASS subtitles cannot be properly embedded in mp4 files; expect issues')
498
499 if not sub_langs:
500 return [], information
501
502 input_files = [filename] + sub_filenames
503
504 opts = [
505 '-c', 'copy', '-map', '0', '-dn',
506 # Don't copy the existing subtitles, we may be running the
507 # postprocessor a second time
508 '-map', '-0:s',
509 # Don't copy Apple TV chapters track, bin_data (see #19042, #19024,
510 # https://trac.ffmpeg.org/ticket/6016)
511 '-map', '-0:d',
512 ]
513 if information['ext'] == 'mp4':
514 opts += ['-c:s', 'mov_text']
515 for i, (lang, name) in enumerate(zip(sub_langs, sub_names)):
516 opts.extend(['-map', '%d:0' % (i + 1)])
517 lang_code = ISO639Utils.short2long(lang) or lang
518 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
519 if name:
520 opts.extend(['-metadata:s:s:%d' % i, 'handler_name=%s' % name,
521 '-metadata:s:s:%d' % i, 'title=%s' % name])
522
523 temp_filename = prepend_extension(filename, 'temp')
524 self.to_screen('Embedding subtitles in "%s"' % filename)
525 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
526 os.replace(temp_filename, filename)
527
528 files_to_delete = [] if self._already_have_subtitle else sub_filenames
529 return files_to_delete, information
530
531
532 class FFmpegMetadataPP(FFmpegPostProcessor):
533
534 @staticmethod
535 def _options(target_ext):
536 yield from ('-map', '0', '-dn')
537 if target_ext == 'm4a':
538 yield from ('-vn', '-acodec', 'copy')
539 else:
540 yield from ('-c', 'copy')
541
542 @PostProcessor._restrict_to(images=False)
543 def run(self, info):
544 metadata = {}
545
546 def add(meta_list, info_list=None):
547 if not meta_list:
548 return
549 for info_f in variadic(info_list or meta_list):
550 if isinstance(info.get(info_f), (compat_str, compat_numeric_types)):
551 for meta_f in variadic(meta_list):
552 metadata[meta_f] = info[info_f]
553 break
554
555 # See [1-4] for some info on media metadata/metadata supported
556 # by ffmpeg.
557 # 1. https://kdenlive.org/en/project/adding-meta-data-to-mp4-video/
558 # 2. https://wiki.multimedia.cx/index.php/FFmpeg_Metadata
559 # 3. https://kodi.wiki/view/Video_file_tagging
560
561 add('title', ('track', 'title'))
562 add('date', 'upload_date')
563 add(('description', 'synopsis'), 'description')
564 add(('purl', 'comment'), 'webpage_url')
565 add('track', 'track_number')
566 add('artist', ('artist', 'creator', 'uploader', 'uploader_id'))
567 add('genre')
568 add('album')
569 add('album_artist')
570 add('disc', 'disc_number')
571 add('show', 'series')
572 add('season_number')
573 add('episode_id', ('episode', 'episode_id'))
574 add('episode_sort', 'episode_number')
575
576 prefix = 'meta_'
577 for key in filter(lambda k: k.startswith(prefix), info.keys()):
578 add(key[len(prefix):], key)
579
580 filename, metadata_filename = info['filepath'], None
581 options = [('-metadata', f'{name}={value}') for name, value in metadata.items()]
582
583 stream_idx = 0
584 for fmt in info.get('requested_formats') or []:
585 stream_count = 2 if 'none' not in (fmt.get('vcodec'), fmt.get('acodec')) else 1
586 if fmt.get('language'):
587 lang = ISO639Utils.short2long(fmt['language']) or fmt['language']
588 options.extend(('-metadata:s:%d' % (stream_idx + i), 'language=%s' % lang)
589 for i in range(stream_count))
590 stream_idx += stream_count
591
592 chapters = info.get('chapters', [])
593 if chapters:
594 metadata_filename = replace_extension(filename, 'meta')
595 with io.open(metadata_filename, 'wt', encoding='utf-8') as f:
596 def ffmpeg_escape(text):
597 return re.sub(r'([\\=;#\n])', r'\\\1', text)
598
599 metadata_file_content = ';FFMETADATA1\n'
600 for chapter in chapters:
601 metadata_file_content += '[CHAPTER]\nTIMEBASE=1/1000\n'
602 metadata_file_content += 'START=%d\n' % (chapter['start_time'] * 1000)
603 metadata_file_content += 'END=%d\n' % (chapter['end_time'] * 1000)
604 chapter_title = chapter.get('title')
605 if chapter_title:
606 metadata_file_content += 'title=%s\n' % ffmpeg_escape(chapter_title)
607 f.write(metadata_file_content)
608 options.append(('-map_metadata', '1'))
609
610 if ('no-attach-info-json' not in self.get_param('compat_opts', [])
611 and '__infojson_filename' in info and info['ext'] in ('mkv', 'mka')):
612 old_stream, new_stream = self.get_stream_number(filename, ('tags', 'mimetype'), 'application/json')
613 if old_stream is not None:
614 options.append(('-map', '-0:%d' % old_stream))
615 new_stream -= 1
616
617 options.append((
618 '-attach', info['__infojson_filename'],
619 '-metadata:s:%d' % new_stream, 'mimetype=application/json'
620 ))
621
622 if not options:
623 self.to_screen('There isn\'t any metadata to add')
624 return [], info
625
626 temp_filename = prepend_extension(filename, 'temp')
627 self.to_screen('Adding metadata to "%s"' % filename)
628 self.run_ffmpeg_multiple_files(
629 (filename, metadata_filename), temp_filename,
630 itertools.chain(self._options(info['ext']), *options))
631 if chapters:
632 os.remove(metadata_filename)
633 os.replace(temp_filename, filename)
634 return [], info
635
636
637 class FFmpegMergerPP(FFmpegPostProcessor):
638 @PostProcessor._restrict_to(images=False)
639 def run(self, info):
640 filename = info['filepath']
641 temp_filename = prepend_extension(filename, 'temp')
642 args = ['-c', 'copy']
643 for (i, fmt) in enumerate(info['requested_formats']):
644 if fmt.get('acodec') != 'none':
645 args.extend(['-map', '%u:a:0' % (i)])
646 if fmt.get('vcodec') != 'none':
647 args.extend(['-map', '%u:v:0' % (i)])
648 self.to_screen('Merging formats into "%s"' % filename)
649 self.run_ffmpeg_multiple_files(info['__files_to_merge'], temp_filename, args)
650 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
651 return info['__files_to_merge'], info
652
653 def can_merge(self):
654 # TODO: figure out merge-capable ffmpeg version
655 if self.basename != 'avconv':
656 return True
657
658 required_version = '10-0'
659 if is_outdated_version(
660 self._versions[self.basename], required_version):
661 warning = ('Your copy of %s is outdated and unable to properly mux separate video and audio files, '
662 'yt-dlp will download single file media. '
663 'Update %s to version %s or newer to fix this.') % (
664 self.basename, self.basename, required_version)
665 self.report_warning(warning)
666 return False
667 return True
668
669
670 class FFmpegFixupPostProcessor(FFmpegPostProcessor):
671 def _fixup(self, msg, filename, options):
672 temp_filename = prepend_extension(filename, 'temp')
673
674 self.to_screen(f'{msg} of "{filename}"')
675 self.run_ffmpeg(filename, temp_filename, options)
676
677 os.replace(temp_filename, filename)
678
679
680 class FFmpegFixupStretchedPP(FFmpegFixupPostProcessor):
681 @PostProcessor._restrict_to(images=False, audio=False)
682 def run(self, info):
683 stretched_ratio = info.get('stretched_ratio')
684 if stretched_ratio not in (None, 1):
685 self._fixup('Fixing aspect ratio', info['filepath'], [
686 '-c', 'copy', '-map', '0', '-dn', '-aspect', '%f' % stretched_ratio])
687 return [], info
688
689
690 class FFmpegFixupM4aPP(FFmpegFixupPostProcessor):
691 @PostProcessor._restrict_to(images=False, video=False)
692 def run(self, info):
693 if info.get('container') == 'm4a_dash':
694 self._fixup('Correcting container', info['filepath'], [
695 '-c', 'copy', '-map', '0', '-dn', '-f', 'mp4'])
696 return [], info
697
698
699 class FFmpegFixupM3u8PP(FFmpegFixupPostProcessor):
700 @PostProcessor._restrict_to(images=False)
701 def run(self, info):
702 if self.get_audio_codec(info['filepath']) == 'aac':
703 self._fixup('Fixing malformed AAC bitstream', info['filepath'], [
704 '-c', 'copy', '-map', '0', '-dn', '-f', 'mp4', '-bsf:a', 'aac_adtstoasc'])
705 return [], info
706
707
708 class FFmpegFixupTimestampPP(FFmpegFixupPostProcessor):
709
710 def __init__(self, downloader=None, trim=0.001):
711 # "trim" should be used when the video contains unintended packets
712 super(FFmpegFixupTimestampPP, self).__init__(downloader)
713 assert isinstance(trim, (int, float))
714 self.trim = str(trim)
715
716 @PostProcessor._restrict_to(images=False)
717 def run(self, info):
718 required_version = '4.4'
719 if is_outdated_version(self._versions[self.basename], required_version):
720 self.report_warning(
721 'A re-encode is needed to fix timestamps in older versions of ffmpeg. '
722 f'Please install ffmpeg {required_version} or later to fixup without re-encoding')
723 opts = ['-vf', 'setpts=PTS-STARTPTS']
724 else:
725 opts = ['-c', 'copy', '-bsf', 'setts=ts=TS-STARTPTS']
726 self._fixup('Fixing frame timestamp', info['filepath'], opts + ['-map', '0', '-dn', '-ss', self.trim])
727 return [], info
728
729
730 class FFmpegFixupDurationPP(FFmpegFixupPostProcessor):
731 @PostProcessor._restrict_to(images=False)
732 def run(self, info):
733 self._fixup('Fixing video duration', info['filepath'], ['-c', 'copy', '-map', '0', '-dn'])
734 return [], info
735
736
737 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
738 SUPPORTED_EXTS = ('srt', 'vtt', 'ass', 'lrc')
739
740 def __init__(self, downloader=None, format=None):
741 super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
742 self.format = format
743
744 def run(self, info):
745 subs = info.get('requested_subtitles')
746 new_ext = self.format
747 new_format = new_ext
748 if new_format == 'vtt':
749 new_format = 'webvtt'
750 if subs is None:
751 self.to_screen('There aren\'t any subtitles to convert')
752 return [], info
753 self.to_screen('Converting subtitles')
754 sub_filenames = []
755 for lang, sub in subs.items():
756 ext = sub['ext']
757 if ext == new_ext:
758 self.to_screen('Subtitle file for %s is already in the requested format' % new_ext)
759 continue
760 elif ext == 'json':
761 self.to_screen(
762 'You have requested to convert json subtitles into another format, '
763 'which is currently not possible')
764 continue
765 old_file = sub['filepath']
766 sub_filenames.append(old_file)
767 new_file = replace_extension(old_file, new_ext)
768
769 if ext in ('dfxp', 'ttml', 'tt'):
770 self.report_warning(
771 'You have requested to convert dfxp (TTML) subtitles into another format, '
772 'which results in style information loss')
773
774 dfxp_file = old_file
775 srt_file = replace_extension(old_file, 'srt')
776
777 with open(dfxp_file, 'rb') as f:
778 srt_data = dfxp2srt(f.read())
779
780 with io.open(srt_file, 'wt', encoding='utf-8') as f:
781 f.write(srt_data)
782 old_file = srt_file
783
784 subs[lang] = {
785 'ext': 'srt',
786 'data': srt_data,
787 'filepath': srt_file,
788 }
789
790 if new_ext == 'srt':
791 continue
792 else:
793 sub_filenames.append(srt_file)
794
795 self.run_ffmpeg(old_file, new_file, ['-f', new_format])
796
797 with io.open(new_file, 'rt', encoding='utf-8') as f:
798 subs[lang] = {
799 'ext': new_ext,
800 'data': f.read(),
801 'filepath': new_file,
802 }
803
804 info['__files_to_move'][new_file] = replace_extension(
805 info['__files_to_move'][sub['filepath']], new_ext)
806
807 return sub_filenames, info
808
809
810 class FFmpegSplitChaptersPP(FFmpegPostProcessor):
811
812 def _prepare_filename(self, number, chapter, info):
813 info = info.copy()
814 info.update({
815 'section_number': number,
816 'section_title': chapter.get('title'),
817 'section_start': chapter.get('start_time'),
818 'section_end': chapter.get('end_time'),
819 })
820 return self._downloader.prepare_filename(info, 'chapter')
821
822 def _ffmpeg_args_for_chapter(self, number, chapter, info):
823 destination = self._prepare_filename(number, chapter, info)
824 if not self._downloader._ensure_dir_exists(encodeFilename(destination)):
825 return
826
827 chapter['filepath'] = destination
828 self.to_screen('Chapter %03d; Destination: %s' % (number, destination))
829 return (
830 destination,
831 ['-ss', compat_str(chapter['start_time']),
832 '-t', compat_str(chapter['end_time'] - chapter['start_time'])])
833
834 @PostProcessor._restrict_to(images=False)
835 def run(self, info):
836 chapters = info.get('chapters') or []
837 if not chapters:
838 self.report_warning('Chapter information is unavailable')
839 return [], info
840
841 self.to_screen('Splitting video by chapters; %d chapters found' % len(chapters))
842 for idx, chapter in enumerate(chapters):
843 destination, opts = self._ffmpeg_args_for_chapter(idx + 1, chapter, info)
844 self.real_run_ffmpeg([(info['filepath'], opts)], [(destination, ['-c', 'copy'])])
845 return [], info
846
847
848 class FFmpegThumbnailsConvertorPP(FFmpegPostProcessor):
849 SUPPORTED_EXTS = ('jpg', 'png')
850
851 def __init__(self, downloader=None, format=None):
852 super(FFmpegThumbnailsConvertorPP, self).__init__(downloader)
853 self.format = format
854
855 @staticmethod
856 def is_webp(path):
857 with open(encodeFilename(path), 'rb') as f:
858 b = f.read(12)
859 return b[0:4] == b'RIFF' and b[8:] == b'WEBP'
860
861 def fixup_webp(self, info, idx=-1):
862 thumbnail_filename = info['thumbnails'][idx]['filepath']
863 _, thumbnail_ext = os.path.splitext(thumbnail_filename)
864 if thumbnail_ext:
865 thumbnail_ext = thumbnail_ext[1:].lower()
866 if thumbnail_ext != 'webp' and self.is_webp(thumbnail_filename):
867 self.to_screen('Correcting thumbnail "%s" extension to webp' % thumbnail_filename)
868 webp_filename = replace_extension(thumbnail_filename, 'webp')
869 os.replace(thumbnail_filename, webp_filename)
870 info['thumbnails'][idx]['filepath'] = webp_filename
871 info['__files_to_move'][webp_filename] = replace_extension(
872 info['__files_to_move'].pop(thumbnail_filename), 'webp')
873
874 @staticmethod
875 def _options(target_ext):
876 if target_ext == 'jpg':
877 return ['-bsf:v', 'mjpeg2jpeg']
878 return []
879
880 def convert_thumbnail(self, thumbnail_filename, target_ext):
881 thumbnail_conv_filename = replace_extension(thumbnail_filename, target_ext)
882
883 self.to_screen('Converting thumbnail "%s" to %s' % (thumbnail_filename, target_ext))
884 self.real_run_ffmpeg(
885 [(thumbnail_filename, ['-f', 'image2', '-pattern_type', 'none'])],
886 [(thumbnail_conv_filename.replace('%', '%%'), self._options(target_ext))])
887 return thumbnail_conv_filename
888
889 def run(self, info):
890 files_to_delete = []
891 has_thumbnail = False
892
893 for idx, thumbnail_dict in enumerate(info['thumbnails']):
894 if 'filepath' not in thumbnail_dict:
895 continue
896 has_thumbnail = True
897 self.fixup_webp(info, idx)
898 original_thumbnail = thumbnail_dict['filepath']
899 _, thumbnail_ext = os.path.splitext(original_thumbnail)
900 if thumbnail_ext:
901 thumbnail_ext = thumbnail_ext[1:].lower()
902 if thumbnail_ext == 'jpeg':
903 thumbnail_ext = 'jpg'
904 if thumbnail_ext == self.format:
905 self.to_screen('Thumbnail "%s" is already in the requested format' % original_thumbnail)
906 continue
907 thumbnail_dict['filepath'] = self.convert_thumbnail(original_thumbnail, self.format)
908 files_to_delete.append(original_thumbnail)
909 info['__files_to_move'][thumbnail_dict['filepath']] = replace_extension(
910 info['__files_to_move'][original_thumbnail], self.format)
911
912 if not has_thumbnail:
913 self.to_screen('There aren\'t any thumbnails to convert')
914 return files_to_delete, info