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