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