2014-09-13 05:58:44 +00:00
from __future__ import unicode_literals
2014-09-13 05:55:21 +00:00
import os . path
import optparse
2016-08-02 15:03:26 +00:00
import re
2014-09-13 05:55:21 +00:00
import sys
2014-11-02 10:23:40 +00:00
from . compat import (
2014-09-30 15:27:53 +00:00
compat_expanduser ,
2015-02-28 20:42:16 +00:00
compat_get_terminal_size ,
2014-09-30 15:27:53 +00:00
compat_getenv ,
2014-11-15 14:17:19 +00:00
compat_kwargs ,
2015-09-05 15:42:41 +00:00
compat_shlex_split ,
2014-11-02 10:23:40 +00:00
)
from . utils import (
2021-12-14 17:03:47 +00:00
Config ,
2021-01-23 12:18:12 +00:00
expand_path ,
2021-01-24 13:40:02 +00:00
get_executable_path ,
2021-02-03 13:36:09 +00:00
OUTTMPL_TYPES ,
2022-01-03 11:13:54 +00:00
POSTPROCESS_WHEN ,
2021-09-29 20:53:33 +00:00
remove_end ,
2014-09-13 05:55:21 +00:00
write_string ,
)
2021-12-27 01:28:44 +00:00
from . cookies import SUPPORTED_BROWSERS , SUPPORTED_KEYRINGS
2014-09-13 05:55:21 +00:00
from . version import __version__
2021-05-22 08:24:12 +00:00
from . downloader . external import list_external_downloaders
2021-08-09 12:10:24 +00:00
from . postprocessor import (
2021-05-22 08:24:12 +00:00
FFmpegExtractAudioPP ,
FFmpegSubtitlesConvertorPP ,
FFmpegThumbnailsConvertorPP ,
FFmpegVideoRemuxerPP ,
2021-09-01 20:55:16 +00:00
SponsorBlockPP ,
2021-05-22 08:24:12 +00:00
)
2021-09-01 20:55:16 +00:00
from . postprocessor . modify_chapters import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
2021-05-22 08:24:12 +00:00
2014-09-13 05:55:21 +00:00
2021-12-14 17:03:47 +00:00
def parseOpts ( overrideArguments = None , ignore_config_files = ' if_override ' ) :
parser = create_parser ( )
root = Config ( parser )
2017-07-23 08:21:35 +00:00
2021-12-14 17:03:47 +00:00
if ignore_config_files == ' if_override ' :
ignore_config_files = overrideArguments is not None
if overrideArguments :
root . append_config ( overrideArguments , label = ' Override ' )
else :
root . append_config ( sys . argv [ 1 : ] , label = ' Command-line ' )
2014-09-13 05:55:21 +00:00
2021-01-16 18:21:00 +00:00
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 )
2021-12-14 17:03:47 +00:00
userConf = Config . read_file ( userConfFile , default = None )
2021-01-16 18:21:00 +00:00
if userConf is not None :
2021-01-23 12:18:12 +00:00
return userConf , userConfFile
2014-09-13 05:55:21 +00:00
2021-01-16 18:21:00 +00:00
# appdata
appdata_dir = compat_getenv ( ' appdata ' )
if appdata_dir :
userConfFile = os . path . join ( appdata_dir , package_name , ' config ' )
2021-12-14 17:03:47 +00:00
userConf = Config . read_file ( userConfFile , default = None )
2021-01-16 18:21:00 +00:00
if userConf is None :
2021-01-23 12:18:12 +00:00
userConfFile + = ' .txt '
2021-12-14 17:03:47 +00:00
userConf = Config . read_file ( userConfFile , default = None )
2021-01-16 18:21:00 +00:00
if userConf is not None :
2021-01-23 12:18:12 +00:00
return userConf , userConfFile
2014-09-13 05:55:21 +00:00
2021-01-16 18:21:00 +00:00
# home
userConfFile = os . path . join ( compat_expanduser ( ' ~ ' ) , ' %s .conf ' % package_name )
2021-12-14 17:03:47 +00:00
userConf = Config . read_file ( userConfFile , default = None )
2014-09-13 05:55:21 +00:00
if userConf is None :
2021-01-23 12:18:12 +00:00
userConfFile + = ' .txt '
2021-12-14 17:03:47 +00:00
userConf = Config . read_file ( userConfFile , default = None )
2021-01-16 18:21:00 +00:00
if userConf is not None :
2021-01-23 12:18:12 +00:00
return userConf , userConfFile
2014-09-13 05:55:21 +00:00
2021-01-23 12:18:12 +00:00
return default , None
2014-09-13 05:55:21 +00:00
2021-12-14 17:03:47 +00:00
def add_config ( label , path , user = False ) :
""" Adds config and returns whether to continue """
if root . parse_args ( ) [ 0 ] . ignoreconfig :
return False
# Multiple package names can be given here
# Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
# the configuration file of any of these three packages
for package in ( ' yt-dlp ' , ) :
if user :
args , current_path = _readUserConf ( package , default = None )
else :
current_path = os . path . join ( path , ' %s .conf ' % package )
args = Config . read_file ( current_path , default = None )
if args is not None :
root . append_config ( args , current_path , label = label )
return True
return True
def load_configs ( ) :
yield not ignore_config_files
yield add_config ( ' Portable ' , get_executable_path ( ) )
yield add_config ( ' Home ' , expand_path ( root . parse_args ( ) [ 0 ] . paths . get ( ' home ' , ' ' ) ) . strip ( ) )
yield add_config ( ' User ' , None , user = True )
yield add_config ( ' System ' , ' /etc ' )
if all ( load_configs ( ) ) :
# If ignoreconfig is found inside the system configuration file,
# the user configuration is removed
if root . parse_args ( ) [ 0 ] . ignoreconfig :
user_conf = next ( ( i for i , conf in enumerate ( root . configs ) if conf . label == ' User ' ) , None )
if user_conf is not None :
root . configs . pop ( user_conf )
opts , args = root . parse_args ( )
if opts . verbose :
write_string ( f ' \n { root } ' . replace ( ' \n | ' , ' \n [debug] ' ) [ 1 : ] + ' \n ' )
return parser , opts , args
2022-02-10 15:37:08 +00:00
class _YoutubeDLOptionParser ( optparse . OptionParser ) :
# optparse is deprecated since python 3.2. So assume a stable interface even for private methods
def _match_long_opt ( self , opt ) :
""" Improve ambigious argument resolution by comparing option objects instead of argument strings """
try :
return super ( ) . _match_long_opt ( opt )
except optparse . AmbiguousOptionError as e :
if len ( set ( self . _long_opt [ p ] for p in e . possibilities ) ) == 1 :
return e . possibilities [ 0 ]
raise
2021-12-14 17:03:47 +00:00
def create_parser ( ) :
2014-09-13 05:55:21 +00:00
def _format_option_string ( option ) :
''' ( ' -o ' , ' --option ' ) -> -o, --format METAVAR '''
opts = [ ]
if option . _short_opts :
opts . append ( option . _short_opts [ 0 ] )
if option . _long_opts :
opts . append ( option . _long_opts [ 0 ] )
if len ( opts ) > 1 :
opts . insert ( 1 , ' , ' )
2014-10-12 21:10:11 +00:00
if option . takes_value ( ) :
opts . append ( ' %s ' % option . metavar )
2014-09-13 05:55:21 +00:00
2016-02-14 09:37:17 +00:00
return ' ' . join ( opts )
2014-09-13 05:55:21 +00:00
2021-09-14 06:33:26 +00:00
def _list_from_options_callback ( option , opt_str , value , parser , append = True , delim = ' , ' , process = str . strip ) :
2021-05-13 12:21:22 +00:00
# append can be True, False or -1 (prepend)
2022-01-03 19:37:24 +00:00
current = list ( getattr ( parser . values , option . dest ) ) if append else [ ]
2021-09-23 23:40:33 +00:00
value = list ( filter ( None , [ process ( value ) ] if delim is None else map ( process , value . split ( delim ) ) ) )
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
setattr (
parser . values , option . dest ,
2021-05-13 12:21:22 +00:00
current + value if append is True else value + current )
2014-09-13 05:55:21 +00:00
2021-08-14 18:54:53 +00:00
def _set_from_options_callback (
2021-09-14 06:33:26 +00:00
option , opt_str , value , parser , delim = ' , ' , allowed_values = None , aliases = { } ,
process = lambda x : x . lower ( ) . strip ( ) ) :
2022-01-03 19:37:24 +00:00
current = set ( getattr ( parser . values , option . dest ) )
2021-09-14 06:33:26 +00:00
values = [ process ( value ) ] if delim is None else list ( map ( process , value . split ( delim ) [ : : - 1 ] ) )
2021-08-14 18:54:53 +00:00
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 )
2021-05-13 12:21:22 +00:00
def _dict_from_options_callback (
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
option , opt_str , value , parser ,
2021-11-10 13:03:37 +00:00
allowed_keys = r ' [ \ w-]+ ' , delimiter = ' : ' , default_key = None , process = None , multiple_keys = True ,
2022-01-02 10:52:00 +00:00
process_key = str . lower , append = False ) :
2021-01-23 05:57:27 +00:00
2022-01-02 10:52:00 +00:00
out_dict = dict ( getattr ( parser . values , option . dest ) )
2022-01-23 21:34:19 +00:00
multiple_args = not isinstance ( value , str )
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
if multiple_keys :
allowed_keys = r ' ( %s )(,( %s ))* ' % ( allowed_keys , allowed_keys )
2022-01-23 21:34:19 +00:00
mobj = re . match (
r ' (?i)(?P<keys> %s ) %s (?P<val>.*)$ ' % ( allowed_keys , delimiter ) ,
value [ 0 ] if multiple_args else value )
2021-01-23 05:57:27 +00:00
if mobj is not None :
2021-11-10 13:03:37 +00:00
keys , val = mobj . group ( ' keys ' ) . split ( ' , ' ) , mobj . group ( ' val ' )
2022-01-23 21:34:19 +00:00
if multiple_args :
val = [ val , * value [ 1 : ] ]
2021-01-23 05:57:27 +00:00
elif default_key is not None :
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
keys , val = [ default_key ] , value
2021-01-23 05:57:27 +00:00
else :
raise optparse . OptionValueError (
' wrong %s formatting; it should be %s , not " %s " ' % ( opt_str , option . metavar , value ) )
2021-07-08 15:33:13 +00:00
try :
2021-11-10 13:03:37 +00:00
keys = map ( process_key , keys ) if process_key else keys
2021-07-08 15:33:13 +00:00
val = process ( val ) if process else val
except Exception as err :
2021-11-10 13:03:37 +00:00
raise optparse . OptionValueError ( f ' wrong { opt_str } formatting; { err } ' )
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
for key in keys :
2022-01-02 10:52:00 +00:00
out_dict [ key ] = out_dict . get ( key , [ ] ) + [ val ] if append else val
setattr ( parser . values , option . dest , out_dict )
2021-01-23 05:57:27 +00:00
2014-09-13 05:55:21 +00:00
# No need to wrap help messages if we're on a wide console
2015-02-28 20:42:16 +00:00
columns = compat_get_terminal_size ( ) . columns
2014-10-12 21:10:11 +00:00
max_width = columns if columns else 80
2021-07-21 20:32:49 +00:00
# 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 )
2014-09-13 05:55:21 +00:00
fmt = optparse . IndentedHelpFormatter ( width = max_width , max_help_position = max_help_position )
fmt . format_option_strings = _format_option_string
kw = {
2014-10-12 21:10:11 +00:00
' version ' : __version__ ,
' formatter ' : fmt ,
2015-01-01 21:01:26 +00:00
' usage ' : ' % prog [OPTIONS] URL [URL...] ' ,
2014-10-12 21:10:11 +00:00
' conflict_handler ' : ' resolve ' ,
2014-09-13 05:55:21 +00:00
}
2022-02-10 15:37:08 +00:00
parser = _YoutubeDLOptionParser ( * * compat_kwargs ( kw ) )
2014-09-13 05:55:21 +00:00
2014-10-12 21:10:11 +00:00
general = optparse . OptionGroup ( parser , ' General Options ' )
general . add_option (
' -h ' , ' --help ' ,
action = ' help ' ,
2015-03-25 10:02:55 +00:00
help = ' Print this help text and exit ' )
2014-10-12 21:10:11 +00:00
general . add_option (
2020-02-29 09:33:09 +00:00
' --version ' ,
2014-10-12 21:10:11 +00:00
action = ' version ' ,
2015-03-25 10:02:55 +00:00
help = ' Print program version and exit ' )
2014-10-12 21:10:11 +00:00
general . add_option (
' -U ' , ' --update ' ,
action = ' store_true ' , dest = ' update_self ' ,
2021-02-09 20:06:02 +00:00
help = ' Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed) ' )
2014-10-12 21:10:11 +00:00
general . add_option (
2021-09-24 00:21:54 +00:00
' -i ' , ' --ignore-errors ' ,
action = ' store_true ' , dest = ' ignoreerrors ' ,
2021-10-31 09:15:59 +00:00
help = ' Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails ' )
2021-09-24 00:21:54 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
general . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --abort-on-error ' , ' --no-ignore-errors ' ,
2014-10-12 21:10:11 +00:00
action = ' store_false ' , dest = ' ignoreerrors ' ,
2021-01-18 19:17:48 +00:00
help = ' Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors) ' )
2014-10-12 21:10:11 +00:00
general . add_option (
' --dump-user-agent ' ,
action = ' store_true ' , dest = ' dump_user_agent ' , default = False ,
2021-08-07 08:49:17 +00:00
help = ' Display the current user-agent and exit ' )
2014-09-13 05:55:21 +00:00
general . add_option (
2014-10-12 21:10:11 +00:00
' --list-extractors ' ,
action = ' store_true ' , dest = ' list_extractors ' , default = False ,
2021-08-07 00:01:51 +00:00
help = ' List all supported extractors and exit ' )
2014-10-12 21:10:11 +00:00
general . add_option (
' --extractor-descriptions ' ,
action = ' store_true ' , dest = ' list_extractor_descriptions ' , default = False ,
2021-08-07 00:01:51 +00:00
help = ' Output descriptions of all supported extractors and exit ' )
2015-06-12 13:20:12 +00:00
general . add_option (
' --force-generic-extractor ' ,
action = ' store_true ' , dest = ' force_generic_extractor ' , default = False ,
help = ' Force extraction to use the generic extractor ' )
2014-09-13 05:55:21 +00:00
general . add_option (
' --default-search ' ,
dest = ' default_search ' , metavar = ' PREFIX ' ,
2021-09-01 23:09:47 +00:00
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 yt-dlp 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 ' )
2014-09-13 05:55:21 +00:00
general . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --ignore-config ' , ' --no-config ' ,
2021-09-13 02:52:11 +00:00
action = ' store_true ' , dest = ' ignoreconfig ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
2022-01-03 19:37:24 +00:00
' Don \' t load any more configuration files except those given by --config-locations. '
2022-01-12 03:30:21 +00:00
' For backward compatibility, if this option is found inside the system configuration file, the user configuration is not loaded. '
2022-01-19 22:57:07 +00:00
' (Alias: --no-config) ' ) )
2016-09-14 15:28:17 +00:00
general . add_option (
2021-12-14 17:03:47 +00:00
' --no-config-locations ' ,
action = ' store_const ' , dest = ' config_locations ' , const = [ ] ,
help = (
' Do not load any custom configuration files (default). When given inside a '
' configuration file, ignore all previous --config-locations defined in the current file ' ) )
general . add_option (
' --config-locations ' ,
dest = ' config_locations ' , metavar = ' PATH ' , action = ' append ' ,
help = (
' Location of the main configuration file; either the path to the config or its containing directory. '
' Can be used multiple times and inside other configuration files ' ) )
2014-10-24 12:48:12 +00:00
general . add_option (
' --flat-playlist ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
action = ' store_const ' , dest = ' extract_flat ' , const = ' in_playlist ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Do not extract the videos of a playlist, only list them ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
general . add_option (
' --no-flat-playlist ' ,
action = ' store_false ' , dest = ' extract_flat ' ,
help = ' Extract the videos of a playlist ' )
2021-12-20 06:06:46 +00:00
general . add_option (
' --live-from-start ' ,
action = ' store_true ' , dest = ' live_from_start ' ,
2022-01-03 19:37:24 +00:00
help = ' Download livestreams from the start. Currently only supported for YouTube (Experimental) ' )
2021-12-20 06:06:46 +00:00
general . add_option (
' --no-live-from-start ' ,
action = ' store_false ' , dest = ' live_from_start ' ,
help = ' Download livestreams from the current time (default) ' )
2021-11-28 18:57:44 +00:00
general . add_option (
' --wait-for-video ' ,
dest = ' wait_for_video ' , metavar = ' MIN[-MAX] ' , default = None ,
help = (
' Wait for scheduled streams to become available. '
' Pass the minimum number of seconds (or range) to wait between retries ' ) )
general . add_option (
' --no-wait-for-video ' ,
dest = ' wait_for_video ' , action = ' store_const ' , const = None ,
help = ' Do not wait for scheduled streams (default) ' )
2016-02-29 19:01:33 +00:00
general . add_option (
' --mark-watched ' ,
action = ' store_true ' , dest = ' mark_watched ' , default = False ,
2021-09-17 18:23:55 +00:00
help = ' Mark videos watched (even with --simulate). Currently only supported for YouTube ' )
2016-03-01 17:41:23 +00:00
general . add_option (
' --no-mark-watched ' ,
2021-03-15 00:00:18 +00:00
action = ' store_false ' , dest = ' mark_watched ' ,
help = ' Do not mark videos watched (default) ' )
2015-02-10 03:22:10 +00:00
general . add_option (
2021-01-18 19:17:48 +00:00
' --no-colors ' ,
2021-03-15 00:00:18 +00:00
action = ' store_true ' , dest = ' no_color ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Do not emit color codes in output ' )
2021-05-11 08:00:48 +00:00
general . add_option (
' --compat-options ' ,
2021-08-14 18:54:53 +00:00
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 ' ,
2021-11-14 19:55:47 +00:00
' no-youtube-channel-redirect ' , ' no-youtube-unavailable-videos ' , ' no-attach-info-json ' , ' embed-metadata ' ,
2021-08-14 18:54:53 +00:00
' embed-thumbnail-atomicparsley ' , ' seperate-video-versions ' , ' no-clean-infojson ' , ' no-keep-subs ' ,
2021-09-14 06:33:26 +00:00
} , ' aliases ' : {
2021-08-14 18:54:53 +00:00
' 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 '
2021-05-11 08:00:48 +00:00
' configurations by reverting some of the changes made in yt-dlp. '
' See " Differences in default behavior " for details ' ) )
2014-09-13 05:55:21 +00:00
2015-01-10 18:55:36 +00:00
network = optparse . OptionGroup ( parser , ' Network Options ' )
network . add_option (
' --proxy ' , dest = ' proxy ' ,
default = None , metavar = ' URL ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
' Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
' SOCKS proxy, specify a proper scheme. For example '
2022-01-23 19:51:39 +00:00
' socks5://user:pass@127.0.0.1:1080/. Pass in an empty string (--proxy " " ) '
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' for direct connection ' ) )
2015-01-10 18:55:36 +00:00
network . add_option (
' --socket-timeout ' ,
dest = ' socket_timeout ' , type = float , default = None , metavar = ' SECONDS ' ,
help = ' Time to wait before giving up, in seconds ' )
network . add_option (
' --source-address ' ,
metavar = ' IP ' , dest = ' source_address ' , default = None ,
2017-01-28 15:40:07 +00:00
help = ' Client-side IP address to bind to ' ,
2015-01-10 18:55:36 +00:00
)
2015-01-10 19:02:02 +00:00
network . add_option (
' -4 ' , ' --force-ipv4 ' ,
action = ' store_const ' , const = ' 0.0.0.0 ' , dest = ' source_address ' ,
2017-01-28 15:40:07 +00:00
help = ' Make all connections via IPv4 ' ,
2015-01-10 19:02:02 +00:00
)
network . add_option (
' -6 ' , ' --force-ipv6 ' ,
action = ' store_const ' , const = ' :: ' , dest = ' source_address ' ,
2017-01-28 15:40:07 +00:00
help = ' Make all connections via IPv6 ' ,
2015-01-10 19:02:02 +00:00
)
2017-02-18 20:58:17 +00:00
2021-04-11 00:22:55 +00:00
geo = optparse . OptionGroup ( parser , ' Geo-restriction ' )
2017-02-18 20:58:17 +00:00
geo . add_option (
2016-07-03 15:23:48 +00:00
' --geo-verification-proxy ' ,
dest = ' geo_verification_proxy ' , default = None , metavar = ' URL ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
' Use this proxy to verify the IP address for some geo-restricted sites. '
2021-01-18 19:17:48 +00:00
' The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading ' ) )
2017-02-18 20:58:17 +00:00
geo . add_option (
2015-03-02 23:03:06 +00:00
' --cn-verification-proxy ' ,
dest = ' cn_verification_proxy ' , default = None , metavar = ' URL ' ,
2017-02-18 20:58:17 +00:00
help = optparse . SUPPRESS_HELP )
geo . add_option (
' --geo-bypass ' ,
action = ' store_true ' , dest = ' geo_bypass ' , default = True ,
2022-02-03 15:02:10 +00:00
help = ' Bypass geographic restriction via faking X-Forwarded-For HTTP header (default) ' )
2017-02-18 20:58:17 +00:00
geo . add_option (
' --no-geo-bypass ' ,
2022-02-03 15:02:10 +00:00
action = ' store_false ' , dest = ' geo_bypass ' ,
2018-05-19 16:53:24 +00:00
help = ' Do not bypass geographic restriction via faking X-Forwarded-For HTTP header ' )
2017-02-18 20:58:17 +00:00
geo . add_option (
' --geo-bypass-country ' , metavar = ' CODE ' ,
dest = ' geo_bypass_country ' , default = None ,
2018-05-19 16:53:24 +00:00
help = ' Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code ' )
2018-05-02 00:18:01 +00:00
geo . add_option (
' --geo-bypass-ip-block ' , metavar = ' IP_BLOCK ' ,
dest = ' geo_bypass_ip_block ' , default = None ,
2018-05-19 16:53:24 +00:00
help = ' Force bypass geographic restriction with explicitly provided IP block in CIDR notation ' )
2015-01-10 18:55:36 +00:00
2014-10-12 21:10:11 +00:00
selection = optparse . OptionGroup ( parser , ' Video Selection ' )
2014-09-13 05:55:21 +00:00
selection . add_option (
' --playlist-start ' ,
dest = ' playliststart ' , metavar = ' NUMBER ' , default = 1 , type = int ,
2015-03-25 10:02:55 +00:00
help = ' Playlist video to start at (default is %d efault) ' )
2014-09-13 05:55:21 +00:00
selection . add_option (
' --playlist-end ' ,
dest = ' playlistend ' , metavar = ' NUMBER ' , default = None , type = int ,
2015-03-25 10:02:55 +00:00
help = ' Playlist video to end at (default is last) ' )
2015-01-25 03:24:55 +00:00
selection . add_option (
' --playlist-items ' ,
dest = ' playlist_items ' , metavar = ' ITEM_SPEC ' , default = None ,
2021-01-18 19:17:48 +00:00
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 ' )
2014-09-13 05:55:21 +00:00
selection . add_option (
2014-10-12 21:10:11 +00:00
' --match-title ' ,
dest = ' matchtitle ' , metavar = ' REGEX ' ,
2021-08-15 08:12:23 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --reject-title ' ,
dest = ' rejecttitle ' , metavar = ' REGEX ' ,
2021-08-15 08:12:23 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --min-filesize ' ,
metavar = ' SIZE ' , dest = ' min_filesize ' , default = None ,
help = ' Do not download any videos smaller than SIZE (e.g. 50k or 44.6m) ' )
selection . add_option (
' --max-filesize ' ,
metavar = ' SIZE ' , dest = ' max_filesize ' , default = None ,
help = ' Do not download any videos larger than SIZE (e.g. 50k or 44.6m) ' )
selection . add_option (
' --date ' ,
metavar = ' DATE ' , dest = ' date ' , default = None ,
2021-01-07 06:41:05 +00:00
help = (
2021-10-31 09:15:59 +00:00
' Download only videos uploaded on this date. '
2021-01-18 19:17:48 +00:00
' The date can be " YYYYMMDD " or in the format '
2021-01-07 06:41:05 +00:00
' " (now|today)[+-][0-9](day|week|month|year)(s)? " ' ) )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --datebefore ' ,
metavar = ' DATE ' , dest = ' datebefore ' , default = None ,
2021-01-07 06:41:05 +00:00
help = (
' Download only videos uploaded on or before this date. '
' The date formats accepted is the same as --date ' ) )
2014-09-13 05:55:21 +00:00
selection . add_option (
2014-10-12 21:10:11 +00:00
' --dateafter ' ,
metavar = ' DATE ' , dest = ' dateafter ' , default = None ,
2021-01-07 06:41:05 +00:00
help = (
' Download only videos uploaded on or after this date. '
' The date formats accepted is the same as --date ' ) )
2014-09-13 05:55:21 +00:00
selection . add_option (
2014-10-12 21:10:11 +00:00
' --min-views ' ,
metavar = ' COUNT ' , dest = ' min_views ' , default = None , type = int ,
2021-08-15 08:12:23 +00:00
help = optparse . SUPPRESS_HELP )
2014-09-13 05:55:21 +00:00
selection . add_option (
2014-10-12 21:10:11 +00:00
' --max-views ' ,
metavar = ' COUNT ' , dest = ' max_views ' , default = None , type = int ,
2021-08-15 08:12:23 +00:00
help = optparse . SUPPRESS_HELP )
2015-02-10 02:32:21 +00:00
selection . add_option (
' --match-filter ' ,
metavar = ' FILTER ' , dest = ' match_filter ' , default = None ,
help = (
2021-06-13 14:25:19 +00:00
' 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 '
2021-08-04 21:31:23 +00:00
' 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 '
2021-08-27 20:50:18 +00:00
' " !is_live & like_count>?100 & description~= \' (?i) \\ bcats \\ & dogs \\ b \' " '
2021-08-04 21:31:23 +00:00
' 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) ' ) )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
selection . add_option (
' --no-match-filter ' ,
metavar = ' FILTER ' , dest = ' match_filter ' , action = ' store_const ' , const = None ,
help = ' Do not use generic video filter (default) ' )
2014-09-13 05:55:21 +00:00
selection . add_option (
2014-10-12 21:10:11 +00:00
' --no-playlist ' ,
action = ' store_true ' , dest = ' noplaylist ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Download only the video, if the URL refers to a video and a playlist ' )
2015-02-24 16:25:02 +00:00
selection . add_option (
' --yes-playlist ' ,
2021-02-28 15:25:32 +00:00
action = ' store_false ' , dest = ' noplaylist ' ,
2021-01-18 19:17:48 +00:00
help = ' Download the playlist, if the URL refers to a video and a playlist ' )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --age-limit ' ,
metavar = ' YEARS ' , dest = ' age_limit ' , default = None , type = int ,
2015-03-25 10:02:55 +00:00
help = ' Download only videos suitable for the given age ' )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --download-archive ' , metavar = ' FILE ' ,
dest = ' download_archive ' ,
2021-01-18 19:17:48 +00:00
help = ' Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it ' )
2021-11-28 21:22:52 +00:00
selection . add_option (
' --no-download-archive ' ,
dest = ' download_archive ' , action = " store_const " , const = None ,
help = ' Do not use archive file (default) ' )
selection . add_option (
' --max-downloads ' ,
dest = ' max_downloads ' , metavar = ' NUMBER ' , type = int , default = None ,
help = ' Abort after downloading NUMBER files ' )
2020-09-21 15:26:18 +00:00
selection . add_option (
' --break-on-existing ' ,
action = ' store_true ' , dest = ' break_on_existing ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Stop the download process when encountering a file that is in the archive ' )
2021-01-13 01:01:01 +00:00
selection . add_option (
' --break-on-reject ' ,
action = ' store_true ' , dest = ' break_on_reject ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Stop the download process when encountering a file that has been filtered out ' )
2021-11-28 21:11:55 +00:00
selection . add_option (
' --break-per-input ' ,
action = ' store_true ' , dest = ' break_per_url ' , default = False ,
help = ' Make --break-on-existing and --break-on-reject act only on the current input URL ' )
selection . add_option (
' --no-break-per-input ' ,
action = ' store_false ' , dest = ' break_per_url ' ,
help = ' --break-on-existing and --break-on-reject terminates the entire download queue ' )
2021-04-21 06:00:43 +00:00
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 ' )
2014-10-12 21:10:11 +00:00
selection . add_option (
' --include-ads ' ,
dest = ' include_ads ' , action = ' store_true ' ,
2021-04-10 15:22:54 +00:00
help = optparse . SUPPRESS_HELP )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
selection . add_option (
' --no-include-ads ' ,
dest = ' include_ads ' , action = ' store_false ' ,
2021-04-10 15:22:54 +00:00
help = optparse . SUPPRESS_HELP )
2014-09-13 05:55:21 +00:00
2014-10-12 21:10:11 +00:00
authentication = optparse . OptionGroup ( parser , ' Authentication Options ' )
authentication . add_option (
' -u ' , ' --username ' ,
dest = ' username ' , metavar = ' USERNAME ' ,
2015-03-25 10:02:55 +00:00
help = ' Login with this account ID ' )
2014-10-12 21:10:11 +00:00
authentication . add_option (
' -p ' , ' --password ' ,
dest = ' password ' , metavar = ' PASSWORD ' ,
2021-02-24 18:45:56 +00:00
help = ' Account password. If this option is left out, yt-dlp will ask interactively ' )
2014-10-12 21:10:11 +00:00
authentication . add_option (
' -2 ' , ' --twofactor ' ,
dest = ' twofactor ' , metavar = ' TWOFACTOR ' ,
2016-12-12 11:13:34 +00:00
help = ' Two-factor authentication code ' )
2014-10-12 21:10:11 +00:00
authentication . add_option (
' -n ' , ' --netrc ' ,
action = ' store_true ' , dest = ' usenetrc ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Use .netrc authentication data ' )
2021-09-15 19:21:40 +00:00
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 ' )
2014-10-12 21:10:11 +00:00
authentication . add_option (
' --video-password ' ,
dest = ' videopassword ' , metavar = ' PASSWORD ' ,
2021-01-01 12:26:37 +00:00
help = ' Video password (vimeo, youku) ' )
2021-04-11 00:22:55 +00:00
authentication . add_option (
2016-09-14 17:58:47 +00:00
' --ap-mso ' ,
dest = ' ap_mso ' , metavar = ' MSO ' ,
2016-09-15 15:17:17 +00:00
help = ' Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs ' )
2021-04-11 00:22:55 +00:00
authentication . add_option (
2016-09-13 21:16:01 +00:00
' --ap-username ' ,
2016-09-14 17:58:47 +00:00
dest = ' ap_username ' , metavar = ' USERNAME ' ,
2016-09-15 15:17:17 +00:00
help = ' Multiple-system operator account login ' )
2021-04-11 00:22:55 +00:00
authentication . add_option (
2016-09-13 21:16:01 +00:00
' --ap-password ' ,
2016-09-14 17:58:47 +00:00
dest = ' ap_password ' , metavar = ' PASSWORD ' ,
2021-02-24 18:45:56 +00:00
help = ' Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively ' )
2021-04-11 00:22:55 +00:00
authentication . add_option (
2016-09-14 19:21:09 +00:00
' --ap-list-mso ' ,
action = ' store_true ' , dest = ' ap_list_mso ' , default = False ,
2016-09-15 15:17:17 +00:00
help = ' List all supported multiple-system operators ' )
2014-10-12 21:10:11 +00:00
video_format = optparse . OptionGroup ( parser , ' Video Format Options ' )
video_format . add_option (
' -f ' , ' --format ' ,
action = ' store ' , dest = ' format ' , metavar = ' FORMAT ' , default = None ,
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 15:50:09 +00:00
help = ' Video format code, see " FORMAT SELECTION " for more details ' )
video_format . add_option (
2021-01-07 06:41:05 +00:00
' -S ' , ' --format-sort ' , metavar = ' SORTORDER ' ,
2021-05-13 12:21:22 +00:00
dest = ' format_sort ' , default = [ ] , type = ' str ' , action = ' callback ' ,
callback = _list_from_options_callback , callback_kwargs = { ' append ' : - 1 } ,
Better Format Sorting (Squashed)
* Added --format-sort (-S height,filesize)
* Made fields reversible (-S +height)
* Added --format-sort-force, --no-format-sort-force
* Added limit (-S height:720)
* Added codec preference (-S vcodec,acodec)
* Correct handling of preference<-1000
* Rebased to yt-dlc
* Automatically determine missing bitrates
* aext, vext, protocol, acodec, vcodec can now takes priority as string, not number (-S vext:webm)
* Correct handling of None in codec, audio_codec (None means the codec is unknown while 'none' means it doesn't exist)
* Correctly parse filesize (-S filesize:200M)
* Generalized preference calculation
* Rewrote entire code into the class FormatSort
* Correctly handle user input errors
* Combined fields (-S +ext:webm:webm)
* Closest mode (-S filesize~50M)
* Aliases (framerate=fps, br=bitrate etc)
* Documentation
2020-10-26 15:50:09 +00:00
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 ' ) )
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 15:35:36 +00:00
video_format . add_option (
' --video-multistreams ' ,
2021-05-11 08:00:48 +00:00
action = ' store_true ' , dest = ' allow_multiple_video_streams ' , default = None ,
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 16:40:47 +00:00
help = ' Allow multiple video streams to be merged into a single file ' )
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 15:35:36 +00:00
video_format . add_option (
' --no-video-multistreams ' ,
action = ' store_false ' , dest = ' allow_multiple_video_streams ' ,
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 16:40:47 +00:00
help = ' Only one video stream is downloaded for each output file (default) ' )
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 15:35:36 +00:00
video_format . add_option (
' --audio-multistreams ' ,
2021-05-11 08:00:48 +00:00
action = ' store_true ' , dest = ' allow_multiple_audio_streams ' , default = None ,
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 16:40:47 +00:00
help = ' Allow multiple audio streams to be merged into a single file ' )
Better Format Selection
* Added options: --video-multistreams, --no-video-multistreams, --audio-multistreams, --no-audio-multistreams
* New format selectors: best*, worst*, bestvideo*, bestaudio*, worstvideo*, worstaudio*
* Added b,w,v,a as alias for best, worst, video and audio respectively in format selection
* Changed video format sorting to show video only files and video+audio files together.
2020-11-05 15:35:36 +00:00
video_format . add_option (
' --no-audio-multistreams ' ,
action = ' store_false ' , dest = ' allow_multiple_audio_streams ' ,
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 16:40:47 +00:00
help = ' Only one audio stream is downloaded for each output file (default) ' )
2014-10-12 21:10:11 +00:00
video_format . add_option (
' --all-formats ' ,
action = ' store_const ' , dest = ' format ' , const = ' all ' ,
2021-04-10 15:22:54 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
video_format . add_option (
' --prefer-free-formats ' ,
action = ' store_true ' , dest = ' prefer_free_formats ' , default = False ,
2021-02-18 14:17:46 +00:00
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 ' ,
2021-08-25 11:49:05 +00:00
action = ' store_false ' , dest = ' prefer_free_formats ' , default = False ,
2021-02-18 14:17:46 +00:00
help = " Don ' t give any special preference to free containers (default) " )
2021-05-04 15:54:00 +00:00
video_format . add_option (
' --check-formats ' ,
2021-10-24 09:16:07 +00:00
action = ' store_const ' , const = ' selected ' , dest = ' check_formats ' , default = None ,
help = ' Check that the selected formats are actually downloadable ' )
video_format . add_option (
' --check-all-formats ' ,
action = ' store_true ' , dest = ' check_formats ' ,
help = ' Check all formats for whether they are actually downloadable ' )
2021-07-15 17:19:59 +00:00
video_format . add_option (
' --no-check-formats ' ,
action = ' store_false ' , dest = ' check_formats ' ,
2021-10-24 09:16:07 +00:00
help = ' Do not check that the formats are actually downloadable ' )
2014-10-12 21:10:11 +00:00
video_format . add_option (
' -F ' , ' --list-formats ' ,
action = ' store_true ' , dest = ' listformats ' ,
2021-08-07 00:01:51 +00:00
help = ' List available formats of each video. Simulate unless --no-simulate is used ' )
2020-12-13 14:29:09 +00:00
video_format . add_option (
' --list-formats-as-table ' ,
Change defaults
* Enabled --ignore by default
* Disabled --video-multistreams and --audio-multistreams by default
* Changed default format selection to 'bv*+ba/b' when --audio-multistreams is disabled
* Changed default format sort order to 'res,fps,codec,size,br,asr,proto,ext,has_audio,source,format_id'
* Changed default output template to '%(title)s [%(id)s].%(ext)s'
* Enabled `--list-formats-as-table` by default
2021-01-04 16:40:47 +00:00
action = ' store_true ' , dest = ' listformats_table ' , default = True ,
2021-05-11 08:00:48 +00:00
help = optparse . SUPPRESS_HELP )
2020-12-13 14:29:09 +00:00
video_format . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --list-formats-old ' , ' --no-list-formats-as-table ' ,
2020-12-13 14:29:09 +00:00
action = ' store_false ' , dest = ' listformats_table ' ,
2021-05-11 08:00:48 +00:00
help = optparse . SUPPRESS_HELP )
2015-01-09 22:03:56 +00:00
video_format . add_option (
2015-01-10 01:03:00 +00:00
' --merge-output-format ' ,
action = ' store ' , dest = ' merge_output_format ' , metavar = ' FORMAT ' , default = None ,
2015-01-09 22:03:56 +00:00
help = (
2015-06-27 08:26:51 +00:00
' If a merge is required (e.g. bestvideo+bestaudio), '
' output to given container format. One of mkv, mp4, ogg, webm, flv. '
2015-01-09 22:03:56 +00:00
' Ignored if no merge is required ' ) )
2021-02-12 03:51:59 +00:00
video_format . add_option (
' --allow-unplayable-formats ' ,
action = ' store_true ' , dest = ' allow_unplayable_formats ' , default = False ,
2021-08-22 20:08:38 +00:00
help = optparse . SUPPRESS_HELP )
2021-02-12 03:51:59 +00:00
video_format . add_option (
' --no-allow-unplayable-formats ' ,
action = ' store_false ' , dest = ' allow_unplayable_formats ' ,
2021-08-22 20:08:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
subtitles = optparse . OptionGroup ( parser , ' Subtitle Options ' )
subtitles . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --write-subs ' , ' --write-srt ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' writesubtitles ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Write subtitle file ' )
2014-10-12 21:10:11 +00:00
subtitles . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --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 ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' writeautomaticsub ' , default = False ,
2021-03-18 15:34:09 +00:00
help = ' Write automatically generated subtitle file (Alias: --write-automatic-subs) ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
subtitles . add_option (
' --no-write-auto-subs ' , ' --no-write-automatic-subs ' ,
action = ' store_false ' , dest = ' writeautomaticsub ' , default = False ,
2021-03-18 15:34:09 +00:00
help = ' Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs) ' )
2014-10-12 21:10:11 +00:00
subtitles . add_option (
' --all-subs ' ,
action = ' store_true ' , dest = ' allsubtitles ' , default = False ,
2021-04-19 21:17:09 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
subtitles . add_option (
' --list-subs ' ,
action = ' store_true ' , dest = ' listsubtitles ' , default = False ,
2021-08-07 00:01:51 +00:00
help = ' List available subtitles of each video. Simulate unless --no-simulate is used ' )
2014-10-12 21:10:11 +00:00
subtitles . add_option (
' --sub-format ' ,
2015-02-15 17:03:41 +00:00
action = ' store ' , dest = ' subtitlesformat ' , metavar = ' FORMAT ' , default = ' best ' ,
2015-04-04 14:00:23 +00:00
help = ' Subtitle format, accepts formats preference, for example: " srt " or " ass/srt/best " ' )
2014-10-12 21:10:11 +00:00
subtitles . add_option (
2021-03-18 15:34:09 +00:00
' --sub-langs ' , ' --srt-langs ' ,
2014-10-12 21:10:11 +00:00
action = ' callback ' , dest = ' subtitleslangs ' , metavar = ' LANGS ' , type = ' str ' ,
2021-05-13 12:21:22 +00:00
default = [ ] , callback = _list_from_options_callback ,
2021-04-19 21:17:09 +00:00
help = (
2021-11-03 22:10:35 +00:00
' Languages of the subtitles to download (can be regex) or " all " separated by commas. (Eg: --sub-langs " en.*,ja " ) '
2021-04-19 21:17:09 +00:00
' 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 ' ) )
2014-10-12 21:10:11 +00:00
downloader = optparse . OptionGroup ( parser , ' Download Options ' )
2021-03-13 04:46:58 +00:00
downloader . add_option (
' -N ' , ' --concurrent-fragments ' ,
dest = ' concurrent_fragment_downloads ' , metavar = ' N ' , default = 1 , type = int ,
2021-12-23 01:42:26 +00:00
help = ' Number of fragments of a dash/hlsnative video that should be downloaded concurrently (default is %d efault) ' )
2014-10-12 21:10:11 +00:00
downloader . add_option (
2016-05-30 14:48:35 +00:00
' -r ' , ' --limit-rate ' , ' --rate-limit ' ,
dest = ' ratelimit ' , metavar = ' RATE ' ,
2015-03-25 10:02:55 +00:00
help = ' Maximum download rate in bytes per second (e.g. 50K or 4.2M) ' )
2021-06-22 23:11:09 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
downloader . add_option (
' -R ' , ' --retries ' ,
dest = ' retries ' , metavar = ' RETRIES ' , default = 10 ,
2021-01-18 19:17:48 +00:00
help = ' Number of retries (default is %d efault), or " infinite " ' )
2021-12-23 02:29:03 +00:00
downloader . add_option (
' --file-access-retries ' ,
dest = ' file_access_retries ' , metavar = ' RETRIES ' , default = 10 ,
help = ' Number of times to retry on file access error (default is %d efault), or " infinite " ' )
2016-03-19 14:40:36 +00:00
downloader . add_option (
' --fragment-retries ' ,
dest = ' fragment_retries ' , metavar = ' RETRIES ' , default = 10 ,
2017-03-28 16:35:48 +00:00
help = ' Number of retries for a fragment (default is %d efault), or " infinite " (DASH, hlsnative and ISM) ' )
2016-08-26 21:52:18 +00:00
downloader . add_option (
2021-01-07 06:41:05 +00:00
' --skip-unavailable-fragments ' , ' --no-abort-on-unavailable-fragment ' ,
2016-08-26 21:52:18 +00:00
action = ' store_true ' , dest = ' skip_unavailable_fragments ' , default = True ,
2021-01-18 19:17:48 +00:00
help = ' Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment) ' )
2017-01-28 14:06:22 +00:00
downloader . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --abort-on-unavailable-fragment ' , ' --no-skip-unavailable-fragments ' ,
2016-08-26 21:52:18 +00:00
action = ' store_false ' , dest = ' skip_unavailable_fragments ' ,
2021-01-18 19:17:48 +00:00
help = ' Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments) ' )
2017-04-23 20:09:08 +00:00
downloader . add_option (
' --keep-fragments ' ,
action = ' store_true ' , dest = ' keep_fragments ' , default = False ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
downloader . add_option (
' --buffer-size ' ,
dest = ' buffersize ' , metavar = ' SIZE ' , default = ' 1024 ' ,
2015-03-25 10:02:55 +00:00
help = ' Size of download buffer (e.g. 1024 or 16K) (default is %d efault) ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
downloader . add_option (
' --no-resize-buffer ' ,
action = ' store_true ' , dest = ' noresizebuffer ' , default = False ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = ' Do not automatically adjust the buffer size ' )
2018-01-28 06:21:45 +00:00
downloader . add_option (
' --http-chunk-size ' ,
dest = ' http_chunk_size ' , metavar = ' SIZE ' , default = None ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
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) ' ) )
2014-10-12 21:10:11 +00:00
downloader . add_option (
' --test ' ,
action = ' store_true ' , dest = ' test ' , default = False ,
help = optparse . SUPPRESS_HELP )
2014-07-11 03:11:11 +00:00
downloader . add_option (
' --playlist-reverse ' ,
action = ' store_true ' ,
help = ' Download playlist videos in reverse order ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
downloader . add_option (
' --no-playlist-reverse ' ,
2021-01-07 06:41:05 +00:00
action = ' store_false ' , dest = ' playlist_reverse ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = ' Download playlist videos in default order (default) ' )
2017-01-31 09:03:31 +00:00
downloader . add_option (
' --playlist-random ' ,
action = ' store_true ' ,
help = ' Download playlist videos in random order ' )
2015-01-25 03:49:44 +00:00
downloader . add_option (
' --xattr-set-filesize ' ,
dest = ' xattr_set_filesize ' , action = ' store_true ' ,
2018-05-19 16:53:24 +00:00
help = ' Set file xattribute ytdl.filesize with expected file size ' )
2015-02-17 11:09:12 +00:00
downloader . add_option (
' --hls-prefer-native ' ,
2016-04-21 17:02:17 +00:00
dest = ' hls_prefer_native ' , action = ' store_true ' , default = None ,
2021-04-10 15:08:33 +00:00
help = optparse . SUPPRESS_HELP )
2016-04-21 17:02:17 +00:00
downloader . add_option (
' --hls-prefer-ffmpeg ' ,
dest = ' hls_prefer_native ' , action = ' store_false ' , default = None ,
2021-04-10 15:08:33 +00:00
help = optparse . SUPPRESS_HELP )
2016-01-30 11:26:40 +00:00
downloader . add_option (
' --hls-use-mpegts ' ,
2021-02-26 16:21:31 +00:00
dest = ' hls_use_mpegts ' , action = ' store_true ' , default = None ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
2021-02-26 16:21:31 +00:00
' 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 ' ) )
2015-01-24 00:38:48 +00:00
downloader . add_option (
2021-04-10 15:08:33 +00:00
' --downloader ' , ' --external-downloader ' ,
dest = ' external_downloader ' , metavar = ' [PROTO:]NAME ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
2021-04-10 15:08:33 +00:00
callback_kwargs = {
' allowed_keys ' : ' http|ftp|m3u8|dash|rtsp|rtmp|mms ' ,
2021-05-01 15:59:42 +00:00
' default_key ' : ' default ' ,
2021-07-31 10:51:01 +00:00
' process ' : str . strip
} , help = (
2021-04-10 15:08:33 +00:00
' 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 ( ) ) ) )
2015-03-02 14:06:09 +00:00
downloader . add_option (
2021-01-23 05:59:20 +00:00
' --downloader-args ' , ' --external-downloader-args ' ,
metavar = ' NAME:ARGS ' , dest = ' external_downloader_args ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
2021-01-23 12:11:21 +00:00
callback_kwargs = {
2022-01-03 19:37:24 +00:00
' allowed_keys ' : r ' ffmpeg_[io] \ d*| %s ' % ' | ' . join ( map ( re . escape , list_external_downloaders ( ) ) ) ,
2021-05-01 15:59:42 +00:00
' default_key ' : ' default ' ,
' process ' : compat_shlex_split
2021-07-31 10:51:01 +00:00
} , help = (
2021-01-23 05:59:20 +00:00
' Give these arguments to the external downloader. '
' Specify the downloader name and the arguments separated by a colon " : " . '
2021-08-23 21:45:44 +00:00
' For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
2021-06-25 14:05:41 +00:00
' You can use this option multiple times to give different arguments to different downloaders '
' (Alias: --external-downloader-args) ' ) )
2014-10-12 21:10:11 +00:00
workarounds = optparse . OptionGroup ( parser , ' Workarounds ' )
2014-09-13 05:55:21 +00:00
workarounds . add_option (
2014-10-12 21:10:11 +00:00
' --encoding ' ,
dest = ' encoding ' , metavar = ' ENCODING ' ,
2014-09-13 05:55:21 +00:00
help = ' Force the specified encoding (experimental) ' )
2022-01-21 06:12:30 +00:00
workarounds . add_option (
' --legacy-server-connect ' ,
action = ' store_true ' , dest = ' legacy_server_connect ' , default = False ,
help = ' Explicitly allow HTTPS connection to servers that do not support RFC 5746 secure renegotiation ' )
2014-09-13 05:55:21 +00:00
workarounds . add_option (
2021-09-17 18:23:55 +00:00
' --no-check-certificates ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' no_check_certificate ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Suppress HTTPS certificate validation ' )
2014-09-13 05:55:21 +00:00
workarounds . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --prefer-insecure ' , ' --prefer-unsecure ' ,
action = ' store_true ' , dest = ' prefer_insecure ' ,
2021-03-18 15:34:09 +00:00
help = ' Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube) ' )
2014-09-13 05:55:21 +00:00
workarounds . add_option (
2014-10-12 21:10:11 +00:00
' --user-agent ' ,
metavar = ' UA ' , dest = ' user_agent ' ,
2015-03-25 10:02:55 +00:00
help = ' Specify a custom user agent ' )
2014-09-13 05:55:21 +00:00
workarounds . add_option (
2014-10-12 21:10:11 +00:00
' --referer ' ,
metavar = ' URL ' , dest = ' referer ' , default = None ,
2015-03-25 10:02:55 +00:00
help = ' Specify a custom referer, use if the video access is restricted to one domain ' ,
2014-09-13 05:55:21 +00:00
)
workarounds . add_option (
2014-10-12 21:10:11 +00:00
' --add-header ' ,
2021-01-23 05:57:27 +00:00
metavar = ' FIELD:VALUE ' , dest = ' headers ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
2021-11-10 13:03:37 +00:00
callback_kwargs = { ' multiple_keys ' : False , ' process_key ' : None } ,
2021-01-23 05:57:27 +00:00
help = ' Specify a custom HTTP header and its value, separated by a colon " : " . You can use this option multiple times ' ,
2014-09-13 05:55:21 +00:00
)
workarounds . add_option (
2014-10-12 21:10:11 +00:00
' --bidi-workaround ' ,
dest = ' bidi_workaround ' , action = ' store_true ' ,
help = ' Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH ' )
2021-02-27 12:41:23 +00:00
workarounds . add_option (
' --sleep-requests ' , metavar = ' SECONDS ' ,
dest = ' sleep_interval_requests ' , type = float ,
help = ' Number of seconds to sleep between requests during data extraction ' )
2015-01-23 11:05:01 +00:00
workarounds . add_option (
2016-08-04 10:17:22 +00:00
' --sleep-interval ' , ' --min-sleep-interval ' , metavar = ' SECONDS ' ,
2015-01-23 11:07:13 +00:00
dest = ' sleep_interval ' , type = float ,
2016-08-08 20:46:52 +00:00
help = (
2021-03-18 15:34:09 +00:00
' 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) ' ) )
2016-08-04 10:17:22 +00:00
workarounds . add_option (
' --max-sleep-interval ' , metavar = ' SECONDS ' ,
dest = ' max_sleep_interval ' , type = float ,
2021-03-18 15:34:09 +00:00
help = ' Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval ' )
2020-09-29 03:11:32 +00:00
workarounds . add_option (
2021-01-07 06:41:05 +00:00
' --sleep-subtitles ' , metavar = ' SECONDS ' ,
2020-11-01 02:36:16 +00:00
dest = ' sleep_interval_subtitles ' , default = 0 , type = int ,
2021-02-27 12:41:23 +00:00
help = ' Number of seconds to sleep before each subtitle download ' )
2014-09-13 05:55:21 +00:00
2021-02-24 19:46:57 +00:00
verbosity = optparse . OptionGroup ( parser , ' Verbosity and Simulation Options ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -q ' , ' --quiet ' ,
action = ' store_true ' , dest = ' quiet ' , default = False ,
2021-08-07 08:49:17 +00:00
help = ' Activate quiet mode. If used with --verbose, print the log to stderr ' )
2014-09-13 05:55:21 +00:00
verbosity . add_option (
' --no-warnings ' ,
dest = ' no_warnings ' , action = ' store_true ' , default = False ,
help = ' Ignore warnings ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -s ' , ' --simulate ' ,
2021-08-07 00:01:51 +00:00
action = ' store_true ' , dest = ' simulate ' , default = None ,
2015-03-25 10:02:55 +00:00
help = ' Do not download the video and do not write anything to disk ' )
2021-08-07 00:01:51 +00:00
verbosity . add_option (
' --no-simulate ' ,
action = ' store_false ' , dest = ' simulate ' ,
help = ' Download the video even if printing/listing options are used ' )
2021-04-17 00:09:58 +00:00
verbosity . add_option (
' --ignore-no-formats-error ' ,
action = ' store_true ' , dest = ' ignore_no_formats_error ' , default = False ,
help = (
2021-10-31 09:15:59 +00:00
' Ignore " No video formats " error. Useful for extracting metadata '
2021-08-07 08:49:17 +00:00
' even if the videos are not actually available for download (experimental) ' ) )
2021-04-17 00:09:58 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --skip-download ' , ' --no-download ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' skip_download ' , default = False ,
2021-03-18 15:34:09 +00:00
help = ' Do not download the video but write all related files (Alias: --no-download) ' )
2021-05-14 07:44:38 +00:00
verbosity . add_option (
2021-08-09 12:10:24 +00:00
' -O ' , ' --print ' ,
2022-01-02 10:52:00 +00:00
metavar = ' [WHEN:]TEMPLATE ' , dest = ' forceprint ' , default = { } , type = ' str ' ,
action = ' callback ' , callback = _dict_from_options_callback ,
callback_kwargs = {
2022-01-10 18:27:59 +00:00
' allowed_keys ' : ' video| ' + ' | ' . join ( map ( re . escape , POSTPROCESS_WHEN ) ) ,
2022-01-02 10:52:00 +00:00
' default_key ' : ' video ' ,
' multiple_keys ' : False ,
' append ' : True ,
} , help = (
2022-01-10 18:27:59 +00:00
' Field name or output template to print to screen, optionally prefixed with when to print it, separated by a " : " . '
' Supported values of " WHEN " are the same as that of --use-postprocessor, and " video " (default). '
2022-01-02 10:52:00 +00:00
' Implies --quiet and --simulate (unless --no-simulate is used). This option can be used multiple times ' ) )
2022-01-23 21:34:19 +00:00
verbosity . add_option (
' --print-to-file ' ,
metavar = ' [WHEN:]TEMPLATE FILE ' , dest = ' print_to_file ' , default = { } , type = ' str ' , nargs = 2 ,
action = ' callback ' , callback = _dict_from_options_callback ,
callback_kwargs = {
' allowed_keys ' : ' video| ' + ' | ' . join ( map ( re . escape , POSTPROCESS_WHEN ) ) ,
' default_key ' : ' video ' ,
' multiple_keys ' : False ,
' append ' : True ,
} , help = (
' Append given template to the file. The values of WHEN and TEMPLATE are same as that of --print. '
' FILE uses the same syntax as the output template. This option can be used multiple times ' ) )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -g ' , ' --get-url ' ,
action = ' store_true ' , dest = ' geturl ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -e ' , ' --get-title ' ,
action = ' store_true ' , dest = ' gettitle ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-id ' ,
action = ' store_true ' , dest = ' getid ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-thumbnail ' ,
action = ' store_true ' , dest = ' getthumbnail ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-description ' ,
action = ' store_true ' , dest = ' getdescription ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-duration ' ,
action = ' store_true ' , dest = ' getduration ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-filename ' ,
action = ' store_true ' , dest = ' getfilename ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --get-format ' ,
action = ' store_true ' , dest = ' getformat ' , default = False ,
2021-05-14 07:44:38 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -j ' , ' --dump-json ' ,
action = ' store_true ' , dest = ' dumpjson ' , default = False ,
2021-08-07 00:01:51 +00:00
help = ' Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See " OUTPUT TEMPLATE " for a description of available keys ' )
2014-10-24 22:30:57 +00:00
verbosity . add_option (
' -J ' , ' --dump-single-json ' ,
action = ' store_true ' , dest = ' dump_single_json ' , default = False ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
2021-08-07 00:01:51 +00:00
' 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 ' ) )
2015-01-08 17:01:41 +00:00
verbosity . add_option (
' --print-json ' ,
action = ' store_true ' , dest = ' print_json ' , default = False ,
2021-08-07 00:01:51 +00:00
help = optparse . SUPPRESS_HELP )
2020-11-05 17:43:21 +00:00
verbosity . add_option (
2021-01-07 06:41:05 +00:00
' --force-write-archive ' , ' --force-write-download-archive ' , ' --force-download-archive ' ,
2020-11-05 17:43:21 +00:00
action = ' store_true ' , dest = ' force_write_download_archive ' , default = False ,
help = (
2021-04-22 11:04:02 +00:00
' 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) ' ) )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --newline ' ,
action = ' store_true ' , dest = ' progress_with_newline ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Output progress bar as new lines ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --no-progress ' ,
2021-10-08 19:11:59 +00:00
action = ' store_true ' , dest = ' noprogress ' , default = None ,
2015-03-25 10:02:55 +00:00
help = ' Do not print progress bar ' )
2021-10-08 19:11:59 +00:00
verbosity . add_option (
' --progress ' ,
action = ' store_false ' , dest = ' noprogress ' ,
help = ' Show progress bar, even if in quiet mode ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --console-title ' ,
action = ' store_true ' , dest = ' consoletitle ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Display progress in console titlebar ' )
2021-10-08 19:11:59 +00:00
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 '
2021-10-31 09:15:59 +00:00
' the progress attributes are accessible under " progress " key. E.g.: '
2021-10-08 19:11:59 +00:00
# TODO: Document the fields inside "progress"
' --console-title --progress-template " download-title: % (info.id)s- % (progress.eta)s " ' ) )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' -v ' , ' --verbose ' ,
action = ' store_true ' , dest = ' verbose ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Print various debugging information ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
2015-03-08 17:37:43 +00:00
' --dump-pages ' , ' --dump-intermediate-pages ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' dump_intermediate_pages ' , default = False ,
2015-05-22 14:14:55 +00:00
help = ' Print downloaded pages encoded using base64 to debug problems (very verbose) ' )
2014-10-12 21:10:11 +00:00
verbosity . add_option (
' --write-pages ' ,
action = ' store_true ' , dest = ' write_pages ' , default = False ,
help = ' Write downloaded intermediary pages to files in the current directory to debug problems ' )
verbosity . add_option (
' --youtube-print-sig-code ' ,
action = ' store_true ' , dest = ' youtube_print_sig_code ' , default = False ,
help = optparse . SUPPRESS_HELP )
verbosity . add_option (
2015-02-10 03:52:33 +00:00
' --print-traffic ' , ' --dump-headers ' ,
2014-10-12 21:10:11 +00:00
dest = ' debug_printtraffic ' , action = ' store_true ' , default = False ,
help = ' Display sent and read HTTP traffic ' )
2015-01-10 20:02:27 +00:00
verbosity . add_option (
' -C ' , ' --call-home ' ,
dest = ' call_home ' , action = ' store_true ' , default = False ,
2021-02-24 18:45:56 +00:00
# help='[Broken] Contact the yt-dlp server for debugging')
2021-02-09 20:06:02 +00:00
help = optparse . SUPPRESS_HELP )
2015-01-10 20:09:15 +00:00
verbosity . add_option (
' --no-call-home ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
dest = ' call_home ' , action = ' store_false ' ,
2021-02-24 18:45:56 +00:00
# help='Do not contact the yt-dlp server for debugging (default)')
2021-02-09 20:06:02 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
filesystem = optparse . OptionGroup ( parser , ' Filesystem Options ' )
filesystem . add_option (
' -a ' , ' --batch-file ' ,
dest = ' batchfile ' , metavar = ' FILE ' ,
2021-12-17 22:58:18 +00:00
help = (
' File containing URLs to download ( " - " for stdin), one URL per line. '
' Lines starting with " # " , " ; " or " ] " are considered as comments and ignored ' ) )
2021-10-18 19:11:07 +00:00
filesystem . add_option (
' --no-batch-file ' ,
dest = ' batchfile ' , action = ' store_const ' , const = None ,
help = ' Do not read URLs from batch file (default) ' )
2021-10-21 23:04:22 +00:00
filesystem . add_option (
' --id ' , default = False ,
action = ' store_true ' , dest = ' useid ' , help = optparse . SUPPRESS_HELP )
2021-01-23 12:18:12 +00:00
filesystem . add_option (
' -P ' , ' --paths ' ,
2021-07-31 13:30:32 +00:00
metavar = ' [TYPES:]PATH ' , dest = ' paths ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
2021-07-31 13:30:32 +00:00
callback_kwargs = {
2022-01-03 19:37:24 +00:00
' allowed_keys ' : ' home|temp| %s ' % ' | ' . join ( map ( re . escape , OUTTMPL_TYPES . keys ( ) ) ) ,
2021-07-31 13:30:32 +00:00
' default_key ' : ' home '
} , help = (
2021-01-23 12:18:12 +00:00
' The paths where the files should be downloaded. '
2021-02-03 13:36:09 +00:00
' Specify the type of file and the path separated by a colon " : " . '
2021-12-27 01:56:21 +00:00
' All the same TYPES as --output are supported. '
2021-07-31 13:30:32 +00:00
' Additionally, you can also provide " home " (default) and " temp " paths. '
2021-01-23 12:18:12 +00:00
' 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. '
2021-02-03 13:36:09 +00:00
' This option is ignored if --output is an absolute path ' ) )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' -o ' , ' --output ' ,
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
metavar = ' [TYPES:]TEMPLATE ' , dest = ' outtmpl ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
2021-02-03 13:36:09 +00:00
callback_kwargs = {
2022-01-03 19:37:24 +00:00
' allowed_keys ' : ' | ' . join ( map ( re . escape , OUTTMPL_TYPES . keys ( ) ) ) ,
2021-05-01 15:59:42 +00:00
' default_key ' : ' default '
2021-07-31 10:51:01 +00:00
} , help = ' Output filename template; see " OUTPUT TEMPLATE " for details ' )
2021-01-16 17:12:05 +00:00
filesystem . add_option (
' --output-na-placeholder ' ,
2021-01-24 16:01:13 +00:00
dest = ' outtmpl_na_placeholder ' , metavar = ' TEXT ' , default = ' NA ' ,
help = ( ' Placeholder value for unavailable meta fields in output filename template (default: " %d efault " ) ' ) )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --autonumber-size ' ,
2017-02-23 23:04:27 +00:00
dest = ' autonumber_size ' , metavar = ' NUMBER ' , type = int ,
help = optparse . SUPPRESS_HELP )
2016-05-01 12:34:11 +00:00
filesystem . add_option (
' --autonumber-start ' ,
2017-01-28 16:57:56 +00:00
dest = ' autonumber_start ' , metavar = ' NUMBER ' , default = 1 , type = int ,
2021-04-15 12:31:16 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
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 ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --no-restrict-filenames ' ,
2021-02-17 19:09:38 +00:00
action = ' store_false ' , dest = ' restrictfilenames ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = ' Allow Unicode characters, " & " and spaces in filenames (default) ' )
2021-02-17 19:09:38 +00:00
filesystem . add_option (
' --windows-filenames ' ,
action = ' store_true ' , dest = ' windowsfilenames ' , default = False ,
2021-10-31 09:15:59 +00:00
help = ' Force filenames to be Windows-compatible ' )
2021-02-17 19:09:38 +00:00
filesystem . add_option (
' --no-windows-filenames ' ,
action = ' store_false ' , dest = ' windowsfilenames ' ,
2021-10-31 09:15:59 +00:00
help = ' Make filenames Windows-compatible only if using Windows (default) ' )
2021-02-17 19:09:38 +00:00
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 ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' -w ' , ' --no-overwrites ' ,
2019-10-13 16:00:48 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' -c ' , ' --continue ' ,
action = ' store_true ' , dest = ' continue_dl ' , default = True ,
2021-02-04 22:53:04 +00:00
help = ' Resume partially downloaded files/fragments (default) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --no-continue ' ,
action = ' store_false ' , dest = ' continue_dl ' ,
2021-02-04 22:53:04 +00:00
help = (
' Do not resume partially downloaded fragments. '
2021-04-22 11:04:02 +00:00
' If the file is not fragmented, restart download of the entire file ' ) )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --part ' ,
action = ' store_false ' , dest = ' nopart ' , default = False ,
help = ' Use .part files instead of writing directly into output file (default) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --no-part ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
action = ' store_true ' , dest = ' nopart ' ,
2015-03-25 10:02:55 +00:00
help = ' Do not use .part files - write directly into output file ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --mtime ' ,
action = ' store_true ' , dest = ' updatetime ' , default = True ,
help = ' Use the Last-modified header to set the file modification time (default) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --no-mtime ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
action = ' store_false ' , dest = ' updatetime ' ,
2015-03-25 10:02:55 +00:00
help = ' Do not use the Last-modified header to set the file modification time ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --write-description ' ,
action = ' store_true ' , dest = ' writedescription ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Write video description to a .description file ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --no-write-description ' ,
action = ' store_false ' , dest = ' writedescription ' ,
help = ' Do not write video description (default) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --write-info-json ' ,
action = ' store_true ' , dest = ' writeinfojson ' , default = False ,
2021-02-04 22:53:04 +00:00
help = ' Write video metadata to a .info.json file (this may contain personal information) ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --no-write-info-json ' ,
action = ' store_false ' , dest = ' writeinfojson ' ,
help = ' Do not write video metadata (default) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --write-annotations ' ,
action = ' store_true ' , dest = ' writeannotations ' , default = False ,
2021-08-24 03:52:40 +00:00
help = optparse . SUPPRESS_HELP )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --no-write-annotations ' ,
action = ' store_false ' , dest = ' writeannotations ' ,
2021-08-24 03:52:40 +00:00
help = optparse . SUPPRESS_HELP )
2021-01-30 11:13:20 +00:00
filesystem . add_option (
' --write-playlist-metafiles ' ,
2021-05-11 08:00:48 +00:00
action = ' store_true ' , dest = ' allow_playlist_files ' , default = None ,
2021-01-30 11:13:20 +00:00
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 ' ,
2021-03-18 15:34:09 +00:00
help = ' Do not write playlist metadata when using --write-info-json, --write-description etc. ' )
2021-03-18 15:27:20 +00:00
filesystem . add_option (
2022-02-10 15:43:28 +00:00
' --clean-info-json ' , ' --clean-infojson ' ,
2021-07-31 06:08:39 +00:00
action = ' store_true ' , dest = ' clean_infojson ' , default = None ,
2021-03-18 15:27:20 +00:00
help = (
' Remove some private fields such as filenames from the infojson. '
' Note that it could still contain some personal information (default) ' ) )
filesystem . add_option (
2022-02-10 15:43:28 +00:00
' --no-clean-info-json ' , ' --no-clean-infojson ' ,
2021-03-18 15:27:20 +00:00
action = ' store_false ' , dest = ' clean_infojson ' ,
help = ' Write all fields to the infojson ' )
2021-01-27 15:02:51 +00:00
filesystem . add_option (
2021-05-20 10:10:35 +00:00
' --write-comments ' , ' --get-comments ' ,
2021-01-27 15:02:51 +00:00
action = ' store_true ' , dest = ' getcomments ' , default = False ,
2021-02-28 14:56:08 +00:00
help = (
2021-05-20 10:10:35 +00:00
' 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 ' ,
2021-09-03 19:48:56 +00:00
action = ' store_false ' , dest = ' getcomments ' ,
2021-05-20 10:10:35 +00:00
help = ' Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
2016-06-05 19:52:58 +00:00
' --load-info-json ' , ' --load-info ' ,
2014-10-12 21:10:11 +00:00
dest = ' load_info_filename ' , metavar = ' FILE ' ,
2015-04-04 14:09:11 +00:00
help = ' JSON file containing the video information (created with the " --write-info-json " option) ' )
2014-10-12 21:10:11 +00:00
filesystem . add_option (
' --cookies ' ,
dest = ' cookiefile ' , metavar = ' FILE ' ,
2021-11-28 21:22:52 +00:00
help = ' Netscape formatted file to read cookies from and dump cookie jar in ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
filesystem . add_option (
' --no-cookies ' ,
action = ' store_const ' , const = None , dest = ' cookiefile ' , metavar = ' FILE ' ,
2021-07-21 20:32:49 +00:00
help = ' Do not read/dump cookies from/to file (default) ' )
filesystem . add_option (
' --cookies-from-browser ' ,
2021-12-27 01:28:44 +00:00
dest = ' cookiesfrombrowser ' , metavar = ' BROWSER[+KEYRING][:PROFILE] ' ,
2021-07-21 20:32:49 +00:00
help = (
2021-12-27 01:28:44 +00:00
' The name of the browser and (optionally) the name/path of '
' the profile to load cookies from, separated by a " : " . '
f ' Currently supported browsers are: { " , " . join ( sorted ( SUPPORTED_BROWSERS ) ) } . '
' By default, the most recently accessed profile is used. '
' The keyring used for decrypting Chromium cookies on Linux can be '
' (optionally) specified after the browser name separated by a " + " . '
f ' Currently supported keyrings are: { " , " . join ( map ( str . lower , sorted ( SUPPORTED_KEYRINGS ) ) ) } ' ) )
2021-07-21 20:32:49 +00:00
filesystem . add_option (
' --no-cookies-from-browser ' ,
action = ' store_const ' , const = None , dest = ' cookiesfrombrowser ' ,
help = ' Do not load cookies from browser (default) ' )
2014-09-13 05:55:21 +00:00
filesystem . add_option (
' --cache-dir ' , dest = ' cachedir ' , default = None , metavar = ' DIR ' ,
2021-09-01 23:09:47 +00:00
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 ' )
2014-09-13 05:55:21 +00:00
filesystem . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --no-cache-dir ' , action = ' store_false ' , dest = ' cachedir ' ,
2014-09-13 05:55:21 +00:00
help = ' Disable filesystem caching ' )
filesystem . add_option (
2014-10-12 21:10:11 +00:00
' --rm-cache-dir ' ,
action = ' store_true ' , dest = ' rm_cachedir ' ,
2014-09-13 05:55:21 +00:00
help = ' Delete all filesystem cache files ' )
2021-04-11 00:22:55 +00:00
thumbnail = optparse . OptionGroup ( parser , ' Thumbnail Options ' )
2015-01-25 01:38:47 +00:00
thumbnail . add_option (
' --write-thumbnail ' ,
2021-12-06 17:56:34 +00:00
action = ' callback ' , dest = ' writethumbnail ' , default = False ,
# Should override --no-write-thumbnail, but not --write-all-thumbnail
callback = lambda option , _ , __ , parser : setattr (
parser . values , option . dest , getattr ( parser . values , option . dest ) or True ) ,
2015-03-25 10:02:55 +00:00
help = ' Write thumbnail image to disk ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
thumbnail . add_option (
' --no-write-thumbnail ' ,
action = ' store_false ' , dest = ' writethumbnail ' ,
help = ' Do not write thumbnail image to disk (default) ' )
2015-01-25 02:11:12 +00:00
thumbnail . add_option (
' --write-all-thumbnails ' ,
2021-12-06 17:56:34 +00:00
action = ' store_const ' , dest = ' writethumbnail ' , const = ' all ' ,
2015-03-25 10:02:55 +00:00
help = ' Write all thumbnail image formats to disk ' )
2015-01-25 01:38:47 +00:00
thumbnail . add_option (
' --list-thumbnails ' ,
action = ' store_true ' , dest = ' list_thumbnails ' , default = False ,
2021-08-07 00:01:51 +00:00
help = ' List available thumbnails of each video. Simulate unless --no-simulate is used ' )
2015-01-25 01:38:47 +00:00
2020-10-27 10:37:21 +00:00
link = optparse . OptionGroup ( parser , ' Internet Shortcut Options ' )
link . add_option (
' --write-link ' ,
action = ' store_true ' , dest = ' writelink ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS ' )
2020-10-27 10:37:21 +00:00
link . add_option (
' --write-url-link ' ,
action = ' store_true ' , dest = ' writeurllink ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Write a .url Windows internet shortcut. The OS caches the URL based on the file path ' )
2020-10-27 10:37:21 +00:00
link . add_option (
' --write-webloc-link ' ,
action = ' store_true ' , dest = ' writewebloclink ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Write a .webloc macOS internet shortcut ' )
2020-10-27 10:37:21 +00:00
link . add_option (
' --write-desktop-link ' ,
action = ' store_true ' , dest = ' writedesktoplink ' , default = False ,
2021-01-18 19:17:48 +00:00
help = ' Write a .desktop Linux internet shortcut ' )
2020-10-27 10:37:21 +00:00
postproc = optparse . OptionGroup ( parser , ' Post-Processing Options ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' -x ' , ' --extract-audio ' ,
action = ' store_true ' , dest = ' extractaudio ' , default = False ,
2021-01-26 17:57:32 +00:00
help = ' Convert video files to audio-only files (requires ffmpeg and ffprobe) ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --audio-format ' , metavar = ' FORMAT ' , dest = ' audioformat ' , default = ' best ' ,
2021-05-22 08:24:12 +00:00
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 ) ) )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --audio-quality ' , metavar = ' QUALITY ' ,
dest = ' audioquality ' , default = ' 5 ' ,
2021-11-03 18:35:53 +00:00
help = ' Specify ffmpeg audio quality, insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %d efault) ' )
2020-05-16 16:09:12 +00:00
postproc . add_option (
' --remux-video ' ,
metavar = ' FORMAT ' , dest = ' remuxvideo ' , default = None ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
2021-01-28 03:56:50 +00:00
' Remux the video into another container if necessary (currently supported: %s ). '
2021-01-27 15:02:51 +00:00
' If target container does not support the video/audio codec, remuxing will fail. '
2021-05-22 08:24:12 +00:00
' 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 ) ) )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --recode-video ' ,
metavar = ' FORMAT ' , dest = ' recodevideo ' , default = None ,
2021-01-28 03:56:50 +00:00
help = (
' Re-encode the video into another format if re-encoding is necessary. '
2021-05-22 08:24:12 +00:00
' The syntax and supported formats are the same as --remux-video ' ) )
2015-06-10 01:08:16 +00:00
postproc . add_option (
2021-01-23 05:57:27 +00:00
' --postprocessor-args ' , ' --ppa ' ,
metavar = ' NAME:ARGS ' , dest = ' postprocessor_args ' , default = { } , type = ' str ' ,
2021-05-13 12:21:22 +00:00
action = ' callback ' , callback = _dict_from_options_callback ,
Improve argument parsing for `-P`, `-o`, `-S`
* `-P "subtitle,thumbnail:PATH"` is now possible. Similarly for `-o`
* `-S "fps,br" -S "res,codec"` is now interpreted as `-S res,codec,fps,br`. Previously, `-S fps,br` was ignored in this case.
2021-04-10 15:00:38 +00:00
callback_kwargs = {
2022-01-03 19:37:24 +00:00
' allowed_keys ' : r ' \ w+(?: \ + \ w+)? ' ,
' default_key ' : ' default-compat ' ,
2021-05-01 15:59:42 +00:00
' process ' : compat_shlex_split ,
' multiple_keys ' : False
2021-07-31 10:51:01 +00:00
} , help = (
2021-01-07 19:28:41 +00:00
' Give these arguments to the postprocessors. '
2021-01-20 16:07:40 +00:00
' Specify the postprocessor/executable name and the arguments separated by a colon " : " '
2021-04-10 22:18:52 +00:00
' to give the argument to the specified postprocessor/executable. Supported PP are: '
2021-09-01 20:55:16 +00:00
' 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. '
2021-01-20 16:07:40 +00:00
' You can also specify " PP+EXE:ARGS " to give the arguments to the specified executable '
2021-02-24 16:05:18 +00:00
' only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
2021-03-15 00:00:18 +00:00
' " _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 " . '
2021-02-24 16:05:18 +00:00
' You can use this option multiple times to give different arguments to different '
' postprocessors. (Alias: --ppa) ' ) )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' -k ' , ' --keep-video ' ,
action = ' store_true ' , dest = ' keepvideo ' , default = False ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
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) ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --no-post-overwrites ' ,
action = ' store_true ' , dest = ' nopostoverwrites ' , default = False ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = ' Do not overwrite post-processed files ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --embed-subs ' ,
action = ' store_true ' , dest = ' embedsubtitles ' , default = False ,
2016-03-19 22:12:34 +00:00
help = ' Embed subtitles in the video (only for mp4, webm and mkv videos) ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
postproc . add_option (
' --no-embed-subs ' ,
action = ' store_false ' , dest = ' embedsubtitles ' ,
help = ' Do not embed subtitles (default) ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --embed-thumbnail ' ,
action = ' store_true ' , dest = ' embedthumbnail ' , default = False ,
2021-06-23 01:36:12 +00:00
help = ' Embed thumbnail in the video as cover art ' )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
postproc . add_option (
' --no-embed-thumbnail ' ,
action = ' store_false ' , dest = ' embedthumbnail ' ,
help = ' Do not embed thumbnail (default) ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
2021-06-19 22:24:37 +00:00
' --embed-metadata ' , ' --add-metadata ' ,
2014-10-12 21:10:11 +00:00
action = ' store_true ' , dest = ' addmetadata ' , default = False ,
2021-11-14 22:33:41 +00:00
help = (
' Embed metadata to the video file. Also embeds chapters/infojson if present '
' unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata) ' ) )
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
postproc . add_option (
2021-06-19 22:24:37 +00:00
' --no-embed-metadata ' , ' --no-add-metadata ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
action = ' store_false ' , dest = ' addmetadata ' ,
2021-09-01 20:55:16 +00:00
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) ' )
2021-11-14 22:33:41 +00:00
postproc . add_option (
' --embed-info-json ' ,
action = ' store_true ' , dest = ' embed_infojson ' , default = None ,
help = ' Embed the infojson as an attachment to mkv/mka video files ' )
postproc . add_option (
' --no-embed-info-json ' ,
action = ' store_false ' , dest = ' embed_infojson ' ,
help = ' Do not embed the infojson as an attachment to the video file ' )
2015-03-04 21:33:56 +00:00
postproc . add_option (
' --metadata-from-title ' ,
metavar = ' FORMAT ' , dest = ' metafromtitle ' ,
2021-01-26 10:20:20 +00:00
help = optparse . SUPPRESS_HELP )
postproc . add_option (
' --parse-metadata ' ,
2021-08-09 19:52:55 +00:00
metavar = ' FROM:TO ' , dest = ' parse_metadata ' , action = ' append ' ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
2021-04-03 08:33:25 +00:00
' Parse additional metadata like title/artist from other fields; '
' see " MODIFYING METADATA " for details ' ) )
2021-08-09 19:52:55 +00:00
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 ' )
2014-10-12 21:10:11 +00:00
postproc . add_option (
' --xattrs ' ,
action = ' store_true ' , dest = ' xattrs ' , default = False ,
2015-03-25 10:02:55 +00:00
help = ' Write metadata to the video file \' s xattrs (using dublin core and xdg standards) ' )
2022-01-13 11:01:08 +00:00
postproc . add_option (
' --concat-playlist ' ,
metavar = ' POLICY ' , dest = ' concat_playlist ' , default = ' multi_video ' ,
choices = ( ' never ' , ' always ' , ' multi_video ' ) ,
help = (
2022-01-19 22:57:07 +00:00
' Concatenate videos in a playlist. One of " never " , " always " , or '
' " multi_video " (default; only when the videos form a single show). '
2022-01-13 11:01:08 +00:00
' All the video files must have same codecs and number of streams to be concatable. '
' The " pl_video: " prefix can be used with " --paths " and " --output " to '
' set the output filename for the split files. See " OUTPUT TEMPLATE " for details ' ) )
2015-01-10 04:45:51 +00:00
postproc . add_option (
' --fixup ' ,
2021-03-07 07:02:59 +00:00
metavar = ' POLICY ' , dest = ' fixup ' , default = None ,
2021-06-19 22:45:19 +00:00
choices = ( ' never ' , ' ignore ' , ' warn ' , ' detect_or_warn ' , ' force ' ) ,
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
help = (
' Automatically correct known faults of the file. '
' One of never (do nothing), warn (only emit a warning), '
2021-06-19 22:45:19 +00:00
' detect_or_warn (the default; fix file if we can, warn otherwise), '
2021-11-28 21:22:52 +00:00
' force (try fixing even if file already exists) ' ) )
2014-10-12 21:10:11 +00:00
postproc . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --prefer-avconv ' , ' --no-prefer-ffmpeg ' ,
2014-10-12 21:10:11 +00:00
action = ' store_false ' , dest = ' prefer_ffmpeg ' ,
2021-01-26 17:57:32 +00:00
help = optparse . SUPPRESS_HELP )
2014-10-12 21:10:11 +00:00
postproc . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --prefer-ffmpeg ' , ' --no-prefer-avconv ' ,
2021-01-26 17:57:32 +00:00
action = ' store_true ' , dest = ' prefer_ffmpeg ' , default = True ,
help = optparse . SUPPRESS_HELP )
2015-02-13 10:14:01 +00:00
postproc . add_option (
' --ffmpeg-location ' , ' --avconv-location ' , metavar = ' PATH ' ,
dest = ' ffmpeg_location ' ,
2021-01-26 17:57:32 +00:00
help = ' Location of the ffmpeg binary; either the path to the binary or its containing directory ' )
2014-09-13 05:55:21 +00:00
postproc . add_option (
2022-01-03 11:13:54 +00:00
' --exec ' ,
metavar = ' [WHEN:]CMD ' , dest = ' exec_cmd ' , default = { } , type = ' str ' ,
action = ' callback ' , callback = _dict_from_options_callback ,
callback_kwargs = {
' allowed_keys ' : ' | ' . join ( map ( re . escape , POSTPROCESS_WHEN ) ) ,
' default_key ' : ' after_move ' ,
' multiple_keys ' : False ,
' append ' : True ,
} , help = (
' Execute a command, optionally prefixed with when to execute it (after_move if unspecified), separated by a " : " . '
' Supported values of " WHEN " are the same as that of --use-postprocessor. '
2021-08-07 08:49:17 +00:00
' Same syntax as the output template can be used to pass any field as arguments to the command. '
2022-01-03 11:13:54 +00:00
' After download, an additional field " filepath " that contains the final path of the downloaded file '
' is also available, and if no fields are passed, % (filepath)q is appended to the end of the command. '
2021-08-07 08:00:55 +00:00
' This option can be used multiple times ' ) )
postproc . add_option (
' --no-exec ' ,
2022-01-03 11:13:54 +00:00
action = ' store_const ' , dest = ' exec_cmd ' , const = { } ,
2021-08-07 08:00:55 +00:00
help = ' Remove any previously defined --exec ' )
postproc . add_option (
' --exec-before-download ' , metavar = ' CMD ' ,
2021-08-09 12:10:24 +00:00
action = ' append ' , dest = ' exec_before_dl_cmd ' ,
2022-01-03 11:13:54 +00:00
help = optparse . SUPPRESS_HELP )
2021-07-19 17:56:22 +00:00
postproc . add_option (
2021-08-07 08:00:55 +00:00
' --no-exec-before-download ' ,
action = ' store_const ' , dest = ' exec_before_dl_cmd ' , const = [ ] ,
2022-01-03 11:13:54 +00:00
help = optparse . SUPPRESS_HELP )
2015-02-28 13:43:24 +00:00
postproc . add_option (
2021-03-18 15:34:09 +00:00
' --convert-subs ' , ' --convert-sub ' , ' --convert-subtitles ' ,
2015-02-28 13:43:24 +00:00
metavar = ' FORMAT ' , dest = ' convertsubtitles ' , default = None ,
2021-05-22 08:24:12 +00:00
help = (
' Convert the subtitles to another format (currently supported: %s ) '
' (Alias: --convert-subtitles) ' % ' | ' . join ( FFmpegSubtitlesConvertorPP . SUPPORTED_EXTS ) ) )
2021-04-10 22:18:52 +00:00
postproc . add_option (
' --convert-thumbnails ' ,
metavar = ' FORMAT ' , dest = ' convertthumbnails ' , default = None ,
2021-05-22 08:24:12 +00:00
help = (
' Convert the thumbnails to another format '
' (currently supported: %s ) ' % ' | ' . join ( FFmpegThumbnailsConvertorPP . SUPPORTED_EXTS ) ) )
2021-03-14 23:02:13 +00:00
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) ' )
2021-09-01 20:55:16 +00:00
postproc . add_option (
' --remove-chapters ' ,
metavar = ' REGEX ' , dest = ' remove_chapters ' , action = ' append ' ,
2021-10-18 10:33:05 +00:00
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 ' ) )
2021-09-01 20:55:16 +00:00
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. '
2021-12-19 15:18:06 +00:00
' Requires a re-encode and thus is very slow, but the resulting video '
2021-09-01 20:55:16 +00:00
' 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) ' )
2021-09-29 20:53:33 +00:00
_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, '
2021-12-19 15:18:06 +00:00
' and (optionally) arguments to be passed to it, separated by a colon " : " . '
2021-09-29 20:53:33 +00:00
' 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), '
2022-01-02 10:53:20 +00:00
' " before_dl " (before video download), " post_process " (after video download; default), '
' " after_move " (after moving file to their final locations), '
' " after_video " (after downloading and processing all formats of a video), '
' or " playlist " (end of playlist). '
2021-09-29 20:53:33 +00:00
' This option can be used multiple times to add different postprocessors ' ) )
2014-09-13 05:55:21 +00:00
2021-09-01 20:55:16 +00:00
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 ' ,
2021-12-09 12:40:31 +00:00
callback = _set_from_options_callback , callback_kwargs = {
' allowed_values ' : SponsorBlockPP . CATEGORIES . keys ( ) ,
' aliases ' : { ' default ' : [ ' all ' ] }
} , help = (
2021-09-01 20:55:16 +00:00
' SponsorBlock categories to create chapters for, separated by commas. '
2021-12-09 12:40:31 +00:00
f ' Available categories are all, default(=all), { " , " . join ( SponsorBlockPP . CATEGORIES . keys ( ) ) } . '
' You can prefix the category with a " - " to exempt it. See [1] for description of the categories. '
' Eg: --sponsorblock-mark all,-preview [1] https://wiki.sponsor.ajay.app/w/Segment_Categories ' ) )
2021-09-01 20:55:16 +00:00
sponsorblock . add_option (
' --sponsorblock-remove ' , metavar = ' CATS ' ,
dest = ' sponsorblock_remove ' , default = set ( ) , action = ' callback ' , type = ' str ' ,
2021-12-09 12:40:31 +00:00
callback = _set_from_options_callback , callback_kwargs = {
' allowed_values ' : set ( SponsorBlockPP . CATEGORIES . keys ( ) ) - set ( SponsorBlockPP . POI_CATEGORIES . keys ( ) ) ,
# Note: From https://wiki.sponsor.ajay.app/w/Types:
# The filler category is very aggressive.
# It is strongly recommended to not use this in a client by default.
' aliases ' : { ' default ' : [ ' all ' , ' -filler ' ] }
} , help = (
2021-09-01 20:55:16 +00:00
' 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. '
2021-12-09 12:40:31 +00:00
' The syntax and available categories are the same as for --sponsorblock-mark '
' except that " default " refers to " all,-filler " '
f ' and { " , " . join ( SponsorBlockPP . POI_CATEGORIES . keys ( ) ) } is not available ' ) )
2021-09-01 20:55:16 +00:00
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 " %d efault " ' ) )
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 %d efault ' )
sponsorblock . add_option (
2020-11-15 00:28:41 +00:00
' --sponskrub ' ,
2021-09-03 20:07:41 +00:00
action = ' store_true ' , dest = ' sponskrub ' , default = False ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
2020-11-15 00:28:41 +00:00
' --no-sponskrub ' ,
action = ' store_false ' , dest = ' sponskrub ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
2020-11-15 00:28:41 +00:00
' --sponskrub-cut ' , default = False ,
action = ' store_true ' , dest = ' sponskrub_cut ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --no-sponskrub-cut ' ,
action = ' store_false ' , dest = ' sponskrub_cut ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
2020-11-15 00:28:41 +00:00
' --sponskrub-force ' , default = False ,
action = ' store_true ' , dest = ' sponskrub_force ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --no-sponskrub-force ' ,
action = ' store_true ' , dest = ' sponskrub_force ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
2020-11-15 00:28:41 +00:00
' --sponskrub-location ' , metavar = ' PATH ' ,
dest = ' sponskrub_path ' , default = ' ' ,
2021-09-01 20:55:16 +00:00
help = optparse . SUPPRESS_HELP )
sponsorblock . add_option (
2021-01-07 06:41:05 +00:00
' --sponskrub-args ' , dest = ' sponskrub_args ' , metavar = ' ARGS ' ,
2021-01-07 19:28:41 +00:00
help = optparse . SUPPRESS_HELP )
2020-11-15 00:28:41 +00:00
2020-09-16 11:00:41 +00:00
extractor = optparse . OptionGroup ( parser , ' Extractor Options ' )
2021-02-28 23:48:37 +00:00
extractor . add_option (
' --extractor-retries ' ,
2021-03-02 21:33:04 +00:00
dest = ' extractor_retries ' , metavar = ' RETRIES ' , default = 3 ,
2021-02-28 23:48:37 +00:00
help = ' Number of retries for known extractor errors (default is %d efault), or " infinite " ' )
2020-09-16 11:00:41 +00:00
extractor . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --allow-dynamic-mpd ' , ' --no-ignore-dynamic-mpd ' ,
2020-09-16 11:00:41 +00:00
action = ' store_true ' , dest = ' dynamic_mpd ' , default = True ,
2021-01-18 19:17:48 +00:00
help = ' Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd) ' )
2020-09-16 11:00:41 +00:00
extractor . add_option (
Added negative switches for many existing options
* The idea is that it should be possible to negate any boolean option by adding a `no-` to the switch
New: `--no-ignore-dynamic-mpd`, `--no-allow-dynamic-mpd`, `--allow-dynamic-mpd`, `--youtube-include-hls-manifest`, `--no-youtube-include-hls-manifest`, `--no-youtube-skip-hls-manifest`, `--no-download`, `--no-download-archive`, `--resize-buffer`, `--part`, `--mtime`, `--no-keep-fragments`, `--no-cookies`, `--no-write-annotations`, `--no-write-info-json`, `--no-write-description`, `--no-write-thumbnail`, `--youtube-include-dash-manifest`, `--post-overwrites`, `--no-keep-video`, `--no-embed-subs`, `--no-embed-thumbnail`, `--no-add-metadata`, `--no-include-ads`, `--no-write-sub`, `--no-write-auto-sub`, `--no-playlist-reverse`, `--no-restrict-filenames`, `--youtube-include-dash-manifest`, `--no-format-sort-force`, `--flat-videos`, `--no-list-formats-as-table`, `--no-sponskrub`, `--no-sponskrub-cut`, `--no-sponskrub-force`
Renamed: `--write-subs`, --no-write-subs`, `--no-write-auto-subs, `--write-auto-subs`. Note that these can still be used without the ending "s"
2021-01-04 17:45:15 +00:00
' --ignore-dynamic-mpd ' , ' --no-allow-dynamic-mpd ' ,
2020-09-16 11:00:41 +00:00
action = ' store_false ' , dest = ' dynamic_mpd ' ,
2021-01-18 19:17:48 +00:00
help = ' Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd) ' )
2021-02-24 14:47:53 +00:00
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) ' )
2021-12-30 02:45:07 +00:00
_extractor_arg_parser = lambda key , vals = ' ' : ( key . strip ( ) . lower ( ) . replace ( ' - ' , ' _ ' ) , [
val . replace ( r ' \ , ' , ' , ' ) . strip ( ) for val in re . split ( r ' (?<! \\ ), ' , vals ) ] )
2021-06-25 14:05:41 +00:00
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 (
2021-07-08 15:33:13 +00:00
_extractor_arg_parser ( * arg . split ( ' = ' , 1 ) ) for arg in val . split ( ' ; ' ) )
2021-07-31 10:51:01 +00:00
} , help = (
2021-06-25 14:05:41 +00:00
' Pass these arguments to the extractor. See " EXTRACTOR ARGUMENTS " for details. '
2021-07-08 15:33:13 +00:00
' You can use this option multiple times to give arguments for different extractors ' ) )
2021-02-24 16:01:01 +00:00
extractor . add_option (
' --youtube-include-dash-manifest ' , ' --no-youtube-skip-dash-manifest ' ,
action = ' store_true ' , dest = ' youtube_include_dash_manifest ' , default = True ,
2021-06-25 14:05:41 +00:00
help = optparse . SUPPRESS_HELP )
2021-02-24 16:01:01 +00:00
extractor . add_option (
' --youtube-skip-dash-manifest ' , ' --no-youtube-include-dash-manifest ' ,
action = ' store_false ' , dest = ' youtube_include_dash_manifest ' ,
2021-06-25 14:05:41 +00:00
help = optparse . SUPPRESS_HELP )
2021-02-24 16:01:01 +00:00
extractor . add_option (
' --youtube-include-hls-manifest ' , ' --no-youtube-skip-hls-manifest ' ,
action = ' store_true ' , dest = ' youtube_include_hls_manifest ' , default = True ,
2021-06-25 14:05:41 +00:00
help = optparse . SUPPRESS_HELP )
2021-02-24 16:01:01 +00:00
extractor . add_option (
' --youtube-skip-hls-manifest ' , ' --no-youtube-include-hls-manifest ' ,
action = ' store_false ' , dest = ' youtube_include_hls_manifest ' ,
2021-06-25 14:05:41 +00:00
help = optparse . SUPPRESS_HELP )
2020-09-16 11:00:41 +00:00
2014-09-13 05:55:21 +00:00
parser . add_option_group ( general )
2015-01-10 18:55:36 +00:00
parser . add_option_group ( network )
2017-02-18 20:58:17 +00:00
parser . add_option_group ( geo )
2014-09-13 05:55:21 +00:00
parser . add_option_group ( selection )
parser . add_option_group ( downloader )
parser . add_option_group ( filesystem )
2015-01-25 01:38:47 +00:00
parser . add_option_group ( thumbnail )
2020-10-27 10:37:21 +00:00
parser . add_option_group ( link )
2014-09-13 05:55:21 +00:00
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 ( postproc )
2021-09-01 20:55:16 +00:00
parser . add_option_group ( sponsorblock )
2020-09-16 11:00:41 +00:00
parser . add_option_group ( extractor )
2014-09-13 05:55:21 +00:00
2021-12-14 17:03:47 +00:00
return parser
2021-09-13 02:52:11 +00:00
2016-09-14 15:28:17 +00:00
2021-12-14 17:03:47 +00:00
def _hide_login_info ( opts ) :
write_string (
' DeprecationWarning: " yt_dlp.options._hide_login_info " is deprecated and may be removed in a future version. '
' Use " yt_dlp.utils.Config.hide_login_info " instead \n ' )
return Config . hide_login_info ( opts )