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