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