Release 2024.12.13
[yt-dlp.git] / yt_dlp / options.py
blob930d9d4bef6d112fa1c0cad7b458227feabc7d4b
1 import collections
2 import contextlib
3 import optparse
4 import os.path
5 import re
6 import shlex
7 import shutil
8 import string
9 import sys
11 from .compat import compat_expanduser
12 from .cookies import SUPPORTED_BROWSERS, SUPPORTED_KEYRINGS
13 from .downloader.external import list_external_downloaders
14 from .postprocessor import (
15 FFmpegExtractAudioPP,
16 FFmpegMergerPP,
17 FFmpegSubtitlesConvertorPP,
18 FFmpegThumbnailsConvertorPP,
19 FFmpegVideoRemuxerPP,
20 SponsorBlockPP,
22 from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
23 from .update import UPDATE_SOURCES, detect_variant, is_non_updateable
24 from .utils import (
25 OUTTMPL_TYPES,
26 POSTPROCESS_WHEN,
27 Config,
28 deprecation_warning,
29 expand_path,
30 format_field,
31 get_executable_path,
32 get_system_config_dirs,
33 get_user_config_dirs,
34 join_nonempty,
35 orderedSet_from_options,
36 remove_end,
37 variadic,
38 write_string,
40 from .version import CHANNEL, __version__
43 def parseOpts(overrideArguments=None, ignore_config_files='if_override'): # noqa: N803
44 PACKAGE_NAME = 'yt-dlp'
46 root = Config(create_parser())
47 if ignore_config_files == 'if_override':
48 ignore_config_files = overrideArguments is not None
50 def read_config(*paths):
51 path = os.path.join(*paths)
52 conf = Config.read_file(path, default=None)
53 if conf is not None:
54 return conf, path
56 def _load_from_config_dirs(config_dirs):
57 for config_dir in config_dirs:
58 head, tail = os.path.split(config_dir)
59 assert tail == PACKAGE_NAME or config_dir == os.path.join(compat_expanduser('~'), f'.{PACKAGE_NAME}')
61 yield read_config(head, f'{PACKAGE_NAME}.conf')
62 if tail.startswith('.'): # ~/.PACKAGE_NAME
63 yield read_config(head, f'{PACKAGE_NAME}.conf.txt')
64 yield read_config(config_dir, 'config')
65 yield read_config(config_dir, 'config.txt')
67 def add_config(label, path=None, func=None):
68 """ Adds config and returns whether to continue """
69 if root.parse_known_args()[0].ignoreconfig:
70 return False
71 elif func:
72 assert path is None
73 args, current_path = next(
74 filter(None, _load_from_config_dirs(func(PACKAGE_NAME))), (None, None))
75 else:
76 current_path = os.path.join(path, 'yt-dlp.conf')
77 args = Config.read_file(current_path, default=None)
78 if args is not None:
79 root.append_config(args, current_path, label=label)
80 return True
82 def load_configs():
83 yield not ignore_config_files
84 yield add_config('Portable', get_executable_path())
85 yield add_config('Home', expand_path(root.parse_known_args()[0].paths.get('home', '')).strip())
86 yield add_config('User', func=get_user_config_dirs)
87 yield add_config('System', func=get_system_config_dirs)
89 opts = optparse.Values({'verbose': True, 'print_help': False})
90 try:
91 try:
92 if overrideArguments is not None:
93 root.append_config(overrideArguments, label='Override')
94 else:
95 root.append_config(sys.argv[1:], label='Command-line')
96 loaded_all_configs = all(load_configs())
97 except ValueError as err:
98 raise root.parser.error(err)
100 if loaded_all_configs:
101 # If ignoreconfig is found inside the system configuration file,
102 # the user configuration is removed
103 if root.parse_known_args()[0].ignoreconfig:
104 user_conf = next((i for i, conf in enumerate(root.configs) if conf.label == 'User'), None)
105 if user_conf is not None:
106 root.configs.pop(user_conf)
108 try:
109 root.configs[0].load_configs() # Resolve any aliases using --config-location
110 except ValueError as err:
111 raise root.parser.error(err)
113 opts, args = root.parse_args()
114 except optparse.OptParseError:
115 with contextlib.suppress(optparse.OptParseError):
116 opts, _ = root.parse_known_args(strict=False)
117 raise
118 except (SystemExit, KeyboardInterrupt):
119 opts.verbose = False
120 raise
121 finally:
122 verbose = opts.verbose and f'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
123 if verbose:
124 write_string(f'{verbose}\n')
125 if opts.print_help:
126 if verbose:
127 write_string('\n')
128 root.parser.print_help()
129 if opts.print_help:
130 sys.exit()
131 return root.parser, opts, args
134 class _YoutubeDLHelpFormatter(optparse.IndentedHelpFormatter):
135 def __init__(self):
136 # No need to wrap help messages if we're on a wide console
137 max_width = shutil.get_terminal_size().columns or 80
138 # The % is chosen to get a pretty output in README.md
139 super().__init__(width=max_width, max_help_position=int(0.45 * max_width))
141 @staticmethod
142 def format_option_strings(option):
143 """ ('-o', '--option') -> -o, --format METAVAR """
144 opts = join_nonempty(
145 option._short_opts and option._short_opts[0],
146 option._long_opts and option._long_opts[0],
147 delim=', ')
148 if option.takes_value():
149 opts += f' {option.metavar}'
150 return opts
153 class _YoutubeDLOptionParser(optparse.OptionParser):
154 # optparse is deprecated since Python 3.2. So assume a stable interface even for private methods
155 ALIAS_DEST = '_triggered_aliases'
156 ALIAS_TRIGGER_LIMIT = 100
158 def __init__(self):
159 super().__init__(
160 prog='yt-dlp' if detect_variant() == 'source' else None,
161 version=__version__,
162 usage='%prog [OPTIONS] URL [URL...]',
163 epilog='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
164 formatter=_YoutubeDLHelpFormatter(),
165 conflict_handler='resolve',
167 self.set_default(self.ALIAS_DEST, collections.defaultdict(int))
169 _UNKNOWN_OPTION = (optparse.BadOptionError, optparse.AmbiguousOptionError)
170 _BAD_OPTION = optparse.OptionValueError
172 def parse_known_args(self, args=None, values=None, strict=True):
173 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
174 self.rargs, self.largs = self._get_args(args), []
175 self.values = values or self.get_default_values()
176 while self.rargs:
177 arg = self.rargs[0]
178 try:
179 if arg == '--':
180 del self.rargs[0]
181 break
182 elif arg.startswith('--'):
183 self._process_long_opt(self.rargs, self.values)
184 elif arg.startswith('-') and arg != '-':
185 self._process_short_opts(self.rargs, self.values)
186 elif self.allow_interspersed_args:
187 self.largs.append(self.rargs.pop(0))
188 else:
189 break
190 except optparse.OptParseError as err:
191 if isinstance(err, self._UNKNOWN_OPTION):
192 self.largs.append(err.opt_str)
193 elif strict:
194 if isinstance(err, self._BAD_OPTION):
195 self.error(str(err))
196 raise
197 return self.check_values(self.values, self.largs)
199 def _generate_error_message(self, msg):
200 msg = f'{self.get_prog_name()}: error: {str(msg).strip()}\n'
201 return f'{self.get_usage()}\n{msg}' if self.usage else msg
203 def error(self, msg):
204 raise optparse.OptParseError(self._generate_error_message(msg))
206 def _get_args(self, args):
207 return sys.argv[1:] if args is None else list(args)
209 def _match_long_opt(self, opt):
210 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
211 try:
212 return super()._match_long_opt(opt)
213 except optparse.AmbiguousOptionError as e:
214 if len({self._long_opt[p] for p in e.possibilities}) == 1:
215 return e.possibilities[0]
216 raise
219 def create_parser():
220 def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip):
221 # append can be True, False or -1 (prepend)
222 current = list(getattr(parser.values, option.dest)) if append else []
223 value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim))))
224 setattr(
225 parser.values, option.dest,
226 current + value if append is True else value + current)
228 def _set_from_options_callback(
229 option, opt_str, value, parser, allowed_values, delim=',', aliases={},
230 process=lambda x: x.lower().strip()):
231 values = [process(value)] if delim is None else map(process, value.split(delim))
232 try:
233 requested = orderedSet_from_options(values, collections.ChainMap(aliases, {'all': allowed_values}),
234 start=getattr(parser.values, option.dest))
235 except ValueError as e:
236 raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {e.args[0]}')
238 setattr(parser.values, option.dest, set(requested))
240 def _dict_from_options_callback(
241 option, opt_str, value, parser,
242 allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True,
243 process_key=str.lower, append=False):
245 out_dict = dict(getattr(parser.values, option.dest))
246 multiple_args = not isinstance(value, str)
247 if multiple_keys:
248 allowed_keys = fr'({allowed_keys})(,({allowed_keys}))*'
249 mobj = re.match(
250 fr'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
251 value[0] if multiple_args else value)
252 if mobj is not None:
253 keys, val = mobj.group('keys').split(','), mobj.group('val')
254 if multiple_args:
255 val = [val, *value[1:]]
256 elif default_key is not None:
257 keys, val = variadic(default_key), value
258 else:
259 raise optparse.OptionValueError(
260 f'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
261 try:
262 keys = map(process_key, keys) if process_key else keys
263 val = process(val) if process else val
264 except Exception as err:
265 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
266 for key in keys:
267 out_dict[key] = [*out_dict.get(key, []), val] if append else val
268 setattr(parser.values, option.dest, out_dict)
270 def when_prefix(default):
271 return {
272 'default': {},
273 'type': 'str',
274 'action': 'callback',
275 'callback': _dict_from_options_callback,
276 'callback_kwargs': {
277 'allowed_keys': '|'.join(map(re.escape, POSTPROCESS_WHEN)),
278 'default_key': default,
279 'multiple_keys': False,
280 'append': True,
284 parser = _YoutubeDLOptionParser()
285 alias_group = optparse.OptionGroup(parser, 'Aliases')
286 Formatter = string.Formatter()
288 def _create_alias(option, opt_str, value, parser):
289 aliases, opts = value
290 try:
291 nargs = len({i if f == '' else f
292 for i, (_, f, _, _) in enumerate(Formatter.parse(opts)) if f is not None})
293 opts.format(*map(str, range(nargs))) # validate
294 except Exception as err:
295 raise optparse.OptionValueError(f'wrong {opt_str} OPTIONS formatting; {err}')
296 if alias_group not in parser.option_groups:
297 parser.add_option_group(alias_group)
299 aliases = (x if x.startswith('-') else f'--{x}' for x in map(str.strip, aliases.split(',')))
300 try:
301 args = [f'ARG{i}' for i in range(nargs)]
302 alias_group.add_option(
303 *aliases, nargs=nargs, dest=parser.ALIAS_DEST, type='str' if nargs else None,
304 metavar=' '.join(args), help=opts.format(*args), action='callback',
305 callback=_alias_callback, callback_kwargs={'opts': opts, 'nargs': nargs})
306 except Exception as err:
307 raise optparse.OptionValueError(f'wrong {opt_str} formatting; {err}')
309 def _alias_callback(option, opt_str, value, parser, opts, nargs):
310 counter = getattr(parser.values, option.dest)
311 counter[opt_str] += 1
312 if counter[opt_str] > parser.ALIAS_TRIGGER_LIMIT:
313 raise optparse.OptionValueError(f'Alias {opt_str} exceeded invocation limit')
314 if nargs == 1:
315 value = [value]
316 assert (nargs == 0 and value is None) or len(value) == nargs
317 parser.rargs[:0] = shlex.split(
318 opts if value is None else opts.format(*map(shlex.quote, value)))
320 general = optparse.OptionGroup(parser, 'General Options')
321 general.add_option(
322 '-h', '--help', dest='print_help', action='store_true',
323 help='Print this help text and exit')
324 general.add_option(
325 '--version',
326 action='version',
327 help='Print program version and exit')
328 general.add_option(
329 '-U', '--update',
330 action='store_const', dest='update_self', const=CHANNEL,
331 help=format_field(
332 is_non_updateable(), None, 'Check if updates are available. %s',
333 default=f'Update this program to the latest {CHANNEL} version'))
334 general.add_option(
335 '--no-update',
336 action='store_false', dest='update_self',
337 help='Do not check for updates (default)')
338 general.add_option(
339 '--update-to',
340 action='store', dest='update_self', metavar='[CHANNEL]@[TAG]',
341 help=(
342 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
343 f'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
344 f'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
345 general.add_option(
346 '-i', '--ignore-errors',
347 action='store_true', dest='ignoreerrors',
348 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
349 general.add_option(
350 '--no-abort-on-error',
351 action='store_const', dest='ignoreerrors', const='only_download',
352 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
353 general.add_option(
354 '--abort-on-error', '--no-ignore-errors',
355 action='store_false', dest='ignoreerrors',
356 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
357 general.add_option(
358 '--dump-user-agent',
359 action='store_true', dest='dump_user_agent', default=False,
360 help='Display the current user-agent and exit')
361 general.add_option(
362 '--list-extractors',
363 action='store_true', dest='list_extractors', default=False,
364 help='List all supported extractors and exit')
365 general.add_option(
366 '--extractor-descriptions',
367 action='store_true', dest='list_extractor_descriptions', default=False,
368 help='Output descriptions of all supported extractors and exit')
369 general.add_option(
370 '--use-extractors', '--ies',
371 action='callback', dest='allowed_extractors', metavar='NAMES', type='str',
372 default=[], callback=_list_from_options_callback,
373 help=(
374 'Extractor names to use separated by commas. '
375 'You can also use regexes, "all", "default" and "end" (end URL matching); '
376 'e.g. --ies "holodex.*,end,youtube". '
377 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
378 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
379 general.add_option(
380 '--force-generic-extractor',
381 action='store_true', dest='force_generic_extractor', default=False,
382 help=optparse.SUPPRESS_HELP)
383 general.add_option(
384 '--default-search',
385 dest='default_search', metavar='PREFIX',
386 help=(
387 'Use this prefix for unqualified URLs. '
388 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
389 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
390 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
391 'but emits an error if this is not possible instead of searching'))
392 general.add_option(
393 '--ignore-config', '--no-config',
394 action='store_true', dest='ignoreconfig',
395 help=(
396 'Don\'t load any more configuration files except those given to --config-locations. '
397 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
398 '(Alias: --no-config)'))
399 general.add_option(
400 '--no-config-locations',
401 action='store_const', dest='config_locations', const=[],
402 help=(
403 'Do not load any custom configuration files (default). When given inside a '
404 'configuration file, ignore all previous --config-locations defined in the current file'))
405 general.add_option(
406 '--config-locations',
407 dest='config_locations', metavar='PATH', action='append',
408 help=(
409 'Location of the main configuration file; either the path to the config or its containing directory '
410 '("-" for stdin). Can be used multiple times and inside other configuration files'))
411 general.add_option(
412 '--plugin-dirs',
413 dest='plugin_dirs', metavar='PATH', action='append',
414 help=(
415 'Path to an additional directory to search for plugins. '
416 'This option can be used multiple times to add multiple directories. '
417 'Note that this currently only works for extractor plugins; '
418 'postprocessor plugins can only be loaded from the default plugin directories'))
419 general.add_option(
420 '--flat-playlist',
421 action='store_const', dest='extract_flat', const='in_playlist', default=False,
422 help=(
423 'Do not extract a playlist\'s URL result entries; '
424 'some entry metadata may be missing and downloading may be bypassed'))
425 general.add_option(
426 '--no-flat-playlist',
427 action='store_false', dest='extract_flat',
428 help='Fully extract the videos of a playlist (default)')
429 general.add_option(
430 '--live-from-start',
431 action='store_true', dest='live_from_start',
432 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
433 general.add_option(
434 '--no-live-from-start',
435 action='store_false', dest='live_from_start',
436 help='Download livestreams from the current time (default)')
437 general.add_option(
438 '--wait-for-video',
439 dest='wait_for_video', metavar='MIN[-MAX]', default=None,
440 help=(
441 'Wait for scheduled streams to become available. '
442 'Pass the minimum number of seconds (or range) to wait between retries'))
443 general.add_option(
444 '--no-wait-for-video',
445 dest='wait_for_video', action='store_const', const=None,
446 help='Do not wait for scheduled streams (default)')
447 general.add_option(
448 '--mark-watched',
449 action='store_true', dest='mark_watched', default=False,
450 help='Mark videos watched (even with --simulate)')
451 general.add_option(
452 '--no-mark-watched',
453 action='store_false', dest='mark_watched',
454 help='Do not mark videos watched (default)')
455 general.add_option(
456 '--no-colors', '--no-colours',
457 action='store_const', dest='color', const={
458 'stdout': 'no_color',
459 'stderr': 'no_color',
461 help=optparse.SUPPRESS_HELP)
462 general.add_option(
463 '--color',
464 dest='color', metavar='[STREAM:]POLICY', default={}, type='str',
465 action='callback', callback=_dict_from_options_callback,
466 callback_kwargs={
467 'allowed_keys': 'stdout|stderr',
468 'default_key': ['stdout', 'stderr'],
469 'process': str.strip,
470 }, help=(
471 'Whether to emit color codes in output, optionally prefixed by '
472 'the STREAM (stdout or stderr) to apply the setting to. '
473 'Can be one of "always", "auto" (default), "never", or '
474 '"no_color" (use non color terminal sequences). '
475 'Use "auto-tty" or "no_color-tty" to decide based on terminal support only. '
476 'Can be used multiple times'))
477 general.add_option(
478 '--compat-options',
479 metavar='OPTS', dest='compat_opts', default=set(), type='str',
480 action='callback', callback=_set_from_options_callback,
481 callback_kwargs={
482 'allowed_values': {
483 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
484 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter',
485 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
486 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
487 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
488 'prefer-legacy-http-handler', 'manifest-filesize-approx', 'allow-unsafe-ext', 'prefer-vp9-sort',
489 }, 'aliases': {
490 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext', '-prefer-vp9-sort'],
491 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext', '-prefer-vp9-sort'],
492 '2021': ['2022', 'no-certifi', 'filename-sanitization'],
493 '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler', 'manifest-filesize-approx'],
494 '2023': ['prefer-vp9-sort'],
496 }, help=(
497 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
498 'configurations by reverting some of the changes made in yt-dlp. '
499 'See "Differences in default behavior" for details'))
500 general.add_option(
501 '--alias', metavar='ALIASES OPTIONS', dest='_', type='str', nargs=2,
502 action='callback', callback=_create_alias,
503 help=(
504 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
505 'Arguments are parsed according to the Python string formatting mini-language. '
506 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
507 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
508 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
509 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
510 f'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
511 'This option can be used multiple times'))
513 network = optparse.OptionGroup(parser, 'Network Options')
514 network.add_option(
515 '--proxy', dest='proxy',
516 default=None, metavar='URL',
517 help=(
518 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
519 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
520 network.add_option(
521 '--socket-timeout',
522 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
523 help='Time to wait before giving up, in seconds')
524 network.add_option(
525 '--source-address',
526 metavar='IP', dest='source_address', default=None,
527 help='Client-side IP address to bind to',
529 network.add_option(
530 '--impersonate',
531 metavar='CLIENT[:OS]', dest='impersonate', default=None,
532 help=(
533 'Client to impersonate for requests. E.g. chrome, chrome-110, chrome:windows-10. '
534 'Pass --impersonate="" to impersonate any client. Note that forcing impersonation '
535 'for all requests may have a detrimental impact on download speed and stability'),
537 network.add_option(
538 '--list-impersonate-targets',
539 dest='list_impersonate_targets', default=False, action='store_true',
540 help='List available clients to impersonate.',
542 network.add_option(
543 '-4', '--force-ipv4',
544 action='store_const', const='0.0.0.0', dest='source_address',
545 help='Make all connections via IPv4',
547 network.add_option(
548 '-6', '--force-ipv6',
549 action='store_const', const='::', dest='source_address',
550 help='Make all connections via IPv6',
552 network.add_option(
553 '--enable-file-urls', action='store_true',
554 dest='enable_file_urls', default=False,
555 help='Enable file:// URLs. This is disabled by default for security reasons.',
558 geo = optparse.OptionGroup(parser, 'Geo-restriction')
559 geo.add_option(
560 '--geo-verification-proxy',
561 dest='geo_verification_proxy', default=None, metavar='URL',
562 help=(
563 'Use this proxy to verify the IP address for some geo-restricted sites. '
564 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
565 geo.add_option(
566 '--cn-verification-proxy',
567 dest='cn_verification_proxy', default=None, metavar='URL',
568 help=optparse.SUPPRESS_HELP)
569 geo.add_option(
570 '--xff', metavar='VALUE',
571 dest='geo_bypass', default='default',
572 help=(
573 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
574 'One of "default" (only when known to be useful), "never", '
575 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
576 geo.add_option(
577 '--geo-bypass',
578 action='store_const', dest='geo_bypass', const='default',
579 help=optparse.SUPPRESS_HELP)
580 geo.add_option(
581 '--no-geo-bypass',
582 action='store_const', dest='geo_bypass', const='never',
583 help=optparse.SUPPRESS_HELP)
584 geo.add_option(
585 '--geo-bypass-country', metavar='CODE', dest='geo_bypass',
586 help=optparse.SUPPRESS_HELP)
587 geo.add_option(
588 '--geo-bypass-ip-block', metavar='IP_BLOCK', dest='geo_bypass',
589 help=optparse.SUPPRESS_HELP)
591 selection = optparse.OptionGroup(parser, 'Video Selection')
592 selection.add_option(
593 '--playlist-start',
594 dest='playliststart', metavar='NUMBER', default=1, type=int,
595 help=optparse.SUPPRESS_HELP)
596 selection.add_option(
597 '--playlist-end',
598 dest='playlistend', metavar='NUMBER', default=None, type=int,
599 help=optparse.SUPPRESS_HELP)
600 selection.add_option(
601 '-I', '--playlist-items',
602 dest='playlist_items', metavar='ITEM_SPEC', default=None,
603 help=(
604 'Comma separated playlist_index of the items to download. '
605 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
606 'Use negative indices to count from the right and negative STEP to download in reverse order. '
607 'E.g. "-I 1:3,7,-5::2" used on a playlist of size 15 will download the items at index 1,2,3,7,11,13,15'))
608 selection.add_option(
609 '--match-title',
610 dest='matchtitle', metavar='REGEX',
611 help=optparse.SUPPRESS_HELP)
612 selection.add_option(
613 '--reject-title',
614 dest='rejecttitle', metavar='REGEX',
615 help=optparse.SUPPRESS_HELP)
616 selection.add_option(
617 '--min-filesize',
618 metavar='SIZE', dest='min_filesize', default=None,
619 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
620 selection.add_option(
621 '--max-filesize',
622 metavar='SIZE', dest='max_filesize', default=None,
623 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
624 selection.add_option(
625 '--date',
626 metavar='DATE', dest='date', default=None,
627 help=(
628 'Download only videos uploaded on this date. '
629 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
630 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
631 selection.add_option(
632 '--datebefore',
633 metavar='DATE', dest='datebefore', default=None,
634 help=(
635 'Download only videos uploaded on or before this date. '
636 'The date formats accepted are the same as --date'))
637 selection.add_option(
638 '--dateafter',
639 metavar='DATE', dest='dateafter', default=None,
640 help=(
641 'Download only videos uploaded on or after this date. '
642 'The date formats accepted are the same as --date'))
643 selection.add_option(
644 '--min-views',
645 metavar='COUNT', dest='min_views', default=None, type=int,
646 help=optparse.SUPPRESS_HELP)
647 selection.add_option(
648 '--max-views',
649 metavar='COUNT', dest='max_views', default=None, type=int,
650 help=optparse.SUPPRESS_HELP)
651 selection.add_option(
652 '--match-filters',
653 metavar='FILTER', dest='match_filter', action='append',
654 help=(
655 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
656 'number or a string using the operators defined in "Filtering Formats". '
657 'You can also simply specify a field to match if the field is present, '
658 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
659 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
660 'the filter matches if at least one of the conditions is met. E.g. --match-filters '
661 '!is_live --match-filters "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
662 'matches only videos that are not live OR those that have a like count more than 100 '
663 '(or the like field is not available) and also has a description '
664 'that contains the phrase "cats & dogs" (caseless). '
665 'Use "--match-filters -" to interactively ask whether to download each video'))
666 selection.add_option(
667 '--no-match-filters',
668 dest='match_filter', action='store_const', const=None,
669 help='Do not use any --match-filters (default)')
670 selection.add_option(
671 '--break-match-filters',
672 metavar='FILTER', dest='breaking_match_filter', action='append',
673 help='Same as "--match-filters" but stops the download process when a video is rejected')
674 selection.add_option(
675 '--no-break-match-filters',
676 dest='breaking_match_filter', action='store_const', const=None,
677 help='Do not use any --break-match-filters (default)')
678 selection.add_option(
679 '--no-playlist',
680 action='store_true', dest='noplaylist', default=False,
681 help='Download only the video, if the URL refers to a video and a playlist')
682 selection.add_option(
683 '--yes-playlist',
684 action='store_false', dest='noplaylist',
685 help='Download the playlist, if the URL refers to a video and a playlist')
686 selection.add_option(
687 '--age-limit',
688 metavar='YEARS', dest='age_limit', default=None, type=int,
689 help='Download only videos suitable for the given age')
690 selection.add_option(
691 '--download-archive', metavar='FILE',
692 dest='download_archive',
693 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
694 selection.add_option(
695 '--no-download-archive',
696 dest='download_archive', action='store_const', const=None,
697 help='Do not use archive file (default)')
698 selection.add_option(
699 '--max-downloads',
700 dest='max_downloads', metavar='NUMBER', type=int, default=None,
701 help='Abort after downloading NUMBER files')
702 selection.add_option(
703 '--break-on-existing',
704 action='store_true', dest='break_on_existing', default=False,
705 help='Stop the download process when encountering a file that is in the archive '
706 'supplied with the --download-archive option')
707 selection.add_option(
708 '--no-break-on-existing',
709 action='store_false', dest='break_on_existing',
710 help='Do not stop the download process when encountering a file that is in the archive (default)')
711 selection.add_option(
712 '--break-on-reject',
713 action='store_true', dest='break_on_reject', default=False,
714 help=optparse.SUPPRESS_HELP)
715 selection.add_option(
716 '--break-per-input',
717 action='store_true', dest='break_per_url', default=False,
718 help='Alters --max-downloads, --break-on-existing, --break-match-filters, and autonumber to reset per input URL')
719 selection.add_option(
720 '--no-break-per-input',
721 action='store_false', dest='break_per_url',
722 help='--break-on-existing and similar options terminates the entire download queue')
723 selection.add_option(
724 '--skip-playlist-after-errors', metavar='N',
725 dest='skip_playlist_after_errors', default=None, type=int,
726 help='Number of allowed failures until the rest of the playlist is skipped')
727 selection.add_option(
728 '--include-ads',
729 dest='include_ads', action='store_true',
730 help=optparse.SUPPRESS_HELP)
731 selection.add_option(
732 '--no-include-ads',
733 dest='include_ads', action='store_false',
734 help=optparse.SUPPRESS_HELP)
736 authentication = optparse.OptionGroup(parser, 'Authentication Options')
737 authentication.add_option(
738 '-u', '--username',
739 dest='username', metavar='USERNAME',
740 help='Login with this account ID')
741 authentication.add_option(
742 '-p', '--password',
743 dest='password', metavar='PASSWORD',
744 help='Account password. If this option is left out, yt-dlp will ask interactively')
745 authentication.add_option(
746 '-2', '--twofactor',
747 dest='twofactor', metavar='TWOFACTOR',
748 help='Two-factor authentication code')
749 authentication.add_option(
750 '-n', '--netrc',
751 action='store_true', dest='usenetrc', default=False,
752 help='Use .netrc authentication data')
753 authentication.add_option(
754 '--netrc-location',
755 dest='netrc_location', metavar='PATH',
756 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
757 authentication.add_option(
758 '--netrc-cmd',
759 dest='netrc_cmd', metavar='NETRC_CMD',
760 help='Command to execute to get the credentials for an extractor.')
761 authentication.add_option(
762 '--video-password',
763 dest='videopassword', metavar='PASSWORD',
764 help='Video-specific password')
765 authentication.add_option(
766 '--ap-mso',
767 dest='ap_mso', metavar='MSO',
768 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
769 authentication.add_option(
770 '--ap-username',
771 dest='ap_username', metavar='USERNAME',
772 help='Multiple-system operator account login')
773 authentication.add_option(
774 '--ap-password',
775 dest='ap_password', metavar='PASSWORD',
776 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
777 authentication.add_option(
778 '--ap-list-mso',
779 action='store_true', dest='ap_list_mso', default=False,
780 help='List all supported multiple-system operators')
781 authentication.add_option(
782 '--client-certificate',
783 dest='client_certificate', metavar='CERTFILE',
784 help='Path to client certificate file in PEM format. May include the private key')
785 authentication.add_option(
786 '--client-certificate-key',
787 dest='client_certificate_key', metavar='KEYFILE',
788 help='Path to private key file for client certificate')
789 authentication.add_option(
790 '--client-certificate-password',
791 dest='client_certificate_password', metavar='PASSWORD',
792 help='Password for client certificate private key, if encrypted. '
793 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
795 video_format = optparse.OptionGroup(parser, 'Video Format Options')
796 video_format.add_option(
797 '-f', '--format',
798 action='store', dest='format', metavar='FORMAT', default=None,
799 help='Video format code, see "FORMAT SELECTION" for more details')
800 video_format.add_option(
801 '-S', '--format-sort', metavar='SORTORDER',
802 dest='format_sort', default=[], type='str', action='callback',
803 callback=_list_from_options_callback, callback_kwargs={'append': -1},
804 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
805 video_format.add_option(
806 '--format-sort-force', '--S-force',
807 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
808 help=(
809 'Force user specified sort order to have precedence over all fields, '
810 'see "Sorting Formats" for more details (Alias: --S-force)'))
811 video_format.add_option(
812 '--no-format-sort-force',
813 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
814 help='Some fields have precedence over the user specified sort order (default)')
815 video_format.add_option(
816 '--video-multistreams',
817 action='store_true', dest='allow_multiple_video_streams', default=None,
818 help='Allow multiple video streams to be merged into a single file')
819 video_format.add_option(
820 '--no-video-multistreams',
821 action='store_false', dest='allow_multiple_video_streams',
822 help='Only one video stream is downloaded for each output file (default)')
823 video_format.add_option(
824 '--audio-multistreams',
825 action='store_true', dest='allow_multiple_audio_streams', default=None,
826 help='Allow multiple audio streams to be merged into a single file')
827 video_format.add_option(
828 '--no-audio-multistreams',
829 action='store_false', dest='allow_multiple_audio_streams',
830 help='Only one audio stream is downloaded for each output file (default)')
831 video_format.add_option(
832 '--all-formats',
833 action='store_const', dest='format', const='all',
834 help=optparse.SUPPRESS_HELP)
835 video_format.add_option(
836 '--prefer-free-formats',
837 action='store_true', dest='prefer_free_formats', default=False,
838 help=(
839 'Prefer video formats with free containers over non-free ones of the same quality. '
840 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
841 video_format.add_option(
842 '--no-prefer-free-formats',
843 action='store_false', dest='prefer_free_formats', default=False,
844 help="Don't give any special preference to free containers (default)")
845 video_format.add_option(
846 '--check-formats',
847 action='store_const', const='selected', dest='check_formats', default=None,
848 help='Make sure formats are selected only from those that are actually downloadable')
849 video_format.add_option(
850 '--check-all-formats',
851 action='store_true', dest='check_formats',
852 help='Check all formats for whether they are actually downloadable')
853 video_format.add_option(
854 '--no-check-formats',
855 action='store_false', dest='check_formats',
856 help='Do not check that the formats are actually downloadable')
857 video_format.add_option(
858 '-F', '--list-formats',
859 action='store_true', dest='listformats',
860 help='List available formats of each video. Simulate unless --no-simulate is used')
861 video_format.add_option(
862 '--list-formats-as-table',
863 action='store_true', dest='listformats_table', default=True,
864 help=optparse.SUPPRESS_HELP)
865 video_format.add_option(
866 '--list-formats-old', '--no-list-formats-as-table',
867 action='store_false', dest='listformats_table',
868 help=optparse.SUPPRESS_HELP)
869 video_format.add_option(
870 '--merge-output-format',
871 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
872 help=(
873 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
874 'Ignored if no merge is required. '
875 f'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
876 video_format.add_option(
877 '--allow-unplayable-formats',
878 action='store_true', dest='allow_unplayable_formats', default=False,
879 help=optparse.SUPPRESS_HELP)
880 video_format.add_option(
881 '--no-allow-unplayable-formats',
882 action='store_false', dest='allow_unplayable_formats',
883 help=optparse.SUPPRESS_HELP)
885 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
886 subtitles.add_option(
887 '--write-subs', '--write-srt',
888 action='store_true', dest='writesubtitles', default=False,
889 help='Write subtitle file')
890 subtitles.add_option(
891 '--no-write-subs', '--no-write-srt',
892 action='store_false', dest='writesubtitles',
893 help='Do not write subtitle file (default)')
894 subtitles.add_option(
895 '--write-auto-subs', '--write-automatic-subs',
896 action='store_true', dest='writeautomaticsub', default=False,
897 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
898 subtitles.add_option(
899 '--no-write-auto-subs', '--no-write-automatic-subs',
900 action='store_false', dest='writeautomaticsub', default=False,
901 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
902 subtitles.add_option(
903 '--all-subs',
904 action='store_true', dest='allsubtitles', default=False,
905 help=optparse.SUPPRESS_HELP)
906 subtitles.add_option(
907 '--list-subs',
908 action='store_true', dest='listsubtitles', default=False,
909 help='List available subtitles of each video. Simulate unless --no-simulate is used')
910 subtitles.add_option(
911 '--sub-format',
912 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
913 help='Subtitle format; accepts formats preference separated by "/", e.g. "srt" or "ass/srt/best"')
914 subtitles.add_option(
915 '--sub-langs', '--srt-langs',
916 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
917 default=[], callback=_list_from_options_callback,
918 help=(
919 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja" '
920 '(where "en.*" is a regex pattern that matches "en" followed by 0 or more of any character). '
921 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
922 'Use --list-subs for a list of available language tags'))
924 downloader = optparse.OptionGroup(parser, 'Download Options')
925 downloader.add_option(
926 '-N', '--concurrent-fragments',
927 dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
928 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
929 downloader.add_option(
930 '-r', '--limit-rate', '--rate-limit',
931 dest='ratelimit', metavar='RATE',
932 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
933 downloader.add_option(
934 '--throttled-rate',
935 dest='throttledratelimit', metavar='RATE',
936 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
937 downloader.add_option(
938 '-R', '--retries',
939 dest='retries', metavar='RETRIES', default=10,
940 help='Number of retries (default is %default), or "infinite"')
941 downloader.add_option(
942 '--file-access-retries',
943 dest='file_access_retries', metavar='RETRIES', default=3,
944 help='Number of times to retry on file access error (default is %default), or "infinite"')
945 downloader.add_option(
946 '--fragment-retries',
947 dest='fragment_retries', metavar='RETRIES', default=10,
948 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
949 downloader.add_option(
950 '--retry-sleep',
951 dest='retry_sleep', metavar='[TYPE:]EXPR', default={}, type='str',
952 action='callback', callback=_dict_from_options_callback,
953 callback_kwargs={
954 'allowed_keys': 'http|fragment|file_access|extractor',
955 'default_key': 'http',
956 }, help=(
957 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
958 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
959 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
960 'This option can be used multiple times to set the sleep for the different retry types, '
961 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
962 downloader.add_option(
963 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
964 action='store_true', dest='skip_unavailable_fragments', default=True,
965 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
966 downloader.add_option(
967 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
968 action='store_false', dest='skip_unavailable_fragments',
969 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
970 downloader.add_option(
971 '--keep-fragments',
972 action='store_true', dest='keep_fragments', default=False,
973 help='Keep downloaded fragments on disk after downloading is finished')
974 downloader.add_option(
975 '--no-keep-fragments',
976 action='store_false', dest='keep_fragments',
977 help='Delete downloaded fragments after downloading is finished (default)')
978 downloader.add_option(
979 '--buffer-size',
980 dest='buffersize', metavar='SIZE', default='1024',
981 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
982 downloader.add_option(
983 '--resize-buffer',
984 action='store_false', dest='noresizebuffer',
985 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
986 downloader.add_option(
987 '--no-resize-buffer',
988 action='store_true', dest='noresizebuffer', default=False,
989 help='Do not automatically adjust the buffer size')
990 downloader.add_option(
991 '--http-chunk-size',
992 dest='http_chunk_size', metavar='SIZE', default=None,
993 help=(
994 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
995 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
996 downloader.add_option(
997 '--test',
998 action='store_true', dest='test', default=False,
999 help=optparse.SUPPRESS_HELP)
1000 downloader.add_option(
1001 '--playlist-reverse',
1002 action='store_true', dest='playlist_reverse',
1003 help=optparse.SUPPRESS_HELP)
1004 downloader.add_option(
1005 '--no-playlist-reverse',
1006 action='store_false', dest='playlist_reverse',
1007 help=optparse.SUPPRESS_HELP)
1008 downloader.add_option(
1009 '--playlist-random',
1010 action='store_true', dest='playlist_random',
1011 help='Download playlist videos in random order')
1012 downloader.add_option(
1013 '--lazy-playlist',
1014 action='store_true', dest='lazy_playlist',
1015 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
1016 downloader.add_option(
1017 '--no-lazy-playlist',
1018 action='store_false', dest='lazy_playlist',
1019 help='Process videos in the playlist only after the entire playlist is parsed (default)')
1020 downloader.add_option(
1021 '--xattr-set-filesize',
1022 dest='xattr_set_filesize', action='store_true',
1023 help='Set file xattribute ytdl.filesize with expected file size')
1024 downloader.add_option(
1025 '--hls-prefer-native',
1026 dest='hls_prefer_native', action='store_true', default=None,
1027 help=optparse.SUPPRESS_HELP)
1028 downloader.add_option(
1029 '--hls-prefer-ffmpeg',
1030 dest='hls_prefer_native', action='store_false', default=None,
1031 help=optparse.SUPPRESS_HELP)
1032 downloader.add_option(
1033 '--hls-use-mpegts',
1034 dest='hls_use_mpegts', action='store_true', default=None,
1035 help=(
1036 'Use the mpegts container for HLS videos; '
1037 'allowing some players to play the video while downloading, '
1038 'and reducing the chance of file corruption if download is interrupted. '
1039 'This is enabled by default for live streams'))
1040 downloader.add_option(
1041 '--no-hls-use-mpegts',
1042 dest='hls_use_mpegts', action='store_false',
1043 help=(
1044 'Do not use the mpegts container for HLS videos. '
1045 'This is default when not downloading live streams'))
1046 downloader.add_option(
1047 '--download-sections',
1048 metavar='REGEX', dest='download_ranges', action='append',
1049 help=(
1050 'Download only chapters that match the regular expression. '
1051 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
1052 '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
1053 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1054 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1055 downloader.add_option(
1056 '--downloader', '--external-downloader',
1057 dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
1058 action='callback', callback=_dict_from_options_callback,
1059 callback_kwargs={
1060 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1061 'default_key': 'default',
1062 'process': str.strip,
1063 }, help=(
1064 'Name or path of the external downloader to use (optionally) prefixed by '
1065 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1066 f'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1067 'You can use this option multiple times to set different downloaders for different protocols. '
1068 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1069 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1070 '(Alias: --external-downloader)'))
1071 downloader.add_option(
1072 '--downloader-args', '--external-downloader-args',
1073 metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
1074 action='callback', callback=_dict_from_options_callback,
1075 callback_kwargs={
1076 'allowed_keys': r'ffmpeg_[io]\d*|{}'.format('|'.join(map(re.escape, list_external_downloaders()))),
1077 'default_key': 'default',
1078 'process': shlex.split,
1079 }, help=(
1080 'Give these arguments to the external downloader. '
1081 'Specify the downloader name and the arguments separated by a colon ":". '
1082 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1083 'You can use this option multiple times to give different arguments to different downloaders '
1084 '(Alias: --external-downloader-args)'))
1086 workarounds = optparse.OptionGroup(parser, 'Workarounds')
1087 workarounds.add_option(
1088 '--encoding',
1089 dest='encoding', metavar='ENCODING',
1090 help='Force the specified encoding (experimental)')
1091 workarounds.add_option(
1092 '--legacy-server-connect',
1093 action='store_true', dest='legacy_server_connect', default=False,
1094 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1095 workarounds.add_option(
1096 '--no-check-certificates',
1097 action='store_true', dest='no_check_certificate', default=False,
1098 help='Suppress HTTPS certificate validation')
1099 workarounds.add_option(
1100 '--prefer-insecure', '--prefer-unsecure',
1101 action='store_true', dest='prefer_insecure',
1102 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1103 workarounds.add_option(
1104 '--user-agent',
1105 metavar='UA', dest='user_agent',
1106 help=optparse.SUPPRESS_HELP)
1107 workarounds.add_option(
1108 '--referer',
1109 metavar='URL', dest='referer', default=None,
1110 help=optparse.SUPPRESS_HELP)
1111 workarounds.add_option(
1112 '--add-headers',
1113 metavar='FIELD:VALUE', dest='headers', default={}, type='str',
1114 action='callback', callback=_dict_from_options_callback,
1115 callback_kwargs={'multiple_keys': False},
1116 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1118 workarounds.add_option(
1119 '--bidi-workaround',
1120 dest='bidi_workaround', action='store_true',
1121 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1122 workarounds.add_option(
1123 '--sleep-requests', metavar='SECONDS',
1124 dest='sleep_interval_requests', type=float,
1125 help='Number of seconds to sleep between requests during data extraction')
1126 workarounds.add_option(
1127 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
1128 dest='sleep_interval', type=float,
1129 help=(
1130 'Number of seconds to sleep before each download. '
1131 'This is the minimum time to sleep when used along with --max-sleep-interval '
1132 '(Alias: --min-sleep-interval)'))
1133 workarounds.add_option(
1134 '--max-sleep-interval', metavar='SECONDS',
1135 dest='max_sleep_interval', type=float,
1136 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1137 workarounds.add_option(
1138 '--sleep-subtitles', metavar='SECONDS',
1139 dest='sleep_interval_subtitles', default=0, type=int,
1140 help='Number of seconds to sleep before each subtitle download')
1142 verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
1143 verbosity.add_option(
1144 '-q', '--quiet',
1145 action='store_true', dest='quiet', default=None,
1146 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1147 verbosity.add_option(
1148 '--no-quiet',
1149 action='store_false', dest='quiet',
1150 help='Deactivate quiet mode. (Default)')
1151 verbosity.add_option(
1152 '--no-warnings',
1153 dest='no_warnings', action='store_true', default=False,
1154 help='Ignore warnings')
1155 verbosity.add_option(
1156 '-s', '--simulate',
1157 action='store_true', dest='simulate', default=None,
1158 help='Do not download the video and do not write anything to disk')
1159 verbosity.add_option(
1160 '--no-simulate',
1161 action='store_false', dest='simulate',
1162 help='Download the video even if printing/listing options are used')
1163 verbosity.add_option(
1164 '--ignore-no-formats-error',
1165 action='store_true', dest='ignore_no_formats_error', default=False,
1166 help=(
1167 'Ignore "No video formats" error. Useful for extracting metadata '
1168 'even if the videos are not actually available for download (experimental)'))
1169 verbosity.add_option(
1170 '--no-ignore-no-formats-error',
1171 action='store_false', dest='ignore_no_formats_error',
1172 help='Throw error when no downloadable video formats are found (default)')
1173 verbosity.add_option(
1174 '--skip-download', '--no-download',
1175 action='store_true', dest='skip_download', default=False,
1176 help='Do not download the video but write all related files (Alias: --no-download)')
1177 verbosity.add_option(
1178 '-O', '--print',
1179 metavar='[WHEN:]TEMPLATE', dest='forceprint', **when_prefix('video'),
1180 help=(
1181 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1182 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1183 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1184 'This option can be used multiple times'))
1185 verbosity.add_option(
1186 '--print-to-file',
1187 metavar='[WHEN:]TEMPLATE FILE', dest='print_to_file', nargs=2, **when_prefix('video'),
1188 help=(
1189 'Append given template to the file. The values of WHEN and TEMPLATE are the same as that of --print. '
1190 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1191 verbosity.add_option(
1192 '-g', '--get-url',
1193 action='store_true', dest='geturl', default=False,
1194 help=optparse.SUPPRESS_HELP)
1195 verbosity.add_option(
1196 '-e', '--get-title',
1197 action='store_true', dest='gettitle', default=False,
1198 help=optparse.SUPPRESS_HELP)
1199 verbosity.add_option(
1200 '--get-id',
1201 action='store_true', dest='getid', default=False,
1202 help=optparse.SUPPRESS_HELP)
1203 verbosity.add_option(
1204 '--get-thumbnail',
1205 action='store_true', dest='getthumbnail', default=False,
1206 help=optparse.SUPPRESS_HELP)
1207 verbosity.add_option(
1208 '--get-description',
1209 action='store_true', dest='getdescription', default=False,
1210 help=optparse.SUPPRESS_HELP)
1211 verbosity.add_option(
1212 '--get-duration',
1213 action='store_true', dest='getduration', default=False,
1214 help=optparse.SUPPRESS_HELP)
1215 verbosity.add_option(
1216 '--get-filename',
1217 action='store_true', dest='getfilename', default=False,
1218 help=optparse.SUPPRESS_HELP)
1219 verbosity.add_option(
1220 '--get-format',
1221 action='store_true', dest='getformat', default=False,
1222 help=optparse.SUPPRESS_HELP)
1223 verbosity.add_option(
1224 '-j', '--dump-json',
1225 action='store_true', dest='dumpjson', default=False,
1226 help=(
1227 'Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. '
1228 'See "OUTPUT TEMPLATE" for a description of available keys'))
1229 verbosity.add_option(
1230 '-J', '--dump-single-json',
1231 action='store_true', dest='dump_single_json', default=False,
1232 help=(
1233 'Quiet, but print JSON information for each URL or infojson passed. Simulate unless --no-simulate is used. '
1234 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1235 verbosity.add_option(
1236 '--print-json',
1237 action='store_true', dest='print_json', default=False,
1238 help=optparse.SUPPRESS_HELP)
1239 verbosity.add_option(
1240 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1241 action='store_true', dest='force_write_download_archive', default=False,
1242 help=(
1243 'Force download archive entries to be written as far as no errors occur, '
1244 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1245 verbosity.add_option(
1246 '--newline',
1247 action='store_true', dest='progress_with_newline', default=False,
1248 help='Output progress bar as new lines')
1249 verbosity.add_option(
1250 '--no-progress',
1251 action='store_true', dest='noprogress', default=None,
1252 help='Do not print progress bar')
1253 verbosity.add_option(
1254 '--progress',
1255 action='store_false', dest='noprogress',
1256 help='Show progress bar, even if in quiet mode')
1257 verbosity.add_option(
1258 '--console-title',
1259 action='store_true', dest='consoletitle', default=False,
1260 help='Display progress in console titlebar')
1261 verbosity.add_option(
1262 '--progress-template',
1263 metavar='[TYPES:]TEMPLATE', dest='progress_template', default={}, type='str',
1264 action='callback', callback=_dict_from_options_callback,
1265 callback_kwargs={
1266 'allowed_keys': '(download|postprocess)(-title)?',
1267 'default_key': 'download',
1268 }, help=(
1269 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1270 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1271 'The video\'s fields are accessible under the "info" key and '
1272 'the progress attributes are accessible under "progress" key. E.g. '
1273 # TODO: Document the fields inside "progress"
1274 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1275 verbosity.add_option(
1276 '--progress-delta',
1277 metavar='SECONDS', action='store', dest='progress_delta', type=float, default=0,
1278 help='Time between progress output (default: 0)')
1279 verbosity.add_option(
1280 '-v', '--verbose',
1281 action='store_true', dest='verbose', default=False,
1282 help='Print various debugging information')
1283 verbosity.add_option(
1284 '--dump-pages', '--dump-intermediate-pages',
1285 action='store_true', dest='dump_intermediate_pages', default=False,
1286 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1287 verbosity.add_option(
1288 '--write-pages',
1289 action='store_true', dest='write_pages', default=False,
1290 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1291 verbosity.add_option(
1292 '--load-pages',
1293 action='store_true', dest='load_pages', default=False,
1294 help=optparse.SUPPRESS_HELP)
1295 verbosity.add_option(
1296 '--youtube-print-sig-code',
1297 action='store_true', dest='youtube_print_sig_code', default=False,
1298 help=optparse.SUPPRESS_HELP)
1299 verbosity.add_option(
1300 '--print-traffic', '--dump-headers',
1301 dest='debug_printtraffic', action='store_true', default=False,
1302 help='Display sent and read HTTP traffic')
1303 verbosity.add_option(
1304 '-C', '--call-home',
1305 dest='call_home', action='store_true', default=False,
1306 # help='Contact the yt-dlp server for debugging')
1307 help=optparse.SUPPRESS_HELP)
1308 verbosity.add_option(
1309 '--no-call-home',
1310 dest='call_home', action='store_false',
1311 # help='Do not contact the yt-dlp server for debugging (default)')
1312 help=optparse.SUPPRESS_HELP)
1314 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
1315 filesystem.add_option(
1316 '-a', '--batch-file',
1317 dest='batchfile', metavar='FILE',
1318 help=(
1319 'File containing URLs to download ("-" for stdin), one URL per line. '
1320 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1321 filesystem.add_option(
1322 '--no-batch-file',
1323 dest='batchfile', action='store_const', const=None,
1324 help='Do not read URLs from batch file (default)')
1325 filesystem.add_option(
1326 '--id', default=False,
1327 action='store_true', dest='useid', help=optparse.SUPPRESS_HELP)
1328 filesystem.add_option(
1329 '-P', '--paths',
1330 metavar='[TYPES:]PATH', dest='paths', default={}, type='str',
1331 action='callback', callback=_dict_from_options_callback,
1332 callback_kwargs={
1333 'allowed_keys': 'home|temp|{}'.format('|'.join(map(re.escape, OUTTMPL_TYPES.keys()))),
1334 'default_key': 'home',
1335 }, help=(
1336 'The paths where the files should be downloaded. '
1337 'Specify the type of file and the path separated by a colon ":". '
1338 'All the same TYPES as --output are supported. '
1339 'Additionally, you can also provide "home" (default) and "temp" paths. '
1340 'All intermediary files are first downloaded to the temp path and '
1341 'then the final files are moved over to the home path after download is finished. '
1342 'This option is ignored if --output is an absolute path'))
1343 filesystem.add_option(
1344 '-o', '--output',
1345 metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
1346 action='callback', callback=_dict_from_options_callback,
1347 callback_kwargs={
1348 'allowed_keys': '|'.join(map(re.escape, OUTTMPL_TYPES.keys())),
1349 'default_key': 'default',
1350 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1351 filesystem.add_option(
1352 '--output-na-placeholder',
1353 dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
1354 help=('Placeholder for unavailable fields in --output (default: "%default")'))
1355 filesystem.add_option(
1356 '--autonumber-size',
1357 dest='autonumber_size', metavar='NUMBER', type=int,
1358 help=optparse.SUPPRESS_HELP)
1359 filesystem.add_option(
1360 '--autonumber-start',
1361 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
1362 help=optparse.SUPPRESS_HELP)
1363 filesystem.add_option(
1364 '--restrict-filenames',
1365 action='store_true', dest='restrictfilenames', default=False,
1366 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1367 filesystem.add_option(
1368 '--no-restrict-filenames',
1369 action='store_false', dest='restrictfilenames',
1370 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1371 filesystem.add_option(
1372 '--windows-filenames',
1373 action='store_true', dest='windowsfilenames', default=False,
1374 help='Force filenames to be Windows-compatible')
1375 filesystem.add_option(
1376 '--no-windows-filenames',
1377 action='store_false', dest='windowsfilenames',
1378 help='Make filenames Windows-compatible only if using Windows (default)')
1379 filesystem.add_option(
1380 '--trim-filenames', '--trim-file-names', metavar='LENGTH',
1381 dest='trim_file_name', default=0, type=int,
1382 help='Limit the filename length (excluding extension) to the specified number of characters')
1383 filesystem.add_option(
1384 '-w', '--no-overwrites',
1385 action='store_false', dest='overwrites', default=None,
1386 help='Do not overwrite any files')
1387 filesystem.add_option(
1388 '--force-overwrites', '--yes-overwrites',
1389 action='store_true', dest='overwrites',
1390 help='Overwrite all video and metadata files. This option includes --no-continue')
1391 filesystem.add_option(
1392 '--no-force-overwrites',
1393 action='store_const', dest='overwrites', const=None,
1394 help='Do not overwrite the video, but overwrite related files (default)')
1395 filesystem.add_option(
1396 '-c', '--continue',
1397 action='store_true', dest='continue_dl', default=True,
1398 help='Resume partially downloaded files/fragments (default)')
1399 filesystem.add_option(
1400 '--no-continue',
1401 action='store_false', dest='continue_dl',
1402 help=(
1403 'Do not resume partially downloaded fragments. '
1404 'If the file is not fragmented, restart download of the entire file'))
1405 filesystem.add_option(
1406 '--part',
1407 action='store_false', dest='nopart', default=False,
1408 help='Use .part files instead of writing directly into output file (default)')
1409 filesystem.add_option(
1410 '--no-part',
1411 action='store_true', dest='nopart',
1412 help='Do not use .part files - write directly into output file')
1413 filesystem.add_option(
1414 '--mtime',
1415 action='store_true', dest='updatetime', default=True,
1416 help='Use the Last-modified header to set the file modification time (default)')
1417 filesystem.add_option(
1418 '--no-mtime',
1419 action='store_false', dest='updatetime',
1420 help='Do not use the Last-modified header to set the file modification time')
1421 filesystem.add_option(
1422 '--write-description',
1423 action='store_true', dest='writedescription', default=False,
1424 help='Write video description to a .description file')
1425 filesystem.add_option(
1426 '--no-write-description',
1427 action='store_false', dest='writedescription',
1428 help='Do not write video description (default)')
1429 filesystem.add_option(
1430 '--write-info-json',
1431 action='store_true', dest='writeinfojson', default=None,
1432 help='Write video metadata to a .info.json file (this may contain personal information)')
1433 filesystem.add_option(
1434 '--no-write-info-json',
1435 action='store_false', dest='writeinfojson',
1436 help='Do not write video metadata (default)')
1437 filesystem.add_option(
1438 '--write-annotations',
1439 action='store_true', dest='writeannotations', default=False,
1440 help=optparse.SUPPRESS_HELP)
1441 filesystem.add_option(
1442 '--no-write-annotations',
1443 action='store_false', dest='writeannotations',
1444 help=optparse.SUPPRESS_HELP)
1445 filesystem.add_option(
1446 '--write-playlist-metafiles',
1447 action='store_true', dest='allow_playlist_files', default=None,
1448 help=(
1449 'Write playlist metadata in addition to the video metadata '
1450 'when using --write-info-json, --write-description etc. (default)'))
1451 filesystem.add_option(
1452 '--no-write-playlist-metafiles',
1453 action='store_false', dest='allow_playlist_files',
1454 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1455 filesystem.add_option(
1456 '--clean-info-json', '--clean-infojson',
1457 action='store_true', dest='clean_infojson', default=None,
1458 help=(
1459 'Remove some internal metadata such as filenames from the infojson (default)'))
1460 filesystem.add_option(
1461 '--no-clean-info-json', '--no-clean-infojson',
1462 action='store_false', dest='clean_infojson',
1463 help='Write all fields to the infojson')
1464 filesystem.add_option(
1465 '--write-comments', '--get-comments',
1466 action='store_true', dest='getcomments', default=False,
1467 help=(
1468 'Retrieve video comments to be placed in the infojson. '
1469 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1470 filesystem.add_option(
1471 '--no-write-comments', '--no-get-comments',
1472 action='store_false', dest='getcomments',
1473 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1474 filesystem.add_option(
1475 '--load-info-json', '--load-info',
1476 dest='load_info_filename', metavar='FILE',
1477 help='JSON file containing the video information (created with the "--write-info-json" option)')
1478 filesystem.add_option(
1479 '--cookies',
1480 dest='cookiefile', metavar='FILE',
1481 help='Netscape formatted file to read cookies from and dump cookie jar in')
1482 filesystem.add_option(
1483 '--no-cookies',
1484 action='store_const', const=None, dest='cookiefile', metavar='FILE',
1485 help='Do not read/dump cookies from/to file (default)')
1486 filesystem.add_option(
1487 '--cookies-from-browser',
1488 dest='cookiesfrombrowser', metavar='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1489 help=(
1490 'The name of the browser to load cookies from. '
1491 f'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1492 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1493 'the name/path of the PROFILE to load cookies from, '
1494 'and the CONTAINER name (if Firefox) ("none" for no container) '
1495 'can be given with their respective separators. '
1496 'By default, all containers of the most recently accessed profile are used. '
1497 f'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1498 filesystem.add_option(
1499 '--no-cookies-from-browser',
1500 action='store_const', const=None, dest='cookiesfrombrowser',
1501 help='Do not load cookies from browser (default)')
1502 filesystem.add_option(
1503 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
1504 help=(
1505 'Location in the filesystem where yt-dlp can store some downloaded information '
1506 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1507 filesystem.add_option(
1508 '--no-cache-dir', action='store_false', dest='cachedir',
1509 help='Disable filesystem caching')
1510 filesystem.add_option(
1511 '--rm-cache-dir',
1512 action='store_true', dest='rm_cachedir',
1513 help='Delete all filesystem cache files')
1515 thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options')
1516 thumbnail.add_option(
1517 '--write-thumbnail',
1518 action='callback', dest='writethumbnail', default=False,
1519 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1520 callback=lambda option, _, __, parser: setattr(
1521 parser.values, option.dest, getattr(parser.values, option.dest) or True),
1522 help='Write thumbnail image to disk')
1523 thumbnail.add_option(
1524 '--no-write-thumbnail',
1525 action='store_false', dest='writethumbnail',
1526 help='Do not write thumbnail image to disk (default)')
1527 thumbnail.add_option(
1528 '--write-all-thumbnails',
1529 action='store_const', dest='writethumbnail', const='all',
1530 help='Write all thumbnail image formats to disk')
1531 thumbnail.add_option(
1532 '--list-thumbnails',
1533 action='store_true', dest='list_thumbnails', default=False,
1534 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1536 link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
1537 link.add_option(
1538 '--write-link',
1539 action='store_true', dest='writelink', default=False,
1540 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1541 link.add_option(
1542 '--write-url-link',
1543 action='store_true', dest='writeurllink', default=False,
1544 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1545 link.add_option(
1546 '--write-webloc-link',
1547 action='store_true', dest='writewebloclink', default=False,
1548 help='Write a .webloc macOS internet shortcut')
1549 link.add_option(
1550 '--write-desktop-link',
1551 action='store_true', dest='writedesktoplink', default=False,
1552 help='Write a .desktop Linux internet shortcut')
1554 postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
1555 postproc.add_option(
1556 '-x', '--extract-audio',
1557 action='store_true', dest='extractaudio', default=False,
1558 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1559 postproc.add_option(
1560 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
1561 help=(
1562 'Format to convert the audio to when -x is used. '
1563 f'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1564 'You can specify multiple rules using similar syntax as --remux-video'))
1565 postproc.add_option(
1566 '--audio-quality', metavar='QUALITY',
1567 dest='audioquality', default='5',
1568 help=(
1569 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1570 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1571 postproc.add_option(
1572 '--remux-video',
1573 metavar='FORMAT', dest='remuxvideo', default=None,
1574 help=(
1575 'Remux the video into another container if necessary '
1576 f'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1577 'If the target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1578 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1579 postproc.add_option(
1580 '--recode-video',
1581 metavar='FORMAT', dest='recodevideo', default=None,
1582 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1583 postproc.add_option(
1584 '--postprocessor-args', '--ppa',
1585 metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
1586 action='callback', callback=_dict_from_options_callback,
1587 callback_kwargs={
1588 'allowed_keys': r'\w+(?:\+\w+)?',
1589 'default_key': 'default-compat',
1590 'process': shlex.split,
1591 'multiple_keys': False,
1592 }, help=(
1593 'Give these arguments to the postprocessors. '
1594 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1595 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1596 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1597 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1598 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1599 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1600 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1601 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1602 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1603 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1604 'You can use this option multiple times to give different arguments to different '
1605 'postprocessors. (Alias: --ppa)'))
1606 postproc.add_option(
1607 '-k', '--keep-video',
1608 action='store_true', dest='keepvideo', default=False,
1609 help='Keep the intermediate video file on disk after post-processing')
1610 postproc.add_option(
1611 '--no-keep-video',
1612 action='store_false', dest='keepvideo',
1613 help='Delete the intermediate video file after post-processing (default)')
1614 postproc.add_option(
1615 '--post-overwrites',
1616 action='store_false', dest='nopostoverwrites',
1617 help='Overwrite post-processed files (default)')
1618 postproc.add_option(
1619 '--no-post-overwrites',
1620 action='store_true', dest='nopostoverwrites', default=False,
1621 help='Do not overwrite post-processed files')
1622 postproc.add_option(
1623 '--embed-subs',
1624 action='store_true', dest='embedsubtitles', default=False,
1625 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1626 postproc.add_option(
1627 '--no-embed-subs',
1628 action='store_false', dest='embedsubtitles',
1629 help='Do not embed subtitles (default)')
1630 postproc.add_option(
1631 '--embed-thumbnail',
1632 action='store_true', dest='embedthumbnail', default=False,
1633 help='Embed thumbnail in the video as cover art')
1634 postproc.add_option(
1635 '--no-embed-thumbnail',
1636 action='store_false', dest='embedthumbnail',
1637 help='Do not embed thumbnail (default)')
1638 postproc.add_option(
1639 '--embed-metadata', '--add-metadata',
1640 action='store_true', dest='addmetadata', default=False,
1641 help=(
1642 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1643 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1644 postproc.add_option(
1645 '--no-embed-metadata', '--no-add-metadata',
1646 action='store_false', dest='addmetadata',
1647 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1648 postproc.add_option(
1649 '--embed-chapters', '--add-chapters',
1650 action='store_true', dest='addchapters', default=None,
1651 help='Add chapter markers to the video file (Alias: --add-chapters)')
1652 postproc.add_option(
1653 '--no-embed-chapters', '--no-add-chapters',
1654 action='store_false', dest='addchapters',
1655 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1656 postproc.add_option(
1657 '--embed-info-json',
1658 action='store_true', dest='embed_infojson', default=None,
1659 help='Embed the infojson as an attachment to mkv/mka video files')
1660 postproc.add_option(
1661 '--no-embed-info-json',
1662 action='store_false', dest='embed_infojson',
1663 help='Do not embed the infojson as an attachment to the video file')
1664 postproc.add_option(
1665 '--metadata-from-title',
1666 metavar='FORMAT', dest='metafromtitle',
1667 help=optparse.SUPPRESS_HELP)
1668 postproc.add_option(
1669 '--parse-metadata',
1670 metavar='[WHEN:]FROM:TO', dest='parse_metadata', **when_prefix('pre_process'),
1671 help=(
1672 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1673 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1674 postproc.add_option(
1675 '--replace-in-metadata',
1676 dest='parse_metadata', metavar='[WHEN:]FIELDS REGEX REPLACE', nargs=3, **when_prefix('pre_process'),
1677 help=(
1678 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1679 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1680 postproc.add_option(
1681 '--xattrs', '--xattr',
1682 action='store_true', dest='xattrs', default=False,
1683 help='Write metadata to the video file\'s xattrs (using Dublin Core and XDG standards)')
1684 postproc.add_option(
1685 '--concat-playlist',
1686 metavar='POLICY', dest='concat_playlist', default='multi_video',
1687 choices=('never', 'always', 'multi_video'),
1688 help=(
1689 'Concatenate videos in a playlist. One of "never", "always", or '
1690 '"multi_video" (default; only when the videos form a single show). '
1691 'All the video files must have the same codecs and number of streams to be concatenable. '
1692 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1693 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1694 postproc.add_option(
1695 '--fixup',
1696 metavar='POLICY', dest='fixup', default=None,
1697 choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1698 help=(
1699 'Automatically correct known faults of the file. '
1700 'One of never (do nothing), warn (only emit a warning), '
1701 'detect_or_warn (the default; fix the file if we can, warn otherwise), '
1702 'force (try fixing even if the file already exists)'))
1703 postproc.add_option(
1704 '--prefer-avconv', '--no-prefer-ffmpeg',
1705 action='store_false', dest='prefer_ffmpeg',
1706 help=optparse.SUPPRESS_HELP)
1707 postproc.add_option(
1708 '--prefer-ffmpeg', '--no-prefer-avconv',
1709 action='store_true', dest='prefer_ffmpeg', default=True,
1710 help=optparse.SUPPRESS_HELP)
1711 postproc.add_option(
1712 '--ffmpeg-location', '--avconv-location', metavar='PATH',
1713 dest='ffmpeg_location',
1714 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1715 postproc.add_option(
1716 '--exec',
1717 metavar='[WHEN:]CMD', dest='exec_cmd', **when_prefix('after_move'),
1718 help=(
1719 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1720 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1721 'The same syntax as the output template can be used to pass any field as arguments to the command. '
1722 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1723 'This option can be used multiple times'))
1724 postproc.add_option(
1725 '--no-exec',
1726 action='store_const', dest='exec_cmd', const={},
1727 help='Remove any previously defined --exec')
1728 postproc.add_option(
1729 '--exec-before-download', metavar='CMD',
1730 action='append', dest='exec_before_dl_cmd',
1731 help=optparse.SUPPRESS_HELP)
1732 postproc.add_option(
1733 '--no-exec-before-download',
1734 action='store_const', dest='exec_before_dl_cmd', const=None,
1735 help=optparse.SUPPRESS_HELP)
1736 postproc.add_option(
1737 '--convert-subs', '--convert-sub', '--convert-subtitles',
1738 metavar='FORMAT', dest='convertsubtitles', default=None,
1739 help=(
1740 'Convert the subtitles to another format '
1741 f'(currently supported: {", ".join(sorted(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS))}). '
1742 'Use "--convert-subs none" to disable conversion (default) (Alias: --convert-subtitles)'))
1743 postproc.add_option(
1744 '--convert-thumbnails',
1745 metavar='FORMAT', dest='convertthumbnails', default=None,
1746 help=(
1747 'Convert the thumbnails to another format '
1748 f'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1749 'You can specify multiple rules using similar syntax as "--remux-video". '
1750 'Use "--convert-thumbnails none" to disable conversion (default)'))
1751 postproc.add_option(
1752 '--split-chapters', '--split-tracks',
1753 dest='split_chapters', action='store_true', default=False,
1754 help=(
1755 'Split video into multiple files based on internal chapters. '
1756 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1757 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1758 postproc.add_option(
1759 '--no-split-chapters', '--no-split-tracks',
1760 dest='split_chapters', action='store_false',
1761 help='Do not split video based on chapters (default)')
1762 postproc.add_option(
1763 '--remove-chapters',
1764 metavar='REGEX', dest='remove_chapters', action='append',
1765 help=(
1766 'Remove chapters whose title matches the given regular expression. '
1767 'The syntax is the same as --download-sections. This option can be used multiple times'))
1768 postproc.add_option(
1769 '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None,
1770 help='Do not remove any chapters from the file (default)')
1771 postproc.add_option(
1772 '--force-keyframes-at-cuts',
1773 action='store_true', dest='force_keyframes_at_cuts', default=False,
1774 help=(
1775 'Force keyframes at cuts when downloading/splitting/removing sections. '
1776 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1777 postproc.add_option(
1778 '--no-force-keyframes-at-cuts',
1779 action='store_false', dest='force_keyframes_at_cuts',
1780 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1781 _postprocessor_opts_parser = lambda key, val='': (
1782 *(item.split('=', 1) for item in (val.split(';') if val else [])),
1783 ('key', remove_end(key, 'PP')))
1784 postproc.add_option(
1785 '--use-postprocessor',
1786 metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str',
1787 action='callback', callback=_list_from_options_callback,
1788 callback_kwargs={
1789 'delim': None,
1790 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1))),
1791 }, help=(
1792 'The (case-sensitive) name of plugin postprocessors to be enabled, '
1793 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1794 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1795 'The "when" argument determines when the postprocessor is invoked. '
1796 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1797 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1798 '"post_process" (after each video download; default), '
1799 '"after_move" (after moving the video file to its final location), '
1800 '"after_video" (after downloading and processing all formats of a video), '
1801 'or "playlist" (at end of playlist). '
1802 'This option can be used multiple times to add different postprocessors'))
1804 sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=(
1805 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1806 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1807 sponsorblock.add_option(
1808 '--sponsorblock-mark', metavar='CATS',
1809 dest='sponsorblock_mark', default=set(), action='callback', type='str',
1810 callback=_set_from_options_callback, callback_kwargs={
1811 'allowed_values': SponsorBlockPP.CATEGORIES.keys(),
1812 'aliases': {'default': ['all']},
1813 }, help=(
1814 'SponsorBlock categories to create chapters for, separated by commas. '
1815 f'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1816 'You can prefix the category with a "-" to exclude it. See [1] for descriptions of the categories. '
1817 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1818 sponsorblock.add_option(
1819 '--sponsorblock-remove', metavar='CATS',
1820 dest='sponsorblock_remove', default=set(), action='callback', type='str',
1821 callback=_set_from_options_callback, callback_kwargs={
1822 'allowed_values': set(SponsorBlockPP.CATEGORIES.keys()) - set(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys()),
1823 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1824 # The filler category is very aggressive.
1825 # It is strongly recommended to not use this in a client by default.
1826 'aliases': {'default': ['all', '-filler']},
1827 }, help=(
1828 'SponsorBlock categories to be removed from the video file, separated by commas. '
1829 'If a category is present in both mark and remove, remove takes precedence. '
1830 'The syntax and available categories are the same as for --sponsorblock-mark '
1831 'except that "default" refers to "all,-filler" '
1832 f'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1833 sponsorblock.add_option(
1834 '--sponsorblock-chapter-title', metavar='TEMPLATE',
1835 default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title',
1836 help=(
1837 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1838 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1839 'Defaults to "%default"'))
1840 sponsorblock.add_option(
1841 '--no-sponsorblock', default=False,
1842 action='store_true', dest='no_sponsorblock',
1843 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1844 sponsorblock.add_option(
1845 '--sponsorblock-api', metavar='URL',
1846 default='https://sponsor.ajay.app', dest='sponsorblock_api',
1847 help='SponsorBlock API location, defaults to %default')
1849 sponsorblock.add_option(
1850 '--sponskrub',
1851 action='store_true', dest='sponskrub', default=False,
1852 help=optparse.SUPPRESS_HELP)
1853 sponsorblock.add_option(
1854 '--no-sponskrub',
1855 action='store_false', dest='sponskrub',
1856 help=optparse.SUPPRESS_HELP)
1857 sponsorblock.add_option(
1858 '--sponskrub-cut', default=False,
1859 action='store_true', dest='sponskrub_cut',
1860 help=optparse.SUPPRESS_HELP)
1861 sponsorblock.add_option(
1862 '--no-sponskrub-cut',
1863 action='store_false', dest='sponskrub_cut',
1864 help=optparse.SUPPRESS_HELP)
1865 sponsorblock.add_option(
1866 '--sponskrub-force', default=False,
1867 action='store_true', dest='sponskrub_force',
1868 help=optparse.SUPPRESS_HELP)
1869 sponsorblock.add_option(
1870 '--no-sponskrub-force',
1871 action='store_true', dest='sponskrub_force',
1872 help=optparse.SUPPRESS_HELP)
1873 sponsorblock.add_option(
1874 '--sponskrub-location', metavar='PATH',
1875 dest='sponskrub_path', default='',
1876 help=optparse.SUPPRESS_HELP)
1877 sponsorblock.add_option(
1878 '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
1879 help=optparse.SUPPRESS_HELP)
1881 extractor = optparse.OptionGroup(parser, 'Extractor Options')
1882 extractor.add_option(
1883 '--extractor-retries',
1884 dest='extractor_retries', metavar='RETRIES', default=3,
1885 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1886 extractor.add_option(
1887 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1888 action='store_true', dest='dynamic_mpd', default=True,
1889 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1890 extractor.add_option(
1891 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1892 action='store_false', dest='dynamic_mpd',
1893 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1894 extractor.add_option(
1895 '--hls-split-discontinuity',
1896 dest='hls_split_discontinuity', action='store_true', default=False,
1897 help='Split HLS playlists to different formats at discontinuities such as ad breaks',
1899 extractor.add_option(
1900 '--no-hls-split-discontinuity',
1901 dest='hls_split_discontinuity', action='store_false',
1902 help='Do not split HLS playlists into different formats at discontinuities such as ad breaks (default)')
1903 _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [
1904 val.replace(r'\,', ',').strip() for val in re.split(r'(?<!\\),', vals)])
1905 extractor.add_option(
1906 '--extractor-args',
1907 metavar='IE_KEY:ARGS', dest='extractor_args', default={}, type='str',
1908 action='callback', callback=_dict_from_options_callback,
1909 callback_kwargs={
1910 'multiple_keys': False,
1911 'process': lambda val: dict(
1912 _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';')),
1913 }, help=(
1914 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1915 'You can use this option multiple times to give arguments for different extractors'))
1916 extractor.add_option(
1917 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1918 action='store_true', dest='youtube_include_dash_manifest', default=True,
1919 help=optparse.SUPPRESS_HELP)
1920 extractor.add_option(
1921 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1922 action='store_false', dest='youtube_include_dash_manifest',
1923 help=optparse.SUPPRESS_HELP)
1924 extractor.add_option(
1925 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1926 action='store_true', dest='youtube_include_hls_manifest', default=True,
1927 help=optparse.SUPPRESS_HELP)
1928 extractor.add_option(
1929 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1930 action='store_false', dest='youtube_include_hls_manifest',
1931 help=optparse.SUPPRESS_HELP)
1933 parser.add_option_group(general)
1934 parser.add_option_group(network)
1935 parser.add_option_group(geo)
1936 parser.add_option_group(selection)
1937 parser.add_option_group(downloader)
1938 parser.add_option_group(filesystem)
1939 parser.add_option_group(thumbnail)
1940 parser.add_option_group(link)
1941 parser.add_option_group(verbosity)
1942 parser.add_option_group(workarounds)
1943 parser.add_option_group(video_format)
1944 parser.add_option_group(subtitles)
1945 parser.add_option_group(authentication)
1946 parser.add_option_group(postproc)
1947 parser.add_option_group(sponsorblock)
1948 parser.add_option_group(extractor)
1950 return parser
1953 def _hide_login_info(opts):
1954 deprecation_warning(f'"{__name__}._hide_login_info" is deprecated and may be removed '
1955 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1956 return Config.hide_login_info(opts)