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