yt_dlp/__init__.py

   1 try:
   2     import contextvars  # noqa: F401
   3 except Exception:
   4     raise Exception(
   5         f'You are using an unsupported version of Python. Only Python versions 3.7 and above are supported by yt-dlp')  # noqa: F541
   6
   7 __license__ = 'Public Domain'
   8
   9 import collections
  10 import getpass
  11 import itertools
  12 import optparse
  13 import os
  14 import re
  15 import sys
  16
  17 from .compat import compat_shlex_quote
  18 from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS
  19 from .downloader import FileDownloader
  20 from .downloader.external import get_external_downloader
  21 from .extractor import list_extractor_classes
  22 from .extractor.adobepass import MSO_INFO
  23 from .extractor.common import InfoExtractor
  24 from .options import parseOpts
  25 from .postprocessor import (
  26     FFmpegExtractAudioPP,
  27     FFmpegMergerPP,
  28     FFmpegPostProcessor,
  29     FFmpegSubtitlesConvertorPP,
  30     FFmpegThumbnailsConvertorPP,
  31     FFmpegVideoConvertorPP,
  32     FFmpegVideoRemuxerPP,
  33     MetadataFromFieldPP,
  34     MetadataParserPP,
  35 )
  36 from .update import Updater
  37 from .utils import (
  38     NO_DEFAULT,
  39     POSTPROCESS_WHEN,
  40     DateRange,
  41     DownloadCancelled,
  42     DownloadError,
  43     GeoUtils,
  44     PlaylistEntries,
  45     SameFileError,
  46     decodeOption,
  47     download_range_func,
  48     expand_path,
  49     float_or_none,
  50     format_field,
  51     int_or_none,
  52     match_filter_func,
  53     parse_duration,
  54     preferredencoding,
  55     read_batch_urls,
  56     read_stdin,
  57     render_table,
  58     setproctitle,
  59     std_headers,
  60     traverse_obj,
  61     variadic,
  62     write_string,
  63 )
  64 from .YoutubeDL import YoutubeDL
  65
  66
  67 def _exit(status=0, *args):
  68     for msg in args:
  69         sys.stderr.write(msg)
  70     raise SystemExit(status)
  71
  72
  73 def get_urls(urls, batchfile, verbose):
  74     # Batch file verification
  75     batch_urls = []
  76     if batchfile is not None:
  77         try:
  78             batch_urls = read_batch_urls(
  79                 read_stdin('URLs') if batchfile == '-'
  80                 else open(expand_path(batchfile), encoding='utf-8', errors='ignore'))
  81             if verbose:
  82                 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
  83         except OSError:
  84             _exit(f'ERROR: batch file {batchfile} could not be read')
  85     _enc = preferredencoding()
  86     return [
  87         url.strip().decode(_enc, 'ignore') if isinstance(url, bytes) else url.strip()
  88         for url in batch_urls + urls]
  89
  90
  91 def print_extractor_information(opts, urls):
  92     # Importing GenericIE is currently slow since it imports other extractors
  93     # TODO: Move this back to module level after generalization of embed detection
  94     from .extractor.generic import GenericIE
  95
  96     out = ''
  97     if opts.list_extractors:
  98         urls = dict.fromkeys(urls, False)
  99         for ie in list_extractor_classes(opts.age_limit):
 100             out += ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie.working() else '') + '\n'
 101             if ie == GenericIE:
 102                 matched_urls = [url for url, matched in urls.items() if not matched]
 103             else:
 104                 matched_urls = tuple(filter(ie.suitable, urls.keys()))
 105                 urls.update(dict.fromkeys(matched_urls, True))
 106             out += ''.join(f'  {url}\n' for url in matched_urls)
 107     elif opts.list_extractor_descriptions:
 108         _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
 109         out = '\n'.join(
 110             ie.description(markdown=False, search_examples=_SEARCHES)
 111             for ie in list_extractor_classes(opts.age_limit) if ie.working() and ie.IE_DESC is not False)
 112     elif opts.ap_list_mso:
 113         out = 'Supported TV Providers:\n%s\n' % render_table(
 114             ['mso', 'mso name'],
 115             [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()])
 116     else:
 117         return False
 118     write_string(out, out=sys.stdout)
 119     return True
 120
 121
 122 def set_compat_opts(opts):
 123     def _unused_compat_opt(name):
 124         if name not in opts.compat_opts:
 125             return False
 126         opts.compat_opts.discard(name)
 127         opts.compat_opts.update(['*%s' % name])
 128         return True
 129
 130     def set_default_compat(compat_name, opt_name, default=True, remove_compat=True):
 131         attr = getattr(opts, opt_name)
 132         if compat_name in opts.compat_opts:
 133             if attr is None:
 134                 setattr(opts, opt_name, not default)
 135                 return True
 136             else:
 137                 if remove_compat:
 138                     _unused_compat_opt(compat_name)
 139                 return False
 140         elif attr is None:
 141             setattr(opts, opt_name, default)
 142         return None
 143
 144     set_default_compat('abort-on-error', 'ignoreerrors', 'only_download')
 145     set_default_compat('no-playlist-metafiles', 'allow_playlist_files')
 146     set_default_compat('no-clean-infojson', 'clean_infojson')
 147     if 'no-attach-info-json' in opts.compat_opts:
 148         if opts.embed_infojson:
 149             _unused_compat_opt('no-attach-info-json')
 150         else:
 151             opts.embed_infojson = False
 152     if 'format-sort' in opts.compat_opts:
 153         opts.format_sort.extend(InfoExtractor.FormatSort.ytdl_default)
 154     _video_multistreams_set = set_default_compat('multistreams', 'allow_multiple_video_streams', False, remove_compat=False)
 155     _audio_multistreams_set = set_default_compat('multistreams', 'allow_multiple_audio_streams', False, remove_compat=False)
 156     if _video_multistreams_set is False and _audio_multistreams_set is False:
 157         _unused_compat_opt('multistreams')
 158     if 'filename' in opts.compat_opts:
 159         if opts.outtmpl.get('default') is None:
 160             opts.outtmpl.update({'default': '%(title)s-%(id)s.%(ext)s'})
 161         else:
 162             _unused_compat_opt('filename')
 163
 164
 165 def validate_options(opts):
 166     def validate(cndn, name, value=None, msg=None):
 167         if cndn:
 168             return True
 169         raise ValueError((msg or 'invalid {name} "{value}" given').format(name=name, value=value))
 170
 171     def validate_in(name, value, items, msg=None):
 172         return validate(value is None or value in items, name, value, msg)
 173
 174     def validate_regex(name, value, regex):
 175         return validate(value is None or re.match(regex, value), name, value)
 176
 177     def validate_positive(name, value, strict=False):
 178         return validate(value is None or value > 0 or (not strict and value == 0),
 179                         name, value, '{name} "{value}" must be positive' + ('' if strict else ' or 0'))
 180
 181     def validate_minmax(min_val, max_val, min_name, max_name=None):
 182         if max_val is None or min_val is None or max_val >= min_val:
 183             return
 184         if not max_name:
 185             min_name, max_name = f'min {min_name}', f'max {min_name}'
 186         raise ValueError(f'{max_name} "{max_val}" must be must be greater than or equal to {min_name} "{min_val}"')
 187
 188     # Usernames and passwords
 189     validate(not opts.usenetrc or (opts.username is None and opts.password is None),
 190              '.netrc', msg='using {name} conflicts with giving username/password')
 191     validate(opts.password is None or opts.username is not None, 'account username', msg='{name} missing')
 192     validate(opts.ap_password is None or opts.ap_username is not None,
 193              'TV Provider account username', msg='{name} missing')
 194     validate_in('TV Provider', opts.ap_mso, MSO_INFO,
 195                 'Unsupported {name} "{value}", use --ap-list-mso to get a list of supported TV Providers')
 196
 197     # Numbers
 198     validate_positive('autonumber start', opts.autonumber_start)
 199     validate_positive('autonumber size', opts.autonumber_size, True)
 200     validate_positive('concurrent fragments', opts.concurrent_fragment_downloads, True)
 201     validate_positive('playlist start', opts.playliststart, True)
 202     if opts.playlistend != -1:
 203         validate_minmax(opts.playliststart, opts.playlistend, 'playlist start', 'playlist end')
 204
 205     # Time ranges
 206     validate_positive('subtitles sleep interval', opts.sleep_interval_subtitles)
 207     validate_positive('requests sleep interval', opts.sleep_interval_requests)
 208     validate_positive('sleep interval', opts.sleep_interval)
 209     validate_positive('max sleep interval', opts.max_sleep_interval)
 210     if opts.sleep_interval is None:
 211         validate(
 212             opts.max_sleep_interval is None, 'min sleep interval',
 213             msg='{name} must be specified; use --min-sleep-interval')
 214     elif opts.max_sleep_interval is None:
 215         opts.max_sleep_interval = opts.sleep_interval
 216     else:
 217         validate_minmax(opts.sleep_interval, opts.max_sleep_interval, 'sleep interval')
 218
 219     if opts.wait_for_video is not None:
 220         min_wait, max_wait, *_ = map(parse_duration, opts.wait_for_video.split('-', 1) + [None])
 221         validate(min_wait is not None and not (max_wait is None and '-' in opts.wait_for_video),
 222                  'time range to wait for video', opts.wait_for_video)
 223         validate_minmax(min_wait, max_wait, 'time range to wait for video')
 224         opts.wait_for_video = (min_wait, max_wait)
 225
 226     # Format sort
 227     for f in opts.format_sort:
 228         validate_regex('format sorting', f, InfoExtractor.FormatSort.regex)
 229
 230     # Postprocessor formats
 231     validate_regex('merge output format', opts.merge_output_format,
 232                    r'({0})(/({0}))*'.format('|'.join(map(re.escape, FFmpegMergerPP.SUPPORTED_EXTS))))
 233     validate_regex('audio format', opts.audioformat, FFmpegExtractAudioPP.FORMAT_RE)
 234     validate_in('subtitle format', opts.convertsubtitles, FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS)
 235     validate_regex('thumbnail format', opts.convertthumbnails, FFmpegThumbnailsConvertorPP.FORMAT_RE)
 236     validate_regex('recode video format', opts.recodevideo, FFmpegVideoConvertorPP.FORMAT_RE)
 237     validate_regex('remux video format', opts.remuxvideo, FFmpegVideoRemuxerPP.FORMAT_RE)
 238     if opts.audioquality:
 239         opts.audioquality = opts.audioquality.strip('k').strip('K')
 240         # int_or_none prevents inf, nan
 241         validate_positive('audio quality', int_or_none(float_or_none(opts.audioquality), default=0))
 242
 243     # Retries
 244     def parse_retries(name, value):
 245         if value is None:
 246             return None
 247         elif value in ('inf', 'infinite'):
 248             return float('inf')
 249         try:
 250             return int(value)
 251         except (TypeError, ValueError):
 252             validate(False, f'{name} retry count', value)
 253
 254     opts.retries = parse_retries('download', opts.retries)
 255     opts.fragment_retries = parse_retries('fragment', opts.fragment_retries)
 256     opts.extractor_retries = parse_retries('extractor', opts.extractor_retries)
 257     opts.file_access_retries = parse_retries('file access', opts.file_access_retries)
 258
 259     # Retry sleep function
 260     def parse_sleep_func(expr):
 261         NUMBER_RE = r'\d+(?:\.\d+)?'
 262         op, start, limit, step, *_ = tuple(re.fullmatch(
 263             rf'(?:(linear|exp)=)?({NUMBER_RE})(?::({NUMBER_RE})?)?(?::({NUMBER_RE}))?',
 264             expr.strip()).groups()) + (None, None)
 265
 266         if op == 'exp':
 267             return lambda n: min(float(start) * (float(step or 2) ** n), float(limit or 'inf'))
 268         else:
 269             default_step = start if op or limit else 0
 270             return lambda n: min(float(start) + float(step or default_step) * n, float(limit or 'inf'))
 271
 272     for key, expr in opts.retry_sleep.items():
 273         if not expr:
 274             del opts.retry_sleep[key]
 275             continue
 276         try:
 277             opts.retry_sleep[key] = parse_sleep_func(expr)
 278         except AttributeError:
 279             raise ValueError(f'invalid {key} retry sleep expression {expr!r}')
 280
 281     # Bytes
 282     def parse_bytes(name, value):
 283         if value is None:
 284             return None
 285         numeric_limit = FileDownloader.parse_bytes(value)
 286         validate(numeric_limit is not None, 'rate limit', value)
 287         return numeric_limit
 288
 289     opts.ratelimit = parse_bytes('rate limit', opts.ratelimit)
 290     opts.throttledratelimit = parse_bytes('throttled rate limit', opts.throttledratelimit)
 291     opts.min_filesize = parse_bytes('min filesize', opts.min_filesize)
 292     opts.max_filesize = parse_bytes('max filesize', opts.max_filesize)
 293     opts.buffersize = parse_bytes('buffer size', opts.buffersize)
 294     opts.http_chunk_size = parse_bytes('http chunk size', opts.http_chunk_size)
 295
 296     # Output templates
 297     def validate_outtmpl(tmpl, msg):
 298         err = YoutubeDL.validate_outtmpl(tmpl)
 299         if err:
 300             raise ValueError(f'invalid {msg} "{tmpl}": {err}')
 301
 302     for k, tmpl in opts.outtmpl.items():
 303         validate_outtmpl(tmpl, f'{k} output template')
 304     for type_, tmpl_list in opts.forceprint.items():
 305         for tmpl in tmpl_list:
 306             validate_outtmpl(tmpl, f'{type_} print template')
 307     for type_, tmpl_list in opts.print_to_file.items():
 308         for tmpl, file in tmpl_list:
 309             validate_outtmpl(tmpl, f'{type_} print to file template')
 310             validate_outtmpl(file, f'{type_} print to file filename')
 311     validate_outtmpl(opts.sponsorblock_chapter_title, 'SponsorBlock chapter title')
 312     for k, tmpl in opts.progress_template.items():
 313         k = f'{k[:-6]} console title' if '-title' in k else f'{k} progress'
 314         validate_outtmpl(tmpl, f'{k} template')
 315
 316     outtmpl_default = opts.outtmpl.get('default')
 317     if outtmpl_default == '':
 318         opts.skip_download = None
 319         del opts.outtmpl['default']
 320     if outtmpl_default and not os.path.splitext(outtmpl_default)[1] and opts.extractaudio:
 321         raise ValueError(
 322             'Cannot download a video and extract audio into the same file! '
 323             f'Use "{outtmpl_default}.%(ext)s" instead of "{outtmpl_default}" as the output template')
 324
 325     def parse_chapters(name, value):
 326         chapters, ranges = [], []
 327         for regex in value or []:
 328             if regex.startswith('*'):
 329                 for range in regex[1:].split(','):
 330                     dur = tuple(map(parse_duration, range.strip().split('-')))
 331                     if len(dur) == 2 and all(t is not None for t in dur):
 332                         ranges.append(dur)
 333                     else:
 334                         raise ValueError(f'invalid {name} time range "{regex}". Must be of the form *start-end')
 335                 continue
 336             try:
 337                 chapters.append(re.compile(regex))
 338             except re.error as err:
 339                 raise ValueError(f'invalid {name} regex "{regex}" - {err}')
 340         return chapters, ranges
 341
 342     opts.remove_chapters, opts.remove_ranges = parse_chapters('--remove-chapters', opts.remove_chapters)
 343     opts.download_ranges = download_range_func(*parse_chapters('--download-sections', opts.download_ranges))
 344
 345     # Cookies from browser
 346     if opts.cookiesfrombrowser:
 347         mobj = re.match(r'(?P<name>[^+:]+)(\s*\+\s*(?P<keyring>[^:]+))?(\s*:(?P<profile>.+))?', opts.cookiesfrombrowser)
 348         if mobj is None:
 349             raise ValueError(f'invalid cookies from browser arguments: {opts.cookiesfrombrowser}')
 350         browser_name, keyring, profile = mobj.group('name', 'keyring', 'profile')
 351         browser_name = browser_name.lower()
 352         if browser_name not in SUPPORTED_BROWSERS:
 353             raise ValueError(f'unsupported browser specified for cookies: "{browser_name}". '
 354                              f'Supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}')
 355         if keyring is not None:
 356             keyring = keyring.upper()
 357             if keyring not in SUPPORTED_KEYRINGS:
 358                 raise ValueError(f'unsupported keyring specified for cookies: "{keyring}". '
 359                                  f'Supported keyrings are: {", ".join(sorted(SUPPORTED_KEYRINGS))}')
 360         opts.cookiesfrombrowser = (browser_name, profile, keyring)
 361
 362     # MetadataParser
 363     def metadataparser_actions(f):
 364         if isinstance(f, str):
 365             cmd = '--parse-metadata %s' % compat_shlex_quote(f)
 366             try:
 367                 actions = [MetadataFromFieldPP.to_action(f)]
 368             except Exception as err:
 369                 raise ValueError(f'{cmd} is invalid; {err}')
 370         else:
 371             cmd = '--replace-in-metadata %s' % ' '.join(map(compat_shlex_quote, f))
 372             actions = ((MetadataParserPP.Actions.REPLACE, x, *f[1:]) for x in f[0].split(','))
 373
 374         for action in actions:
 375             try:
 376                 MetadataParserPP.validate_action(*action)
 377             except Exception as err:
 378                 raise ValueError(f'{cmd} is invalid; {err}')
 379             yield action
 380
 381     parse_metadata = opts.parse_metadata or []
 382     if opts.metafromtitle is not None:
 383         parse_metadata.append('title:%s' % opts.metafromtitle)
 384     opts.parse_metadata = list(itertools.chain(*map(metadataparser_actions, parse_metadata)))
 385
 386     # Other options
 387     if opts.playlist_items is not None:
 388         try:
 389             tuple(PlaylistEntries.parse_playlist_items(opts.playlist_items))
 390         except Exception as err:
 391             raise ValueError(f'Invalid playlist-items {opts.playlist_items!r}: {err}')
 392
 393     geo_bypass_code = opts.geo_bypass_ip_block or opts.geo_bypass_country
 394     if geo_bypass_code is not None:
 395         try:
 396             GeoUtils.random_ipv4(geo_bypass_code)
 397         except Exception:
 398             raise ValueError('unsupported geo-bypass country or ip-block')
 399
 400     opts.match_filter = match_filter_func(opts.match_filter)
 401
 402     if opts.download_archive is not None:
 403         opts.download_archive = expand_path(opts.download_archive)
 404
 405     if opts.user_agent is not None:
 406         opts.headers.setdefault('User-Agent', opts.user_agent)
 407     if opts.referer is not None:
 408         opts.headers.setdefault('Referer', opts.referer)
 409
 410     if opts.no_sponsorblock:
 411         opts.sponsorblock_mark = opts.sponsorblock_remove = set()
 412
 413     default_downloader = None
 414     for proto, path in opts.external_downloader.items():
 415         if path == 'native':
 416             continue
 417         ed = get_external_downloader(path)
 418         if ed is None:
 419             raise ValueError(
 420                 f'No such {format_field(proto, None, "%s ", ignore="default")}external downloader "{path}"')
 421         elif ed and proto == 'default':
 422             default_downloader = ed.get_basename()
 423
 424     warnings, deprecation_warnings = [], []
 425
 426     # Common mistake: -f best
 427     if opts.format == 'best':
 428         warnings.append('.\n         '.join((
 429             '"-f best" selects the best pre-merged format which is often not the best option',
 430             'To let yt-dlp download and merge the best available formats, simply do not pass any format selection',
 431             'If you know what you are doing and want only the best pre-merged format, use "-f b" instead to suppress this warning')))
 432
 433     # --(postprocessor/downloader)-args without name
 434     def report_args_compat(name, value, key1, key2=None, where=None):
 435         if key1 in value and key2 not in value:
 436             warnings.append(f'{name.title()} arguments given without specifying name. '
 437                             f'The arguments will be given to {where or f"all {name}s"}')
 438             return True
 439         return False
 440
 441     if report_args_compat('external downloader', opts.external_downloader_args,
 442                           'default', where=default_downloader) and default_downloader:
 443         # Compat with youtube-dl's behavior. See https://github.com/ytdl-org/youtube-dl/commit/49c5293014bc11ec8c009856cd63cffa6296c1e1
 444         opts.external_downloader_args.setdefault(default_downloader, opts.external_downloader_args.pop('default'))
 445
 446     if report_args_compat('post-processor', opts.postprocessor_args, 'default-compat', 'default'):
 447         opts.postprocessor_args['default'] = opts.postprocessor_args.pop('default-compat')
 448         opts.postprocessor_args.setdefault('sponskrub', [])
 449
 450     def report_conflict(arg1, opt1, arg2='--allow-unplayable-formats', opt2='allow_unplayable_formats',
 451                         val1=NO_DEFAULT, val2=NO_DEFAULT, default=False):
 452         if val2 is NO_DEFAULT:
 453             val2 = getattr(opts, opt2)
 454         if not val2:
 455             return
 456
 457         if val1 is NO_DEFAULT:
 458             val1 = getattr(opts, opt1)
 459         if val1:
 460             warnings.append(f'{arg1} is ignored since {arg2} was given')
 461         setattr(opts, opt1, default)
 462
 463     # Conflicting options
 464     report_conflict('--playlist-reverse', 'playlist_reverse', '--playlist-random', 'playlist_random')
 465     report_conflict('--playlist-reverse', 'playlist_reverse', '--lazy-playlist', 'lazy_playlist')
 466     report_conflict('--playlist-random', 'playlist_random', '--lazy-playlist', 'lazy_playlist')
 467     report_conflict('--dateafter', 'dateafter', '--date', 'date', default=None)
 468     report_conflict('--datebefore', 'datebefore', '--date', 'date', default=None)
 469     report_conflict('--exec-before-download', 'exec_before_dl_cmd',
 470                     '"--exec before_dl:"', 'exec_cmd', val2=opts.exec_cmd.get('before_dl'))
 471     report_conflict('--id', 'useid', '--output', 'outtmpl', val2=opts.outtmpl.get('default'))
 472     report_conflict('--remux-video', 'remuxvideo', '--recode-video', 'recodevideo')
 473     report_conflict('--sponskrub', 'sponskrub', '--remove-chapters', 'remove_chapters')
 474     report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-mark', 'sponsorblock_mark')
 475     report_conflict('--sponskrub', 'sponskrub', '--sponsorblock-remove', 'sponsorblock_remove')
 476     report_conflict('--sponskrub-cut', 'sponskrub_cut', '--split-chapter', 'split_chapters',
 477                     val1=opts.sponskrub and opts.sponskrub_cut)
 478
 479     # Conflicts with --allow-unplayable-formats
 480     report_conflict('--add-metadata', 'addmetadata')
 481     report_conflict('--embed-chapters', 'addchapters')
 482     report_conflict('--embed-info-json', 'embed_infojson')
 483     report_conflict('--embed-subs', 'embedsubtitles')
 484     report_conflict('--embed-thumbnail', 'embedthumbnail')
 485     report_conflict('--extract-audio', 'extractaudio')
 486     report_conflict('--fixup', 'fixup', val1=opts.fixup not in (None, 'never', 'ignore'), default='never')
 487     report_conflict('--recode-video', 'recodevideo')
 488     report_conflict('--remove-chapters', 'remove_chapters', default=[])
 489     report_conflict('--remux-video', 'remuxvideo')
 490     report_conflict('--sponskrub', 'sponskrub')
 491     report_conflict('--sponsorblock-remove', 'sponsorblock_remove', default=set())
 492     report_conflict('--xattrs', 'xattrs')
 493
 494     # Fully deprecated options
 495     def report_deprecation(val, old, new=None):
 496         if not val:
 497             return
 498         deprecation_warnings.append(
 499             f'{old} is deprecated and may be removed in a future version. Use {new} instead' if new
 500             else f'{old} is deprecated and may not work as expected')
 501
 502     report_deprecation(opts.sponskrub, '--sponskrub', '--sponsorblock-mark or --sponsorblock-remove')
 503     report_deprecation(not opts.prefer_ffmpeg, '--prefer-avconv', 'ffmpeg')
 504     # report_deprecation(opts.include_ads, '--include-ads')  # We may re-implement this in future
 505     # report_deprecation(opts.call_home, '--call-home')  # We may re-implement this in future
 506     # report_deprecation(opts.writeannotations, '--write-annotations')  # It's just that no website has it
 507
 508     # Dependent options
 509     opts.date = DateRange.day(opts.date) if opts.date else DateRange(opts.dateafter, opts.datebefore)
 510
 511     if opts.exec_before_dl_cmd:
 512         opts.exec_cmd['before_dl'] = opts.exec_before_dl_cmd
 513
 514     if opts.useid:  # --id is not deprecated in youtube-dl
 515         opts.outtmpl['default'] = '%(id)s.%(ext)s'
 516
 517     if opts.overwrites:  # --force-overwrites implies --no-continue
 518         opts.continue_dl = False
 519
 520     if (opts.addmetadata or opts.sponsorblock_mark) and opts.addchapters is None:
 521         # Add chapters when adding metadata or marking sponsors
 522         opts.addchapters = True
 523
 524     if opts.extractaudio and not opts.keepvideo and opts.format is None:
 525         # Do not unnecessarily download audio
 526         opts.format = 'bestaudio/best'
 527
 528     if opts.getcomments and opts.writeinfojson is None and not opts.embed_infojson:
 529         # If JSON is not printed anywhere, but comments are requested, save it to file
 530         if not opts.dumpjson or opts.print_json or opts.dump_single_json:
 531             opts.writeinfojson = True
 532
 533     if opts.allsubtitles and not (opts.embedsubtitles or opts.writeautomaticsub):
 534         # --all-sub automatically sets --write-sub if --write-auto-sub is not given
 535         opts.writesubtitles = True
 536
 537     if opts.addmetadata and opts.embed_infojson is None:
 538         # If embedding metadata and infojson is present, embed it
 539         opts.embed_infojson = 'if_exists'
 540
 541     # Ask for passwords
 542     if opts.username is not None and opts.password is None:
 543         opts.password = getpass.getpass('Type account password and press [Return]: ')
 544     if opts.ap_username is not None and opts.ap_password is None:
 545         opts.ap_password = getpass.getpass('Type TV provider account password and press [Return]: ')
 546
 547     return warnings, deprecation_warnings
 548
 549
 550 def get_postprocessors(opts):
 551     yield from opts.add_postprocessors
 552
 553     if opts.parse_metadata:
 554         yield {
 555             'key': 'MetadataParser',
 556             'actions': opts.parse_metadata,
 557             'when': 'pre_process'
 558         }
 559     sponsorblock_query = opts.sponsorblock_mark | opts.sponsorblock_remove
 560     if sponsorblock_query:
 561         yield {
 562             'key': 'SponsorBlock',
 563             'categories': sponsorblock_query,
 564             'api': opts.sponsorblock_api,
 565             'when': 'after_filter'
 566         }
 567     if opts.convertsubtitles:
 568         yield {
 569             'key': 'FFmpegSubtitlesConvertor',
 570             'format': opts.convertsubtitles,
 571             'when': 'before_dl'
 572         }
 573     if opts.convertthumbnails:
 574         yield {
 575             'key': 'FFmpegThumbnailsConvertor',
 576             'format': opts.convertthumbnails,
 577             'when': 'before_dl'
 578         }
 579     if opts.extractaudio:
 580         yield {
 581             'key': 'FFmpegExtractAudio',
 582             'preferredcodec': opts.audioformat,
 583             'preferredquality': opts.audioquality,
 584             'nopostoverwrites': opts.nopostoverwrites,
 585         }
 586     if opts.remuxvideo:
 587         yield {
 588             'key': 'FFmpegVideoRemuxer',
 589             'preferedformat': opts.remuxvideo,
 590         }
 591     if opts.recodevideo:
 592         yield {
 593             'key': 'FFmpegVideoConvertor',
 594             'preferedformat': opts.recodevideo,
 595         }
 596     # If ModifyChapters is going to remove chapters, subtitles must already be in the container.
 597     if opts.embedsubtitles:
 598         keep_subs = 'no-keep-subs' not in opts.compat_opts
 599         yield {
 600             'key': 'FFmpegEmbedSubtitle',
 601             # already_have_subtitle = True prevents the file from being deleted after embedding
 602             'already_have_subtitle': opts.writesubtitles and keep_subs
 603         }
 604         if not opts.writeautomaticsub and keep_subs:
 605             opts.writesubtitles = True
 606
 607     # ModifyChapters must run before FFmpegMetadataPP
 608     if opts.remove_chapters or sponsorblock_query:
 609         yield {
 610             'key': 'ModifyChapters',
 611             'remove_chapters_patterns': opts.remove_chapters,
 612             'remove_sponsor_segments': opts.sponsorblock_remove,
 613             'remove_ranges': opts.remove_ranges,
 614             'sponsorblock_chapter_title': opts.sponsorblock_chapter_title,
 615             'force_keyframes': opts.force_keyframes_at_cuts
 616         }
 617     # FFmpegMetadataPP should be run after FFmpegVideoConvertorPP and
 618     # FFmpegExtractAudioPP as containers before conversion may not support
 619     # metadata (3gp, webm, etc.)
 620     # By default ffmpeg preserves metadata applicable for both
 621     # source and target containers. From this point the container won't change,
 622     # so metadata can be added here.
 623     if opts.addmetadata or opts.addchapters or opts.embed_infojson:
 624         yield {
 625             'key': 'FFmpegMetadata',
 626             'add_chapters': opts.addchapters,
 627             'add_metadata': opts.addmetadata,
 628             'add_infojson': opts.embed_infojson,
 629         }
 630     # Deprecated
 631     # This should be above EmbedThumbnail since sponskrub removes the thumbnail attachment
 632     # but must be below EmbedSubtitle and FFmpegMetadata
 633     # See https://github.com/yt-dlp/yt-dlp/issues/204 , https://github.com/faissaloo/SponSkrub/issues/29
 634     # If opts.sponskrub is None, sponskrub is used, but it silently fails if the executable can't be found
 635     if opts.sponskrub is not False:
 636         yield {
 637             'key': 'SponSkrub',
 638             'path': opts.sponskrub_path,
 639             'args': opts.sponskrub_args,
 640             'cut': opts.sponskrub_cut,
 641             'force': opts.sponskrub_force,
 642             'ignoreerror': opts.sponskrub is None,
 643             '_from_cli': True,
 644         }
 645     if opts.embedthumbnail:
 646         yield {
 647             'key': 'EmbedThumbnail',
 648             # already_have_thumbnail = True prevents the file from being deleted after embedding
 649             'already_have_thumbnail': opts.writethumbnail
 650         }
 651         if not opts.writethumbnail:
 652             opts.writethumbnail = True
 653             opts.outtmpl['pl_thumbnail'] = ''
 654     if opts.split_chapters:
 655         yield {
 656             'key': 'FFmpegSplitChapters',
 657             'force_keyframes': opts.force_keyframes_at_cuts,
 658         }
 659     # XAttrMetadataPP should be run after post-processors that may change file contents
 660     if opts.xattrs:
 661         yield {'key': 'XAttrMetadata'}
 662     if opts.concat_playlist != 'never':
 663         yield {
 664             'key': 'FFmpegConcat',
 665             'only_multi_video': opts.concat_playlist != 'always',
 666             'when': 'playlist',
 667         }
 668     # Exec must be the last PP of each category
 669     for when, exec_cmd in opts.exec_cmd.items():
 670         yield {
 671             'key': 'Exec',
 672             'exec_cmd': exec_cmd,
 673             'when': when,
 674         }
 675
 676
 677 ParsedOptions = collections.namedtuple('ParsedOptions', ('parser', 'options', 'urls', 'ydl_opts'))
 678
 679
 680 def parse_options(argv=None):
 681     """@returns ParsedOptions(parser, opts, urls, ydl_opts)"""
 682     parser, opts, urls = parseOpts(argv)
 683     urls = get_urls(urls, opts.batchfile, opts.verbose)
 684
 685     set_compat_opts(opts)
 686     try:
 687         warnings, deprecation_warnings = validate_options(opts)
 688     except ValueError as err:
 689         parser.error(f'{err}\n')
 690
 691     postprocessors = list(get_postprocessors(opts))
 692
 693     print_only = bool(opts.forceprint) and all(k not in opts.forceprint for k in POSTPROCESS_WHEN[2:])
 694     any_getting = any(getattr(opts, k) for k in (
 695         'dumpjson', 'dump_single_json', 'getdescription', 'getduration', 'getfilename',
 696         'getformat', 'getid', 'getthumbnail', 'gettitle', 'geturl'
 697     ))
 698
 699     playlist_pps = [pp for pp in postprocessors if pp.get('when') == 'playlist']
 700     write_playlist_infojson = (opts.writeinfojson and not opts.clean_infojson
 701                                and opts.allow_playlist_files and opts.outtmpl.get('pl_infojson') != '')
 702     if not any((
 703         opts.extract_flat,
 704         opts.dump_single_json,
 705         opts.forceprint.get('playlist'),
 706         opts.print_to_file.get('playlist'),
 707         write_playlist_infojson,
 708     )):
 709         if not playlist_pps:
 710             opts.extract_flat = 'discard'
 711         elif playlist_pps == [{'key': 'FFmpegConcat', 'only_multi_video': True, 'when': 'playlist'}]:
 712             opts.extract_flat = 'discard_in_playlist'
 713
 714     final_ext = (
 715         opts.recodevideo if opts.recodevideo in FFmpegVideoConvertorPP.SUPPORTED_EXTS
 716         else opts.remuxvideo if opts.remuxvideo in FFmpegVideoRemuxerPP.SUPPORTED_EXTS
 717         else opts.audioformat if (opts.extractaudio and opts.audioformat in FFmpegExtractAudioPP.SUPPORTED_EXTS)
 718         else None)
 719
 720     return ParsedOptions(parser, opts, urls, {
 721         'usenetrc': opts.usenetrc,
 722         'netrc_location': opts.netrc_location,
 723         'username': opts.username,
 724         'password': opts.password,
 725         'twofactor': opts.twofactor,
 726         'videopassword': opts.videopassword,
 727         'ap_mso': opts.ap_mso,
 728         'ap_username': opts.ap_username,
 729         'ap_password': opts.ap_password,
 730         'client_certificate': opts.client_certificate,
 731         'client_certificate_key': opts.client_certificate_key,
 732         'client_certificate_password': opts.client_certificate_password,
 733         'quiet': opts.quiet or any_getting or opts.print_json or bool(opts.forceprint),
 734         'no_warnings': opts.no_warnings,
 735         'forceurl': opts.geturl,
 736         'forcetitle': opts.gettitle,
 737         'forceid': opts.getid,
 738         'forcethumbnail': opts.getthumbnail,
 739         'forcedescription': opts.getdescription,
 740         'forceduration': opts.getduration,
 741         'forcefilename': opts.getfilename,
 742         'forceformat': opts.getformat,
 743         'forceprint': opts.forceprint,
 744         'print_to_file': opts.print_to_file,
 745         'forcejson': opts.dumpjson or opts.print_json,
 746         'dump_single_json': opts.dump_single_json,
 747         'force_write_download_archive': opts.force_write_download_archive,
 748         'simulate': (print_only or any_getting or None) if opts.simulate is None else opts.simulate,
 749         'skip_download': opts.skip_download,
 750         'format': opts.format,
 751         'allow_unplayable_formats': opts.allow_unplayable_formats,
 752         'ignore_no_formats_error': opts.ignore_no_formats_error,
 753         'format_sort': opts.format_sort,
 754         'format_sort_force': opts.format_sort_force,
 755         'allow_multiple_video_streams': opts.allow_multiple_video_streams,
 756         'allow_multiple_audio_streams': opts.allow_multiple_audio_streams,
 757         'check_formats': opts.check_formats,
 758         'listformats': opts.listformats,
 759         'listformats_table': opts.listformats_table,
 760         'outtmpl': opts.outtmpl,
 761         'outtmpl_na_placeholder': opts.outtmpl_na_placeholder,
 762         'paths': opts.paths,
 763         'autonumber_size': opts.autonumber_size,
 764         'autonumber_start': opts.autonumber_start,
 765         'restrictfilenames': opts.restrictfilenames,
 766         'windowsfilenames': opts.windowsfilenames,
 767         'ignoreerrors': opts.ignoreerrors,
 768         'force_generic_extractor': opts.force_generic_extractor,
 769         'allowed_extractors': opts.allowed_extractors or ['default'],
 770         'ratelimit': opts.ratelimit,
 771         'throttledratelimit': opts.throttledratelimit,
 772         'overwrites': opts.overwrites,
 773         'retries': opts.retries,
 774         'file_access_retries': opts.file_access_retries,
 775         'fragment_retries': opts.fragment_retries,
 776         'extractor_retries': opts.extractor_retries,
 777         'retry_sleep_functions': opts.retry_sleep,
 778         'skip_unavailable_fragments': opts.skip_unavailable_fragments,
 779         'keep_fragments': opts.keep_fragments,
 780         'concurrent_fragment_downloads': opts.concurrent_fragment_downloads,
 781         'buffersize': opts.buffersize,
 782         'noresizebuffer': opts.noresizebuffer,
 783         'http_chunk_size': opts.http_chunk_size,
 784         'continuedl': opts.continue_dl,
 785         'noprogress': opts.quiet if opts.noprogress is None else opts.noprogress,
 786         'progress_with_newline': opts.progress_with_newline,
 787         'progress_template': opts.progress_template,
 788         'playliststart': opts.playliststart,
 789         'playlistend': opts.playlistend,
 790         'playlistreverse': opts.playlist_reverse,
 791         'playlistrandom': opts.playlist_random,
 792         'lazy_playlist': opts.lazy_playlist,
 793         'noplaylist': opts.noplaylist,
 794         'logtostderr': opts.outtmpl.get('default') == '-',
 795         'consoletitle': opts.consoletitle,
 796         'nopart': opts.nopart,
 797         'updatetime': opts.updatetime,
 798         'writedescription': opts.writedescription,
 799         'writeannotations': opts.writeannotations,
 800         'writeinfojson': opts.writeinfojson,
 801         'allow_playlist_files': opts.allow_playlist_files,
 802         'clean_infojson': opts.clean_infojson,
 803         'getcomments': opts.getcomments,
 804         'writethumbnail': opts.writethumbnail is True,
 805         'write_all_thumbnails': opts.writethumbnail == 'all',
 806         'writelink': opts.writelink,
 807         'writeurllink': opts.writeurllink,
 808         'writewebloclink': opts.writewebloclink,
 809         'writedesktoplink': opts.writedesktoplink,
 810         'writesubtitles': opts.writesubtitles,
 811         'writeautomaticsub': opts.writeautomaticsub,
 812         'allsubtitles': opts.allsubtitles,
 813         'listsubtitles': opts.listsubtitles,
 814         'subtitlesformat': opts.subtitlesformat,
 815         'subtitleslangs': opts.subtitleslangs,
 816         'matchtitle': decodeOption(opts.matchtitle),
 817         'rejecttitle': decodeOption(opts.rejecttitle),
 818         'max_downloads': opts.max_downloads,
 819         'prefer_free_formats': opts.prefer_free_formats,
 820         'trim_file_name': opts.trim_file_name,
 821         'verbose': opts.verbose,
 822         'dump_intermediate_pages': opts.dump_intermediate_pages,
 823         'write_pages': opts.write_pages,
 824         'load_pages': opts.load_pages,
 825         'test': opts.test,
 826         'keepvideo': opts.keepvideo,
 827         'min_filesize': opts.min_filesize,
 828         'max_filesize': opts.max_filesize,
 829         'min_views': opts.min_views,
 830         'max_views': opts.max_views,
 831         'daterange': opts.date,
 832         'cachedir': opts.cachedir,
 833         'youtube_print_sig_code': opts.youtube_print_sig_code,
 834         'age_limit': opts.age_limit,
 835         'download_archive': opts.download_archive,
 836         'break_on_existing': opts.break_on_existing,
 837         'break_on_reject': opts.break_on_reject,
 838         'break_per_url': opts.break_per_url,
 839         'skip_playlist_after_errors': opts.skip_playlist_after_errors,
 840         'cookiefile': opts.cookiefile,
 841         'cookiesfrombrowser': opts.cookiesfrombrowser,
 842         'legacyserverconnect': opts.legacy_server_connect,
 843         'nocheckcertificate': opts.no_check_certificate,
 844         'prefer_insecure': opts.prefer_insecure,
 845         'http_headers': opts.headers,
 846         'proxy': opts.proxy,
 847         'socket_timeout': opts.socket_timeout,
 848         'bidi_workaround': opts.bidi_workaround,
 849         'debug_printtraffic': opts.debug_printtraffic,
 850         'prefer_ffmpeg': opts.prefer_ffmpeg,
 851         'include_ads': opts.include_ads,
 852         'default_search': opts.default_search,
 853         'dynamic_mpd': opts.dynamic_mpd,
 854         'extractor_args': opts.extractor_args,
 855         'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
 856         'youtube_include_hls_manifest': opts.youtube_include_hls_manifest,
 857         'encoding': opts.encoding,
 858         'extract_flat': opts.extract_flat,
 859         'live_from_start': opts.live_from_start,
 860         'wait_for_video': opts.wait_for_video,
 861         'mark_watched': opts.mark_watched,
 862         'merge_output_format': opts.merge_output_format,
 863         'final_ext': final_ext,
 864         'postprocessors': postprocessors,
 865         'fixup': opts.fixup,
 866         'source_address': opts.source_address,
 867         'call_home': opts.call_home,
 868         'sleep_interval_requests': opts.sleep_interval_requests,
 869         'sleep_interval': opts.sleep_interval,
 870         'max_sleep_interval': opts.max_sleep_interval,
 871         'sleep_interval_subtitles': opts.sleep_interval_subtitles,
 872         'external_downloader': opts.external_downloader,
 873         'download_ranges': opts.download_ranges,
 874         'force_keyframes_at_cuts': opts.force_keyframes_at_cuts,
 875         'list_thumbnails': opts.list_thumbnails,
 876         'playlist_items': opts.playlist_items,
 877         'xattr_set_filesize': opts.xattr_set_filesize,
 878         'match_filter': opts.match_filter,
 879         'no_color': opts.no_color,
 880         'ffmpeg_location': opts.ffmpeg_location,
 881         'hls_prefer_native': opts.hls_prefer_native,
 882         'hls_use_mpegts': opts.hls_use_mpegts,
 883         'hls_split_discontinuity': opts.hls_split_discontinuity,
 884         'external_downloader_args': opts.external_downloader_args,
 885         'postprocessor_args': opts.postprocessor_args,
 886         'cn_verification_proxy': opts.cn_verification_proxy,
 887         'geo_verification_proxy': opts.geo_verification_proxy,
 888         'geo_bypass': opts.geo_bypass,
 889         'geo_bypass_country': opts.geo_bypass_country,
 890         'geo_bypass_ip_block': opts.geo_bypass_ip_block,
 891         '_warnings': warnings,
 892         '_deprecation_warnings': deprecation_warnings,
 893         'compat_opts': opts.compat_opts,
 894     })
 895
 896
 897 def _real_main(argv=None):
 898     setproctitle('yt-dlp')
 899
 900     parser, opts, all_urls, ydl_opts = parse_options(argv)
 901
 902     # Dump user agent
 903     if opts.dump_user_agent:
 904         ua = traverse_obj(opts.headers, 'User-Agent', casesense=False, default=std_headers['User-Agent'])
 905         write_string(f'{ua}\n', out=sys.stdout)
 906         return
 907
 908     if print_extractor_information(opts, all_urls):
 909         return
 910
 911     # We may need ffmpeg_location without having access to the YoutubeDL instance
 912     # See https://github.com/yt-dlp/yt-dlp/issues/2191
 913     if opts.ffmpeg_location:
 914         FFmpegPostProcessor._ffmpeg_location.set(opts.ffmpeg_location)
 915
 916     with YoutubeDL(ydl_opts) as ydl:
 917         pre_process = opts.update_self or opts.rm_cachedir
 918         actual_use = all_urls or opts.load_info_filename
 919
 920         if opts.rm_cachedir:
 921             ydl.cache.remove()
 922
 923         updater = Updater(ydl)
 924         if opts.update_self and updater.update() and actual_use:
 925             if updater.cmd:
 926                 return updater.restart()
 927             # This code is reachable only for zip variant in py < 3.10
 928             # It makes sense to exit here, but the old behavior is to continue
 929             ydl.report_warning('Restart yt-dlp to use the updated version')
 930             # return 100, 'ERROR: The program must exit for the update to complete'
 931
 932         if not actual_use:
 933             if pre_process:
 934                 return ydl._download_retcode
 935
 936             ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
 937             parser.error(
 938                 'You must provide at least one URL.\n'
 939                 'Type yt-dlp --help to see a list of all options.')
 940
 941         parser.destroy()
 942         try:
 943             if opts.load_info_filename is not None:
 944                 return ydl.download_with_info_file(expand_path(opts.load_info_filename))
 945             else:
 946                 return ydl.download(all_urls)
 947         except DownloadCancelled:
 948             ydl.to_screen('Aborting remaining downloads')
 949             return 101
 950
 951
 952 def main(argv=None):
 953     try:
 954         _exit(*variadic(_real_main(argv)))
 955     except DownloadError:
 956         _exit(1)
 957     except SameFileError as e:
 958         _exit(f'ERROR: {e}')
 959     except KeyboardInterrupt:
 960         _exit('\nERROR: Interrupted by user')
 961     except BrokenPipeError as e:
 962         # https://docs.python.org/3/library/signal.html#note-on-sigpipe
 963         devnull = os.open(os.devnull, os.O_WRONLY)
 964         os.dup2(devnull, sys.stdout.fileno())
 965         _exit(f'\nERROR: {e}')
 966     except optparse.OptParseError as e:
 967         _exit(2, f'\n{e}')
 968
 969
 970 from .extractor import gen_extractors, list_extractors
 971
 972 __all__ = [
 973     'main',
 974     'YoutubeDL',
 975     'parse_options',
 976     'gen_extractors',
 977     'list_extractors',
 978 ]