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