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