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