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