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'):
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 error(self
, msg
):
200 msg
= f
'{self.get_prog_name()}: error: {str(msg).strip()}\n'
201 raise optparse
.OptParseError(f
'{self.get_usage()}\n{msg}' if self
.usage
else msg
)
203 def _get_args(self
, args
):
204 return sys
.argv
[1:] if args
is None else list(args
)
206 def _match_long_opt(self
, opt
):
207 """Improve ambiguous argument resolution by comparing option objects instead of argument strings"""
209 return super()._match
_long
_opt
(opt
)
210 except optparse
.AmbiguousOptionError
as e
:
211 if len({self._long_opt[p] for p in e.possibilities}
) == 1:
212 return e
.possibilities
[0]
217 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
218 # append can be True, False or -1 (prepend)
219 current
= list(getattr(parser
.values
, option
.dest
)) if append
else []
220 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
222 parser
.values
, option
.dest
,
223 current
+ value
if append
is True else value
+ current
)
225 def _set_from_options_callback(
226 option
, opt_str
, value
, parser
, allowed_values
, delim
=',', aliases
={},
227 process
=lambda x
: x
.lower().strip()):
228 values
= [process(value
)] if delim
is None else map(process
, value
.split(delim
))
230 requested
= orderedSet_from_options(values
, collections
.ChainMap(aliases
, {'all': allowed_values}
),
231 start
=getattr(parser
.values
, option
.dest
))
232 except ValueError as e
:
233 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {e.args[0]}')
235 setattr(parser
.values
, option
.dest
, set(requested
))
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
'(?is)(?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
= variadic(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 def when_prefix(default
):
271 'action': 'callback',
272 'callback': _dict_from_options_callback
,
274 'allowed_keys': '|'.join(map(re
.escape
, POSTPROCESS_WHEN
)),
275 'default_key': default
,
276 'multiple_keys': False,
281 parser
= _YoutubeDLOptionParser()
282 alias_group
= optparse
.OptionGroup(parser
, 'Aliases')
283 Formatter
= string
.Formatter()
285 def _create_alias(option
, opt_str
, value
, parser
):
286 aliases
, opts
= value
288 nargs
= len({i
if f
== '' else f
289 for i
, (_
, f
, _
, _
) in enumerate(Formatter
.parse(opts
)) if f
is not None})
290 opts
.format(*map(str, range(nargs
))) # validate
291 except Exception as err
:
292 raise optparse
.OptionValueError(f
'wrong {opt_str} OPTIONS formatting; {err}')
293 if alias_group
not in parser
.option_groups
:
294 parser
.add_option_group(alias_group
)
296 aliases
= (x
if x
.startswith('-') else f
'--{x}' for x
in map(str.strip
, aliases
.split(',')))
298 args
= [f
'ARG{i}' for i
in range(nargs
)]
299 alias_group
.add_option(
300 *aliases
, nargs
=nargs
, dest
=parser
.ALIAS_DEST
, type='str' if nargs
else None,
301 metavar
=' '.join(args
), help=opts
.format(*args
), action
='callback',
302 callback
=_alias_callback
, callback_kwargs
={'opts': opts, 'nargs': nargs}
)
303 except Exception as err
:
304 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
306 def _alias_callback(option
, opt_str
, value
, parser
, opts
, nargs
):
307 counter
= getattr(parser
.values
, option
.dest
)
308 counter
[opt_str
] += 1
309 if counter
[opt_str
] > parser
.ALIAS_TRIGGER_LIMIT
:
310 raise optparse
.OptionValueError(f
'Alias {opt_str} exceeded invocation limit')
313 assert (nargs
== 0 and value
is None) or len(value
) == nargs
314 parser
.rargs
[:0] = shlex
.split(
315 opts
if value
is None else opts
.format(*map(shlex
.quote
, value
)))
317 general
= optparse
.OptionGroup(parser
, 'General Options')
319 '-h', '--help', dest
='print_help', action
='store_true',
320 help='Print this help text and exit')
324 help='Print program version and exit')
327 action
='store_const', dest
='update_self', const
=CHANNEL
,
329 is_non_updateable(), None, 'Check if updates are available. %s',
330 default
=f
'Update this program to the latest {CHANNEL} version'))
333 action
='store_false', dest
='update_self',
334 help='Do not check for updates (default)')
337 action
='store', dest
='update_self', metavar
='[CHANNEL]@[TAG]',
339 'Upgrade/downgrade to a specific version. CHANNEL can be a repository as well. '
340 f
'CHANNEL and TAG default to "{CHANNEL.partition("@")[0]}" and "latest" respectively if omitted; '
341 f
'See "UPDATE" for details. Supported channels: {", ".join(UPDATE_SOURCES)}'))
343 '-i', '--ignore-errors',
344 action
='store_true', dest
='ignoreerrors',
345 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
347 '--no-abort-on-error',
348 action
='store_const', dest
='ignoreerrors', const
='only_download',
349 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
351 '--abort-on-error', '--no-ignore-errors',
352 action
='store_false', dest
='ignoreerrors',
353 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
356 action
='store_true', dest
='dump_user_agent', default
=False,
357 help='Display the current user-agent and exit')
360 action
='store_true', dest
='list_extractors', default
=False,
361 help='List all supported extractors and exit')
363 '--extractor-descriptions',
364 action
='store_true', dest
='list_extractor_descriptions', default
=False,
365 help='Output descriptions of all supported extractors and exit')
367 '--use-extractors', '--ies',
368 action
='callback', dest
='allowed_extractors', metavar
='NAMES', type='str',
369 default
=[], callback
=_list_from_options_callback
,
371 'Extractor names to use separated by commas. '
372 'You can also use regexes, "all", "default" and "end" (end URL matching); '
373 'e.g. --ies "holodex.*,end,youtube". '
374 'Prefix the name with a "-" to exclude it, e.g. --ies default,-generic. '
375 'Use --list-extractors for a list of extractor names. (Alias: --ies)'))
377 '--force-generic-extractor',
378 action
='store_true', dest
='force_generic_extractor', default
=False,
379 help=optparse
.SUPPRESS_HELP
)
382 dest
='default_search', metavar
='PREFIX',
384 'Use this prefix for unqualified URLs. '
385 'E.g. "gvsearch2:python" downloads two videos from google videos for the search term "python". '
386 'Use the value "auto" to let yt-dlp guess ("auto_warning" to emit a warning when guessing). '
387 '"error" just throws an error. The default value "fixup_error" repairs broken URLs, '
388 'but emits an error if this is not possible instead of searching'))
390 '--ignore-config', '--no-config',
391 action
='store_true', dest
='ignoreconfig',
393 'Don\'t load any more configuration files except those given by --config-locations. '
394 'For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
395 '(Alias: --no-config)'))
397 '--no-config-locations',
398 action
='store_const', dest
='config_locations', const
=[],
400 'Do not load any custom configuration files (default). When given inside a '
401 'configuration file, ignore all previous --config-locations defined in the current file'))
403 '--config-locations',
404 dest
='config_locations', metavar
='PATH', action
='append',
406 'Location of the main configuration file; either the path to the config or its containing directory '
407 '("-" for stdin). Can be used multiple times and inside other configuration files'))
410 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
411 help='Do not extract the videos of a playlist, only list them')
413 '--no-flat-playlist',
414 action
='store_false', dest
='extract_flat',
415 help='Fully extract the videos of a playlist (default)')
418 action
='store_true', dest
='live_from_start',
419 help='Download livestreams from the start. Currently only supported for YouTube (Experimental)')
421 '--no-live-from-start',
422 action
='store_false', dest
='live_from_start',
423 help='Download livestreams from the current time (default)')
426 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
428 'Wait for scheduled streams to become available. '
429 'Pass the minimum number of seconds (or range) to wait between retries'))
431 '--no-wait-for-video',
432 dest
='wait_for_video', action
='store_const', const
=None,
433 help='Do not wait for scheduled streams (default)')
436 action
='store_true', dest
='mark_watched', default
=False,
437 help='Mark videos watched (even with --simulate)')
440 action
='store_false', dest
='mark_watched',
441 help='Do not mark videos watched (default)')
443 '--no-colors', '--no-colours',
444 action
='store_const', dest
='color', const
={
445 'stdout': 'no_color',
446 'stderr': 'no_color',
448 help=optparse
.SUPPRESS_HELP
)
451 dest
='color', metavar
='[STREAM:]POLICY', default
={}, type='str',
452 action
='callback', callback
=_dict_from_options_callback
,
454 'allowed_keys': 'stdout|stderr',
455 'default_key': ['stdout', 'stderr'],
456 'process': str.strip
,
458 'Whether to emit color codes in output, optionally prefixed by '
459 'the STREAM (stdout or stderr) to apply the setting to. '
460 'Can be one of "always", "auto" (default), "never", or '
461 '"no_color" (use non color terminal sequences). '
462 'Can be used multiple times'))
465 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
466 action
='callback', callback
=_set_from_options_callback
,
469 'filename', 'filename-sanitization', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
470 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
471 'no-attach-info-json', 'embed-thumbnail-atomicparsley', 'no-external-downloader-progress',
472 'embed-metadata', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs', 'no-certifi',
473 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-youtube-prefer-utc-upload-date',
475 'youtube-dl': ['all', '-multistreams'],
476 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat'],
477 '2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'],
478 '2022': ['no-external-downloader-progress'],
481 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
482 'configurations by reverting some of the changes made in yt-dlp. '
483 'See "Differences in default behavior" for details'))
485 '--alias', metavar
='ALIASES OPTIONS', dest
='_', type='str', nargs
=2,
486 action
='callback', callback
=_create_alias
,
488 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
489 'Arguments are parsed according to the Python string formatting mini-language. '
490 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
491 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
492 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
493 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
494 f
'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
495 'This option can be used multiple times'))
497 network
= optparse
.OptionGroup(parser
, 'Network Options')
499 '--proxy', dest
='proxy',
500 default
=None, metavar
='URL',
502 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
503 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
506 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
507 help='Time to wait before giving up, in seconds')
510 metavar
='IP', dest
='source_address', default
=None,
511 help='Client-side IP address to bind to',
514 '-4', '--force-ipv4',
515 action
='store_const', const
='0.0.0.0', dest
='source_address',
516 help='Make all connections via IPv4',
519 '-6', '--force-ipv6',
520 action
='store_const', const
='::', dest
='source_address',
521 help='Make all connections via IPv6',
524 '--enable-file-urls', action
='store_true',
525 dest
='enable_file_urls', default
=False,
526 help='Enable file:// URLs. This is disabled by default for security reasons.'
529 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
531 '--geo-verification-proxy',
532 dest
='geo_verification_proxy', default
=None, metavar
='URL',
534 'Use this proxy to verify the IP address for some geo-restricted sites. '
535 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
537 '--cn-verification-proxy',
538 dest
='cn_verification_proxy', default
=None, metavar
='URL',
539 help=optparse
.SUPPRESS_HELP
)
541 '--xff', metavar
='VALUE',
542 dest
='geo_bypass', default
='default',
544 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
545 'One of "default" (only when known to be useful), "never", '
546 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
549 action
='store_const', dest
='geo_bypass', const
='default',
550 help=optparse
.SUPPRESS_HELP
)
553 action
='store_const', dest
='geo_bypass', const
='never',
554 help=optparse
.SUPPRESS_HELP
)
556 '--geo-bypass-country', metavar
='CODE', dest
='geo_bypass',
557 help=optparse
.SUPPRESS_HELP
)
559 '--geo-bypass-ip-block', metavar
='IP_BLOCK', dest
='geo_bypass',
560 help=optparse
.SUPPRESS_HELP
)
562 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
563 selection
.add_option(
565 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
566 help=optparse
.SUPPRESS_HELP
)
567 selection
.add_option(
569 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
570 help=optparse
.SUPPRESS_HELP
)
571 selection
.add_option(
572 '-I', '--playlist-items',
573 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
575 'Comma separated playlist_index of the items to download. '
576 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
577 'Use negative indices to count from the right and negative STEP to download in reverse order. '
578 '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'))
579 selection
.add_option(
581 dest
='matchtitle', metavar
='REGEX',
582 help=optparse
.SUPPRESS_HELP
)
583 selection
.add_option(
585 dest
='rejecttitle', metavar
='REGEX',
586 help=optparse
.SUPPRESS_HELP
)
587 selection
.add_option(
589 metavar
='SIZE', dest
='min_filesize', default
=None,
590 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
591 selection
.add_option(
593 metavar
='SIZE', dest
='max_filesize', default
=None,
594 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
595 selection
.add_option(
597 metavar
='DATE', dest
='date', default
=None,
599 'Download only videos uploaded on this date. '
600 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
601 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
602 selection
.add_option(
604 metavar
='DATE', dest
='datebefore', default
=None,
606 'Download only videos uploaded on or before this date. '
607 'The date formats accepted is the same as --date'))
608 selection
.add_option(
610 metavar
='DATE', dest
='dateafter', default
=None,
612 'Download only videos uploaded on or after this date. '
613 'The date formats accepted is the same as --date'))
614 selection
.add_option(
616 metavar
='COUNT', dest
='min_views', default
=None, type=int,
617 help=optparse
.SUPPRESS_HELP
)
618 selection
.add_option(
620 metavar
='COUNT', dest
='max_views', default
=None, type=int,
621 help=optparse
.SUPPRESS_HELP
)
622 selection
.add_option(
624 metavar
='FILTER', dest
='match_filter', action
='append',
626 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
627 'number or a string using the operators defined in "Filtering Formats". '
628 'You can also simply specify a field to match if the field is present, '
629 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
630 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
631 'the filter matches if atleast one of the conditions are met. E.g. --match-filter '
632 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
633 'matches only videos that are not live OR those that have a like count more than 100 '
634 '(or the like field is not available) and also has a description '
635 'that contains the phrase "cats & dogs" (caseless). '
636 'Use "--match-filter -" to interactively ask whether to download each video'))
637 selection
.add_option(
638 '--no-match-filters',
639 dest
='match_filter', action
='store_const', const
=None,
640 help='Do not use any --match-filter (default)')
641 selection
.add_option(
642 '--break-match-filters',
643 metavar
='FILTER', dest
='breaking_match_filter', action
='append',
644 help='Same as "--match-filters" but stops the download process when a video is rejected')
645 selection
.add_option(
646 '--no-break-match-filters',
647 dest
='breaking_match_filter', action
='store_const', const
=None,
648 help='Do not use any --break-match-filters (default)')
649 selection
.add_option(
651 action
='store_true', dest
='noplaylist', default
=False,
652 help='Download only the video, if the URL refers to a video and a playlist')
653 selection
.add_option(
655 action
='store_false', dest
='noplaylist',
656 help='Download the playlist, if the URL refers to a video and a playlist')
657 selection
.add_option(
659 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
660 help='Download only videos suitable for the given age')
661 selection
.add_option(
662 '--download-archive', metavar
='FILE',
663 dest
='download_archive',
664 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
665 selection
.add_option(
666 '--no-download-archive',
667 dest
='download_archive', action
="store_const", const
=None,
668 help='Do not use archive file (default)')
669 selection
.add_option(
671 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
672 help='Abort after downloading NUMBER files')
673 selection
.add_option(
674 '--break-on-existing',
675 action
='store_true', dest
='break_on_existing', default
=False,
676 help='Stop the download process when encountering a file that is in the archive')
677 selection
.add_option(
679 action
='store_true', dest
='break_on_reject', default
=False,
680 help=optparse
.SUPPRESS_HELP
)
681 selection
.add_option(
683 action
='store_true', dest
='break_per_url', default
=False,
684 help='Alters --max-downloads, --break-on-existing, --break-match-filter, and autonumber to reset per input URL')
685 selection
.add_option(
686 '--no-break-per-input',
687 action
='store_false', dest
='break_per_url',
688 help='--break-on-existing and similar options terminates the entire download queue')
689 selection
.add_option(
690 '--skip-playlist-after-errors', metavar
='N',
691 dest
='skip_playlist_after_errors', default
=None, type=int,
692 help='Number of allowed failures until the rest of the playlist is skipped')
693 selection
.add_option(
695 dest
='include_ads', action
='store_true',
696 help=optparse
.SUPPRESS_HELP
)
697 selection
.add_option(
699 dest
='include_ads', action
='store_false',
700 help=optparse
.SUPPRESS_HELP
)
702 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
703 authentication
.add_option(
705 dest
='username', metavar
='USERNAME',
706 help='Login with this account ID')
707 authentication
.add_option(
709 dest
='password', metavar
='PASSWORD',
710 help='Account password. If this option is left out, yt-dlp will ask interactively')
711 authentication
.add_option(
713 dest
='twofactor', metavar
='TWOFACTOR',
714 help='Two-factor authentication code')
715 authentication
.add_option(
717 action
='store_true', dest
='usenetrc', default
=False,
718 help='Use .netrc authentication data')
719 authentication
.add_option(
721 dest
='netrc_location', metavar
='PATH',
722 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
723 authentication
.add_option(
725 dest
='videopassword', metavar
='PASSWORD',
726 help='Video password (vimeo, youku)')
727 authentication
.add_option(
729 dest
='ap_mso', metavar
='MSO',
730 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
731 authentication
.add_option(
733 dest
='ap_username', metavar
='USERNAME',
734 help='Multiple-system operator account login')
735 authentication
.add_option(
737 dest
='ap_password', metavar
='PASSWORD',
738 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
739 authentication
.add_option(
741 action
='store_true', dest
='ap_list_mso', default
=False,
742 help='List all supported multiple-system operators')
743 authentication
.add_option(
744 '--client-certificate',
745 dest
='client_certificate', metavar
='CERTFILE',
746 help='Path to client certificate file in PEM format. May include the private key')
747 authentication
.add_option(
748 '--client-certificate-key',
749 dest
='client_certificate_key', metavar
='KEYFILE',
750 help='Path to private key file for client certificate')
751 authentication
.add_option(
752 '--client-certificate-password',
753 dest
='client_certificate_password', metavar
='PASSWORD',
754 help='Password for client certificate private key, if encrypted. '
755 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
757 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
758 video_format
.add_option(
760 action
='store', dest
='format', metavar
='FORMAT', default
=None,
761 help='Video format code, see "FORMAT SELECTION" for more details')
762 video_format
.add_option(
763 '-S', '--format-sort', metavar
='SORTORDER',
764 dest
='format_sort', default
=[], type='str', action
='callback',
765 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
766 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
767 video_format
.add_option(
768 '--format-sort-force', '--S-force',
769 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
771 'Force user specified sort order to have precedence over all fields, '
772 'see "Sorting Formats" for more details (Alias: --S-force)'))
773 video_format
.add_option(
774 '--no-format-sort-force',
775 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
776 help='Some fields have precedence over the user specified sort order (default)')
777 video_format
.add_option(
778 '--video-multistreams',
779 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
780 help='Allow multiple video streams to be merged into a single file')
781 video_format
.add_option(
782 '--no-video-multistreams',
783 action
='store_false', dest
='allow_multiple_video_streams',
784 help='Only one video stream is downloaded for each output file (default)')
785 video_format
.add_option(
786 '--audio-multistreams',
787 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
788 help='Allow multiple audio streams to be merged into a single file')
789 video_format
.add_option(
790 '--no-audio-multistreams',
791 action
='store_false', dest
='allow_multiple_audio_streams',
792 help='Only one audio stream is downloaded for each output file (default)')
793 video_format
.add_option(
795 action
='store_const', dest
='format', const
='all',
796 help=optparse
.SUPPRESS_HELP
)
797 video_format
.add_option(
798 '--prefer-free-formats',
799 action
='store_true', dest
='prefer_free_formats', default
=False,
801 'Prefer video formats with free containers over non-free ones of same quality. '
802 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
803 video_format
.add_option(
804 '--no-prefer-free-formats',
805 action
='store_false', dest
='prefer_free_formats', default
=False,
806 help="Don't give any special preference to free containers (default)")
807 video_format
.add_option(
809 action
='store_const', const
='selected', dest
='check_formats', default
=None,
810 help='Make sure formats are selected only from those that are actually downloadable')
811 video_format
.add_option(
812 '--check-all-formats',
813 action
='store_true', dest
='check_formats',
814 help='Check all formats for whether they are actually downloadable')
815 video_format
.add_option(
816 '--no-check-formats',
817 action
='store_false', dest
='check_formats',
818 help='Do not check that the formats are actually downloadable')
819 video_format
.add_option(
820 '-F', '--list-formats',
821 action
='store_true', dest
='listformats',
822 help='List available formats of each video. Simulate unless --no-simulate is used')
823 video_format
.add_option(
824 '--list-formats-as-table',
825 action
='store_true', dest
='listformats_table', default
=True,
826 help=optparse
.SUPPRESS_HELP
)
827 video_format
.add_option(
828 '--list-formats-old', '--no-list-formats-as-table',
829 action
='store_false', dest
='listformats_table',
830 help=optparse
.SUPPRESS_HELP
)
831 video_format
.add_option(
832 '--merge-output-format',
833 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
835 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
836 'Ignored if no merge is required. '
837 f
'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
838 video_format
.add_option(
839 '--allow-unplayable-formats',
840 action
='store_true', dest
='allow_unplayable_formats', default
=False,
841 help=optparse
.SUPPRESS_HELP
)
842 video_format
.add_option(
843 '--no-allow-unplayable-formats',
844 action
='store_false', dest
='allow_unplayable_formats',
845 help=optparse
.SUPPRESS_HELP
)
847 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
848 subtitles
.add_option(
849 '--write-subs', '--write-srt',
850 action
='store_true', dest
='writesubtitles', default
=False,
851 help='Write subtitle file')
852 subtitles
.add_option(
853 '--no-write-subs', '--no-write-srt',
854 action
='store_false', dest
='writesubtitles',
855 help='Do not write subtitle file (default)')
856 subtitles
.add_option(
857 '--write-auto-subs', '--write-automatic-subs',
858 action
='store_true', dest
='writeautomaticsub', default
=False,
859 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
860 subtitles
.add_option(
861 '--no-write-auto-subs', '--no-write-automatic-subs',
862 action
='store_false', dest
='writeautomaticsub', default
=False,
863 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
864 subtitles
.add_option(
866 action
='store_true', dest
='allsubtitles', default
=False,
867 help=optparse
.SUPPRESS_HELP
)
868 subtitles
.add_option(
870 action
='store_true', dest
='listsubtitles', default
=False,
871 help='List available subtitles of each video. Simulate unless --no-simulate is used')
872 subtitles
.add_option(
874 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
875 help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"')
876 subtitles
.add_option(
877 '--sub-langs', '--srt-langs',
878 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
879 default
=[], callback
=_list_from_options_callback
,
881 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". '
882 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
883 'Use --list-subs for a list of available language tags'))
885 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
886 downloader
.add_option(
887 '-N', '--concurrent-fragments',
888 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
889 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
890 downloader
.add_option(
891 '-r', '--limit-rate', '--rate-limit',
892 dest
='ratelimit', metavar
='RATE',
893 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
894 downloader
.add_option(
896 dest
='throttledratelimit', metavar
='RATE',
897 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
898 downloader
.add_option(
900 dest
='retries', metavar
='RETRIES', default
=10,
901 help='Number of retries (default is %default), or "infinite"')
902 downloader
.add_option(
903 '--file-access-retries',
904 dest
='file_access_retries', metavar
='RETRIES', default
=3,
905 help='Number of times to retry on file access error (default is %default), or "infinite"')
906 downloader
.add_option(
907 '--fragment-retries',
908 dest
='fragment_retries', metavar
='RETRIES', default
=10,
909 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
910 downloader
.add_option(
912 dest
='retry_sleep', metavar
='[TYPE:]EXPR', default
={}, type='str',
913 action
='callback', callback
=_dict_from_options_callback
,
915 'allowed_keys': 'http|fragment|file_access|extractor',
916 'default_key': 'http',
918 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
919 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
920 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
921 'This option can be used multiple times to set the sleep for the different retry types, '
922 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
923 downloader
.add_option(
924 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
925 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
926 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
927 downloader
.add_option(
928 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
929 action
='store_false', dest
='skip_unavailable_fragments',
930 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
931 downloader
.add_option(
933 action
='store_true', dest
='keep_fragments', default
=False,
934 help='Keep downloaded fragments on disk after downloading is finished')
935 downloader
.add_option(
936 '--no-keep-fragments',
937 action
='store_false', dest
='keep_fragments',
938 help='Delete downloaded fragments after downloading is finished (default)')
939 downloader
.add_option(
941 dest
='buffersize', metavar
='SIZE', default
='1024',
942 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
943 downloader
.add_option(
945 action
='store_false', dest
='noresizebuffer',
946 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
947 downloader
.add_option(
948 '--no-resize-buffer',
949 action
='store_true', dest
='noresizebuffer', default
=False,
950 help='Do not automatically adjust the buffer size')
951 downloader
.add_option(
953 dest
='http_chunk_size', metavar
='SIZE', default
=None,
955 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
956 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
957 downloader
.add_option(
959 action
='store_true', dest
='test', default
=False,
960 help=optparse
.SUPPRESS_HELP
)
961 downloader
.add_option(
962 '--playlist-reverse',
963 action
='store_true', dest
='playlist_reverse',
964 help=optparse
.SUPPRESS_HELP
)
965 downloader
.add_option(
966 '--no-playlist-reverse',
967 action
='store_false', dest
='playlist_reverse',
968 help=optparse
.SUPPRESS_HELP
)
969 downloader
.add_option(
971 action
='store_true', dest
='playlist_random',
972 help='Download playlist videos in random order')
973 downloader
.add_option(
975 action
='store_true', dest
='lazy_playlist',
976 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
977 downloader
.add_option(
978 '--no-lazy-playlist',
979 action
='store_false', dest
='lazy_playlist',
980 help='Process videos in the playlist only after the entire playlist is parsed (default)')
981 downloader
.add_option(
982 '--xattr-set-filesize',
983 dest
='xattr_set_filesize', action
='store_true',
984 help='Set file xattribute ytdl.filesize with expected file size')
985 downloader
.add_option(
986 '--hls-prefer-native',
987 dest
='hls_prefer_native', action
='store_true', default
=None,
988 help=optparse
.SUPPRESS_HELP
)
989 downloader
.add_option(
990 '--hls-prefer-ffmpeg',
991 dest
='hls_prefer_native', action
='store_false', default
=None,
992 help=optparse
.SUPPRESS_HELP
)
993 downloader
.add_option(
995 dest
='hls_use_mpegts', action
='store_true', default
=None,
997 'Use the mpegts container for HLS videos; '
998 'allowing some players to play the video while downloading, '
999 'and reducing the chance of file corruption if download is interrupted. '
1000 'This is enabled by default for live streams'))
1001 downloader
.add_option(
1002 '--no-hls-use-mpegts',
1003 dest
='hls_use_mpegts', action
='store_false',
1005 'Do not use the mpegts container for HLS videos. '
1006 'This is default when not downloading live streams'))
1007 downloader
.add_option(
1008 '--download-sections',
1009 metavar
='REGEX', dest
='download_ranges', action
='append',
1011 'Download only chapters whose title matches the given regular expression. '
1012 'Time ranges prefixed by a "*" can also be used in place of chapters to download the specified range. '
1013 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1014 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1015 downloader
.add_option(
1016 '--downloader', '--external-downloader',
1017 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
1018 action
='callback', callback
=_dict_from_options_callback
,
1020 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1021 'default_key': 'default',
1022 'process': str.strip
1024 'Name or path of the external downloader to use (optionally) prefixed by '
1025 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1026 f
'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1027 'You can use this option multiple times to set different downloaders for different protocols. '
1028 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1029 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1030 '(Alias: --external-downloader)'))
1031 downloader
.add_option(
1032 '--downloader-args', '--external-downloader-args',
1033 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
1034 action
='callback', callback
=_dict_from_options_callback
,
1036 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(map(re
.escape
, list_external_downloaders())),
1037 'default_key': 'default',
1038 'process': shlex
.split
1040 'Give these arguments to the external downloader. '
1041 'Specify the downloader name and the arguments separated by a colon ":". '
1042 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1043 'You can use this option multiple times to give different arguments to different downloaders '
1044 '(Alias: --external-downloader-args)'))
1046 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
1047 workarounds
.add_option(
1049 dest
='encoding', metavar
='ENCODING',
1050 help='Force the specified encoding (experimental)')
1051 workarounds
.add_option(
1052 '--legacy-server-connect',
1053 action
='store_true', dest
='legacy_server_connect', default
=False,
1054 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1055 workarounds
.add_option(
1056 '--no-check-certificates',
1057 action
='store_true', dest
='no_check_certificate', default
=False,
1058 help='Suppress HTTPS certificate validation')
1059 workarounds
.add_option(
1060 '--prefer-insecure', '--prefer-unsecure',
1061 action
='store_true', dest
='prefer_insecure',
1062 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1063 workarounds
.add_option(
1065 metavar
='UA', dest
='user_agent',
1066 help=optparse
.SUPPRESS_HELP
)
1067 workarounds
.add_option(
1069 metavar
='URL', dest
='referer', default
=None,
1070 help=optparse
.SUPPRESS_HELP
)
1071 workarounds
.add_option(
1073 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
1074 action
='callback', callback
=_dict_from_options_callback
,
1075 callback_kwargs
={'multiple_keys': False}
,
1076 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1078 workarounds
.add_option(
1079 '--bidi-workaround',
1080 dest
='bidi_workaround', action
='store_true',
1081 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1082 workarounds
.add_option(
1083 '--sleep-requests', metavar
='SECONDS',
1084 dest
='sleep_interval_requests', type=float,
1085 help='Number of seconds to sleep between requests during data extraction')
1086 workarounds
.add_option(
1087 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
1088 dest
='sleep_interval', type=float,
1090 'Number of seconds to sleep before each download. '
1091 'This is the minimum time to sleep when used along with --max-sleep-interval '
1092 '(Alias: --min-sleep-interval)'))
1093 workarounds
.add_option(
1094 '--max-sleep-interval', metavar
='SECONDS',
1095 dest
='max_sleep_interval', type=float,
1096 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1097 workarounds
.add_option(
1098 '--sleep-subtitles', metavar
='SECONDS',
1099 dest
='sleep_interval_subtitles', default
=0, type=int,
1100 help='Number of seconds to sleep before each subtitle download')
1102 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
1103 verbosity
.add_option(
1105 action
='store_true', dest
='quiet', default
=None,
1106 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1107 verbosity
.add_option(
1109 action
='store_false', dest
='quiet',
1110 help='Deactivate quiet mode. (Default)')
1111 verbosity
.add_option(
1113 dest
='no_warnings', action
='store_true', default
=False,
1114 help='Ignore warnings')
1115 verbosity
.add_option(
1117 action
='store_true', dest
='simulate', default
=None,
1118 help='Do not download the video and do not write anything to disk')
1119 verbosity
.add_option(
1121 action
='store_false', dest
='simulate',
1122 help='Download the video even if printing/listing options are used')
1123 verbosity
.add_option(
1124 '--ignore-no-formats-error',
1125 action
='store_true', dest
='ignore_no_formats_error', default
=False,
1127 'Ignore "No video formats" error. Useful for extracting metadata '
1128 'even if the videos are not actually available for download (experimental)'))
1129 verbosity
.add_option(
1130 '--no-ignore-no-formats-error',
1131 action
='store_false', dest
='ignore_no_formats_error',
1132 help='Throw error when no downloadable video formats are found (default)')
1133 verbosity
.add_option(
1134 '--skip-download', '--no-download',
1135 action
='store_true', dest
='skip_download', default
=False,
1136 help='Do not download the video but write all related files (Alias: --no-download)')
1137 verbosity
.add_option(
1139 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', **when_prefix('video'),
1141 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1142 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1143 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1144 'This option can be used multiple times'))
1145 verbosity
.add_option(
1147 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', nargs
=2, **when_prefix('video'),
1149 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1150 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1151 verbosity
.add_option(
1153 action
='store_true', dest
='geturl', default
=False,
1154 help=optparse
.SUPPRESS_HELP
)
1155 verbosity
.add_option(
1156 '-e', '--get-title',
1157 action
='store_true', dest
='gettitle', default
=False,
1158 help=optparse
.SUPPRESS_HELP
)
1159 verbosity
.add_option(
1161 action
='store_true', dest
='getid', default
=False,
1162 help=optparse
.SUPPRESS_HELP
)
1163 verbosity
.add_option(
1165 action
='store_true', dest
='getthumbnail', default
=False,
1166 help=optparse
.SUPPRESS_HELP
)
1167 verbosity
.add_option(
1168 '--get-description',
1169 action
='store_true', dest
='getdescription', default
=False,
1170 help=optparse
.SUPPRESS_HELP
)
1171 verbosity
.add_option(
1173 action
='store_true', dest
='getduration', default
=False,
1174 help=optparse
.SUPPRESS_HELP
)
1175 verbosity
.add_option(
1177 action
='store_true', dest
='getfilename', default
=False,
1178 help=optparse
.SUPPRESS_HELP
)
1179 verbosity
.add_option(
1181 action
='store_true', dest
='getformat', default
=False,
1182 help=optparse
.SUPPRESS_HELP
)
1183 verbosity
.add_option(
1184 '-j', '--dump-json',
1185 action
='store_true', dest
='dumpjson', default
=False,
1186 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
1187 verbosity
.add_option(
1188 '-J', '--dump-single-json',
1189 action
='store_true', dest
='dump_single_json', default
=False,
1191 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1192 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1193 verbosity
.add_option(
1195 action
='store_true', dest
='print_json', default
=False,
1196 help=optparse
.SUPPRESS_HELP
)
1197 verbosity
.add_option(
1198 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1199 action
='store_true', dest
='force_write_download_archive', default
=False,
1201 'Force download archive entries to be written as far as no errors occur, '
1202 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1203 verbosity
.add_option(
1205 action
='store_true', dest
='progress_with_newline', default
=False,
1206 help='Output progress bar as new lines')
1207 verbosity
.add_option(
1209 action
='store_true', dest
='noprogress', default
=None,
1210 help='Do not print progress bar')
1211 verbosity
.add_option(
1213 action
='store_false', dest
='noprogress',
1214 help='Show progress bar, even if in quiet mode')
1215 verbosity
.add_option(
1217 action
='store_true', dest
='consoletitle', default
=False,
1218 help='Display progress in console titlebar')
1219 verbosity
.add_option(
1220 '--progress-template',
1221 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1222 action
='callback', callback
=_dict_from_options_callback
,
1224 'allowed_keys': '(download|postprocess)(-title)?',
1225 'default_key': 'download'
1227 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1228 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1229 'The video\'s fields are accessible under the "info" key and '
1230 'the progress attributes are accessible under "progress" key. E.g. '
1231 # TODO: Document the fields inside "progress"
1232 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1233 verbosity
.add_option(
1235 action
='store_true', dest
='verbose', default
=False,
1236 help='Print various debugging information')
1237 verbosity
.add_option(
1238 '--dump-pages', '--dump-intermediate-pages',
1239 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1240 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1241 verbosity
.add_option(
1243 action
='store_true', dest
='write_pages', default
=False,
1244 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1245 verbosity
.add_option(
1247 action
='store_true', dest
='load_pages', default
=False,
1248 help=optparse
.SUPPRESS_HELP
)
1249 verbosity
.add_option(
1250 '--youtube-print-sig-code',
1251 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1252 help=optparse
.SUPPRESS_HELP
)
1253 verbosity
.add_option(
1254 '--print-traffic', '--dump-headers',
1255 dest
='debug_printtraffic', action
='store_true', default
=False,
1256 help='Display sent and read HTTP traffic')
1257 verbosity
.add_option(
1258 '-C', '--call-home',
1259 dest
='call_home', action
='store_true', default
=False,
1260 # help='Contact the yt-dlp server for debugging')
1261 help=optparse
.SUPPRESS_HELP
)
1262 verbosity
.add_option(
1264 dest
='call_home', action
='store_false',
1265 # help='Do not contact the yt-dlp server for debugging (default)')
1266 help=optparse
.SUPPRESS_HELP
)
1268 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1269 filesystem
.add_option(
1270 '-a', '--batch-file',
1271 dest
='batchfile', metavar
='FILE',
1273 'File containing URLs to download ("-" for stdin), one URL per line. '
1274 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1275 filesystem
.add_option(
1277 dest
='batchfile', action
='store_const', const
=None,
1278 help='Do not read URLs from batch file (default)')
1279 filesystem
.add_option(
1280 '--id', default
=False,
1281 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1282 filesystem
.add_option(
1284 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1285 action
='callback', callback
=_dict_from_options_callback
,
1287 'allowed_keys': 'home|temp|%s' % '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1288 'default_key': 'home'
1290 'The paths where the files should be downloaded. '
1291 'Specify the type of file and the path separated by a colon ":". '
1292 'All the same TYPES as --output are supported. '
1293 'Additionally, you can also provide "home" (default) and "temp" paths. '
1294 'All intermediary files are first downloaded to the temp path and '
1295 'then the final files are moved over to the home path after download is finished. '
1296 'This option is ignored if --output is an absolute path'))
1297 filesystem
.add_option(
1299 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1300 action
='callback', callback
=_dict_from_options_callback
,
1302 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1303 'default_key': 'default'
1304 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1305 filesystem
.add_option(
1306 '--output-na-placeholder',
1307 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1308 help=('Placeholder for unavailable fields in "OUTPUT TEMPLATE" (default: "%default")'))
1309 filesystem
.add_option(
1310 '--autonumber-size',
1311 dest
='autonumber_size', metavar
='NUMBER', type=int,
1312 help=optparse
.SUPPRESS_HELP
)
1313 filesystem
.add_option(
1314 '--autonumber-start',
1315 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1316 help=optparse
.SUPPRESS_HELP
)
1317 filesystem
.add_option(
1318 '--restrict-filenames',
1319 action
='store_true', dest
='restrictfilenames', default
=False,
1320 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1321 filesystem
.add_option(
1322 '--no-restrict-filenames',
1323 action
='store_false', dest
='restrictfilenames',
1324 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1325 filesystem
.add_option(
1326 '--windows-filenames',
1327 action
='store_true', dest
='windowsfilenames', default
=False,
1328 help='Force filenames to be Windows-compatible')
1329 filesystem
.add_option(
1330 '--no-windows-filenames',
1331 action
='store_false', dest
='windowsfilenames',
1332 help='Make filenames Windows-compatible only if using Windows (default)')
1333 filesystem
.add_option(
1334 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1335 dest
='trim_file_name', default
=0, type=int,
1336 help='Limit the filename length (excluding extension) to the specified number of characters')
1337 filesystem
.add_option(
1338 '-w', '--no-overwrites',
1339 action
='store_false', dest
='overwrites', default
=None,
1340 help='Do not overwrite any files')
1341 filesystem
.add_option(
1342 '--force-overwrites', '--yes-overwrites',
1343 action
='store_true', dest
='overwrites',
1344 help='Overwrite all video and metadata files. This option includes --no-continue')
1345 filesystem
.add_option(
1346 '--no-force-overwrites',
1347 action
='store_const', dest
='overwrites', const
=None,
1348 help='Do not overwrite the video, but overwrite related files (default)')
1349 filesystem
.add_option(
1351 action
='store_true', dest
='continue_dl', default
=True,
1352 help='Resume partially downloaded files/fragments (default)')
1353 filesystem
.add_option(
1355 action
='store_false', dest
='continue_dl',
1357 'Do not resume partially downloaded fragments. '
1358 'If the file is not fragmented, restart download of the entire file'))
1359 filesystem
.add_option(
1361 action
='store_false', dest
='nopart', default
=False,
1362 help='Use .part files instead of writing directly into output file (default)')
1363 filesystem
.add_option(
1365 action
='store_true', dest
='nopart',
1366 help='Do not use .part files - write directly into output file')
1367 filesystem
.add_option(
1369 action
='store_true', dest
='updatetime', default
=True,
1370 help='Use the Last-modified header to set the file modification time (default)')
1371 filesystem
.add_option(
1373 action
='store_false', dest
='updatetime',
1374 help='Do not use the Last-modified header to set the file modification time')
1375 filesystem
.add_option(
1376 '--write-description',
1377 action
='store_true', dest
='writedescription', default
=False,
1378 help='Write video description to a .description file')
1379 filesystem
.add_option(
1380 '--no-write-description',
1381 action
='store_false', dest
='writedescription',
1382 help='Do not write video description (default)')
1383 filesystem
.add_option(
1384 '--write-info-json',
1385 action
='store_true', dest
='writeinfojson', default
=None,
1386 help='Write video metadata to a .info.json file (this may contain personal information)')
1387 filesystem
.add_option(
1388 '--no-write-info-json',
1389 action
='store_false', dest
='writeinfojson',
1390 help='Do not write video metadata (default)')
1391 filesystem
.add_option(
1392 '--write-annotations',
1393 action
='store_true', dest
='writeannotations', default
=False,
1394 help=optparse
.SUPPRESS_HELP
)
1395 filesystem
.add_option(
1396 '--no-write-annotations',
1397 action
='store_false', dest
='writeannotations',
1398 help=optparse
.SUPPRESS_HELP
)
1399 filesystem
.add_option(
1400 '--write-playlist-metafiles',
1401 action
='store_true', dest
='allow_playlist_files', default
=None,
1403 'Write playlist metadata in addition to the video metadata '
1404 'when using --write-info-json, --write-description etc. (default)'))
1405 filesystem
.add_option(
1406 '--no-write-playlist-metafiles',
1407 action
='store_false', dest
='allow_playlist_files',
1408 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1409 filesystem
.add_option(
1410 '--clean-info-json', '--clean-infojson',
1411 action
='store_true', dest
='clean_infojson', default
=None,
1413 'Remove some private fields such as filenames from the infojson. '
1414 'Note that it could still contain some personal information (default)'))
1415 filesystem
.add_option(
1416 '--no-clean-info-json', '--no-clean-infojson',
1417 action
='store_false', dest
='clean_infojson',
1418 help='Write all fields to the infojson')
1419 filesystem
.add_option(
1420 '--write-comments', '--get-comments',
1421 action
='store_true', dest
='getcomments', default
=False,
1423 'Retrieve video comments to be placed in the infojson. '
1424 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1425 filesystem
.add_option(
1426 '--no-write-comments', '--no-get-comments',
1427 action
='store_false', dest
='getcomments',
1428 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1429 filesystem
.add_option(
1430 '--load-info-json', '--load-info',
1431 dest
='load_info_filename', metavar
='FILE',
1432 help='JSON file containing the video information (created with the "--write-info-json" option)')
1433 filesystem
.add_option(
1435 dest
='cookiefile', metavar
='FILE',
1436 help='Netscape formatted file to read cookies from and dump cookie jar in')
1437 filesystem
.add_option(
1439 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1440 help='Do not read/dump cookies from/to file (default)')
1441 filesystem
.add_option(
1442 '--cookies-from-browser',
1443 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1445 'The name of the browser to load cookies from. '
1446 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1447 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1448 'the name/path of the PROFILE to load cookies from, '
1449 'and the CONTAINER name (if Firefox) ("none" for no container) '
1450 'can be given with their respective seperators. '
1451 'By default, all containers of the most recently accessed profile are used. '
1452 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1453 filesystem
.add_option(
1454 '--no-cookies-from-browser',
1455 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1456 help='Do not load cookies from browser (default)')
1457 filesystem
.add_option(
1458 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1460 'Location in the filesystem where yt-dlp can store some downloaded information '
1461 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1462 filesystem
.add_option(
1463 '--no-cache-dir', action
='store_false', dest
='cachedir',
1464 help='Disable filesystem caching')
1465 filesystem
.add_option(
1467 action
='store_true', dest
='rm_cachedir',
1468 help='Delete all filesystem cache files')
1470 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1471 thumbnail
.add_option(
1472 '--write-thumbnail',
1473 action
='callback', dest
='writethumbnail', default
=False,
1474 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1475 callback
=lambda option
, _
, __
, parser
: setattr(
1476 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1477 help='Write thumbnail image to disk')
1478 thumbnail
.add_option(
1479 '--no-write-thumbnail',
1480 action
='store_false', dest
='writethumbnail',
1481 help='Do not write thumbnail image to disk (default)')
1482 thumbnail
.add_option(
1483 '--write-all-thumbnails',
1484 action
='store_const', dest
='writethumbnail', const
='all',
1485 help='Write all thumbnail image formats to disk')
1486 thumbnail
.add_option(
1487 '--list-thumbnails',
1488 action
='store_true', dest
='list_thumbnails', default
=False,
1489 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1491 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1494 action
='store_true', dest
='writelink', default
=False,
1495 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1498 action
='store_true', dest
='writeurllink', default
=False,
1499 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1501 '--write-webloc-link',
1502 action
='store_true', dest
='writewebloclink', default
=False,
1503 help='Write a .webloc macOS internet shortcut')
1505 '--write-desktop-link',
1506 action
='store_true', dest
='writedesktoplink', default
=False,
1507 help='Write a .desktop Linux internet shortcut')
1509 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1510 postproc
.add_option(
1511 '-x', '--extract-audio',
1512 action
='store_true', dest
='extractaudio', default
=False,
1513 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1514 postproc
.add_option(
1515 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1517 'Format to convert the audio to when -x is used. '
1518 f
'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1519 'You can specify multiple rules using similar syntax as --remux-video'))
1520 postproc
.add_option(
1521 '--audio-quality', metavar
='QUALITY',
1522 dest
='audioquality', default
='5',
1524 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1525 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1526 postproc
.add_option(
1528 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1530 'Remux the video into another container if necessary '
1531 f
'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1532 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1533 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1534 postproc
.add_option(
1536 metavar
='FORMAT', dest
='recodevideo', default
=None,
1537 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1538 postproc
.add_option(
1539 '--postprocessor-args', '--ppa',
1540 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1541 action
='callback', callback
=_dict_from_options_callback
,
1543 'allowed_keys': r
'\w+(?:\+\w+)?',
1544 'default_key': 'default-compat',
1545 'process': shlex
.split
,
1546 'multiple_keys': False
1548 'Give these arguments to the postprocessors. '
1549 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1550 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1551 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1552 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1553 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1554 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1555 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1556 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1557 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1558 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1559 'You can use this option multiple times to give different arguments to different '
1560 'postprocessors. (Alias: --ppa)'))
1561 postproc
.add_option(
1562 '-k', '--keep-video',
1563 action
='store_true', dest
='keepvideo', default
=False,
1564 help='Keep the intermediate video file on disk after post-processing')
1565 postproc
.add_option(
1567 action
='store_false', dest
='keepvideo',
1568 help='Delete the intermediate video file after post-processing (default)')
1569 postproc
.add_option(
1570 '--post-overwrites',
1571 action
='store_false', dest
='nopostoverwrites',
1572 help='Overwrite post-processed files (default)')
1573 postproc
.add_option(
1574 '--no-post-overwrites',
1575 action
='store_true', dest
='nopostoverwrites', default
=False,
1576 help='Do not overwrite post-processed files')
1577 postproc
.add_option(
1579 action
='store_true', dest
='embedsubtitles', default
=False,
1580 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1581 postproc
.add_option(
1583 action
='store_false', dest
='embedsubtitles',
1584 help='Do not embed subtitles (default)')
1585 postproc
.add_option(
1586 '--embed-thumbnail',
1587 action
='store_true', dest
='embedthumbnail', default
=False,
1588 help='Embed thumbnail in the video as cover art')
1589 postproc
.add_option(
1590 '--no-embed-thumbnail',
1591 action
='store_false', dest
='embedthumbnail',
1592 help='Do not embed thumbnail (default)')
1593 postproc
.add_option(
1594 '--embed-metadata', '--add-metadata',
1595 action
='store_true', dest
='addmetadata', default
=False,
1597 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1598 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1599 postproc
.add_option(
1600 '--no-embed-metadata', '--no-add-metadata',
1601 action
='store_false', dest
='addmetadata',
1602 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1603 postproc
.add_option(
1604 '--embed-chapters', '--add-chapters',
1605 action
='store_true', dest
='addchapters', default
=None,
1606 help='Add chapter markers to the video file (Alias: --add-chapters)')
1607 postproc
.add_option(
1608 '--no-embed-chapters', '--no-add-chapters',
1609 action
='store_false', dest
='addchapters',
1610 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1611 postproc
.add_option(
1612 '--embed-info-json',
1613 action
='store_true', dest
='embed_infojson', default
=None,
1614 help='Embed the infojson as an attachment to mkv/mka video files')
1615 postproc
.add_option(
1616 '--no-embed-info-json',
1617 action
='store_false', dest
='embed_infojson',
1618 help='Do not embed the infojson as an attachment to the video file')
1619 postproc
.add_option(
1620 '--metadata-from-title',
1621 metavar
='FORMAT', dest
='metafromtitle',
1622 help=optparse
.SUPPRESS_HELP
)
1623 postproc
.add_option(
1625 metavar
='[WHEN:]FROM:TO', dest
='parse_metadata', **when_prefix('pre_process'),
1627 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1628 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1629 postproc
.add_option(
1630 '--replace-in-metadata',
1631 dest
='parse_metadata', metavar
='[WHEN:]FIELDS REGEX REPLACE', nargs
=3, **when_prefix('pre_process'),
1633 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1634 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1635 postproc
.add_option(
1636 '--xattrs', '--xattr',
1637 action
='store_true', dest
='xattrs', default
=False,
1638 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1639 postproc
.add_option(
1640 '--concat-playlist',
1641 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1642 choices
=('never', 'always', 'multi_video'),
1644 'Concatenate videos in a playlist. One of "never", "always", or '
1645 '"multi_video" (default; only when the videos form a single show). '
1646 'All the video files must have same codecs and number of streams to be concatable. '
1647 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1648 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1649 postproc
.add_option(
1651 metavar
='POLICY', dest
='fixup', default
=None,
1652 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1654 'Automatically correct known faults of the file. '
1655 'One of never (do nothing), warn (only emit a warning), '
1656 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1657 'force (try fixing even if file already exists)'))
1658 postproc
.add_option(
1659 '--prefer-avconv', '--no-prefer-ffmpeg',
1660 action
='store_false', dest
='prefer_ffmpeg',
1661 help=optparse
.SUPPRESS_HELP
)
1662 postproc
.add_option(
1663 '--prefer-ffmpeg', '--no-prefer-avconv',
1664 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1665 help=optparse
.SUPPRESS_HELP
)
1666 postproc
.add_option(
1667 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1668 dest
='ffmpeg_location',
1669 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1670 postproc
.add_option(
1672 metavar
='[WHEN:]CMD', dest
='exec_cmd', **when_prefix('after_move'),
1674 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1675 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1676 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1677 'After download, an additional field "filepath" that contains the final path of the downloaded file '
1678 'is also available, and if no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1679 'This option can be used multiple times'))
1680 postproc
.add_option(
1682 action
='store_const', dest
='exec_cmd', const
={},
1683 help='Remove any previously defined --exec')
1684 postproc
.add_option(
1685 '--exec-before-download', metavar
='CMD',
1686 action
='append', dest
='exec_before_dl_cmd',
1687 help=optparse
.SUPPRESS_HELP
)
1688 postproc
.add_option(
1689 '--no-exec-before-download',
1690 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1691 help=optparse
.SUPPRESS_HELP
)
1692 postproc
.add_option(
1693 '--convert-subs', '--convert-sub', '--convert-subtitles',
1694 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1696 'Convert the subtitles to another format (currently supported: %s) '
1697 '(Alias: --convert-subtitles)' % ', '.join(sorted(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
))))
1698 postproc
.add_option(
1699 '--convert-thumbnails',
1700 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1702 'Convert the thumbnails to another format '
1703 f
'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1704 'You can specify multiple rules using similar syntax as --remux-video'))
1705 postproc
.add_option(
1706 '--split-chapters', '--split-tracks',
1707 dest
='split_chapters', action
='store_true', default
=False,
1709 'Split video into multiple files based on internal chapters. '
1710 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1711 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1712 postproc
.add_option(
1713 '--no-split-chapters', '--no-split-tracks',
1714 dest
='split_chapters', action
='store_false',
1715 help='Do not split video based on chapters (default)')
1716 postproc
.add_option(
1717 '--remove-chapters',
1718 metavar
='REGEX', dest
='remove_chapters', action
='append',
1720 'Remove chapters whose title matches the given regular expression. '
1721 'The syntax is the same as --download-sections. This option can be used multiple times'))
1722 postproc
.add_option(
1723 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1724 help='Do not remove any chapters from the file (default)')
1725 postproc
.add_option(
1726 '--force-keyframes-at-cuts',
1727 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1729 'Force keyframes at cuts when downloading/splitting/removing sections. '
1730 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1731 postproc
.add_option(
1732 '--no-force-keyframes-at-cuts',
1733 action
='store_false', dest
='force_keyframes_at_cuts',
1734 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1735 _postprocessor_opts_parser
= lambda key
, val
='': (
1736 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1737 ('key', remove_end(key
, 'PP')))
1738 postproc
.add_option(
1739 '--use-postprocessor',
1740 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1741 action
='callback', callback
=_list_from_options_callback
,
1744 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1746 'The (case sensitive) name of plugin postprocessors to be enabled, '
1747 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1748 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1749 'The "when" argument determines when the postprocessor is invoked. '
1750 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1751 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1752 '"post_process" (after each video download; default), '
1753 '"after_move" (after moving video file to it\'s final locations), '
1754 '"after_video" (after downloading and processing all formats of a video), '
1755 'or "playlist" (at end of playlist). '
1756 'This option can be used multiple times to add different postprocessors'))
1758 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1759 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1760 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1761 sponsorblock
.add_option(
1762 '--sponsorblock-mark', metavar
='CATS',
1763 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1764 callback
=_set_from_options_callback
, callback_kwargs
={
1765 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1766 'aliases': {'default': ['all']}
1768 'SponsorBlock categories to create chapters for, separated by commas. '
1769 f
'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1770 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
1771 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1772 sponsorblock
.add_option(
1773 '--sponsorblock-remove', metavar
='CATS',
1774 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1775 callback
=_set_from_options_callback
, callback_kwargs
={
1776 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.NON_SKIPPABLE_CATEGORIES
.keys()),
1777 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1778 # The filler category is very aggressive.
1779 # It is strongly recommended to not use this in a client by default.
1780 'aliases': {'default': ['all', '-filler']}
1782 'SponsorBlock categories to be removed from the video file, separated by commas. '
1783 'If a category is present in both mark and remove, remove takes precedence. '
1784 'The syntax and available categories are the same as for --sponsorblock-mark '
1785 'except that "default" refers to "all,-filler" '
1786 f
'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1787 sponsorblock
.add_option(
1788 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1789 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1791 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1792 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1793 'Defaults to "%default"'))
1794 sponsorblock
.add_option(
1795 '--no-sponsorblock', default
=False,
1796 action
='store_true', dest
='no_sponsorblock',
1797 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1798 sponsorblock
.add_option(
1799 '--sponsorblock-api', metavar
='URL',
1800 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1801 help='SponsorBlock API location, defaults to %default')
1803 sponsorblock
.add_option(
1805 action
='store_true', dest
='sponskrub', default
=False,
1806 help=optparse
.SUPPRESS_HELP
)
1807 sponsorblock
.add_option(
1809 action
='store_false', dest
='sponskrub',
1810 help=optparse
.SUPPRESS_HELP
)
1811 sponsorblock
.add_option(
1812 '--sponskrub-cut', default
=False,
1813 action
='store_true', dest
='sponskrub_cut',
1814 help=optparse
.SUPPRESS_HELP
)
1815 sponsorblock
.add_option(
1816 '--no-sponskrub-cut',
1817 action
='store_false', dest
='sponskrub_cut',
1818 help=optparse
.SUPPRESS_HELP
)
1819 sponsorblock
.add_option(
1820 '--sponskrub-force', default
=False,
1821 action
='store_true', dest
='sponskrub_force',
1822 help=optparse
.SUPPRESS_HELP
)
1823 sponsorblock
.add_option(
1824 '--no-sponskrub-force',
1825 action
='store_true', dest
='sponskrub_force',
1826 help=optparse
.SUPPRESS_HELP
)
1827 sponsorblock
.add_option(
1828 '--sponskrub-location', metavar
='PATH',
1829 dest
='sponskrub_path', default
='',
1830 help=optparse
.SUPPRESS_HELP
)
1831 sponsorblock
.add_option(
1832 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1833 help=optparse
.SUPPRESS_HELP
)
1835 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1836 extractor
.add_option(
1837 '--extractor-retries',
1838 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1839 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1840 extractor
.add_option(
1841 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1842 action
='store_true', dest
='dynamic_mpd', default
=True,
1843 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1844 extractor
.add_option(
1845 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1846 action
='store_false', dest
='dynamic_mpd',
1847 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1848 extractor
.add_option(
1849 '--hls-split-discontinuity',
1850 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1851 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1853 extractor
.add_option(
1854 '--no-hls-split-discontinuity',
1855 dest
='hls_split_discontinuity', action
='store_false',
1856 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1857 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1858 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1859 extractor
.add_option(
1861 metavar
='IE_KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1862 action
='callback', callback
=_dict_from_options_callback
,
1864 'multiple_keys': False,
1865 'process': lambda val
: dict(
1866 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1868 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1869 'You can use this option multiple times to give arguments for different extractors'))
1870 extractor
.add_option(
1871 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1872 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1873 help=optparse
.SUPPRESS_HELP
)
1874 extractor
.add_option(
1875 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1876 action
='store_false', dest
='youtube_include_dash_manifest',
1877 help=optparse
.SUPPRESS_HELP
)
1878 extractor
.add_option(
1879 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1880 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1881 help=optparse
.SUPPRESS_HELP
)
1882 extractor
.add_option(
1883 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1884 action
='store_false', dest
='youtube_include_hls_manifest',
1885 help=optparse
.SUPPRESS_HELP
)
1887 parser
.add_option_group(general
)
1888 parser
.add_option_group(network
)
1889 parser
.add_option_group(geo
)
1890 parser
.add_option_group(selection
)
1891 parser
.add_option_group(downloader
)
1892 parser
.add_option_group(filesystem
)
1893 parser
.add_option_group(thumbnail
)
1894 parser
.add_option_group(link
)
1895 parser
.add_option_group(verbosity
)
1896 parser
.add_option_group(workarounds
)
1897 parser
.add_option_group(video_format
)
1898 parser
.add_option_group(subtitles
)
1899 parser
.add_option_group(authentication
)
1900 parser
.add_option_group(postproc
)
1901 parser
.add_option_group(sponsorblock
)
1902 parser
.add_option_group(extractor
)
1907 def _hide_login_info(opts
):
1908 deprecation_warning(f
'"{__name__}._hide_login_info" is deprecated and may be removed '
1909 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1910 return Config
.hide_login_info(opts
)