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