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