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