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