]>
Commit | Line | Data |
---|---|---|
1 | from __future__ import unicode_literals | |
2 | ||
3 | import os.path | |
4 | import optparse | |
5 | import re | |
6 | import sys | |
7 | ||
8 | from .compat import ( | |
9 | compat_expanduser, | |
10 | compat_get_terminal_size, | |
11 | compat_getenv, | |
12 | compat_kwargs, | |
13 | compat_shlex_split, | |
14 | ) | |
15 | from .utils import ( | |
16 | expand_path, | |
17 | get_executable_path, | |
18 | OUTTMPL_TYPES, | |
19 | preferredencoding, | |
20 | remove_end, | |
21 | write_string, | |
22 | ) | |
23 | from .cookies import SUPPORTED_BROWSERS | |
24 | from .version import __version__ | |
25 | ||
26 | from .downloader.external import list_external_downloaders | |
27 | from .postprocessor import ( | |
28 | FFmpegExtractAudioPP, | |
29 | FFmpegSubtitlesConvertorPP, | |
30 | FFmpegThumbnailsConvertorPP, | |
31 | FFmpegVideoRemuxerPP, | |
32 | SponsorBlockPP, | |
33 | ) | |
34 | from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE | |
35 | ||
36 | ||
37 | def _hide_login_info(opts): | |
38 | PRIVATE_OPTS = set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username']) | |
39 | eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$') | |
40 | ||
41 | def _scrub_eq(o): | |
42 | m = eqre.match(o) | |
43 | if m: | |
44 | return m.group('key') + '=PRIVATE' | |
45 | else: | |
46 | return o | |
47 | ||
48 | opts = list(map(_scrub_eq, opts)) | |
49 | for idx, opt in enumerate(opts): | |
50 | if opt in PRIVATE_OPTS and idx + 1 < len(opts): | |
51 | opts[idx + 1] = 'PRIVATE' | |
52 | return opts | |
53 | ||
54 | ||
55 | def parseOpts(overrideArguments=None): | |
56 | def _readOptions(filename_bytes, default=[]): | |
57 | try: | |
58 | optionf = open(filename_bytes) | |
59 | except IOError: | |
60 | return default # silently skip if file is not present | |
61 | try: | |
62 | # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56 | |
63 | contents = optionf.read() | |
64 | if sys.version_info < (3,): | |
65 | contents = contents.decode(preferredencoding()) | |
66 | res = compat_shlex_split(contents, comments=True) | |
67 | finally: | |
68 | optionf.close() | |
69 | return res | |
70 | ||
71 | def _readUserConf(package_name, default=[]): | |
72 | # .config | |
73 | xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config') | |
74 | userConfFile = os.path.join(xdg_config_home, package_name, 'config') | |
75 | if not os.path.isfile(userConfFile): | |
76 | userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name) | |
77 | userConf = _readOptions(userConfFile, default=None) | |
78 | if userConf is not None: | |
79 | return userConf, userConfFile | |
80 | ||
81 | # appdata | |
82 | appdata_dir = compat_getenv('appdata') | |
83 | if appdata_dir: | |
84 | userConfFile = os.path.join(appdata_dir, package_name, 'config') | |
85 | userConf = _readOptions(userConfFile, default=None) | |
86 | if userConf is None: | |
87 | userConfFile += '.txt' | |
88 | userConf = _readOptions(userConfFile, default=None) | |
89 | if userConf is not None: | |
90 | return userConf, userConfFile | |
91 | ||
92 | # home | |
93 | userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name) | |
94 | userConf = _readOptions(userConfFile, default=None) | |
95 | if userConf is None: | |
96 | userConfFile += '.txt' | |
97 | userConf = _readOptions(userConfFile, default=None) | |
98 | if userConf is not None: | |
99 | return userConf, userConfFile | |
100 | ||
101 | return default, None | |
102 | ||
103 | def _format_option_string(option): | |
104 | ''' ('-o', '--option') -> -o, --format METAVAR''' | |
105 | ||
106 | opts = [] | |
107 | ||
108 | if option._short_opts: | |
109 | opts.append(option._short_opts[0]) | |
110 | if option._long_opts: | |
111 | opts.append(option._long_opts[0]) | |
112 | if len(opts) > 1: | |
113 | opts.insert(1, ', ') | |
114 | ||
115 | if option.takes_value(): | |
116 | opts.append(' %s' % option.metavar) | |
117 | ||
118 | return ''.join(opts) | |
119 | ||
120 | def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip): | |
121 | # append can be True, False or -1 (prepend) | |
122 | current = getattr(parser.values, option.dest) if append else [] | |
123 | value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim)))) | |
124 | setattr( | |
125 | parser.values, option.dest, | |
126 | current + value if append is True else value + current) | |
127 | ||
128 | def _set_from_options_callback( | |
129 | option, opt_str, value, parser, delim=',', allowed_values=None, aliases={}, | |
130 | process=lambda x: x.lower().strip()): | |
131 | current = getattr(parser.values, option.dest) | |
132 | values = [process(value)] if delim is None else list(map(process, value.split(delim)[::-1])) | |
133 | while values: | |
134 | actual_val = val = values.pop() | |
135 | if val == 'all': | |
136 | current.update(allowed_values) | |
137 | elif val == '-all': | |
138 | current = set() | |
139 | elif val in aliases: | |
140 | values.extend(aliases[val]) | |
141 | else: | |
142 | if val[0] == '-': | |
143 | val = val[1:] | |
144 | current.discard(val) | |
145 | else: | |
146 | current.update([val]) | |
147 | if allowed_values is not None and val not in allowed_values: | |
148 | raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {actual_val}') | |
149 | ||
150 | setattr(parser.values, option.dest, current) | |
151 | ||
152 | def _dict_from_options_callback( | |
153 | option, opt_str, value, parser, | |
154 | allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True): | |
155 | ||
156 | out_dict = getattr(parser.values, option.dest) | |
157 | if multiple_keys: | |
158 | allowed_keys = r'(%s)(,(%s))*' % (allowed_keys, allowed_keys) | |
159 | mobj = re.match(r'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value) | |
160 | if mobj is not None: | |
161 | keys = [k.strip() for k in mobj.group('keys').lower().split(',')] | |
162 | val = mobj.group('val') | |
163 | elif default_key is not None: | |
164 | keys, val = [default_key], value | |
165 | else: | |
166 | raise optparse.OptionValueError( | |
167 | 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value)) | |
168 | try: | |
169 | val = process(val) if process else val | |
170 | except Exception as err: | |
171 | raise optparse.OptionValueError( | |
172 | 'wrong %s formatting; %s' % (opt_str, err)) | |
173 | for key in keys: | |
174 | out_dict[key] = val | |
175 | ||
176 | # No need to wrap help messages if we're on a wide console | |
177 | columns = compat_get_terminal_size().columns | |
178 | max_width = columns if columns else 80 | |
179 | # 47% is chosen because that is how README.md is currently formatted | |
180 | # and moving help text even further to the right is undesirable. | |
181 | # This can be reduced in the future to get a prettier output | |
182 | max_help_position = int(0.47 * max_width) | |
183 | ||
184 | fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position) | |
185 | fmt.format_option_strings = _format_option_string | |
186 | ||
187 | kw = { | |
188 | 'version': __version__, | |
189 | 'formatter': fmt, | |
190 | 'usage': '%prog [OPTIONS] URL [URL...]', | |
191 | 'conflict_handler': 'resolve', | |
192 | } | |
193 | ||
194 | parser = optparse.OptionParser(**compat_kwargs(kw)) | |
195 | ||
196 | general = optparse.OptionGroup(parser, 'General Options') | |
197 | general.add_option( | |
198 | '-h', '--help', | |
199 | action='help', | |
200 | help='Print this help text and exit') | |
201 | general.add_option( | |
202 | '--version', | |
203 | action='version', | |
204 | help='Print program version and exit') | |
205 | general.add_option( | |
206 | '-U', '--update', | |
207 | action='store_true', dest='update_self', | |
208 | help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)') | |
209 | general.add_option( | |
210 | '-i', '--ignore-errors', | |
211 | action='store_true', dest='ignoreerrors', | |
212 | help='Ignore download and postprocessing errors. The download will be considered successfull even if the postprocessing fails') | |
213 | general.add_option( | |
214 | '--no-abort-on-error', | |
215 | action='store_const', dest='ignoreerrors', const='only_download', | |
216 | help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)') | |
217 | general.add_option( | |
218 | '--abort-on-error', '--no-ignore-errors', | |
219 | action='store_false', dest='ignoreerrors', | |
220 | help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)') | |
221 | general.add_option( | |
222 | '--dump-user-agent', | |
223 | action='store_true', dest='dump_user_agent', default=False, | |
224 | help='Display the current user-agent and exit') | |
225 | general.add_option( | |
226 | '--list-extractors', | |
227 | action='store_true', dest='list_extractors', default=False, | |
228 | help='List all supported extractors and exit') | |
229 | general.add_option( | |
230 | '--extractor-descriptions', | |
231 | action='store_true', dest='list_extractor_descriptions', default=False, | |
232 | help='Output descriptions of all supported extractors and exit') | |
233 | general.add_option( | |
234 | '--force-generic-extractor', | |
235 | action='store_true', dest='force_generic_extractor', default=False, | |
236 | help='Force extraction to use the generic extractor') | |
237 | general.add_option( | |
238 | '--default-search', | |
239 | dest='default_search', metavar='PREFIX', | |
240 | help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for the search term "large apple". Use the value "auto" to let yt-dlp 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') | |
241 | general.add_option( | |
242 | '--ignore-config', '--no-config', | |
243 | action='store_true', dest='ignoreconfig', | |
244 | help=( | |
245 | 'Disable loading any configuration files except the one provided by --config-location. ' | |
246 | 'When given inside a configuration file, no further configuration files are loaded. ' | |
247 | 'Additionally, (for backward compatibility) if this option is found inside the ' | |
248 | 'system configuration file, the user configuration is not loaded')) | |
249 | general.add_option( | |
250 | '--config-location', | |
251 | dest='config_location', metavar='PATH', | |
252 | help='Location of the main configuration file; either the path to the config or its containing directory') | |
253 | general.add_option( | |
254 | '--flat-playlist', | |
255 | action='store_const', dest='extract_flat', const='in_playlist', default=False, | |
256 | help='Do not extract the videos of a playlist, only list them') | |
257 | general.add_option( | |
258 | '--no-flat-playlist', | |
259 | action='store_false', dest='extract_flat', | |
260 | help='Extract the videos of a playlist') | |
261 | general.add_option( | |
262 | '--mark-watched', | |
263 | action='store_true', dest='mark_watched', default=False, | |
264 | help='Mark videos watched (YouTube only)') | |
265 | general.add_option( | |
266 | '--no-mark-watched', | |
267 | action='store_false', dest='mark_watched', | |
268 | help='Do not mark videos watched (default)') | |
269 | general.add_option( | |
270 | '--no-colors', | |
271 | action='store_true', dest='no_color', default=False, | |
272 | help='Do not emit color codes in output') | |
273 | general.add_option( | |
274 | '--compat-options', | |
275 | metavar='OPTS', dest='compat_opts', default=set(), type='str', | |
276 | action='callback', callback=_set_from_options_callback, | |
277 | callback_kwargs={ | |
278 | 'allowed_values': { | |
279 | 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles', | |
280 | 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', | |
281 | 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', | |
282 | 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', | |
283 | }, 'aliases': { | |
284 | 'youtube-dl': ['-multistreams', 'all'], | |
285 | 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'], | |
286 | } | |
287 | }, help=( | |
288 | 'Options that can help keep compatibility with youtube-dl or youtube-dlc ' | |
289 | 'configurations by reverting some of the changes made in yt-dlp. ' | |
290 | 'See "Differences in default behavior" for details')) | |
291 | ||
292 | network = optparse.OptionGroup(parser, 'Network Options') | |
293 | network.add_option( | |
294 | '--proxy', dest='proxy', | |
295 | default=None, metavar='URL', | |
296 | help=( | |
297 | 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable ' | |
298 | 'SOCKS proxy, specify a proper scheme. For example ' | |
299 | 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") ' | |
300 | 'for direct connection')) | |
301 | network.add_option( | |
302 | '--socket-timeout', | |
303 | dest='socket_timeout', type=float, default=None, metavar='SECONDS', | |
304 | help='Time to wait before giving up, in seconds') | |
305 | network.add_option( | |
306 | '--source-address', | |
307 | metavar='IP', dest='source_address', default=None, | |
308 | help='Client-side IP address to bind to', | |
309 | ) | |
310 | network.add_option( | |
311 | '-4', '--force-ipv4', | |
312 | action='store_const', const='0.0.0.0', dest='source_address', | |
313 | help='Make all connections via IPv4', | |
314 | ) | |
315 | network.add_option( | |
316 | '-6', '--force-ipv6', | |
317 | action='store_const', const='::', dest='source_address', | |
318 | help='Make all connections via IPv6', | |
319 | ) | |
320 | ||
321 | geo = optparse.OptionGroup(parser, 'Geo-restriction') | |
322 | geo.add_option( | |
323 | '--geo-verification-proxy', | |
324 | dest='geo_verification_proxy', default=None, metavar='URL', | |
325 | help=( | |
326 | 'Use this proxy to verify the IP address for some geo-restricted sites. ' | |
327 | 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading')) | |
328 | geo.add_option( | |
329 | '--cn-verification-proxy', | |
330 | dest='cn_verification_proxy', default=None, metavar='URL', | |
331 | help=optparse.SUPPRESS_HELP) | |
332 | geo.add_option( | |
333 | '--geo-bypass', | |
334 | action='store_true', dest='geo_bypass', default=True, | |
335 | help='Bypass geographic restriction via faking X-Forwarded-For HTTP header') | |
336 | geo.add_option( | |
337 | '--no-geo-bypass', | |
338 | action='store_false', dest='geo_bypass', default=True, | |
339 | help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header') | |
340 | geo.add_option( | |
341 | '--geo-bypass-country', metavar='CODE', | |
342 | dest='geo_bypass_country', default=None, | |
343 | help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code') | |
344 | geo.add_option( | |
345 | '--geo-bypass-ip-block', metavar='IP_BLOCK', | |
346 | dest='geo_bypass_ip_block', default=None, | |
347 | help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation') | |
348 | ||
349 | selection = optparse.OptionGroup(parser, 'Video Selection') | |
350 | selection.add_option( | |
351 | '--playlist-start', | |
352 | dest='playliststart', metavar='NUMBER', default=1, type=int, | |
353 | help='Playlist video to start at (default is %default)') | |
354 | selection.add_option( | |
355 | '--playlist-end', | |
356 | dest='playlistend', metavar='NUMBER', default=None, type=int, | |
357 | help='Playlist video to end at (default is last)') | |
358 | selection.add_option( | |
359 | '--playlist-items', | |
360 | dest='playlist_items', metavar='ITEM_SPEC', default=None, | |
361 | 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') | |
362 | selection.add_option( | |
363 | '--match-title', | |
364 | dest='matchtitle', metavar='REGEX', | |
365 | help=optparse.SUPPRESS_HELP) | |
366 | selection.add_option( | |
367 | '--reject-title', | |
368 | dest='rejecttitle', metavar='REGEX', | |
369 | help=optparse.SUPPRESS_HELP) | |
370 | selection.add_option( | |
371 | '--max-downloads', | |
372 | dest='max_downloads', metavar='NUMBER', type=int, default=None, | |
373 | help='Abort after downloading NUMBER files') | |
374 | selection.add_option( | |
375 | '--min-filesize', | |
376 | metavar='SIZE', dest='min_filesize', default=None, | |
377 | help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)') | |
378 | selection.add_option( | |
379 | '--max-filesize', | |
380 | metavar='SIZE', dest='max_filesize', default=None, | |
381 | help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)') | |
382 | selection.add_option( | |
383 | '--date', | |
384 | metavar='DATE', dest='date', default=None, | |
385 | help=( | |
386 | 'Download only videos uploaded in this date. ' | |
387 | 'The date can be "YYYYMMDD" or in the format ' | |
388 | '"(now|today)[+-][0-9](day|week|month|year)(s)?"')) | |
389 | selection.add_option( | |
390 | '--datebefore', | |
391 | metavar='DATE', dest='datebefore', default=None, | |
392 | help=( | |
393 | 'Download only videos uploaded on or before this date. ' | |
394 | 'The date formats accepted is the same as --date')) | |
395 | selection.add_option( | |
396 | '--dateafter', | |
397 | metavar='DATE', dest='dateafter', default=None, | |
398 | help=( | |
399 | 'Download only videos uploaded on or after this date. ' | |
400 | 'The date formats accepted is the same as --date')) | |
401 | selection.add_option( | |
402 | '--min-views', | |
403 | metavar='COUNT', dest='min_views', default=None, type=int, | |
404 | help=optparse.SUPPRESS_HELP) | |
405 | selection.add_option( | |
406 | '--max-views', | |
407 | metavar='COUNT', dest='max_views', default=None, type=int, | |
408 | help=optparse.SUPPRESS_HELP) | |
409 | selection.add_option( | |
410 | '--match-filter', | |
411 | metavar='FILTER', dest='match_filter', default=None, | |
412 | help=( | |
413 | 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a ' | |
414 | 'number or a string using the operators defined in "Filtering formats". ' | |
415 | 'You can also simply specify a field to match if the field is present ' | |
416 | 'and "!field" to check if the field is not present. In addition, ' | |
417 | 'Python style regular expression matching can be done using "~=", ' | |
418 | 'and multiple filters can be checked with "&". ' | |
419 | 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter ' | |
420 | '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" ' | |
421 | 'matches only videos that are not live, has a like count more than 100 ' | |
422 | '(or the like field is not available), and also has a description ' | |
423 | 'that contains the phrase "cats & dogs" (ignoring case)')) | |
424 | selection.add_option( | |
425 | '--no-match-filter', | |
426 | metavar='FILTER', dest='match_filter', action='store_const', const=None, | |
427 | help='Do not use generic video filter (default)') | |
428 | selection.add_option( | |
429 | '--no-playlist', | |
430 | action='store_true', dest='noplaylist', default=False, | |
431 | help='Download only the video, if the URL refers to a video and a playlist') | |
432 | selection.add_option( | |
433 | '--yes-playlist', | |
434 | action='store_false', dest='noplaylist', | |
435 | help='Download the playlist, if the URL refers to a video and a playlist') | |
436 | selection.add_option( | |
437 | '--age-limit', | |
438 | metavar='YEARS', dest='age_limit', default=None, type=int, | |
439 | help='Download only videos suitable for the given age') | |
440 | selection.add_option( | |
441 | '--download-archive', metavar='FILE', | |
442 | dest='download_archive', | |
443 | help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it') | |
444 | selection.add_option( | |
445 | '--break-on-existing', | |
446 | action='store_true', dest='break_on_existing', default=False, | |
447 | help='Stop the download process when encountering a file that is in the archive') | |
448 | selection.add_option( | |
449 | '--break-on-reject', | |
450 | action='store_true', dest='break_on_reject', default=False, | |
451 | help='Stop the download process when encountering a file that has been filtered out') | |
452 | selection.add_option( | |
453 | '--skip-playlist-after-errors', metavar='N', | |
454 | dest='skip_playlist_after_errors', default=None, type=int, | |
455 | help='Number of allowed failures until the rest of the playlist is skipped') | |
456 | selection.add_option( | |
457 | '--no-download-archive', | |
458 | dest='download_archive', action="store_const", const=None, | |
459 | help='Do not use archive file (default)') | |
460 | selection.add_option( | |
461 | '--include-ads', | |
462 | dest='include_ads', action='store_true', | |
463 | help=optparse.SUPPRESS_HELP) | |
464 | selection.add_option( | |
465 | '--no-include-ads', | |
466 | dest='include_ads', action='store_false', | |
467 | help=optparse.SUPPRESS_HELP) | |
468 | ||
469 | authentication = optparse.OptionGroup(parser, 'Authentication Options') | |
470 | authentication.add_option( | |
471 | '-u', '--username', | |
472 | dest='username', metavar='USERNAME', | |
473 | help='Login with this account ID') | |
474 | authentication.add_option( | |
475 | '-p', '--password', | |
476 | dest='password', metavar='PASSWORD', | |
477 | help='Account password. If this option is left out, yt-dlp will ask interactively') | |
478 | authentication.add_option( | |
479 | '-2', '--twofactor', | |
480 | dest='twofactor', metavar='TWOFACTOR', | |
481 | help='Two-factor authentication code') | |
482 | authentication.add_option( | |
483 | '-n', '--netrc', | |
484 | action='store_true', dest='usenetrc', default=False, | |
485 | help='Use .netrc authentication data') | |
486 | authentication.add_option( | |
487 | '--netrc-location', | |
488 | dest='netrc_location', metavar='PATH', | |
489 | help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc') | |
490 | authentication.add_option( | |
491 | '--video-password', | |
492 | dest='videopassword', metavar='PASSWORD', | |
493 | help='Video password (vimeo, youku)') | |
494 | authentication.add_option( | |
495 | '--ap-mso', | |
496 | dest='ap_mso', metavar='MSO', | |
497 | help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs') | |
498 | authentication.add_option( | |
499 | '--ap-username', | |
500 | dest='ap_username', metavar='USERNAME', | |
501 | help='Multiple-system operator account login') | |
502 | authentication.add_option( | |
503 | '--ap-password', | |
504 | dest='ap_password', metavar='PASSWORD', | |
505 | help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively') | |
506 | authentication.add_option( | |
507 | '--ap-list-mso', | |
508 | action='store_true', dest='ap_list_mso', default=False, | |
509 | help='List all supported multiple-system operators') | |
510 | ||
511 | video_format = optparse.OptionGroup(parser, 'Video Format Options') | |
512 | video_format.add_option( | |
513 | '-f', '--format', | |
514 | action='store', dest='format', metavar='FORMAT', default=None, | |
515 | help='Video format code, see "FORMAT SELECTION" for more details') | |
516 | video_format.add_option( | |
517 | '-S', '--format-sort', metavar='SORTORDER', | |
518 | dest='format_sort', default=[], type='str', action='callback', | |
519 | callback=_list_from_options_callback, callback_kwargs={'append': -1}, | |
520 | help='Sort the formats by the fields given, see "Sorting Formats" for more details') | |
521 | video_format.add_option( | |
522 | '--format-sort-force', '--S-force', | |
523 | action='store_true', dest='format_sort_force', metavar='FORMAT', default=False, | |
524 | help=( | |
525 | 'Force user specified sort order to have precedence over all fields, ' | |
526 | 'see "Sorting Formats" for more details')) | |
527 | video_format.add_option( | |
528 | '--no-format-sort-force', | |
529 | action='store_false', dest='format_sort_force', metavar='FORMAT', default=False, | |
530 | help=( | |
531 | 'Some fields have precedence over the user specified sort order (default), ' | |
532 | 'see "Sorting Formats" for more details')) | |
533 | video_format.add_option( | |
534 | '--video-multistreams', | |
535 | action='store_true', dest='allow_multiple_video_streams', default=None, | |
536 | help='Allow multiple video streams to be merged into a single file') | |
537 | video_format.add_option( | |
538 | '--no-video-multistreams', | |
539 | action='store_false', dest='allow_multiple_video_streams', | |
540 | help='Only one video stream is downloaded for each output file (default)') | |
541 | video_format.add_option( | |
542 | '--audio-multistreams', | |
543 | action='store_true', dest='allow_multiple_audio_streams', default=None, | |
544 | help='Allow multiple audio streams to be merged into a single file') | |
545 | video_format.add_option( | |
546 | '--no-audio-multistreams', | |
547 | action='store_false', dest='allow_multiple_audio_streams', | |
548 | help='Only one audio stream is downloaded for each output file (default)') | |
549 | video_format.add_option( | |
550 | '--all-formats', | |
551 | action='store_const', dest='format', const='all', | |
552 | help=optparse.SUPPRESS_HELP) | |
553 | video_format.add_option( | |
554 | '--prefer-free-formats', | |
555 | action='store_true', dest='prefer_free_formats', default=False, | |
556 | help=( | |
557 | 'Prefer video formats with free containers over non-free ones of same quality. ' | |
558 | 'Use with "-S ext" to strictly prefer free containers irrespective of quality')) | |
559 | video_format.add_option( | |
560 | '--no-prefer-free-formats', | |
561 | action='store_false', dest='prefer_free_formats', default=False, | |
562 | help="Don't give any special preference to free containers (default)") | |
563 | video_format.add_option( | |
564 | '--check-formats', | |
565 | action='store_true', dest='check_formats', default=None, | |
566 | help='Check that the formats selected are actually downloadable') | |
567 | video_format.add_option( | |
568 | '--no-check-formats', | |
569 | action='store_false', dest='check_formats', | |
570 | help='Do not check that the formats selected are actually downloadable') | |
571 | video_format.add_option( | |
572 | '-F', '--list-formats', | |
573 | action='store_true', dest='listformats', | |
574 | help='List available formats of each video. Simulate unless --no-simulate is used') | |
575 | video_format.add_option( | |
576 | '--list-formats-as-table', | |
577 | action='store_true', dest='listformats_table', default=True, | |
578 | help=optparse.SUPPRESS_HELP) | |
579 | video_format.add_option( | |
580 | '--list-formats-old', '--no-list-formats-as-table', | |
581 | action='store_false', dest='listformats_table', | |
582 | help=optparse.SUPPRESS_HELP) | |
583 | video_format.add_option( | |
584 | '--merge-output-format', | |
585 | action='store', dest='merge_output_format', metavar='FORMAT', default=None, | |
586 | help=( | |
587 | 'If a merge is required (e.g. bestvideo+bestaudio), ' | |
588 | 'output to given container format. One of mkv, mp4, ogg, webm, flv. ' | |
589 | 'Ignored if no merge is required')) | |
590 | video_format.add_option( | |
591 | '--allow-unplayable-formats', | |
592 | action='store_true', dest='allow_unplayable_formats', default=False, | |
593 | help=optparse.SUPPRESS_HELP) | |
594 | video_format.add_option( | |
595 | '--no-allow-unplayable-formats', | |
596 | action='store_false', dest='allow_unplayable_formats', | |
597 | help=optparse.SUPPRESS_HELP) | |
598 | ||
599 | subtitles = optparse.OptionGroup(parser, 'Subtitle Options') | |
600 | subtitles.add_option( | |
601 | '--write-subs', '--write-srt', | |
602 | action='store_true', dest='writesubtitles', default=False, | |
603 | help='Write subtitle file') | |
604 | subtitles.add_option( | |
605 | '--no-write-subs', '--no-write-srt', | |
606 | action='store_false', dest='writesubtitles', | |
607 | help='Do not write subtitle file (default)') | |
608 | subtitles.add_option( | |
609 | '--write-auto-subs', '--write-automatic-subs', | |
610 | action='store_true', dest='writeautomaticsub', default=False, | |
611 | help='Write automatically generated subtitle file (Alias: --write-automatic-subs)') | |
612 | subtitles.add_option( | |
613 | '--no-write-auto-subs', '--no-write-automatic-subs', | |
614 | action='store_false', dest='writeautomaticsub', default=False, | |
615 | help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)') | |
616 | subtitles.add_option( | |
617 | '--all-subs', | |
618 | action='store_true', dest='allsubtitles', default=False, | |
619 | help=optparse.SUPPRESS_HELP) | |
620 | subtitles.add_option( | |
621 | '--list-subs', | |
622 | action='store_true', dest='listsubtitles', default=False, | |
623 | help='List available subtitles of each video. Simulate unless --no-simulate is used') | |
624 | subtitles.add_option( | |
625 | '--sub-format', | |
626 | action='store', dest='subtitlesformat', metavar='FORMAT', default='best', | |
627 | help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"') | |
628 | subtitles.add_option( | |
629 | '--sub-langs', '--srt-langs', | |
630 | action='callback', dest='subtitleslangs', metavar='LANGS', type='str', | |
631 | default=[], callback=_list_from_options_callback, | |
632 | help=( | |
633 | 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) ' | |
634 | 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) ' | |
635 | 'Use --list-subs for a list of available language tags')) | |
636 | ||
637 | downloader = optparse.OptionGroup(parser, 'Download Options') | |
638 | downloader.add_option( | |
639 | '-N', '--concurrent-fragments', | |
640 | dest='concurrent_fragment_downloads', metavar='N', default=1, type=int, | |
641 | help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)') | |
642 | downloader.add_option( | |
643 | '-r', '--limit-rate', '--rate-limit', | |
644 | dest='ratelimit', metavar='RATE', | |
645 | help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)') | |
646 | downloader.add_option( | |
647 | '--throttled-rate', | |
648 | dest='throttledratelimit', metavar='RATE', | |
649 | help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)') | |
650 | downloader.add_option( | |
651 | '-R', '--retries', | |
652 | dest='retries', metavar='RETRIES', default=10, | |
653 | help='Number of retries (default is %default), or "infinite"') | |
654 | downloader.add_option( | |
655 | '--fragment-retries', | |
656 | dest='fragment_retries', metavar='RETRIES', default=10, | |
657 | help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)') | |
658 | downloader.add_option( | |
659 | '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment', | |
660 | action='store_true', dest='skip_unavailable_fragments', default=True, | |
661 | help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)') | |
662 | downloader.add_option( | |
663 | '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments', | |
664 | action='store_false', dest='skip_unavailable_fragments', | |
665 | help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)') | |
666 | downloader.add_option( | |
667 | '--keep-fragments', | |
668 | action='store_true', dest='keep_fragments', default=False, | |
669 | help='Keep downloaded fragments on disk after downloading is finished') | |
670 | downloader.add_option( | |
671 | '--no-keep-fragments', | |
672 | action='store_false', dest='keep_fragments', | |
673 | help='Delete downloaded fragments after downloading is finished (default)') | |
674 | downloader.add_option( | |
675 | '--buffer-size', | |
676 | dest='buffersize', metavar='SIZE', default='1024', | |
677 | help='Size of download buffer (e.g. 1024 or 16K) (default is %default)') | |
678 | downloader.add_option( | |
679 | '--resize-buffer', | |
680 | action='store_false', dest='noresizebuffer', | |
681 | help='The buffer size is automatically resized from an initial value of --buffer-size (default)') | |
682 | downloader.add_option( | |
683 | '--no-resize-buffer', | |
684 | action='store_true', dest='noresizebuffer', default=False, | |
685 | help='Do not automatically adjust the buffer size') | |
686 | downloader.add_option( | |
687 | '--http-chunk-size', | |
688 | dest='http_chunk_size', metavar='SIZE', default=None, | |
689 | help=( | |
690 | 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). ' | |
691 | 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)')) | |
692 | downloader.add_option( | |
693 | '--test', | |
694 | action='store_true', dest='test', default=False, | |
695 | help=optparse.SUPPRESS_HELP) | |
696 | downloader.add_option( | |
697 | '--playlist-reverse', | |
698 | action='store_true', | |
699 | help='Download playlist videos in reverse order') | |
700 | downloader.add_option( | |
701 | '--no-playlist-reverse', | |
702 | action='store_false', dest='playlist_reverse', | |
703 | help='Download playlist videos in default order (default)') | |
704 | downloader.add_option( | |
705 | '--playlist-random', | |
706 | action='store_true', | |
707 | help='Download playlist videos in random order') | |
708 | downloader.add_option( | |
709 | '--xattr-set-filesize', | |
710 | dest='xattr_set_filesize', action='store_true', | |
711 | help='Set file xattribute ytdl.filesize with expected file size') | |
712 | downloader.add_option( | |
713 | '--hls-prefer-native', | |
714 | dest='hls_prefer_native', action='store_true', default=None, | |
715 | help=optparse.SUPPRESS_HELP) | |
716 | downloader.add_option( | |
717 | '--hls-prefer-ffmpeg', | |
718 | dest='hls_prefer_native', action='store_false', default=None, | |
719 | help=optparse.SUPPRESS_HELP) | |
720 | downloader.add_option( | |
721 | '--hls-use-mpegts', | |
722 | dest='hls_use_mpegts', action='store_true', default=None, | |
723 | help=( | |
724 | 'Use the mpegts container for HLS videos; ' | |
725 | 'allowing some players to play the video while downloading, ' | |
726 | 'and reducing the chance of file corruption if download is interrupted. ' | |
727 | 'This is enabled by default for live streams')) | |
728 | downloader.add_option( | |
729 | '--no-hls-use-mpegts', | |
730 | dest='hls_use_mpegts', action='store_false', | |
731 | help=( | |
732 | 'Do not use the mpegts container for HLS videos. ' | |
733 | 'This is default when not downloading live streams')) | |
734 | downloader.add_option( | |
735 | '--downloader', '--external-downloader', | |
736 | dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str', | |
737 | action='callback', callback=_dict_from_options_callback, | |
738 | callback_kwargs={ | |
739 | 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms', | |
740 | 'default_key': 'default', | |
741 | 'process': str.strip | |
742 | }, help=( | |
743 | 'Name or path of the external downloader to use (optionally) prefixed by ' | |
744 | 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. ' | |
745 | 'Currently supports native, %s (Recommended: aria2c). ' | |
746 | 'You can use this option multiple times to set different downloaders for different protocols. ' | |
747 | 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use ' | |
748 | 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads ' | |
749 | '(Alias: --external-downloader)' % ', '.join(list_external_downloaders()))) | |
750 | downloader.add_option( | |
751 | '--downloader-args', '--external-downloader-args', | |
752 | metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str', | |
753 | action='callback', callback=_dict_from_options_callback, | |
754 | callback_kwargs={ | |
755 | 'allowed_keys': r'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()), | |
756 | 'default_key': 'default', | |
757 | 'process': compat_shlex_split | |
758 | }, help=( | |
759 | 'Give these arguments to the external downloader. ' | |
760 | 'Specify the downloader name and the arguments separated by a colon ":". ' | |
761 | 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. ' | |
762 | 'You can use this option multiple times to give different arguments to different downloaders ' | |
763 | '(Alias: --external-downloader-args)')) | |
764 | ||
765 | workarounds = optparse.OptionGroup(parser, 'Workarounds') | |
766 | workarounds.add_option( | |
767 | '--encoding', | |
768 | dest='encoding', metavar='ENCODING', | |
769 | help='Force the specified encoding (experimental)') | |
770 | workarounds.add_option( | |
771 | '--no-check-certificate', | |
772 | action='store_true', dest='no_check_certificate', default=False, | |
773 | help='Suppress HTTPS certificate validation') | |
774 | workarounds.add_option( | |
775 | '--prefer-insecure', '--prefer-unsecure', | |
776 | action='store_true', dest='prefer_insecure', | |
777 | help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)') | |
778 | workarounds.add_option( | |
779 | '--user-agent', | |
780 | metavar='UA', dest='user_agent', | |
781 | help='Specify a custom user agent') | |
782 | workarounds.add_option( | |
783 | '--referer', | |
784 | metavar='URL', dest='referer', default=None, | |
785 | help='Specify a custom referer, use if the video access is restricted to one domain', | |
786 | ) | |
787 | workarounds.add_option( | |
788 | '--add-header', | |
789 | metavar='FIELD:VALUE', dest='headers', default={}, type='str', | |
790 | action='callback', callback=_dict_from_options_callback, | |
791 | callback_kwargs={'multiple_keys': False}, | |
792 | help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times', | |
793 | ) | |
794 | workarounds.add_option( | |
795 | '--bidi-workaround', | |
796 | dest='bidi_workaround', action='store_true', | |
797 | help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH') | |
798 | workarounds.add_option( | |
799 | '--sleep-requests', metavar='SECONDS', | |
800 | dest='sleep_interval_requests', type=float, | |
801 | help='Number of seconds to sleep between requests during data extraction') | |
802 | workarounds.add_option( | |
803 | '--sleep-interval', '--min-sleep-interval', metavar='SECONDS', | |
804 | dest='sleep_interval', type=float, | |
805 | help=( | |
806 | 'Number of seconds to sleep before each download. ' | |
807 | 'This is the minimum time to sleep when used along with --max-sleep-interval ' | |
808 | '(Alias: --min-sleep-interval)')) | |
809 | workarounds.add_option( | |
810 | '--max-sleep-interval', metavar='SECONDS', | |
811 | dest='max_sleep_interval', type=float, | |
812 | help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval') | |
813 | workarounds.add_option( | |
814 | '--sleep-subtitles', metavar='SECONDS', | |
815 | dest='sleep_interval_subtitles', default=0, type=int, | |
816 | help='Number of seconds to sleep before each subtitle download') | |
817 | ||
818 | verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options') | |
819 | verbosity.add_option( | |
820 | '-q', '--quiet', | |
821 | action='store_true', dest='quiet', default=False, | |
822 | help='Activate quiet mode. If used with --verbose, print the log to stderr') | |
823 | verbosity.add_option( | |
824 | '--no-warnings', | |
825 | dest='no_warnings', action='store_true', default=False, | |
826 | help='Ignore warnings') | |
827 | verbosity.add_option( | |
828 | '-s', '--simulate', | |
829 | action='store_true', dest='simulate', default=None, | |
830 | help='Do not download the video and do not write anything to disk') | |
831 | verbosity.add_option( | |
832 | '--no-simulate', | |
833 | action='store_false', dest='simulate', | |
834 | help='Download the video even if printing/listing options are used') | |
835 | verbosity.add_option( | |
836 | '--ignore-no-formats-error', | |
837 | action='store_true', dest='ignore_no_formats_error', default=False, | |
838 | help=( | |
839 | 'Ignore "No video formats" error. Usefull for extracting metadata ' | |
840 | 'even if the videos are not actually available for download (experimental)')) | |
841 | verbosity.add_option( | |
842 | '--no-ignore-no-formats-error', | |
843 | action='store_false', dest='ignore_no_formats_error', | |
844 | help='Throw error when no downloadable video formats are found (default)') | |
845 | verbosity.add_option( | |
846 | '--skip-download', '--no-download', | |
847 | action='store_true', dest='skip_download', default=False, | |
848 | help='Do not download the video but write all related files (Alias: --no-download)') | |
849 | verbosity.add_option( | |
850 | '-O', '--print', | |
851 | metavar='TEMPLATE', action='append', dest='forceprint', | |
852 | help=( | |
853 | 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. ' | |
854 | 'Either a field name or same syntax as the output template can be used')) | |
855 | verbosity.add_option( | |
856 | '-g', '--get-url', | |
857 | action='store_true', dest='geturl', default=False, | |
858 | help=optparse.SUPPRESS_HELP) | |
859 | verbosity.add_option( | |
860 | '-e', '--get-title', | |
861 | action='store_true', dest='gettitle', default=False, | |
862 | help=optparse.SUPPRESS_HELP) | |
863 | verbosity.add_option( | |
864 | '--get-id', | |
865 | action='store_true', dest='getid', default=False, | |
866 | help=optparse.SUPPRESS_HELP) | |
867 | verbosity.add_option( | |
868 | '--get-thumbnail', | |
869 | action='store_true', dest='getthumbnail', default=False, | |
870 | help=optparse.SUPPRESS_HELP) | |
871 | verbosity.add_option( | |
872 | '--get-description', | |
873 | action='store_true', dest='getdescription', default=False, | |
874 | help=optparse.SUPPRESS_HELP) | |
875 | verbosity.add_option( | |
876 | '--get-duration', | |
877 | action='store_true', dest='getduration', default=False, | |
878 | help=optparse.SUPPRESS_HELP) | |
879 | verbosity.add_option( | |
880 | '--get-filename', | |
881 | action='store_true', dest='getfilename', default=False, | |
882 | help=optparse.SUPPRESS_HELP) | |
883 | verbosity.add_option( | |
884 | '--get-format', | |
885 | action='store_true', dest='getformat', default=False, | |
886 | help=optparse.SUPPRESS_HELP) | |
887 | verbosity.add_option( | |
888 | '-j', '--dump-json', | |
889 | action='store_true', dest='dumpjson', default=False, | |
890 | help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys') | |
891 | verbosity.add_option( | |
892 | '-J', '--dump-single-json', | |
893 | action='store_true', dest='dump_single_json', default=False, | |
894 | help=( | |
895 | 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. ' | |
896 | 'If the URL refers to a playlist, the whole playlist information is dumped in a single line')) | |
897 | verbosity.add_option( | |
898 | '--print-json', | |
899 | action='store_true', dest='print_json', default=False, | |
900 | help=optparse.SUPPRESS_HELP) | |
901 | verbosity.add_option( | |
902 | '--force-write-archive', '--force-write-download-archive', '--force-download-archive', | |
903 | action='store_true', dest='force_write_download_archive', default=False, | |
904 | help=( | |
905 | 'Force download archive entries to be written as far as no errors occur, ' | |
906 | 'even if -s or another simulation option is used (Alias: --force-download-archive)')) | |
907 | verbosity.add_option( | |
908 | '--newline', | |
909 | action='store_true', dest='progress_with_newline', default=False, | |
910 | help='Output progress bar as new lines') | |
911 | verbosity.add_option( | |
912 | '--no-progress', | |
913 | action='store_true', dest='noprogress', default=False, | |
914 | help='Do not print progress bar') | |
915 | verbosity.add_option( | |
916 | '--console-title', | |
917 | action='store_true', dest='consoletitle', default=False, | |
918 | help='Display progress in console titlebar') | |
919 | verbosity.add_option( | |
920 | '-v', '--verbose', | |
921 | action='store_true', dest='verbose', default=False, | |
922 | help='Print various debugging information') | |
923 | verbosity.add_option( | |
924 | '--dump-pages', '--dump-intermediate-pages', | |
925 | action='store_true', dest='dump_intermediate_pages', default=False, | |
926 | help='Print downloaded pages encoded using base64 to debug problems (very verbose)') | |
927 | verbosity.add_option( | |
928 | '--write-pages', | |
929 | action='store_true', dest='write_pages', default=False, | |
930 | help='Write downloaded intermediary pages to files in the current directory to debug problems') | |
931 | verbosity.add_option( | |
932 | '--youtube-print-sig-code', | |
933 | action='store_true', dest='youtube_print_sig_code', default=False, | |
934 | help=optparse.SUPPRESS_HELP) | |
935 | verbosity.add_option( | |
936 | '--print-traffic', '--dump-headers', | |
937 | dest='debug_printtraffic', action='store_true', default=False, | |
938 | help='Display sent and read HTTP traffic') | |
939 | verbosity.add_option( | |
940 | '-C', '--call-home', | |
941 | dest='call_home', action='store_true', default=False, | |
942 | # help='[Broken] Contact the yt-dlp server for debugging') | |
943 | help=optparse.SUPPRESS_HELP) | |
944 | verbosity.add_option( | |
945 | '--no-call-home', | |
946 | dest='call_home', action='store_false', | |
947 | # help='Do not contact the yt-dlp server for debugging (default)') | |
948 | help=optparse.SUPPRESS_HELP) | |
949 | ||
950 | filesystem = optparse.OptionGroup(parser, 'Filesystem Options') | |
951 | filesystem.add_option( | |
952 | '-a', '--batch-file', | |
953 | dest='batchfile', metavar='FILE', | |
954 | help="File containing URLs to download ('-' for stdin), one URL per line. " | |
955 | "Lines starting with '#', ';' or ']' are considered as comments and ignored") | |
956 | filesystem.add_option( | |
957 | '--id', default=False, | |
958 | action='store_true', dest='useid', help=optparse.SUPPRESS_HELP) | |
959 | filesystem.add_option( | |
960 | '-P', '--paths', | |
961 | metavar='[TYPES:]PATH', dest='paths', default={}, type='str', | |
962 | action='callback', callback=_dict_from_options_callback, | |
963 | callback_kwargs={ | |
964 | 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES.keys()), | |
965 | 'default_key': 'home' | |
966 | }, help=( | |
967 | 'The paths where the files should be downloaded. ' | |
968 | 'Specify the type of file and the path separated by a colon ":". ' | |
969 | 'All the same types as --output are supported. ' | |
970 | 'Additionally, you can also provide "home" (default) and "temp" paths. ' | |
971 | 'All intermediary files are first downloaded to the temp path and ' | |
972 | 'then the final files are moved over to the home path after download is finished. ' | |
973 | 'This option is ignored if --output is an absolute path')) | |
974 | filesystem.add_option( | |
975 | '-o', '--output', | |
976 | metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str', | |
977 | action='callback', callback=_dict_from_options_callback, | |
978 | callback_kwargs={ | |
979 | 'allowed_keys': '|'.join(OUTTMPL_TYPES.keys()), | |
980 | 'default_key': 'default' | |
981 | }, help='Output filename template; see "OUTPUT TEMPLATE" for details') | |
982 | filesystem.add_option( | |
983 | '--output-na-placeholder', | |
984 | dest='outtmpl_na_placeholder', metavar='TEXT', default='NA', | |
985 | help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")')) | |
986 | filesystem.add_option( | |
987 | '--autonumber-size', | |
988 | dest='autonumber_size', metavar='NUMBER', type=int, | |
989 | help=optparse.SUPPRESS_HELP) | |
990 | filesystem.add_option( | |
991 | '--autonumber-start', | |
992 | dest='autonumber_start', metavar='NUMBER', default=1, type=int, | |
993 | help=optparse.SUPPRESS_HELP) | |
994 | filesystem.add_option( | |
995 | '--restrict-filenames', | |
996 | action='store_true', dest='restrictfilenames', default=False, | |
997 | help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames') | |
998 | filesystem.add_option( | |
999 | '--no-restrict-filenames', | |
1000 | action='store_false', dest='restrictfilenames', | |
1001 | help='Allow Unicode characters, "&" and spaces in filenames (default)') | |
1002 | filesystem.add_option( | |
1003 | '--windows-filenames', | |
1004 | action='store_true', dest='windowsfilenames', default=False, | |
1005 | help='Force filenames to be windows compatible') | |
1006 | filesystem.add_option( | |
1007 | '--no-windows-filenames', | |
1008 | action='store_false', dest='windowsfilenames', | |
1009 | help='Make filenames windows compatible only if using windows (default)') | |
1010 | filesystem.add_option( | |
1011 | '--trim-filenames', '--trim-file-names', metavar='LENGTH', | |
1012 | dest='trim_file_name', default=0, type=int, | |
1013 | help='Limit the filename length (excluding extension) to the specified number of characters') | |
1014 | filesystem.add_option( | |
1015 | '--auto-number', | |
1016 | action='store_true', dest='autonumber', default=False, | |
1017 | help=optparse.SUPPRESS_HELP) | |
1018 | filesystem.add_option( | |
1019 | '--title', | |
1020 | action='store_true', dest='usetitle', default=False, | |
1021 | help=optparse.SUPPRESS_HELP) | |
1022 | filesystem.add_option( | |
1023 | '--literal', default=False, | |
1024 | action='store_true', dest='usetitle', | |
1025 | help=optparse.SUPPRESS_HELP) | |
1026 | filesystem.add_option( | |
1027 | '-w', '--no-overwrites', | |
1028 | action='store_false', dest='overwrites', default=None, | |
1029 | help='Do not overwrite any files') | |
1030 | filesystem.add_option( | |
1031 | '--force-overwrites', '--yes-overwrites', | |
1032 | action='store_true', dest='overwrites', | |
1033 | help='Overwrite all video and metadata files. This option includes --no-continue') | |
1034 | filesystem.add_option( | |
1035 | '--no-force-overwrites', | |
1036 | action='store_const', dest='overwrites', const=None, | |
1037 | help='Do not overwrite the video, but overwrite related files (default)') | |
1038 | filesystem.add_option( | |
1039 | '-c', '--continue', | |
1040 | action='store_true', dest='continue_dl', default=True, | |
1041 | help='Resume partially downloaded files/fragments (default)') | |
1042 | filesystem.add_option( | |
1043 | '--no-continue', | |
1044 | action='store_false', dest='continue_dl', | |
1045 | help=( | |
1046 | 'Do not resume partially downloaded fragments. ' | |
1047 | 'If the file is not fragmented, restart download of the entire file')) | |
1048 | filesystem.add_option( | |
1049 | '--part', | |
1050 | action='store_false', dest='nopart', default=False, | |
1051 | help='Use .part files instead of writing directly into output file (default)') | |
1052 | filesystem.add_option( | |
1053 | '--no-part', | |
1054 | action='store_true', dest='nopart', | |
1055 | help='Do not use .part files - write directly into output file') | |
1056 | filesystem.add_option( | |
1057 | '--mtime', | |
1058 | action='store_true', dest='updatetime', default=True, | |
1059 | help='Use the Last-modified header to set the file modification time (default)') | |
1060 | filesystem.add_option( | |
1061 | '--no-mtime', | |
1062 | action='store_false', dest='updatetime', | |
1063 | help='Do not use the Last-modified header to set the file modification time') | |
1064 | filesystem.add_option( | |
1065 | '--write-description', | |
1066 | action='store_true', dest='writedescription', default=False, | |
1067 | help='Write video description to a .description file') | |
1068 | filesystem.add_option( | |
1069 | '--no-write-description', | |
1070 | action='store_false', dest='writedescription', | |
1071 | help='Do not write video description (default)') | |
1072 | filesystem.add_option( | |
1073 | '--write-info-json', | |
1074 | action='store_true', dest='writeinfojson', default=False, | |
1075 | help='Write video metadata to a .info.json file (this may contain personal information)') | |
1076 | filesystem.add_option( | |
1077 | '--no-write-info-json', | |
1078 | action='store_false', dest='writeinfojson', | |
1079 | help='Do not write video metadata (default)') | |
1080 | filesystem.add_option( | |
1081 | '--write-annotations', | |
1082 | action='store_true', dest='writeannotations', default=False, | |
1083 | help=optparse.SUPPRESS_HELP) | |
1084 | filesystem.add_option( | |
1085 | '--no-write-annotations', | |
1086 | action='store_false', dest='writeannotations', | |
1087 | help=optparse.SUPPRESS_HELP) | |
1088 | filesystem.add_option( | |
1089 | '--write-playlist-metafiles', | |
1090 | action='store_true', dest='allow_playlist_files', default=None, | |
1091 | help=( | |
1092 | 'Write playlist metadata in addition to the video metadata ' | |
1093 | 'when using --write-info-json, --write-description etc. (default)')) | |
1094 | filesystem.add_option( | |
1095 | '--no-write-playlist-metafiles', | |
1096 | action='store_false', dest='allow_playlist_files', | |
1097 | help='Do not write playlist metadata when using --write-info-json, --write-description etc.') | |
1098 | filesystem.add_option( | |
1099 | '--clean-infojson', | |
1100 | action='store_true', dest='clean_infojson', default=None, | |
1101 | help=( | |
1102 | 'Remove some private fields such as filenames from the infojson. ' | |
1103 | 'Note that it could still contain some personal information (default)')) | |
1104 | filesystem.add_option( | |
1105 | '--no-clean-infojson', | |
1106 | action='store_false', dest='clean_infojson', | |
1107 | help='Write all fields to the infojson') | |
1108 | filesystem.add_option( | |
1109 | '--write-comments', '--get-comments', | |
1110 | action='store_true', dest='getcomments', default=False, | |
1111 | help=( | |
1112 | 'Retrieve video comments to be placed in the infojson. ' | |
1113 | 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)')) | |
1114 | filesystem.add_option( | |
1115 | '--no-write-comments', '--no-get-comments', | |
1116 | action='store_false', dest='getcomments', | |
1117 | help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)') | |
1118 | filesystem.add_option( | |
1119 | '--load-info-json', '--load-info', | |
1120 | dest='load_info_filename', metavar='FILE', | |
1121 | help='JSON file containing the video information (created with the "--write-info-json" option)') | |
1122 | filesystem.add_option( | |
1123 | '--cookies', | |
1124 | dest='cookiefile', metavar='FILE', | |
1125 | help='File to read cookies from and dump cookie jar in') | |
1126 | filesystem.add_option( | |
1127 | '--no-cookies', | |
1128 | action='store_const', const=None, dest='cookiefile', metavar='FILE', | |
1129 | help='Do not read/dump cookies from/to file (default)') | |
1130 | filesystem.add_option( | |
1131 | '--cookies-from-browser', | |
1132 | dest='cookiesfrombrowser', metavar='BROWSER[:PROFILE]', | |
1133 | help=( | |
1134 | 'Load cookies from a user profile of the given web browser. ' | |
1135 | 'Currently supported browsers are: {}. ' | |
1136 | 'You can specify the user profile name or directory using ' | |
1137 | '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". ' | |
1138 | 'If no profile is given, the most recently accessed one is used'.format( | |
1139 | ', '.join(sorted(SUPPORTED_BROWSERS))))) | |
1140 | filesystem.add_option( | |
1141 | '--no-cookies-from-browser', | |
1142 | action='store_const', const=None, dest='cookiesfrombrowser', | |
1143 | help='Do not load cookies from browser (default)') | |
1144 | filesystem.add_option( | |
1145 | '--cache-dir', dest='cachedir', default=None, metavar='DIR', | |
1146 | help='Location in the filesystem where youtube-dl can store some downloaded information (such as client ids and signatures) permanently. By default $XDG_CACHE_HOME/yt-dlp or ~/.cache/yt-dlp') | |
1147 | filesystem.add_option( | |
1148 | '--no-cache-dir', action='store_false', dest='cachedir', | |
1149 | help='Disable filesystem caching') | |
1150 | filesystem.add_option( | |
1151 | '--rm-cache-dir', | |
1152 | action='store_true', dest='rm_cachedir', | |
1153 | help='Delete all filesystem cache files') | |
1154 | ||
1155 | thumbnail = optparse.OptionGroup(parser, 'Thumbnail Options') | |
1156 | thumbnail.add_option( | |
1157 | '--write-thumbnail', | |
1158 | action='store_true', dest='writethumbnail', default=False, | |
1159 | help='Write thumbnail image to disk') | |
1160 | thumbnail.add_option( | |
1161 | '--no-write-thumbnail', | |
1162 | action='store_false', dest='writethumbnail', | |
1163 | help='Do not write thumbnail image to disk (default)') | |
1164 | thumbnail.add_option( | |
1165 | '--write-all-thumbnails', | |
1166 | action='store_true', dest='write_all_thumbnails', default=False, | |
1167 | help='Write all thumbnail image formats to disk') | |
1168 | thumbnail.add_option( | |
1169 | '--list-thumbnails', | |
1170 | action='store_true', dest='list_thumbnails', default=False, | |
1171 | help='List available thumbnails of each video. Simulate unless --no-simulate is used') | |
1172 | ||
1173 | link = optparse.OptionGroup(parser, 'Internet Shortcut Options') | |
1174 | link.add_option( | |
1175 | '--write-link', | |
1176 | action='store_true', dest='writelink', default=False, | |
1177 | help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS') | |
1178 | link.add_option( | |
1179 | '--write-url-link', | |
1180 | action='store_true', dest='writeurllink', default=False, | |
1181 | help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path') | |
1182 | link.add_option( | |
1183 | '--write-webloc-link', | |
1184 | action='store_true', dest='writewebloclink', default=False, | |
1185 | help='Write a .webloc macOS internet shortcut') | |
1186 | link.add_option( | |
1187 | '--write-desktop-link', | |
1188 | action='store_true', dest='writedesktoplink', default=False, | |
1189 | help='Write a .desktop Linux internet shortcut') | |
1190 | ||
1191 | postproc = optparse.OptionGroup(parser, 'Post-Processing Options') | |
1192 | postproc.add_option( | |
1193 | '-x', '--extract-audio', | |
1194 | action='store_true', dest='extractaudio', default=False, | |
1195 | help='Convert video files to audio-only files (requires ffmpeg and ffprobe)') | |
1196 | postproc.add_option( | |
1197 | '--audio-format', metavar='FORMAT', dest='audioformat', default='best', | |
1198 | help=( | |
1199 | 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: ' | |
1200 | 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP.SUPPORTED_EXTS))) | |
1201 | postproc.add_option( | |
1202 | '--audio-quality', metavar='QUALITY', | |
1203 | dest='audioquality', default='5', | |
1204 | help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)') | |
1205 | postproc.add_option( | |
1206 | '--remux-video', | |
1207 | metavar='FORMAT', dest='remuxvideo', default=None, | |
1208 | help=( | |
1209 | 'Remux the video into another container if necessary (currently supported: %s). ' | |
1210 | 'If target container does not support the video/audio codec, remuxing will fail. ' | |
1211 | 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 ' | |
1212 | 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS))) | |
1213 | postproc.add_option( | |
1214 | '--recode-video', | |
1215 | metavar='FORMAT', dest='recodevideo', default=None, | |
1216 | help=( | |
1217 | 'Re-encode the video into another format if re-encoding is necessary. ' | |
1218 | 'The syntax and supported formats are the same as --remux-video')) | |
1219 | postproc.add_option( | |
1220 | '--postprocessor-args', '--ppa', | |
1221 | metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str', | |
1222 | action='callback', callback=_dict_from_options_callback, | |
1223 | callback_kwargs={ | |
1224 | 'allowed_keys': r'\w+(?:\+\w+)?', 'default_key': 'default-compat', | |
1225 | 'process': compat_shlex_split, | |
1226 | 'multiple_keys': False | |
1227 | }, help=( | |
1228 | 'Give these arguments to the postprocessors. ' | |
1229 | 'Specify the postprocessor/executable name and the arguments separated by a colon ":" ' | |
1230 | 'to give the argument to the specified postprocessor/executable. Supported PP are: ' | |
1231 | 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, ' | |
1232 | 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, ' | |
1233 | 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. ' | |
1234 | 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. ' | |
1235 | 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable ' | |
1236 | 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, ' | |
1237 | '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument ' | |
1238 | 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". ' | |
1239 | 'You can use this option multiple times to give different arguments to different ' | |
1240 | 'postprocessors. (Alias: --ppa)')) | |
1241 | postproc.add_option( | |
1242 | '-k', '--keep-video', | |
1243 | action='store_true', dest='keepvideo', default=False, | |
1244 | help='Keep the intermediate video file on disk after post-processing') | |
1245 | postproc.add_option( | |
1246 | '--no-keep-video', | |
1247 | action='store_false', dest='keepvideo', | |
1248 | help='Delete the intermediate video file after post-processing (default)') | |
1249 | postproc.add_option( | |
1250 | '--post-overwrites', | |
1251 | action='store_false', dest='nopostoverwrites', | |
1252 | help='Overwrite post-processed files (default)') | |
1253 | postproc.add_option( | |
1254 | '--no-post-overwrites', | |
1255 | action='store_true', dest='nopostoverwrites', default=False, | |
1256 | help='Do not overwrite post-processed files') | |
1257 | postproc.add_option( | |
1258 | '--embed-subs', | |
1259 | action='store_true', dest='embedsubtitles', default=False, | |
1260 | help='Embed subtitles in the video (only for mp4, webm and mkv videos)') | |
1261 | postproc.add_option( | |
1262 | '--no-embed-subs', | |
1263 | action='store_false', dest='embedsubtitles', | |
1264 | help='Do not embed subtitles (default)') | |
1265 | postproc.add_option( | |
1266 | '--embed-thumbnail', | |
1267 | action='store_true', dest='embedthumbnail', default=False, | |
1268 | help='Embed thumbnail in the video as cover art') | |
1269 | postproc.add_option( | |
1270 | '--no-embed-thumbnail', | |
1271 | action='store_false', dest='embedthumbnail', | |
1272 | help='Do not embed thumbnail (default)') | |
1273 | postproc.add_option( | |
1274 | '--embed-metadata', '--add-metadata', | |
1275 | action='store_true', dest='addmetadata', default=False, | |
1276 | help='Embed metadata to the video file. Also adds chapters to file unless --no-add-chapters is used (Alias: --add-metadata)') | |
1277 | postproc.add_option( | |
1278 | '--no-embed-metadata', '--no-add-metadata', | |
1279 | action='store_false', dest='addmetadata', | |
1280 | help='Do not add metadata to file (default) (Alias: --no-add-metadata)') | |
1281 | postproc.add_option( | |
1282 | '--embed-chapters', '--add-chapters', | |
1283 | action='store_true', dest='addchapters', default=None, | |
1284 | help='Add chapter markers to the video file (Alias: --add-chapters)') | |
1285 | postproc.add_option( | |
1286 | '--no-embed-chapters', '--no-add-chapters', | |
1287 | action='store_false', dest='addchapters', | |
1288 | help='Do not add chapter markers (default) (Alias: --no-add-chapters)') | |
1289 | postproc.add_option( | |
1290 | '--metadata-from-title', | |
1291 | metavar='FORMAT', dest='metafromtitle', | |
1292 | help=optparse.SUPPRESS_HELP) | |
1293 | postproc.add_option( | |
1294 | '--parse-metadata', | |
1295 | metavar='FROM:TO', dest='parse_metadata', action='append', | |
1296 | help=( | |
1297 | 'Parse additional metadata like title/artist from other fields; ' | |
1298 | 'see "MODIFYING METADATA" for details')) | |
1299 | postproc.add_option( | |
1300 | '--replace-in-metadata', | |
1301 | dest='parse_metadata', metavar='FIELDS REGEX REPLACE', action='append', nargs=3, | |
1302 | help='Replace text in a metadata field using the given regex. This option can be used multiple times') | |
1303 | postproc.add_option( | |
1304 | '--xattrs', | |
1305 | action='store_true', dest='xattrs', default=False, | |
1306 | help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)') | |
1307 | postproc.add_option( | |
1308 | '--fixup', | |
1309 | metavar='POLICY', dest='fixup', default=None, | |
1310 | choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'), | |
1311 | help=( | |
1312 | 'Automatically correct known faults of the file. ' | |
1313 | 'One of never (do nothing), warn (only emit a warning), ' | |
1314 | 'detect_or_warn (the default; fix file if we can, warn otherwise), ' | |
1315 | 'force (try fixing even if file already exists')) | |
1316 | postproc.add_option( | |
1317 | '--prefer-avconv', '--no-prefer-ffmpeg', | |
1318 | action='store_false', dest='prefer_ffmpeg', | |
1319 | help=optparse.SUPPRESS_HELP) | |
1320 | postproc.add_option( | |
1321 | '--prefer-ffmpeg', '--no-prefer-avconv', | |
1322 | action='store_true', dest='prefer_ffmpeg', default=True, | |
1323 | help=optparse.SUPPRESS_HELP) | |
1324 | postproc.add_option( | |
1325 | '--ffmpeg-location', '--avconv-location', metavar='PATH', | |
1326 | dest='ffmpeg_location', | |
1327 | help='Location of the ffmpeg binary; either the path to the binary or its containing directory') | |
1328 | postproc.add_option( | |
1329 | '--exec', metavar='CMD', | |
1330 | action='append', dest='exec_cmd', | |
1331 | help=( | |
1332 | 'Execute a command on the file after downloading and post-processing. ' | |
1333 | 'Same syntax as the output template can be used to pass any field as arguments to the command. ' | |
1334 | 'An additional field "filepath" that contains the final path of the downloaded file is also available. ' | |
1335 | 'If no fields are passed, %(filepath)q is appended to the end of the command. ' | |
1336 | 'This option can be used multiple times')) | |
1337 | postproc.add_option( | |
1338 | '--no-exec', | |
1339 | action='store_const', dest='exec_cmd', const=[], | |
1340 | help='Remove any previously defined --exec') | |
1341 | postproc.add_option( | |
1342 | '--exec-before-download', metavar='CMD', | |
1343 | action='append', dest='exec_before_dl_cmd', | |
1344 | help=( | |
1345 | 'Execute a command before the actual download. ' | |
1346 | 'The syntax is the same as --exec but "filepath" is not available. ' | |
1347 | 'This option can be used multiple times')) | |
1348 | postproc.add_option( | |
1349 | '--no-exec-before-download', | |
1350 | action='store_const', dest='exec_before_dl_cmd', const=[], | |
1351 | help='Remove any previously defined --exec-before-download') | |
1352 | postproc.add_option( | |
1353 | '--convert-subs', '--convert-sub', '--convert-subtitles', | |
1354 | metavar='FORMAT', dest='convertsubtitles', default=None, | |
1355 | help=( | |
1356 | 'Convert the subtitles to another format (currently supported: %s) ' | |
1357 | '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS))) | |
1358 | postproc.add_option( | |
1359 | '--convert-thumbnails', | |
1360 | metavar='FORMAT', dest='convertthumbnails', default=None, | |
1361 | help=( | |
1362 | 'Convert the thumbnails to another format ' | |
1363 | '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))) | |
1364 | postproc.add_option( | |
1365 | '--split-chapters', '--split-tracks', | |
1366 | dest='split_chapters', action='store_true', default=False, | |
1367 | help=( | |
1368 | 'Split video into multiple files based on internal chapters. ' | |
1369 | 'The "chapter:" prefix can be used with "--paths" and "--output" to ' | |
1370 | 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details')) | |
1371 | postproc.add_option( | |
1372 | '--no-split-chapters', '--no-split-tracks', | |
1373 | dest='split_chapters', action='store_false', | |
1374 | help='Do not split video based on chapters (default)') | |
1375 | postproc.add_option( | |
1376 | '--remove-chapters', | |
1377 | metavar='REGEX', dest='remove_chapters', action='append', | |
1378 | help='Remove chapters whose title matches the given regular expression. This option can be used multiple times') | |
1379 | postproc.add_option( | |
1380 | '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None, | |
1381 | help='Do not remove any chapters from the file (default)') | |
1382 | postproc.add_option( | |
1383 | '--force-keyframes-at-cuts', | |
1384 | action='store_true', dest='force_keyframes_at_cuts', default=False, | |
1385 | help=( | |
1386 | 'Force keyframes around the chapters before removing/splitting them. ' | |
1387 | 'Requires a reencode and thus is very slow, but the resulting video ' | |
1388 | 'may have fewer artifacts around the cuts')) | |
1389 | postproc.add_option( | |
1390 | '--no-force-keyframes-at-cuts', | |
1391 | action='store_false', dest='force_keyframes_at_cuts', | |
1392 | help='Do not force keyframes around the chapters when cutting/splitting (default)') | |
1393 | _postprocessor_opts_parser = lambda key, val='': ( | |
1394 | *(item.split('=', 1) for item in (val.split(';') if val else [])), | |
1395 | ('key', remove_end(key, 'PP'))) | |
1396 | postproc.add_option( | |
1397 | '--use-postprocessor', | |
1398 | metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str', | |
1399 | action='callback', callback=_list_from_options_callback, | |
1400 | callback_kwargs={ | |
1401 | 'delim': None, | |
1402 | 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1))) | |
1403 | }, help=( | |
1404 | 'The (case sensitive) name of plugin postprocessors to be enabled, ' | |
1405 | 'and (optionally) arguments to be passed to it, seperated by a colon ":". ' | |
1406 | 'ARGS are a semicolon ";" delimited list of NAME=VALUE. ' | |
1407 | 'The "when" argument determines when the postprocessor is invoked. ' | |
1408 | 'It can be one of "pre_process" (after extraction), ' | |
1409 | '"before_dl" (before video download), "post_process" (after video download; default) ' | |
1410 | 'or "after_move" (after moving file to their final locations). ' | |
1411 | 'This option can be used multiple times to add different postprocessors')) | |
1412 | ||
1413 | sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=( | |
1414 | 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) ' | |
1415 | 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)')) | |
1416 | sponsorblock.add_option( | |
1417 | '--sponsorblock-mark', metavar='CATS', | |
1418 | dest='sponsorblock_mark', default=set(), action='callback', type='str', | |
1419 | callback=_set_from_options_callback, callback_kwargs={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}, | |
1420 | help=( | |
1421 | 'SponsorBlock categories to create chapters for, separated by commas. ' | |
1422 | 'Available categories are all, %s. You can prefix the category with a "-" to exempt it. ' | |
1423 | 'See https://wiki.sponsor.ajay.app/index.php/Segment_Categories for description of the categories. ' | |
1424 | 'Eg: --sponsorblock-mark all,-preview' % ', '.join(SponsorBlockPP.CATEGORIES.keys()))) | |
1425 | sponsorblock.add_option( | |
1426 | '--sponsorblock-remove', metavar='CATS', | |
1427 | dest='sponsorblock_remove', default=set(), action='callback', type='str', | |
1428 | callback=_set_from_options_callback, callback_kwargs={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}, | |
1429 | help=( | |
1430 | 'SponsorBlock categories to be removed from the video file, separated by commas. ' | |
1431 | 'If a category is present in both mark and remove, remove takes precedence. ' | |
1432 | 'The syntax and available categories are the same as for --sponsorblock-mark')) | |
1433 | sponsorblock.add_option( | |
1434 | '--sponsorblock-chapter-title', metavar='TEMPLATE', | |
1435 | default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title', | |
1436 | help=( | |
1437 | 'The title template for SponsorBlock chapters created by --sponsorblock-mark. ' | |
1438 | 'The same syntax as the output template is used, but the only available fields are ' | |
1439 | 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"')) | |
1440 | sponsorblock.add_option( | |
1441 | '--no-sponsorblock', default=False, | |
1442 | action='store_true', dest='no_sponsorblock', | |
1443 | help='Disable both --sponsorblock-mark and --sponsorblock-remove') | |
1444 | sponsorblock.add_option( | |
1445 | '--sponsorblock-api', metavar='URL', | |
1446 | default='https://sponsor.ajay.app', dest='sponsorblock_api', | |
1447 | help='SponsorBlock API location, defaults to %default') | |
1448 | ||
1449 | sponsorblock.add_option( | |
1450 | '--sponskrub', | |
1451 | action='store_true', dest='sponskrub', default=False, | |
1452 | help=optparse.SUPPRESS_HELP) | |
1453 | sponsorblock.add_option( | |
1454 | '--no-sponskrub', | |
1455 | action='store_false', dest='sponskrub', | |
1456 | help=optparse.SUPPRESS_HELP) | |
1457 | sponsorblock.add_option( | |
1458 | '--sponskrub-cut', default=False, | |
1459 | action='store_true', dest='sponskrub_cut', | |
1460 | help=optparse.SUPPRESS_HELP) | |
1461 | sponsorblock.add_option( | |
1462 | '--no-sponskrub-cut', | |
1463 | action='store_false', dest='sponskrub_cut', | |
1464 | help=optparse.SUPPRESS_HELP) | |
1465 | sponsorblock.add_option( | |
1466 | '--sponskrub-force', default=False, | |
1467 | action='store_true', dest='sponskrub_force', | |
1468 | help=optparse.SUPPRESS_HELP) | |
1469 | sponsorblock.add_option( | |
1470 | '--no-sponskrub-force', | |
1471 | action='store_true', dest='sponskrub_force', | |
1472 | help=optparse.SUPPRESS_HELP) | |
1473 | sponsorblock.add_option( | |
1474 | '--sponskrub-location', metavar='PATH', | |
1475 | dest='sponskrub_path', default='', | |
1476 | help=optparse.SUPPRESS_HELP) | |
1477 | sponsorblock.add_option( | |
1478 | '--sponskrub-args', dest='sponskrub_args', metavar='ARGS', | |
1479 | help=optparse.SUPPRESS_HELP) | |
1480 | ||
1481 | extractor = optparse.OptionGroup(parser, 'Extractor Options') | |
1482 | extractor.add_option( | |
1483 | '--extractor-retries', | |
1484 | dest='extractor_retries', metavar='RETRIES', default=3, | |
1485 | help='Number of retries for known extractor errors (default is %default), or "infinite"') | |
1486 | extractor.add_option( | |
1487 | '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd', | |
1488 | action='store_true', dest='dynamic_mpd', default=True, | |
1489 | help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)') | |
1490 | extractor.add_option( | |
1491 | '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd', | |
1492 | action='store_false', dest='dynamic_mpd', | |
1493 | help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)') | |
1494 | extractor.add_option( | |
1495 | '--hls-split-discontinuity', | |
1496 | dest='hls_split_discontinuity', action='store_true', default=False, | |
1497 | help='Split HLS playlists to different formats at discontinuities such as ad breaks' | |
1498 | ) | |
1499 | extractor.add_option( | |
1500 | '--no-hls-split-discontinuity', | |
1501 | dest='hls_split_discontinuity', action='store_false', | |
1502 | help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)') | |
1503 | _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [val.strip() for val in vals.split(',')]) | |
1504 | extractor.add_option( | |
1505 | '--extractor-args', | |
1506 | metavar='KEY:ARGS', dest='extractor_args', default={}, type='str', | |
1507 | action='callback', callback=_dict_from_options_callback, | |
1508 | callback_kwargs={ | |
1509 | 'multiple_keys': False, | |
1510 | 'process': lambda val: dict( | |
1511 | _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';')) | |
1512 | }, help=( | |
1513 | 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. ' | |
1514 | 'You can use this option multiple times to give arguments for different extractors')) | |
1515 | extractor.add_option( | |
1516 | '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest', | |
1517 | action='store_true', dest='youtube_include_dash_manifest', default=True, | |
1518 | help=optparse.SUPPRESS_HELP) | |
1519 | extractor.add_option( | |
1520 | '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest', | |
1521 | action='store_false', dest='youtube_include_dash_manifest', | |
1522 | help=optparse.SUPPRESS_HELP) | |
1523 | extractor.add_option( | |
1524 | '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest', | |
1525 | action='store_true', dest='youtube_include_hls_manifest', default=True, | |
1526 | help=optparse.SUPPRESS_HELP) | |
1527 | extractor.add_option( | |
1528 | '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest', | |
1529 | action='store_false', dest='youtube_include_hls_manifest', | |
1530 | help=optparse.SUPPRESS_HELP) | |
1531 | ||
1532 | parser.add_option_group(general) | |
1533 | parser.add_option_group(network) | |
1534 | parser.add_option_group(geo) | |
1535 | parser.add_option_group(selection) | |
1536 | parser.add_option_group(downloader) | |
1537 | parser.add_option_group(filesystem) | |
1538 | parser.add_option_group(thumbnail) | |
1539 | parser.add_option_group(link) | |
1540 | parser.add_option_group(verbosity) | |
1541 | parser.add_option_group(workarounds) | |
1542 | parser.add_option_group(video_format) | |
1543 | parser.add_option_group(subtitles) | |
1544 | parser.add_option_group(authentication) | |
1545 | parser.add_option_group(postproc) | |
1546 | parser.add_option_group(sponsorblock) | |
1547 | parser.add_option_group(extractor) | |
1548 | ||
1549 | if overrideArguments is not None: | |
1550 | opts, args = parser.parse_args(overrideArguments) | |
1551 | if opts.verbose: | |
1552 | write_string('[debug] Override config: ' + repr(overrideArguments) + '\n') | |
1553 | else: | |
1554 | def compat_conf(conf): | |
1555 | if sys.version_info < (3,): | |
1556 | return [a.decode(preferredencoding(), 'replace') for a in conf] | |
1557 | return conf | |
1558 | ||
1559 | configs = { | |
1560 | 'command-line': compat_conf(sys.argv[1:]), | |
1561 | 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []} | |
1562 | paths = {'command-line': False} | |
1563 | ||
1564 | def read_options(name, path, user=False): | |
1565 | ''' loads config files and returns ignoreconfig ''' | |
1566 | # Multiple package names can be given here | |
1567 | # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for | |
1568 | # the configuration file of any of these three packages | |
1569 | for package in ('yt-dlp',): | |
1570 | if user: | |
1571 | config, current_path = _readUserConf(package, default=None) | |
1572 | else: | |
1573 | current_path = os.path.join(path, '%s.conf' % package) | |
1574 | config = _readOptions(current_path, default=None) | |
1575 | if config is not None: | |
1576 | configs[name], paths[name] = config, current_path | |
1577 | return parser.parse_args(config)[0].ignoreconfig | |
1578 | return False | |
1579 | ||
1580 | def get_configs(): | |
1581 | opts, _ = parser.parse_args(configs['command-line']) | |
1582 | if opts.config_location is not None: | |
1583 | location = compat_expanduser(opts.config_location) | |
1584 | if os.path.isdir(location): | |
1585 | location = os.path.join(location, 'yt-dlp.conf') | |
1586 | if not os.path.exists(location): | |
1587 | parser.error('config-location %s does not exist.' % location) | |
1588 | config = _readOptions(location, default=None) | |
1589 | if config: | |
1590 | configs['custom'], paths['config'] = config, location | |
1591 | ||
1592 | if opts.ignoreconfig: | |
1593 | return | |
1594 | if parser.parse_args(configs['custom'])[0].ignoreconfig: | |
1595 | return | |
1596 | if read_options('portable', get_executable_path()): | |
1597 | return | |
1598 | opts, _ = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line']) | |
1599 | if read_options('home', expand_path(opts.paths.get('home', '')).strip()): | |
1600 | return | |
1601 | if read_options('system', '/etc'): | |
1602 | return | |
1603 | if read_options('user', None, user=True): | |
1604 | configs['system'], paths['system'] = [], None | |
1605 | ||
1606 | get_configs() | |
1607 | argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line'] | |
1608 | opts, args = parser.parse_args(argv) | |
1609 | if opts.verbose: | |
1610 | for label in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'): | |
1611 | key = label.lower() | |
1612 | if paths.get(key): | |
1613 | write_string(f'[debug] {label} config file: {paths[key]}\n') | |
1614 | if paths.get(key) is not None: | |
1615 | write_string(f'[debug] {label} config: {_hide_login_info(configs[key])!r}\n') | |
1616 | ||
1617 | return parser, opts, args |