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