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