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