10 from .compat
import compat_expanduser
, compat_get_terminal_size
, compat_getenv
11 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
12 from .downloader
.external
import list_external_downloaders
13 from .postprocessor
import (
15 FFmpegSubtitlesConvertorPP
,
16 FFmpegThumbnailsConvertorPP
,
20 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
21 from .update
import detect_variant
32 from .version
import __version__
35 def parseOpts(overrideArguments
=None, ignore_config_files
='if_override'):
36 root
= Config(create_parser())
37 if ignore_config_files
== 'if_override':
38 ignore_config_files
= overrideArguments
is not None
40 def _readUserConf(package_name
, default
=[]):
42 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
43 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
44 if not os
.path
.isfile(userConfFile
):
45 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
46 userConf
= Config
.read_file(userConfFile
, default
=None)
47 if userConf
is not None:
48 return userConf
, userConfFile
51 appdata_dir
= compat_getenv('appdata')
53 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
54 userConf
= Config
.read_file(userConfFile
, default
=None)
56 userConfFile
+= '.txt'
57 userConf
= Config
.read_file(userConfFile
, default
=None)
58 if userConf
is not None:
59 return userConf
, userConfFile
62 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
63 userConf
= Config
.read_file(userConfFile
, default
=None)
65 userConfFile
+= '.txt'
66 userConf
= Config
.read_file(userConfFile
, default
=None)
67 if userConf
is not None:
68 return userConf
, userConfFile
72 def add_config(label
, path
, user
=False):
73 """ Adds config and returns whether to continue """
74 if root
.parse_known_args()[0].ignoreconfig
:
76 # Multiple package names can be given here
77 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
78 # the configuration file of any of these three packages
79 for package
in ('yt-dlp',):
81 args
, current_path
= _readUserConf(package
, default
=None)
83 current_path
= os
.path
.join(path
, '%s.conf' % package
)
84 args
= Config
.read_file(current_path
, default
=None)
86 root
.append_config(args
, current_path
, label
=label
)
91 yield not ignore_config_files
92 yield add_config('Portable', get_executable_path())
93 yield add_config('Home', expand_path(root
.parse_known_args()[0].paths
.get('home', '')).strip())
94 yield add_config('User', None, user
=True)
95 yield add_config('System', '/etc')
97 opts
= optparse
.Values({'verbose': True, 'print_help': False}
)
100 root
.append_config(overrideArguments
, label
='Override')
102 root
.append_config(sys
.argv
[1:], label
='Command-line')
104 if all(load_configs()):
105 # If ignoreconfig is found inside the system configuration file,
106 # the user configuration is removed
107 if root
.parse_known_args()[0].ignoreconfig
:
108 user_conf
= next((i
for i
, conf
in enumerate(root
.configs
) if conf
.label
== 'User'), None)
109 if user_conf
is not None:
110 root
.configs
.pop(user_conf
)
112 opts
, args
= root
.parse_args()
113 except optparse
.OptParseError
:
114 with contextlib
.suppress(optparse
.OptParseError
):
115 opts
, _
= root
.parse_known_args(strict
=False)
117 except (SystemExit, KeyboardInterrupt):
121 verbose
= opts
.verbose
and f
'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
123 write_string(f
'{verbose}\n')
127 root
.parser
.print_help()
130 return root
.parser
, opts
, args
133 class _YoutubeDLHelpFormatter(optparse
.IndentedHelpFormatter
):
135 # No need to wrap help messages if we're on a wide console
136 max_width
= compat_get_terminal_size().columns
or 80
137 # The % is chosen to get a pretty output in README.md
138 super().__init
__(width
=max_width
, max_help_position
=int(0.45 * max_width
))
141 def format_option_strings(option
):
142 """ ('-o', '--option') -> -o, --format METAVAR """
143 opts
= join_nonempty(
144 option
._short
_opts
and option
._short
_opts
[0],
145 option
._long
_opts
and option
._long
_opts
[0],
147 if option
.takes_value():
148 opts
+= f
' {option.metavar}'
152 class _YoutubeDLOptionParser(optparse
.OptionParser
):
153 # optparse is deprecated since python 3.2. So assume a stable interface even for private methods
154 ALIAS_TRIGGER_LIMIT
= 100
158 prog
='yt-dlp' if detect_variant() == 'source' else None,
160 usage
='%prog [OPTIONS] URL [URL...]',
161 epilog
='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
162 formatter
=_YoutubeDLHelpFormatter(),
163 conflict_handler
='resolve',
166 _UNKNOWN_OPTION
= (optparse
.BadOptionError
, optparse
.AmbiguousOptionError
)
167 _BAD_OPTION
= optparse
.OptionValueError
169 def parse_known_args(self
, args
=None, values
=None, strict
=True):
170 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
171 self
.rargs
, self
.largs
= self
._get
_args
(args
), []
172 self
.values
= values
or self
.get_default_values()
175 self
._process
_args
(self
.largs
, self
.rargs
, self
.values
)
176 except optparse
.OptParseError
as err
:
177 if isinstance(err
, self
._UNKNOWN
_OPTION
):
178 self
.largs
.append(err
.opt_str
)
180 if isinstance(err
, self
._BAD
_OPTION
):
183 return self
.check_values(self
.values
, self
.largs
)
185 def error(self
, msg
):
186 msg
= f
'{self.get_prog_name()}: error: {msg.strip()}\n'
187 raise optparse
.OptParseError(f
'{self.get_usage()}\n{msg}' if self
.usage
else msg
)
189 def _get_args(self
, args
):
190 return sys
.argv
[1:] if args
is None else list(args
)
192 def _match_long_opt(self
, opt
):
193 """Improve ambigious argument resolution by comparing option objects instead of argument strings"""
195 return super()._match
_long
_opt
(opt
)
196 except optparse
.AmbiguousOptionError
as e
:
197 if len({self._long_opt[p] for p in e.possibilities}
) == 1:
198 return e
.possibilities
[0]
203 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
204 # append can be True, False or -1 (prepend)
205 current
= list(getattr(parser
.values
, option
.dest
)) if append
else []
206 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
208 parser
.values
, option
.dest
,
209 current
+ value
if append
is True else value
+ current
)
211 def _set_from_options_callback(
212 option
, opt_str
, value
, parser
, delim
=',', allowed_values
=None, aliases
={},
213 process
=lambda x
: x
.lower().strip()):
214 current
= set(getattr(parser
.values
, option
.dest
))
215 values
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)[::-1]))
217 actual_val
= val
= values
.pop()
219 raise optparse
.OptionValueError(f
'Invalid {option.metavar} for {opt_str}: {value}')
221 current
.update(allowed_values
)
225 values
.extend(aliases
[val
])
231 current
.update([val
])
232 if allowed_values
is not None and val
not in allowed_values
:
233 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
235 setattr(parser
.values
, option
.dest
, current
)
237 def _dict_from_options_callback(
238 option
, opt_str
, value
, parser
,
239 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
240 process_key
=str.lower
, append
=False):
242 out_dict
= dict(getattr(parser
.values
, option
.dest
))
243 multiple_args
= not isinstance(value
, str)
245 allowed_keys
= fr
'({allowed_keys})(,({allowed_keys}))*'
247 fr
'(?i)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
248 value
[0] if multiple_args
else value
)
250 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
252 val
= [val
, *value
[1:]]
253 elif default_key
is not None:
254 keys
, val
= [default_key
], value
256 raise optparse
.OptionValueError(
257 f
'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
259 keys
= map(process_key
, keys
) if process_key
else keys
260 val
= process(val
) if process
else val
261 except Exception as err
:
262 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
264 out_dict
[key
] = out_dict
.get(key
, []) + [val
] if append
else val
265 setattr(parser
.values
, option
.dest
, out_dict
)
267 parser
= _YoutubeDLOptionParser()
268 alias_group
= optparse
.OptionGroup(parser
, 'Aliases')
269 Formatter
= string
.Formatter()
271 def _create_alias(option
, opt_str
, value
, parser
):
272 aliases
, opts
= value
274 nargs
= len({i
if f
== '' else f
275 for i
, (_
, f
, _
, _
) in enumerate(Formatter
.parse(opts
)) if f
is not None})
276 opts
.format(*map(str, range(nargs
))) # validate
277 except Exception as err
:
278 raise optparse
.OptionValueError(f
'wrong {opt_str} OPTIONS formatting; {err}')
279 if alias_group
not in parser
.option_groups
:
280 parser
.add_option_group(alias_group
)
282 aliases
= (x
if x
.startswith('-') else f
'--{x}' for x
in map(str.strip
, aliases
.split(',')))
284 alias_group
.add_option(
285 *aliases
, help=opts
, nargs
=nargs
, type='str' if nargs
else None,
286 dest
='_triggered_aliases', default
=collections
.defaultdict(int),
287 metavar
=' '.join(f
'ARG{i}' for i
in range(nargs
)), action
='callback',
288 callback
=_alias_callback
, callback_kwargs
={'opts': opts, 'nargs': nargs}
)
289 except Exception as err
:
290 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
292 def _alias_callback(option
, opt_str
, value
, parser
, opts
, nargs
):
293 counter
= getattr(parser
.values
, option
.dest
)
294 counter
[opt_str
] += 1
295 if counter
[opt_str
] > parser
.ALIAS_TRIGGER_LIMIT
:
296 raise optparse
.OptionValueError(f
'Alias {opt_str} exceeded invocation limit')
299 assert (nargs
== 0 and value
is None) or len(value
) == nargs
300 parser
.rargs
[:0] = shlex
.split(
301 opts
if value
is None else opts
.format(*map(shlex
.quote
, value
)))
303 general
= optparse
.OptionGroup(parser
, 'General Options')
305 '-h', '--help', dest
='print_help', action
='store_true',
306 help='Print this help text and exit')
310 help='Print program version and exit')
313 action
='store_true', dest
='update_self',
314 help='Update this program to latest version')
316 '-i', '--ignore-errors',
317 action
='store_true', dest
='ignoreerrors',
318 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
320 '--no-abort-on-error',
321 action
='store_const', dest
='ignoreerrors', const
='only_download',
322 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
324 '--abort-on-error', '--no-ignore-errors',
325 action
='store_false', dest
='ignoreerrors',
326 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
329 action
='store_true', dest
='dump_user_agent', default
=False,
330 help='Display the current user-agent and exit')
333 action
='store_true', dest
='list_extractors', default
=False,
334 help='List all supported extractors and exit')
336 '--extractor-descriptions',
337 action
='store_true', dest
='list_extractor_descriptions', default
=False,
338 help='Output descriptions of all supported extractors and exit')
340 '--force-generic-extractor',
341 action
='store_true', dest
='force_generic_extractor', default
=False,
342 help='Force extraction to use the generic extractor')
345 dest
='default_search', metavar
='PREFIX',
347 'Use this prefix for unqualified URLs. '
348 'Eg: "gvsearch2:python" downloads two videos from google videos for the search term "python". '
349 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
350 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
351 'but emits an error if this is not possible instead of searching'))
353 '--ignore-config', '--no-config',
354 action
='store_true', dest
='ignoreconfig',
356 'Don\'t load any more configuration files except those given by --config-locations. '
357 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
358 '(Alias: --no-config)'))
360 '--no-config-locations',
361 action
='store_const', dest
='config_locations', const
=[],
363 'Do not load any custom configuration files (default). When given inside a '
364 'configuration file, ignore all previous --config-locations defined in the current file'))
366 '--config-locations',
367 dest
='config_locations', metavar
='PATH', action
='append',
369 'Location of the main configuration file; either the path to the config or its containing directory '
370 '("-" for stdin). Can be used multiple times and inside other configuration files'))
373 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
374 help='Do not extract the videos of a playlist, only list them')
376 '--no-flat-playlist',
377 action
='store_false', dest
='extract_flat',
378 help='Extract the videos of a playlist')
381 action
='store_true', dest
='live_from_start',
382 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
384 '--no-live-from-start',
385 action
='store_false', dest
='live_from_start',
386 help='Download livestreams from the current time (default)')
389 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
391 'Wait for scheduled streams to become available. '
392 'Pass the minimum number of seconds (or range) to wait between retries'))
394 '--no-wait-for-video',
395 dest
='wait_for_video', action
='store_const', const
=None,
396 help='Do not wait for scheduled streams (default)')
399 action
='store_true', dest
='mark_watched', default
=False,
400 help='Mark videos watched (even with --simulate)')
403 action
='store_false', dest
='mark_watched',
404 help='Do not mark videos watched (default)')
407 action
='store_true', dest
='no_color', default
=False,
408 help='Do not emit color codes in output')
411 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
412 action
='callback', callback
=_set_from_options_callback
,
415 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
416 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
417 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', 'embed-metadata',
418 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
420 'youtube-dl': ['-multistreams', 'all'],
421 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
424 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
425 'configurations by reverting some of the changes made in yt-dlp. '
426 'See "Differences in default behavior" for details'))
428 '--alias', metavar
='ALIASES OPTIONS', dest
='_', type='str', nargs
=2,
429 action
='callback', callback
=_create_alias
,
431 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
432 'Arguments are parsed according to the Python string formatting mini-language. '
433 'Eg: --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
434 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
435 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
436 'Alias options can trigger more aliases; so be carefull to avoid defining recursive options. '
437 f
'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
438 'This option can be used multiple times'))
440 network
= optparse
.OptionGroup(parser
, 'Network Options')
442 '--proxy', dest
='proxy',
443 default
=None, metavar
='URL',
445 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme. '
446 'Eg: socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
449 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
450 help='Time to wait before giving up, in seconds')
453 metavar
='IP', dest
='source_address', default
=None,
454 help='Client-side IP address to bind to',
457 '-4', '--force-ipv4',
458 action
='store_const', const
='0.0.0.0', dest
='source_address',
459 help='Make all connections via IPv4',
462 '-6', '--force-ipv6',
463 action
='store_const', const
='::', dest
='source_address',
464 help='Make all connections via IPv6',
467 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
469 '--geo-verification-proxy',
470 dest
='geo_verification_proxy', default
=None, metavar
='URL',
472 'Use this proxy to verify the IP address for some geo-restricted sites. '
473 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
475 '--cn-verification-proxy',
476 dest
='cn_verification_proxy', default
=None, metavar
='URL',
477 help=optparse
.SUPPRESS_HELP
)
480 action
='store_true', dest
='geo_bypass', default
=True,
481 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header (default)')
484 action
='store_false', dest
='geo_bypass',
485 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
487 '--geo-bypass-country', metavar
='CODE',
488 dest
='geo_bypass_country', default
=None,
489 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
491 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
492 dest
='geo_bypass_ip_block', default
=None,
493 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
495 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
496 selection
.add_option(
498 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
499 help='Playlist video to start at (default is %default)')
500 selection
.add_option(
502 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
503 help='Playlist video to end at (default is last)')
504 selection
.add_option(
506 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
507 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')
508 selection
.add_option(
510 dest
='matchtitle', metavar
='REGEX',
511 help=optparse
.SUPPRESS_HELP
)
512 selection
.add_option(
514 dest
='rejecttitle', metavar
='REGEX',
515 help=optparse
.SUPPRESS_HELP
)
516 selection
.add_option(
518 metavar
='SIZE', dest
='min_filesize', default
=None,
519 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
520 selection
.add_option(
522 metavar
='SIZE', dest
='max_filesize', default
=None,
523 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
524 selection
.add_option(
526 metavar
='DATE', dest
='date', default
=None,
528 'Download only videos uploaded on this date. The date can be "YYYYMMDD" or in the format '
529 '[now|today|yesterday][-N[day|week|month|year]]. Eg: --date today-2weeks'))
530 selection
.add_option(
532 metavar
='DATE', dest
='datebefore', default
=None,
534 'Download only videos uploaded on or before this date. '
535 'The date formats accepted is the same as --date'))
536 selection
.add_option(
538 metavar
='DATE', dest
='dateafter', default
=None,
540 'Download only videos uploaded on or after this date. '
541 'The date formats accepted is the same as --date'))
542 selection
.add_option(
544 metavar
='COUNT', dest
='min_views', default
=None, type=int,
545 help=optparse
.SUPPRESS_HELP
)
546 selection
.add_option(
548 metavar
='COUNT', dest
='max_views', default
=None, type=int,
549 help=optparse
.SUPPRESS_HELP
)
550 selection
.add_option(
552 metavar
='FILTER', dest
='match_filter', action
='append',
554 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
555 'number or a string using the operators defined in "Filtering formats". '
556 'You can also simply specify a field to match if the field is present, '
557 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
558 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
559 'the filter matches if atleast one of the conditions are met. Eg: --match-filter '
560 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
561 'matches only videos that are not live OR those that have a like count more than 100 '
562 '(or the like field is not available) and also has a description '
563 'that contains the phrase "cats & dogs" (caseless). '
564 'Use "--match-filter -" to interactively ask whether to download each video'))
565 selection
.add_option(
567 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
568 help='Do not use generic video filter (default)')
569 selection
.add_option(
571 action
='store_true', dest
='noplaylist', default
=False,
572 help='Download only the video, if the URL refers to a video and a playlist')
573 selection
.add_option(
575 action
='store_false', dest
='noplaylist',
576 help='Download the playlist, if the URL refers to a video and a playlist')
577 selection
.add_option(
579 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
580 help='Download only videos suitable for the given age')
581 selection
.add_option(
582 '--download-archive', metavar
='FILE',
583 dest
='download_archive',
584 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
585 selection
.add_option(
586 '--no-download-archive',
587 dest
='download_archive', action
="store_const", const
=None,
588 help='Do not use archive file (default)')
589 selection
.add_option(
591 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
592 help='Abort after downloading NUMBER files')
593 selection
.add_option(
594 '--break-on-existing',
595 action
='store_true', dest
='break_on_existing', default
=False,
596 help='Stop the download process when encountering a file that is in the archive')
597 selection
.add_option(
599 action
='store_true', dest
='break_on_reject', default
=False,
600 help='Stop the download process when encountering a file that has been filtered out')
601 selection
.add_option(
603 action
='store_true', dest
='break_per_url', default
=False,
604 help='Make --break-on-existing, --break-on-reject and --max-downloads act only on the current input URL')
605 selection
.add_option(
606 '--no-break-per-input',
607 action
='store_false', dest
='break_per_url',
608 help='--break-on-existing and similar options terminates the entire download queue')
609 selection
.add_option(
610 '--skip-playlist-after-errors', metavar
='N',
611 dest
='skip_playlist_after_errors', default
=None, type=int,
612 help='Number of allowed failures until the rest of the playlist is skipped')
613 selection
.add_option(
615 dest
='include_ads', action
='store_true',
616 help=optparse
.SUPPRESS_HELP
)
617 selection
.add_option(
619 dest
='include_ads', action
='store_false',
620 help=optparse
.SUPPRESS_HELP
)
622 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
623 authentication
.add_option(
625 dest
='username', metavar
='USERNAME',
626 help='Login with this account ID')
627 authentication
.add_option(
629 dest
='password', metavar
='PASSWORD',
630 help='Account password. If this option is left out, yt-dlp will ask interactively')
631 authentication
.add_option(
633 dest
='twofactor', metavar
='TWOFACTOR',
634 help='Two-factor authentication code')
635 authentication
.add_option(
637 action
='store_true', dest
='usenetrc', default
=False,
638 help='Use .netrc authentication data')
639 authentication
.add_option(
641 dest
='netrc_location', metavar
='PATH',
642 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
643 authentication
.add_option(
645 dest
='videopassword', metavar
='PASSWORD',
646 help='Video password (vimeo, youku)')
647 authentication
.add_option(
649 dest
='ap_mso', metavar
='MSO',
650 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
651 authentication
.add_option(
653 dest
='ap_username', metavar
='USERNAME',
654 help='Multiple-system operator account login')
655 authentication
.add_option(
657 dest
='ap_password', metavar
='PASSWORD',
658 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
659 authentication
.add_option(
661 action
='store_true', dest
='ap_list_mso', default
=False,
662 help='List all supported multiple-system operators')
663 authentication
.add_option(
664 '--client-certificate',
665 dest
='client_certificate', metavar
='CERTFILE',
666 help='Path to client certificate file in PEM format. May include the private key')
667 authentication
.add_option(
668 '--client-certificate-key',
669 dest
='client_certificate_key', metavar
='KEYFILE',
670 help='Path to private key file for client certificate')
671 authentication
.add_option(
672 '--client-certificate-password',
673 dest
='client_certificate_password', metavar
='PASSWORD',
674 help='Password for client certificate private key, if encrypted. '
675 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
677 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
678 video_format
.add_option(
680 action
='store', dest
='format', metavar
='FORMAT', default
=None,
681 help='Video format code, see "FORMAT SELECTION" for more details')
682 video_format
.add_option(
683 '-S', '--format-sort', metavar
='SORTORDER',
684 dest
='format_sort', default
=[], type='str', action
='callback',
685 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
686 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
687 video_format
.add_option(
688 '--format-sort-force', '--S-force',
689 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
691 'Force user specified sort order to have precedence over all fields, '
692 'see "Sorting Formats" for more details (Alias: --S-force)'))
693 video_format
.add_option(
694 '--no-format-sort-force',
695 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
696 help='Some fields have precedence over the user specified sort order (default)')
697 video_format
.add_option(
698 '--video-multistreams',
699 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
700 help='Allow multiple video streams to be merged into a single file')
701 video_format
.add_option(
702 '--no-video-multistreams',
703 action
='store_false', dest
='allow_multiple_video_streams',
704 help='Only one video stream is downloaded for each output file (default)')
705 video_format
.add_option(
706 '--audio-multistreams',
707 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
708 help='Allow multiple audio streams to be merged into a single file')
709 video_format
.add_option(
710 '--no-audio-multistreams',
711 action
='store_false', dest
='allow_multiple_audio_streams',
712 help='Only one audio stream is downloaded for each output file (default)')
713 video_format
.add_option(
715 action
='store_const', dest
='format', const
='all',
716 help=optparse
.SUPPRESS_HELP
)
717 video_format
.add_option(
718 '--prefer-free-formats',
719 action
='store_true', dest
='prefer_free_formats', default
=False,
721 'Prefer video formats with free containers over non-free ones of same quality. '
722 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
723 video_format
.add_option(
724 '--no-prefer-free-formats',
725 action
='store_false', dest
='prefer_free_formats', default
=False,
726 help="Don't give any special preference to free containers (default)")
727 video_format
.add_option(
729 action
='store_const', const
='selected', dest
='check_formats', default
=None,
730 help='Make sure formats are selected only from those that are actually downloadable')
731 video_format
.add_option(
732 '--check-all-formats',
733 action
='store_true', dest
='check_formats',
734 help='Check all formats for whether they are actually downloadable')
735 video_format
.add_option(
736 '--no-check-formats',
737 action
='store_false', dest
='check_formats',
738 help='Do not check that the formats are actually downloadable')
739 video_format
.add_option(
740 '-F', '--list-formats',
741 action
='store_true', dest
='listformats',
742 help='List available formats of each video. Simulate unless --no-simulate is used')
743 video_format
.add_option(
744 '--list-formats-as-table',
745 action
='store_true', dest
='listformats_table', default
=True,
746 help=optparse
.SUPPRESS_HELP
)
747 video_format
.add_option(
748 '--list-formats-old', '--no-list-formats-as-table',
749 action
='store_false', dest
='listformats_table',
750 help=optparse
.SUPPRESS_HELP
)
751 video_format
.add_option(
752 '--merge-output-format',
753 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
755 'If a merge is required (e.g. bestvideo+bestaudio), '
756 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
757 'Ignored if no merge is required'))
758 video_format
.add_option(
759 '--allow-unplayable-formats',
760 action
='store_true', dest
='allow_unplayable_formats', default
=False,
761 help=optparse
.SUPPRESS_HELP
)
762 video_format
.add_option(
763 '--no-allow-unplayable-formats',
764 action
='store_false', dest
='allow_unplayable_formats',
765 help=optparse
.SUPPRESS_HELP
)
767 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
768 subtitles
.add_option(
769 '--write-subs', '--write-srt',
770 action
='store_true', dest
='writesubtitles', default
=False,
771 help='Write subtitle file')
772 subtitles
.add_option(
773 '--no-write-subs', '--no-write-srt',
774 action
='store_false', dest
='writesubtitles',
775 help='Do not write subtitle file (default)')
776 subtitles
.add_option(
777 '--write-auto-subs', '--write-automatic-subs',
778 action
='store_true', dest
='writeautomaticsub', default
=False,
779 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
780 subtitles
.add_option(
781 '--no-write-auto-subs', '--no-write-automatic-subs',
782 action
='store_false', dest
='writeautomaticsub', default
=False,
783 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
784 subtitles
.add_option(
786 action
='store_true', dest
='allsubtitles', default
=False,
787 help=optparse
.SUPPRESS_HELP
)
788 subtitles
.add_option(
790 action
='store_true', dest
='listsubtitles', default
=False,
791 help='List available subtitles of each video. Simulate unless --no-simulate is used')
792 subtitles
.add_option(
794 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
795 help='Subtitle format; accepts formats preference, Eg: "srt" or "ass/srt/best"')
796 subtitles
.add_option(
797 '--sub-langs', '--srt-langs',
798 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
799 default
=[], callback
=_list_from_options_callback
,
801 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
802 'You can prefix the language code with a "-" to exclude it from the requested languages. (Eg: --sub-langs all,-live_chat) '
803 'Use --list-subs for a list of available language tags'))
805 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
806 downloader
.add_option(
807 '-N', '--concurrent-fragments',
808 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
809 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
810 downloader
.add_option(
811 '-r', '--limit-rate', '--rate-limit',
812 dest
='ratelimit', metavar
='RATE',
813 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
814 downloader
.add_option(
816 dest
='throttledratelimit', metavar
='RATE',
817 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
818 downloader
.add_option(
820 dest
='retries', metavar
='RETRIES', default
=10,
821 help='Number of retries (default is %default), or "infinite"')
822 downloader
.add_option(
823 '--file-access-retries',
824 dest
='file_access_retries', metavar
='RETRIES', default
=3,
825 help='Number of times to retry on file access error (default is %default), or "infinite"')
826 downloader
.add_option(
827 '--fragment-retries',
828 dest
='fragment_retries', metavar
='RETRIES', default
=10,
829 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
830 downloader
.add_option(
832 dest
='retry_sleep', metavar
='[TYPE:]EXPR', default
={}, type='str',
833 action
='callback', callback
=_dict_from_options_callback
,
835 'allowed_keys': 'http|fragment|file_access',
836 'default_key': 'http',
838 'An expression for the time to sleep between retries in seconds (optionally) prefixed '
839 'by the type of retry (file_access, fragment, http (default)) to apply the sleep to. '
840 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
841 'This option can be used multiple times to set the sleep for the different retry types. '
842 'Eg: --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
843 downloader
.add_option(
844 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
845 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
846 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragment)')
847 downloader
.add_option(
848 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
849 action
='store_false', dest
='skip_unavailable_fragments',
850 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
851 downloader
.add_option(
853 action
='store_true', dest
='keep_fragments', default
=False,
854 help='Keep downloaded fragments on disk after downloading is finished')
855 downloader
.add_option(
856 '--no-keep-fragments',
857 action
='store_false', dest
='keep_fragments',
858 help='Delete downloaded fragments after downloading is finished (default)')
859 downloader
.add_option(
861 dest
='buffersize', metavar
='SIZE', default
='1024',
862 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
863 downloader
.add_option(
865 action
='store_false', dest
='noresizebuffer',
866 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
867 downloader
.add_option(
868 '--no-resize-buffer',
869 action
='store_true', dest
='noresizebuffer', default
=False,
870 help='Do not automatically adjust the buffer size')
871 downloader
.add_option(
873 dest
='http_chunk_size', metavar
='SIZE', default
=None,
875 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
876 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
877 downloader
.add_option(
879 action
='store_true', dest
='test', default
=False,
880 help=optparse
.SUPPRESS_HELP
)
881 downloader
.add_option(
882 '--playlist-reverse',
884 help='Download playlist videos in reverse order')
885 downloader
.add_option(
886 '--no-playlist-reverse',
887 action
='store_false', dest
='playlist_reverse',
888 help='Download playlist videos in default order (default)')
889 downloader
.add_option(
892 help='Download playlist videos in random order')
893 downloader
.add_option(
894 '--xattr-set-filesize',
895 dest
='xattr_set_filesize', action
='store_true',
896 help='Set file xattribute ytdl.filesize with expected file size')
897 downloader
.add_option(
898 '--hls-prefer-native',
899 dest
='hls_prefer_native', action
='store_true', default
=None,
900 help=optparse
.SUPPRESS_HELP
)
901 downloader
.add_option(
902 '--hls-prefer-ffmpeg',
903 dest
='hls_prefer_native', action
='store_false', default
=None,
904 help=optparse
.SUPPRESS_HELP
)
905 downloader
.add_option(
907 dest
='hls_use_mpegts', action
='store_true', default
=None,
909 'Use the mpegts container for HLS videos; '
910 'allowing some players to play the video while downloading, '
911 'and reducing the chance of file corruption if download is interrupted. '
912 'This is enabled by default for live streams'))
913 downloader
.add_option(
914 '--no-hls-use-mpegts',
915 dest
='hls_use_mpegts', action
='store_false',
917 'Do not use the mpegts container for HLS videos. '
918 'This is default when not downloading live streams'))
919 downloader
.add_option(
920 '--downloader', '--external-downloader',
921 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
922 action
='callback', callback
=_dict_from_options_callback
,
924 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
925 'default_key': 'default',
928 'Name or path of the external downloader to use (optionally) prefixed by '
929 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
930 f
'Currently supports native, {", ".join(list_external_downloaders())}. '
931 'You can use this option multiple times to set different downloaders for different protocols. '
932 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
933 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
934 '(Alias: --external-downloader)'))
935 downloader
.add_option(
936 '--downloader-args', '--external-downloader-args',
937 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
938 action
='callback', callback
=_dict_from_options_callback
,
940 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(map(re
.escape
, list_external_downloaders())),
941 'default_key': 'default',
942 'process': shlex
.split
944 'Give these arguments to the external downloader. '
945 'Specify the downloader name and the arguments separated by a colon ":". '
946 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
947 'You can use this option multiple times to give different arguments to different downloaders '
948 '(Alias: --external-downloader-args)'))
950 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
951 workarounds
.add_option(
953 dest
='encoding', metavar
='ENCODING',
954 help='Force the specified encoding (experimental)')
955 workarounds
.add_option(
956 '--legacy-server-connect',
957 action
='store_true', dest
='legacy_server_connect', default
=False,
958 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
959 workarounds
.add_option(
960 '--no-check-certificates',
961 action
='store_true', dest
='no_check_certificate', default
=False,
962 help='Suppress HTTPS certificate validation')
963 workarounds
.add_option(
964 '--prefer-insecure', '--prefer-unsecure',
965 action
='store_true', dest
='prefer_insecure',
966 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
967 workarounds
.add_option(
969 metavar
='UA', dest
='user_agent',
970 help=optparse
.SUPPRESS_HELP
)
971 workarounds
.add_option(
973 metavar
='URL', dest
='referer', default
=None,
974 help=optparse
.SUPPRESS_HELP
)
975 workarounds
.add_option(
977 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
978 action
='callback', callback
=_dict_from_options_callback
,
979 callback_kwargs
={'multiple_keys': False}
,
980 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
982 workarounds
.add_option(
984 dest
='bidi_workaround', action
='store_true',
985 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
986 workarounds
.add_option(
987 '--sleep-requests', metavar
='SECONDS',
988 dest
='sleep_interval_requests', type=float,
989 help='Number of seconds to sleep between requests during data extraction')
990 workarounds
.add_option(
991 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
992 dest
='sleep_interval', type=float,
994 'Number of seconds to sleep before each download. '
995 'This is the minimum time to sleep when used along with --max-sleep-interval '
996 '(Alias: --min-sleep-interval)'))
997 workarounds
.add_option(
998 '--max-sleep-interval', metavar
='SECONDS',
999 dest
='max_sleep_interval', type=float,
1000 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1001 workarounds
.add_option(
1002 '--sleep-subtitles', metavar
='SECONDS',
1003 dest
='sleep_interval_subtitles', default
=0, type=int,
1004 help='Number of seconds to sleep before each subtitle download')
1006 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
1007 verbosity
.add_option(
1009 action
='store_true', dest
='quiet', default
=False,
1010 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1011 verbosity
.add_option(
1013 dest
='no_warnings', action
='store_true', default
=False,
1014 help='Ignore warnings')
1015 verbosity
.add_option(
1017 action
='store_true', dest
='simulate', default
=None,
1018 help='Do not download the video and do not write anything to disk')
1019 verbosity
.add_option(
1021 action
='store_false', dest
='simulate',
1022 help='Download the video even if printing/listing options are used')
1023 verbosity
.add_option(
1024 '--ignore-no-formats-error',
1025 action
='store_true', dest
='ignore_no_formats_error', default
=False,
1027 'Ignore "No video formats" error. Useful for extracting metadata '
1028 'even if the videos are not actually available for download (experimental)'))
1029 verbosity
.add_option(
1030 '--no-ignore-no-formats-error',
1031 action
='store_false', dest
='ignore_no_formats_error',
1032 help='Throw error when no downloadable video formats are found (default)')
1033 verbosity
.add_option(
1034 '--skip-download', '--no-download',
1035 action
='store_true', dest
='skip_download', default
=False,
1036 help='Do not download the video but write all related files (Alias: --no-download)')
1037 verbosity
.add_option(
1039 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', default
={}, type='str',
1040 action
='callback', callback
=_dict_from_options_callback
,
1042 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
1043 'default_key': 'video',
1044 'multiple_keys': False,
1047 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1048 'Supported values of "WHEN" are the same as that of --use-postprocessor, and "video" (default). '
1049 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1050 'This option can be used multiple times'))
1051 verbosity
.add_option(
1053 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', default
={}, type='str', nargs
=2,
1054 action
='callback', callback
=_dict_from_options_callback
,
1056 'allowed_keys': 'video|' + '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
1057 'default_key': 'video',
1058 'multiple_keys': False,
1061 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1062 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1063 verbosity
.add_option(
1065 action
='store_true', dest
='geturl', default
=False,
1066 help=optparse
.SUPPRESS_HELP
)
1067 verbosity
.add_option(
1068 '-e', '--get-title',
1069 action
='store_true', dest
='gettitle', default
=False,
1070 help=optparse
.SUPPRESS_HELP
)
1071 verbosity
.add_option(
1073 action
='store_true', dest
='getid', default
=False,
1074 help=optparse
.SUPPRESS_HELP
)
1075 verbosity
.add_option(
1077 action
='store_true', dest
='getthumbnail', default
=False,
1078 help=optparse
.SUPPRESS_HELP
)
1079 verbosity
.add_option(
1080 '--get-description',
1081 action
='store_true', dest
='getdescription', default
=False,
1082 help=optparse
.SUPPRESS_HELP
)
1083 verbosity
.add_option(
1085 action
='store_true', dest
='getduration', default
=False,
1086 help=optparse
.SUPPRESS_HELP
)
1087 verbosity
.add_option(
1089 action
='store_true', dest
='getfilename', default
=False,
1090 help=optparse
.SUPPRESS_HELP
)
1091 verbosity
.add_option(
1093 action
='store_true', dest
='getformat', default
=False,
1094 help=optparse
.SUPPRESS_HELP
)
1095 verbosity
.add_option(
1096 '-j', '--dump-json',
1097 action
='store_true', dest
='dumpjson', default
=False,
1098 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
1099 verbosity
.add_option(
1100 '-J', '--dump-single-json',
1101 action
='store_true', dest
='dump_single_json', default
=False,
1103 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1104 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1105 verbosity
.add_option(
1107 action
='store_true', dest
='print_json', default
=False,
1108 help=optparse
.SUPPRESS_HELP
)
1109 verbosity
.add_option(
1110 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1111 action
='store_true', dest
='force_write_download_archive', default
=False,
1113 'Force download archive entries to be written as far as no errors occur, '
1114 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1115 verbosity
.add_option(
1117 action
='store_true', dest
='progress_with_newline', default
=False,
1118 help='Output progress bar as new lines')
1119 verbosity
.add_option(
1121 action
='store_true', dest
='noprogress', default
=None,
1122 help='Do not print progress bar')
1123 verbosity
.add_option(
1125 action
='store_false', dest
='noprogress',
1126 help='Show progress bar, even if in quiet mode')
1127 verbosity
.add_option(
1129 action
='store_true', dest
='consoletitle', default
=False,
1130 help='Display progress in console titlebar')
1131 verbosity
.add_option(
1132 '--progress-template',
1133 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1134 action
='callback', callback
=_dict_from_options_callback
,
1136 'allowed_keys': '(download|postprocess)(-title)?',
1137 'default_key': 'download'
1139 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1140 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1141 'The video\'s fields are accessible under the "info" key and '
1142 'the progress attributes are accessible under "progress" key. E.g.: '
1143 # TODO: Document the fields inside "progress"
1144 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1145 verbosity
.add_option(
1147 action
='store_true', dest
='verbose', default
=False,
1148 help='Print various debugging information')
1149 verbosity
.add_option(
1150 '--dump-pages', '--dump-intermediate-pages',
1151 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1152 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1153 verbosity
.add_option(
1155 action
='store_true', dest
='write_pages', default
=False,
1156 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1157 verbosity
.add_option(
1159 action
='store_true', dest
='load_pages', default
=False,
1160 help=optparse
.SUPPRESS_HELP
)
1161 verbosity
.add_option(
1162 '--youtube-print-sig-code',
1163 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1164 help=optparse
.SUPPRESS_HELP
)
1165 verbosity
.add_option(
1166 '--print-traffic', '--dump-headers',
1167 dest
='debug_printtraffic', action
='store_true', default
=False,
1168 help='Display sent and read HTTP traffic')
1169 verbosity
.add_option(
1170 '-C', '--call-home',
1171 dest
='call_home', action
='store_true', default
=False,
1172 # help='Contact the yt-dlp server for debugging')
1173 help=optparse
.SUPPRESS_HELP
)
1174 verbosity
.add_option(
1176 dest
='call_home', action
='store_false',
1177 # help='Do not contact the yt-dlp server for debugging (default)')
1178 help=optparse
.SUPPRESS_HELP
)
1180 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1181 filesystem
.add_option(
1182 '-a', '--batch-file',
1183 dest
='batchfile', metavar
='FILE',
1185 'File containing URLs to download ("-" for stdin), one URL per line. '
1186 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1187 filesystem
.add_option(
1189 dest
='batchfile', action
='store_const', const
=None,
1190 help='Do not read URLs from batch file (default)')
1191 filesystem
.add_option(
1192 '--id', default
=False,
1193 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1194 filesystem
.add_option(
1196 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1197 action
='callback', callback
=_dict_from_options_callback
,
1199 'allowed_keys': 'home|temp|%s' % '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1200 'default_key': 'home'
1202 'The paths where the files should be downloaded. '
1203 'Specify the type of file and the path separated by a colon ":". '
1204 'All the same TYPES as --output are supported. '
1205 'Additionally, you can also provide "home" (default) and "temp" paths. '
1206 'All intermediary files are first downloaded to the temp path and '
1207 'then the final files are moved over to the home path after download is finished. '
1208 'This option is ignored if --output is an absolute path'))
1209 filesystem
.add_option(
1211 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1212 action
='callback', callback
=_dict_from_options_callback
,
1214 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1215 'default_key': 'default'
1216 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1217 filesystem
.add_option(
1218 '--output-na-placeholder',
1219 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1220 help=('Placeholder for unavailable fields in "OUTPUT TEMPLATE" (default: "%default")'))
1221 filesystem
.add_option(
1222 '--autonumber-size',
1223 dest
='autonumber_size', metavar
='NUMBER', type=int,
1224 help=optparse
.SUPPRESS_HELP
)
1225 filesystem
.add_option(
1226 '--autonumber-start',
1227 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1228 help=optparse
.SUPPRESS_HELP
)
1229 filesystem
.add_option(
1230 '--restrict-filenames',
1231 action
='store_true', dest
='restrictfilenames', default
=False,
1232 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1233 filesystem
.add_option(
1234 '--no-restrict-filenames',
1235 action
='store_false', dest
='restrictfilenames',
1236 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1237 filesystem
.add_option(
1238 '--windows-filenames',
1239 action
='store_true', dest
='windowsfilenames', default
=False,
1240 help='Force filenames to be Windows-compatible')
1241 filesystem
.add_option(
1242 '--no-windows-filenames',
1243 action
='store_false', dest
='windowsfilenames',
1244 help='Make filenames Windows-compatible only if using Windows (default)')
1245 filesystem
.add_option(
1246 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1247 dest
='trim_file_name', default
=0, type=int,
1248 help='Limit the filename length (excluding extension) to the specified number of characters')
1249 filesystem
.add_option(
1250 '-w', '--no-overwrites',
1251 action
='store_false', dest
='overwrites', default
=None,
1252 help='Do not overwrite any files')
1253 filesystem
.add_option(
1254 '--force-overwrites', '--yes-overwrites',
1255 action
='store_true', dest
='overwrites',
1256 help='Overwrite all video and metadata files. This option includes --no-continue')
1257 filesystem
.add_option(
1258 '--no-force-overwrites',
1259 action
='store_const', dest
='overwrites', const
=None,
1260 help='Do not overwrite the video, but overwrite related files (default)')
1261 filesystem
.add_option(
1263 action
='store_true', dest
='continue_dl', default
=True,
1264 help='Resume partially downloaded files/fragments (default)')
1265 filesystem
.add_option(
1267 action
='store_false', dest
='continue_dl',
1269 'Do not resume partially downloaded fragments. '
1270 'If the file is not fragmented, restart download of the entire file'))
1271 filesystem
.add_option(
1273 action
='store_false', dest
='nopart', default
=False,
1274 help='Use .part files instead of writing directly into output file (default)')
1275 filesystem
.add_option(
1277 action
='store_true', dest
='nopart',
1278 help='Do not use .part files - write directly into output file')
1279 filesystem
.add_option(
1281 action
='store_true', dest
='updatetime', default
=True,
1282 help='Use the Last-modified header to set the file modification time (default)')
1283 filesystem
.add_option(
1285 action
='store_false', dest
='updatetime',
1286 help='Do not use the Last-modified header to set the file modification time')
1287 filesystem
.add_option(
1288 '--write-description',
1289 action
='store_true', dest
='writedescription', default
=False,
1290 help='Write video description to a .description file')
1291 filesystem
.add_option(
1292 '--no-write-description',
1293 action
='store_false', dest
='writedescription',
1294 help='Do not write video description (default)')
1295 filesystem
.add_option(
1296 '--write-info-json',
1297 action
='store_true', dest
='writeinfojson', default
=None,
1298 help='Write video metadata to a .info.json file (this may contain personal information)')
1299 filesystem
.add_option(
1300 '--no-write-info-json',
1301 action
='store_false', dest
='writeinfojson',
1302 help='Do not write video metadata (default)')
1303 filesystem
.add_option(
1304 '--write-annotations',
1305 action
='store_true', dest
='writeannotations', default
=False,
1306 help=optparse
.SUPPRESS_HELP
)
1307 filesystem
.add_option(
1308 '--no-write-annotations',
1309 action
='store_false', dest
='writeannotations',
1310 help=optparse
.SUPPRESS_HELP
)
1311 filesystem
.add_option(
1312 '--write-playlist-metafiles',
1313 action
='store_true', dest
='allow_playlist_files', default
=None,
1315 'Write playlist metadata in addition to the video metadata '
1316 'when using --write-info-json, --write-description etc. (default)'))
1317 filesystem
.add_option(
1318 '--no-write-playlist-metafiles',
1319 action
='store_false', dest
='allow_playlist_files',
1320 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1321 filesystem
.add_option(
1322 '--clean-info-json', '--clean-infojson',
1323 action
='store_true', dest
='clean_infojson', default
=None,
1325 'Remove some private fields such as filenames from the infojson. '
1326 'Note that it could still contain some personal information (default)'))
1327 filesystem
.add_option(
1328 '--no-clean-info-json', '--no-clean-infojson',
1329 action
='store_false', dest
='clean_infojson',
1330 help='Write all fields to the infojson')
1331 filesystem
.add_option(
1332 '--write-comments', '--get-comments',
1333 action
='store_true', dest
='getcomments', default
=False,
1335 'Retrieve video comments to be placed in the infojson. '
1336 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1337 filesystem
.add_option(
1338 '--no-write-comments', '--no-get-comments',
1339 action
='store_false', dest
='getcomments',
1340 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1341 filesystem
.add_option(
1342 '--load-info-json', '--load-info',
1343 dest
='load_info_filename', metavar
='FILE',
1344 help='JSON file containing the video information (created with the "--write-info-json" option)')
1345 filesystem
.add_option(
1347 dest
='cookiefile', metavar
='FILE',
1348 help='Netscape formatted file to read cookies from and dump cookie jar in')
1349 filesystem
.add_option(
1351 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1352 help='Do not read/dump cookies from/to file (default)')
1353 filesystem
.add_option(
1354 '--cookies-from-browser',
1355 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE]',
1357 'The name of the browser and (optionally) the name/path of '
1358 'the profile to load cookies from, separated by a ":". '
1359 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1360 'By default, the most recently accessed profile is used. '
1361 'The keyring used for decrypting Chromium cookies on Linux can be '
1362 '(optionally) specified after the browser name separated by a "+". '
1363 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1364 filesystem
.add_option(
1365 '--no-cookies-from-browser',
1366 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1367 help='Do not load cookies from browser (default)')
1368 filesystem
.add_option(
1369 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1370 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')
1371 filesystem
.add_option(
1372 '--no-cache-dir', action
='store_false', dest
='cachedir',
1373 help='Disable filesystem caching')
1374 filesystem
.add_option(
1376 action
='store_true', dest
='rm_cachedir',
1377 help='Delete all filesystem cache files')
1379 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1380 thumbnail
.add_option(
1381 '--write-thumbnail',
1382 action
='callback', dest
='writethumbnail', default
=False,
1383 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1384 callback
=lambda option
, _
, __
, parser
: setattr(
1385 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1386 help='Write thumbnail image to disk')
1387 thumbnail
.add_option(
1388 '--no-write-thumbnail',
1389 action
='store_false', dest
='writethumbnail',
1390 help='Do not write thumbnail image to disk (default)')
1391 thumbnail
.add_option(
1392 '--write-all-thumbnails',
1393 action
='store_const', dest
='writethumbnail', const
='all',
1394 help='Write all thumbnail image formats to disk')
1395 thumbnail
.add_option(
1396 '--list-thumbnails',
1397 action
='store_true', dest
='list_thumbnails', default
=False,
1398 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1400 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1403 action
='store_true', dest
='writelink', default
=False,
1404 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1407 action
='store_true', dest
='writeurllink', default
=False,
1408 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1410 '--write-webloc-link',
1411 action
='store_true', dest
='writewebloclink', default
=False,
1412 help='Write a .webloc macOS internet shortcut')
1414 '--write-desktop-link',
1415 action
='store_true', dest
='writedesktoplink', default
=False,
1416 help='Write a .desktop Linux internet shortcut')
1418 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1419 postproc
.add_option(
1420 '-x', '--extract-audio',
1421 action
='store_true', dest
='extractaudio', default
=False,
1422 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1423 postproc
.add_option(
1424 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1426 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1427 'best (default) or one of %s' % ', '.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1428 postproc
.add_option(
1429 '--audio-quality', metavar
='QUALITY',
1430 dest
='audioquality', default
='5',
1431 help='Specify ffmpeg audio quality to use when converting the audio with -x. Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')
1432 postproc
.add_option(
1434 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1436 'Remux the video into another container if necessary (currently supported: %s). '
1437 'If target container does not support the video/audio codec, remuxing will fail. '
1438 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1439 'and anything else to mkv.' % ', '.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1440 postproc
.add_option(
1442 metavar
='FORMAT', dest
='recodevideo', default
=None,
1443 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1444 postproc
.add_option(
1445 '--postprocessor-args', '--ppa',
1446 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1447 action
='callback', callback
=_dict_from_options_callback
,
1449 'allowed_keys': r
'\w+(?:\+\w+)?',
1450 'default_key': 'default-compat',
1451 'process': shlex
.split
,
1452 'multiple_keys': False
1454 'Give these arguments to the postprocessors. '
1455 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1456 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1457 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1458 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1459 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1460 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1461 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1462 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1463 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1464 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1465 'You can use this option multiple times to give different arguments to different '
1466 'postprocessors. (Alias: --ppa)'))
1467 postproc
.add_option(
1468 '-k', '--keep-video',
1469 action
='store_true', dest
='keepvideo', default
=False,
1470 help='Keep the intermediate video file on disk after post-processing')
1471 postproc
.add_option(
1473 action
='store_false', dest
='keepvideo',
1474 help='Delete the intermediate video file after post-processing (default)')
1475 postproc
.add_option(
1476 '--post-overwrites',
1477 action
='store_false', dest
='nopostoverwrites',
1478 help='Overwrite post-processed files (default)')
1479 postproc
.add_option(
1480 '--no-post-overwrites',
1481 action
='store_true', dest
='nopostoverwrites', default
=False,
1482 help='Do not overwrite post-processed files')
1483 postproc
.add_option(
1485 action
='store_true', dest
='embedsubtitles', default
=False,
1486 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1487 postproc
.add_option(
1489 action
='store_false', dest
='embedsubtitles',
1490 help='Do not embed subtitles (default)')
1491 postproc
.add_option(
1492 '--embed-thumbnail',
1493 action
='store_true', dest
='embedthumbnail', default
=False,
1494 help='Embed thumbnail in the video as cover art')
1495 postproc
.add_option(
1496 '--no-embed-thumbnail',
1497 action
='store_false', dest
='embedthumbnail',
1498 help='Do not embed thumbnail (default)')
1499 postproc
.add_option(
1500 '--embed-metadata', '--add-metadata',
1501 action
='store_true', dest
='addmetadata', default
=False,
1503 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1504 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1505 postproc
.add_option(
1506 '--no-embed-metadata', '--no-add-metadata',
1507 action
='store_false', dest
='addmetadata',
1508 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1509 postproc
.add_option(
1510 '--embed-chapters', '--add-chapters',
1511 action
='store_true', dest
='addchapters', default
=None,
1512 help='Add chapter markers to the video file (Alias: --add-chapters)')
1513 postproc
.add_option(
1514 '--no-embed-chapters', '--no-add-chapters',
1515 action
='store_false', dest
='addchapters',
1516 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1517 postproc
.add_option(
1518 '--embed-info-json',
1519 action
='store_true', dest
='embed_infojson', default
=None,
1520 help='Embed the infojson as an attachment to mkv/mka video files')
1521 postproc
.add_option(
1522 '--no-embed-info-json',
1523 action
='store_false', dest
='embed_infojson',
1524 help='Do not embed the infojson as an attachment to the video file')
1525 postproc
.add_option(
1526 '--metadata-from-title',
1527 metavar
='FORMAT', dest
='metafromtitle',
1528 help=optparse
.SUPPRESS_HELP
)
1529 postproc
.add_option(
1531 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1533 'Parse additional metadata like title/artist from other fields; '
1534 'see "MODIFYING METADATA" for details'))
1535 postproc
.add_option(
1536 '--replace-in-metadata',
1537 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1538 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1539 postproc
.add_option(
1540 '--xattrs', '--xattr',
1541 action
='store_true', dest
='xattrs', default
=False,
1542 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1543 postproc
.add_option(
1544 '--concat-playlist',
1545 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1546 choices
=('never', 'always', 'multi_video'),
1548 'Concatenate videos in a playlist. One of "never", "always", or '
1549 '"multi_video" (default; only when the videos form a single show). '
1550 'All the video files must have same codecs and number of streams to be concatable. '
1551 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1552 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1553 postproc
.add_option(
1555 metavar
='POLICY', dest
='fixup', default
=None,
1556 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1558 'Automatically correct known faults of the file. '
1559 'One of never (do nothing), warn (only emit a warning), '
1560 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1561 'force (try fixing even if file already exists)'))
1562 postproc
.add_option(
1563 '--prefer-avconv', '--no-prefer-ffmpeg',
1564 action
='store_false', dest
='prefer_ffmpeg',
1565 help=optparse
.SUPPRESS_HELP
)
1566 postproc
.add_option(
1567 '--prefer-ffmpeg', '--no-prefer-avconv',
1568 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1569 help=optparse
.SUPPRESS_HELP
)
1570 postproc
.add_option(
1571 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1572 dest
='ffmpeg_location',
1573 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1574 postproc
.add_option(
1576 metavar
='[WHEN:]CMD', dest
='exec_cmd', default
={}, type='str',
1577 action
='callback', callback
=_dict_from_options_callback
,
1579 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
1580 'default_key': 'after_move',
1581 'multiple_keys': False,
1584 'Execute a command, optionally prefixed with when to execute it (after_move if unspecified), separated by a ":". '
1585 'Supported values of "WHEN" are the same as that of --use-postprocessor. '
1586 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1587 'After download, an additional field "filepath" that contains the final path of the downloaded file '
1588 'is also available, and if no fields are passed, %(filepath)q is appended to the end of the command. '
1589 'This option can be used multiple times'))
1590 postproc
.add_option(
1592 action
='store_const', dest
='exec_cmd', const
={},
1593 help='Remove any previously defined --exec')
1594 postproc
.add_option(
1595 '--exec-before-download', metavar
='CMD',
1596 action
='append', dest
='exec_before_dl_cmd',
1597 help=optparse
.SUPPRESS_HELP
)
1598 postproc
.add_option(
1599 '--no-exec-before-download',
1600 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1601 help=optparse
.SUPPRESS_HELP
)
1602 postproc
.add_option(
1603 '--convert-subs', '--convert-sub', '--convert-subtitles',
1604 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1606 'Convert the subtitles to another format (currently supported: %s) '
1607 '(Alias: --convert-subtitles)' % ', '.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1608 postproc
.add_option(
1609 '--convert-thumbnails',
1610 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1612 'Convert the thumbnails to another format '
1613 '(currently supported: %s) ' % ', '.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1614 postproc
.add_option(
1615 '--split-chapters', '--split-tracks',
1616 dest
='split_chapters', action
='store_true', default
=False,
1618 'Split video into multiple files based on internal chapters. '
1619 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1620 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1621 postproc
.add_option(
1622 '--no-split-chapters', '--no-split-tracks',
1623 dest
='split_chapters', action
='store_false',
1624 help='Do not split video based on chapters (default)')
1625 postproc
.add_option(
1626 '--remove-chapters',
1627 metavar
='REGEX', dest
='remove_chapters', action
='append',
1629 'Remove chapters whose title matches the given regular expression. '
1630 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1631 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1632 'This option can be used multiple times'))
1633 postproc
.add_option(
1634 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1635 help='Do not remove any chapters from the file (default)')
1636 postproc
.add_option(
1637 '--force-keyframes-at-cuts',
1638 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1640 'Force keyframes around chapters when removing/splitting them. '
1641 'This is slow due to needing a re-encode, but '
1642 'the resulting video may have fewer artifacts around the cuts'))
1643 postproc
.add_option(
1644 '--no-force-keyframes-at-cuts',
1645 action
='store_false', dest
='force_keyframes_at_cuts',
1646 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1647 _postprocessor_opts_parser
= lambda key
, val
='': (
1648 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1649 ('key', remove_end(key
, 'PP')))
1650 postproc
.add_option(
1651 '--use-postprocessor',
1652 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1653 action
='callback', callback
=_list_from_options_callback
,
1656 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1658 'The (case sensitive) name of plugin postprocessors to be enabled, '
1659 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1660 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1661 'The "when" argument determines when the postprocessor is invoked. '
1662 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1663 '"before_dl" (before each video download), "post_process" (after each video download; default), '
1664 '"after_move" (after moving video file to it\'s final locations), '
1665 '"after_video" (after downloading and processing all formats of a video), '
1666 'or "playlist" (at end of playlist). '
1667 'This option can be used multiple times to add different postprocessors'))
1669 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1670 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1671 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1672 sponsorblock
.add_option(
1673 '--sponsorblock-mark', metavar
='CATS',
1674 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1675 callback
=_set_from_options_callback
, callback_kwargs
={
1676 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1677 'aliases': {'default': ['all']}
1679 'SponsorBlock categories to create chapters for, separated by commas. '
1680 f
'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1681 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
1682 'Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1683 sponsorblock
.add_option(
1684 '--sponsorblock-remove', metavar
='CATS',
1685 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1686 callback
=_set_from_options_callback
, callback_kwargs
={
1687 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.POI_CATEGORIES
.keys()),
1688 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1689 # The filler category is very aggressive.
1690 # It is strongly recommended to not use this in a client by default.
1691 'aliases': {'default': ['all', '-filler']}
1693 'SponsorBlock categories to be removed from the video file, separated by commas. '
1694 'If a category is present in both mark and remove, remove takes precedence. '
1695 'The syntax and available categories are the same as for --sponsorblock-mark '
1696 'except that "default" refers to "all,-filler" '
1697 f
'and {", ".join(SponsorBlockPP.POI_CATEGORIES.keys())} is not available'))
1698 sponsorblock
.add_option(
1699 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1700 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1702 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1703 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1704 'Defaults to "%default"'))
1705 sponsorblock
.add_option(
1706 '--no-sponsorblock', default
=False,
1707 action
='store_true', dest
='no_sponsorblock',
1708 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1709 sponsorblock
.add_option(
1710 '--sponsorblock-api', metavar
='URL',
1711 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1712 help='SponsorBlock API location, defaults to %default')
1714 sponsorblock
.add_option(
1716 action
='store_true', dest
='sponskrub', default
=False,
1717 help=optparse
.SUPPRESS_HELP
)
1718 sponsorblock
.add_option(
1720 action
='store_false', dest
='sponskrub',
1721 help=optparse
.SUPPRESS_HELP
)
1722 sponsorblock
.add_option(
1723 '--sponskrub-cut', default
=False,
1724 action
='store_true', dest
='sponskrub_cut',
1725 help=optparse
.SUPPRESS_HELP
)
1726 sponsorblock
.add_option(
1727 '--no-sponskrub-cut',
1728 action
='store_false', dest
='sponskrub_cut',
1729 help=optparse
.SUPPRESS_HELP
)
1730 sponsorblock
.add_option(
1731 '--sponskrub-force', default
=False,
1732 action
='store_true', dest
='sponskrub_force',
1733 help=optparse
.SUPPRESS_HELP
)
1734 sponsorblock
.add_option(
1735 '--no-sponskrub-force',
1736 action
='store_true', dest
='sponskrub_force',
1737 help=optparse
.SUPPRESS_HELP
)
1738 sponsorblock
.add_option(
1739 '--sponskrub-location', metavar
='PATH',
1740 dest
='sponskrub_path', default
='',
1741 help=optparse
.SUPPRESS_HELP
)
1742 sponsorblock
.add_option(
1743 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1744 help=optparse
.SUPPRESS_HELP
)
1746 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1747 extractor
.add_option(
1748 '--extractor-retries',
1749 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1750 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1751 extractor
.add_option(
1752 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1753 action
='store_true', dest
='dynamic_mpd', default
=True,
1754 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1755 extractor
.add_option(
1756 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1757 action
='store_false', dest
='dynamic_mpd',
1758 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1759 extractor
.add_option(
1760 '--hls-split-discontinuity',
1761 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1762 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1764 extractor
.add_option(
1765 '--no-hls-split-discontinuity',
1766 dest
='hls_split_discontinuity', action
='store_false',
1767 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1768 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1769 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1770 extractor
.add_option(
1772 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1773 action
='callback', callback
=_dict_from_options_callback
,
1775 'multiple_keys': False,
1776 'process': lambda val
: dict(
1777 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1779 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1780 'You can use this option multiple times to give arguments for different extractors'))
1781 extractor
.add_option(
1782 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1783 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1784 help=optparse
.SUPPRESS_HELP
)
1785 extractor
.add_option(
1786 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1787 action
='store_false', dest
='youtube_include_dash_manifest',
1788 help=optparse
.SUPPRESS_HELP
)
1789 extractor
.add_option(
1790 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1791 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1792 help=optparse
.SUPPRESS_HELP
)
1793 extractor
.add_option(
1794 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1795 action
='store_false', dest
='youtube_include_hls_manifest',
1796 help=optparse
.SUPPRESS_HELP
)
1798 parser
.add_option_group(general
)
1799 parser
.add_option_group(network
)
1800 parser
.add_option_group(geo
)
1801 parser
.add_option_group(selection
)
1802 parser
.add_option_group(downloader
)
1803 parser
.add_option_group(filesystem
)
1804 parser
.add_option_group(thumbnail
)
1805 parser
.add_option_group(link
)
1806 parser
.add_option_group(verbosity
)
1807 parser
.add_option_group(workarounds
)
1808 parser
.add_option_group(video_format
)
1809 parser
.add_option_group(subtitles
)
1810 parser
.add_option_group(authentication
)
1811 parser
.add_option_group(postproc
)
1812 parser
.add_option_group(sponsorblock
)
1813 parser
.add_option_group(extractor
)
1818 def _hide_login_info(opts
):
1820 'DeprecationWarning: "yt_dlp.options._hide_login_info" is deprecated and may be removed in a future version. '
1821 'Use "yt_dlp.utils.Config.hide_login_info" instead\n')
1822 return Config
.hide_login_info(opts
)