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', 'playlist-match-filter',
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',
474 'prefer-legacy-http-handler', 'manifest-filesize-approx'
476 'youtube-dl': ['all', '-multistreams', '-playlist-match-filter', '-manifest-filesize-approx'],
477 'youtube-dlc': ['all', '-no-youtube-channel-redirect', '-no-live-chat', '-playlist-match-filter', '-manifest-filesize-approx'],
478 '2021': ['2022', 'no-certifi', 'filename-sanitization', 'no-youtube-prefer-utc-upload-date'],
479 '2022': ['2023', 'no-external-downloader-progress', 'playlist-match-filter'],
480 '2023': ['prefer-legacy-http-handler', 'manifest-filesize-approx'],
483 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
484 'configurations by reverting some of the changes made in yt-dlp. '
485 'See "Differences in default behavior" for details'))
487 '--alias', metavar
='ALIASES OPTIONS', dest
='_', type='str', nargs
=2,
488 action
='callback', callback
=_create_alias
,
490 'Create aliases for an option string. Unless an alias starts with a dash "-", it is prefixed with "--". '
491 'Arguments are parsed according to the Python string formatting mini-language. '
492 'E.g. --alias get-audio,-X "-S=aext:{0},abr -x --audio-format {0}" creates options '
493 '"--get-audio" and "-X" that takes an argument (ARG0) and expands to '
494 '"-S=aext:ARG0,abr -x --audio-format ARG0". All defined aliases are listed in the --help output. '
495 'Alias options can trigger more aliases; so be careful to avoid defining recursive options. '
496 f
'As a safety measure, each alias may be triggered a maximum of {_YoutubeDLOptionParser.ALIAS_TRIGGER_LIMIT} times. '
497 'This option can be used multiple times'))
499 network
= optparse
.OptionGroup(parser
, 'Network Options')
501 '--proxy', dest
='proxy',
502 default
=None, metavar
='URL',
504 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable SOCKS proxy, specify a proper scheme, '
505 'e.g. socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy "") for direct connection'))
508 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
509 help='Time to wait before giving up, in seconds')
512 metavar
='IP', dest
='source_address', default
=None,
513 help='Client-side IP address to bind to',
516 '-4', '--force-ipv4',
517 action
='store_const', const
='0.0.0.0', dest
='source_address',
518 help='Make all connections via IPv4',
521 '-6', '--force-ipv6',
522 action
='store_const', const
='::', dest
='source_address',
523 help='Make all connections via IPv6',
526 '--enable-file-urls', action
='store_true',
527 dest
='enable_file_urls', default
=False,
528 help='Enable file:// URLs. This is disabled by default for security reasons.'
531 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
533 '--geo-verification-proxy',
534 dest
='geo_verification_proxy', default
=None, metavar
='URL',
536 'Use this proxy to verify the IP address for some geo-restricted sites. '
537 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
539 '--cn-verification-proxy',
540 dest
='cn_verification_proxy', default
=None, metavar
='URL',
541 help=optparse
.SUPPRESS_HELP
)
543 '--xff', metavar
='VALUE',
544 dest
='geo_bypass', default
='default',
546 'How to fake X-Forwarded-For HTTP header to try bypassing geographic restriction. '
547 'One of "default" (only when known to be useful), "never", '
548 'an IP block in CIDR notation, or a two-letter ISO 3166-2 country code'))
551 action
='store_const', dest
='geo_bypass', const
='default',
552 help=optparse
.SUPPRESS_HELP
)
555 action
='store_const', dest
='geo_bypass', const
='never',
556 help=optparse
.SUPPRESS_HELP
)
558 '--geo-bypass-country', metavar
='CODE', dest
='geo_bypass',
559 help=optparse
.SUPPRESS_HELP
)
561 '--geo-bypass-ip-block', metavar
='IP_BLOCK', dest
='geo_bypass',
562 help=optparse
.SUPPRESS_HELP
)
564 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
565 selection
.add_option(
567 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
568 help=optparse
.SUPPRESS_HELP
)
569 selection
.add_option(
571 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
572 help=optparse
.SUPPRESS_HELP
)
573 selection
.add_option(
574 '-I', '--playlist-items',
575 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
577 'Comma separated playlist_index of the items to download. '
578 'You can specify a range using "[START]:[STOP][:STEP]". For backward compatibility, START-STOP is also supported. '
579 'Use negative indices to count from the right and negative STEP to download in reverse order. '
580 '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'))
581 selection
.add_option(
583 dest
='matchtitle', metavar
='REGEX',
584 help=optparse
.SUPPRESS_HELP
)
585 selection
.add_option(
587 dest
='rejecttitle', metavar
='REGEX',
588 help=optparse
.SUPPRESS_HELP
)
589 selection
.add_option(
591 metavar
='SIZE', dest
='min_filesize', default
=None,
592 help='Abort download if filesize is smaller than SIZE, e.g. 50k or 44.6M')
593 selection
.add_option(
595 metavar
='SIZE', dest
='max_filesize', default
=None,
596 help='Abort download if filesize is larger than SIZE, e.g. 50k or 44.6M')
597 selection
.add_option(
599 metavar
='DATE', dest
='date', default
=None,
601 'Download only videos uploaded on this date. '
602 'The date can be "YYYYMMDD" or in the format [now|today|yesterday][-N[day|week|month|year]]. '
603 'E.g. "--date today-2weeks" downloads only videos uploaded on the same day two weeks ago'))
604 selection
.add_option(
606 metavar
='DATE', dest
='datebefore', default
=None,
608 'Download only videos uploaded on or before this date. '
609 'The date formats accepted is the same as --date'))
610 selection
.add_option(
612 metavar
='DATE', dest
='dateafter', default
=None,
614 'Download only videos uploaded on or after this date. '
615 'The date formats accepted is the same as --date'))
616 selection
.add_option(
618 metavar
='COUNT', dest
='min_views', default
=None, type=int,
619 help=optparse
.SUPPRESS_HELP
)
620 selection
.add_option(
622 metavar
='COUNT', dest
='max_views', default
=None, type=int,
623 help=optparse
.SUPPRESS_HELP
)
624 selection
.add_option(
626 metavar
='FILTER', dest
='match_filter', action
='append',
628 'Generic video filter. Any "OUTPUT TEMPLATE" field can be compared with a '
629 'number or a string using the operators defined in "Filtering Formats". '
630 'You can also simply specify a field to match if the field is present, '
631 'use "!field" to check if the field is not present, and "&" to check multiple conditions. '
632 'Use a "\\" to escape "&" or quotes if needed. If used multiple times, '
633 'the filter matches if atleast one of the conditions are met. E.g. --match-filter '
634 '!is_live --match-filter "like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
635 'matches only videos that are not live OR those that have a like count more than 100 '
636 '(or the like field is not available) and also has a description '
637 'that contains the phrase "cats & dogs" (caseless). '
638 'Use "--match-filter -" to interactively ask whether to download each video'))
639 selection
.add_option(
640 '--no-match-filters',
641 dest
='match_filter', action
='store_const', const
=None,
642 help='Do not use any --match-filter (default)')
643 selection
.add_option(
644 '--break-match-filters',
645 metavar
='FILTER', dest
='breaking_match_filter', action
='append',
646 help='Same as "--match-filters" but stops the download process when a video is rejected')
647 selection
.add_option(
648 '--no-break-match-filters',
649 dest
='breaking_match_filter', action
='store_const', const
=None,
650 help='Do not use any --break-match-filters (default)')
651 selection
.add_option(
653 action
='store_true', dest
='noplaylist', default
=False,
654 help='Download only the video, if the URL refers to a video and a playlist')
655 selection
.add_option(
657 action
='store_false', dest
='noplaylist',
658 help='Download the playlist, if the URL refers to a video and a playlist')
659 selection
.add_option(
661 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
662 help='Download only videos suitable for the given age')
663 selection
.add_option(
664 '--download-archive', metavar
='FILE',
665 dest
='download_archive',
666 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
667 selection
.add_option(
668 '--no-download-archive',
669 dest
='download_archive', action
="store_const", const
=None,
670 help='Do not use archive file (default)')
671 selection
.add_option(
673 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
674 help='Abort after downloading NUMBER files')
675 selection
.add_option(
676 '--break-on-existing',
677 action
='store_true', dest
='break_on_existing', default
=False,
678 help='Stop the download process when encountering a file that is in the archive')
679 selection
.add_option(
681 action
='store_true', dest
='break_on_reject', default
=False,
682 help=optparse
.SUPPRESS_HELP
)
683 selection
.add_option(
685 action
='store_true', dest
='break_per_url', default
=False,
686 help='Alters --max-downloads, --break-on-existing, --break-match-filter, and autonumber to reset per input URL')
687 selection
.add_option(
688 '--no-break-per-input',
689 action
='store_false', dest
='break_per_url',
690 help='--break-on-existing and similar options terminates the entire download queue')
691 selection
.add_option(
692 '--skip-playlist-after-errors', metavar
='N',
693 dest
='skip_playlist_after_errors', default
=None, type=int,
694 help='Number of allowed failures until the rest of the playlist is skipped')
695 selection
.add_option(
697 dest
='include_ads', action
='store_true',
698 help=optparse
.SUPPRESS_HELP
)
699 selection
.add_option(
701 dest
='include_ads', action
='store_false',
702 help=optparse
.SUPPRESS_HELP
)
704 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
705 authentication
.add_option(
707 dest
='username', metavar
='USERNAME',
708 help='Login with this account ID')
709 authentication
.add_option(
711 dest
='password', metavar
='PASSWORD',
712 help='Account password. If this option is left out, yt-dlp will ask interactively')
713 authentication
.add_option(
715 dest
='twofactor', metavar
='TWOFACTOR',
716 help='Two-factor authentication code')
717 authentication
.add_option(
719 action
='store_true', dest
='usenetrc', default
=False,
720 help='Use .netrc authentication data')
721 authentication
.add_option(
723 dest
='netrc_location', metavar
='PATH',
724 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
725 authentication
.add_option(
727 dest
='netrc_cmd', metavar
='NETRC_CMD',
728 help='Command to execute to get the credentials for an extractor.')
729 authentication
.add_option(
731 dest
='videopassword', metavar
='PASSWORD',
732 help='Video-specific password')
733 authentication
.add_option(
735 dest
='ap_mso', metavar
='MSO',
736 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
737 authentication
.add_option(
739 dest
='ap_username', metavar
='USERNAME',
740 help='Multiple-system operator account login')
741 authentication
.add_option(
743 dest
='ap_password', metavar
='PASSWORD',
744 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
745 authentication
.add_option(
747 action
='store_true', dest
='ap_list_mso', default
=False,
748 help='List all supported multiple-system operators')
749 authentication
.add_option(
750 '--client-certificate',
751 dest
='client_certificate', metavar
='CERTFILE',
752 help='Path to client certificate file in PEM format. May include the private key')
753 authentication
.add_option(
754 '--client-certificate-key',
755 dest
='client_certificate_key', metavar
='KEYFILE',
756 help='Path to private key file for client certificate')
757 authentication
.add_option(
758 '--client-certificate-password',
759 dest
='client_certificate_password', metavar
='PASSWORD',
760 help='Password for client certificate private key, if encrypted. '
761 'If not provided, and the key is encrypted, yt-dlp will ask interactively')
763 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
764 video_format
.add_option(
766 action
='store', dest
='format', metavar
='FORMAT', default
=None,
767 help='Video format code, see "FORMAT SELECTION" for more details')
768 video_format
.add_option(
769 '-S', '--format-sort', metavar
='SORTORDER',
770 dest
='format_sort', default
=[], type='str', action
='callback',
771 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
772 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
773 video_format
.add_option(
774 '--format-sort-force', '--S-force',
775 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
777 'Force user specified sort order to have precedence over all fields, '
778 'see "Sorting Formats" for more details (Alias: --S-force)'))
779 video_format
.add_option(
780 '--no-format-sort-force',
781 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
782 help='Some fields have precedence over the user specified sort order (default)')
783 video_format
.add_option(
784 '--video-multistreams',
785 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
786 help='Allow multiple video streams to be merged into a single file')
787 video_format
.add_option(
788 '--no-video-multistreams',
789 action
='store_false', dest
='allow_multiple_video_streams',
790 help='Only one video stream is downloaded for each output file (default)')
791 video_format
.add_option(
792 '--audio-multistreams',
793 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
794 help='Allow multiple audio streams to be merged into a single file')
795 video_format
.add_option(
796 '--no-audio-multistreams',
797 action
='store_false', dest
='allow_multiple_audio_streams',
798 help='Only one audio stream is downloaded for each output file (default)')
799 video_format
.add_option(
801 action
='store_const', dest
='format', const
='all',
802 help=optparse
.SUPPRESS_HELP
)
803 video_format
.add_option(
804 '--prefer-free-formats',
805 action
='store_true', dest
='prefer_free_formats', default
=False,
807 'Prefer video formats with free containers over non-free ones of same quality. '
808 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
809 video_format
.add_option(
810 '--no-prefer-free-formats',
811 action
='store_false', dest
='prefer_free_formats', default
=False,
812 help="Don't give any special preference to free containers (default)")
813 video_format
.add_option(
815 action
='store_const', const
='selected', dest
='check_formats', default
=None,
816 help='Make sure formats are selected only from those that are actually downloadable')
817 video_format
.add_option(
818 '--check-all-formats',
819 action
='store_true', dest
='check_formats',
820 help='Check all formats for whether they are actually downloadable')
821 video_format
.add_option(
822 '--no-check-formats',
823 action
='store_false', dest
='check_formats',
824 help='Do not check that the formats are actually downloadable')
825 video_format
.add_option(
826 '-F', '--list-formats',
827 action
='store_true', dest
='listformats',
828 help='List available formats of each video. Simulate unless --no-simulate is used')
829 video_format
.add_option(
830 '--list-formats-as-table',
831 action
='store_true', dest
='listformats_table', default
=True,
832 help=optparse
.SUPPRESS_HELP
)
833 video_format
.add_option(
834 '--list-formats-old', '--no-list-formats-as-table',
835 action
='store_false', dest
='listformats_table',
836 help=optparse
.SUPPRESS_HELP
)
837 video_format
.add_option(
838 '--merge-output-format',
839 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
841 'Containers that may be used when merging formats, separated by "/", e.g. "mp4/mkv". '
842 'Ignored if no merge is required. '
843 f
'(currently supported: {", ".join(sorted(FFmpegMergerPP.SUPPORTED_EXTS))})'))
844 video_format
.add_option(
845 '--allow-unplayable-formats',
846 action
='store_true', dest
='allow_unplayable_formats', default
=False,
847 help=optparse
.SUPPRESS_HELP
)
848 video_format
.add_option(
849 '--no-allow-unplayable-formats',
850 action
='store_false', dest
='allow_unplayable_formats',
851 help=optparse
.SUPPRESS_HELP
)
853 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
854 subtitles
.add_option(
855 '--write-subs', '--write-srt',
856 action
='store_true', dest
='writesubtitles', default
=False,
857 help='Write subtitle file')
858 subtitles
.add_option(
859 '--no-write-subs', '--no-write-srt',
860 action
='store_false', dest
='writesubtitles',
861 help='Do not write subtitle file (default)')
862 subtitles
.add_option(
863 '--write-auto-subs', '--write-automatic-subs',
864 action
='store_true', dest
='writeautomaticsub', default
=False,
865 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
866 subtitles
.add_option(
867 '--no-write-auto-subs', '--no-write-automatic-subs',
868 action
='store_false', dest
='writeautomaticsub', default
=False,
869 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
870 subtitles
.add_option(
872 action
='store_true', dest
='allsubtitles', default
=False,
873 help=optparse
.SUPPRESS_HELP
)
874 subtitles
.add_option(
876 action
='store_true', dest
='listsubtitles', default
=False,
877 help='List available subtitles of each video. Simulate unless --no-simulate is used')
878 subtitles
.add_option(
880 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
881 help='Subtitle format; accepts formats preference, e.g. "srt" or "ass/srt/best"')
882 subtitles
.add_option(
883 '--sub-langs', '--srt-langs',
884 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
885 default
=[], callback
=_list_from_options_callback
,
887 'Languages of the subtitles to download (can be regex) or "all" separated by commas, e.g. --sub-langs "en.*,ja". '
888 'You can prefix the language code with a "-" to exclude it from the requested languages, e.g. --sub-langs all,-live_chat. '
889 'Use --list-subs for a list of available language tags'))
891 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
892 downloader
.add_option(
893 '-N', '--concurrent-fragments',
894 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
895 help='Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %default)')
896 downloader
.add_option(
897 '-r', '--limit-rate', '--rate-limit',
898 dest
='ratelimit', metavar
='RATE',
899 help='Maximum download rate in bytes per second, e.g. 50K or 4.2M')
900 downloader
.add_option(
902 dest
='throttledratelimit', metavar
='RATE',
903 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted, e.g. 100K')
904 downloader
.add_option(
906 dest
='retries', metavar
='RETRIES', default
=10,
907 help='Number of retries (default is %default), or "infinite"')
908 downloader
.add_option(
909 '--file-access-retries',
910 dest
='file_access_retries', metavar
='RETRIES', default
=3,
911 help='Number of times to retry on file access error (default is %default), or "infinite"')
912 downloader
.add_option(
913 '--fragment-retries',
914 dest
='fragment_retries', metavar
='RETRIES', default
=10,
915 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
916 downloader
.add_option(
918 dest
='retry_sleep', metavar
='[TYPE:]EXPR', default
={}, type='str',
919 action
='callback', callback
=_dict_from_options_callback
,
921 'allowed_keys': 'http|fragment|file_access|extractor',
922 'default_key': 'http',
924 'Time to sleep between retries in seconds (optionally) prefixed by the type of retry '
925 '(http (default), fragment, file_access, extractor) to apply the sleep to. '
926 'EXPR can be a number, linear=START[:END[:STEP=1]] or exp=START[:END[:BASE=2]]. '
927 'This option can be used multiple times to set the sleep for the different retry types, '
928 'e.g. --retry-sleep linear=1::2 --retry-sleep fragment:exp=1:20'))
929 downloader
.add_option(
930 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragments',
931 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
932 help='Skip unavailable fragments for DASH, hlsnative and ISM downloads (default) (Alias: --no-abort-on-unavailable-fragments)')
933 downloader
.add_option(
934 '--abort-on-unavailable-fragments', '--no-skip-unavailable-fragments',
935 action
='store_false', dest
='skip_unavailable_fragments',
936 help='Abort download if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
937 downloader
.add_option(
939 action
='store_true', dest
='keep_fragments', default
=False,
940 help='Keep downloaded fragments on disk after downloading is finished')
941 downloader
.add_option(
942 '--no-keep-fragments',
943 action
='store_false', dest
='keep_fragments',
944 help='Delete downloaded fragments after downloading is finished (default)')
945 downloader
.add_option(
947 dest
='buffersize', metavar
='SIZE', default
='1024',
948 help='Size of download buffer, e.g. 1024 or 16K (default is %default)')
949 downloader
.add_option(
951 action
='store_false', dest
='noresizebuffer',
952 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
953 downloader
.add_option(
954 '--no-resize-buffer',
955 action
='store_true', dest
='noresizebuffer', default
=False,
956 help='Do not automatically adjust the buffer size')
957 downloader
.add_option(
959 dest
='http_chunk_size', metavar
='SIZE', default
=None,
961 'Size of a chunk for chunk-based HTTP downloading, e.g. 10485760 or 10M (default is disabled). '
962 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
963 downloader
.add_option(
965 action
='store_true', dest
='test', default
=False,
966 help=optparse
.SUPPRESS_HELP
)
967 downloader
.add_option(
968 '--playlist-reverse',
969 action
='store_true', dest
='playlist_reverse',
970 help=optparse
.SUPPRESS_HELP
)
971 downloader
.add_option(
972 '--no-playlist-reverse',
973 action
='store_false', dest
='playlist_reverse',
974 help=optparse
.SUPPRESS_HELP
)
975 downloader
.add_option(
977 action
='store_true', dest
='playlist_random',
978 help='Download playlist videos in random order')
979 downloader
.add_option(
981 action
='store_true', dest
='lazy_playlist',
982 help='Process entries in the playlist as they are received. This disables n_entries, --playlist-random and --playlist-reverse')
983 downloader
.add_option(
984 '--no-lazy-playlist',
985 action
='store_false', dest
='lazy_playlist',
986 help='Process videos in the playlist only after the entire playlist is parsed (default)')
987 downloader
.add_option(
988 '--xattr-set-filesize',
989 dest
='xattr_set_filesize', action
='store_true',
990 help='Set file xattribute ytdl.filesize with expected file size')
991 downloader
.add_option(
992 '--hls-prefer-native',
993 dest
='hls_prefer_native', action
='store_true', default
=None,
994 help=optparse
.SUPPRESS_HELP
)
995 downloader
.add_option(
996 '--hls-prefer-ffmpeg',
997 dest
='hls_prefer_native', action
='store_false', default
=None,
998 help=optparse
.SUPPRESS_HELP
)
999 downloader
.add_option(
1001 dest
='hls_use_mpegts', action
='store_true', default
=None,
1003 'Use the mpegts container for HLS videos; '
1004 'allowing some players to play the video while downloading, '
1005 'and reducing the chance of file corruption if download is interrupted. '
1006 'This is enabled by default for live streams'))
1007 downloader
.add_option(
1008 '--no-hls-use-mpegts',
1009 dest
='hls_use_mpegts', action
='store_false',
1011 'Do not use the mpegts container for HLS videos. '
1012 'This is default when not downloading live streams'))
1013 downloader
.add_option(
1014 '--download-sections',
1015 metavar
='REGEX', dest
='download_ranges', action
='append',
1017 'Download only chapters that match the regular expression. '
1018 'A "*" prefix denotes time-range instead of chapter. Negative timestamps are calculated from the end. '
1019 '"*from-url" can be used to download between the "start_time" and "end_time" extracted from the URL. '
1020 'Needs ffmpeg. This option can be used multiple times to download multiple sections, '
1021 'e.g. --download-sections "*10:15-inf" --download-sections "intro"'))
1022 downloader
.add_option(
1023 '--downloader', '--external-downloader',
1024 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
1025 action
='callback', callback
=_dict_from_options_callback
,
1027 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
1028 'default_key': 'default',
1029 'process': str.strip
1031 'Name or path of the external downloader to use (optionally) prefixed by '
1032 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
1033 f
'Currently supports native, {", ".join(sorted(list_external_downloaders()))}. '
1034 'You can use this option multiple times to set different downloaders for different protocols. '
1035 'E.g. --downloader aria2c --downloader "dash,m3u8:native" will use '
1036 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
1037 '(Alias: --external-downloader)'))
1038 downloader
.add_option(
1039 '--downloader-args', '--external-downloader-args',
1040 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
1041 action
='callback', callback
=_dict_from_options_callback
,
1043 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(map(re
.escape
, list_external_downloaders())),
1044 'default_key': 'default',
1045 'process': shlex
.split
1047 'Give these arguments to the external downloader. '
1048 'Specify the downloader name and the arguments separated by a colon ":". '
1049 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
1050 'You can use this option multiple times to give different arguments to different downloaders '
1051 '(Alias: --external-downloader-args)'))
1053 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
1054 workarounds
.add_option(
1056 dest
='encoding', metavar
='ENCODING',
1057 help='Force the specified encoding (experimental)')
1058 workarounds
.add_option(
1059 '--legacy-server-connect',
1060 action
='store_true', dest
='legacy_server_connect', default
=False,
1061 help='Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation')
1062 workarounds
.add_option(
1063 '--no-check-certificates',
1064 action
='store_true', dest
='no_check_certificate', default
=False,
1065 help='Suppress HTTPS certificate validation')
1066 workarounds
.add_option(
1067 '--prefer-insecure', '--prefer-unsecure',
1068 action
='store_true', dest
='prefer_insecure',
1069 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
1070 workarounds
.add_option(
1072 metavar
='UA', dest
='user_agent',
1073 help=optparse
.SUPPRESS_HELP
)
1074 workarounds
.add_option(
1076 metavar
='URL', dest
='referer', default
=None,
1077 help=optparse
.SUPPRESS_HELP
)
1078 workarounds
.add_option(
1080 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
1081 action
='callback', callback
=_dict_from_options_callback
,
1082 callback_kwargs
={'multiple_keys': False}
,
1083 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
1085 workarounds
.add_option(
1086 '--bidi-workaround',
1087 dest
='bidi_workaround', action
='store_true',
1088 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
1089 workarounds
.add_option(
1090 '--sleep-requests', metavar
='SECONDS',
1091 dest
='sleep_interval_requests', type=float,
1092 help='Number of seconds to sleep between requests during data extraction')
1093 workarounds
.add_option(
1094 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
1095 dest
='sleep_interval', type=float,
1097 'Number of seconds to sleep before each download. '
1098 'This is the minimum time to sleep when used along with --max-sleep-interval '
1099 '(Alias: --min-sleep-interval)'))
1100 workarounds
.add_option(
1101 '--max-sleep-interval', metavar
='SECONDS',
1102 dest
='max_sleep_interval', type=float,
1103 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
1104 workarounds
.add_option(
1105 '--sleep-subtitles', metavar
='SECONDS',
1106 dest
='sleep_interval_subtitles', default
=0, type=int,
1107 help='Number of seconds to sleep before each subtitle download')
1109 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
1110 verbosity
.add_option(
1112 action
='store_true', dest
='quiet', default
=None,
1113 help='Activate quiet mode. If used with --verbose, print the log to stderr')
1114 verbosity
.add_option(
1116 action
='store_false', dest
='quiet',
1117 help='Deactivate quiet mode. (Default)')
1118 verbosity
.add_option(
1120 dest
='no_warnings', action
='store_true', default
=False,
1121 help='Ignore warnings')
1122 verbosity
.add_option(
1124 action
='store_true', dest
='simulate', default
=None,
1125 help='Do not download the video and do not write anything to disk')
1126 verbosity
.add_option(
1128 action
='store_false', dest
='simulate',
1129 help='Download the video even if printing/listing options are used')
1130 verbosity
.add_option(
1131 '--ignore-no-formats-error',
1132 action
='store_true', dest
='ignore_no_formats_error', default
=False,
1134 'Ignore "No video formats" error. Useful for extracting metadata '
1135 'even if the videos are not actually available for download (experimental)'))
1136 verbosity
.add_option(
1137 '--no-ignore-no-formats-error',
1138 action
='store_false', dest
='ignore_no_formats_error',
1139 help='Throw error when no downloadable video formats are found (default)')
1140 verbosity
.add_option(
1141 '--skip-download', '--no-download',
1142 action
='store_true', dest
='skip_download', default
=False,
1143 help='Do not download the video but write all related files (Alias: --no-download)')
1144 verbosity
.add_option(
1146 metavar
='[WHEN:]TEMPLATE', dest
='forceprint', **when_prefix('video'),
1148 'Field name or output template to print to screen, optionally prefixed with when to print it, separated by a ":". '
1149 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: video). '
1150 'Implies --quiet. Implies --simulate unless --no-simulate or later stages of WHEN are used. '
1151 'This option can be used multiple times'))
1152 verbosity
.add_option(
1154 metavar
='[WHEN:]TEMPLATE FILE', dest
='print_to_file', nargs
=2, **when_prefix('video'),
1156 'Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
1157 'FILE uses the same syntax as the output template. This option can be used multiple times'))
1158 verbosity
.add_option(
1160 action
='store_true', dest
='geturl', default
=False,
1161 help=optparse
.SUPPRESS_HELP
)
1162 verbosity
.add_option(
1163 '-e', '--get-title',
1164 action
='store_true', dest
='gettitle', default
=False,
1165 help=optparse
.SUPPRESS_HELP
)
1166 verbosity
.add_option(
1168 action
='store_true', dest
='getid', default
=False,
1169 help=optparse
.SUPPRESS_HELP
)
1170 verbosity
.add_option(
1172 action
='store_true', dest
='getthumbnail', default
=False,
1173 help=optparse
.SUPPRESS_HELP
)
1174 verbosity
.add_option(
1175 '--get-description',
1176 action
='store_true', dest
='getdescription', default
=False,
1177 help=optparse
.SUPPRESS_HELP
)
1178 verbosity
.add_option(
1180 action
='store_true', dest
='getduration', default
=False,
1181 help=optparse
.SUPPRESS_HELP
)
1182 verbosity
.add_option(
1184 action
='store_true', dest
='getfilename', default
=False,
1185 help=optparse
.SUPPRESS_HELP
)
1186 verbosity
.add_option(
1188 action
='store_true', dest
='getformat', default
=False,
1189 help=optparse
.SUPPRESS_HELP
)
1190 verbosity
.add_option(
1191 '-j', '--dump-json',
1192 action
='store_true', dest
='dumpjson', default
=False,
1193 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
1194 verbosity
.add_option(
1195 '-J', '--dump-single-json',
1196 action
='store_true', dest
='dump_single_json', default
=False,
1198 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
1199 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
1200 verbosity
.add_option(
1202 action
='store_true', dest
='print_json', default
=False,
1203 help=optparse
.SUPPRESS_HELP
)
1204 verbosity
.add_option(
1205 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
1206 action
='store_true', dest
='force_write_download_archive', default
=False,
1208 'Force download archive entries to be written as far as no errors occur, '
1209 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
1210 verbosity
.add_option(
1212 action
='store_true', dest
='progress_with_newline', default
=False,
1213 help='Output progress bar as new lines')
1214 verbosity
.add_option(
1216 action
='store_true', dest
='noprogress', default
=None,
1217 help='Do not print progress bar')
1218 verbosity
.add_option(
1220 action
='store_false', dest
='noprogress',
1221 help='Show progress bar, even if in quiet mode')
1222 verbosity
.add_option(
1224 action
='store_true', dest
='consoletitle', default
=False,
1225 help='Display progress in console titlebar')
1226 verbosity
.add_option(
1227 '--progress-template',
1228 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
1229 action
='callback', callback
=_dict_from_options_callback
,
1231 'allowed_keys': '(download|postprocess)(-title)?',
1232 'default_key': 'download'
1234 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
1235 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
1236 'The video\'s fields are accessible under the "info" key and '
1237 'the progress attributes are accessible under "progress" key. E.g. '
1238 # TODO: Document the fields inside "progress"
1239 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
1240 verbosity
.add_option(
1242 action
='store_true', dest
='verbose', default
=False,
1243 help='Print various debugging information')
1244 verbosity
.add_option(
1245 '--dump-pages', '--dump-intermediate-pages',
1246 action
='store_true', dest
='dump_intermediate_pages', default
=False,
1247 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
1248 verbosity
.add_option(
1250 action
='store_true', dest
='write_pages', default
=False,
1251 help='Write downloaded intermediary pages to files in the current directory to debug problems')
1252 verbosity
.add_option(
1254 action
='store_true', dest
='load_pages', default
=False,
1255 help=optparse
.SUPPRESS_HELP
)
1256 verbosity
.add_option(
1257 '--youtube-print-sig-code',
1258 action
='store_true', dest
='youtube_print_sig_code', default
=False,
1259 help=optparse
.SUPPRESS_HELP
)
1260 verbosity
.add_option(
1261 '--print-traffic', '--dump-headers',
1262 dest
='debug_printtraffic', action
='store_true', default
=False,
1263 help='Display sent and read HTTP traffic')
1264 verbosity
.add_option(
1265 '-C', '--call-home',
1266 dest
='call_home', action
='store_true', default
=False,
1267 # help='Contact the yt-dlp server for debugging')
1268 help=optparse
.SUPPRESS_HELP
)
1269 verbosity
.add_option(
1271 dest
='call_home', action
='store_false',
1272 # help='Do not contact the yt-dlp server for debugging (default)')
1273 help=optparse
.SUPPRESS_HELP
)
1275 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
1276 filesystem
.add_option(
1277 '-a', '--batch-file',
1278 dest
='batchfile', metavar
='FILE',
1280 'File containing URLs to download ("-" for stdin), one URL per line. '
1281 'Lines starting with "#", ";" or "]" are considered as comments and ignored'))
1282 filesystem
.add_option(
1284 dest
='batchfile', action
='store_const', const
=None,
1285 help='Do not read URLs from batch file (default)')
1286 filesystem
.add_option(
1287 '--id', default
=False,
1288 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1289 filesystem
.add_option(
1291 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1292 action
='callback', callback
=_dict_from_options_callback
,
1294 'allowed_keys': 'home|temp|%s' % '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1295 'default_key': 'home'
1297 'The paths where the files should be downloaded. '
1298 'Specify the type of file and the path separated by a colon ":". '
1299 'All the same TYPES as --output are supported. '
1300 'Additionally, you can also provide "home" (default) and "temp" paths. '
1301 'All intermediary files are first downloaded to the temp path and '
1302 'then the final files are moved over to the home path after download is finished. '
1303 'This option is ignored if --output is an absolute path'))
1304 filesystem
.add_option(
1306 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1307 action
='callback', callback
=_dict_from_options_callback
,
1309 'allowed_keys': '|'.join(map(re
.escape
, OUTTMPL_TYPES
.keys())),
1310 'default_key': 'default'
1311 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1312 filesystem
.add_option(
1313 '--output-na-placeholder',
1314 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1315 help=('Placeholder for unavailable fields in "OUTPUT TEMPLATE" (default: "%default")'))
1316 filesystem
.add_option(
1317 '--autonumber-size',
1318 dest
='autonumber_size', metavar
='NUMBER', type=int,
1319 help=optparse
.SUPPRESS_HELP
)
1320 filesystem
.add_option(
1321 '--autonumber-start',
1322 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1323 help=optparse
.SUPPRESS_HELP
)
1324 filesystem
.add_option(
1325 '--restrict-filenames',
1326 action
='store_true', dest
='restrictfilenames', default
=False,
1327 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1328 filesystem
.add_option(
1329 '--no-restrict-filenames',
1330 action
='store_false', dest
='restrictfilenames',
1331 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1332 filesystem
.add_option(
1333 '--windows-filenames',
1334 action
='store_true', dest
='windowsfilenames', default
=False,
1335 help='Force filenames to be Windows-compatible')
1336 filesystem
.add_option(
1337 '--no-windows-filenames',
1338 action
='store_false', dest
='windowsfilenames',
1339 help='Make filenames Windows-compatible only if using Windows (default)')
1340 filesystem
.add_option(
1341 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1342 dest
='trim_file_name', default
=0, type=int,
1343 help='Limit the filename length (excluding extension) to the specified number of characters')
1344 filesystem
.add_option(
1345 '-w', '--no-overwrites',
1346 action
='store_false', dest
='overwrites', default
=None,
1347 help='Do not overwrite any files')
1348 filesystem
.add_option(
1349 '--force-overwrites', '--yes-overwrites',
1350 action
='store_true', dest
='overwrites',
1351 help='Overwrite all video and metadata files. This option includes --no-continue')
1352 filesystem
.add_option(
1353 '--no-force-overwrites',
1354 action
='store_const', dest
='overwrites', const
=None,
1355 help='Do not overwrite the video, but overwrite related files (default)')
1356 filesystem
.add_option(
1358 action
='store_true', dest
='continue_dl', default
=True,
1359 help='Resume partially downloaded files/fragments (default)')
1360 filesystem
.add_option(
1362 action
='store_false', dest
='continue_dl',
1364 'Do not resume partially downloaded fragments. '
1365 'If the file is not fragmented, restart download of the entire file'))
1366 filesystem
.add_option(
1368 action
='store_false', dest
='nopart', default
=False,
1369 help='Use .part files instead of writing directly into output file (default)')
1370 filesystem
.add_option(
1372 action
='store_true', dest
='nopart',
1373 help='Do not use .part files - write directly into output file')
1374 filesystem
.add_option(
1376 action
='store_true', dest
='updatetime', default
=True,
1377 help='Use the Last-modified header to set the file modification time (default)')
1378 filesystem
.add_option(
1380 action
='store_false', dest
='updatetime',
1381 help='Do not use the Last-modified header to set the file modification time')
1382 filesystem
.add_option(
1383 '--write-description',
1384 action
='store_true', dest
='writedescription', default
=False,
1385 help='Write video description to a .description file')
1386 filesystem
.add_option(
1387 '--no-write-description',
1388 action
='store_false', dest
='writedescription',
1389 help='Do not write video description (default)')
1390 filesystem
.add_option(
1391 '--write-info-json',
1392 action
='store_true', dest
='writeinfojson', default
=None,
1393 help='Write video metadata to a .info.json file (this may contain personal information)')
1394 filesystem
.add_option(
1395 '--no-write-info-json',
1396 action
='store_false', dest
='writeinfojson',
1397 help='Do not write video metadata (default)')
1398 filesystem
.add_option(
1399 '--write-annotations',
1400 action
='store_true', dest
='writeannotations', default
=False,
1401 help=optparse
.SUPPRESS_HELP
)
1402 filesystem
.add_option(
1403 '--no-write-annotations',
1404 action
='store_false', dest
='writeannotations',
1405 help=optparse
.SUPPRESS_HELP
)
1406 filesystem
.add_option(
1407 '--write-playlist-metafiles',
1408 action
='store_true', dest
='allow_playlist_files', default
=None,
1410 'Write playlist metadata in addition to the video metadata '
1411 'when using --write-info-json, --write-description etc. (default)'))
1412 filesystem
.add_option(
1413 '--no-write-playlist-metafiles',
1414 action
='store_false', dest
='allow_playlist_files',
1415 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1416 filesystem
.add_option(
1417 '--clean-info-json', '--clean-infojson',
1418 action
='store_true', dest
='clean_infojson', default
=None,
1420 'Remove some internal metadata such as filenames from the infojson (default)'))
1421 filesystem
.add_option(
1422 '--no-clean-info-json', '--no-clean-infojson',
1423 action
='store_false', dest
='clean_infojson',
1424 help='Write all fields to the infojson')
1425 filesystem
.add_option(
1426 '--write-comments', '--get-comments',
1427 action
='store_true', dest
='getcomments', default
=False,
1429 'Retrieve video comments to be placed in the infojson. '
1430 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1431 filesystem
.add_option(
1432 '--no-write-comments', '--no-get-comments',
1433 action
='store_false', dest
='getcomments',
1434 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1435 filesystem
.add_option(
1436 '--load-info-json', '--load-info',
1437 dest
='load_info_filename', metavar
='FILE',
1438 help='JSON file containing the video information (created with the "--write-info-json" option)')
1439 filesystem
.add_option(
1441 dest
='cookiefile', metavar
='FILE',
1442 help='Netscape formatted file to read cookies from and dump cookie jar in')
1443 filesystem
.add_option(
1445 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1446 help='Do not read/dump cookies from/to file (default)')
1447 filesystem
.add_option(
1448 '--cookies-from-browser',
1449 dest
='cookiesfrombrowser', metavar
='BROWSER[+KEYRING][:PROFILE][::CONTAINER]',
1451 'The name of the browser to load cookies from. '
1452 f
'Currently supported browsers are: {", ".join(sorted(SUPPORTED_BROWSERS))}. '
1453 'Optionally, the KEYRING used for decrypting Chromium cookies on Linux, '
1454 'the name/path of the PROFILE to load cookies from, '
1455 'and the CONTAINER name (if Firefox) ("none" for no container) '
1456 'can be given with their respective seperators. '
1457 'By default, all containers of the most recently accessed profile are used. '
1458 f
'Currently supported keyrings are: {", ".join(map(str.lower, sorted(SUPPORTED_KEYRINGS)))}'))
1459 filesystem
.add_option(
1460 '--no-cookies-from-browser',
1461 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1462 help='Do not load cookies from browser (default)')
1463 filesystem
.add_option(
1464 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1466 'Location in the filesystem where yt-dlp can store some downloaded information '
1467 '(such as client ids and signatures) permanently. By default ${XDG_CACHE_HOME}/yt-dlp'))
1468 filesystem
.add_option(
1469 '--no-cache-dir', action
='store_false', dest
='cachedir',
1470 help='Disable filesystem caching')
1471 filesystem
.add_option(
1473 action
='store_true', dest
='rm_cachedir',
1474 help='Delete all filesystem cache files')
1476 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1477 thumbnail
.add_option(
1478 '--write-thumbnail',
1479 action
='callback', dest
='writethumbnail', default
=False,
1480 # Should override --no-write-thumbnail, but not --write-all-thumbnail
1481 callback
=lambda option
, _
, __
, parser
: setattr(
1482 parser
.values
, option
.dest
, getattr(parser
.values
, option
.dest
) or True),
1483 help='Write thumbnail image to disk')
1484 thumbnail
.add_option(
1485 '--no-write-thumbnail',
1486 action
='store_false', dest
='writethumbnail',
1487 help='Do not write thumbnail image to disk (default)')
1488 thumbnail
.add_option(
1489 '--write-all-thumbnails',
1490 action
='store_const', dest
='writethumbnail', const
='all',
1491 help='Write all thumbnail image formats to disk')
1492 thumbnail
.add_option(
1493 '--list-thumbnails',
1494 action
='store_true', dest
='list_thumbnails', default
=False,
1495 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1497 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1500 action
='store_true', dest
='writelink', default
=False,
1501 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1504 action
='store_true', dest
='writeurllink', default
=False,
1505 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1507 '--write-webloc-link',
1508 action
='store_true', dest
='writewebloclink', default
=False,
1509 help='Write a .webloc macOS internet shortcut')
1511 '--write-desktop-link',
1512 action
='store_true', dest
='writedesktoplink', default
=False,
1513 help='Write a .desktop Linux internet shortcut')
1515 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1516 postproc
.add_option(
1517 '-x', '--extract-audio',
1518 action
='store_true', dest
='extractaudio', default
=False,
1519 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1520 postproc
.add_option(
1521 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1523 'Format to convert the audio to when -x is used. '
1524 f
'(currently supported: best (default), {", ".join(sorted(FFmpegExtractAudioPP.SUPPORTED_EXTS))}). '
1525 'You can specify multiple rules using similar syntax as --remux-video'))
1526 postproc
.add_option(
1527 '--audio-quality', metavar
='QUALITY',
1528 dest
='audioquality', default
='5',
1530 'Specify ffmpeg audio quality to use when converting the audio with -x. '
1531 'Insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)'))
1532 postproc
.add_option(
1534 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1536 'Remux the video into another container if necessary '
1537 f
'(currently supported: {", ".join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)}). '
1538 'If target container does not support the video/audio codec, remuxing will fail. You can specify multiple rules; '
1539 'e.g. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 and anything else to mkv'))
1540 postproc
.add_option(
1542 metavar
='FORMAT', dest
='recodevideo', default
=None,
1543 help='Re-encode the video into another format if necessary. The syntax and supported formats are the same as --remux-video')
1544 postproc
.add_option(
1545 '--postprocessor-args', '--ppa',
1546 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1547 action
='callback', callback
=_dict_from_options_callback
,
1549 'allowed_keys': r
'\w+(?:\+\w+)?',
1550 'default_key': 'default-compat',
1551 'process': shlex
.split
,
1552 'multiple_keys': False
1554 'Give these arguments to the postprocessors. '
1555 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1556 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1557 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1558 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1559 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1560 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1561 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1562 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1563 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1564 'before the specified input/output file, e.g. --ppa "Merger+ffmpeg_i1:-v quiet". '
1565 'You can use this option multiple times to give different arguments to different '
1566 'postprocessors. (Alias: --ppa)'))
1567 postproc
.add_option(
1568 '-k', '--keep-video',
1569 action
='store_true', dest
='keepvideo', default
=False,
1570 help='Keep the intermediate video file on disk after post-processing')
1571 postproc
.add_option(
1573 action
='store_false', dest
='keepvideo',
1574 help='Delete the intermediate video file after post-processing (default)')
1575 postproc
.add_option(
1576 '--post-overwrites',
1577 action
='store_false', dest
='nopostoverwrites',
1578 help='Overwrite post-processed files (default)')
1579 postproc
.add_option(
1580 '--no-post-overwrites',
1581 action
='store_true', dest
='nopostoverwrites', default
=False,
1582 help='Do not overwrite post-processed files')
1583 postproc
.add_option(
1585 action
='store_true', dest
='embedsubtitles', default
=False,
1586 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1587 postproc
.add_option(
1589 action
='store_false', dest
='embedsubtitles',
1590 help='Do not embed subtitles (default)')
1591 postproc
.add_option(
1592 '--embed-thumbnail',
1593 action
='store_true', dest
='embedthumbnail', default
=False,
1594 help='Embed thumbnail in the video as cover art')
1595 postproc
.add_option(
1596 '--no-embed-thumbnail',
1597 action
='store_false', dest
='embedthumbnail',
1598 help='Do not embed thumbnail (default)')
1599 postproc
.add_option(
1600 '--embed-metadata', '--add-metadata',
1601 action
='store_true', dest
='addmetadata', default
=False,
1603 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1604 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1605 postproc
.add_option(
1606 '--no-embed-metadata', '--no-add-metadata',
1607 action
='store_false', dest
='addmetadata',
1608 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1609 postproc
.add_option(
1610 '--embed-chapters', '--add-chapters',
1611 action
='store_true', dest
='addchapters', default
=None,
1612 help='Add chapter markers to the video file (Alias: --add-chapters)')
1613 postproc
.add_option(
1614 '--no-embed-chapters', '--no-add-chapters',
1615 action
='store_false', dest
='addchapters',
1616 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1617 postproc
.add_option(
1618 '--embed-info-json',
1619 action
='store_true', dest
='embed_infojson', default
=None,
1620 help='Embed the infojson as an attachment to mkv/mka video files')
1621 postproc
.add_option(
1622 '--no-embed-info-json',
1623 action
='store_false', dest
='embed_infojson',
1624 help='Do not embed the infojson as an attachment to the video file')
1625 postproc
.add_option(
1626 '--metadata-from-title',
1627 metavar
='FORMAT', dest
='metafromtitle',
1628 help=optparse
.SUPPRESS_HELP
)
1629 postproc
.add_option(
1631 metavar
='[WHEN:]FROM:TO', dest
='parse_metadata', **when_prefix('pre_process'),
1633 'Parse additional metadata like title/artist from other fields; see "MODIFYING METADATA" for details. '
1634 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1635 postproc
.add_option(
1636 '--replace-in-metadata',
1637 dest
='parse_metadata', metavar
='[WHEN:]FIELDS REGEX REPLACE', nargs
=3, **when_prefix('pre_process'),
1639 'Replace text in a metadata field using the given regex. This option can be used multiple times. '
1640 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: pre_process)'))
1641 postproc
.add_option(
1642 '--xattrs', '--xattr',
1643 action
='store_true', dest
='xattrs', default
=False,
1644 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1645 postproc
.add_option(
1646 '--concat-playlist',
1647 metavar
='POLICY', dest
='concat_playlist', default
='multi_video',
1648 choices
=('never', 'always', 'multi_video'),
1650 'Concatenate videos in a playlist. One of "never", "always", or '
1651 '"multi_video" (default; only when the videos form a single show). '
1652 'All the video files must have same codecs and number of streams to be concatable. '
1653 'The "pl_video:" prefix can be used with "--paths" and "--output" to '
1654 'set the output filename for the concatenated files. See "OUTPUT TEMPLATE" for details'))
1655 postproc
.add_option(
1657 metavar
='POLICY', dest
='fixup', default
=None,
1658 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1660 'Automatically correct known faults of the file. '
1661 'One of never (do nothing), warn (only emit a warning), '
1662 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1663 'force (try fixing even if file already exists)'))
1664 postproc
.add_option(
1665 '--prefer-avconv', '--no-prefer-ffmpeg',
1666 action
='store_false', dest
='prefer_ffmpeg',
1667 help=optparse
.SUPPRESS_HELP
)
1668 postproc
.add_option(
1669 '--prefer-ffmpeg', '--no-prefer-avconv',
1670 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1671 help=optparse
.SUPPRESS_HELP
)
1672 postproc
.add_option(
1673 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1674 dest
='ffmpeg_location',
1675 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1676 postproc
.add_option(
1678 metavar
='[WHEN:]CMD', dest
='exec_cmd', **when_prefix('after_move'),
1680 'Execute a command, optionally prefixed with when to execute it, separated by a ":". '
1681 'Supported values of "WHEN" are the same as that of --use-postprocessor (default: after_move). '
1682 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1683 'If no fields are passed, %(filepath,_filename|)q is appended to the end of the command. '
1684 'This option can be used multiple times'))
1685 postproc
.add_option(
1687 action
='store_const', dest
='exec_cmd', const
={},
1688 help='Remove any previously defined --exec')
1689 postproc
.add_option(
1690 '--exec-before-download', metavar
='CMD',
1691 action
='append', dest
='exec_before_dl_cmd',
1692 help=optparse
.SUPPRESS_HELP
)
1693 postproc
.add_option(
1694 '--no-exec-before-download',
1695 action
='store_const', dest
='exec_before_dl_cmd', const
=None,
1696 help=optparse
.SUPPRESS_HELP
)
1697 postproc
.add_option(
1698 '--convert-subs', '--convert-sub', '--convert-subtitles',
1699 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1701 'Convert the subtitles to another format (currently supported: %s) '
1702 '(Alias: --convert-subtitles)' % ', '.join(sorted(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
))))
1703 postproc
.add_option(
1704 '--convert-thumbnails',
1705 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1707 'Convert the thumbnails to another format '
1708 f
'(currently supported: {", ".join(sorted(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS))}). '
1709 'You can specify multiple rules using similar syntax as --remux-video'))
1710 postproc
.add_option(
1711 '--split-chapters', '--split-tracks',
1712 dest
='split_chapters', action
='store_true', default
=False,
1714 'Split video into multiple files based on internal chapters. '
1715 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1716 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1717 postproc
.add_option(
1718 '--no-split-chapters', '--no-split-tracks',
1719 dest
='split_chapters', action
='store_false',
1720 help='Do not split video based on chapters (default)')
1721 postproc
.add_option(
1722 '--remove-chapters',
1723 metavar
='REGEX', dest
='remove_chapters', action
='append',
1725 'Remove chapters whose title matches the given regular expression. '
1726 'The syntax is the same as --download-sections. This option can be used multiple times'))
1727 postproc
.add_option(
1728 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1729 help='Do not remove any chapters from the file (default)')
1730 postproc
.add_option(
1731 '--force-keyframes-at-cuts',
1732 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1734 'Force keyframes at cuts when downloading/splitting/removing sections. '
1735 'This is slow due to needing a re-encode, but the resulting video may have fewer artifacts around the cuts'))
1736 postproc
.add_option(
1737 '--no-force-keyframes-at-cuts',
1738 action
='store_false', dest
='force_keyframes_at_cuts',
1739 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1740 _postprocessor_opts_parser
= lambda key
, val
='': (
1741 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1742 ('key', remove_end(key
, 'PP')))
1743 postproc
.add_option(
1744 '--use-postprocessor',
1745 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1746 action
='callback', callback
=_list_from_options_callback
,
1749 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1751 'The (case sensitive) name of plugin postprocessors to be enabled, '
1752 'and (optionally) arguments to be passed to it, separated by a colon ":". '
1753 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1754 'The "when" argument determines when the postprocessor is invoked. '
1755 'It can be one of "pre_process" (after video extraction), "after_filter" (after video passes filter), '
1756 '"video" (after --format; before --print/--output), "before_dl" (before each video download), '
1757 '"post_process" (after each video download; default), '
1758 '"after_move" (after moving video file to it\'s final locations), '
1759 '"after_video" (after downloading and processing all formats of a video), '
1760 'or "playlist" (at end of playlist). '
1761 'This option can be used multiple times to add different postprocessors'))
1763 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1764 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1765 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1766 sponsorblock
.add_option(
1767 '--sponsorblock-mark', metavar
='CATS',
1768 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1769 callback
=_set_from_options_callback
, callback_kwargs
={
1770 'allowed_values': SponsorBlockPP
.CATEGORIES
.keys(),
1771 'aliases': {'default': ['all']}
1773 'SponsorBlock categories to create chapters for, separated by commas. '
1774 f
'Available categories are {", ".join(SponsorBlockPP.CATEGORIES.keys())}, all and default (=all). '
1775 'You can prefix the category with a "-" to exclude it. See [1] for description of the categories. '
1776 'E.g. --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories'))
1777 sponsorblock
.add_option(
1778 '--sponsorblock-remove', metavar
='CATS',
1779 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1780 callback
=_set_from_options_callback
, callback_kwargs
={
1781 'allowed_values': set(SponsorBlockPP
.CATEGORIES
.keys()) - set(SponsorBlockPP
.NON_SKIPPABLE_CATEGORIES
.keys()),
1782 # Note: From https://wiki.sponsor.ajay.app/w/Types:
1783 # The filler category is very aggressive.
1784 # It is strongly recommended to not use this in a client by default.
1785 'aliases': {'default': ['all', '-filler']}
1787 'SponsorBlock categories to be removed from the video file, separated by commas. '
1788 'If a category is present in both mark and remove, remove takes precedence. '
1789 'The syntax and available categories are the same as for --sponsorblock-mark '
1790 'except that "default" refers to "all,-filler" '
1791 f
'and {", ".join(SponsorBlockPP.NON_SKIPPABLE_CATEGORIES.keys())} are not available'))
1792 sponsorblock
.add_option(
1793 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1794 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1796 'An output template for the title of the SponsorBlock chapters created by --sponsorblock-mark. '
1797 'The only available fields are start_time, end_time, category, categories, name, category_names. '
1798 'Defaults to "%default"'))
1799 sponsorblock
.add_option(
1800 '--no-sponsorblock', default
=False,
1801 action
='store_true', dest
='no_sponsorblock',
1802 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1803 sponsorblock
.add_option(
1804 '--sponsorblock-api', metavar
='URL',
1805 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1806 help='SponsorBlock API location, defaults to %default')
1808 sponsorblock
.add_option(
1810 action
='store_true', dest
='sponskrub', default
=False,
1811 help=optparse
.SUPPRESS_HELP
)
1812 sponsorblock
.add_option(
1814 action
='store_false', dest
='sponskrub',
1815 help=optparse
.SUPPRESS_HELP
)
1816 sponsorblock
.add_option(
1817 '--sponskrub-cut', default
=False,
1818 action
='store_true', dest
='sponskrub_cut',
1819 help=optparse
.SUPPRESS_HELP
)
1820 sponsorblock
.add_option(
1821 '--no-sponskrub-cut',
1822 action
='store_false', dest
='sponskrub_cut',
1823 help=optparse
.SUPPRESS_HELP
)
1824 sponsorblock
.add_option(
1825 '--sponskrub-force', default
=False,
1826 action
='store_true', dest
='sponskrub_force',
1827 help=optparse
.SUPPRESS_HELP
)
1828 sponsorblock
.add_option(
1829 '--no-sponskrub-force',
1830 action
='store_true', dest
='sponskrub_force',
1831 help=optparse
.SUPPRESS_HELP
)
1832 sponsorblock
.add_option(
1833 '--sponskrub-location', metavar
='PATH',
1834 dest
='sponskrub_path', default
='',
1835 help=optparse
.SUPPRESS_HELP
)
1836 sponsorblock
.add_option(
1837 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1838 help=optparse
.SUPPRESS_HELP
)
1840 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1841 extractor
.add_option(
1842 '--extractor-retries',
1843 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1844 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1845 extractor
.add_option(
1846 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1847 action
='store_true', dest
='dynamic_mpd', default
=True,
1848 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1849 extractor
.add_option(
1850 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1851 action
='store_false', dest
='dynamic_mpd',
1852 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1853 extractor
.add_option(
1854 '--hls-split-discontinuity',
1855 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1856 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1858 extractor
.add_option(
1859 '--no-hls-split-discontinuity',
1860 dest
='hls_split_discontinuity', action
='store_false',
1861 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1862 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [
1863 val
.replace(r
'\,', ',').strip() for val
in re
.split(r
'(?<!\\),', vals
)])
1864 extractor
.add_option(
1866 metavar
='IE_KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1867 action
='callback', callback
=_dict_from_options_callback
,
1869 'multiple_keys': False,
1870 'process': lambda val
: dict(
1871 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1873 'Pass ARGS arguments to the IE_KEY extractor. See "EXTRACTOR ARGUMENTS" for details. '
1874 'You can use this option multiple times to give arguments for different extractors'))
1875 extractor
.add_option(
1876 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1877 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1878 help=optparse
.SUPPRESS_HELP
)
1879 extractor
.add_option(
1880 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1881 action
='store_false', dest
='youtube_include_dash_manifest',
1882 help=optparse
.SUPPRESS_HELP
)
1883 extractor
.add_option(
1884 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1885 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1886 help=optparse
.SUPPRESS_HELP
)
1887 extractor
.add_option(
1888 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1889 action
='store_false', dest
='youtube_include_hls_manifest',
1890 help=optparse
.SUPPRESS_HELP
)
1892 parser
.add_option_group(general
)
1893 parser
.add_option_group(network
)
1894 parser
.add_option_group(geo
)
1895 parser
.add_option_group(selection
)
1896 parser
.add_option_group(downloader
)
1897 parser
.add_option_group(filesystem
)
1898 parser
.add_option_group(thumbnail
)
1899 parser
.add_option_group(link
)
1900 parser
.add_option_group(verbosity
)
1901 parser
.add_option_group(workarounds
)
1902 parser
.add_option_group(video_format
)
1903 parser
.add_option_group(subtitles
)
1904 parser
.add_option_group(authentication
)
1905 parser
.add_option_group(postproc
)
1906 parser
.add_option_group(sponsorblock
)
1907 parser
.add_option_group(extractor
)
1912 def _hide_login_info(opts
):
1913 deprecation_warning(f
'"{__name__}._hide_login_info" is deprecated and may be removed '
1914 'in a future version. Use "yt_dlp.utils.Config.hide_login_info" instead')
1915 return Config
.hide_login_info(opts
)