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