aboutsummaryrefslogtreecommitdiffstats
path: root/hypervideo_dl/options.py
diff options
context:
space:
mode:
authorJesús <heckyel@hyperbola.info>2021-10-18 15:24:21 -0500
committerJesús <heckyel@hyperbola.info>2021-10-18 15:24:21 -0500
commit5122028a4bcac4ae577ef7fbd55ccad5cb34ef5e (patch)
tree65209bc739db35e31f1c9b5b868eb5df4fe12ae3 /hypervideo_dl/options.py
parent27fe903c511691c078942bef5ee9a05a43b15c8f (diff)
downloadhypervideo-5122028a4bcac4ae577ef7fbd55ccad5cb34ef5e.tar.lz
hypervideo-5122028a4bcac4ae577ef7fbd55ccad5cb34ef5e.tar.xz
hypervideo-5122028a4bcac4ae577ef7fbd55ccad5cb34ef5e.zip
update from upstream
Diffstat (limited to 'hypervideo_dl/options.py')
-rw-r--r--hypervideo_dl/options.py1234
1 files changed, 969 insertions, 265 deletions
diff --git a/hypervideo_dl/options.py b/hypervideo_dl/options.py
index 6ec5912..578fb86 100644
--- a/hypervideo_dl/options.py
+++ b/hypervideo_dl/options.py
@@ -5,7 +5,6 @@ import optparse
import re
import sys
-from .downloader.external import list_external_downloaders
from .compat import (
compat_expanduser,
compat_get_terminal_size,
@@ -14,11 +13,26 @@ from .compat import (
compat_shlex_split,
)
from .utils import (
+ expand_path,
+ get_executable_path,
+ OUTTMPL_TYPES,
preferredencoding,
+ remove_end,
write_string,
)
+from .cookies import SUPPORTED_BROWSERS
from .version import __version__
+from .downloader.external import list_external_downloaders
+from .postprocessor import (
+ FFmpegExtractAudioPP,
+ FFmpegSubtitlesConvertorPP,
+ FFmpegThumbnailsConvertorPP,
+ FFmpegVideoRemuxerPP,
+ SponsorBlockPP,
+)
+from .postprocessor.modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
+
def _hide_login_info(opts):
PRIVATE_OPTS = set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
@@ -54,42 +68,37 @@ def parseOpts(overrideArguments=None):
optionf.close()
return res
- def _readUserConf():
- xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
- if xdg_config_home:
- userConfFile = os.path.join(xdg_config_home, 'hypervideo', 'config')
- if not os.path.isfile(userConfFile):
- userConfFile = os.path.join(xdg_config_home, 'hypervideo.conf')
- else:
- userConfFile = os.path.join(compat_expanduser('~'), '.config', 'hypervideo', 'config')
- if not os.path.isfile(userConfFile):
- userConfFile = os.path.join(compat_expanduser('~'), '.config', 'hypervideo.conf')
- userConf = _readOptions(userConfFile, None)
+ def _readUserConf(package_name, default=[]):
+ # .config
+ xdg_config_home = compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
+ userConfFile = os.path.join(xdg_config_home, package_name, 'config')
+ if not os.path.isfile(userConfFile):
+ userConfFile = os.path.join(xdg_config_home, '%s.conf' % package_name)
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
- if userConf is None:
- appdata_dir = compat_getenv('appdata')
- if appdata_dir:
- userConf = _readOptions(
- os.path.join(appdata_dir, 'hypervideo', 'config'),
- default=None)
- if userConf is None:
- userConf = _readOptions(
- os.path.join(appdata_dir, 'hypervideo', 'config.txt'),
- default=None)
+ # appdata
+ appdata_dir = compat_getenv('appdata')
+ if appdata_dir:
+ userConfFile = os.path.join(appdata_dir, package_name, 'config')
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is None:
+ userConfFile += '.txt'
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
+ # home
+ userConfFile = os.path.join(compat_expanduser('~'), '%s.conf' % package_name)
+ userConf = _readOptions(userConfFile, default=None)
if userConf is None:
- userConf = _readOptions(
- os.path.join(compat_expanduser('~'), 'hypervideo.conf'),
- default=None)
- if userConf is None:
- userConf = _readOptions(
- os.path.join(compat_expanduser('~'), 'hypervideo.conf.txt'),
- default=None)
+ userConfFile += '.txt'
+ userConf = _readOptions(userConfFile, default=None)
+ if userConf is not None:
+ return userConf, userConfFile
- if userConf is None:
- userConf = []
-
- return userConf
+ return default, None
def _format_option_string(option):
''' ('-o', '--option') -> -o, --format METAVAR'''
@@ -108,13 +117,69 @@ def parseOpts(overrideArguments=None):
return ''.join(opts)
- def _comma_separated_values_options_callback(option, opt_str, value, parser):
- setattr(parser.values, option.dest, value.split(','))
+ def _list_from_options_callback(option, opt_str, value, parser, append=True, delim=',', process=str.strip):
+ # append can be True, False or -1 (prepend)
+ current = getattr(parser.values, option.dest) if append else []
+ value = list(filter(None, [process(value)] if delim is None else map(process, value.split(delim))))
+ setattr(
+ parser.values, option.dest,
+ current + value if append is True else value + current)
+
+ def _set_from_options_callback(
+ option, opt_str, value, parser, delim=',', allowed_values=None, aliases={},
+ process=lambda x: x.lower().strip()):
+ current = getattr(parser.values, option.dest)
+ values = [process(value)] if delim is None else list(map(process, value.split(delim)[::-1]))
+ while values:
+ actual_val = val = values.pop()
+ if val == 'all':
+ current.update(allowed_values)
+ elif val == '-all':
+ current = set()
+ elif val in aliases:
+ values.extend(aliases[val])
+ else:
+ if val[0] == '-':
+ val = val[1:]
+ current.discard(val)
+ else:
+ current.update([val])
+ if allowed_values is not None and val not in allowed_values:
+ raise optparse.OptionValueError(f'wrong {option.metavar} for {opt_str}: {actual_val}')
+
+ setattr(parser.values, option.dest, current)
+
+ def _dict_from_options_callback(
+ option, opt_str, value, parser,
+ allowed_keys=r'[\w-]+', delimiter=':', default_key=None, process=None, multiple_keys=True):
+
+ out_dict = getattr(parser.values, option.dest)
+ if multiple_keys:
+ allowed_keys = r'(%s)(,(%s))*' % (allowed_keys, allowed_keys)
+ mobj = re.match(r'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys, delimiter), value)
+ if mobj is not None:
+ keys = [k.strip() for k in mobj.group('keys').lower().split(',')]
+ val = mobj.group('val')
+ elif default_key is not None:
+ keys, val = [default_key], value
+ else:
+ raise optparse.OptionValueError(
+ 'wrong %s formatting; it should be %s, not "%s"' % (opt_str, option.metavar, value))
+ try:
+ val = process(val) if process else val
+ except Exception as err:
+ raise optparse.OptionValueError(
+ 'wrong %s formatting; %s' % (opt_str, err))
+ for key in keys:
+ out_dict[key] = val
# No need to wrap help messages if we're on a wide console
columns = compat_get_terminal_size().columns
max_width = columns if columns else 80
- max_help_position = 80
+ # 47% is chosen because that is how README.md is currently formatted
+ # and moving help text even further to the right is undesirable.
+ # This can be reduced in the future to get a prettier output
+ max_help_position = int(0.47 * max_width)
fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
fmt.format_option_strings = _format_option_string
@@ -139,24 +204,28 @@ def parseOpts(overrideArguments=None):
help='Print program version and exit')
general.add_option(
'-i', '--ignore-errors',
- action='store_true', dest='ignoreerrors', default=False,
- help='Continue on download errors, for example to skip unavailable videos in a playlist')
+ action='store_true', dest='ignoreerrors',
+ help='Ignore download and postprocessing errors. The download will be considered successfull even if the postprocessing fails')
+ general.add_option(
+ '--no-abort-on-error',
+ action='store_const', dest='ignoreerrors', const='only_download',
+ help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
general.add_option(
- '--abort-on-error',
+ '--abort-on-error', '--no-ignore-errors',
action='store_false', dest='ignoreerrors',
- help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
+ help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
general.add_option(
'--dump-user-agent',
action='store_true', dest='dump_user_agent', default=False,
- help='Display the current browser identification')
+ help='Display the current user-agent and exit')
general.add_option(
'--list-extractors',
action='store_true', dest='list_extractors', default=False,
- help='List all supported extractors')
+ help='List all supported extractors and exit')
general.add_option(
'--extractor-descriptions',
action='store_true', dest='list_extractor_descriptions', default=False,
- help='Output descriptions of all supported extractors')
+ help='Output descriptions of all supported extractors and exit')
general.add_option(
'--force-generic-extractor',
action='store_true', dest='force_generic_extractor', default=False,
@@ -164,45 +233,67 @@ def parseOpts(overrideArguments=None):
general.add_option(
'--default-search',
dest='default_search', metavar='PREFIX',
- help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for hypervideo "large apple". Use the value "auto" to let hypervideo guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.')
+ help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for the search term "large apple". Use the value "auto" to let hypervideo guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching')
general.add_option(
- '--ignore-config',
- action='store_true',
- help='Do not read configuration files. '
- 'When given in the global configuration file /etc/hypervideo.conf: '
- 'Do not read the user configuration in ~/.config/hypervideo/config '
- '(%APPDATA%/hypervideo/config.txt on Windows)')
+ '--ignore-config', '--no-config',
+ action='store_true', dest='ignoreconfig',
+ help=(
+ 'Disable loading any configuration files except the one provided by --config-location. '
+ 'When given inside a configuration file, no further configuration files are loaded. '
+ 'Additionally, (for backward compatibility) if this option is found inside the '
+ 'system configuration file, the user configuration is not loaded'))
general.add_option(
'--config-location',
dest='config_location', metavar='PATH',
- help='Location of the configuration file; either the path to the config or its containing directory.')
+ help='Location of the main configuration file; either the path to the config or its containing directory')
general.add_option(
'--flat-playlist',
- action='store_const', dest='extract_flat', const='in_playlist',
- default=False,
- help='Do not extract the videos of a playlist, only list them.')
+ action='store_const', dest='extract_flat', const='in_playlist', default=False,
+ help='Do not extract the videos of a playlist, only list them')
+ general.add_option(
+ '--no-flat-playlist',
+ action='store_false', dest='extract_flat',
+ help='Extract the videos of a playlist')
general.add_option(
'--mark-watched',
action='store_true', dest='mark_watched', default=False,
- help='Mark videos watched (YouTube only)')
+ help='Mark videos watched (even with --simulate). Currently only supported for YouTube')
general.add_option(
'--no-mark-watched',
- action='store_false', dest='mark_watched', default=False,
- help='Do not mark videos watched (YouTube only)')
+ action='store_false', dest='mark_watched',
+ help='Do not mark videos watched (default)')
general.add_option(
- '--no-color', '--no-colors',
- action='store_true', dest='no_color',
- default=False,
+ '--no-colors',
+ action='store_true', dest='no_color', default=False,
help='Do not emit color codes in output')
+ general.add_option(
+ '--compat-options',
+ metavar='OPTS', dest='compat_opts', default=set(), type='str',
+ action='callback', callback=_set_from_options_callback,
+ callback_kwargs={
+ 'allowed_values': {
+ 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
+ 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
+ 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json',
+ 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
+ }, 'aliases': {
+ 'youtube-dl': ['-multistreams', 'all'],
+ 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
+ }
+ }, help=(
+ 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
+ 'configurations by reverting some of the changes made in hypervideo. '
+ 'See "Differences in default behavior" for details'))
network = optparse.OptionGroup(parser, 'Network Options')
network.add_option(
'--proxy', dest='proxy',
default=None, metavar='URL',
- help='Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
- 'SOCKS proxy, specify a proper scheme. For example '
- 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
- 'for direct connection')
+ help=(
+ 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
+ 'SOCKS proxy, specify a proper scheme. For example '
+ 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
+ 'for direct connection'))
network.add_option(
'--socket-timeout',
dest='socket_timeout', type=float, default=None, metavar='SECONDS',
@@ -223,12 +314,13 @@ def parseOpts(overrideArguments=None):
help='Make all connections via IPv6',
)
- geo = optparse.OptionGroup(parser, 'Geo Restriction')
+ geo = optparse.OptionGroup(parser, 'Geo-restriction')
geo.add_option(
'--geo-verification-proxy',
dest='geo_verification_proxy', default=None, metavar='URL',
- help='Use this proxy to verify the IP address for some geo-restricted sites. '
- 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading.')
+ help=(
+ 'Use this proxy to verify the IP address for some geo-restricted sites. '
+ 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
geo.add_option(
'--cn-verification-proxy',
dest='cn_verification_proxy', default=None, metavar='URL',
@@ -262,15 +354,15 @@ def parseOpts(overrideArguments=None):
selection.add_option(
'--playlist-items',
dest='playlist_items', metavar='ITEM_SPEC', default=None,
- help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.')
+ help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13')
selection.add_option(
'--match-title',
dest='matchtitle', metavar='REGEX',
- help='Download only matching titles (regex or caseless sub-string)')
+ help=optparse.SUPPRESS_HELP)
selection.add_option(
'--reject-title',
dest='rejecttitle', metavar='REGEX',
- help='Skip download for matching titles (regex or caseless sub-string)')
+ help=optparse.SUPPRESS_HELP)
selection.add_option(
'--max-downloads',
dest='max_downloads', metavar='NUMBER', type=int, default=None,
@@ -286,52 +378,57 @@ def parseOpts(overrideArguments=None):
selection.add_option(
'--date',
metavar='DATE', dest='date', default=None,
- help='Download only videos uploaded in this date')
+ help=(
+ 'Download only videos uploaded in this date. '
+ 'The date can be "YYYYMMDD" or in the format '
+ '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
selection.add_option(
'--datebefore',
metavar='DATE', dest='datebefore', default=None,
- help='Download only videos uploaded on or before this date (i.e. inclusive)')
+ help=(
+ 'Download only videos uploaded on or before this date. '
+ 'The date formats accepted is the same as --date'))
selection.add_option(
'--dateafter',
metavar='DATE', dest='dateafter', default=None,
- help='Download only videos uploaded on or after this date (i.e. inclusive)')
+ help=(
+ 'Download only videos uploaded on or after this date. '
+ 'The date formats accepted is the same as --date'))
selection.add_option(
'--min-views',
metavar='COUNT', dest='min_views', default=None, type=int,
- help='Do not download any videos with less than COUNT views')
+ help=optparse.SUPPRESS_HELP)
selection.add_option(
'--max-views',
metavar='COUNT', dest='max_views', default=None, type=int,
- help='Do not download any videos with more than COUNT views')
+ help=optparse.SUPPRESS_HELP)
selection.add_option(
'--match-filter',
metavar='FILTER', dest='match_filter', default=None,
help=(
- 'Generic video filter. '
- 'Specify any key (see the "OUTPUT TEMPLATE" for a list of available keys) to '
- 'match if the key is present, '
- '!key to check if the key is not present, '
- 'key > NUMBER (like "comment_count > 12", also works with '
- '>=, <, <=, !=, =) to compare against a number, '
- 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
- 'to match against a string literal '
- 'and & to require multiple matches. '
- 'Values which are not known are excluded unless you '
- 'put a question mark (?) after the operator. '
- 'For example, to only match videos that have been liked more than '
- '100 times and disliked less than 50 times (or the dislike '
- 'functionality is not available at the given service), but who '
- 'also have a description, use --match-filter '
- '"like_count > 100 & dislike_count <? 50 & description" .'
- ))
+ 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
+ 'number or a string using the operators defined in "Filtering formats". '
+ 'You can also simply specify a field to match if the field is present '
+ 'and "!field" to check if the field is not present. In addition, '
+ 'Python style regular expression matching can be done using "~=", '
+ 'and multiple filters can be checked with "&". '
+ 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
+ '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
+ 'matches only videos that are not live, has a like count more than 100 '
+ '(or the like field is not available), and also has a description '
+ 'that contains the phrase "cats & dogs" (ignoring case)'))
+ selection.add_option(
+ '--no-match-filter',
+ metavar='FILTER', dest='match_filter', action='store_const', const=None,
+ help='Do not use generic video filter (default)')
selection.add_option(
'--no-playlist',
action='store_true', dest='noplaylist', default=False,
- help='Download only the video, if the URL refers to a video and a playlist.')
+ help='Download only the video, if the URL refers to a video and a playlist')
selection.add_option(
'--yes-playlist',
- action='store_false', dest='noplaylist', default=False,
- help='Download the playlist, if the URL refers to a video and a playlist.')
+ action='store_false', dest='noplaylist',
+ help='Download the playlist, if the URL refers to a video and a playlist')
selection.add_option(
'--age-limit',
metavar='YEARS', dest='age_limit', default=None, type=int,
@@ -339,11 +436,31 @@ def parseOpts(overrideArguments=None):
selection.add_option(
'--download-archive', metavar='FILE',
dest='download_archive',
- help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
+ help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
+ selection.add_option(
+ '--break-on-existing',
+ action='store_true', dest='break_on_existing', default=False,
+ help='Stop the download process when encountering a file that is in the archive')
+ selection.add_option(
+ '--break-on-reject',
+ action='store_true', dest='break_on_reject', default=False,
+ help='Stop the download process when encountering a file that has been filtered out')
+ selection.add_option(
+ '--skip-playlist-after-errors', metavar='N',
+ dest='skip_playlist_after_errors', default=None, type=int,
+ help='Number of allowed failures until the rest of the playlist is skipped')
+ selection.add_option(
+ '--no-download-archive',
+ dest='download_archive', action="store_const", const=None,
+ help='Do not use archive file (default)')
selection.add_option(
'--include-ads',
dest='include_ads', action='store_true',
- help='Download advertisements as well (experimental)')
+ help=optparse.SUPPRESS_HELP)
+ selection.add_option(
+ '--no-include-ads',
+ dest='include_ads', action='store_false',
+ help=optparse.SUPPRESS_HELP)
authentication = optparse.OptionGroup(parser, 'Authentication Options')
authentication.add_option(
@@ -353,7 +470,7 @@ def parseOpts(overrideArguments=None):
authentication.add_option(
'-p', '--password',
dest='password', metavar='PASSWORD',
- help='Account password. If this option is left out, hypervideo will ask interactively.')
+ help='Account password. If this option is left out, hypervideo will ask interactively')
authentication.add_option(
'-2', '--twofactor',
dest='twofactor', metavar='TWOFACTOR',
@@ -363,24 +480,26 @@ def parseOpts(overrideArguments=None):
action='store_true', dest='usenetrc', default=False,
help='Use .netrc authentication data')
authentication.add_option(
+ '--netrc-location',
+ dest='netrc_location', metavar='PATH',
+ help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
+ authentication.add_option(
'--video-password',
dest='videopassword', metavar='PASSWORD',
help='Video password (vimeo, youku)')
-
- adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
- adobe_pass.add_option(
+ authentication.add_option(
'--ap-mso',
dest='ap_mso', metavar='MSO',
help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
- adobe_pass.add_option(
+ authentication.add_option(
'--ap-username',
dest='ap_username', metavar='USERNAME',
help='Multiple-system operator account login')
- adobe_pass.add_option(
+ authentication.add_option(
'--ap-password',
dest='ap_password', metavar='PASSWORD',
- help='Multiple-system operator account password. If this option is left out, hypervideo will ask interactively.')
- adobe_pass.add_option(
+ help='Multiple-system operator account password. If this option is left out, hypervideo will ask interactively')
+ authentication.add_option(
'--ap-list-mso',
action='store_true', dest='ap_list_mso', default=False,
help='List all supported multiple-system operators')
@@ -389,27 +508,74 @@ def parseOpts(overrideArguments=None):
video_format.add_option(
'-f', '--format',
action='store', dest='format', metavar='FORMAT', default=None,
- help='Video format code, see the "FORMAT SELECTION" for all the info')
+ help='Video format code, see "FORMAT SELECTION" for more details')
+ video_format.add_option(
+ '-S', '--format-sort', metavar='SORTORDER',
+ dest='format_sort', default=[], type='str', action='callback',
+ callback=_list_from_options_callback, callback_kwargs={'append': -1},
+ help='Sort the formats by the fields given, see "Sorting Formats" for more details')
+ video_format.add_option(
+ '--format-sort-force', '--S-force',
+ action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
+ help=(
+ 'Force user specified sort order to have precedence over all fields, '
+ 'see "Sorting Formats" for more details'))
+ video_format.add_option(
+ '--no-format-sort-force',
+ action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
+ help=(
+ 'Some fields have precedence over the user specified sort order (default), '
+ 'see "Sorting Formats" for more details'))
+ video_format.add_option(
+ '--video-multistreams',
+ action='store_true', dest='allow_multiple_video_streams', default=None,
+ help='Allow multiple video streams to be merged into a single file')
+ video_format.add_option(
+ '--no-video-multistreams',
+ action='store_false', dest='allow_multiple_video_streams',
+ help='Only one video stream is downloaded for each output file (default)')
+ video_format.add_option(
+ '--audio-multistreams',
+ action='store_true', dest='allow_multiple_audio_streams', default=None,
+ help='Allow multiple audio streams to be merged into a single file')
+ video_format.add_option(
+ '--no-audio-multistreams',
+ action='store_false', dest='allow_multiple_audio_streams',
+ help='Only one audio stream is downloaded for each output file (default)')
video_format.add_option(
'--all-formats',
action='store_const', dest='format', const='all',
- help='Download all available video formats')
+ help=optparse.SUPPRESS_HELP)
video_format.add_option(
'--prefer-free-formats',
action='store_true', dest='prefer_free_formats', default=False,
- help='Prefer free video formats unless a specific one is requested')
+ help=(
+ 'Prefer video formats with free containers over non-free ones of same quality. '
+ 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
+ video_format.add_option(
+ '--no-prefer-free-formats',
+ action='store_false', dest='prefer_free_formats', default=False,
+ help="Don't give any special preference to free containers (default)")
+ video_format.add_option(
+ '--check-formats',
+ action='store_true', dest='check_formats', default=None,
+ help='Check that the formats selected are actually downloadable')
+ video_format.add_option(
+ '--no-check-formats',
+ action='store_false', dest='check_formats',
+ help='Do not check that the formats selected are actually downloadable')
video_format.add_option(
'-F', '--list-formats',
action='store_true', dest='listformats',
- help='List all available formats of requested videos')
+ help='List available formats of each video. Simulate unless --no-simulate is used')
video_format.add_option(
- '--youtube-include-dash-manifest',
- action='store_true', dest='youtube_include_dash_manifest', default=True,
+ '--list-formats-as-table',
+ action='store_true', dest='listformats_table', default=True,
help=optparse.SUPPRESS_HELP)
video_format.add_option(
- '--youtube-skip-dash-manifest',
- action='store_false', dest='youtube_include_dash_manifest',
- help='Do not download the DASH manifests and related data on YouTube videos')
+ '--list-formats-old', '--no-list-formats-as-table',
+ action='store_false', dest='listformats_table',
+ help=optparse.SUPPRESS_HELP)
video_format.add_option(
'--merge-output-format',
action='store', dest='merge_output_format', metavar='FORMAT', default=None,
@@ -417,72 +583,108 @@ def parseOpts(overrideArguments=None):
'If a merge is required (e.g. bestvideo+bestaudio), '
'output to given container format. One of mkv, mp4, ogg, webm, flv. '
'Ignored if no merge is required'))
+ video_format.add_option(
+ '--allow-unplayable-formats',
+ action='store_true', dest='allow_unplayable_formats', default=False,
+ help=optparse.SUPPRESS_HELP)
+ video_format.add_option(
+ '--no-allow-unplayable-formats',
+ action='store_false', dest='allow_unplayable_formats',
+ help=optparse.SUPPRESS_HELP)
subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
subtitles.add_option(
- '--write-sub', '--write-srt',
+ '--write-subs', '--write-srt',
action='store_true', dest='writesubtitles', default=False,
help='Write subtitle file')
subtitles.add_option(
- '--write-auto-sub', '--write-automatic-sub',
+ '--no-write-subs', '--no-write-srt',
+ action='store_false', dest='writesubtitles',
+ help='Do not write subtitle file (default)')
+ subtitles.add_option(
+ '--write-auto-subs', '--write-automatic-subs',
action='store_true', dest='writeautomaticsub', default=False,
- help='Write automatically generated subtitle file (YouTube only)')
+ help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
+ subtitles.add_option(
+ '--no-write-auto-subs', '--no-write-automatic-subs',
+ action='store_false', dest='writeautomaticsub', default=False,
+ help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
subtitles.add_option(
'--all-subs',
action='store_true', dest='allsubtitles', default=False,
- help='Download all the available subtitles of the video')
+ help=optparse.SUPPRESS_HELP)
subtitles.add_option(
'--list-subs',
action='store_true', dest='listsubtitles', default=False,
- help='List all available subtitles for the video')
+ help='List available subtitles of each video. Simulate unless --no-simulate is used')
subtitles.add_option(
'--sub-format',
action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
subtitles.add_option(
- '--sub-lang', '--sub-langs', '--srt-lang',
+ '--sub-langs', '--srt-langs',
action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
- default=[], callback=_comma_separated_values_options_callback,
- help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
+ default=[], callback=_list_from_options_callback,
+ help=(
+ 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) '
+ 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
+ 'Use --list-subs for a list of available language tags'))
downloader = optparse.OptionGroup(parser, 'Download Options')
downloader.add_option(
+ '-N', '--concurrent-fragments',
+ dest='concurrent_fragment_downloads', metavar='N', default=1, type=int,
+ help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
+ downloader.add_option(
'-r', '--limit-rate', '--rate-limit',
dest='ratelimit', metavar='RATE',
help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
downloader.add_option(
+ '--throttled-rate',
+ dest='throttledratelimit', metavar='RATE',
+ help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
+ downloader.add_option(
'-R', '--retries',
dest='retries', metavar='RETRIES', default=10,
- help='Number of retries (default is %default), or "infinite".')
+ help='Number of retries (default is %default), or "infinite"')
downloader.add_option(
'--fragment-retries',
dest='fragment_retries', metavar='RETRIES', default=10,
help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
downloader.add_option(
- '--skip-unavailable-fragments',
+ '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
action='store_true', dest='skip_unavailable_fragments', default=True,
- help='Skip unavailable fragments (DASH, hlsnative and ISM)')
+ help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
downloader.add_option(
- '--abort-on-unavailable-fragment',
+ '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
action='store_false', dest='skip_unavailable_fragments',
- help='Abort downloading when some fragment is not available')
+ help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
downloader.add_option(
'--keep-fragments',
action='store_true', dest='keep_fragments', default=False,
- help='Keep downloaded fragments on disk after downloading is finished; fragments are erased by default')
+ help='Keep downloaded fragments on disk after downloading is finished')
+ downloader.add_option(
+ '--no-keep-fragments',
+ action='store_false', dest='keep_fragments',
+ help='Delete downloaded fragments after downloading is finished (default)')
downloader.add_option(
'--buffer-size',
dest='buffersize', metavar='SIZE', default='1024',
help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
downloader.add_option(
+ '--resize-buffer',
+ action='store_false', dest='noresizebuffer',
+ help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
+ downloader.add_option(
'--no-resize-buffer',
action='store_true', dest='noresizebuffer', default=False,
- help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
+ help='Do not automatically adjust the buffer size')
downloader.add_option(
'--http-chunk-size',
dest='http_chunk_size', metavar='SIZE', default=None,
- help='Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
- 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)')
+ help=(
+ 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
+ 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
downloader.add_option(
'--test',
action='store_true', dest='test', default=False,
@@ -492,6 +694,10 @@ def parseOpts(overrideArguments=None):
action='store_true',
help='Download playlist videos in reverse order')
downloader.add_option(
+ '--no-playlist-reverse',
+ action='store_false', dest='playlist_reverse',
+ help='Download playlist videos in default order (default)')
+ downloader.add_option(
'--playlist-random',
action='store_true',
help='Download playlist videos in random order')
@@ -502,25 +708,55 @@ def parseOpts(overrideArguments=None):
downloader.add_option(
'--hls-prefer-native',
dest='hls_prefer_native', action='store_true', default=None,
- help='Use the native HLS downloader instead of ffmpeg')
+ help=optparse.SUPPRESS_HELP)
downloader.add_option(
'--hls-prefer-ffmpeg',
dest='hls_prefer_native', action='store_false', default=None,
- help='Use ffmpeg instead of the native HLS downloader')
+ help=optparse.SUPPRESS_HELP)
downloader.add_option(
'--hls-use-mpegts',
- dest='hls_use_mpegts', action='store_true',
- help='Use the mpegts container for HLS videos, allowing to play the '
- 'video while downloading (some players may not be able to play it)')
+ dest='hls_use_mpegts', action='store_true', default=None,
+ help=(
+ 'Use the mpegts container for HLS videos; '
+ 'allowing some players to play the video while downloading, '
+ 'and reducing the chance of file corruption if download is interrupted. '
+ 'This is enabled by default for live streams'))
+ downloader.add_option(
+ '--no-hls-use-mpegts',
+ dest='hls_use_mpegts', action='store_false',
+ help=(
+ 'Do not use the mpegts container for HLS videos. '
+ 'This is default when not downloading live streams'))
downloader.add_option(
- '--external-downloader',
- dest='external_downloader', metavar='COMMAND',
- help='Use the specified external downloader. '
- 'Currently supports %s' % ','.join(list_external_downloaders()))
+ '--downloader', '--external-downloader',
+ dest='external_downloader', metavar='[PROTO:]NAME', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
+ 'default_key': 'default',
+ 'process': str.strip
+ }, help=(
+ 'Name or path of the external downloader to use (optionally) prefixed by '
+ 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
+ 'Currently supports native, %s (Recommended: aria2c). '
+ 'You can use this option multiple times to set different downloaders for different protocols. '
+ 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
+ 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
+ '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
downloader.add_option(
- '--external-downloader-args',
- dest='external_downloader_args', metavar='ARGS',
- help='Give these arguments to the external downloader')
+ '--downloader-args', '--external-downloader-args',
+ metavar='NAME:ARGS', dest='external_downloader_args', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': r'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()),
+ 'default_key': 'default',
+ 'process': compat_shlex_split
+ }, help=(
+ 'Give these arguments to the external downloader. '
+ 'Specify the downloader name and the arguments separated by a colon ":". '
+ 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
+ 'You can use this option multiple times to give different arguments to different downloaders '
+ '(Alias: --external-downloader-args)'))
workarounds = optparse.OptionGroup(parser, 'Workarounds')
workarounds.add_option(
@@ -528,13 +764,13 @@ def parseOpts(overrideArguments=None):
dest='encoding', metavar='ENCODING',
help='Force the specified encoding (experimental)')
workarounds.add_option(
- '--no-check-certificate',
+ '--no-check-certificates',
action='store_true', dest='no_check_certificate', default=False,
help='Suppress HTTPS certificate validation')
workarounds.add_option(
- '--prefer-insecure',
- '--prefer-unsecure', action='store_true', dest='prefer_insecure',
- help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
+ '--prefer-insecure', '--prefer-unsecure',
+ action='store_true', dest='prefer_insecure',
+ help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
workarounds.add_option(
'--user-agent',
metavar='UA', dest='user_agent',
@@ -546,104 +782,155 @@ def parseOpts(overrideArguments=None):
)
workarounds.add_option(
'--add-header',
- metavar='FIELD:VALUE', dest='headers', action='append',
- help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
+ metavar='FIELD:VALUE', dest='headers', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={'multiple_keys': False},
+ help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
)
workarounds.add_option(
'--bidi-workaround',
dest='bidi_workaround', action='store_true',
help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
workarounds.add_option(
+ '--sleep-requests', metavar='SECONDS',
+ dest='sleep_interval_requests', type=float,
+ help='Number of seconds to sleep between requests during data extraction')
+ workarounds.add_option(
'--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
dest='sleep_interval', type=float,
help=(
- 'Number of seconds to sleep before each download when used alone '
- 'or a lower bound of a range for randomized sleep before each download '
- '(minimum possible number of seconds to sleep) when used along with '
- '--max-sleep-interval.'))
+ 'Number of seconds to sleep before each download. '
+ 'This is the minimum time to sleep when used along with --max-sleep-interval '
+ '(Alias: --min-sleep-interval)'))
workarounds.add_option(
'--max-sleep-interval', metavar='SECONDS',
dest='max_sleep_interval', type=float,
- help=(
- 'Upper bound of a range for randomized sleep before each download '
- '(maximum possible number of seconds to sleep). Must only be used '
- 'along with --min-sleep-interval.'))
+ help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
+ workarounds.add_option(
+ '--sleep-subtitles', metavar='SECONDS',
+ dest='sleep_interval_subtitles', default=0, type=int,
+ help='Number of seconds to sleep before each subtitle download')
- verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
+ verbosity = optparse.OptionGroup(parser, 'Verbosity and Simulation Options')
verbosity.add_option(
'-q', '--quiet',
action='store_true', dest='quiet', default=False,
- help='Activate quiet mode')
+ help='Activate quiet mode. If used with --verbose, print the log to stderr')
verbosity.add_option(
'--no-warnings',
dest='no_warnings', action='store_true', default=False,
help='Ignore warnings')
verbosity.add_option(
'-s', '--simulate',
- action='store_true', dest='simulate', default=False,
+ action='store_true', dest='simulate', default=None,
help='Do not download the video and do not write anything to disk')
verbosity.add_option(
- '--skip-download',
+ '--no-simulate',
+ action='store_false', dest='simulate',
+ help='Download the video even if printing/listing options are used')
+ verbosity.add_option(
+ '--ignore-no-formats-error',
+ action='store_true', dest='ignore_no_formats_error', default=False,
+ help=(
+ 'Ignore "No video formats" error. Usefull for extracting metadata '
+ 'even if the videos are not actually available for download (experimental)'))
+ verbosity.add_option(
+ '--no-ignore-no-formats-error',
+ action='store_false', dest='ignore_no_formats_error',
+ help='Throw error when no downloadable video formats are found (default)')
+ verbosity.add_option(
+ '--skip-download', '--no-download',
action='store_true', dest='skip_download', default=False,
- help='Do not download the video')
+ help='Do not download the video but write all related files (Alias: --no-download)')
+ verbosity.add_option(
+ '-O', '--print',
+ metavar='TEMPLATE', action='append', dest='forceprint',
+ help=(
+ 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. '
+ 'Either a field name or same syntax as the output template can be used'))
verbosity.add_option(
'-g', '--get-url',
action='store_true', dest='geturl', default=False,
- help='Simulate, quiet but print URL')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'-e', '--get-title',
action='store_true', dest='gettitle', default=False,
- help='Simulate, quiet but print title')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-id',
action='store_true', dest='getid', default=False,
- help='Simulate, quiet but print id')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-thumbnail',
action='store_true', dest='getthumbnail', default=False,
- help='Simulate, quiet but print thumbnail URL')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-description',
action='store_true', dest='getdescription', default=False,
- help='Simulate, quiet but print video description')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-duration',
action='store_true', dest='getduration', default=False,
- help='Simulate, quiet but print video length')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-filename',
action='store_true', dest='getfilename', default=False,
- help='Simulate, quiet but print output filename')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--get-format',
action='store_true', dest='getformat', default=False,
- help='Simulate, quiet but print output format')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'-j', '--dump-json',
action='store_true', dest='dumpjson', default=False,
- help='Simulate, quiet but print JSON information. See the "OUTPUT TEMPLATE" for a description of available keys.')
+ help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
verbosity.add_option(
'-J', '--dump-single-json',
action='store_true', dest='dump_single_json', default=False,
- help='Simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
+ help=(
+ 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
+ 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
verbosity.add_option(
'--print-json',
action='store_true', dest='print_json', default=False,
- help='Be quiet and print the video information as JSON (video is still being downloaded).',
- )
+ help=optparse.SUPPRESS_HELP)
+ verbosity.add_option(
+ '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
+ action='store_true', dest='force_write_download_archive', default=False,
+ help=(
+ 'Force download archive entries to be written as far as no errors occur, '
+ 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
verbosity.add_option(
'--newline',
action='store_true', dest='progress_with_newline', default=False,
help='Output progress bar as new lines')
verbosity.add_option(
'--no-progress',
- action='store_true', dest='noprogress', default=False,
+ action='store_true', dest='noprogress', default=None,
help='Do not print progress bar')
verbosity.add_option(
+ '--progress',
+ action='store_false', dest='noprogress',
+ help='Show progress bar, even if in quiet mode')
+ verbosity.add_option(
'--console-title',
action='store_true', dest='consoletitle', default=False,
help='Display progress in console titlebar')
verbosity.add_option(
+ '--progress-template',
+ metavar='[TYPES:]TEMPLATE', dest='progress_template', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': '(download|postprocess)(-title)?',
+ 'default_key': 'download'
+ }, help=(
+ 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
+ '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
+ 'The video\'s fields are accessible under the "info" key and '
+ 'the progress attributes are accessible under "progress" key. Eg: '
+ # TODO: Document the fields inside "progress"
+ '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
+ verbosity.add_option(
'-v', '--verbose',
action='store_true', dest='verbose', default=False,
help='Print various debugging information')
@@ -666,29 +953,47 @@ def parseOpts(overrideArguments=None):
verbosity.add_option(
'-C', '--call-home',
dest='call_home', action='store_true', default=False,
- help='Contact the hypervideo server for debugging')
+ # help='[Broken] Contact the hypervideo server for debugging')
+ help=optparse.SUPPRESS_HELP)
verbosity.add_option(
'--no-call-home',
- dest='call_home', action='store_false', default=False,
- help='Do NOT contact the hypervideo server for debugging')
+ dest='call_home', action='store_false',
+ # help='Do not contact the hypervideo server for debugging (default)')
+ help=optparse.SUPPRESS_HELP)
filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
filesystem.add_option(
'-a', '--batch-file',
dest='batchfile', metavar='FILE',
help="File containing URLs to download ('-' for stdin), one URL per line. "
- "Lines starting with '#', ';' or ']' are considered as comments and ignored.")
+ "Lines starting with '#', ';' or ']' are considered as comments and ignored")
filesystem.add_option(
- '--id', default=False,
- action='store_true', dest='useid', help='Use only video ID in file name')
+ '-P', '--paths',
+ metavar='[TYPES:]PATH', dest='paths', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES.keys()),
+ 'default_key': 'home'
+ }, help=(
+ 'The paths where the files should be downloaded. '
+ 'Specify the type of file and the path separated by a colon ":". '
+ 'All the same types as --output are supported. '
+ 'Additionally, you can also provide "home" (default) and "temp" paths. '
+ 'All intermediary files are first downloaded to the temp path and '
+ 'then the final files are moved over to the home path after download is finished. '
+ 'This option is ignored if --output is an absolute path'))
filesystem.add_option(
'-o', '--output',
- dest='outtmpl', metavar='TEMPLATE',
- help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info'))
+ metavar='[TYPES:]TEMPLATE', dest='outtmpl', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': '|'.join(OUTTMPL_TYPES.keys()),
+ 'default_key': 'default'
+ }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
filesystem.add_option(
'--output-na-placeholder',
- dest='outtmpl_na_placeholder', metavar='PLACEHOLDER', default='NA',
- help=('Placeholder value for unavailable meta fields in output filename template (default is "%default")'))
+ dest='outtmpl_na_placeholder', metavar='TEXT', default='NA',
+ help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
filesystem.add_option(
'--autonumber-size',
dest='autonumber_size', metavar='NUMBER', type=int,
@@ -696,55 +1001,119 @@ def parseOpts(overrideArguments=None):
filesystem.add_option(
'--autonumber-start',
dest='autonumber_start', metavar='NUMBER', default=1, type=int,
- help='Specify the start value for %(autonumber)s (default is %default)')
+ help=optparse.SUPPRESS_HELP)
filesystem.add_option(
'--restrict-filenames',
action='store_true', dest='restrictfilenames', default=False,
help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
filesystem.add_option(
- '-A', '--auto-number',
- action='store_true', dest='autonumber', default=False,
- help=optparse.SUPPRESS_HELP)
+ '--no-restrict-filenames',
+ action='store_false', dest='restrictfilenames',
+ help='Allow Unicode characters, "&" and spaces in filenames (default)')
filesystem.add_option(
- '-t', '--title',
- action='store_true', dest='usetitle', default=False,
- help=optparse.SUPPRESS_HELP)
+ '--windows-filenames',
+ action='store_true', dest='windowsfilenames', default=False,
+ help='Force filenames to be windows compatible')
filesystem.add_option(
- '-l', '--literal', default=False,
- action='store_true', dest='usetitle',
- help=optparse.SUPPRESS_HELP)
+ '--no-windows-filenames',
+ action='store_false', dest='windowsfilenames',
+ help='Make filenames windows compatible only if using windows (default)')
+ filesystem.add_option(
+ '--trim-filenames', '--trim-file-names', metavar='LENGTH',
+ dest='trim_file_name', default=0, type=int,
+ help='Limit the filename length (excluding extension) to the specified number of characters')
filesystem.add_option(
'-w', '--no-overwrites',
- action='store_true', dest='nooverwrites', default=False,
- help='Do not overwrite files')
+ action='store_false', dest='overwrites', default=None,
+ help='Do not overwrite any files')
+ filesystem.add_option(
+ '--force-overwrites', '--yes-overwrites',
+ action='store_true', dest='overwrites',
+ help='Overwrite all video and metadata files. This option includes --no-continue')
+ filesystem.add_option(
+ '--no-force-overwrites',
+ action='store_const', dest='overwrites', const=None,
+ help='Do not overwrite the video, but overwrite related files (default)')
filesystem.add_option(
'-c', '--continue',
action='store_true', dest='continue_dl', default=True,
- help='Force resume of partially downloaded files. By default, hypervideo will resume downloads if possible.')
+ help='Resume partially downloaded files/fragments (default)')
filesystem.add_option(
'--no-continue',
action='store_false', dest='continue_dl',
- help='Do not resume partially downloaded files (restart from beginning)')
+ help=(
+ 'Do not resume partially downloaded fragments. '
+ 'If the file is not fragmented, restart download of the entire file'))
+ filesystem.add_option(
+ '--part',
+ action='store_false', dest='nopart', default=False,
+ help='Use .part files instead of writing directly into output file (default)')
filesystem.add_option(
'--no-part',
- action='store_true', dest='nopart', default=False,
+ action='store_true', dest='nopart',
help='Do not use .part files - write directly into output file')
filesystem.add_option(
+ '--mtime',
+ action='store_true', dest='updatetime', default=True,
+ help='Use the Last-modified header to set the file modification time (default)')
+ filesystem.add_option(
'--no-mtime',
- action='store_false', dest='updatetime', default=True,
+ action='store_false', dest='updatetime',
help='Do not use the Last-modified header to set the file modification time')
filesystem.add_option(
'--write-description',
action='store_true', dest='writedescription', default=False,
help='Write video description to a .description file')
filesystem.add_option(
+ '--no-write-description',
+ action='store_false', dest='writedescription',
+ help='Do not write video description (default)')
+ filesystem.add_option(
'--write-info-json',
action='store_true', dest='writeinfojson', default=False,
- help='Write video metadata to a .info.json file')
+ help='Write video metadata to a .info.json file (this may contain personal information)')
+ filesystem.add_option(
+ '--no-write-info-json',
+ action='store_false', dest='writeinfojson',
+ help='Do not write video metadata (default)')
filesystem.add_option(
'--write-annotations',
action='store_true', dest='writeannotations', default=False,
- help='Write video annotations to a .annotations.xml file')
+ help=optparse.SUPPRESS_HELP)
+ filesystem.add_option(
+ '--no-write-annotations',
+ action='store_false', dest='writeannotations',
+ help=optparse.SUPPRESS_HELP)
+ filesystem.add_option(
+ '--write-playlist-metafiles',
+ action='store_true', dest='allow_playlist_files', default=None,
+ help=(
+ 'Write playlist metadata in addition to the video metadata '
+ 'when using --write-info-json, --write-description etc. (default)'))
+ filesystem.add_option(
+ '--no-write-playlist-metafiles',
+ action='store_false', dest='allow_playlist_files',
+ help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
+ filesystem.add_option(
+ '--clean-infojson',
+ action='store_true', dest='clean_infojson', default=None,
+ help=(
+ 'Remove some private fields such as filenames from the infojson. '
+ 'Note that it could still contain some personal information (default)'))
+ filesystem.add_option(
+ '--no-clean-infojson',
+ action='store_false', dest='clean_infojson',
+ help='Write all fields to the infojson')
+ filesystem.add_option(
+ '--write-comments', '--get-comments',
+ action='store_true', dest='getcomments', default=False,
+ help=(
+ 'Retrieve video comments to be placed in the infojson. '
+ 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
+ filesystem.add_option(
+ '--no-write-comments', '--no-get-comments',
+ action='store_false', dest='getcomments',
+ help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
filesystem.add_option(
'--load-info-json', '--load-info',
dest='load_info_filename', metavar='FILE',
@@ -754,10 +1123,28 @@ def parseOpts(overrideArguments=None):
dest='cookiefile', metavar='FILE',
help='File to read cookies from and dump cookie jar in')
filesystem.add_option(
+ '--no-cookies',
+ action='store_const', const=None, dest='cookiefile', metavar='FILE',
+ help='Do not read/dump cookies from/to file (default)')
+ filesystem.add_option(
+ '--cookies-from-browser',
+ dest='cookiesfrombrowser', metavar='BROWSER[:PROFILE]',
+ help=(
+ 'Load cookies from a user profile of the given web browser. '
+ 'Currently supported browsers are: {}. '
+ 'You can specify the user profile name or directory using '
+ '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
+ 'If no profile is given, the most recently accessed one is used'.format(
+ ', '.join(sorted(SUPPORTED_BROWSERS)))))
+ filesystem.add_option(
+ '--no-cookies-from-browser',
+ action='store_const', const=None, dest='cookiesfrombrowser',
+ help='Do not load cookies from browser (default)')
+ filesystem.add_option(
'--cache-dir', dest='cachedir', default=None, metavar='DIR',
- help='Location in the filesystem where hypervideo can store some downloaded information permanently. By default $XDG_CACHE_HOME/hypervideo or ~/.cache/hypervideo . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.')
+ 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/hypervideo or ~/.cache/hypervideo')
filesystem.add_option(
- '--no-cache-dir', action='store_const', const=False, dest='cachedir',
+ '--no-cache-dir', action='store_false', dest='cachedir',
help='Disable filesystem caching')
filesystem.add_option(
'--rm-cache-dir',
@@ -770,94 +1157,380 @@ def parseOpts(overrideArguments=None):
action='store_true', dest='writethumbnail', default=False,
help='Write thumbnail image to disk')
thumbnail.add_option(
+ '--no-write-thumbnail',
+ action='store_false', dest='writethumbnail',
+ help='Do not write thumbnail image to disk (default)')
+ thumbnail.add_option(
'--write-all-thumbnails',
action='store_true', dest='write_all_thumbnails', default=False,
help='Write all thumbnail image formats to disk')
thumbnail.add_option(
'--list-thumbnails',
action='store_true', dest='list_thumbnails', default=False,
- help='Simulate and list all available thumbnail formats')
+ help='List available thumbnails of each video. Simulate unless --no-simulate is used')
- postproc = optparse.OptionGroup(parser, 'Post-processing Options')
+ link = optparse.OptionGroup(parser, 'Internet Shortcut Options')
+ link.add_option(
+ '--write-link',
+ action='store_true', dest='writelink', default=False,
+ help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
+ link.add_option(
+ '--write-url-link',
+ action='store_true', dest='writeurllink', default=False,
+ help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
+ link.add_option(
+ '--write-webloc-link',
+ action='store_true', dest='writewebloclink', default=False,
+ help='Write a .webloc macOS internet shortcut')
+ link.add_option(
+ '--write-desktop-link',
+ action='store_true', dest='writedesktoplink', default=False,
+ help='Write a .desktop Linux internet shortcut')
+
+ postproc = optparse.OptionGroup(parser, 'Post-Processing Options')
postproc.add_option(
'-x', '--extract-audio',
action='store_true', dest='extractaudio', default=False,
- help='Convert video files to audio-only files (requires ffmpeg/avconv and ffprobe/avprobe)')
+ help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
postproc.add_option(
'--audio-format', metavar='FORMAT', dest='audioformat', default='best',
- help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
+ help=(
+ 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
+ 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP.SUPPORTED_EXTS)))
postproc.add_option(
'--audio-quality', metavar='QUALITY',
dest='audioquality', default='5',
- help='Specify ffmpeg/avconv audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
+ help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
+ postproc.add_option(
+ '--remux-video',
+ metavar='FORMAT', dest='remuxvideo', default=None,
+ help=(
+ 'Remux the video into another container if necessary (currently supported: %s). '
+ 'If target container does not support the video/audio codec, remuxing will fail. '
+ 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
+ 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP.SUPPORTED_EXTS)))
postproc.add_option(
'--recode-video',
metavar='FORMAT', dest='recodevideo', default=None,
- help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
+ help=(
+ 'Re-encode the video into another format if re-encoding is necessary. '
+ 'The syntax and supported formats are the same as --remux-video'))
postproc.add_option(
- '--postprocessor-args',
- dest='postprocessor_args', metavar='ARGS',
- help='Give these arguments to the postprocessor')
+ '--postprocessor-args', '--ppa',
+ metavar='NAME:ARGS', dest='postprocessor_args', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'allowed_keys': r'\w+(?:\+\w+)?', 'default_key': 'default-compat',
+ 'process': compat_shlex_split,
+ 'multiple_keys': False
+ }, help=(
+ 'Give these arguments to the postprocessors. '
+ 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
+ 'to give the argument to the specified postprocessor/executable. Supported PP are: '
+ 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
+ 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
+ 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
+ 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
+ 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
+ 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
+ '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
+ 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
+ 'You can use this option multiple times to give different arguments to different '
+ 'postprocessors. (Alias: --ppa)'))
postproc.add_option(
'-k', '--keep-video',
action='store_true', dest='keepvideo', default=False,
- help='Keep the video file on disk after the post-processing; the video is erased by default')
+ help='Keep the intermediate video file on disk after post-processing')
+ postproc.add_option(
+ '--no-keep-video',
+ action='store_false', dest='keepvideo',
+ help='Delete the intermediate video file after post-processing (default)')
+ postproc.add_option(
+ '--post-overwrites',
+ action='store_false', dest='nopostoverwrites',
+ help='Overwrite post-processed files (default)')
postproc.add_option(
'--no-post-overwrites',
action='store_true', dest='nopostoverwrites', default=False,
- help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
+ help='Do not overwrite post-processed files')
postproc.add_option(
'--embed-subs',
action='store_true', dest='embedsubtitles', default=False,
help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
postproc.add_option(
+ '--no-embed-subs',
+ action='store_false', dest='embedsubtitles',
+ help='Do not embed subtitles (default)')
+ postproc.add_option(
'--embed-thumbnail',
action='store_true', dest='embedthumbnail', default=False,
- help='Embed thumbnail in the audio as cover art')
+ help='Embed thumbnail in the video as cover art')
+ postproc.add_option(
+ '--no-embed-thumbnail',
+ action='store_false', dest='embedthumbnail',
+ help='Do not embed thumbnail (default)')
postproc.add_option(
- '--add-metadata',
+ '--embed-metadata', '--add-metadata',
action='store_true', dest='addmetadata', default=False,
- help='Write metadata to the video file')
+ help='Embed metadata to the video file. Also adds chapters to file unless --no-add-chapters is used (Alias: --add-metadata)')
+ postproc.add_option(
+ '--no-embed-metadata', '--no-add-metadata',
+ action='store_false', dest='addmetadata',
+ help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
+ postproc.add_option(
+ '--embed-chapters', '--add-chapters',
+ action='store_true', dest='addchapters', default=None,
+ help='Add chapter markers to the video file (Alias: --add-chapters)')
+ postproc.add_option(
+ '--no-embed-chapters', '--no-add-chapters',
+ action='store_false', dest='addchapters',
+ help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
postproc.add_option(
'--metadata-from-title',
metavar='FORMAT', dest='metafromtitle',
- help='Parse additional metadata like song title / artist from the video title. '
- 'The format syntax is the same as --output. Regular expression with '
- 'named capture groups may also be used. '
- 'The parsed parameters replace existing values. '
- 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
- '"Coldplay - Paradise". '
- 'Example (regex): --metadata-from-title "(?P<artist>.+?) - (?P<title>.+)"')
+ help=optparse.SUPPRESS_HELP)
+ postproc.add_option(
+ '--parse-metadata',
+ metavar='FROM:TO', dest='parse_metadata', action='append',
+ help=(
+ 'Parse additional metadata like title/artist from other fields; '
+ 'see "MODIFYING METADATA" for details'))
+ postproc.add_option(
+ '--replace-in-metadata',
+ dest='parse_metadata', metavar='FIELDS REGEX REPLACE', action='append', nargs=3,
+ help='Replace text in a metadata field using the given regex. This option can be used multiple times')
postproc.add_option(
'--xattrs',
action='store_true', dest='xattrs', default=False,
help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
postproc.add_option(
'--fixup',
- metavar='POLICY', dest='fixup', default='detect_or_warn',
- help='Automatically correct known faults of the file. '
- 'One of never (do nothing), warn (only emit a warning), '
- 'detect_or_warn (the default; fix file if we can, warn otherwise)')
+ metavar='POLICY', dest='fixup', default=None,
+ choices=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
+ help=(
+ 'Automatically correct known faults of the file. '
+ 'One of never (do nothing), warn (only emit a warning), '
+ 'detect_or_warn (the default; fix file if we can, warn otherwise), '
+ 'force (try fixing even if file already exists'))
postproc.add_option(
- '--prefer-avconv',
+ '--prefer-avconv', '--no-prefer-ffmpeg',
action='store_false', dest='prefer_ffmpeg',
- help='Prefer avconv over ffmpeg for running the postprocessors')
+ help=optparse.SUPPRESS_HELP)
postproc.add_option(
- '--prefer-ffmpeg',
- action='store_true', dest='prefer_ffmpeg',
- help='Prefer ffmpeg over avconv for running the postprocessors (default)')
+ '--prefer-ffmpeg', '--no-prefer-avconv',
+ action='store_true', dest='prefer_ffmpeg', default=True,
+ help=optparse.SUPPRESS_HELP)
postproc.add_option(
'--ffmpeg-location', '--avconv-location', metavar='PATH',
dest='ffmpeg_location',
- help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
+ help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
+ postproc.add_option(
+ '--exec', metavar='CMD',
+ action='append', dest='exec_cmd',
+ help=(
+ 'Execute a command on the file after downloading and post-processing. '
+ 'Same syntax as the output template can be used to pass any field as arguments to the command. '
+ 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
+ 'If no fields are passed, %(filepath)q is appended to the end of the command. '
+ 'This option can be used multiple times'))
+ postproc.add_option(
+ '--no-exec',
+ action='store_const', dest='exec_cmd', const=[],
+ help='Remove any previously defined --exec')
+ postproc.add_option(
+ '--exec-before-download', metavar='CMD',
+ action='append', dest='exec_before_dl_cmd',
+ help=(
+ 'Execute a command before the actual download. '
+ 'The syntax is the same as --exec but "filepath" is not available. '
+ 'This option can be used multiple times'))
postproc.add_option(
- '--exec',
- metavar='CMD', dest='exec_cmd',
- help='Execute a command on the file after downloading and post-processing, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
+ '--no-exec-before-download',
+ action='store_const', dest='exec_before_dl_cmd', const=[],
+ help='Remove any previously defined --exec-before-download')
postproc.add_option(
- '--convert-subs', '--convert-subtitles',
+ '--convert-subs', '--convert-sub', '--convert-subtitles',
metavar='FORMAT', dest='convertsubtitles', default=None,
- help='Convert the subtitles to other format (currently supported: srt|ass|vtt|lrc)')
+ help=(
+ 'Convert the subtitles to another format (currently supported: %s) '
+ '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP.SUPPORTED_EXTS)))
+ postproc.add_option(
+ '--convert-thumbnails',
+ metavar='FORMAT', dest='convertthumbnails', default=None,
+ help=(
+ 'Convert the thumbnails to another format '
+ '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP.SUPPORTED_EXTS)))
+ postproc.add_option(
+ '--split-chapters', '--split-tracks',
+ dest='split_chapters', action='store_true', default=False,
+ help=(
+ 'Split video into multiple files based on internal chapters. '
+ 'The "chapter:" prefix can be used with "--paths" and "--output" to '
+ 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
+ postproc.add_option(
+ '--no-split-chapters', '--no-split-tracks',
+ dest='split_chapters', action='store_false',
+ help='Do not split video based on chapters (default)')
+ postproc.add_option(
+ '--remove-chapters',
+ metavar='REGEX', dest='remove_chapters', action='append',
+ help=(
+ 'Remove chapters whose title matches the given regular expression. '
+ 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
+ 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
+ 'This option can be used multiple times'))
+ postproc.add_option(
+ '--no-remove-chapters', dest='remove_chapters', action='store_const', const=None,
+ help='Do not remove any chapters from the file (default)')
+ postproc.add_option(
+ '--force-keyframes-at-cuts',
+ action='store_true', dest='force_keyframes_at_cuts', default=False,
+ help=(
+ 'Force keyframes around the chapters before removing/splitting them. '
+ 'Requires a reencode and thus is very slow, but the resulting video '
+ 'may have fewer artifacts around the cuts'))
+ postproc.add_option(
+ '--no-force-keyframes-at-cuts',
+ action='store_false', dest='force_keyframes_at_cuts',
+ help='Do not force keyframes around the chapters when cutting/splitting (default)')
+ _postprocessor_opts_parser = lambda key, val='': (
+ *(item.split('=', 1) for item in (val.split(';') if val else [])),
+ ('key', remove_end(key, 'PP')))
+ postproc.add_option(
+ '--use-postprocessor',
+ metavar='NAME[:ARGS]', dest='add_postprocessors', default=[], type='str',
+ action='callback', callback=_list_from_options_callback,
+ callback_kwargs={
+ 'delim': None,
+ 'process': lambda val: dict(_postprocessor_opts_parser(*val.split(':', 1)))
+ }, help=(
+ 'The (case sensitive) name of plugin postprocessors to be enabled, '
+ 'and (optionally) arguments to be passed to it, seperated by a colon ":". '
+ 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
+ 'The "when" argument determines when the postprocessor is invoked. '
+ 'It can be one of "pre_process" (after extraction), '
+ '"before_dl" (before video download), "post_process" (after video download; default) '
+ 'or "after_move" (after moving file to their final locations). '
+ 'This option can be used multiple times to add different postprocessors'))
+
+ sponsorblock = optparse.OptionGroup(parser, 'SponsorBlock Options', description=(
+ 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
+ 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
+ sponsorblock.add_option(
+ '--sponsorblock-mark', metavar='CATS',
+ dest='sponsorblock_mark', default=set(), action='callback', type='str',
+ callback=_set_from_options_callback, callback_kwargs={'allowed_values': SponsorBlockPP.CATEGORIES.keys()},
+ help=(
+ 'SponsorBlock categories to create chapters for, separated by commas. '
+ 'Available categories are all, %s. You can prefix the category with a "-" to exempt it. '
+ 'See https://wiki.sponsor.ajay.app/index.php/Segment_Categories for description of the categories. '
+ 'Eg: --sponsorblock-mark all,-preview' % ', '.join(SponsorBlockPP.CATEGORIES.keys())))
+ sponsorblock.add_option(
+ '--sponsorblock-remove', metavar='CATS',
+ dest='sponsorblock_remove', default=set(), action='callback', type='str',
+ callback=_set_from_options_callback, callback_kwargs={'allowed_values': SponsorBlockPP.CATEGORIES.keys()},
+ help=(
+ 'SponsorBlock categories to be removed from the video file, separated by commas. '
+ 'If a category is present in both mark and remove, remove takes precedence. '
+ 'The syntax and available categories are the same as for --sponsorblock-mark'))
+ sponsorblock.add_option(
+ '--sponsorblock-chapter-title', metavar='TEMPLATE',
+ default=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE, dest='sponsorblock_chapter_title',
+ help=(
+ 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
+ 'The same syntax as the output template is used, but the only available fields are '
+ 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
+ sponsorblock.add_option(
+ '--no-sponsorblock', default=False,
+ action='store_true', dest='no_sponsorblock',
+ help='Disable both --sponsorblock-mark and --sponsorblock-remove')
+ sponsorblock.add_option(
+ '--sponsorblock-api', metavar='URL',
+ default='https://sponsor.ajay.app', dest='sponsorblock_api',
+ help='SponsorBlock API location, defaults to %default')
+
+ sponsorblock.add_option(
+ '--sponskrub',
+ action='store_true', dest='sponskrub', default=False,
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--no-sponskrub',
+ action='store_false', dest='sponskrub',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--sponskrub-cut', default=False,
+ action='store_true', dest='sponskrub_cut',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--no-sponskrub-cut',
+ action='store_false', dest='sponskrub_cut',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--sponskrub-force', default=False,
+ action='store_true', dest='sponskrub_force',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--no-sponskrub-force',
+ action='store_true', dest='sponskrub_force',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--sponskrub-location', metavar='PATH',
+ dest='sponskrub_path', default='',
+ help=optparse.SUPPRESS_HELP)
+ sponsorblock.add_option(
+ '--sponskrub-args', dest='sponskrub_args', metavar='ARGS',
+ help=optparse.SUPPRESS_HELP)
+
+ extractor = optparse.OptionGroup(parser, 'Extractor Options')
+ extractor.add_option(
+ '--extractor-retries',
+ dest='extractor_retries', metavar='RETRIES', default=3,
+ help='Number of retries for known extractor errors (default is %default), or "infinite"')
+ extractor.add_option(
+ '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
+ action='store_true', dest='dynamic_mpd', default=True,
+ help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
+ extractor.add_option(
+ '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
+ action='store_false', dest='dynamic_mpd',
+ help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
+ extractor.add_option(
+ '--hls-split-discontinuity',
+ dest='hls_split_discontinuity', action='store_true', default=False,
+ help='Split HLS playlists to different formats at discontinuities such as ad breaks'
+ )
+ extractor.add_option(
+ '--no-hls-split-discontinuity',
+ dest='hls_split_discontinuity', action='store_false',
+ help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
+ _extractor_arg_parser = lambda key, vals='': (key.strip().lower().replace('-', '_'), [val.strip() for val in vals.split(',')])
+ extractor.add_option(
+ '--extractor-args',
+ metavar='KEY:ARGS', dest='extractor_args', default={}, type='str',
+ action='callback', callback=_dict_from_options_callback,
+ callback_kwargs={
+ 'multiple_keys': False,
+ 'process': lambda val: dict(
+ _extractor_arg_parser(*arg.split('=', 1)) for arg in val.split(';'))
+ }, help=(
+ 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
+ 'You can use this option multiple times to give arguments for different extractors'))
+ extractor.add_option(
+ '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
+ action='store_true', dest='youtube_include_dash_manifest', default=True,
+ help=optparse.SUPPRESS_HELP)
+ extractor.add_option(
+ '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
+ action='store_false', dest='youtube_include_dash_manifest',
+ help=optparse.SUPPRESS_HELP)
+ extractor.add_option(
+ '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
+ action='store_true', dest='youtube_include_hls_manifest', default=True,
+ help=optparse.SUPPRESS_HELP)
+ extractor.add_option(
+ '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
+ action='store_false', dest='youtube_include_hls_manifest',
+ help=optparse.SUPPRESS_HELP)
parser.add_option_group(general)
parser.add_option_group(network)
@@ -866,13 +1539,15 @@ def parseOpts(overrideArguments=None):
parser.add_option_group(downloader)
parser.add_option_group(filesystem)
parser.add_option_group(thumbnail)
+ parser.add_option_group(link)
parser.add_option_group(verbosity)
parser.add_option_group(workarounds)
parser.add_option_group(video_format)
parser.add_option_group(subtitles)
parser.add_option_group(authentication)
- parser.add_option_group(adobe_pass)
parser.add_option_group(postproc)
+ parser.add_option_group(sponsorblock)
+ parser.add_option_group(extractor)
if overrideArguments is not None:
opts, args = parser.parse_args(overrideArguments)
@@ -884,33 +1559,62 @@ def parseOpts(overrideArguments=None):
return [a.decode(preferredencoding(), 'replace') for a in conf]
return conf
- command_line_conf = compat_conf(sys.argv[1:])
- opts, args = parser.parse_args(command_line_conf)
+ configs = {
+ 'command-line': compat_conf(sys.argv[1:]),
+ 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
+ paths = {'command-line': False}
- system_conf = user_conf = custom_conf = []
+ def read_options(name, path, user=False):
+ ''' loads config files and returns ignoreconfig '''
+ # Multiple package names can be given here
+ # Eg: ('hypervideo', 'youtube-dlc', 'youtube-dl') will look for
+ # the configuration file of any of these three packages
+ for package in ('hypervideo',):
+ if user:
+ config, current_path = _readUserConf(package, default=None)
+ else:
+ current_path = os.path.join(path, '%s.conf' % package)
+ config = _readOptions(current_path, default=None)
+ if config is not None:
+ configs[name], paths[name] = config, current_path
+ return parser.parse_args(config)[0].ignoreconfig
+ return False
- if '--config-location' in command_line_conf:
- location = compat_expanduser(opts.config_location)
- if os.path.isdir(location):
- location = os.path.join(location, 'hypervideo.conf')
- if not os.path.exists(location):
- parser.error('config-location %s does not exist.' % location)
- custom_conf = _readOptions(location)
- elif '--ignore-config' in command_line_conf:
- pass
- else:
- system_conf = _readOptions('/etc/hypervideo.conf')
- if '--ignore-config' not in system_conf:
- user_conf = _readUserConf()
+ def get_configs():
+ opts, _ = parser.parse_args(configs['command-line'])
+ if opts.config_location is not None:
+ location = compat_expanduser(opts.config_location)
+ if os.path.isdir(location):
+ location = os.path.join(location, 'hypervideo.conf')
+ if not os.path.exists(location):
+ parser.error('config-location %s does not exist.' % location)
+ config = _readOptions(location, default=None)
+ if config:
+ configs['custom'], paths['custom'] = config, location
+
+ if opts.ignoreconfig:
+ return
+ if parser.parse_args(configs['custom'])[0].ignoreconfig:
+ return
+ if read_options('portable', get_executable_path()):
+ return
+ opts, _ = parser.parse_args(configs['portable'] + configs['custom'] + configs['command-line'])
+ if read_options('home', expand_path(opts.paths.get('home', '')).strip()):
+ return
+ if read_options('system', '/etc'):
+ return
+ if read_options('user', None, user=True):
+ configs['system'], paths['system'] = [], None
- argv = system_conf + user_conf + custom_conf + command_line_conf
+ get_configs()
+ argv = configs['system'] + configs['user'] + configs['home'] + configs['portable'] + configs['custom'] + configs['command-line']
opts, args = parser.parse_args(argv)
if opts.verbose:
- for conf_label, conf in (
- ('System config', system_conf),
- ('User config', user_conf),
- ('Custom config', custom_conf),
- ('Command-line args', command_line_conf)):
- write_string('[debug] %s: %s\n' % (conf_label, repr(_hide_login_info(conf))))
+ for label in ('Command-line', 'Custom', 'Portable', 'Home', 'User', 'System'):
+ key = label.lower()
+ if paths.get(key):
+ write_string(f'[debug] {label} config file: {paths[key]}\n')
+ if paths.get(key) is not None:
+ write_string(f'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
return parser, opts, args