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