]> jfr.im git - yt-dlp.git/blob - youtube_dl/postprocessor/ffmpeg.py
Detect already merged videos
[yt-dlp.git] / youtube_dl / postprocessor / ffmpeg.py
1 from __future__ import unicode_literals
2
3 import io
4 import os
5 import subprocess
6 import time
7
8
9 from .common import AudioConversionError, PostProcessor
10
11 from ..compat import (
12 compat_subprocess_get_DEVNULL,
13 )
14 from ..utils import (
15 encodeArgument,
16 encodeFilename,
17 get_exe_version,
18 is_outdated_version,
19 PostProcessingError,
20 prepend_extension,
21 shell_quote,
22 subtitles_filename,
23 )
24
25
26 class FFmpegPostProcessorError(PostProcessingError):
27 pass
28
29
30 class FFmpegPostProcessor(PostProcessor):
31 def __init__(self, downloader=None):
32 PostProcessor.__init__(self, downloader)
33 self._determine_executables()
34
35 def check_version(self):
36 if not self.available:
37 raise FFmpegPostProcessorError('ffmpeg or avconv not found. Please install one.')
38
39 required_version = '10-0' if self.basename == 'avconv' else '1.0'
40 if is_outdated_version(
41 self._versions[self.basename], required_version):
42 warning = 'Your copy of %s is outdated, update %s to version %s or newer if you encounter any errors.' % (
43 self.basename, self.basename, required_version)
44 if self._downloader:
45 self._downloader.report_warning(warning)
46
47 @staticmethod
48 def get_versions(downloader=None):
49 return FFmpegPostProcessor(downloader)._versions
50
51 def _determine_executables(self):
52 programs = ['avprobe', 'avconv', 'ffmpeg', 'ffprobe']
53 prefer_ffmpeg = self._downloader.params.get('prefer_ffmpeg', False)
54
55 self.basename = None
56 self.probe_basename = None
57
58 self._paths = None
59 self._versions = None
60 if self._downloader:
61 location = self._downloader.params.get('ffmpeg_location')
62 if location is not None:
63 if not os.path.exists(location):
64 self._downloader.report_warning(
65 'ffmpeg-location %s does not exist! '
66 'Continuing without avconv/ffmpeg.' % (location))
67 self._versions = {}
68 return
69 elif not os.path.isdir(location):
70 basename = os.path.splitext(os.path.basename(location))[0]
71 if basename not in programs:
72 self._downloader.report_warning(
73 'Cannot identify executable %s, its basename should be one of %s. '
74 'Continuing without avconv/ffmpeg.' %
75 (location, ', '.join(programs)))
76 self._versions = {}
77 return None
78 location = os.path.dirname(os.path.abspath(location))
79 if basename in ('ffmpeg', 'ffprobe'):
80 prefer_ffmpeg = True
81
82 self._paths = dict(
83 (p, os.path.join(location, p)) for p in programs)
84 self._versions = dict(
85 (p, get_exe_version(self._paths[p], args=['-version']))
86 for p in programs)
87 if self._versions is None:
88 self._versions = dict(
89 (p, get_exe_version(p, args=['-version'])) for p in programs)
90 self._paths = dict((p, p) for p in programs)
91
92 if prefer_ffmpeg:
93 prefs = ('ffmpeg', 'avconv')
94 else:
95 prefs = ('avconv', 'ffmpeg')
96 for p in prefs:
97 if self._versions[p]:
98 self.basename = p
99 break
100
101 if prefer_ffmpeg:
102 prefs = ('ffprobe', 'avprobe')
103 else:
104 prefs = ('avprobe', 'ffprobe')
105 for p in prefs:
106 if self._versions[p]:
107 self.probe_basename = p
108 break
109
110 @property
111 def available(self):
112 return self.basename is not None
113
114 @property
115 def executable(self):
116 return self._paths[self.basename]
117
118 @property
119 def probe_available(self):
120 return self.probe_basename is not None
121
122 @property
123 def probe_executable(self):
124 return self._paths[self.probe_basename]
125
126 def run_ffmpeg_multiple_files(self, input_paths, out_path, opts):
127 self.check_version()
128
129 oldest_mtime = min(
130 os.stat(encodeFilename(path)).st_mtime for path in input_paths)
131
132 files_cmd = []
133 for path in input_paths:
134 files_cmd.extend([encodeArgument('-i'), encodeFilename(path, True)])
135 cmd = ([encodeFilename(self.executable, True), encodeArgument('-y')] +
136 files_cmd +
137 [encodeArgument(o) for o in opts] +
138 [encodeFilename(self._ffmpeg_filename_argument(out_path), True)])
139
140 if self._downloader.params.get('verbose', False):
141 self._downloader.to_screen('[debug] ffmpeg command line: %s' % shell_quote(cmd))
142 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE)
143 stdout, stderr = p.communicate()
144 if p.returncode != 0:
145 stderr = stderr.decode('utf-8', 'replace')
146 msg = stderr.strip().split('\n')[-1]
147 raise FFmpegPostProcessorError(msg)
148 self.try_utime(out_path, oldest_mtime, oldest_mtime)
149
150 def run_ffmpeg(self, path, out_path, opts):
151 self.run_ffmpeg_multiple_files([path], out_path, opts)
152
153 def _ffmpeg_filename_argument(self, fn):
154 # ffmpeg broke --, see https://ffmpeg.org/trac/ffmpeg/ticket/2127 for details
155 if fn.startswith('-'):
156 return './' + fn
157 return fn
158
159
160 class FFmpegExtractAudioPP(FFmpegPostProcessor):
161 def __init__(self, downloader=None, preferredcodec=None, preferredquality=None, nopostoverwrites=False):
162 FFmpegPostProcessor.__init__(self, downloader)
163 if preferredcodec is None:
164 preferredcodec = 'best'
165 self._preferredcodec = preferredcodec
166 self._preferredquality = preferredquality
167 self._nopostoverwrites = nopostoverwrites
168
169 def get_audio_codec(self, path):
170
171 if not self.probe_available:
172 raise PostProcessingError('ffprobe or avprobe not found. Please install one.')
173 try:
174 cmd = [
175 encodeFilename(self.probe_executable, True),
176 encodeArgument('-show_streams'),
177 encodeFilename(self._ffmpeg_filename_argument(path), True)]
178 if self._downloader.params.get('verbose', False):
179 self._downloader.to_screen('[debug] %s command line: %s' % (self.basename, shell_quote(cmd)))
180 handle = subprocess.Popen(cmd, stderr=compat_subprocess_get_DEVNULL(), stdout=subprocess.PIPE, stdin=subprocess.PIPE)
181 output = handle.communicate()[0]
182 if handle.wait() != 0:
183 return None
184 except (IOError, OSError):
185 return None
186 audio_codec = None
187 for line in output.decode('ascii', 'ignore').split('\n'):
188 if line.startswith('codec_name='):
189 audio_codec = line.split('=')[1].strip()
190 elif line.strip() == 'codec_type=audio' and audio_codec is not None:
191 return audio_codec
192 return None
193
194 def run_ffmpeg(self, path, out_path, codec, more_opts):
195 if codec is None:
196 acodec_opts = []
197 else:
198 acodec_opts = ['-acodec', codec]
199 opts = ['-vn'] + acodec_opts + more_opts
200 try:
201 FFmpegPostProcessor.run_ffmpeg(self, path, out_path, opts)
202 except FFmpegPostProcessorError as err:
203 raise AudioConversionError(err.msg)
204
205 def run(self, information):
206 path = information['filepath']
207
208 filecodec = self.get_audio_codec(path)
209 if filecodec is None:
210 raise PostProcessingError('WARNING: unable to obtain file audio codec with ffprobe')
211
212 more_opts = []
213 if self._preferredcodec == 'best' or self._preferredcodec == filecodec or (self._preferredcodec == 'm4a' and filecodec == 'aac'):
214 if filecodec == 'aac' and self._preferredcodec in ['m4a', 'best']:
215 # Lossless, but in another container
216 acodec = 'copy'
217 extension = 'm4a'
218 more_opts = ['-bsf:a', 'aac_adtstoasc']
219 elif filecodec in ['aac', 'mp3', 'vorbis', 'opus']:
220 # Lossless if possible
221 acodec = 'copy'
222 extension = filecodec
223 if filecodec == 'aac':
224 more_opts = ['-f', 'adts']
225 if filecodec == 'vorbis':
226 extension = 'ogg'
227 else:
228 # MP3 otherwise.
229 acodec = 'libmp3lame'
230 extension = 'mp3'
231 more_opts = []
232 if self._preferredquality is not None:
233 if int(self._preferredquality) < 10:
234 more_opts += ['-q:a', self._preferredquality]
235 else:
236 more_opts += ['-b:a', self._preferredquality + 'k']
237 else:
238 # We convert the audio (lossy)
239 acodec = {'mp3': 'libmp3lame', 'aac': 'aac', 'm4a': 'aac', 'opus': 'opus', 'vorbis': 'libvorbis', 'wav': None}[self._preferredcodec]
240 extension = self._preferredcodec
241 more_opts = []
242 if self._preferredquality is not None:
243 # The opus codec doesn't support the -aq option
244 if int(self._preferredquality) < 10 and extension != 'opus':
245 more_opts += ['-q:a', self._preferredquality]
246 else:
247 more_opts += ['-b:a', self._preferredquality + 'k']
248 if self._preferredcodec == 'aac':
249 more_opts += ['-f', 'adts']
250 if self._preferredcodec == 'm4a':
251 more_opts += ['-bsf:a', 'aac_adtstoasc']
252 if self._preferredcodec == 'vorbis':
253 extension = 'ogg'
254 if self._preferredcodec == 'wav':
255 extension = 'wav'
256 more_opts += ['-f', 'wav']
257
258 prefix, sep, ext = path.rpartition('.') # not os.path.splitext, since the latter does not work on unicode in all setups
259 new_path = prefix + sep + extension
260
261 # If we download foo.mp3 and convert it to... foo.mp3, then don't delete foo.mp3, silly.
262 if (new_path == path or
263 (self._nopostoverwrites and os.path.exists(encodeFilename(new_path)))):
264 self._downloader.to_screen('[youtube] Post-process file %s exists, skipping' % new_path)
265 return [], information
266
267 try:
268 self._downloader.to_screen('[' + self.basename + '] Destination: ' + new_path)
269 self.run_ffmpeg(path, new_path, acodec, more_opts)
270 except AudioConversionError as e:
271 raise PostProcessingError(
272 'audio conversion failed: ' + e.msg)
273 except Exception:
274 raise PostProcessingError('error running ' + self.basename)
275
276 # Try to update the date time for extracted audio file.
277 if information.get('filetime') is not None:
278 self.try_utime(
279 new_path, time.time(), information['filetime'],
280 errnote='Cannot update utime of audio file')
281
282 information['filepath'] = new_path
283 return [path], information
284
285
286 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
287 def __init__(self, downloader=None, preferedformat=None):
288 super(FFmpegVideoConvertorPP, self).__init__(downloader)
289 self._preferedformat = preferedformat
290
291 def run(self, information):
292 path = information['filepath']
293 prefix, sep, ext = path.rpartition('.')
294 outpath = prefix + sep + self._preferedformat
295 if information['ext'] == self._preferedformat:
296 self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
297 return [], information
298 self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
299 self.run_ffmpeg(path, outpath, [])
300 information['filepath'] = outpath
301 information['format'] = self._preferedformat
302 information['ext'] = self._preferedformat
303 return [path], information
304
305
306 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
307 # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
308 _lang_map = {
309 'aa': 'aar',
310 'ab': 'abk',
311 'ae': 'ave',
312 'af': 'afr',
313 'ak': 'aka',
314 'am': 'amh',
315 'an': 'arg',
316 'ar': 'ara',
317 'as': 'asm',
318 'av': 'ava',
319 'ay': 'aym',
320 'az': 'aze',
321 'ba': 'bak',
322 'be': 'bel',
323 'bg': 'bul',
324 'bh': 'bih',
325 'bi': 'bis',
326 'bm': 'bam',
327 'bn': 'ben',
328 'bo': 'bod',
329 'br': 'bre',
330 'bs': 'bos',
331 'ca': 'cat',
332 'ce': 'che',
333 'ch': 'cha',
334 'co': 'cos',
335 'cr': 'cre',
336 'cs': 'ces',
337 'cu': 'chu',
338 'cv': 'chv',
339 'cy': 'cym',
340 'da': 'dan',
341 'de': 'deu',
342 'dv': 'div',
343 'dz': 'dzo',
344 'ee': 'ewe',
345 'el': 'ell',
346 'en': 'eng',
347 'eo': 'epo',
348 'es': 'spa',
349 'et': 'est',
350 'eu': 'eus',
351 'fa': 'fas',
352 'ff': 'ful',
353 'fi': 'fin',
354 'fj': 'fij',
355 'fo': 'fao',
356 'fr': 'fra',
357 'fy': 'fry',
358 'ga': 'gle',
359 'gd': 'gla',
360 'gl': 'glg',
361 'gn': 'grn',
362 'gu': 'guj',
363 'gv': 'glv',
364 'ha': 'hau',
365 'he': 'heb',
366 'hi': 'hin',
367 'ho': 'hmo',
368 'hr': 'hrv',
369 'ht': 'hat',
370 'hu': 'hun',
371 'hy': 'hye',
372 'hz': 'her',
373 'ia': 'ina',
374 'id': 'ind',
375 'ie': 'ile',
376 'ig': 'ibo',
377 'ii': 'iii',
378 'ik': 'ipk',
379 'io': 'ido',
380 'is': 'isl',
381 'it': 'ita',
382 'iu': 'iku',
383 'ja': 'jpn',
384 'jv': 'jav',
385 'ka': 'kat',
386 'kg': 'kon',
387 'ki': 'kik',
388 'kj': 'kua',
389 'kk': 'kaz',
390 'kl': 'kal',
391 'km': 'khm',
392 'kn': 'kan',
393 'ko': 'kor',
394 'kr': 'kau',
395 'ks': 'kas',
396 'ku': 'kur',
397 'kv': 'kom',
398 'kw': 'cor',
399 'ky': 'kir',
400 'la': 'lat',
401 'lb': 'ltz',
402 'lg': 'lug',
403 'li': 'lim',
404 'ln': 'lin',
405 'lo': 'lao',
406 'lt': 'lit',
407 'lu': 'lub',
408 'lv': 'lav',
409 'mg': 'mlg',
410 'mh': 'mah',
411 'mi': 'mri',
412 'mk': 'mkd',
413 'ml': 'mal',
414 'mn': 'mon',
415 'mr': 'mar',
416 'ms': 'msa',
417 'mt': 'mlt',
418 'my': 'mya',
419 'na': 'nau',
420 'nb': 'nob',
421 'nd': 'nde',
422 'ne': 'nep',
423 'ng': 'ndo',
424 'nl': 'nld',
425 'nn': 'nno',
426 'no': 'nor',
427 'nr': 'nbl',
428 'nv': 'nav',
429 'ny': 'nya',
430 'oc': 'oci',
431 'oj': 'oji',
432 'om': 'orm',
433 'or': 'ori',
434 'os': 'oss',
435 'pa': 'pan',
436 'pi': 'pli',
437 'pl': 'pol',
438 'ps': 'pus',
439 'pt': 'por',
440 'qu': 'que',
441 'rm': 'roh',
442 'rn': 'run',
443 'ro': 'ron',
444 'ru': 'rus',
445 'rw': 'kin',
446 'sa': 'san',
447 'sc': 'srd',
448 'sd': 'snd',
449 'se': 'sme',
450 'sg': 'sag',
451 'si': 'sin',
452 'sk': 'slk',
453 'sl': 'slv',
454 'sm': 'smo',
455 'sn': 'sna',
456 'so': 'som',
457 'sq': 'sqi',
458 'sr': 'srp',
459 'ss': 'ssw',
460 'st': 'sot',
461 'su': 'sun',
462 'sv': 'swe',
463 'sw': 'swa',
464 'ta': 'tam',
465 'te': 'tel',
466 'tg': 'tgk',
467 'th': 'tha',
468 'ti': 'tir',
469 'tk': 'tuk',
470 'tl': 'tgl',
471 'tn': 'tsn',
472 'to': 'ton',
473 'tr': 'tur',
474 'ts': 'tso',
475 'tt': 'tat',
476 'tw': 'twi',
477 'ty': 'tah',
478 'ug': 'uig',
479 'uk': 'ukr',
480 'ur': 'urd',
481 'uz': 'uzb',
482 've': 'ven',
483 'vi': 'vie',
484 'vo': 'vol',
485 'wa': 'wln',
486 'wo': 'wol',
487 'xh': 'xho',
488 'yi': 'yid',
489 'yo': 'yor',
490 'za': 'zha',
491 'zh': 'zho',
492 'zu': 'zul',
493 }
494
495 @classmethod
496 def _conver_lang_code(cls, code):
497 """Convert language code from ISO 639-1 to ISO 639-2/T"""
498 return cls._lang_map.get(code[:2])
499
500 def run(self, information):
501 if information['ext'] != 'mp4':
502 self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4 files')
503 return [], information
504 subtitles = information.get('requested_subtitles')
505 if not subtitles:
506 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
507 return [], information
508
509 sub_langs = list(subtitles.keys())
510 filename = information['filepath']
511 sub_filenames = [subtitles_filename(filename, lang, sub_info['ext']) for lang, sub_info in subtitles.items()]
512 input_files = [filename] + sub_filenames
513
514 opts = [
515 '-map', '0',
516 '-c', 'copy',
517 # Don't copy the existing subtitles, we may be running the
518 # postprocessor a second time
519 '-map', '-0:s',
520 '-c:s', 'mov_text',
521 ]
522 for (i, lang) in enumerate(sub_langs):
523 opts.extend(['-map', '%d:0' % (i + 1)])
524 lang_code = self._conver_lang_code(lang)
525 if lang_code is not None:
526 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
527
528 temp_filename = prepend_extension(filename, 'temp')
529 self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
530 self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
531 os.remove(encodeFilename(filename))
532 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
533
534 return sub_filenames, information
535
536
537 class FFmpegMetadataPP(FFmpegPostProcessor):
538 def run(self, info):
539 metadata = {}
540 if info.get('title') is not None:
541 metadata['title'] = info['title']
542 if info.get('upload_date') is not None:
543 metadata['date'] = info['upload_date']
544 if info.get('artist') is not None:
545 metadata['artist'] = info['artist']
546 elif info.get('uploader') is not None:
547 metadata['artist'] = info['uploader']
548 elif info.get('uploader_id') is not None:
549 metadata['artist'] = info['uploader_id']
550 if info.get('description') is not None:
551 metadata['description'] = info['description']
552 metadata['comment'] = info['description']
553 if info.get('webpage_url') is not None:
554 metadata['purl'] = info['webpage_url']
555 if info.get('album') is not None:
556 metadata['album'] = info['album']
557
558 if not metadata:
559 self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
560 return [], info
561
562 filename = info['filepath']
563 temp_filename = prepend_extension(filename, 'temp')
564
565 if info['ext'] == 'm4a':
566 options = ['-vn', '-acodec', 'copy']
567 else:
568 options = ['-c', 'copy']
569
570 for (name, value) in metadata.items():
571 options.extend(['-metadata', '%s=%s' % (name, value)])
572
573 self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
574 self.run_ffmpeg(filename, temp_filename, options)
575 os.remove(encodeFilename(filename))
576 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
577 return [], info
578
579
580 class FFmpegMergerPP(FFmpegPostProcessor):
581 def run(self, info):
582 filename = info['filepath']
583 temp_filename = prepend_extension(filename, 'temp')
584 args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
585 self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
586 self.run_ffmpeg_multiple_files(info['__files_to_merge'], temp_filename, args)
587 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
588 return info['__files_to_merge'], info
589
590
591 class FFmpegAudioFixPP(FFmpegPostProcessor):
592 def run(self, info):
593 filename = info['filepath']
594 temp_filename = prepend_extension(filename, 'temp')
595
596 options = ['-vn', '-acodec', 'copy']
597 self._downloader.to_screen('[ffmpeg] Fixing audio file "%s"' % filename)
598 self.run_ffmpeg(filename, temp_filename, options)
599
600 os.remove(encodeFilename(filename))
601 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
602
603 return [], info
604
605
606 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
607 def run(self, info):
608 stretched_ratio = info.get('stretched_ratio')
609 if stretched_ratio is None or stretched_ratio == 1:
610 return [], info
611
612 filename = info['filepath']
613 temp_filename = prepend_extension(filename, 'temp')
614
615 options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
616 self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
617 self.run_ffmpeg(filename, temp_filename, options)
618
619 os.remove(encodeFilename(filename))
620 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
621
622 return [], info
623
624
625 class FFmpegFixupM4aPP(FFmpegPostProcessor):
626 def run(self, info):
627 if info.get('container') != 'm4a_dash':
628 return [], info
629
630 filename = info['filepath']
631 temp_filename = prepend_extension(filename, 'temp')
632
633 options = ['-c', 'copy', '-f', 'mp4']
634 self._downloader.to_screen('[ffmpeg] Correcting container in "%s"' % filename)
635 self.run_ffmpeg(filename, temp_filename, options)
636
637 os.remove(encodeFilename(filename))
638 os.rename(encodeFilename(temp_filename), encodeFilename(filename))
639
640 return [], info
641
642
643 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
644 def __init__(self, downloader=None, format=None):
645 super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
646 self.format = format
647
648 def run(self, info):
649 subs = info.get('requested_subtitles')
650 filename = info['filepath']
651 new_ext = self.format
652 new_format = new_ext
653 if new_format == 'vtt':
654 new_format = 'webvtt'
655 if subs is None:
656 self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
657 return [], info
658 self._downloader.to_screen('[ffmpeg] Converting subtitles')
659 for lang, sub in subs.items():
660 ext = sub['ext']
661 if ext == new_ext:
662 self._downloader.to_screen(
663 '[ffmpeg] Subtitle file for %s is already in the requested'
664 'format' % new_ext)
665 continue
666 new_file = subtitles_filename(filename, lang, new_ext)
667 self.run_ffmpeg(
668 subtitles_filename(filename, lang, ext),
669 new_file, ['-f', new_format])
670
671 with io.open(new_file, 'rt', encoding='utf-8') as f:
672 subs[lang] = {
673 'ext': ext,
674 'data': f.read(),
675 }
676
677 return [], info