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