]> git.bitcoin.ninja Git - youtube-dl/blob - youtube_dl/postprocessor/ffmpeg.py
4c4a038f9ca181d7d865e9e751345a0b673a1a08
[youtube-dl] / 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 or
268                 (self._nopostoverwrites and os.path.exists(encodeFilename(new_path)))):
269             self._downloader.to_screen('[youtube] Post-process file %s exists, skipping' % new_path)
270             return True, information
271
272         try:
273             self._downloader.to_screen('[' + self.basename + '] Destination: ' + new_path)
274             self.run_ffmpeg(path, new_path, acodec, more_opts)
275         except AudioConversionError as e:
276             raise PostProcessingError(
277                 'audio conversion failed: ' + e.msg)
278         except Exception:
279             raise PostProcessingError('error running ' + self.basename)
280
281         # Try to update the date time for extracted audio file.
282         if information.get('filetime') is not None:
283             self.try_utime(
284                 new_path, time.time(), information['filetime'],
285                 errnote='Cannot update utime of audio file')
286
287         information['filepath'] = new_path
288         return False, information
289
290
291 class FFmpegVideoConvertorPP(FFmpegPostProcessor):
292     def __init__(self, downloader=None, preferedformat=None):
293         super(FFmpegVideoConvertorPP, self).__init__(downloader)
294         self._preferedformat = preferedformat
295
296     def run(self, information):
297         path = information['filepath']
298         prefix, sep, ext = path.rpartition('.')
299         outpath = prefix + sep + self._preferedformat
300         if information['ext'] == self._preferedformat:
301             self._downloader.to_screen('[ffmpeg] Not converting video file %s - already is in target format %s' % (path, self._preferedformat))
302             return True, information
303         self._downloader.to_screen('[' + 'ffmpeg' + '] Converting video from %s to %s, Destination: ' % (information['ext'], self._preferedformat) + outpath)
304         self.run_ffmpeg(path, outpath, [])
305         information['filepath'] = outpath
306         information['format'] = self._preferedformat
307         information['ext'] = self._preferedformat
308         return False, information
309
310
311 class FFmpegEmbedSubtitlePP(FFmpegPostProcessor):
312     # See http://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
313     _lang_map = {
314         'aa': 'aar',
315         'ab': 'abk',
316         'ae': 'ave',
317         'af': 'afr',
318         'ak': 'aka',
319         'am': 'amh',
320         'an': 'arg',
321         'ar': 'ara',
322         'as': 'asm',
323         'av': 'ava',
324         'ay': 'aym',
325         'az': 'aze',
326         'ba': 'bak',
327         'be': 'bel',
328         'bg': 'bul',
329         'bh': 'bih',
330         'bi': 'bis',
331         'bm': 'bam',
332         'bn': 'ben',
333         'bo': 'bod',
334         'br': 'bre',
335         'bs': 'bos',
336         'ca': 'cat',
337         'ce': 'che',
338         'ch': 'cha',
339         'co': 'cos',
340         'cr': 'cre',
341         'cs': 'ces',
342         'cu': 'chu',
343         'cv': 'chv',
344         'cy': 'cym',
345         'da': 'dan',
346         'de': 'deu',
347         'dv': 'div',
348         'dz': 'dzo',
349         'ee': 'ewe',
350         'el': 'ell',
351         'en': 'eng',
352         'eo': 'epo',
353         'es': 'spa',
354         'et': 'est',
355         'eu': 'eus',
356         'fa': 'fas',
357         'ff': 'ful',
358         'fi': 'fin',
359         'fj': 'fij',
360         'fo': 'fao',
361         'fr': 'fra',
362         'fy': 'fry',
363         'ga': 'gle',
364         'gd': 'gla',
365         'gl': 'glg',
366         'gn': 'grn',
367         'gu': 'guj',
368         'gv': 'glv',
369         'ha': 'hau',
370         'he': 'heb',
371         'hi': 'hin',
372         'ho': 'hmo',
373         'hr': 'hrv',
374         'ht': 'hat',
375         'hu': 'hun',
376         'hy': 'hye',
377         'hz': 'her',
378         'ia': 'ina',
379         'id': 'ind',
380         'ie': 'ile',
381         'ig': 'ibo',
382         'ii': 'iii',
383         'ik': 'ipk',
384         'io': 'ido',
385         'is': 'isl',
386         'it': 'ita',
387         'iu': 'iku',
388         'ja': 'jpn',
389         'jv': 'jav',
390         'ka': 'kat',
391         'kg': 'kon',
392         'ki': 'kik',
393         'kj': 'kua',
394         'kk': 'kaz',
395         'kl': 'kal',
396         'km': 'khm',
397         'kn': 'kan',
398         'ko': 'kor',
399         'kr': 'kau',
400         'ks': 'kas',
401         'ku': 'kur',
402         'kv': 'kom',
403         'kw': 'cor',
404         'ky': 'kir',
405         'la': 'lat',
406         'lb': 'ltz',
407         'lg': 'lug',
408         'li': 'lim',
409         'ln': 'lin',
410         'lo': 'lao',
411         'lt': 'lit',
412         'lu': 'lub',
413         'lv': 'lav',
414         'mg': 'mlg',
415         'mh': 'mah',
416         'mi': 'mri',
417         'mk': 'mkd',
418         'ml': 'mal',
419         'mn': 'mon',
420         'mr': 'mar',
421         'ms': 'msa',
422         'mt': 'mlt',
423         'my': 'mya',
424         'na': 'nau',
425         'nb': 'nob',
426         'nd': 'nde',
427         'ne': 'nep',
428         'ng': 'ndo',
429         'nl': 'nld',
430         'nn': 'nno',
431         'no': 'nor',
432         'nr': 'nbl',
433         'nv': 'nav',
434         'ny': 'nya',
435         'oc': 'oci',
436         'oj': 'oji',
437         'om': 'orm',
438         'or': 'ori',
439         'os': 'oss',
440         'pa': 'pan',
441         'pi': 'pli',
442         'pl': 'pol',
443         'ps': 'pus',
444         'pt': 'por',
445         'qu': 'que',
446         'rm': 'roh',
447         'rn': 'run',
448         'ro': 'ron',
449         'ru': 'rus',
450         'rw': 'kin',
451         'sa': 'san',
452         'sc': 'srd',
453         'sd': 'snd',
454         'se': 'sme',
455         'sg': 'sag',
456         'si': 'sin',
457         'sk': 'slk',
458         'sl': 'slv',
459         'sm': 'smo',
460         'sn': 'sna',
461         'so': 'som',
462         'sq': 'sqi',
463         'sr': 'srp',
464         'ss': 'ssw',
465         'st': 'sot',
466         'su': 'sun',
467         'sv': 'swe',
468         'sw': 'swa',
469         'ta': 'tam',
470         'te': 'tel',
471         'tg': 'tgk',
472         'th': 'tha',
473         'ti': 'tir',
474         'tk': 'tuk',
475         'tl': 'tgl',
476         'tn': 'tsn',
477         'to': 'ton',
478         'tr': 'tur',
479         'ts': 'tso',
480         'tt': 'tat',
481         'tw': 'twi',
482         'ty': 'tah',
483         'ug': 'uig',
484         'uk': 'ukr',
485         'ur': 'urd',
486         'uz': 'uzb',
487         've': 'ven',
488         'vi': 'vie',
489         'vo': 'vol',
490         'wa': 'wln',
491         'wo': 'wol',
492         'xh': 'xho',
493         'yi': 'yid',
494         'yo': 'yor',
495         'za': 'zha',
496         'zh': 'zho',
497         'zu': 'zul',
498     }
499
500     @classmethod
501     def _conver_lang_code(cls, code):
502         """Convert language code from ISO 639-1 to ISO 639-2/T"""
503         return cls._lang_map.get(code[:2])
504
505     def run(self, information):
506         if information['ext'] != 'mp4':
507             self._downloader.to_screen('[ffmpeg] Subtitles can only be embedded in mp4 files')
508             return True, information
509         subtitles = information.get('requested_subtitles')
510         if not subtitles:
511             self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to embed')
512             return True, information
513
514         sub_langs = list(subtitles.keys())
515         filename = information['filepath']
516         input_files = [filename] + [subtitles_filename(filename, lang, sub_info['ext']) for lang, sub_info in subtitles.items()]
517
518         opts = [
519             '-map', '0',
520             '-c', 'copy',
521             # Don't copy the existing subtitles, we may be running the
522             # postprocessor a second time
523             '-map', '-0:s',
524             '-c:s', 'mov_text',
525         ]
526         for (i, lang) in enumerate(sub_langs):
527             opts.extend(['-map', '%d:0' % (i + 1)])
528             lang_code = self._conver_lang_code(lang)
529             if lang_code is not None:
530                 opts.extend(['-metadata:s:s:%d' % i, 'language=%s' % lang_code])
531
532         temp_filename = prepend_extension(filename, 'temp')
533         self._downloader.to_screen('[ffmpeg] Embedding subtitles in \'%s\'' % filename)
534         self.run_ffmpeg_multiple_files(input_files, temp_filename, opts)
535         os.remove(encodeFilename(filename))
536         os.rename(encodeFilename(temp_filename), encodeFilename(filename))
537
538         return True, information
539
540
541 class FFmpegMetadataPP(FFmpegPostProcessor):
542     def run(self, info):
543         metadata = {}
544         if info.get('title') is not None:
545             metadata['title'] = info['title']
546         if info.get('upload_date') is not None:
547             metadata['date'] = info['upload_date']
548         if info.get('artist') is not None:
549             metadata['artist'] = info['artist']
550         elif info.get('uploader') is not None:
551             metadata['artist'] = info['uploader']
552         elif info.get('uploader_id') is not None:
553             metadata['artist'] = info['uploader_id']
554         if info.get('description') is not None:
555             metadata['description'] = info['description']
556             metadata['comment'] = info['description']
557         if info.get('webpage_url') is not None:
558             metadata['purl'] = info['webpage_url']
559         if info.get('album') is not None:
560             metadata['album'] = info['album']
561
562         if not metadata:
563             self._downloader.to_screen('[ffmpeg] There isn\'t any metadata to add')
564             return True, info
565
566         filename = info['filepath']
567         temp_filename = prepend_extension(filename, 'temp')
568
569         if info['ext'] == 'm4a':
570             options = ['-vn', '-acodec', 'copy']
571         else:
572             options = ['-c', 'copy']
573
574         for (name, value) in metadata.items():
575             options.extend(['-metadata', '%s=%s' % (name, value)])
576
577         self._downloader.to_screen('[ffmpeg] Adding metadata to \'%s\'' % filename)
578         self.run_ffmpeg(filename, temp_filename, options)
579         os.remove(encodeFilename(filename))
580         os.rename(encodeFilename(temp_filename), encodeFilename(filename))
581         return True, info
582
583
584 class FFmpegMergerPP(FFmpegPostProcessor):
585     def run(self, info):
586         filename = info['filepath']
587         args = ['-c', 'copy', '-map', '0:v:0', '-map', '1:a:0']
588         self._downloader.to_screen('[ffmpeg] Merging formats into "%s"' % filename)
589         self.run_ffmpeg_multiple_files(info['__files_to_merge'], filename, args)
590         return True, info
591
592
593 class FFmpegAudioFixPP(FFmpegPostProcessor):
594     def run(self, info):
595         filename = info['filepath']
596         temp_filename = prepend_extension(filename, 'temp')
597
598         options = ['-vn', '-acodec', 'copy']
599         self._downloader.to_screen('[ffmpeg] Fixing audio file "%s"' % filename)
600         self.run_ffmpeg(filename, temp_filename, options)
601
602         os.remove(encodeFilename(filename))
603         os.rename(encodeFilename(temp_filename), encodeFilename(filename))
604
605         return True, info
606
607
608 class FFmpegFixupStretchedPP(FFmpegPostProcessor):
609     def run(self, info):
610         stretched_ratio = info.get('stretched_ratio')
611         if stretched_ratio is None or stretched_ratio == 1:
612             return True, info
613
614         filename = info['filepath']
615         temp_filename = prepend_extension(filename, 'temp')
616
617         options = ['-c', 'copy', '-aspect', '%f' % stretched_ratio]
618         self._downloader.to_screen('[ffmpeg] Fixing aspect ratio in "%s"' % filename)
619         self.run_ffmpeg(filename, temp_filename, options)
620
621         os.remove(encodeFilename(filename))
622         os.rename(encodeFilename(temp_filename), encodeFilename(filename))
623
624         return True, info
625
626
627 class FFmpegFixupM4aPP(FFmpegPostProcessor):
628     def run(self, info):
629         if info.get('container') != 'm4a_dash':
630             return True, info
631
632         filename = info['filepath']
633         temp_filename = prepend_extension(filename, 'temp')
634
635         options = ['-c', 'copy', '-f', 'mp4']
636         self._downloader.to_screen('[ffmpeg] Correcting container in "%s"' % filename)
637         self.run_ffmpeg(filename, temp_filename, options)
638
639         os.remove(encodeFilename(filename))
640         os.rename(encodeFilename(temp_filename), encodeFilename(filename))
641
642         return True, info
643
644
645 class FFmpegSubtitlesConvertorPP(FFmpegPostProcessor):
646     def __init__(self, downloader=None, format=None):
647         super(FFmpegSubtitlesConvertorPP, self).__init__(downloader)
648         self.format = format
649
650     def run(self, info):
651         subs = info.get('requested_subtitles')
652         filename = info['filepath']
653         new_ext = self.format
654         new_format = new_ext
655         if new_format == 'vtt':
656             new_format = 'webvtt'
657         if subs is None:
658             self._downloader.to_screen('[ffmpeg] There aren\'t any subtitles to convert')
659             return True, info
660         self._downloader.to_screen('[ffmpeg] Converting subtitles')
661         for lang, sub in subs.items():
662             ext = sub['ext']
663             if ext == new_ext:
664                 self._downloader.to_screen(
665                     '[ffmpeg] Subtitle file for %s is already in the requested'
666                     'format' % new_ext)
667                 continue
668             new_file = subtitles_filename(filename, lang, new_ext)
669             self.run_ffmpeg(
670                 subtitles_filename(filename, lang, ext),
671                 new_file, ['-f', new_format])
672
673             with io.open(new_file, 'rt', encoding='utf-8') as f:
674                 subs[lang] = {
675                     'ext': ext,
676                     'data': f.read(),
677                 }
678
679         return True, info