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