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