11 from .compat
import compat_expanduser
12 from .cookies
import SUPPORTED_BROWSERS
, SUPPORTED_KEYRINGS
13 from .downloader
.external
import list_external_downloaders
14 from .postprocessor
import (
17 FFmpegSubtitlesConvertorPP
,
18 FFmpegThumbnailsConvertorPP
,
22 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
23 from .update
import UPDATE_SOURCES
, detect_variant
, is_non_updateable
32 get_system_config_dirs
,
35 orderedSet_from_options
,
40 from .version
import CHANNEL
, __version__
43 def parseOpts(overrideArguments
=None, ignore_config_files
='if_override'): # noqa: N803
44 PACKAGE_NAME
= 'yt-dlp'
46 root
= Config(create_parser())
47 if ignore_config_files
== 'if_override':
48 ignore_config_files
= overrideArguments
is not None
50 def read_config(*paths
):
51 path
= os
.path
.join(*paths
)
52 conf
= Config
.read_file(path
, default
=None)
56 def _load_from_config_dirs(config_dirs
):
57 for config_dir
in config_dirs
:
58 head
, tail
= os
.path
.split(config_dir
)
59 assert tail
== PACKAGE_NAME
or config_dir
== os
.path
.join(compat_expanduser('~'), f
'.{PACKAGE_NAME}')
61 yield read_config(head
, f
'{PACKAGE_NAME}.conf')
62 if tail
.startswith('.'): # ~/.PACKAGE_NAME
63 yield read_config(head
, f
'{PACKAGE_NAME}.conf.txt')
64 yield read_config(config_dir
, 'config')
65 yield read_config(config_dir
, 'config.txt')
67 def add_config(label
, path
=None, func
=None):
68 """ Adds config and returns whether to continue """
69 if root
.parse_known_args()[0].ignoreconfig
:
73 args
, current_path
= next(
74 filter(None, _load_from_config_dirs(func(PACKAGE_NAME
))), (None, None))
76 current_path
= os
.path
.join(path
, 'yt-dlp.conf')
77 args
= Config
.read_file(current_path
, default
=None)
79 root
.append_config(args
, current_path
, label
=label
)
83 yield not ignore_config_files
84 yield add_config('Portable', get_executable_path())
85 yield add_config('Home', expand_path(root
.parse_known_args()[0].paths
.get('home', '')).strip())
86 yield add_config('User', func
=get_user_config_dirs
)
87 yield add_config('System', func
=get_system_config_dirs
)
89 opts
= optparse
.Values({'verbose': True, 'print_help': False}
)
92 if overrideArguments
is not None:
93 root
.append_config(overrideArguments
, label
='Override')
95 root
.append_config(sys
.argv
[1:], label
='Command-line')
96 loaded_all_configs
= all(load_configs())
97 except ValueError as err
:
98 raise root
.parser
.error(err
)
100 if loaded_all_configs
:
101 # If ignoreconfig is found inside the system configuration file,
102 # the user configuration is removed
103 if root
.parse_known_args()[0].ignoreconfig
:
104 user_conf
= next((i
for i
, conf
in enumerate(root
.configs
) if conf
.label
== 'User'), None)
105 if user_conf
is not None:
106 root
.configs
.pop(user_conf
)
109 root
.configs
[0].load_configs() # Resolve any aliases using --config-location
110 except ValueError as err
:
111 raise root
.parser
.error(err
)
113 opts
, args
= root
.parse_args()
114 except optparse
.OptParseError
:
115 with contextlib
.suppress(optparse
.OptParseError
):
116 opts
, _
= root
.parse_known_args(strict
=False)
118 except (SystemExit, KeyboardInterrupt):
122 verbose
= opts
.verbose
and f
'\n{root}'.replace('\n| ', '\n[debug] ')[1:]
124 write_string(f
'{verbose}\n')
128 root
.parser
.print_help()
131 return root
.parser
, opts
, args
134 class _YoutubeDLHelpFormatter(optparse
.IndentedHelpFormatter
):
136 # No need to wrap help messages if we're on a wide console
137 max_width
= shutil
.get_terminal_size().columns
or 80
138 # The % is chosen to get a pretty output in README.md
139 super().__init
__(width
=max_width
, max_help_position
=int(0.45 * max_width
))
142 def format_option_strings(option
):
143 """ ('-o', '--option') -> -o, --format METAVAR """
144 opts
= join_nonempty(
145 option
._short
_opts
and option
._short
_opts
[0],
146 option
._long
_opts
and option
._long
_opts
[0],
148 if option
.takes_value():
149 opts
+= f
' {option.metavar}'
153 class _YoutubeDLOptionParser(optparse
.OptionParser
):
154 # optparse is deprecated since Python 3.2. So assume a stable interface even for private methods
155 ALIAS_DEST
= '_triggered_aliases'
156 ALIAS_TRIGGER_LIMIT
= 100
160 prog
='yt-dlp' if detect_variant() == 'source' else None,
162 usage
='%prog [OPTIONS] URL [URL...]',
163 epilog
='See full documentation at https://github.com/yt-dlp/yt-dlp#readme',
164 formatter
=_YoutubeDLHelpFormatter(),
165 conflict_handler
='resolve',
167 self
.set_default(self
.ALIAS_DEST
, collections
.defaultdict(int))
169 _UNKNOWN_OPTION
= (optparse
.BadOptionError
, optparse
.AmbiguousOptionError
)
170 _BAD_OPTION
= optparse
.OptionValueError
172 def parse_known_args(self
, args
=None, values
=None, strict
=True):
173 """Same as parse_args, but ignore unknown switches. Similar to argparse.parse_known_args"""
174 self
.rargs
, self
.largs
= self
._get
_args
(args
), []
175 self
.values
= values
or self
.get_default_values()
182 elif arg
.startswith('--'):
183 self
._process
_long
_opt
(self
.rargs
, self
.values
)
184 elif arg
.startswith('-') and arg
!= '-':
185 self
._process
_short
_opts
(self
.rargs
, self
.values
)
186 elif self
.allow_interspersed_args
:
187 self
.largs
.append(self
.rargs
.pop(0))
190 except optparse
.OptParseError
as err
:
191 if isinstance(err
, self
._UNKNOWN
_OPTION
):
192 self
.largs
.append(err
.opt_str
)
194 if isinstance(err
, self
._BAD
_OPTION
):
197 return self
.check_values(self
.values
, self
.largs
)
199 def _generate_error_message(self
, msg
):
200 msg
= f
'{self.get_prog_name()}: error: {str(msg).strip()}\n'
201 return f
'{self.get_usage()}\n{msg}' if self
.usage
else msg
203 def error(self
, msg
):
204 raise optparse
.OptParseError(self
._generate
_error
_message
(msg
))
206 def _get_args(self
, args
):
207 return sys
.argv
[1:] if args
is None else list(args
)
209 def _match_long_opt(self
, opt
):
210 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
212 return super()._match
_long
_opt
(opt
)
213 except optparse
.AmbiguousOptionError
as e
:
214 if len({self._long_opt[p] for p in e.possibilities}
) == 1:
215 return e
.possibilities
[0]
220 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
221 # append can be True, False or -1 (prepend)
222 current
= list(getattr(parser
.values
, option
.dest
)) if append
else []
223 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
225 parser
.values
, option
.dest
,
226 current
+ value
if append
is True else value
+ current
)
228 def _set_from_options_callback(
229 option
, opt_str
, value
, parser
, allowed_values
, delim
=',', aliases
={},
230 process
=lambda x
: x
.lower().strip()):
231 values
= [process(value
)] if delim
is None else map(process
, value
.split(delim
))
233 requested
= orderedSet_from_options(values
, collections
.ChainMap(aliases
, {'all': allowed_values}
),
234 start
=getattr(parser
.values
, option
.dest
))
235 except ValueError as e
:
236 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {e.args[0]}')
238 setattr(parser
.values
, option
.dest
, set(requested
))
240 def _dict_from_options_callback(
241 option
, opt_str
, value
, parser
,
242 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
243 process_key
=str.lower
, append
=False):
245 out_dict
= dict(getattr(parser
.values
, option
.dest
))
246 multiple_args
= not isinstance(value
, str)
248 allowed_keys
= fr
'({allowed_keys})(,({allowed_keys}))*'
250 fr
'(?is)(?P<keys>{allowed_keys}){delimiter}(?P<val>.*)$',
251 value
[0] if multiple_args
else value
)
253 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
255 val
= [val
, *value
[1:]]
256 elif default_key
is not None:
257 keys
, val
= variadic(default_key
), value
259 raise optparse
.OptionValueError(
260 f
'wrong {opt_str} formatting; it should be {option.metavar}, not "{value}"')
262 keys
= map(process_key
, keys
) if process_key
else keys
263 val
= process(val
) if process
else val
264 except Exception as err
:
265 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
267 out_dict
[key
] = [*out_dict
.get(key
, []), val
] if append
else val
268 setattr(parser
.values
, option
.dest
, out_dict
)
270 def when_prefix(default
):
274 'action': 'callback',
275 'callback': _dict_from_options_callback
,
277 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
278 'default_key': default
,
279 'multiple_keys': False,
284 parser
= _YoutubeDLOptionParser()
285 alias_group
= optparse
.OptionGroup(parser
, 'Aliases')
286 Formatter
= string
.Formatter()
288 def _create_alias(option
, opt_str
, value
, parser
):
289 aliases
, opts
= value
291 nargs
= len({i
if f
== '' else f
292 for i
, (_
, f
, _
, _
) in enumerate(Formatter
.parse(opts
)) if f
is not None})
293 opts
.format(*map(str, range(nargs
))) # validate
294 except Exception as err
:
295 raise optparse
.OptionValueError(f
'wrong {opt_str} OPTIONS formatting; {err}')
296 if alias_group
not in parser
.option_groups
:
297 parser
.add_option_group(alias_group
)
299 aliases
= (x
if x
.startswith('-') else f
'--{x}' for x
in map(str.strip
, aliases
.split(',')))
301 args
= [f
'ARG{i}' for i
in range(nargs
)]
302 alias_group
.add_option(
303 *aliases
, nargs
=nargs
, dest
=parser
.ALIAS_DEST
, type='str' if nargs
else None,
304 metavar
=' '.join(args
), help=opts
.format(*args
), action
='callback',
305 callback
=_alias_callback
, callback_kwargs
={'opts': opts, 'nargs': nargs}
)
306 except Exception as err
:
307 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
309 def _alias_callback(option
, opt_str
, value
, parser
, opts
, nargs
):
310 counter
= getattr(parser
.values
, option
.dest
)
311 counter
[opt_str
] += 1
312 if counter
[opt_str
] > parser
.ALIAS_TRIGGER_LIMIT
:
313 raise optparse
.OptionValueError(f
'Alias {opt_str} exceeded invocation limit')
316 assert (nargs
== 0 and value
is None) or len(value
) == nargs
317 parser
.rargs
[:0] = shlex
.split(
318 opts
if value
is None else opts
.format(*map(shlex
.quote
, value
)))
320 general
= optparse
.OptionGroup(parser
, 'General Options')
322 '-h', '--help', dest
='print_help', action
='store_true',
323 help='Print this help text and exit')
327 help='Print program version and exit')
330 action
='store_const', dest
='update_self', const
=CHANNEL
,
332 is_non_updateable(), None, 'Check if updates are available. %s',
333 default
=f
'Update this program to the latest {CHANNEL} version'))
336 action
='store_false', dest
='update_self',
337 help='Do not check for updates (default)')
340 action
='store', dest
='update_self', metavar
='[CHANNEL]@[TAG]',
342 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
343 f
'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
344 f
'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
346 '-i', '--ignore-errors',
347 action
='store_true', dest
='ignoreerrors',
348 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
350 '--no-abort-on-error',
351 action
='store_const', dest
='ignoreerrors', const
='only_download',
352 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
354 '--abort-on-error', '--no-ignore-errors',
355 action
='store_false', dest
='ignoreerrors',
356 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
359 action
='store_true', dest
='dump_user_agent', default
=False,
360 help='Display the current user-agent and exit')
363 action
='store_true', dest
='list_extractors', default
=False,
364 help='List all supported extractors and exit')
366 '--extractor-descriptions',
367 action
='store_true', dest
='list_extractor_descriptions', default
=False,
368 help='Output descriptions of all supported extractors and exit')
370 '--use-extractors', '--ies',
371 action
='callback', dest
='allowed_extractors', metavar
='NAMES', type='str',
372 default
=[], callback
=_list_from_options_callback
,
374 'Extractor names to use separated by commas. '
375 'You can also use regexes, "all", "default" and "end" (end URL matching); '
376 'e.g. --ies "holodex.*,end,youtube". '
377 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
378 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
380 '--force-generic-extractor',
381 action
='store_true', dest
='force_generic_extractor', default
=False,
382 help=optparse
.SUPPRESS_HELP
)
385 dest
='default_search', metavar
='PREFIX',
387 'Use this prefix for unqualified URLs. '
388 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
389 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
390 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
391 'but emits an error if this is not possible instead of searching'))
393 '--ignore-config', '--no-config',
394 action
='store_true', dest
='ignoreconfig',
396 'Don\'t load any more configuration files except those given to --config-locations. '
397 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
398 '(Alias: --no-config)'))
400 '--no-config-locations',
401 action
='store_const', dest
='config_locations', const
=[],
403 'Do not load any custom configuration files (default). When given inside a '
404 'configuration file, ignore all previous --config-locations defined in the current file'))
406 '--config-locations',
407 dest
='config_locations', metavar
='PATH', action
='append',
409 'Location of the main configuration file; either the path to the config or its containing directory '
410 '("-" for stdin). Can be used multiple times and inside other configuration files'))
413 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
414 help='Do not extract the videos of a playlist, only list them')
416 '--no-flat-playlist',
417 action
='store_false', dest
='extract_flat',
418 help='Fully extract the videos of a playlist (default)')
421 action
='store_true', dest
='live_from_start',
422 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
424 '--no-live-from-start',
425 action
='store_false', dest
='live_from_start',
426 help='Download livestreams from the current time (default)')
429 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
431 'Wait for scheduled streams to become available. '
432 'Pass the minimum number of seconds (or range) to wait between retries'))
434 '--no-wait-for-video',
435 dest
='wait_for_video', action
='store_const', const
=None,
436 help='Do not wait for scheduled streams (default)')
439 action
='store_true', dest
='mark_watched', default
=False,
440 help='Mark videos watched (even with --simulate)')
443 action
='store_false', dest
='mark_watched',
444 help='Do not mark videos watched (default)')
446 '--no-colors', '--no-colours',
447 action
='store_const', dest
='color', const
={
448 'stdout': 'no_color',
449 'stderr': 'no_color',
451 help=optparse
.SUPPRESS_HELP
)
454 dest
='color', metavar
='[STREAM:]POLICY', default
={}, type='str',
455 action
='callback', callback
=_dict_from_options_callback
,
457 'allowed_keys': 'stdout|stderr',
458 'default_key': ['stdout', 'stderr'],
459 'process': str.strip
,
461 'Whether to emit color codes in output, optionally prefixed by '
462 'the STREAM (stdout or stderr) to apply the setting to. '
463 'Can be one of "always", "auto" (default), "never", or '
464 '"no_color" (use non color terminal sequences). '
465 'Can be used multiple times'))
468 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
469 action
='callback', callback
=_set_from_options_callback
,
472 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
473 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge', 'playlist-match-filter',
474 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
475 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
476 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
477 'prefer-legacy-http-handler', 'manifest-filesize-approx', 'allow-unsafe-ext',
479 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext'],
480 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx', '-allow-unsafe-ext'],
481 '2021': ['2022', 'no-certifi', 'filename-sanitization'],
482 '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter', 'prefer-legacy-http-handler', 'manifest-filesize-approx'],
486 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
487 'configurations by reverting some of the changes made in yt-dlp. '
488 'See "Differences in default behavior" for details'))
490 '--alias', metavar
='ALIASES OPTIONS', dest
='_', type='str', nargs
=2,
491 action
='callback', callback
=_create_alias
,
493 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
494 'Arguments are parsed according to the Python string formatting mini-language. '
495 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
496 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
497 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
498 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
499 f
'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
500 'This option can be used multiple times'))
502 network
= optparse
.OptionGroup(parser
, 'Network Options')
504 '--proxy', dest
='proxy',
505 default
=None, metavar
='URL',
507 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
508 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
511 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
512 help='Time to wait before giving up, in seconds')
515 metavar
='IP', dest
='source_address', default
=None,
516 help='Client-side IP address to bind to',
520 metavar
='CLIENT[:OS]', dest
='impersonate', default
=None,
522 'Client to impersonate for requests. E.g. chrome, chrome-110, chrome:windows-10. '
523 'Pass --impersonate="" to impersonate any client. Note that forcing impersonation '
524 'for all requests may have a detrimental impact on download speed and stability'),
527 '--list-impersonate-targets',
528 dest
='list_impersonate_targets', default
=False, action
='store_true',
529 help='List available clients to impersonate.',
532 '-4', '--force-ipv4',
533 action
='store_const', const
='0.0.0.0', dest
='source_address',
534 help='Make all connections via IPv4',
537 '-6', '--force-ipv6',
538 action
='store_const', const
='::', dest
='source_address',
539 help='Make all connections via IPv6',
542 '--enable-file-urls', action
='store_true',
543 dest
='enable_file_urls', default
=False,
544 help='Enable file:// URLs. This is disabled by default for security reasons.',
547 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
549 '--geo-verification-proxy',
550 dest
='geo_verification_proxy', default
=None, metavar
='URL',
552 'Use this proxy to verify the IP address for some geo-restricted sites. '
553 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
555 '--cn-verification-proxy',
556 dest
='cn_verification_proxy', default
=None, metavar
='URL',
557 help=optparse
.SUPPRESS_HELP
)
559 '--xff', metavar
='VALUE',
560 dest
='geo_bypass', default
='default',
562 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
563 'One of "default" (only when known to be useful), "never", '
564 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
567 action
='store_const', dest
='geo_bypass', const
='default',
568 help=optparse
.SUPPRESS_HELP
)
571 action
='store_const', dest
='geo_bypass', const
='never',
572 help=optparse
.SUPPRESS_HELP
)
574 '--geo-bypass-country', metavar
='CODE', dest
='geo_bypass',
575 help=optparse
.SUPPRESS_HELP
)
577 '--geo-bypass-ip-block', metavar
='IP_BLOCK', dest
='geo_bypass',
578 help=optparse
.SUPPRESS_HELP
)
580 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
581 selection
.add_option(
583 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
584 help=optparse
.SUPPRESS_HELP
)
585 selection
.add_option(
587 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
588 help=optparse
.SUPPRESS_HELP
)
589 selection
.add_option(
590 '-I', '--playlist-items',
591 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
593 'Comma separated playlist_index of the items to download. '
594 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
595 'Use negative indices to count from the right and negative STEP to download in reverse order. '
596 'E.g. "-I 1:3,7,-5::2" used on a playlist of size 15 will download the items at index 1,2,3,7,11,13,15'))
597 selection
.add_option(
599 dest
='matchtitle', metavar
='REGEX',
600 help=optparse
.SUPPRESS_HELP
)
601 selection
.add_option(
603 dest
='rejecttitle', metavar
='REGEX',
604 help=optparse
.SUPPRESS_HELP
)
605 selection
.add_option(
607 metavar
='SIZE', dest
='min_filesize', default
=None,
608 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
609 selection
.add_option(
611 metavar
='SIZE', dest
='max_filesize', default
=None,
612 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
613 selection
.add_option(
615 metavar
='DATE', dest
='date', default
=None,
617 'Download only videos uploaded on this date. '
618 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
619 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
620 selection
.add_option(
622 metavar
='DATE', dest
='datebefore', default
=None,
624 'Download only videos uploaded on or before this date. '
625 'The date formats accepted is the same as --date'))
626 selection
.add_option(
628 metavar
='DATE', dest
='dateafter', default
=None,
630 'Download only videos uploaded on or after this date. '
631 'The date formats accepted is the same as --date'))
632 selection
.add_option(
634 metavar
='COUNT', dest
='min_views', default
=None, type=int,
635 help=optparse
.SUPPRESS_HELP
)
636 selection
.add_option(
638 metavar
='COUNT', dest
='max_views', default
=None, type=int,
639 help=optparse
.SUPPRESS_HELP
)
640 selection
.add_option(
642 metavar
='FILTER', dest
='match_filter', action
='append',
644 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
645 'number or a string using the operators defined in "Filtering Formats". '
646 'You can also simply specify a field to match if the field is present, '
647 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
648 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
649 'the filter matches if at least one of the conditions is met. E.g. --match-filter '
650 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
651 'matches only videos that are not live OR those that have a like count more than 100 '
652 '(or the like field is not available) and also has a description '
653 'that contains the phrase "cats & dogs" (caseless). '
654 'Use "--match-filter -" to interactively ask whether to download each video'))
655 selection
.add_option(
656 '--no-match-filters',
657 dest
='match_filter', action
='store_const', const
=None,
658 help='Do not use any --match-filter (default)')
659 selection
.add_option(
660 '--break-match-filters',
661 metavar
='FILTER', dest
='breaking_match_filter', action
='append',
662 help='Same as "--match-filters" but stops the download process when a video is rejected')
663 selection
.add_option(
664 '--no-break-match-filters',
665 dest
='breaking_match_filter', action
='store_const', const
=None,
666 help='Do not use any --break-match-filters (default)')
667 selection
.add_option(
669 action
='store_true', dest
='noplaylist', default
=False,
670 help='Download only the video, if the URL refers to a video and a playlist')
671 selection
.add_option(
673 action
='store_false', dest
='noplaylist',
674 help='Download the playlist, if the URL refers to a video and a playlist')
675 selection
.add_option(
677 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
678 help='Download only videos suitable for the given age')
679 selection
.add_option(
680 '--download-archive', metavar
='FILE',
681 dest
='download_archive',
682 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
683 selection
.add_option(
684 '--no-download-archive',
685 dest
='download_archive', action
='store_const', const
=None,
686 help='Do not use archive file (default)')
687 selection
.add_option(
689 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
690 help='Abort after downloading NUMBER files')
691 selection
.add_option(
692 '--break-on-existing',
693 action
='store_true', dest
='break_on_existing', default
=False,
694 help='Stop the download process when encountering a file that is in the archive')
695 selection
.add_option(
696 '--no-break-on-existing',
697 action
='store_false', dest
='break_on_existing',
698 help='Do not stop the download process when encountering a file that is in the archive (default)')
699 selection
.add_option(
701 action
='store_true', dest
='break_on_reject', default
=False,
702 help=optparse
.SUPPRESS_HELP
)
703 selection
.add_option(
705 action
='store_true', dest
='break_per_url', default
=False,
706 help='Alters --max-downloads, --break-on-existing, --break-match-filter, and autonumber to reset per input URL')
707 selection
.add_option(
708 '--no-break-per-input',
709 action
='store_false', dest
='break_per_url',
710 help='--break-on-existing and similar options terminates the entire download queue')
711 selection
.add_option(
712 '--skip-playlist-after-errors', metavar
='N',
713 dest
='skip_playlist_after_errors', default
=None, type=int,
714 help='Number of allowed failures until the rest of the playlist is skipped')
715 selection
.add_option(
717 dest
='include_ads', action
='store_true',
718 help=optparse
.SUPPRESS_HELP
)
719 selection
.add_option(
721 dest
='include_ads', action
='store_false',
722 help=optparse
.SUPPRESS_HELP
)
724 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
725 authentication
.add_option(
727 dest
='username', metavar
='USERNAME',
728 help='Login with this account ID')
729 authentication
.add_option(
731 dest
='password', metavar
='PASSWORD',
732 help='Account password. If this option is left out, yt-dlp will ask interactively')
733 authentication
.add_option(
735 dest
='twofactor', metavar
='TWOFACTOR',
736 help='Two-factor authentication code')
737 authentication
.add_option(
739 action
='store_true', dest
='usenetrc', default
=False,
740 help='Use .netrc authentication data')
741 authentication
.add_option(
743 dest
='netrc_location', metavar
='PATH',
744 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
745 authentication
.add_option(
747 dest
='netrc_cmd', metavar
='NETRC_CMD',
748 help='Command to execute to get the credentials for an extractor.')
749 authentication
.add_option(
751 dest
='videopassword', metavar
='PASSWORD',
752 help='Video-specific password')
753 authentication
.add_option(
755 dest
='ap_mso', metavar
='MSO',
756 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
757 authentication
.add_option(
759 dest
='ap_username', metavar
='USERNAME',
760 help='Multiple-system operator account login')
761 authentication
.add_option(
763 dest
='ap_password', metavar
='PASSWORD',
764 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
765 authentication
.add_option(
767 action
='store_true', dest
='ap_list_mso', default
=False,
768 help='List all supported multiple-system operators')
769 authentication
.add_option(
770 '--client-certificate',
771 dest
='client_certificate', metavar
='CERTFILE',
772 help='Path to client certificate file in PEM format. May include the private key')
773 authentication
.add_option(
774 '--client-certificate-key',
775 dest
='client_certificate_key', metavar
='KEYFILE',
776 help='Path to private key file for client certificate')
777 authentication
.add_option(
778 '--client-certificate-password',
779 dest
='client_certificate_password', metavar
='PASSWORD',
780 help='Password for client certificate private key, if encrypted. '
781 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
783 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
784 video_format
.add_option(
786 action
='store', dest
='format', metavar
='FORMAT', default
=None,
787 help='Video format code, see "FORMAT SELECTION" for more details')
788 video_format
.add_option(
789 '-S', '--format-sort', metavar
='SORTORDER',
790 dest
='format_sort', default
=[], type='str', action
='callback',
791 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
792 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
793 video_format
.add_option(
794 '--format-sort-force', '--S-force',
795 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
797 'Force user specified sort order to have precedence over all fields, '
798 'see "Sorting Formats" for more details (Alias: --S-force)'))
799 video_format
.add_option(
800 '--no-format-sort-force',
801 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
802 help='Some fields have precedence over the user specified sort order (default)')
803 video_format
.add_option(
804 '--video-multistreams',
805 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
806 help='Allow multiple video streams to be merged into a single file')
807 video_format
.add_option(
808 '--no-video-multistreams',
809 action
='store_false', dest
='allow_multiple_video_streams',
810 help='Only one video stream is downloaded for each output file (default)')
811 video_format
.add_option(
812 '--audio-multistreams',
813 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
814 help='Allow multiple audio streams to be merged into a single file')
815 video_format
.add_option(
816 '--no-audio-multistreams',
817 action
='store_false', dest
='allow_multiple_audio_streams',
818 help='Only one audio stream is downloaded for each output file (default)')
819 video_format
.add_option(
821 action
='store_const', dest
='format', const
='all',
822 help=optparse
.SUPPRESS_HELP
)
823 video_format
.add_option(
824 '--prefer-free-formats',
825 action
='store_true', dest
='prefer_free_formats', default
=False,
827 'Prefer video formats with free containers over non-free ones of same quality. '
828 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
829 video_format
.add_option(
830 '--no-prefer-free-formats',
831 action
='store_false', dest
='prefer_free_formats', default
=False,
832 help="Don't give any special preference to free containers (default)")
833 video_format
.add_option(
835 action
='store_const', const
='selected', dest
='check_formats', default
=None,
836 help='Make sure formats are selected only from those that are actually downloadable')
837 video_format
.add_option(
838 '--check-all-formats',
839 action
='store_true', dest
='check_formats',
840 help='Check all formats for whether they are actually downloadable')
841 video_format
.add_option(
842 '--no-check-formats',
843 action
='store_false', dest
='check_formats',
844 help='Do not check that the formats are actually downloadable')
845 video_format
.add_option(
846 '-F', '--list-formats',
847 action
='store_true', dest
='listformats',
848 help='List available formats of each video. Simulate unless --no-simulate is used')
849 video_format
.add_option(
850 '--list-formats-as-table',
851 action
='store_true', dest
='listformats_table', default
=True,
852 help=optparse
.SUPPRESS_HELP
)
853 video_format
.add_option(
854 '--list-formats-old', '--no-list-formats-as-table',
855 action
='store_false', dest
='listformats_table',
856 help=optparse
.SUPPRESS_HELP
)
857 video_format
.add_option(
858 '--merge-output-format',
859 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
861 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
862 'Ignored if no merge is required. '
863 f
'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
864 video_format
.add_option(
865 '--allow-unplayable-formats',
866 action
='store_true', dest
='allow_unplayable_formats', default
=False,
867 help=optparse
.SUPPRESS_HELP
)
868 video_format
.add_option(
869 '--no-allow-unplayable-formats',
870 action
='store_false', dest
='allow_unplayable_formats',
871 help=optparse
.SUPPRESS_HELP
)
873 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
874 subtitles
.add_option(
875 '--write-subs', '--write-srt',
876 action
='store_true', dest
='writesubtitles', default
=False,
877 help='Write subtitle file')
878 subtitles
.add_option(
879 '--no-write-subs', '--no-write-srt',
880 action
='store_false', dest
='writesubtitles',
881 help='Do not write subtitle file (default)')
882 subtitles
.add_option(
883 '--write-auto-subs', '--write-automatic-subs',
884 action
='store_true', dest
='writeautomaticsub', default
=False,
885 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
886 subtitles
.add_option(
887 '--no-write-auto-subs', '--no-write-automatic-subs',
888 action
='store_false', dest
='writeautomaticsub', default
=False,
889 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
890 subtitles
.add_option(
892 action
='store_true', dest
='allsubtitles', default
=False,
893 help=optparse
.SUPPRESS_HELP
)
894 subtitles
.add_option(
896 action
='store_true', dest
='listsubtitles', default
=False,
897 help='List available subtitles of each video. Simulate unless --no-simulate is used')
898 subtitles
.add_option(
900 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
901 help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"')
902 subtitles
.add_option(
903 '--sub-langs', '--srt-langs',
904 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
905 default
=[], callback
=_list_from_options_callback
,
907 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". '
908 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
909 'Use --list-subs for a list of available language tags'))
911 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
912 downloader
.add_option(
913 '-N', '--concurrent-fragments',
914 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
915 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
916 downloader
.add_option(
917 '-r', '--limit-rate', '--rate-limit',
918 dest
='ratelimit', metavar
='RATE',
919 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
920 downloader
.add_option(
922 dest
='throttledratelimit', metavar
='RATE',
923 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
924 downloader
.add_option(
926 dest
='retries', metavar
='RETRIES', default
=10,
927 help='Number of retries (default is %default), or "infinite"')
928 downloader
.add_option(
929 '--file-access-retries',
930 dest
='file_access_retries', metavar
='RETRIES', default
=3,
931 help='Number of times to retry on file access error (default is %default), or "infinite"')
932 downloader
.add_option(
933 '--fragment-retries',
934 dest
='fragment_retries', metavar
='RETRIES', default
=10,
935 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
936 downloader
.add_option(
938 dest
='retry_sleep', metavar
='[TYPE:]EXPR', default
={}, type='str',
939 action
='callback', callback
=_dict_from_options_callback
,
941 'allowed_keys': 'http|fragment|file_access|extractor',
942 'default_key': 'http',
944 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
945 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
946 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
947 'This option can be used multiple times to set the sleep for the different retry types, '
948 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
949 downloader
.add_option(
950 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
951 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
952 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
953 downloader
.add_option(
954 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
955 action
='store_false', dest
='skip_unavailable_fragments',
956 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
957 downloader
.add_option(
959 action
='store_true', dest
='keep_fragments', default
=False,
960 help='Keep downloaded fragments on disk after downloading is finished')
961 downloader
.add_option(
962 '--no-keep-fragments',
963 action
='store_false', dest
='keep_fragments',
964 help='Delete downloaded fragments after downloading is finished (default)')
965 downloader
.add_option(
967 dest
='buffersize', metavar
='SIZE', default
='1024',
968 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
969 downloader
.add_option(
971 action
='store_false', dest
='noresizebuffer',
972 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
973 downloader
.add_option(
974 '--no-resize-buffer',
975 action
='store_true', dest
='noresizebuffer', default
=False,
976 help='Do not automatically adjust the buffer size')
977 downloader
.add_option(
979 dest
='http_chunk_size', metavar
='SIZE', default
=None,
981 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
982 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
983 downloader
.add_option(
985 action
='store_true', dest
='test', default
=False,
986 help=optparse
.SUPPRESS_HELP
)
987 downloader
.add_option(
988 '--playlist-reverse',
989 action
='store_true', dest
='playlist_reverse',
990 help=optparse
.SUPPRESS_HELP
)
991 downloader
.add_option(
992 '--no-playlist-reverse',
993 action
='store_false', dest
='playlist_reverse',
994 help=optparse
.SUPPRESS_HELP
)
995 downloader
.add_option(
997 action
='store_true', dest
='playlist_random',
998 help='Download playlist videos in random order')
999 downloader
.add_option(
1001 action
='store_true', dest
='lazy_playlist',
1002 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
1003 downloader
.add_option(
1004 '--no-lazy-playlist',
1005 action
='store_false', dest
='lazy_playlist',
1006 help='Process videos in the playlist only after the entire playlist is parsed (default)')
1007 downloader
.add_option(
1008 '--xattr-set-filesize',
1009 dest
='xattr_set_filesize', action
='store_true',
1010 help='Set file xattribute ytdl.filesize with expected file size')
1011 downloader
.add_option(
1012 '--hls-prefer-native',
1013 dest
='hls_prefer_native', action
='store_true', default
=None,
1014 help=optparse
.SUPPRESS_HELP
)
1015 downloader
.add_option(
1016 '--hls-prefer-ffmpeg',
1017 dest
='hls_prefer_native', action
='store_false', default
=None,
1018 help=optparse
.SUPPRESS_HELP
)
1019 downloader
.add_option(
1021 dest
='hls_use_mpegts', action
='store_true', default
=None,
1023 'Use the mpegts container for HLS videos; '
1024 'allowing some players to play the video while downloading, '
1025 'and reducing the chance of file corruption if download is interrupted. '
1026 'This is enabled by default for live streams'))
1027 downloader
.add_option(
1028 '--no-hls-use-mpegts',
1029 dest
='hls_use_mpegts', action
='store_false',
1031 'Do not use the mpegts container for HLS videos. '
1032 'This is default when not downloading live streams'))
1033 downloader
.add_option(
1034 '--download-sections',
1035 metavar
='REGEX', dest
='download_ranges', action
='append',
1037 'Download only chapters that match the regular expression. '
1038 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
1039 '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
1040 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1041 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1042 downloader
.add_option(
1043 '--downloader', '--external-downloader',
1044 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
1045 action
='callback', callback
=_dict_from_options_callback
,
1047 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1048 'default_key': 'default',
1049 'process': str.strip
,
1051 'Name or path of the external downloader to use (optionally) prefixed by '
1052 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1053 f
'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1054 'You can use this option multiple times to set different downloaders for different protocols. '
1055 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1056 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1057 '(Alias: --external-downloader)'))
1058 downloader
.add_option(
1059 '--downloader-args', '--external-downloader-args',
1060 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
1061 action
='callback', callback
=_dict_from_options_callback
,
1063 'allowed_keys': r
'ffmpeg_[io]\d*|{}'.format('|'.join(map(re
.escape
, list_external_downloaders()))),
1064 'default_key': 'default',
1065 'process': shlex
.split
,
1067 'Give these arguments to the external downloader. '
1068 'Specify the downloader name and the arguments separated by a colon ":". '
1069 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1070 'You can use this option multiple times to give different arguments to different downloaders '
1071 '(Alias: --external-downloader-args)'))
1073 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
1074 workarounds
.add_option(
1076 dest
='encoding', metavar
='ENCODING',
1077 help='Force the specified encoding (experimental)')
1078 workarounds
.add_option(
1079 '--legacy-server-connect',
1080 action
='store_true', dest
='legacy_server_connect', default
=False,
1081 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1082 workarounds
.add_option(
1083 '--no-check-certificates',
1084 action
='store_true', dest
='no_check_certificate', default
=False,
1085 help='Suppress HTTPS certificate validation')
1086 workarounds
.add_option(
1087 '--prefer-insecure', '--prefer-unsecure',
1088 action
='store_true', dest
='prefer_insecure',
1089 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1090 workarounds
.add_option(
1092 metavar
='UA', dest
='user_agent',
1093 help=optparse
.SUPPRESS_HELP
)
1094 workarounds
.add_option(
1096 metavar
='URL', dest
='referer', default
=None,
1097 help=optparse
.SUPPRESS_HELP
)
1098 workarounds
.add_option(
1100 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
1101 action
='callback', callback
=_dict_from_options_callback
,
1102 callback_kwargs
={'multiple_keys': False}
,
1103 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1105 workarounds
.add_option(
1106 '--bidi-workaround',
1107 dest
='bidi_workaround', action
='store_true',
1108 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1109 workarounds
.add_option(
1110 '--sleep-requests', metavar
='SECONDS',
1111 dest
='sleep_interval_requests', type=float,
1112 help='Number of seconds to sleep between requests during data extraction')
1113 workarounds
.add_option(
1114 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
1115 dest
='sleep_interval', type=float,
1117 'Number of seconds to sleep before each download. '
1118 'This is the minimum time to sleep when used along with --max-sleep-interval '
1119 '(Alias: --min-sleep-interval)'))
1120 workarounds
.add_option(
1121 '--max-sleep-interval', metavar
='SECONDS',
1122 dest
='max_sleep_interval', type=float,
1123 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1124 workarounds
.add_option(
1125 '--sleep-subtitles', metavar
='SECONDS',
1126 dest
='sleep_interval_subtitles', default
=0, type=int,
1127 help='Number of seconds to sleep before each subtitle download')
1129 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
1130 verbosity
.add_option(
1132 action
='store_true', dest
='quiet', default
=None,
1133 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1134 verbosity
.add_option(
1136 action
='store_false', dest
='quiet',
1137 help='Deactivate quiet mode. (Default)')
1138 verbosity
.add_option(
1140 dest
='no_warnings', action
='store_true', default
=False,
1141 help='Ignore warnings')
1142 verbosity
.add_option(
1144 action
='store_true', dest
='simulate', default
=None,
1145 help='Do not download the video and do not write anything to disk')
1146 verbosity
.add_option(
1148 action
='store_false', dest
='simulate',
1149 help='Download the video even if printing/listing options are used')
1150 verbosity
.add_option(
1151 '--ignore-no-formats-error',
1152 action
='store_true', dest
='ignore_no_formats_error', default
=False,
1154 'Ignore "No video formats" error. Useful for extracting metadata '
1155 'even if the videos are not actually available for download (experimental)'))
1156 verbosity
.add_option(
1157 '--no-ignore-no-formats-error',
1158 action
='store_false', dest
='ignore_no_formats_error',
1159 help='Throw error when no downloadable video formats are found (default)')
1160 verbosity
.add_option(
1161 '--skip-download', '--no-download',
1162 action
='store_true', dest
='skip_download', default
=False,
1163 help='Do not download the video but write all related files (Alias: --no-download)')
1164 verbosity
.add_option(
1166 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', **when_prefix('video'),
1168 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1169 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1170 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1171 'This option can be used multiple times'))
1172 verbosity
.add_option(
1174 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', nargs
=2, **when_prefix('video'),
1176 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1177 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1178 verbosity
.add_option(
1180 action
='store_true', dest
='geturl', default
=False,
1181 help=optparse
.SUPPRESS_HELP
)
1182 verbosity
.add_option(
1183 '-e', '--get-title',
1184 action
='store_true', dest
='gettitle', default
=False,
1185 help=optparse
.SUPPRESS_HELP
)
1186 verbosity
.add_option(
1188 action
='store_true', dest
='getid', default
=False,
1189 help=optparse
.SUPPRESS_HELP
)
1190 verbosity
.add_option(
1192 action
='store_true', dest
='getthumbnail', default
=False,
1193 help=optparse
.SUPPRESS_HELP
)
1194 verbosity
.add_option(
1195 '--get-description',
1196 action
='store_true', dest
='getdescription', default
=False,
1197 help=optparse
.SUPPRESS_HELP
)
1198 verbosity
.add_option(
1200 action
='store_true', dest
='getduration', default
=False,
1201 help=optparse
.SUPPRESS_HELP
)
1202 verbosity
.add_option(
1204 action
='store_true', dest
='getfilename', default
=False,
1205 help=optparse
.SUPPRESS_HELP
)
1206 verbosity
.add_option(
1208 action
='store_true', dest
='getformat', default
=False,
1209 help=optparse
.SUPPRESS_HELP
)
1210 verbosity
.add_option(
1211 '-j', '--dump-json',
1212 action
='store_true', dest
='dumpjson', default
=False,
1214 'Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. '
1215 'See "OUTPUT TEMPLATE" for a description of available keys'))
1216 verbosity
.add_option(
1217 '-J', '--dump-single-json',
1218 action
='store_true', dest
='dump_single_json', default
=False,
1220 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1221 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1222 verbosity
.add_option(
1224 action
='store_true', dest
='print_json', default
=False,
1225 help=optparse
.SUPPRESS_HELP
)
1226 verbosity
.add_option(
1227 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1228 action
='store_true', dest
='force_write_download_archive', default
=False,
1230 'Force download archive entries to be written as far as no errors occur, '
1231 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1232 verbosity
.add_option(
1234 action
='store_true', dest
='progress_with_newline', default
=False,
1235 help='Output progress bar as new lines')
1236 verbosity
.add_option(
1238 action
='store_true', dest
='noprogress', default
=None,
1239 help='Do not print progress bar')
1240 verbosity
.add_option(
1242 action
='store_false', dest
='noprogress',
1243 help='Show progress bar, even if in quiet mode')
1244 verbosity
.add_option(
1246 action
='store_true', dest
='consoletitle', default
=False,
1247 help='Display progress in console titlebar')
1248 verbosity
.add_option(
1249 '--progress-template',
1250 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1251 action
='callback', callback
=_dict_from_options_callback
,
1253 'allowed_keys': '(download|postprocess)(-title)?',
1254 'default_key': 'download',
1256 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1257 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1258 'The video\'s fields are accessible under the "info" key and '
1259 'the progress attributes are accessible under "progress" key. E.g. '
1260 # TODO: Document the fields inside "progress"
1261 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1262 verbosity
.add_option(
1264 metavar
='SECONDS', action
='store', dest
='progress_delta', type=float, default
=0,
1265 help='Time between progress output (default: 0)')
1266 verbosity
.add_option(
1268 action
='store_true', dest
='verbose', default
=False,
1269 help='Print various debugging information')
1270 verbosity
.add_option(
1271 '--dump-pages', '--dump-intermediate-pages',
1272 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1273 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1274 verbosity
.add_option(
1276 action
='store_true', dest
='write_pages', default
=False,
1277 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1278 verbosity
.add_option(
1280 action
='store_true', dest
='load_pages', default
=False,
1281 help=optparse
.SUPPRESS_HELP
)
1282 verbosity
.add_option(
1283 '--youtube-print-sig-code',
1284 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1285 help=optparse
.SUPPRESS_HELP
)
1286 verbosity
.add_option(
1287 '--print-traffic', '--dump-headers',
1288 dest
='debug_printtraffic', action
='store_true', default
=False,
1289 help='Display sent and read HTTP traffic')
1290 verbosity
.add_option(
1291 '-C', '--call-home',
1292 dest
='call_home', action
='store_true', default
=False,
1293 # help='Contact the yt-dlp server for debugging')
1294 help=optparse
.SUPPRESS_HELP
)
1295 verbosity
.add_option(
1297 dest
='call_home', action
='store_false',
1298 # help='Do not contact the yt-dlp server for debugging (default)')
1299 help=optparse
.SUPPRESS_HELP
)
1301 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1302 filesystem
.add_option(
1303 '-a', '--batch-file',
1304 dest
='batchfile', metavar
='FILE',
1306 'File containing URLs to download ("-" for stdin), one URL per line. '
1307 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1308 filesystem
.add_option(
1310 dest
='batchfile', action
='store_const', const
=None,
1311 help='Do not read URLs from batch file (default)')
1312 filesystem
.add_option(
1313 '--id', default
=False,
1314 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1315 filesystem
.add_option(
1317 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1318 action
='callback', callback
=_dict_from_options_callback
,
1320 'allowed_keys': 'home|temp|{}'.format('|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys()))),
1321 'default_key': 'home',
1323 'The paths where the files should be downloaded. '
1324 'Specify the type of file and the path separated by a colon ":". '
1325 'All the same TYPES as --output are supported. '
1326 'Additionally, you can also provide "home" (default) and "temp" paths. '
1327 'All intermediary files are first downloaded to the temp path and '
1328 'then the final files are moved over to the home path after download is finished. '
1329 'This option is ignored if --output is an absolute path'))
1330 filesystem
.add_option(
1332 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1333 action
='callback', callback
=_dict_from_options_callback
,
1335 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1336 'default_key': 'default',
1337 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1338 filesystem
.add_option(
1339 '--output-na-placeholder',
1340 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1341 help=('Placeholder for unavailable fields in --output (default: "%default")'))
1342 filesystem
.add_option(
1343 '--autonumber-size',
1344 dest
='autonumber_size', metavar
='NUMBER', type=int,
1345 help=optparse
.SUPPRESS_HELP
)
1346 filesystem
.add_option(
1347 '--autonumber-start',
1348 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1349 help=optparse
.SUPPRESS_HELP
)
1350 filesystem
.add_option(
1351 '--restrict-filenames',
1352 action
='store_true', dest
='restrictfilenames', default
=False,
1353 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1354 filesystem
.add_option(
1355 '--no-restrict-filenames',
1356 action
='store_false', dest
='restrictfilenames',
1357 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1358 filesystem
.add_option(
1359 '--windows-filenames',
1360 action
='store_true', dest
='windowsfilenames', default
=False,
1361 help='Force filenames to be Windows-compatible')
1362 filesystem
.add_option(
1363 '--no-windows-filenames',
1364 action
='store_false', dest
='windowsfilenames',
1365 help='Make filenames Windows-compatible only if using Windows (default)')
1366 filesystem
.add_option(
1367 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1368 dest
='trim_file_name', default
=0, type=int,
1369 help='Limit the filename length (excluding extension) to the specified number of characters')
1370 filesystem
.add_option(
1371 '-w', '--no-overwrites',
1372 action
='store_false', dest
='overwrites', default
=None,
1373 help='Do not overwrite any files')
1374 filesystem
.add_option(
1375 '--force-overwrites', '--yes-overwrites',
1376 action
='store_true', dest
='overwrites',
1377 help='Overwrite all video and metadata files. This option includes --no-continue')
1378 filesystem
.add_option(
1379 '--no-force-overwrites',
1380 action
='store_const', dest
='overwrites', const
=None,
1381 help='Do not overwrite the video, but overwrite related files (default)')
1382 filesystem
.add_option(
1384 action
='store_true', dest
='continue_dl', default
=True,
1385 help='Resume partially downloaded files/fragments (default)')
1386 filesystem
.add_option(
1388 action
='store_false', dest
='continue_dl',
1390 'Do not resume partially downloaded fragments. '
1391 'If the file is not fragmented, restart download of the entire file'))
1392 filesystem
.add_option(
1394 action
='store_false', dest
='nopart', default
=False,
1395 help='Use .part files instead of writing directly into output file (default)')
1396 filesystem
.add_option(
1398 action
='store_true', dest
='nopart',
1399 help='Do not use .part files - write directly into output file')
1400 filesystem
.add_option(
1402 action
='store_true', dest
='updatetime', default
=True,
1403 help='Use the Last-modified header to set the file modification time (default)')
1404 filesystem
.add_option(
1406 action
='store_false', dest
='updatetime',
1407 help='Do not use the Last-modified header to set the file modification time')
1408 filesystem
.add_option(
1409 '--write-description',
1410 action
='store_true', dest
='writedescription', default
=False,
1411 help='Write video description to a .description file')
1412 filesystem
.add_option(
1413 '--no-write-description',
1414 action
='store_false', dest
='writedescription',
1415 help='Do not write video description (default)')
1416 filesystem
.add_option(
1417 '--write-info-json',
1418 action
='store_true', dest
='writeinfojson', default
=None,
1419 help='Write video metadata to a .info.json file (this may contain personal information)')
1420 filesystem
.add_option(
1421 '--no-write-info-json',
1422 action
='store_false', dest
='writeinfojson',
1423 help='Do not write video metadata (default)')
1424 filesystem
.add_option(
1425 '--write-annotations',
1426 action
='store_true', dest
='writeannotations', default
=False,
1427 help=optparse
.SUPPRESS_HELP
)
1428 filesystem
.add_option(
1429 '--no-write-annotations',
1430 action
='store_false', dest
='writeannotations',
1431 help=optparse
.SUPPRESS_HELP
)
1432 filesystem
.add_option(
1433 '--write-playlist-metafiles',
1434 action
='store_true', dest
='allow_playlist_files', default
=None,
1436 'Write playlist metadata in addition to the video metadata '
1437 'when using --write-info-json, --write-description etc. (default)'))
1438 filesystem
.add_option(
1439 '--no-write-playlist-metafiles',
1440 action
='store_false', dest
='allow_playlist_files',
1441 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1442 filesystem
.add_option(
1443 '--clean-info-json', '--clean-infojson',
1444 action
='store_true', dest
='clean_infojson', default
=None,
1446 'Remove some internal metadata such as filenames from the infojson (default)'))
1447 filesystem
.add_option(
1448 '--no-clean-info-json', '--no-clean-infojson',
1449 action
='store_false', dest
='clean_infojson',
1450 help='Write all fields to the infojson')
1451 filesystem
.add_option(
1452 '--write-comments', '--get-comments',
1453 action
='store_true', dest
='getcomments', default
=False,
1455 'Retrieve video comments to be placed in the infojson. '
1456 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1457 filesystem
.add_option(
1458 '--no-write-comments', '--no-get-comments',
1459 action
='store_false', dest
='getcomments',
1460 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1461 filesystem
.add_option(
1462 '--load-info-json', '--load-info',
1463 dest
='load_info_filename', metavar
='FILE',
1464 help='JSON file containing the video information (created with the "--write-info-json" option)')
1465 filesystem
.add_option(
1467 dest
='cookiefile', metavar
='FILE',
1468 help='Netscape formatted file to read cookies from and dump cookie jar in')
1469 filesystem
.add_option(
1471 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1472 help='Do not read/dump cookies from/to file (default)')
1473 filesystem
.add_option(
1474 '--cookies-from-browser',
1475 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1477 'The name of the browser to load cookies from. '
1478 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1479 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1480 'the name/path of the PROFILE to load cookies from, '
1481 'and the CONTAINER name (if Firefox) ("none" for no container) '
1482 'can be given with their respective separators. '
1483 'By default, all containers of the most recently accessed profile are used. '
1484 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1485 filesystem
.add_option(
1486 '--no-cookies-from-browser',
1487 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1488 help='Do not load cookies from browser (default)')
1489 filesystem
.add_option(
1490 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1492 'Location in the filesystem where yt-dlp can store some downloaded information '
1493 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1494 filesystem
.add_option(
1495 '--no-cache-dir', action
='store_false', dest
='cachedir',
1496 help='Disable filesystem caching')
1497 filesystem
.add_option(
1499 action
='store_true', dest
='rm_cachedir',
1500 help='Delete all filesystem cache files')
1502 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1503 thumbnail
.add_option(
1504 '--write-thumbnail',
1505 action
='callback', dest
='writethumbnail', default
=False,
1506 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1507 callback
=lambda option
, _
, __
, parser
: setattr(
1508 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1509 help='Write thumbnail image to disk')
1510 thumbnail
.add_option(
1511 '--no-write-thumbnail',
1512 action
='store_false', dest
='writethumbnail',
1513 help='Do not write thumbnail image to disk (default)')
1514 thumbnail
.add_option(
1515 '--write-all-thumbnails',
1516 action
='store_const', dest
='writethumbnail', const
='all',
1517 help='Write all thumbnail image formats to disk')
1518 thumbnail
.add_option(
1519 '--list-thumbnails',
1520 action
='store_true', dest
='list_thumbnails', default
=False,
1521 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1523 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1526 action
='store_true', dest
='writelink', default
=False,
1527 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1530 action
='store_true', dest
='writeurllink', default
=False,
1531 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1533 '--write-webloc-link',
1534 action
='store_true', dest
='writewebloclink', default
=False,
1535 help='Write a .webloc macOS internet shortcut')
1537 '--write-desktop-link',
1538 action
='store_true', dest
='writedesktoplink', default
=False,
1539 help='Write a .desktop Linux internet shortcut')
1541 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1542 postproc
.add_option(
1543 '-x', '--extract-audio',
1544 action
='store_true', dest
='extractaudio', default
=False,
1545 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1546 postproc
.add_option(
1547 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1549 'Format to convert the audio to when -x is used. '
1550 f
'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1551 'You can specify multiple rules using similar syntax as --remux-video'))
1552 postproc
.add_option(
1553 '--audio-quality', metavar
='QUALITY',
1554 dest
='audioquality', default
='5',
1556 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1557 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1558 postproc
.add_option(
1560 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1562 'Remux the video into another container if necessary '
1563 f
'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1564 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1565 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1566 postproc
.add_option(
1568 metavar
='FORMAT', dest
='recodevideo', default
=None,
1569 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1570 postproc
.add_option(
1571 '--postprocessor-args', '--ppa',
1572 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1573 action
='callback', callback
=_dict_from_options_callback
,
1575 'allowed_keys': r
'\w+(?:\+\w+)?',
1576 'default_key': 'default-compat',
1577 'process': shlex
.split
,
1578 'multiple_keys': False,
1580 'Give these arguments to the postprocessors. '
1581 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1582 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1583 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1584 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1585 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1586 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1587 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1588 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1589 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1590 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1591 'You can use this option multiple times to give different arguments to different '
1592 'postprocessors. (Alias: --ppa)'))
1593 postproc
.add_option(
1594 '-k', '--keep-video',
1595 action
='store_true', dest
='keepvideo', default
=False,
1596 help='Keep the intermediate video file on disk after post-processing')
1597 postproc
.add_option(
1599 action
='store_false', dest
='keepvideo',
1600 help='Delete the intermediate video file after post-processing (default)')
1601 postproc
.add_option(
1602 '--post-overwrites',
1603 action
='store_false', dest
='nopostoverwrites',
1604 help='Overwrite post-processed files (default)')
1605 postproc
.add_option(
1606 '--no-post-overwrites',
1607 action
='store_true', dest
='nopostoverwrites', default
=False,
1608 help='Do not overwrite post-processed files')
1609 postproc
.add_option(
1611 action
='store_true', dest
='embedsubtitles', default
=False,
1612 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1613 postproc
.add_option(
1615 action
='store_false', dest
='embedsubtitles',
1616 help='Do not embed subtitles (default)')
1617 postproc
.add_option(
1618 '--embed-thumbnail',
1619 action
='store_true', dest
='embedthumbnail', default
=False,
1620 help='Embed thumbnail in the video as cover art')
1621 postproc
.add_option(
1622 '--no-embed-thumbnail',
1623 action
='store_false', dest
='embedthumbnail',
1624 help='Do not embed thumbnail (default)')
1625 postproc
.add_option(
1626 '--embed-metadata', '--add-metadata',
1627 action
='store_true', dest
='addmetadata', default
=False,
1629 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1630 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1631 postproc
.add_option(
1632 '--no-embed-metadata', '--no-add-metadata',
1633 action
='store_false', dest
='addmetadata',
1634 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1635 postproc
.add_option(
1636 '--embed-chapters', '--add-chapters',
1637 action
='store_true', dest
='addchapters', default
=None,
1638 help='Add chapter markers to the video file (Alias: --add-chapters)')
1639 postproc
.add_option(
1640 '--no-embed-chapters', '--no-add-chapters',
1641 action
='store_false', dest
='addchapters',
1642 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1643 postproc
.add_option(
1644 '--embed-info-json',
1645 action
='store_true', dest
='embed_infojson', default
=None,
1646 help='Embed the infojson as an attachment to mkv/mka video files')
1647 postproc
.add_option(
1648 '--no-embed-info-json',
1649 action
='store_false', dest
='embed_infojson',
1650 help='Do not embed the infojson as an attachment to the video file')
1651 postproc
.add_option(
1652 '--metadata-from-title',
1653 metavar
='FORMAT', dest
='metafromtitle',
1654 help=optparse
.SUPPRESS_HELP
)
1655 postproc
.add_option(
1657 metavar
='[WHEN:]FROM:TO', dest
='parse_metadata', **when_prefix('pre_process'),
1659 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1660 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1661 postproc
.add_option(
1662 '--replace-in-metadata',
1663 dest
='parse_metadata', metavar
='[WHEN:]FIELDS REGEX REPLACE', nargs
=3, **when_prefix('pre_process'),
1665 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1666 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1667 postproc
.add_option(
1668 '--xattrs', '--xattr',
1669 action
='store_true', dest
='xattrs', default
=False,
1670 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1671 postproc
.add_option(
1672 '--concat-playlist',
1673 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1674 choices
=('never', 'always', 'multi_video'),
1676 'Concatenate videos in a playlist. One of "never", "always", or '
1677 '"multi_video" (default; only when the videos form a single show). '
1678 'All the video files must have same codecs and number of streams to be concatable. '
1679 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1680 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1681 postproc
.add_option(
1683 metavar
='POLICY', dest
='fixup', default
=None,
1684 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1686 'Automatically correct known faults of the file. '
1687 'One of never (do nothing), warn (only emit a warning), '
1688 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1689 'force (try fixing even if file already exists)'))
1690 postproc
.add_option(
1691 '--prefer-avconv', '--no-prefer-ffmpeg',
1692 action
='store_false', dest
='prefer_ffmpeg',
1693 help=optparse
.SUPPRESS_HELP
)
1694 postproc
.add_option(
1695 '--prefer-ffmpeg', '--no-prefer-avconv',
1696 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1697 help=optparse
.SUPPRESS_HELP
)
1698 postproc
.add_option(
1699 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1700 dest
='ffmpeg_location',
1701 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1702 postproc
.add_option(
1704 metavar
='[WHEN:]CMD', dest
='exec_cmd', **when_prefix('after_move'),
1706 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1707 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1708 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1709 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1710 'This option can be used multiple times'))
1711 postproc
.add_option(
1713 action
='store_const', dest
='exec_cmd', const
={},
1714 help='Remove any previously defined --exec')
1715 postproc
.add_option(
1716 '--exec-before-download', metavar
='CMD',
1717 action
='append', dest
='exec_before_dl_cmd',
1718 help=optparse
.SUPPRESS_HELP
)
1719 postproc
.add_option(
1720 '--no-exec-before-download',
1721 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1722 help=optparse
.SUPPRESS_HELP
)
1723 postproc
.add_option(
1724 '--convert-subs', '--convert-sub', '--convert-subtitles',
1725 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1727 'Convert the subtitles to another format (currently supported: {}) '
1728 '(Alias: --convert-subtitles)'.format(', '.join(sorted(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))))
1729 postproc
.add_option(
1730 '--convert-thumbnails',
1731 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1733 'Convert the thumbnails to another format '
1734 f
'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1735 'You can specify multiple rules using similar syntax as --remux-video'))
1736 postproc
.add_option(
1737 '--split-chapters', '--split-tracks',
1738 dest
='split_chapters', action
='store_true', default
=False,
1740 'Split video into multiple files based on internal chapters. '
1741 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1742 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1743 postproc
.add_option(
1744 '--no-split-chapters', '--no-split-tracks',
1745 dest
='split_chapters', action
='store_false',
1746 help='Do not split video based on chapters (default)')
1747 postproc
.add_option(
1748 '--remove-chapters',
1749 metavar
='REGEX', dest
='remove_chapters', action
='append',
1751 'Remove chapters whose title matches the given regular expression. '
1752 'The syntax is the same as --download-sections. This option can be used multiple times'))
1753 postproc
.add_option(
1754 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1755 help='Do not remove any chapters from the file (default)')
1756 postproc
.add_option(
1757 '--force-keyframes-at-cuts',
1758 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1760 'Force keyframes at cuts when downloading/splitting/removing sections. '
1761 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1762 postproc
.add_option(
1763 '--no-force-keyframes-at-cuts',
1764 action
='store_false', dest
='force_keyframes_at_cuts',
1765 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1766 _postprocessor_opts_parser
= lambda key
, val
='': (
1767 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1768 ('key', remove_end(key
, 'PP')))
1769 postproc
.add_option(
1770 '--use-postprocessor',
1771 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1772 action
='callback', callback
=_list_from_options_callback
,
1775 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1))),
1777 'The (case sensitive) name of plugin postprocessors to be enabled, '
1778 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1779 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1780 'The "when" argument determines when the postprocessor is invoked. '
1781 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1782 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1783 '"post_process" (after each video download; default), '
1784 '"after_move" (after moving video file to its final locations), '
1785 '"after_video" (after downloading and processing all formats of a video), '
1786 'or "playlist" (at end of playlist). '
1787 'This option can be used multiple times to add different postprocessors'))
1789 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1790 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1791 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1792 sponsorblock
.add_option(
1793 '--sponsorblock-mark', metavar
='CATS',
1794 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1795 callback
=_set_from_options_callback
, callback_kwargs
={
1796 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1797 'aliases': {'default': ['all']}
,
1799 'SponsorBlock categories to create chapters for, separated by commas. '
1800 f
'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1801 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
1802 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1803 sponsorblock
.add_option(
1804 '--sponsorblock-remove', metavar
='CATS',
1805 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1806 callback
=_set_from_options_callback
, callback_kwargs
={
1807 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.NON_SKIPPABLE_CATEGORIES
.keys()),
1808 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1809 # The filler category is very aggressive.
1810 # It is strongly recommended to not use this in a client by default.
1811 'aliases': {'default': ['all', '-filler']}
,
1813 'SponsorBlock categories to be removed from the video file, separated by commas. '
1814 'If a category is present in both mark and remove, remove takes precedence. '
1815 'The syntax and available categories are the same as for --sponsorblock-mark '
1816 'except that "default" refers to "all,-filler" '
1817 f
'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1818 sponsorblock
.add_option(
1819 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1820 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1822 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1823 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1824 'Defaults to "%default"'))
1825 sponsorblock
.add_option(
1826 '--no-sponsorblock', default
=False,
1827 action
='store_true', dest
='no_sponsorblock',
1828 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1829 sponsorblock
.add_option(
1830 '--sponsorblock-api', metavar
='URL',
1831 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1832 help='SponsorBlock API location, defaults to %default')
1834 sponsorblock
.add_option(
1836 action
='store_true', dest
='sponskrub', default
=False,
1837 help=optparse
.SUPPRESS_HELP
)
1838 sponsorblock
.add_option(
1840 action
='store_false', dest
='sponskrub',
1841 help=optparse
.SUPPRESS_HELP
)
1842 sponsorblock
.add_option(
1843 '--sponskrub-cut', default
=False,
1844 action
='store_true', dest
='sponskrub_cut',
1845 help=optparse
.SUPPRESS_HELP
)
1846 sponsorblock
.add_option(
1847 '--no-sponskrub-cut',
1848 action
='store_false', dest
='sponskrub_cut',
1849 help=optparse
.SUPPRESS_HELP
)
1850 sponsorblock
.add_option(
1851 '--sponskrub-force', default
=False,
1852 action
='store_true', dest
='sponskrub_force',
1853 help=optparse
.SUPPRESS_HELP
)
1854 sponsorblock
.add_option(
1855 '--no-sponskrub-force',
1856 action
='store_true', dest
='sponskrub_force',
1857 help=optparse
.SUPPRESS_HELP
)
1858 sponsorblock
.add_option(
1859 '--sponskrub-location', metavar
='PATH',
1860 dest
='sponskrub_path', default
='',
1861 help=optparse
.SUPPRESS_HELP
)
1862 sponsorblock
.add_option(
1863 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1864 help=optparse
.SUPPRESS_HELP
)
1866 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1867 extractor
.add_option(
1868 '--extractor-retries',
1869 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1870 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1871 extractor
.add_option(
1872 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1873 action
='store_true', dest
='dynamic_mpd', default
=True,
1874 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1875 extractor
.add_option(
1876 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1877 action
='store_false', dest
='dynamic_mpd',
1878 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1879 extractor
.add_option(
1880 '--hls-split-discontinuity',
1881 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1882 help='Split HLS playlists to different formats at discontinuities such as ad breaks',
1884 extractor
.add_option(
1885 '--no-hls-split-discontinuity',
1886 dest
='hls_split_discontinuity', action
='store_false',
1887 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1888 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1889 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1890 extractor
.add_option(
1892 metavar
='IE_KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1893 action
='callback', callback
=_dict_from_options_callback
,
1895 'multiple_keys': False,
1896 'process': lambda val
: dict(
1897 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';')),
1899 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1900 'You can use this option multiple times to give arguments for different extractors'))
1901 extractor
.add_option(
1902 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1903 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1904 help=optparse
.SUPPRESS_HELP
)
1905 extractor
.add_option(
1906 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1907 action
='store_false', dest
='youtube_include_dash_manifest',
1908 help=optparse
.SUPPRESS_HELP
)
1909 extractor
.add_option(
1910 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1911 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1912 help=optparse
.SUPPRESS_HELP
)
1913 extractor
.add_option(
1914 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1915 action
='store_false', dest
='youtube_include_hls_manifest',
1916 help=optparse
.SUPPRESS_HELP
)
1918 parser
.add_option_group(general
)
1919 parser
.add_option_group(network
)
1920 parser
.add_option_group(geo
)
1921 parser
.add_option_group(selection
)
1922 parser
.add_option_group(downloader
)
1923 parser
.add_option_group(filesystem
)
1924 parser
.add_option_group(thumbnail
)
1925 parser
.add_option_group(link
)
1926 parser
.add_option_group(verbosity
)
1927 parser
.add_option_group(workarounds
)
1928 parser
.add_option_group(video_format
)
1929 parser
.add_option_group(subtitles
)
1930 parser
.add_option_group(authentication
)
1931 parser
.add_option_group(postproc
)
1932 parser
.add_option_group(sponsorblock
)
1933 parser
.add_option_group(extractor
)
1938 def _hide_login_info(opts
):
1939 deprecation_warning(f
'"{__name__}._hide_login_info" is deprecated and may be removed '
1940 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1941 return Config
.hide_login_info(opts
)