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