]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
Attempt to fix C++ compilation
[vlc] / src / libvlc.h
index 26fe6f268c7c0c765f8ca2bbc299cb1ce667a959..3c79633a152542476b2b2cde728650269eba84ea 100644 (file)
@@ -1,5 +1,5 @@
 /*****************************************************************************
- * libvlc.h: main libvlc header
+ * libvlc.h: Options for the main module
  *****************************************************************************
  * Copyright (C) 1998-2006 the VideoLAN team
  * $Id$
 
 #define Nothing here, this is just to prevent update-po from being stupid
 #include "vlc_keys.h"
+#include "vlc_meta.h"
 
 #if defined (WIN32) || defined (__APPLE__)
-static char *ppsz_language[] =
+static const char *ppsz_language[] =
 { "auto", "en", "en_GB", "ca", "cs", "da", "de", "es", "fr", "gl", "he", "hu",
-  "it", "ja", "ka", "ko", "nl", "oc", "pt_BR", "ro", "ru", "sv", "tr",
-  "zh_CN", "zh_TW" };
+  "it", "ja", "ka", "ko", "ms", "nl", "oc", "pt_BR", "ro", "ru", "sk", "sl",
+  "sv", "tr", "zh_CN", "zh_TW" };
 
-static char *ppsz_language_text[] =
+static const char *ppsz_language_text[] =
 { N_("Auto"), N_("American English"), N_("British English"),
 N_("Catalan"), N_("Czech"), N_("Danish"), N_("German"), N_("Spanish"),
 N_("French"), N_("Galician"), N_("Hebrew"), N_("Hungarian"),N_("Italian"),
-N_("Japanese"),N_("Georgian"), N_("Korean"), N_("Dutch"), N_("Occitan"),
-N_("Brazilian Portuguese"), N_("Romanian"), N_("Russian"), N_("Swedish"),
-N_("Turkish"), N_("Simplified Chinese"), N_("Chinese Traditional") };
+N_("Japanese"),N_("Georgian"), N_("Korean"), N_("Malay"), N_("Dutch"),
+N_("Occitan"), N_("Brazilian Portuguese"), N_("Romanian"), N_("Russian"),
+N_("Slovak"), N_("Slovenian"), N_("Swedish"), N_("Turkish"),
+N_("Simplified Chinese"), N_("Chinese Traditional") };
 #endif
 
-static char *ppsz_snap_formats[] =
+static const char *ppsz_snap_formats[] =
 { "png", "jpg" };
 
 /*****************************************************************************
@@ -197,7 +199,7 @@ static char *ppsz_snap_formats[] =
     "enhance your experience, especially when combined with the Headphone "\
     "Channel Mixer." )
 static int pi_force_dolby_values[] = { 0, 1, 2 };
-static char *ppsz_force_dolby_descriptions[] = { N_("Auto"), N_("On"), N_("Off") };
+static const char *ppsz_force_dolby_descriptions[] = { N_("Auto"), N_("On"), N_("Off") };
 
 
 #define AUDIO_FILTER_TEXT N_("Audio filters")
@@ -262,7 +264,7 @@ static char *ppsz_force_dolby_descriptions[] = { N_("Auto"), N_("On"), N_("Off")
     "will be centered (0=center, 1=left, 2=right, 4=top, 8=bottom, you can " \
     "also use combinations of these values, like 6=4+2 meaning top-right).")
 static int pi_align_values[] = { 0, 1, 2, 4, 8, 5, 6, 9, 10 };
-static char *ppsz_align_descriptions[] =
+static const char *ppsz_align_descriptions[] =
 { N_("Center"), N_("Left"), N_("Right"), N_("Top"), N_("Bottom"),
   N_("Top-Left"), N_("Top-Right"), N_("Bottom-Left"), N_("Bottom-Right") };
 
@@ -417,7 +419,7 @@ static char *ppsz_align_descriptions[] =
         "are available in Advanced / Network Sync." )
 
 static int pi_clock_values[] = { -1, 0, 1 };
-static char *ppsz_clock_descriptions[] =
+static const char *ppsz_clock_descriptions[] =
 { N_("Default"), N_("Disable"), N_("Enable") };
 
 #define SERVER_PORT_TEXT N_("UDP port")
@@ -432,18 +434,23 @@ static char *ppsz_clock_descriptions[] =
 #define TTL_TEXT N_("Hop limit (TTL)")
 #define TTL_LONGTEXT N_( \
     "This is the hop limit (also known as \"Time-To-Live\" or TTL) of " \
-    "the multicast packets sent by the stream output (0 = use operating "\
+    "the multicast packets sent by the stream output (-1 = use operating " \
     "system built-in default).")
 
-#define MIFACE_TEXT N_("IPv6 multicast output interface")
+#define MIFACE_TEXT N_("Multicast output interface")
 #define MIFACE_LONGTEXT N_( \
-    "Default IPv6 multicast interface. This overrides the routing table.")
+    "Default multicast interface. This overrides the routing table.")
 
 #define MIFACE_ADDR_TEXT N_("IPv4 multicast output interface address")
 #define MIFACE_ADDR_LONGTEXT N_( \
     "IPv4 adress for the default multicast interface. This overrides " \
     "the routing table.")
 
+#define DSCP_TEXT N_("DiffServ Code Point")
+#define DSCP_LONGTEXT N_("Differentiated Services Code Point " \
+    "for outgoing UDP streams (or IPv4 Type Of Service, " \
+    "or IPv6 Traffic Class). This is used for network Quality of Service.")
+
 #define INPUT_PROGRAM_TEXT N_("Program")
 #define INPUT_PROGRAM_LONGTEXT N_( \
     "Choose the program to select by giving its Service ID. " \
@@ -746,7 +753,6 @@ static char *ppsz_clock_descriptions[] =
     "When the SAP flow control is disabled, " \
     "this lets you set the fixed interval between SAP announcements." )
 
-
 /*****************************************************************************
  * Advanced
  ****************************************************************************/
@@ -869,14 +875,24 @@ static char *ppsz_clock_descriptions[] =
 #define SYSLOG_LONGTEXT N_( \
     "Log all VLC messages to syslog (UNIX systems)." )
 
-#define ONEINSTANCE_TEXT N_("Allow only one running instance")
-#define ONEINSTANCE_LONGTEXT N_( \
+#define ONEINSTANCE_WIN_TEXT N_("Allow only one running instance")
+#define ONEINSTANCE_WIN_LONGTEXT N_( \
     "Allowing only one running instance of VLC can sometimes be useful, " \
     "for example if you associated VLC with some media types and you " \
     "don't want a new instance of VLC to be opened each time you " \
     "double-click on a file in the explorer. This option will allow you " \
     "to play the file with the already running instance or enqueue it.")
 
+#define ONEINSTANCE_DBUS_TEXT ONEINSTANCE_WIN_TEXT
+#define ONEINSTANCE_DBUS_LONGTEXT N_( \
+    "Allowing only one running instance of VLC can sometimes be useful, " \
+    "for example if you associated VLC with some media types and you " \
+    "don't want a new instance of VLC to be opened each time you " \
+    "open a file in your file manager. This option will allow you " \
+    "to play the file with the already running instance or enqueue it." \
+    "This option require the D-Bus session daemon to be active " \
+    "and the running instance of VLC to use D-Bus control interface.")
+
 #define STARTEDFROMFILE_TEXT N_("VLC is started from file association")
 #define STARTEDFROMFILE_LONGTEXT N_( \
     "Tell VLC that it is being launched due to a file association in the OS" )
@@ -933,6 +949,19 @@ static char *ppsz_clock_descriptions[] =
     "Automatically preparse files added to the playlist " \
     "(to retrieve some metadata)." )
 
+#define ALBUM_ART_TEXT N_( "Album art policy" )
+#define ALBUM_ART_LONGTEXT N_( \
+    "Choose when to download and cache album art." )
+
+static int pi_albumart_values[] = { ALBUM_ART_NEVER,
+                                    ALBUM_ART_WHEN_ASKED,
+                                    ALBUM_ART_WHEN_PLAYED,
+                                    ALBUM_ART_ALL };
+static const char *ppsz_albumart_descriptions[] =
+    { N_("Never download"), N_("Download when asked"),
+      N_("Download when track starts playing"),
+      N_("Download everything ASAP") };
+
 #define SD_TEXT N_( "Services discovery modules")
 #define SD_LONGTEXT N_( \
      "Specifies the services discovery modules to load, separated by " \
@@ -969,7 +998,7 @@ static char *ppsz_clock_descriptions[] =
     "contents of a directory. \"Default\" means that the tree will only " \
     "be used when really needed." )
 static int pi_pltree_values[] = { 0, 1, 2 };
-static char *ppsz_pltree_descriptions[] = { N_("Default"), N_("Always"), N_("Never") };
+static const char *ppsz_pltree_descriptions[] = { N_("Default"), N_("Always"), N_("Never") };
 
 
 
@@ -1133,6 +1162,8 @@ static char *ppsz_pltree_descriptions[] = { N_("Default"), N_("Always"), N_("Nev
 
 #define RECORD_KEY_TEXT N_("Record")
 #define RECORD_KEY_LONGTEXT N_("Record access filter start/stop.")
+#define DUMP_KEY_TEXT N_("Dump")
+#define DUMP_KEY_LONGTEXT N_("Media dump access filter trigger.")
 
 #define ZOOM_KEY_TEXT N_("Zoom")
 #define ZOOM_KEY_LONGTEXT N_("Zoom")
@@ -1317,14 +1348,12 @@ vlc_module_begin();
         change_short('V');
 
     set_subcategory( SUBCAT_VIDEO_VFILTER );
-    add_module_list_cat( "vout-filter", SUBCAT_VIDEO_VFILTER, NULL, NULL,
-                VOUT_FILTER_TEXT, VOUT_FILTER_LONGTEXT, VLC_FALSE );
-       add_deprecated( "filter", VLC_FALSE ); /*deprecated since 0.8.2 */
-
-    set_subcategory( SUBCAT_VIDEO_VFILTER2 );
-    add_module_list_cat( "video-filter", SUBCAT_VIDEO_VFILTER2, NULL, NULL,
+    add_module_list_cat( "video-filter", SUBCAT_VIDEO_VFILTER, NULL, NULL,
                 VIDEO_FILTER_TEXT, VIDEO_FILTER_LONGTEXT, VLC_FALSE );
-
+       add_deprecated( "filter", VLC_FALSE ); /*deprecated since 0.8.2 */
+//       add_deprecated( "vout-filter", VLC_FALSE ); /* deprecated since 0.8.6 *// While the "video-filter" chain isn't parsed for both vfilter and vfilter2, keep both options
+    add_module_list_cat( "vout-filter", SUBCAT_VIDEO_VFILTER, NULL, NULL,
+                        NULL, NULL, VLC_FALSE );
 #if 0
     add_string( "pixel-ratio", "1", NULL, PIXEL_RATIO_TEXT, PIXEL_RATIO_TEXT );
 #endif
@@ -1364,7 +1393,7 @@ vlc_module_begin();
     set_category( CAT_INPUT );
     set_subcategory( SUBCAT_INPUT_GENERAL );
 
-    add_bool( "france", VLC_FALSE, NULL, "France", FRANCE_LONGTEXT, VLC_TRUE );
+    add_bool( "france", VLC_FALSE, NULL, N_("France"), FRANCE_LONGTEXT, VLC_TRUE );
 
     set_section( N_( "Track settings" ), NULL );
     add_integer( "program", 0, NULL,
@@ -1519,9 +1548,10 @@ vlc_module_begin();
     set_subcategory( SUBCAT_SOUT_ACO );
     add_module( "access_output", "sout access", NULL, NULL,
                 ACCESS_OUTPUT_TEXT, ACCESS_OUTPUT_LONGTEXT, VLC_TRUE );
-    add_integer( "ttl", 0, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
+    add_integer( "ttl", -1, NULL, TTL_TEXT, TTL_LONGTEXT, VLC_TRUE );
     add_string( "miface", NULL, NULL, MIFACE_TEXT, MIFACE_LONGTEXT, VLC_TRUE );
     add_string( "miface-addr", NULL, NULL, MIFACE_ADDR_TEXT, MIFACE_ADDR_LONGTEXT, VLC_TRUE );
+    add_integer( "dscp", 0, NULL, DSCP_TEXT, DSCP_LONGTEXT, VLC_TRUE );
 
     set_subcategory( SUBCAT_SOUT_PACKETIZER );
     add_module( "packetizer","packetizer", NULL, NULL,
@@ -1532,6 +1562,7 @@ vlc_module_begin();
                                ANN_SAPCTRL_LONGTEXT, VLC_TRUE );
     add_integer( "sap-interval", 5, NULL, ANN_SAPINTV_TEXT,
                                ANN_SAPINTV_LONGTEXT, VLC_TRUE );
+
     set_subcategory( SUBCAT_SOUT_VOD );
 
 /* CPU options */
@@ -1591,11 +1622,19 @@ vlc_module_begin();
         change_need_restart();
 #endif
 
+#if defined(HAVE_DBUS_3)
+    add_bool( "one-instance", 0, NULL, ONEINSTANCE_DBUS_TEXT,
+              ONEINSTANCE_DBUS_LONGTEXT, VLC_TRUE );
+    add_bool( "playlist-enqueue", 0, NULL, PLAYLISTENQUEUE_TEXT,
+              PLAYLISTENQUEUE_LONGTEXT, VLC_TRUE );
+#endif
+
 #if defined(WIN32)
-    add_bool( "one-instance", 0, NULL, ONEINSTANCE_TEXT,
-              ONEINSTANCE_LONGTEXT, VLC_TRUE );
+    add_bool( "one-instance", 0, NULL, ONEINSTANCE_WIN_TEXT,
+              ONEINSTANCE_WIN_LONGTEXT, VLC_TRUE );
     add_bool( "started-from-file", 0, NULL, STARTEDFROMFILE_TEXT,
               STARTEDFROMFILE_LONGTEXT, VLC_TRUE );
+        change_unsaveable();
     add_bool( "one-instance-when-started-from-file", 1, NULL,
               ONEINSTANCEWHENSTARTEDFROMFILE_TEXT,
               ONEINSTANCEWHENSTARTEDFROMFILE_LONGTEXT, VLC_TRUE );
@@ -1618,10 +1657,13 @@ vlc_module_begin();
     add_category_hint( N_("Playlist"), PLAYLIST_CAT_LONGTEXT , VLC_FALSE );
     add_bool( "random", 0, NULL, RANDOM_TEXT, RANDOM_LONGTEXT, VLC_FALSE );
         change_short('Z');
+        change_autosave();
     add_bool( "loop", 0, NULL, LOOP_TEXT, LOOP_LONGTEXT, VLC_FALSE );
         change_short('L');
+        change_autosave();
     add_bool( "repeat", 0, NULL, REPEAT_TEXT, REPEAT_LONGTEXT, VLC_FALSE );
         change_short('R');
+        change_autosave();
     add_bool( "play-and-exit", 0, NULL, PAE_TEXT, PAE_LONGTEXT, VLC_FALSE );
     add_bool( "play-and-stop", 0, NULL, PAS_TEXT, PAS_LONGTEXT, VLC_FALSE );
     add_bool( "media-library", 1, NULL, ML_TEXT, ML_LONGTEXT, VLC_FALSE );
@@ -1635,6 +1677,11 @@ vlc_module_begin();
     add_bool( "auto-preparse", VLC_TRUE, NULL, PREPARSE_TEXT,
               PREPARSE_LONGTEXT, VLC_FALSE );
 
+    add_integer( "album-art", ALBUM_ART_WHEN_PLAYED, NULL, ALBUM_ART_TEXT,
+                 ALBUM_ART_LONGTEXT, VLC_FALSE );
+        change_integer_list( pi_albumart_values,
+                             ppsz_albumart_descriptions, 0 );
+
     set_subcategory( SUBCAT_PLAYLIST_SD );
     add_module_list_cat( "services-discovery", SUBCAT_PLAYLIST_SD, NULL,
                           NULL, SD_TEXT, SD_LONGTEXT, VLC_FALSE );
@@ -1663,7 +1710,7 @@ vlc_module_begin();
     add_bool( "file-logging", VLC_FALSE, NULL, FILE_LOG_TEXT, FILE_LOG_LONGTEXT,
               VLC_TRUE );
         change_need_restart();
-#if HAVE_SYSLOG_H
+#ifdef HAVE_SYSLOG_H
     add_bool ( "syslog", VLC_FALSE, NULL, SYSLOG_TEXT, SYSLOG_LONGTEXT,
                VLC_TRUE );
         change_need_restart();
@@ -1818,6 +1865,7 @@ vlc_module_begin();
 #   define KEY_HISTORY_BACK       KEY_MODIFIER_COMMAND|'['
 #   define KEY_HISTORY_FORWARD    KEY_MODIFIER_COMMAND|']'
 #   define KEY_RECORD             KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|'r'
+#   define KEY_DUMP               KEY_MODIFIER_COMMAND|KEY_MODIFIER_SHIFT|'d'
 
 #else
 #   define KEY_FULLSCREEN         'f'
@@ -1900,6 +1948,7 @@ vlc_module_begin();
 #   define KEY_HISTORY_BACK       KEY_MODIFIER_CTRL|'v'
 #   define KEY_HISTORY_FORWARD    KEY_MODIFIER_CTRL|'b'
 #   define KEY_RECORD             KEY_MODIFIER_CTRL|'r'
+#   define KEY_DUMP               KEY_MODIFIER_CTRL|KEY_MODIFIER_SHIFT|'d'
 #endif
 
     add_key( "key-fullscreen", KEY_FULLSCREEN, NULL, FULLSCREEN_KEY_TEXT,
@@ -1997,6 +2046,8 @@ vlc_module_begin();
              HISTORY_FORWARD_TEXT, HISTORY_FORWARD_LONGTEXT, VLC_TRUE );
     add_key( "key-record", KEY_RECORD, NULL,
              RECORD_KEY_TEXT, RECORD_KEY_LONGTEXT, VLC_TRUE );
+    add_key( "key-dump", KEY_DUMP, NULL,
+             DUMP_KEY_TEXT, DUMP_KEY_LONGTEXT, VLC_TRUE );
     add_key( "key-zoom", KEY_ZOOM, NULL,
              ZOOM_KEY_TEXT, ZOOM_KEY_LONGTEXT, VLC_TRUE );
     add_key( "key-unzoom", KEY_UNZOOM, NULL,
@@ -2104,29 +2155,65 @@ vlc_module_end();
 
 static module_config_t p_help_config[] =
 {
-    { CONFIG_ITEM_BOOL, NULL, "help", 'h',
-      N_("print help for VLC (can be combined with --advanced)") },
-    { CONFIG_ITEM_BOOL, NULL, "longhelp", 'H',
-      N_("print help for VLC and all its modules (can be combined with --advanced)") },
-    { CONFIG_ITEM_BOOL, NULL, "advanced", '\0',
-      N_("print help for the advanced options") },
-    { CONFIG_ITEM_BOOL, NULL, "help-verbose", '\0',
-      N_("ask for extra verbosity when displaying help") },
-    { CONFIG_ITEM_BOOL, NULL, "list", 'l',
-      N_("print a list of available modules") },
-    { CONFIG_ITEM_STRING, NULL, "module", 'p',
-      N_("print help on a specific module (can be combined with --advanced)") },
-    { CONFIG_ITEM_BOOL, NULL, "save-config", '\0',
-      N_("save the current command line options in the config") },
-    { CONFIG_ITEM_BOOL, NULL, "reset-config", '\0',
-      N_("reset the current config to the default values") },
-    { CONFIG_ITEM_STRING, NULL, "config", '\0',
-      N_("use alternate config file") },
-    { CONFIG_ITEM_BOOL, NULL, "reset-plugins-cache", '\0',
-      N_("resets the current plugins cache") },
-    { CONFIG_ITEM_BOOL, NULL, "version", '\0',
-      N_("print version information") },
-    { CONFIG_HINT_END, NULL, NULL, '\0', NULL }
+    { 
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "help",
+        .i_short  = 'h',
+        .psz_text = N_("print help for VLC (can be combined with --advanced)")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "longhelp",
+        .i_short  = 'H',
+        .psz_text = N_("print help for VLC and all its modules (can be combined with --advanced)")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "advanced",
+        .psz_text = N_("print help for the advanced options")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "help-verbose",
+        .psz_text = N_("ask for extra verbosity when displaying help")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "list",
+        .i_short  = 'l',
+        .psz_text = N_("print a list of available modules")
+    },
+    {
+        .i_type   = CONFIG_ITEM_STRING,
+        .psz_name = "module",
+        .i_short  = 'p',
+        .psz_text = N_("print help on a specific module (can be combined with --advanced)")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "save-config",
+        .psz_text = N_("save the current command line options in the config")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "reset-config",
+        .psz_text = N_("reset the current config to the default values")
+    },
+    {
+        .i_type   = CONFIG_ITEM_STRING,
+        .psz_name = "config",
+        .psz_text = N_("use alternate config file")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "reset-plugins-cache",
+        .psz_text = N_("resets the current plugins cache")
+    },
+    {
+        .i_type   = CONFIG_ITEM_BOOL,
+        .psz_name = "version",
+        .psz_text = N_("print version information")
+    }
 };
 
 /*****************************************************************************
@@ -2134,7 +2221,8 @@ static module_config_t p_help_config[] =
  *****************************************************************************/
 
 /*****************************************************************************
- * Initializer for the vlc_t structure storing the action / key associations
+ * Initializer for the libvlc instance structure
+ * storing the action / key associations
  *****************************************************************************/
 static struct hotkey p_hotkeys[] =
 {
@@ -2215,5 +2303,6 @@ static struct hotkey p_hotkeys[] =
     { "key-history-back", ACTIONID_HISTORY_BACK, 0, 0, 0, 0 },
     { "key-history-forward", ACTIONID_HISTORY_FORWARD, 0, 0, 0, 0 },
     { "key-record", ACTIONID_RECORD, 0, 0, 0, 0 },
+    { "key-dump", ACTIONID_DUMP, 0, 0, 0, 0 },
     { NULL, 0, 0, 0, 0, 0 }
 };