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