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