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