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