yt_dlp/options.py

   1 from __future__ import unicode_literals
   2
   3 import os.path
   4 import optparse
   5 import re
   6 import sys
   7
   8 from .downloader.external import list_external_downloaders
   9 from .compat import (
  10     compat_expanduser,
  11     compat_get_terminal_size,
  12     compat_getenv,
  13     compat_kwargs,
  14     compat_shlex_split,
  15 )
  16 from .utils import (
  17     expand_path,
  18     get_executable_path,
  19     OUTTMPL_TYPES,
  20     preferredencoding,
  21     REMUX_EXTENSIONS,
  22     write_string,
  23 )
  24 from .version import __version__
  25
  26
  27 def _hide_login_info(opts):
  28     PRIVATE_OPTS = set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
  29     eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$')
  30
  31     def _scrub_eq(o):
  32         m = eqre.match(o)
  33         if m:
  34             return m.group('key') + '=PRIVATE'
  35         else:
  36             return o
  37
  38     opts = list(map(_scrub_eq, opts))
  39     for idx, opt in enumerate(opts):
  40         if opt in PRIVATE_OPTS and idx + 1 < len(opts):
  41             opts[idx + 1] = 'PRIVATE'
  42     return opts
  43
  44
  45 def parseOpts(overrideArguments=None):
  46     def _readOptions(filename_bytes, default=[]):
  47         try:
  48             optionf = open(filename_bytes)
  49         except IOError:
  50             return default  # silently skip if file is not present
  51         try:
  52             # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
  53             contents = optionf.read()
  54             if sys.version_info < (3,):
  55                 contents = contents.decode(preferredencoding())
  56             res = compat_shlex_split(contents, comments=True)
  57         finally:
  58             optionf.close()
  59         return res
  60
  61     def _readUserConf(package_name, default=[]):
  62         # .config
  63         xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
  64         userConfFile = os.path.join(xdg_config_home, package_name, 'config')
  65         if not os.path.isfile(userConfFile):
  66             userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name)
  67         userConf = _readOptions(userConfFile, default=None)
  68         if userConf is not None:
  69             return userConf, userConfFile
  70
  71         # appdata
  72         appdata_dir = compat_getenv('appdata')
  73         if appdata_dir:
  74             userConfFile = os.path.join(appdata_dir, package_name, 'config')
  75             userConf = _readOptions(userConfFile, default=None)
  76             if userConf is None:
  77                 userConfFile += '.txt'
  78                 userConf = _readOptions(userConfFile, default=None)
  79         if userConf is not None:
  80             return userConf, userConfFile
  81
  82         # home
  83         userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
  84         userConf = _readOptions(userConfFile, default=None)
  85         if userConf is None:
  86             userConfFile += '.txt'
  87             userConf = _readOptions(userConfFile, default=None)
  88         if userConf is not None:
  89             return userConf, userConfFile
  90
  91         return default, None
  92
  93     def _format_option_string(option):
  94         ''' ('-o', '--option') -> -o, --format METAVAR'''
  95
  96         opts = []
  97
  98         if option._short_opts:
  99             opts.append(option._short_opts[0])
 100         if option._long_opts:
 101             opts.append(option._long_opts[0])
 102         if len(opts) > 1:
 103             opts.insert(1, ', ')
 104
 105         if option.takes_value():
 106             opts.append(' %s' % option.metavar)
 107
 108         return ''.join(opts)
 109
 110     def _comma_separated_values_options_callback(option, opt_str, value, parser, prepend=True):
 111         setattr(
 112             parser.values, option.dest,
 113             value.split(',') if not prepend
 114             else value.split(',') + getattr(parser.values, option.dest))
 115
 116     def _dict_from_multiple_values_options_callback(
 117             option, opt_str, value, parser,
 118             allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True):
 119
 120         out_dict = getattr(parser.values, option.dest)
 121         if multiple_keys:
 122             allowed_keys = r'(%s)(,(%s))*' % (allowed_keys, allowed_keys)
 123         mobj = re.match(r'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value)
 124         if mobj is not None:
 125             keys = [k.strip() for k in mobj.group('keys').lower().split(',')]
 126             val = mobj.group('val')
 127         elif default_key is not None:
 128             keys, val = [default_key], value
 129         else:
 130             raise optparse.OptionValueError(
 131                 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value))
 132         val = process(val) if callable(process) else val
 133         for key in keys:
 134             out_dict[key] = val
 135
 136     # No need to wrap help messages if we're on a wide console
 137     columns = compat_get_terminal_size().columns
 138     max_width = columns if columns else 80
 139     max_help_position = 80
 140
 141     fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
 142     fmt.format_option_strings = _format_option_string
 143
 144     kw = {
 145         'version': __version__,
 146         'formatter': fmt,
 147         'usage': '%prog [OPTIONS] URL [URL...]',
 148         'conflict_handler': 'resolve',
 149     }
 150
 151     parser = optparse.OptionParser(**compat_kwargs(kw))
 152
 153     general = optparse.OptionGroup(parser, 'General Options')
 154     general.add_option(
 155         '-h', '--help',
 156         action='help',
 157         help='Print this help text and exit')
 158     general.add_option(
 159         '--version',
 160         action='version',
 161         help='Print program version and exit')
 162     general.add_option(
 163         '-U', '--update',
 164         action='store_true', dest='update_self',
 165         help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
 166     general.add_option(
 167         '-i', '--ignore-errors', '--no-abort-on-error',
 168         action='store_true', dest='ignoreerrors', default=True,
 169         help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
 170     general.add_option(
 171         '--abort-on-error', '--no-ignore-errors',
 172         action='store_false', dest='ignoreerrors',
 173         help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
 174     general.add_option(
 175         '--dump-user-agent',
 176         action='store_true', dest='dump_user_agent', default=False,
 177         help='Display the current browser identification')
 178     general.add_option(
 179         '--list-extractors',
 180         action='store_true', dest='list_extractors', default=False,
 181         help='List all supported extractors')
 182     general.add_option(
 183         '--extractor-descriptions',
 184         action='store_true', dest='list_extractor_descriptions', default=False,
 185         help='Output descriptions of all supported extractors')
 186     general.add_option(
 187         '--force-generic-extractor',
 188         action='store_true', dest='force_generic_extractor', default=False,
 189         help='Force extraction to use the generic extractor')
 190     general.add_option(
 191         '--default-search',
 192         dest='default_search', metavar='PREFIX',
 193         help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching')
 194     general.add_option(
 195         '--ignore-config', '--no-config',
 196         action='store_true',
 197         help=(
 198             'Disable loading any configuration files except the one provided by --config-location. '
 199             'When given inside a configuration file, no further configuration files are loaded. '
 200             'Additionally, (for backward compatibility) if this option is found inside the '
 201             'system configuration file, the user configuration is not loaded'))
 202     general.add_option(
 203         '--config-location',
 204         dest='config_location', metavar='PATH',
 205         help='Location of the main configuration file; either the path to the config or its containing directory')
 206     general.add_option(
 207         '--flat-playlist',
 208         action='store_const', dest='extract_flat', const='in_playlist', default=False,
 209         help='Do not extract the videos of a playlist, only list them')
 210     general.add_option(
 211         '--flat-videos',
 212         action='store_true', dest='extract_flat',
 213         # help='Do not resolve the video urls')
 214         # doesn't work
 215         help=optparse.SUPPRESS_HELP)
 216     general.add_option(
 217         '--no-flat-playlist',
 218         action='store_false', dest='extract_flat',
 219         help='Extract the videos of a playlist')
 220     general.add_option(
 221         '--mark-watched',
 222         action='store_true', dest='mark_watched', default=False,
 223         help='Mark videos watched (YouTube only)')
 224     general.add_option(
 225         '--no-mark-watched',
 226         action='store_false', dest='mark_watched',
 227         help='Do not mark videos watched (default)')
 228     general.add_option(
 229         '--no-colors',
 230         action='store_true', dest='no_color', default=False,
 231         help='Do not emit color codes in output')
 232
 233     network = optparse.OptionGroup(parser, 'Network Options')
 234     network.add_option(
 235         '--proxy', dest='proxy',
 236         default=None, metavar='URL',
 237         help=(
 238             'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
 239             'SOCKS proxy, specify a proper scheme. For example '
 240             'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
 241             'for direct connection'))
 242     network.add_option(
 243         '--socket-timeout',
 244         dest='socket_timeout', type=float, default=None, metavar='SECONDS',
 245         help='Time to wait before giving up, in seconds')
 246     network.add_option(
 247         '--source-address',
 248         metavar='IP', dest='source_address', default=None,
 249         help='Client-side IP address to bind to',
 250     )
 251     network.add_option(
 252         '-4', '--force-ipv4',
 253         action='store_const', const='0.0.0.0', dest='source_address',
 254         help='Make all connections via IPv4',
 255     )
 256     network.add_option(
 257         '-6', '--force-ipv6',
 258         action='store_const', const='::', dest='source_address',
 259         help='Make all connections via IPv6',
 260     )
 261
 262     geo = optparse.OptionGroup(parser, 'Geo-restriction')
 263     geo.add_option(
 264         '--geo-verification-proxy',
 265         dest='geo_verification_proxy', default=None, metavar='URL',
 266         help=(
 267             'Use this proxy to verify the IP address for some geo-restricted sites. '
 268             'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
 269     geo.add_option(
 270         '--cn-verification-proxy',
 271         dest='cn_verification_proxy', default=None, metavar='URL',
 272         help=optparse.SUPPRESS_HELP)
 273     geo.add_option(
 274         '--geo-bypass',
 275         action='store_true', dest='geo_bypass', default=True,
 276         help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
 277     geo.add_option(
 278         '--no-geo-bypass',
 279         action='store_false', dest='geo_bypass', default=True,
 280         help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
 281     geo.add_option(
 282         '--geo-bypass-country', metavar='CODE',
 283         dest='geo_bypass_country', default=None,
 284         help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
 285     geo.add_option(
 286         '--geo-bypass-ip-block', metavar='IP_BLOCK',
 287         dest='geo_bypass_ip_block', default=None,
 288         help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
 289
 290     selection = optparse.OptionGroup(parser, 'Video Selection')
 291     selection.add_option(
 292         '--playlist-start',
 293         dest='playliststart', metavar='NUMBER', default=1, type=int,
 294         help='Playlist video to start at (default is %default)')
 295     selection.add_option(
 296         '--playlist-end',
 297         dest='playlistend', metavar='NUMBER', default=None, type=int,
 298         help='Playlist video to end at (default is last)')
 299     selection.add_option(
 300         '--playlist-items',
 301         dest='playlist_items', metavar='ITEM_SPEC', default=None,
 302         help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13')
 303     selection.add_option(
 304         '--match-title',
 305         dest='matchtitle', metavar='REGEX',
 306         help='Download only matching titles (regex or caseless sub-string)')
 307     selection.add_option(
 308         '--reject-title',
 309         dest='rejecttitle', metavar='REGEX',
 310         help='Skip download for matching titles (regex or caseless sub-string)')
 311     selection.add_option(
 312         '--max-downloads',
 313         dest='max_downloads', metavar='NUMBER', type=int, default=None,
 314         help='Abort after downloading NUMBER files')
 315     selection.add_option(
 316         '--min-filesize',
 317         metavar='SIZE', dest='min_filesize', default=None,
 318         help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
 319     selection.add_option(
 320         '--max-filesize',
 321         metavar='SIZE', dest='max_filesize', default=None,
 322         help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
 323     selection.add_option(
 324         '--date',
 325         metavar='DATE', dest='date', default=None,
 326         help=(
 327             'Download only videos uploaded in this date. '
 328             'The date can be "YYYYMMDD" or in the format '
 329             '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
 330     selection.add_option(
 331         '--datebefore',
 332         metavar='DATE', dest='datebefore', default=None,
 333         help=(
 334             'Download only videos uploaded on or before this date. '
 335             'The date formats accepted is the same as --date'))
 336     selection.add_option(
 337         '--dateafter',
 338         metavar='DATE', dest='dateafter', default=None,
 339         help=(
 340             'Download only videos uploaded on or after this date. '
 341             'The date formats accepted is the same as --date'))
 342     selection.add_option(
 343         '--min-views',
 344         metavar='COUNT', dest='min_views', default=None, type=int,
 345         help='Do not download any videos with less than COUNT views')
 346     selection.add_option(
 347         '--max-views',
 348         metavar='COUNT', dest='max_views', default=None, type=int,
 349         help='Do not download any videos with more than COUNT views')
 350     selection.add_option(
 351         '--match-filter',
 352         metavar='FILTER', dest='match_filter', default=None,
 353         help=(
 354             'Generic video filter. '
 355             'Specify any key (see "OUTPUT TEMPLATE" for a list of available keys) to '
 356             'match if the key is present, '
 357             '!key to check if the key is not present, '
 358             'key>NUMBER (like "view_count > 12", also works with '
 359             '>=, <, <=, !=, =) to compare against a number, '
 360             'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
 361             'to match against a string literal '
 362             'and & to require multiple matches. '
 363             'Values which are not known are excluded unless you '
 364             'put a question mark (?) after the operator. '
 365             'For example, to only match videos that have been liked more than '
 366             '100 times and disliked less than 50 times (or the dislike '
 367             'functionality is not available at the given service), but who '
 368             'also have a description, use --match-filter '
 369             '"like_count > 100 & dislike_count <? 50 & description"'))
 370     selection.add_option(
 371         '--no-match-filter',
 372         metavar='FILTER', dest='match_filter', action='store_const', const=None,
 373         help='Do not use generic video filter (default)')
 374     selection.add_option(
 375         '--no-playlist',
 376         action='store_true', dest='noplaylist', default=False,
 377         help='Download only the video, if the URL refers to a video and a playlist')
 378     selection.add_option(
 379         '--yes-playlist',
 380         action='store_false', dest='noplaylist',
 381         help='Download the playlist, if the URL refers to a video and a playlist')
 382     selection.add_option(
 383         '--age-limit',
 384         metavar='YEARS', dest='age_limit', default=None, type=int,
 385         help='Download only videos suitable for the given age')
 386     selection.add_option(
 387         '--download-archive', metavar='FILE',
 388         dest='download_archive',
 389         help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
 390     selection.add_option(
 391         '--break-on-existing',
 392         action='store_true', dest='break_on_existing', default=False,
 393         help='Stop the download process when encountering a file that is in the archive')
 394     selection.add_option(
 395         '--break-on-reject',
 396         action='store_true', dest='break_on_reject', default=False,
 397         help='Stop the download process when encountering a file that has been filtered out')
 398     selection.add_option(
 399         '--no-download-archive',
 400         dest='download_archive', action="store_const", const=None,
 401         help='Do not use archive file (default)')
 402     selection.add_option(
 403         '--include-ads',
 404         dest='include_ads', action='store_true',
 405         help=optparse.SUPPRESS_HELP)
 406     selection.add_option(
 407         '--no-include-ads',
 408         dest='include_ads', action='store_false',
 409         help=optparse.SUPPRESS_HELP)
 410
 411     authentication = optparse.OptionGroup(parser, 'Authentication Options')
 412     authentication.add_option(
 413         '-u', '--username',
 414         dest='username', metavar='USERNAME',
 415         help='Login with this account ID')
 416     authentication.add_option(
 417         '-p', '--password',
 418         dest='password', metavar='PASSWORD',
 419         help='Account password. If this option is left out, yt-dlp will ask interactively')
 420     authentication.add_option(
 421         '-2', '--twofactor',
 422         dest='twofactor', metavar='TWOFACTOR',
 423         help='Two-factor authentication code')
 424     authentication.add_option(
 425         '-n', '--netrc',
 426         action='store_true', dest='usenetrc', default=False,
 427         help='Use .netrc authentication data')
 428     authentication.add_option(
 429         '--video-password',
 430         dest='videopassword', metavar='PASSWORD',
 431         help='Video password (vimeo, youku)')
 432     authentication.add_option(
 433         '--ap-mso',
 434         dest='ap_mso', metavar='MSO',
 435         help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
 436     authentication.add_option(
 437         '--ap-username',
 438         dest='ap_username', metavar='USERNAME',
 439         help='Multiple-system operator account login')
 440     authentication.add_option(
 441         '--ap-password',
 442         dest='ap_password', metavar='PASSWORD',
 443         help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
 444     authentication.add_option(
 445         '--ap-list-mso',
 446         action='store_true', dest='ap_list_mso', default=False,
 447         help='List all supported multiple-system operators')
 448
 449     video_format = optparse.OptionGroup(parser, 'Video Format Options')
 450     video_format.add_option(
 451         '-f', '--format',
 452         action='store', dest='format', metavar='FORMAT', default=None,
 453         help='Video format code, see "FORMAT SELECTION" for more details')
 454     video_format.add_option(
 455         '-S', '--format-sort', metavar='SORTORDER',
 456         dest='format_sort', default=[],
 457         action='callback', callback=_comma_separated_values_options_callback, type='str',
 458         help='Sort the formats by the fields given, see "Sorting Formats" for more details')
 459     video_format.add_option(
 460         '--format-sort-force', '--S-force',
 461         action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
 462         help=(
 463             'Force user specified sort order to have precedence over all fields, '
 464             'see "Sorting Formats" for more details'))
 465     video_format.add_option(
 466         '--no-format-sort-force',
 467         action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
 468         help=(
 469             'Some fields have precedence over the user specified sort order (default), '
 470             'see "Sorting Formats" for more details'))
 471     video_format.add_option(
 472         '--video-multistreams',
 473         action='store_true', dest='allow_multiple_video_streams', default=False,
 474         help='Allow multiple video streams to be merged into a single file')
 475     video_format.add_option(
 476         '--no-video-multistreams',
 477         action='store_false', dest='allow_multiple_video_streams',
 478         help='Only one video stream is downloaded for each output file (default)')
 479     video_format.add_option(
 480         '--audio-multistreams',
 481         action='store_true', dest='allow_multiple_audio_streams', default=False,
 482         help='Allow multiple audio streams to be merged into a single file')
 483     video_format.add_option(
 484         '--no-audio-multistreams',
 485         action='store_false', dest='allow_multiple_audio_streams',
 486         help='Only one audio stream is downloaded for each output file (default)')
 487     video_format.add_option(
 488         '--all-formats',
 489         action='store_const', dest='format', const='all',
 490         help=optparse.SUPPRESS_HELP)
 491     video_format.add_option(
 492         '--prefer-free-formats',
 493         action='store_true', dest='prefer_free_formats', default=False,
 494         help=(
 495             'Prefer video formats with free containers over non-free ones of same quality. '
 496             'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
 497     video_format.add_option(
 498         '--no-prefer-free-formats',
 499         action='store_true', dest='prefer_free_formats', default=False,
 500         help="Don't give any special preference to free containers (default)")
 501     video_format.add_option(
 502         '-F', '--list-formats',
 503         action='store_true', dest='listformats',
 504         help='List all available formats of requested videos')
 505     video_format.add_option(
 506         '--list-formats-as-table',
 507         action='store_true', dest='listformats_table', default=True,
 508         help='Present the output of -F in tabular form (default)')
 509     video_format.add_option(
 510         '--list-formats-old', '--no-list-formats-as-table',
 511         action='store_false', dest='listformats_table',
 512         help='Present the output of -F in the old form (Alias: --no-list-formats-as-table)')
 513     video_format.add_option(
 514         '--merge-output-format',
 515         action='store', dest='merge_output_format', metavar='FORMAT', default=None,
 516         help=(
 517             'If a merge is required (e.g. bestvideo+bestaudio), '
 518             'output to given container format. One of mkv, mp4, ogg, webm, flv. '
 519             'Ignored if no merge is required'))
 520     video_format.add_option(
 521         '--allow-unplayable-formats',
 522         action='store_true', dest='allow_unplayable_formats', default=False,
 523         help=(
 524             'Allow unplayable formats to be listed and downloaded. '
 525             'All video postprocessing will also be turned off'))
 526     video_format.add_option(
 527         '--no-allow-unplayable-formats',
 528         action='store_false', dest='allow_unplayable_formats',
 529         help='Do not allow unplayable formats to be listed or downloaded (default)')
 530
 531     subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
 532     subtitles.add_option(
 533         '--write-subs', '--write-srt',
 534         action='store_true', dest='writesubtitles', default=False,
 535         help='Write subtitle file')
 536     subtitles.add_option(
 537         '--no-write-subs', '--no-write-srt',
 538         action='store_false', dest='writesubtitles',
 539         help='Do not write subtitle file (default)')
 540     subtitles.add_option(
 541         '--write-auto-subs', '--write-automatic-subs',
 542         action='store_true', dest='writeautomaticsub', default=False,
 543         help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
 544     subtitles.add_option(
 545         '--no-write-auto-subs', '--no-write-automatic-subs',
 546         action='store_false', dest='writeautomaticsub', default=False,
 547         help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
 548     subtitles.add_option(
 549         '--all-subs',
 550         action='store_true', dest='allsubtitles', default=False,
 551         help=optparse.SUPPRESS_HELP)
 552     subtitles.add_option(
 553         '--list-subs',
 554         action='store_true', dest='listsubtitles', default=False,
 555         help='List all available subtitles for the video')
 556     subtitles.add_option(
 557         '--sub-format',
 558         action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
 559         help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
 560     subtitles.add_option(
 561         '--sub-langs', '--srt-langs',
 562         action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
 563         default=[], callback=_comma_separated_values_options_callback,
 564         help=(
 565             'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) '
 566             'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
 567             'Use --list-subs for a list of available language tags'))
 568
 569     downloader = optparse.OptionGroup(parser, 'Download Options')
 570     downloader.add_option(
 571         '-N', '--concurrent-fragments',
 572         dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
 573         help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
 574     downloader.add_option(
 575         '-r', '--limit-rate', '--rate-limit',
 576         dest='ratelimit', metavar='RATE',
 577         help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
 578     downloader.add_option(
 579         '-R', '--retries',
 580         dest='retries', metavar='RETRIES', default=10,
 581         help='Number of retries (default is %default), or "infinite"')
 582     downloader.add_option(
 583         '--fragment-retries',
 584         dest='fragment_retries', metavar='RETRIES', default=10,
 585         help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
 586     downloader.add_option(
 587         '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
 588         action='store_true', dest='skip_unavailable_fragments', default=True,
 589         help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
 590     downloader.add_option(
 591         '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
 592         action='store_false', dest='skip_unavailable_fragments',
 593         help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
 594     downloader.add_option(
 595         '--keep-fragments',
 596         action='store_true', dest='keep_fragments', default=False,
 597         help='Keep downloaded fragments on disk after downloading is finished')
 598     downloader.add_option(
 599         '--no-keep-fragments',
 600         action='store_false', dest='keep_fragments',
 601         help='Delete downloaded fragments after downloading is finished (default)')
 602     downloader.add_option(
 603         '--buffer-size',
 604         dest='buffersize', metavar='SIZE', default='1024',
 605         help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
 606     downloader.add_option(
 607         '--resize-buffer',
 608         action='store_false', dest='noresizebuffer',
 609         help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
 610     downloader.add_option(
 611         '--no-resize-buffer',
 612         action='store_true', dest='noresizebuffer', default=False,
 613         help='Do not automatically adjust the buffer size')
 614     downloader.add_option(
 615         '--http-chunk-size',
 616         dest='http_chunk_size', metavar='SIZE', default=None,
 617         help=(
 618             'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
 619             'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
 620     downloader.add_option(
 621         '--test',
 622         action='store_true', dest='test', default=False,
 623         help=optparse.SUPPRESS_HELP)
 624     downloader.add_option(
 625         '--playlist-reverse',
 626         action='store_true',
 627         help='Download playlist videos in reverse order')
 628     downloader.add_option(
 629         '--no-playlist-reverse',
 630         action='store_false', dest='playlist_reverse',
 631         help='Download playlist videos in default order (default)')
 632     downloader.add_option(
 633         '--playlist-random',
 634         action='store_true',
 635         help='Download playlist videos in random order')
 636     downloader.add_option(
 637         '--xattr-set-filesize',
 638         dest='xattr_set_filesize', action='store_true',
 639         help='Set file xattribute ytdl.filesize with expected file size')
 640     downloader.add_option(
 641         '--hls-prefer-native',
 642         dest='hls_prefer_native', action='store_true', default=None,
 643         help=optparse.SUPPRESS_HELP)
 644     downloader.add_option(
 645         '--hls-prefer-ffmpeg',
 646         dest='hls_prefer_native', action='store_false', default=None,
 647         help=optparse.SUPPRESS_HELP)
 648     downloader.add_option(
 649         '--hls-use-mpegts',
 650         dest='hls_use_mpegts', action='store_true', default=None,
 651         help=(
 652             'Use the mpegts container for HLS videos; '
 653             'allowing some players to play the video while downloading, '
 654             'and reducing the chance of file corruption if download is interrupted. '
 655             'This is enabled by default for live streams'))
 656     downloader.add_option(
 657         '--no-hls-use-mpegts',
 658         dest='hls_use_mpegts', action='store_false',
 659         help=(
 660             'Do not use the mpegts container for HLS videos. '
 661             'This is default when not downloading live streams'))
 662     downloader.add_option(
 663         '--downloader', '--external-downloader',
 664         dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
 665         action='callback', callback=_dict_from_multiple_values_options_callback,
 666         callback_kwargs={
 667             'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
 668             'default_key': 'default', 'process': lambda x: x.strip()},
 669         help=(
 670             'Name or path of the external downloader to use (optionally) prefixed by '
 671             'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
 672             'Currently supports native, %s (Recommended: aria2c). '
 673             'You can use this option multiple times to set different downloaders for different protocols. '
 674             'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
 675             'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
 676             '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
 677     downloader.add_option(
 678         '--downloader-args', '--external-downloader-args',
 679         metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
 680         action='callback', callback=_dict_from_multiple_values_options_callback,
 681         callback_kwargs={
 682             'allowed_keys': '|'.join(list_external_downloaders()),
 683             'default_key': 'default', 'process': compat_shlex_split},
 684         help=(
 685             'Give these arguments to the external downloader. '
 686             'Specify the downloader name and the arguments separated by a colon ":". '
 687             'You can use this option multiple times (Alias: --external-downloader-args)'))
 688
 689     workarounds = optparse.OptionGroup(parser, 'Workarounds')
 690     workarounds.add_option(
 691         '--encoding',
 692         dest='encoding', metavar='ENCODING',
 693         help='Force the specified encoding (experimental)')
 694     workarounds.add_option(
 695         '--no-check-certificate',
 696         action='store_true', dest='no_check_certificate', default=False,
 697         help='Suppress HTTPS certificate validation')
 698     workarounds.add_option(
 699         '--prefer-insecure', '--prefer-unsecure',
 700         action='store_true', dest='prefer_insecure',
 701         help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
 702     workarounds.add_option(
 703         '--user-agent',
 704         metavar='UA', dest='user_agent',
 705         help='Specify a custom user agent')
 706     workarounds.add_option(
 707         '--referer',
 708         metavar='URL', dest='referer', default=None,
 709         help='Specify a custom referer, use if the video access is restricted to one domain',
 710     )
 711     workarounds.add_option(
 712         '--add-header',
 713         metavar='FIELD:VALUE', dest='headers', default={}, type='str',
 714         action='callback', callback=_dict_from_multiple_values_options_callback,
 715         callback_kwargs={'multiple_keys': False},
 716         help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
 717     )
 718     workarounds.add_option(
 719         '--bidi-workaround',
 720         dest='bidi_workaround', action='store_true',
 721         help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
 722     workarounds.add_option(
 723         '--sleep-requests', metavar='SECONDS',
 724         dest='sleep_interval_requests', type=float,
 725         help='Number of seconds to sleep between requests during data extraction')
 726     workarounds.add_option(
 727         '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
 728         dest='sleep_interval', type=float,
 729         help=(
 730             'Number of seconds to sleep before each download. '
 731             'This is the minimum time to sleep when used along with --max-sleep-interval '
 732             '(Alias: --min-sleep-interval)'))
 733     workarounds.add_option(
 734         '--max-sleep-interval', metavar='SECONDS',
 735         dest='max_sleep_interval', type=float,
 736         help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
 737     workarounds.add_option(
 738         '--sleep-subtitles', metavar='SECONDS',
 739         dest='sleep_interval_subtitles', default=0, type=int,
 740         help='Number of seconds to sleep before each subtitle download')
 741
 742     verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
 743     verbosity.add_option(
 744         '-q', '--quiet',
 745         action='store_true', dest='quiet', default=False,
 746         help='Activate quiet mode')
 747     verbosity.add_option(
 748         '--no-warnings',
 749         dest='no_warnings', action='store_true', default=False,
 750         help='Ignore warnings')
 751     verbosity.add_option(
 752         '-s', '--simulate',
 753         action='store_true', dest='simulate', default=False,
 754         help='Do not download the video and do not write anything to disk')
 755     verbosity.add_option(
 756         '--ignore-no-formats-error',
 757         action='store_true', dest='ignore_no_formats_error', default=False,
 758         help=(
 759             'Ignore "No video formats" error. Usefull for extracting metadata '
 760             'even if the video is not actually available for download (experimental)'))
 761     verbosity.add_option(
 762         '--no-ignore-no-formats-error',
 763         action='store_false', dest='ignore_no_formats_error',
 764         help='Throw error when no downloadable video formats are found (default)')
 765     verbosity.add_option(
 766         '--skip-download', '--no-download',
 767         action='store_true', dest='skip_download', default=False,
 768         help='Do not download the video but write all related files (Alias: --no-download)')
 769     verbosity.add_option(
 770         '-g', '--get-url',
 771         action='store_true', dest='geturl', default=False,
 772         help='Simulate, quiet but print URL')
 773     verbosity.add_option(
 774         '-e', '--get-title',
 775         action='store_true', dest='gettitle', default=False,
 776         help='Simulate, quiet but print title')
 777     verbosity.add_option(
 778         '--get-id',
 779         action='store_true', dest='getid', default=False,
 780         help='Simulate, quiet but print id')
 781     verbosity.add_option(
 782         '--get-thumbnail',
 783         action='store_true', dest='getthumbnail', default=False,
 784         help='Simulate, quiet but print thumbnail URL')
 785     verbosity.add_option(
 786         '--get-description',
 787         action='store_true', dest='getdescription', default=False,
 788         help='Simulate, quiet but print video description')
 789     verbosity.add_option(
 790         '--get-duration',
 791         action='store_true', dest='getduration', default=False,
 792         help='Simulate, quiet but print video length')
 793     verbosity.add_option(
 794         '--get-filename',
 795         action='store_true', dest='getfilename', default=False,
 796         help='Simulate, quiet but print output filename')
 797     verbosity.add_option(
 798         '--get-format',
 799         action='store_true', dest='getformat', default=False,
 800         help='Simulate, quiet but print output format')
 801     verbosity.add_option(
 802         '-j', '--dump-json',
 803         action='store_true', dest='dumpjson', default=False,
 804         help='Simulate, quiet but print JSON information. See "OUTPUT TEMPLATE" for a description of available keys')
 805     verbosity.add_option(
 806         '-J', '--dump-single-json',
 807         action='store_true', dest='dump_single_json', default=False,
 808         help=(
 809             'Simulate, quiet but print JSON information for each command-line argument. '
 810             'If the URL refers to a playlist, dump the whole playlist information in a single line'))
 811     verbosity.add_option(
 812         '--print-json',
 813         action='store_true', dest='print_json', default=False,
 814         help='Be quiet and print the video information as JSON (video is still being downloaded)')
 815     verbosity.add_option(
 816         '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
 817         action='store_true', dest='force_write_download_archive', default=False,
 818         help=(
 819             'Force download archive entries to be written as far as no errors occur,'
 820             'even if -s or another simulation switch is used (Alias: --force-download-archive)'))
 821     verbosity.add_option(
 822         '--newline',
 823         action='store_true', dest='progress_with_newline', default=False,
 824         help='Output progress bar as new lines')
 825     verbosity.add_option(
 826         '--no-progress',
 827         action='store_true', dest='noprogress', default=False,
 828         help='Do not print progress bar')
 829     verbosity.add_option(
 830         '--console-title',
 831         action='store_true', dest='consoletitle', default=False,
 832         help='Display progress in console titlebar')
 833     verbosity.add_option(
 834         '-v', '--verbose',
 835         action='store_true', dest='verbose', default=False,
 836         help='Print various debugging information')
 837     verbosity.add_option(
 838         '--dump-pages', '--dump-intermediate-pages',
 839         action='store_true', dest='dump_intermediate_pages', default=False,
 840         help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
 841     verbosity.add_option(
 842         '--write-pages',
 843         action='store_true', dest='write_pages', default=False,
 844         help='Write downloaded intermediary pages to files in the current directory to debug problems')
 845     verbosity.add_option(
 846         '--youtube-print-sig-code',
 847         action='store_true', dest='youtube_print_sig_code', default=False,
 848         help=optparse.SUPPRESS_HELP)
 849     verbosity.add_option(
 850         '--print-traffic', '--dump-headers',
 851         dest='debug_printtraffic', action='store_true', default=False,
 852         help='Display sent and read HTTP traffic')
 853     verbosity.add_option(
 854         '-C', '--call-home',
 855         dest='call_home', action='store_true', default=False,
 856         # help='[Broken] Contact the yt-dlp server for debugging')
 857         help=optparse.SUPPRESS_HELP)
 858     verbosity.add_option(
 859         '--no-call-home',
 860         dest='call_home', action='store_false',
 861         # help='Do not contact the yt-dlp server for debugging (default)')
 862         help=optparse.SUPPRESS_HELP)
 863
 864     filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
 865     filesystem.add_option(
 866         '-a', '--batch-file',
 867         dest='batchfile', metavar='FILE',
 868         help="File containing URLs to download ('-' for stdin), one URL per line. "
 869              "Lines starting with '#', ';' or ']' are considered as comments and ignored")
 870     filesystem.add_option(
 871         '--id', default=False,
 872         action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
 873     filesystem.add_option(
 874         '-P', '--paths',
 875         metavar='TYPES:PATH', dest='paths', default={}, type='str',
 876         action='callback', callback=_dict_from_multiple_values_options_callback,
 877         callback_kwargs={
 878             'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES.keys()),
 879             'process': lambda x: x.strip()},
 880         help=(
 881             'The paths where the files should be downloaded. '
 882             'Specify the type of file and the path separated by a colon ":". '
 883             'All the same types as --output are supported. '
 884             'Additionally, you can also provide "home" and "temp" paths. '
 885             'All intermediary files are first downloaded to the temp path and '
 886             'then the final files are moved over to the home path after download is finished. '
 887             'This option is ignored if --output is an absolute path'))
 888     filesystem.add_option(
 889         '-o', '--output',
 890         metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
 891         action='callback', callback=_dict_from_multiple_values_options_callback,
 892         callback_kwargs={
 893             'allowed_keys': '|'.join(OUTTMPL_TYPES.keys()),
 894             'default_key': 'default', 'process': lambda x: x.strip()},
 895         help='Output filename template; see "OUTPUT TEMPLATE" for details')
 896     filesystem.add_option(
 897         '--output-na-placeholder',
 898         dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
 899         help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
 900     filesystem.add_option(
 901         '--autonumber-size',
 902         dest='autonumber_size', metavar='NUMBER', type=int,
 903         help=optparse.SUPPRESS_HELP)
 904     filesystem.add_option(
 905         '--autonumber-start',
 906         dest='autonumber_start', metavar='NUMBER', default=1, type=int,
 907         help='Specify the start value for %(autonumber)s (default is %default)')
 908     filesystem.add_option(
 909         '--restrict-filenames',
 910         action='store_true', dest='restrictfilenames', default=False,
 911         help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
 912     filesystem.add_option(
 913         '--no-restrict-filenames',
 914         action='store_false', dest='restrictfilenames',
 915         help='Allow Unicode characters, "&" and spaces in filenames (default)')
 916     filesystem.add_option(
 917         '--windows-filenames',
 918         action='store_true', dest='windowsfilenames', default=False,
 919         help='Force filenames to be windows compatible')
 920     filesystem.add_option(
 921         '--no-windows-filenames',
 922         action='store_false', dest='windowsfilenames',
 923         help='Make filenames windows compatible only if using windows (default)')
 924     filesystem.add_option(
 925         '--trim-filenames', '--trim-file-names', metavar='LENGTH',
 926         dest='trim_file_name', default=0, type=int,
 927         help='Limit the filename length (excluding extension) to the specified number of characters')
 928     filesystem.add_option(
 929         '-A', '--auto-number',
 930         action='store_true', dest='autonumber', default=False,
 931         help=optparse.SUPPRESS_HELP)
 932     filesystem.add_option(
 933         '-t', '--title',
 934         action='store_true', dest='usetitle', default=False,
 935         help=optparse.SUPPRESS_HELP)
 936     filesystem.add_option(
 937         '-l', '--literal', default=False,
 938         action='store_true', dest='usetitle',
 939         help=optparse.SUPPRESS_HELP)
 940     filesystem.add_option(
 941         '-w', '--no-overwrites',
 942         action='store_false', dest='overwrites', default=None,
 943         help='Do not overwrite any files')
 944     filesystem.add_option(
 945         '--force-overwrites', '--yes-overwrites',
 946         action='store_true', dest='overwrites',
 947         help='Overwrite all video and metadata files. This option includes --no-continue')
 948     filesystem.add_option(
 949         '--no-force-overwrites',
 950         action='store_const', dest='overwrites', const=None,
 951         help='Do not overwrite the video, but overwrite related files (default)')
 952     filesystem.add_option(
 953         '-c', '--continue',
 954         action='store_true', dest='continue_dl', default=True,
 955         help='Resume partially downloaded files/fragments (default)')
 956     filesystem.add_option(
 957         '--no-continue',
 958         action='store_false', dest='continue_dl',
 959         help=(
 960             'Do not resume partially downloaded fragments. '
 961             'If the file is unfragmented, restart download of the entire file'))
 962     filesystem.add_option(
 963         '--part',
 964         action='store_false', dest='nopart', default=False,
 965         help='Use .part files instead of writing directly into output file (default)')
 966     filesystem.add_option(
 967         '--no-part',
 968         action='store_true', dest='nopart',
 969         help='Do not use .part files - write directly into output file')
 970     filesystem.add_option(
 971         '--mtime',
 972         action='store_true', dest='updatetime', default=True,
 973         help='Use the Last-modified header to set the file modification time (default)')
 974     filesystem.add_option(
 975         '--no-mtime',
 976         action='store_false', dest='updatetime',
 977         help='Do not use the Last-modified header to set the file modification time')
 978     filesystem.add_option(
 979         '--write-description',
 980         action='store_true', dest='writedescription', default=False,
 981         help='Write video description to a .description file')
 982     filesystem.add_option(
 983         '--no-write-description',
 984         action='store_false', dest='writedescription',
 985         help='Do not write video description (default)')
 986     filesystem.add_option(
 987         '--write-info-json',
 988         action='store_true', dest='writeinfojson', default=False,
 989         help='Write video metadata to a .info.json file (this may contain personal information)')
 990     filesystem.add_option(
 991         '--no-write-info-json',
 992         action='store_false', dest='writeinfojson',
 993         help='Do not write video metadata (default)')
 994     filesystem.add_option(
 995         '--write-annotations',
 996         action='store_true', dest='writeannotations', default=False,
 997         help='Write video annotations to a .annotations.xml file')
 998     filesystem.add_option(
 999         '--no-write-annotations',
1000         action='store_false', dest='writeannotations',
1001         help='Do not write video annotations (default)')
1002     filesystem.add_option(
1003         '--write-playlist-metafiles',
1004         action='store_true', dest='allow_playlist_files', default=True,
1005         help=(
1006             'Write playlist metadata in addition to the video metadata '
1007             'when using --write-info-json, --write-description etc. (default)'))
1008     filesystem.add_option(
1009         '--no-write-playlist-metafiles',
1010         action='store_false', dest='allow_playlist_files',
1011         help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1012     filesystem.add_option(
1013         '--clean-infojson',
1014         action='store_true', dest='clean_infojson', default=True,
1015         help=(
1016             'Remove some private fields such as filenames from the infojson. '
1017             'Note that it could still contain some personal information (default)'))
1018     filesystem.add_option(
1019         '--no-clean-infojson',
1020         action='store_false', dest='clean_infojson',
1021         help='Write all fields to the infojson')
1022     filesystem.add_option(
1023         '--get-comments',
1024         action='store_true', dest='getcomments', default=False,
1025         help=(
1026             'Retrieve video comments to be placed in the .info.json file. '
1027             'The comments are fetched even without this option if the extraction is known to be quick'))
1028     filesystem.add_option(
1029         '--load-info-json', '--load-info',
1030         dest='load_info_filename', metavar='FILE',
1031         help='JSON file containing the video information (created with the "--write-info-json" option)')
1032     filesystem.add_option(
1033         '--cookies',
1034         dest='cookiefile', metavar='FILE',
1035         help='File to read cookies from and dump cookie jar in')
1036     filesystem.add_option(
1037         '--no-cookies',
1038         action='store_const', const=None, dest='cookiefile', metavar='FILE',
1039         help='Do not read/dump cookies (default)')
1040     filesystem.add_option(
1041         '--cache-dir', dest='cachedir', default=None, metavar='DIR',
1042         help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change')
1043     filesystem.add_option(
1044         '--no-cache-dir', action='store_false', dest='cachedir',
1045         help='Disable filesystem caching')
1046     filesystem.add_option(
1047         '--rm-cache-dir',
1048         action='store_true', dest='rm_cachedir',
1049         help='Delete all filesystem cache files')
1050
1051     thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options')
1052     thumbnail.add_option(
1053         '--write-thumbnail',
1054         action='store_true', dest='writethumbnail', default=False,
1055         help='Write thumbnail image to disk')
1056     thumbnail.add_option(
1057         '--no-write-thumbnail',
1058         action='store_false', dest='writethumbnail',
1059         help='Do not write thumbnail image to disk (default)')
1060     thumbnail.add_option(
1061         '--write-all-thumbnails',
1062         action='store_true', dest='write_all_thumbnails', default=False,
1063         help='Write all thumbnail image formats to disk')
1064     thumbnail.add_option(
1065         '--list-thumbnails',
1066         action='store_true', dest='list_thumbnails', default=False,
1067         help='Simulate and list all available thumbnail formats')
1068
1069     link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
1070     link.add_option(
1071         '--write-link',
1072         action='store_true', dest='writelink', default=False,
1073         help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1074     link.add_option(
1075         '--write-url-link',
1076         action='store_true', dest='writeurllink', default=False,
1077         help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1078     link.add_option(
1079         '--write-webloc-link',
1080         action='store_true', dest='writewebloclink', default=False,
1081         help='Write a .webloc macOS internet shortcut')
1082     link.add_option(
1083         '--write-desktop-link',
1084         action='store_true', dest='writedesktoplink', default=False,
1085         help='Write a .desktop Linux internet shortcut')
1086
1087     postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
1088     postproc.add_option(
1089         '-x', '--extract-audio',
1090         action='store_true', dest='extractaudio', default=False,
1091         help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1092     postproc.add_option(
1093         '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
1094         help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
1095     postproc.add_option(
1096         '--audio-quality', metavar='QUALITY',
1097         dest='audioquality', default='5',
1098         help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1099     postproc.add_option(
1100         '--remux-video',
1101         metavar='FORMAT', dest='remuxvideo', default=None,
1102         help=(
1103             'Remux the video into another container if necessary (currently supported: %s). '
1104             'If target container does not support the video/audio codec, remuxing will fail. '
1105             'You can specify multiple rules; eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1106             'and anything else to mkv.' % '|'.join(REMUX_EXTENSIONS)))
1107     postproc.add_option(
1108         '--recode-video',
1109         metavar='FORMAT', dest='recodevideo', default=None,
1110         help=(
1111             'Re-encode the video into another format if re-encoding is necessary. '
1112             'The supported formats are the same as --remux-video'))
1113     postproc.add_option(
1114         '--postprocessor-args', '--ppa',
1115         metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
1116         action='callback', callback=_dict_from_multiple_values_options_callback,
1117         callback_kwargs={
1118             'allowed_keys': r'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1119             'process': compat_shlex_split, 'multiple_keys': False},
1120         help=(
1121             'Give these arguments to the postprocessors. '
1122             'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1123             'to give the argument to the specified postprocessor/executable. Supported PP are: '
1124             'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1125             'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
1126             'SponSkrub, FixupStretched, FixupM4a and FixupM3u8. '
1127             'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
1128             'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1129             'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1130             '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1131             'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1132             'You can use this option multiple times to give different arguments to different '
1133             'postprocessors. (Alias: --ppa)'))
1134     postproc.add_option(
1135         '-k', '--keep-video',
1136         action='store_true', dest='keepvideo', default=False,
1137         help='Keep the intermediate video file on disk after post-processing')
1138     postproc.add_option(
1139         '--no-keep-video',
1140         action='store_false', dest='keepvideo',
1141         help='Delete the intermediate video file after post-processing (default)')
1142     postproc.add_option(
1143         '--post-overwrites',
1144         action='store_false', dest='nopostoverwrites',
1145         help='Overwrite post-processed files (default)')
1146     postproc.add_option(
1147         '--no-post-overwrites',
1148         action='store_true', dest='nopostoverwrites', default=False,
1149         help='Do not overwrite post-processed files')
1150     postproc.add_option(
1151         '--embed-subs',
1152         action='store_true', dest='embedsubtitles', default=False,
1153         help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1154     postproc.add_option(
1155         '--no-embed-subs',
1156         action='store_false', dest='embedsubtitles',
1157         help='Do not embed subtitles (default)')
1158     postproc.add_option(
1159         '--embed-thumbnail',
1160         action='store_true', dest='embedthumbnail', default=False,
1161         help='Embed thumbnail in the audio as cover art')
1162     postproc.add_option(
1163         '--no-embed-thumbnail',
1164         action='store_false', dest='embedthumbnail',
1165         help='Do not embed thumbnail (default)')
1166     postproc.add_option(
1167         '--add-metadata',
1168         action='store_true', dest='addmetadata', default=False,
1169         help='Write metadata to the video file')
1170     postproc.add_option(
1171         '--no-add-metadata',
1172         action='store_false', dest='addmetadata',
1173         help='Do not write metadata (default)')
1174     postproc.add_option(
1175         '--metadata-from-title',
1176         metavar='FORMAT', dest='metafromtitle',
1177         help=optparse.SUPPRESS_HELP)
1178     postproc.add_option(
1179         '--parse-metadata',
1180         metavar='FROM:TO', dest='metafromfield', action='append',
1181         help=(
1182             'Parse additional metadata like title/artist from other fields; '
1183             'see "MODIFYING METADATA" for details'))
1184     postproc.add_option(
1185         '--xattrs',
1186         action='store_true', dest='xattrs', default=False,
1187         help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1188     postproc.add_option(
1189         '--fixup',
1190         metavar='POLICY', dest='fixup', default=None,
1191         help=(
1192             'Automatically correct known faults of the file. '
1193             'One of never (do nothing), warn (only emit a warning), '
1194             'detect_or_warn (the default; fix file if we can, warn otherwise)'))
1195     postproc.add_option(
1196         '--prefer-avconv', '--no-prefer-ffmpeg',
1197         action='store_false', dest='prefer_ffmpeg',
1198         help=optparse.SUPPRESS_HELP)
1199     postproc.add_option(
1200         '--prefer-ffmpeg', '--no-prefer-avconv',
1201         action='store_true', dest='prefer_ffmpeg', default=True,
1202         help=optparse.SUPPRESS_HELP)
1203     postproc.add_option(
1204         '--ffmpeg-location', '--avconv-location', metavar='PATH',
1205         dest='ffmpeg_location',
1206         help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1207     postproc.add_option(
1208         '--exec',
1209         metavar='CMD', dest='exec_cmd',
1210         help=(
1211             'Execute a command on the file after downloading and post-processing. '
1212             'Similar syntax to the output template can be used to pass any field as arguments to the command. '
1213             'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1214             'If no fields are passed, "%(filepath)s" is appended to the end of the command'))
1215     postproc.add_option(
1216         '--convert-subs', '--convert-sub', '--convert-subtitles',
1217         metavar='FORMAT', dest='convertsubtitles', default=None,
1218         help='Convert the subtitles to another format (currently supported: srt|ass|vtt|lrc) (Alias: --convert-subtitles)')
1219     postproc.add_option(
1220         '--convert-thumbnails',
1221         metavar='FORMAT', dest='convertthumbnails', default=None,
1222         help='Convert the thumbnails to another format (currently supported: jpg)')
1223     postproc.add_option(
1224         '--split-chapters', '--split-tracks',
1225         dest='split_chapters', action='store_true', default=False,
1226         help=(
1227             'Split video into multiple files based on internal chapters. '
1228             'The "chapter:" prefix can be used with "--paths" and "--output" to '
1229             'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1230     postproc.add_option(
1231         '--no-split-chapters', '--no-split-tracks',
1232         dest='split_chapters', action='store_false',
1233         help='Do not split video based on chapters (default)')
1234
1235     sponskrub = optparse.OptionGroup(parser, 'SponSkrub (SponsorBlock) Options', description=(
1236         'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1237         'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1238     sponskrub.add_option(
1239         '--sponskrub',
1240         action='store_true', dest='sponskrub', default=None,
1241         help=(
1242             'Use sponskrub to mark sponsored sections. '
1243             'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1244     sponskrub.add_option(
1245         '--no-sponskrub',
1246         action='store_false', dest='sponskrub',
1247         help='Do not use sponskrub')
1248     sponskrub.add_option(
1249         '--sponskrub-cut', default=False,
1250         action='store_true', dest='sponskrub_cut',
1251         help='Cut out the sponsor sections instead of simply marking them')
1252     sponskrub.add_option(
1253         '--no-sponskrub-cut',
1254         action='store_false', dest='sponskrub_cut',
1255         help='Simply mark the sponsor sections, not cut them out (default)')
1256     sponskrub.add_option(
1257         '--sponskrub-force', default=False,
1258         action='store_true', dest='sponskrub_force',
1259         help='Run sponskrub even if the video was already downloaded')
1260     sponskrub.add_option(
1261         '--no-sponskrub-force',
1262         action='store_true', dest='sponskrub_force',
1263         help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1264     sponskrub.add_option(
1265         '--sponskrub-location', metavar='PATH',
1266         dest='sponskrub_path', default='',
1267         help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1268     sponskrub.add_option(
1269         '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1270         help=optparse.SUPPRESS_HELP)
1271
1272     extractor = optparse.OptionGroup(parser, 'Extractor Options')
1273     extractor.add_option(
1274         '--extractor-retries',
1275         dest='extractor_retries', metavar='RETRIES', default=3,
1276         help='Number of retries for known extractor errors (default is %default), or "infinite"')
1277     extractor.add_option(
1278         '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1279         action='store_true', dest='dynamic_mpd', default=True,
1280         help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1281     extractor.add_option(
1282         '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1283         action='store_false', dest='dynamic_mpd',
1284         help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1285     extractor.add_option(
1286         '--hls-split-discontinuity',
1287         dest='hls_split_discontinuity', action='store_true', default=False,
1288         help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1289     )
1290     extractor.add_option(
1291         '--no-hls-split-discontinuity',
1292         dest='hls_split_discontinuity', action='store_false',
1293         help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1294     extractor.add_option(
1295         '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1296         action='store_true', dest='youtube_include_dash_manifest', default=True,
1297         help='Download the DASH manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-dash-manifest)')
1298     extractor.add_option(
1299         '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1300         action='store_false', dest='youtube_include_dash_manifest',
1301         help='Do not download the DASH manifests and related data on YouTube videos (Alias: --no-youtube-include-dash-manifest)')
1302     extractor.add_option(
1303         '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1304         action='store_true', dest='youtube_include_hls_manifest', default=True,
1305         help='Download the HLS manifests and related data on YouTube videos (default) (Alias: --no-youtube-skip-hls-manifest)')
1306     extractor.add_option(
1307         '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1308         action='store_false', dest='youtube_include_hls_manifest',
1309         help='Do not download the HLS manifests and related data on YouTube videos (Alias: --no-youtube-include-hls-manifest)')
1310
1311     parser.add_option_group(general)
1312     parser.add_option_group(network)
1313     parser.add_option_group(geo)
1314     parser.add_option_group(selection)
1315     parser.add_option_group(downloader)
1316     parser.add_option_group(filesystem)
1317     parser.add_option_group(thumbnail)
1318     parser.add_option_group(link)
1319     parser.add_option_group(verbosity)
1320     parser.add_option_group(workarounds)
1321     parser.add_option_group(video_format)
1322     parser.add_option_group(subtitles)
1323     parser.add_option_group(authentication)
1324     parser.add_option_group(postproc)
1325     parser.add_option_group(sponskrub)
1326     parser.add_option_group(extractor)
1327
1328     if overrideArguments is not None:
1329         opts, args = parser.parse_args(overrideArguments)
1330         if opts.verbose:
1331             write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
1332     else:
1333         def compat_conf(conf):
1334             if sys.version_info < (3,):
1335                 return [a.decode(preferredencoding(), 'replace') for a in conf]
1336             return conf
1337
1338         configs = {
1339             'command-line': compat_conf(sys.argv[1:]),
1340             'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1341         paths = {'command-line': False}
1342         opts, args = parser.parse_args(configs['command-line'])
1343
1344         def get_configs():
1345             if '--config-location' in configs['command-line']:
1346                 location = compat_expanduser(opts.config_location)
1347                 if os.path.isdir(location):
1348                     location = os.path.join(location, 'yt-dlp.conf')
1349                 if not os.path.exists(location):
1350                     parser.error('config-location %s does not exist.' % location)
1351                 configs['custom'] = _readOptions(location, default=None)
1352                 if configs['custom'] is None:
1353                     configs['custom'] = []
1354                 else:
1355                     paths['custom'] = location
1356             if '--ignore-config' in configs['command-line']:
1357                 return
1358             if '--ignore-config' in configs['custom']:
1359                 return
1360
1361             def read_options(path, user=False):
1362                 # Multiple package names can be given here
1363                 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1364                 # the configuration file of any of these three packages
1365                 for package in ('yt-dlp',):
1366                     if user:
1367                         config, current_path = _readUserConf(package, default=None)
1368                     else:
1369                         current_path = os.path.join(path, '%s.conf' % package)
1370                         config = _readOptions(current_path, default=None)
1371                     if config is not None:
1372                         return config, current_path
1373                 return [], None
1374
1375             configs['portable'], paths['portable'] = read_options(get_executable_path())
1376             if '--ignore-config' in configs['portable']:
1377                 return
1378
1379             def get_home_path():
1380                 opts = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])[0]
1381                 return expand_path(opts.paths.get('home', '')).strip()
1382
1383             configs['home'], paths['home'] = read_options(get_home_path())
1384             if '--ignore-config' in configs['home']:
1385                 return
1386
1387             configs['system'], paths['system'] = read_options('/etc')
1388             if '--ignore-config' in configs['system']:
1389                 return
1390
1391             configs['user'], paths['user'] = read_options('', True)
1392             if '--ignore-config' in configs['user']:
1393                 configs['system'], paths['system'] = [], None
1394
1395         get_configs()
1396         argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line']
1397         opts, args = parser.parse_args(argv)
1398         if opts.verbose:
1399             for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1400                 key = label.lower()
1401                 if paths.get(key) is None:
1402                     continue
1403                 if paths[key]:
1404                     write_string('[debug] %s config file: %s\n' % (label, paths[key]))
1405                 write_string('[debug] %s config: %s\n' % (label, repr(_hide_login_info(configs[key]))))
1406
1407     return parser, opts, args