]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
* vlc_common.h: include stdarg.h by default. Required by ninput.h
[vlc] / src / libvlc.h
index 482d1678868a0cfdf79d6d0e26a48377a57d8749..f3dc83cb7f24dcf28f19f0073ea1dff87636bd86 100644 (file)
@@ -2,7 +2,7 @@
  * libvlc.h: main libvlc header
  *****************************************************************************
  * Copyright (C) 1998-2002 VideoLAN
- * $Id: libvlc.h,v 1.68 2003/05/21 13:10:05 sigmunau Exp $
+ * $Id: libvlc.h,v 1.77 2003/07/20 19:48:30 hartman Exp $
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *          Samuel Hocevar <sam@zoy.org>
 
 #define Nothing here, this is just to prevent update-po from being stupid
 
-static char *ppsz_sout_acodec[] = { "", "mpga", "a52", NULL };
-static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV3", "h263", NULL };
+static char *ppsz_sout_acodec[] = { "", "mpga", "mp3", "vorb", "a52", NULL };
+static char *ppsz_sout_vcodec[] = { "", "mpgv", "mp4v", "DIV1", "DIV2", 
+                                 "DIV3", "h263", "i263", "WMV1", "WMV2",
+                                 "MJPG", NULL };
 
-static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
+static char *ppsz_language[] = { "auto", "en", "en_GB", "de", "fr", "it",
                                  "ja", "nl", "no", "pl", "ru", "sv", NULL };
 
 /*****************************************************************************
@@ -47,7 +49,8 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 #define EXTRAINTF_LONGTEXT N_( \
     "This option allows you to select additional interfaces used by VLC. " \
     "They will be launched in the background in addition to the default " \
-    "interface. Use a comma separated list of interface modules.")
+    "interface. Use a comma separated list of interface modules. (common " \
+    "values are: logger,gestures,sap,rc,http,screensaver)")
 
 #define VERBOSE_TEXT N_("Verbosity (0,1,2)")
 #define VERBOSE_LONGTEXT N_( \
@@ -70,8 +73,9 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 
 #define ADVANCED_TEXT N_("Show advanced options")
 #define ADVANCED_LONGTEXT N_( \
-    "When this option is turned on, the interfaces will show all the " \
-    "available options, including those that most users should never touch")
+    "When this option is turned on, the preferences and/or interfaces  will " \
+    "show all the available options, including those that most users should " \
+    "never touch")
 
 #define INTF_PATH_TEXT N_("Interface default search path")
 #define INTF_PATH_LONGTEXT N_( \
@@ -92,7 +96,7 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 #define AUDIO_TEXT N_("Enable audio")
 #define AUDIO_LONGTEXT N_( \
     "You can completely disable the audio output. In this case the audio " \
-    "decoding stage won't be done, and it will save some processing power.")
+    "decoding will not take place, and it will save some processing power.")
 
 #define MONO_TEXT N_("Force mono audio")
 #define MONO_LONGTEXT N_("This will force a mono audio output")
@@ -123,6 +127,12 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
     "This option allows you to delay the audio output. This can be handy if " \
     "you notice a lag between the video and the audio.")
 
+#define MULTICHA_TEXT N_("Choose prefered audio output channels mode")
+#define MULTICHA_LONGTEXT N_( \
+    "This option allows you to set the audio output channels mode that will " \
+    "be used by default when possible (ie. if your hardware supports it as " \
+    "well as the audio stream being played)")
+
 #define SPDIF_TEXT N_("Use the S/PDIF audio output when available")
 #define SPDIF_LONGTEXT N_( \
     "This option allows you to use the S/PDIF audio output by default when " \
@@ -130,7 +140,7 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 
 #define HEADPHONE_TEXT N_("Headphone virtual spatialization effect")
 #define HEADPHONE_LONGTEXT N_( \
-    "This effect gives you the feeling that you stands in a real room " \
+    "This effect gives you the feeling that you are standing in a room " \
     "with a complete 5.1 speaker set when using only a headphone, " \
     "providing a more realistic sound experience. It should also be " \
     "more comfortable and less tiring when listening to music for " \
@@ -146,21 +156,16 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 #define VIDEO_TEXT N_("Enable video")
 #define VIDEO_LONGTEXT N_( \
     "You can completely disable the video output. In this case the video " \
-    "decoding stage won't be done, which will save some processing power.")
-
-#define DISPLAY_TEXT N_("Display identifier")
-#define DISPLAY_LONGTEXT N_( \
-    "This is the local display port that will be used for X11 drawing. " \
-    "For instance :0.1.")
+    "decoding stage will not take place, which will save some processing power.")
 
 #define WIDTH_TEXT N_("Video width")
 #define WIDTH_LONGTEXT N_( \
-    "You can enforce the video width here. By default VLC will " \
+    "You can enforce the video width here. By default (-1) VLC will " \
     "adapt to the video characteristics.")
 
 #define HEIGHT_TEXT N_("Video height")
 #define HEIGHT_LONGTEXT N_( \
-    "You can enforce the video height here. By default VLC will " \
+    "You can enforce the video height here. By default (-1) VLC will " \
     "adapt to the video characteristics.")
 
 #define ZOOM_TEXT N_("Zoom video")
@@ -180,7 +185,7 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 #define OVERLAY_TEXT N_("Overlay video output")
 #define OVERLAY_LONGTEXT N_( \
     "If enabled, VLC will try to take advantage of the overlay capabilities " \
-    "of your graphic card.")
+    "of your graphics card.")
 
 #define SPUMARGIN_TEXT N_("Force SPU position")
 #define SPUMARGIN_LONGTEXT N_( \
@@ -238,7 +243,8 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 
 #define INPUT_AUDIO_TEXT N_("Choose audio")
 #define INPUT_AUDIO_LONGTEXT N_( \
-    "Give the default type of audio you want to use in a DVD.")
+    "Give the default type of audio you want to use in a DVD. " \
+    "(Developers only)")
 
 #define INPUT_CHAN_TEXT N_("Choose channel")
 #define INPUT_CHAN_LONGTEXT N_( \
@@ -393,7 +399,16 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
 #define DEMUX_LONGTEXT N_( \
     "This is a legacy entry to let you configure demux modules")
 
-#define FAST_MUTEX_TEXT N_("Dast mutex on NT/2K/XP (developers only)")
+#define HPRIORITY_TEXT N_("Increase the priority of the process")
+#define HPRIORITY_LONGTEXT N_( \
+    "Increasing the priority of the process will very likely improve your " \
+    "playing experience as it allows VLC not to be disturbed by other " \
+    "applications that could otherwise take too much processor time.\n" \
+    "However be advise that in certain circumstances (bugs) VLC could take " \
+    "all the processor time and render the whole system unresponsive which " \
+    "might require a reboot of your machine.")
+
+#define FAST_MUTEX_TEXT N_("Fast mutex on NT/2K/XP (developers only)")
 #define FAST_MUTEX_LONGTEXT N_( \
     "On Windows NT/2K/XP we use a slow mutex implementation but which " \
     "allows us to correctely implement condition variables. " \
@@ -411,8 +426,6 @@ static char *ppsz_language[] = { "auto", "de", "en_GB", "fr", "it",
     "Currently you can choose between implementation 0 (which is the " \
     "default and the fastest), 1 and 2.")
 
-#define RT_PRIORITY_TEXT N_("Real-time priority")
-
 #define PLAYLIST_USAGE N_("\nPlaylist items:" \
     "\n  *.mpg, *.vob                   plain MPEG-1/2 files" \
     "\n  [dvd:][device][@raw_device][@[title][,[chapter][,angle]]]" \
@@ -447,14 +460,14 @@ vlc_module_begin();
     add_module_with_short( "intf", 'I', "interface", NULL, NULL,
                            INTF_TEXT, INTF_LONGTEXT, VLC_TRUE );
     add_string( "extraintf", NULL, NULL, EXTRAINTF_TEXT, EXTRAINTF_LONGTEXT, VLC_TRUE );
-    add_integer_with_short( "verbose", 'v', -1, NULL,
+    add_integer_with_short( "verbose", 'v', 0, NULL,
                             VERBOSE_TEXT, VERBOSE_LONGTEXT, VLC_FALSE );
     add_bool_with_short( "quiet", 'q', 0, NULL, QUIET_TEXT, QUIET_LONGTEXT, VLC_TRUE );
     add_string_from_list( "language", "auto", ppsz_language, NULL, LANGUAGE_TEXT, LANGUAGE_LONGTEXT, VLC_FALSE );
     add_bool( "color", 0, NULL, COLOR_TEXT, COLOR_LONGTEXT, VLC_TRUE );
     add_bool( "advanced", 0, NULL, ADVANCED_TEXT, ADVANCED_LONGTEXT, VLC_FALSE );
-    add_string( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
-    add_string( "plugin-path", NULL, NULL,
+    add_directory( "search-path", NULL, NULL, INTF_PATH_TEXT, INTF_PATH_LONGTEXT, VLC_TRUE );
+    add_directory( "plugin-path", NULL, NULL,
                 PLUGIN_PATH_TEXT, PLUGIN_PATH_LONGTEXT, VLC_TRUE );
 
     /* Audio options */
@@ -486,7 +499,9 @@ vlc_module_begin();
     add_float( "zoom", 1, NULL, ZOOM_TEXT, ZOOM_LONGTEXT, VLC_TRUE );
     add_bool( "grayscale", 0, NULL, GRAYSCALE_TEXT, GRAYSCALE_LONGTEXT, VLC_TRUE );
     add_bool( "fullscreen", 0, NULL, FULLSCREEN_TEXT, FULLSCREEN_LONGTEXT, VLC_FALSE );
+#ifndef SYS_DARWIN
     add_bool( "overlay", 1, NULL, OVERLAY_TEXT, OVERLAY_LONGTEXT, VLC_TRUE );
+#endif
     add_integer( "spumargin", -1, NULL, SPUMARGIN_TEXT, SPUMARGIN_LONGTEXT, VLC_TRUE );
     add_module( "filter", "video filter", NULL, NULL,
                 FILTER_TEXT, FILTER_LONGTEXT, VLC_TRUE );
@@ -502,7 +517,6 @@ vlc_module_begin();
                  SERVER_PORT_TEXT, SERVER_PORT_LONGTEXT, VLC_FALSE );
     add_integer( "mtu", 1500, NULL, MTU_TEXT, MTU_LONGTEXT, VLC_TRUE );
     add_string( "iface-addr", "", NULL, IFACE_ADDR_TEXT, IFACE_ADDR_LONGTEXT, VLC_TRUE );
-    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
 
     add_integer( "program", 0, NULL,
                  INPUT_PROGRAM_TEXT, INPUT_PROGRAM_LONGTEXT, VLC_TRUE );
@@ -523,9 +537,11 @@ vlc_module_begin();
     add_category_hint( N_("Decoders"), NULL, VLC_TRUE );
     add_module( "codec", "decoder", NULL, NULL, CODEC_TEXT, CODEC_LONGTEXT, VLC_TRUE );
 
+#if 0 // Encoders have been disabled for now as we are using the stream output transcoder instead
     add_category_hint( N_("Encoders"), NULL, VLC_TRUE );
     add_module( "video-encoder", "video encoder", NULL, NULL, ENCODER_VIDEO_TEXT, ENCODER_VIDEO_LONGTEXT, VLC_TRUE );
     add_module( "audio-encoder", "audio encoder", NULL, NULL, ENCODER_AUDIO_TEXT, ENCODER_AUDIO_LONGTEXT, VLC_TRUE );
+#endif
 
     /* Stream output options */
     add_category_hint( N_("Stream output"), NULL, VLC_TRUE );
@@ -545,6 +561,7 @@ vlc_module_begin();
     add_module( "mux", "sout mux", NULL, NULL, MUX_TEXT, MUX_LONGTEXT, VLC_TRUE );
     add_module( "access_output", "sout access", NULL, NULL,
                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
+    add_integer( "ttl", 1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
 
     /* CPU options */
     add_category_hint( N_("CPU"), NULL, VLC_TRUE );
@@ -571,6 +588,7 @@ vlc_module_begin();
     add_module( "demux", "demux", NULL, NULL, DEMUX_TEXT, DEMUX_LONGTEXT, VLC_TRUE );
 
 #if defined(WIN32)
+    add_bool( "high-priority", 1, NULL, HPRIORITY_TEXT, HPRIORITY_LONGTEXT, VLC_TRUE );
     add_bool( "fast-mutex", 0, NULL, FAST_MUTEX_TEXT, FAST_MUTEX_LONGTEXT, VLC_TRUE );
     add_integer( "win9x-cv-method", 0, NULL, WIN9X_CV_TEXT, WIN9X_CV_LONGTEXT, VLC_TRUE );
 #endif