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