]> git.sesse.net Git - vlc/blobdiff - src/libvlc-module.c
macosx: expand the documentation for our single (known) private API use
[vlc] / src / libvlc-module.c
index 3b41d04af724fe73d0108e0b0a13703d0ec69d75..65709a282cea03cb404b136d2eb4b85c42c652ac 100644 (file)
@@ -157,7 +157,7 @@ static const char *const ppsz_language_text[] =
 #endif
 
 static const char *const ppsz_snap_formats[] =
-{ "png", "jpg" };
+{ "png", "jpg", "tiff" };
 
 /*****************************************************************************
  * Configuration options for the main program. Each module will also separatly
@@ -268,19 +268,17 @@ static const char *const ppsz_snap_formats[] =
 
 #define VOLUME_TEXT N_("Default audio volume")
 #define VOLUME_LONGTEXT N_( \
-    "You can set the default audio output volume here, in a range from 0 to " \
-    "1024.")
+    "You can set the default audio output volume here.")
 
 #define VOLUME_STEP_TEXT N_("Audio output volume step")
 #define VOLUME_STEP_LONGTEXT N_( \
-    "The step size of the volume is adjustable using this option, " \
-    "in a range from 0 to 1024." )
+    "The step size of the volume is adjustable using this option.")
 #define AOUT_VOLUME_STEP 32
 
-#define AOUT_RATE_TEXT N_("Audio output frequency (Hz)")
-#define AOUT_RATE_LONGTEXT N_( \
-    "You can force the audio output frequency here. Common values are " \
-    "0 (undefined), 48000, 44100, 32000, 22050, 16000, 11025, 8000.")
+#define VOLUME_SAVE_TEXT N_( "Remember the audio volume" )
+#define VOLUME_SAVE_LONGTEXT N_( \
+    "The volume can be recorded and automatically restored next time " \
+    "VLC is used." )
 
 #if !defined( __APPLE__ )
 #define AOUT_RESAMP_TEXT N_("High quality audio resampling")
@@ -295,6 +293,10 @@ static const char *const ppsz_snap_formats[] =
     "This delays the audio output. The delay must be given in milliseconds. " \
     "This can be handy if you notice a lag between the video and the audio.")
 
+#define AUDIO_RESAMPLER_TEXT N_("Audio resampler")
+#define AUDIO_RESAMPLER_LONGTEXT N_( \
+    "This selects which plugin to use for audio resampling." )
+
 #define MULTICHA_TEXT N_("Audio output channels mode")
 #define MULTICHA_LONGTEXT N_( \
     "This sets the audio output channels mode that will " \
@@ -738,12 +740,13 @@ static const char *const ppsz_clock_descriptions[] =
     "When several video formats are available, select one whose " \
     "resolution is closest to (but not higher than) this setting, " \
     "in number of lines. Use this option if you don't have enough CPU " \
-    "power or network bandwith to play higher resolutions.")
-static const int pi_prefres[] = { -1, 1080, 720, 576, 320 };
+    "power or network bandwidth to play higher resolutions.")
+static const int pi_prefres[] = { -1, 1080, 720, 576, 360, 240 };
 static const char *const ppsz_prefres[] = {
     N_("Best available"), N_("Full HD (1080p)"), N_("HD (720p)"),
     N_("Standard Definition (576 or 480 lines)"),
-    N_("Low definition (320 lines)")
+    N_("Low Definition (360 lines)"),
+    N_("Very Low Definition (240 lines)"),
 };
 
 #define INPUT_REPEAT_TEXT N_("Input repetitions")
@@ -915,12 +918,19 @@ static const char *const ppsz_prefres[] = {
     "Default TCP connection timeout (in milliseconds). " )
 
 #define HTTP_HOST_TEXT N_( "HTTP server address" )
-#define RTSP_HOST_TEXT N_( "RTSP server address" )
 #define HOST_LONGTEXT N_( \
     "By default, the server will listen on any local IP address. " \
     "Specify an IP address (e.g. ::1 or 127.0.0.1) or a host name " \
     "(e.g. localhost) to restrict them to a specific network interface." )
 
+#define RTSP_HOST_TEXT N_( "RTSP server address" )
+#define RTSP_HOST_LONGTEXT N_( \
+    "This defines the address the RTSP server will listen on, along " \
+    "with the base path of the RTSP VOD media. Syntax is address/path. " \
+    "By default, the server will listen on any local IP address. " \
+    "Specify an IP address (e.g. ::1 or 127.0.0.1) or a host name " \
+    "(e.g. localhost) to restrict them to a specific network interface." )
+
 #define HTTP_PORT_TEXT N_( "HTTP server port" )
 #define HTTP_PORT_LONGTEXT N_( \
     "The HTTP server will listen on this TCP port. " \
@@ -957,7 +967,7 @@ static const char *const ppsz_prefres[] = {
 
 #define HTTP_CRL_TEXT N_("HTTP/TLS Certificate Revocation List")
 #define CRL_LONGTEXT N_( \
-   "This file countains an optional CRL to prevent remove clients " \
+   "This file contains an optional CRL to prevent remove clients " \
    "from using revoked certificates in TLS sessions.")
 
 #define SOCKS_SERVER_TEXT N_("SOCKS server")
@@ -1161,10 +1171,6 @@ static const char *const ppsz_prefres[] = {
     "Additional path for VLC to look for its modules. You can add " \
     "several paths by concatenating them using \" PATH_SEP \" as separator")
 
-#define DATA_PATH_TEXT N_("Data search path")
-#define DATA_PATH_LONGTEXT N_( \
-    "Override the default data/share search path.")
-
 #define VLM_CONF_TEXT N_("VLM configuration file")
 #define VLM_CONF_LONGTEXT N_( \
     "Read a VLM configuration file as soon as VLM is started." )
@@ -1320,8 +1326,8 @@ static const char *const ppsz_albumart_descriptions[] =
 
 #define TOGGLE_FULLSCREEN_KEY_TEXT N_("Fullscreen")
 #define TOGGLE_FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to swap fullscreen state.")
-#define LEAVE_FULLSCREEN_KEY_TEXT N_("Leave fullscreen")
-#define LEAVE_FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to leave fullscreen state.")
+#define LEAVE_FULLSCREEN_KEY_TEXT N_("Exit fullscreen")
+#define LEAVE_FULLSCREEN_KEY_LONGTEXT N_("Select the hotkey to use to exit fullscreen state.")
 #define PLAY_PAUSE_KEY_TEXT N_("Play/Pause")
 #define PLAY_PAUSE_KEY_LONGTEXT N_("Select the hotkey to use to swap paused state.")
 #define PAUSE_KEY_TEXT N_("Pause only")
@@ -1587,7 +1593,8 @@ vlc_module_begin ()
     add_integer_with_range( "volume-step", AOUT_VOLUME_STEP, 0,
                             AOUT_VOLUME_MAX, VOLUME_STEP_TEXT,
                             VOLUME_STEP_LONGTEXT, true )
-    add_obsolete_integer( "aout-rate" ) /* since 1.2.0 */
+    add_bool( "volume-save", true, VOLUME_SAVE_TEXT, VOLUME_SAVE_TEXT, true )
+    add_obsolete_integer( "aout-rate" ) /* since 2.0.0 */
 #if HAVE_FPU && !defined( __APPLE__ )
     add_bool( "hq-resampling", 1, AOUT_RESAMP_TEXT,
               AOUT_RESAMP_LONGTEXT, true )
@@ -1600,6 +1607,9 @@ vlc_module_begin ()
                  DESYNC_LONGTEXT, true )
         change_safe ()
 
+    add_module( "audio-resampler", "audio resampler", NULL,
+                AUDIO_RESAMPLER_TEXT, AUDIO_RESAMPLER_LONGTEXT, true )
+
     /* FIXME TODO create a subcat replay gain ? */
     add_string( "audio-replay-gain-mode", ppsz_replay_gain_mode[0], AUDIO_REPLAY_GAIN_MODE_TEXT,
                 AUDIO_REPLAY_GAIN_MODE_LONGTEXT, false )
@@ -1751,7 +1761,7 @@ vlc_module_begin ()
                 VIDEO_FILTER_TEXT, VIDEO_FILTER_LONGTEXT, false )
     add_module_list_cat( "video-splitter", SUBCAT_VIDEO_VFILTER, NULL,
                         VIDEO_SPLITTER_TEXT, VIDEO_SPLITTER_LONGTEXT, false )
-    add_obsolete_string( "vout-filter" ) /* since 1.2.0 */
+    add_obsolete_string( "vout-filter" ) /* since 2.0.0 */
 #if 0
     add_string( "pixel-ratio", "1", PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT )
 #endif
@@ -1776,9 +1786,9 @@ vlc_module_begin ()
     add_integer( "sub-autodetect-fuzzy", 3,
                  SUB_FUZZY_TEXT, SUB_FUZZY_LONGTEXT, true )
 #if defined( WIN32 ) || defined( __OS2__ )
-#   define SUB_PATH ".\\subtitles"
+#   define SUB_PATH ".\\subtitles, .\\subs"
 #else
-#   define SUB_PATH "./Subtitles, ./subtitles"
+#   define SUB_PATH "./Subtitles, ./subtitles, ./Subs, ./subs"
 #endif
     add_string( "sub-autodetect-path", SUB_PATH,
                  SUB_PATH_TEXT, SUB_PATH_LONGTEXT, true )
@@ -1866,8 +1876,8 @@ vlc_module_begin ()
     set_section( N_( "Network settings" ), NULL )
 
     add_integer( "mtu", MTU_DEFAULT, MTU_TEXT, MTU_LONGTEXT, true )
-    add_obsolete_bool( "ipv6" ) /* since 1.2.0 */
-    add_obsolete_bool( "ipv4" ) /* since 1.2.0 */
+    add_obsolete_bool( "ipv6" ) /* since 2.0.0 */
+    add_obsolete_bool( "ipv4" ) /* since 2.0.0 */
     add_integer( "ipv4-timeout", 5 * 1000, TIMEOUT_TEXT,
                  TIMEOUT_LONGTEXT, true )
 
@@ -1876,17 +1886,17 @@ vlc_module_begin ()
         change_integer_range( 1, 65535 )
     add_integer( "https-port", 8443, HTTPS_PORT_TEXT, HTTPS_PORT_LONGTEXT, true )
         change_integer_range( 1, 65535 )
-    add_string( "rtsp-host", NULL, RTSP_HOST_TEXT, HOST_LONGTEXT, true )
-    add_integer( "rtsp-port", 8554, RTSP_PORT_TEXT, RTSP_PORT_LONGTEXT, true )
+    add_string( "rtsp-host", NULL, RTSP_HOST_TEXT, RTSP_HOST_LONGTEXT, true )
+    add_integer( "rtsp-port", 554, RTSP_PORT_TEXT, RTSP_PORT_LONGTEXT, true )
         change_integer_range( 1, 65535 )
     add_loadfile( "http-cert", NULL, HTTP_CERT_TEXT, CERT_LONGTEXT, true )
-    add_obsolete_string( "sout-http-cert" ) /* since 1.2.0 */
+    add_obsolete_string( "sout-http-cert" ) /* since 2.0.0 */
     add_loadfile( "http-key", NULL, HTTP_KEY_TEXT, KEY_LONGTEXT, true )
-    add_obsolete_string( "sout-http-key" ) /* since 1.2.0 */
+    add_obsolete_string( "sout-http-key" ) /* since 2.0.0 */
     add_loadfile( "http-ca", NULL, HTTP_CA_TEXT, CA_LONGTEXT, true )
-    add_obsolete_string( "sout-http-ca" ) /* since 1.2.0 */
+    add_obsolete_string( "sout-http-ca" ) /* since 2.0.0 */
     add_loadfile( "http-crl", NULL, HTTP_CRL_TEXT, CRL_LONGTEXT, true )
-    add_obsolete_string( "sout-http-crl" ) /* since 1.2.0 */
+    add_obsolete_string( "sout-http-crl" ) /* since 2.0.0 */
 
     set_section( N_( "Socks proxy") , NULL )
     add_string( "socks", NULL,
@@ -1929,48 +1939,48 @@ vlc_module_begin ()
                  CACHING_TEXT, CACHING_LONGTEXT, true )
         change_integer_range( 0, 60000 )
         change_safe()
-    add_obsolete_integer( "vdr-caching" ) /* 1.2.0 */
+    add_obsolete_integer( "vdr-caching" ) /* 2.0.0 */
     add_integer( "live-caching", DEFAULT_PTS_DELAY / 1000,
                  CAPTURE_CACHING_TEXT, CAPTURE_CACHING_LONGTEXT, true )
         change_integer_range( 0, 60000 )
         change_safe()
-    add_obsolete_integer( "alsa-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "dshow-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "dv-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "dvb-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "eyetv-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "gnomevfs-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "jack-input-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "linsys-hdsdi-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "linsys-sdi-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "oss-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "pvr-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "screen-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "v4l2-caching" ) /* 1.2.0 */
+    add_obsolete_integer( "alsa-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "dshow-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "dv-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "dvb-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "eyetv-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "gnomevfs-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "jack-input-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "linsys-hdsdi-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "linsys-sdi-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "oss-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "pvr-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "screen-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "v4l2-caching" ) /* 2.0.0 */
     add_integer( "disc-caching", DEFAULT_PTS_DELAY / 1000,
                  DISC_CACHING_TEXT, DISC_CACHING_LONGTEXT, true )
         change_integer_range( 0, 60000 )
         change_safe()
-    add_obsolete_integer( "bd-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "bluray-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "cdda-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "dvdnav-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "dvdread-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "vcd-caching" ) /* 1.2.0 */
+    add_obsolete_integer( "bd-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "bluray-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "cdda-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "dvdnav-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "dvdread-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "vcd-caching" ) /* 2.0.0 */
     add_integer( "network-caching", CLOCK_FREQ / 1000,
                  NETWORK_CACHING_TEXT, NETWORK_CACHING_LONGTEXT, true )
         change_integer_range( 0, 60000 )
         change_safe()
-    add_obsolete_integer( "ftp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "http-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "mms-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "realrtsp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "rtp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "rtsp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "sftp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "smb-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "tcp-caching" ) /* 1.2.0 */
-    add_obsolete_integer( "udp-caching" ) /* 1.2.0 */
+    add_obsolete_integer( "ftp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "http-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "mms-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "realrtsp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "rtp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "rtsp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "sftp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "smb-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "tcp-caching" ) /* 2.0.0 */
+    add_obsolete_integer( "udp-caching" ) /* 2.0.0 */
 
     add_integer( "cr-average", 40, CR_AVERAGE_TEXT,
                  CR_AVERAGE_LONGTEXT, true )
@@ -2054,7 +2064,7 @@ vlc_module_begin ()
                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, true )
     add_integer( "ttl", -1, TTL_TEXT, TTL_LONGTEXT, true )
     add_string( "miface", NULL, MIFACE_TEXT, MIFACE_LONGTEXT, true )
-    add_obsolete_string( "miface-addr" )
+    add_obsolete_string( "miface-addr" ) /* since 2.0.0 */
     add_integer( "dscp", 0, DSCP_TEXT, DSCP_LONGTEXT, true )
 
     set_subcategory( SUBCAT_SOUT_PACKETIZER )
@@ -2073,18 +2083,18 @@ vlc_module_begin ()
     add_category_hint( N_("CPU"), CPU_CAT_LONGTEXT, true )
     add_obsolete_bool( "fpu" )
 #if defined( __i386__ ) || defined( __x86_64__ )
-    add_obsolete_bool( "mmx" ) /* since 1.2.0 */
-    add_obsolete_bool( "3dn" ) /* since 1.2.0 */
-    add_obsolete_bool( "mmxext" ) /* since 1.2.0 */
-    add_obsolete_bool( "sse" ) /* since 1.2.0 */
-    add_obsolete_bool( "sse2" ) /* since 1.2.0 */
-    add_obsolete_bool( "sse3" ) /* since 1.2.0 */
-    add_obsolete_bool( "ssse3" ) /* since 1.2.0 */
-    add_obsolete_bool( "sse41" ) /* since 1.2.0 */
-    add_obsolete_bool( "sse42" ) /* since 1.2.0 */
+    add_obsolete_bool( "mmx" ) /* since 2.0.0 */
+    add_obsolete_bool( "3dn" ) /* since 2.0.0 */
+    add_obsolete_bool( "mmxext" ) /* since 2.0.0 */
+    add_obsolete_bool( "sse" ) /* since 2.0.0 */
+    add_obsolete_bool( "sse2" ) /* since 2.0.0 */
+    add_obsolete_bool( "sse3" ) /* since 2.0.0 */
+    add_obsolete_bool( "ssse3" ) /* since 2.0.0 */
+    add_obsolete_bool( "sse41" ) /* since 2.0.0 */
+    add_obsolete_bool( "sse42" ) /* since 2.0.0 */
 #endif
 #if defined( __powerpc__ ) || defined( __ppc__ ) || defined( __ppc64__ )
-    add_obsolete_bool( "altivec" ) /* since 1.2.0 */
+    add_obsolete_bool( "altivec" ) /* since 2.0.0 */
 #endif
 
 /* Misc options */
@@ -2098,9 +2108,8 @@ vlc_module_begin ()
     set_section( N_("Plugins" ), NULL )
     add_bool( "plugins-cache", true, PLUGINS_CACHE_TEXT,
               PLUGINS_CACHE_LONGTEXT, true )
-    add_obsolete_string( "plugin-path" )
-    add_directory( "data-path", NULL, DATA_PATH_TEXT,
-                   DATA_PATH_LONGTEXT, true )
+    add_obsolete_string( "plugin-path" ) /* since 2.0.0 */
+    add_obsolete_string( "data-path" ) /* since 2.1.0 */
 
     set_section( N_("Performance options"), NULL )