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