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