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