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