]> git.sesse.net Git - vlc/blobdiff - include/vlc_plugin.h
aout: remove aout_mixer_input_t (no functional changes)
[vlc] / include / vlc_plugin.h
index f9e3107d0f243ef479d4e793c9fcf2b4ab7e99d7..a99d2e1ebf02835d95c393f92885abbd765a8020 100644 (file)
@@ -29,7 +29,7 @@
  * This file implements plugin (module) macros used to define a vlc module.
  */
 
-VLC_EXPORT( int, vlc_plugin_set, (module_t *, module_config_t *, int, ...) );
+VLC_API int vlc_plugin_set(module_t *, module_config_t *, int, ...);
 
 #define vlc_module_set( mod, ... ) vlc_plugin_set ((mod), NULL, __VA_ARGS__)
 #define vlc_config_set( cfg, ... ) vlc_plugin_set (NULL, (cfg), __VA_ARGS__)
@@ -52,12 +52,13 @@ enum vlc_module_properties
     VLC_MODULE_SHORTNAME,
     VLC_MODULE_DESCRIPTION,
     VLC_MODULE_HELP,
+    VLC_MODULE_TEXTDOMAIN,
     /* Insert new VLC_MODULE_* here */
 
     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
      * Append new items at the end ONLY. */
     VLC_CONFIG_NAME=0x1000,
-    /* command line name (args=const char *, vlc_callback_t) */
+    /* command line name (args=const char *) */
 
     VLC_CONFIG_VALUE,
     /* actual value (args=int/double/const char *) */
@@ -71,11 +72,8 @@ enum vlc_module_properties
     VLC_CONFIG_VOLATILE,
     /* don't write variable to storage (args=none) */
 
-    VLC_CONFIG_PERSISTENT,
-    /* always write variable to storage (args=none) */
-
-    VLC_CONFIG_RESTART,
-    /* restart required to apply value change (args=none) */
+    VLC_CONFIG_PERSISTENT_OBSOLETE,
+    /* unused (ignored) */
 
     VLC_CONFIG_PRIVATE,
     /* hide from user (args=none) */
@@ -109,18 +107,11 @@ enum vlc_module_properties
     /* Insert new VLC_CONFIG_* here */
 };
 
-/*****************************************************************************
- * If we are not within a module, assume we're in the vlc core.
- *****************************************************************************/
-#if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
-#   define MODULE_NAME main
-#endif
-
 /**
  * Current plugin ABI version
  */
-# define MODULE_SYMBOL 1_0_0d
-# define MODULE_SUFFIX "__1_0_0d"
+# define MODULE_SYMBOL 1_2_0h
+# define MODULE_SUFFIX "__1_2_0h"
 
 /*****************************************************************************
  * Add a few defines. You do not want to read this section. Really.
@@ -146,12 +137,19 @@ enum vlc_module_properties
 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
 #endif
 
-#if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
+#define CDECL_SYMBOL
+#if defined (__PLUGIN__)
+# if defined (WIN32)
 #   define DLL_SYMBOL              __declspec(dllexport)
+#   undef CDECL_SYMBOL
 #   define CDECL_SYMBOL            __cdecl
+# elif defined (__GNUC__) && (__GNUC__ >= 4)
+#   define DLL_SYMBOL              __attribute__((visibility("default")))
+# else
+#  define DLL_SYMBOL
+# endif
 #else
-#   define DLL_SYMBOL
-#   define CDECL_SYMBOL
+# define DLL_SYMBOL
 #endif
 
 #if defined( __cplusplus )
@@ -174,7 +172,6 @@ enum vlc_module_properties
     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
     {                                                                         \
         module_config_t *p_config = NULL;                                     \
-        const char *domain = NULL;                                            \
         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                             (const char *)(MODULE_STRING)))                   \
             goto error;                                                       \
@@ -195,28 +192,26 @@ enum vlc_module_properties
     if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
         goto error;
 
-#define add_requirement( cap ) \
-    if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
-                        (int)(CPU_CAPABILITY_##cap))) \
-        goto error;
-
-#define add_shortcut( shortcut ) \
+#define add_shortcut( ... ) \
+{ \
+    const char *shortcuts[] = { __VA_ARGS__ }; \
     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
-        (const char *)(shortcut))) \
-        goto error;
+                        sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
+        goto error; \
+}
 
 #define set_shortname( shortname ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
+    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
                         (const char *)(shortname))) \
         goto error;
 
 #define set_description( desc ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
+    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
                         (const char *)(desc))) \
         goto error;
 
 #define set_help( help ) \
-    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
+    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
                         (const char *)(help))) \
         goto error;
 
@@ -231,11 +226,13 @@ enum vlc_module_properties
      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
         goto error;
 
-#define linked_with_a_crap_library_which_uses_atexit( ) \
+#define cannot_unload_broken_library( ) \
     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
         goto error;
 
-#define set_text_domain( dom ) domain = (dom);
+#define set_text_domain( dom ) \
+    if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
+        goto error;
 
 /*****************************************************************************
  * Macros used to build the configuration structure.
@@ -255,34 +252,34 @@ enum vlc_module_properties
 
 #define add_typedesc_inner( type, text, longtext ) \
     add_type_inner( type ) \
-    vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
+    vlc_config_set (p_config, VLC_CONFIG_DESC, \
                     (const char *)(text), (const char *)(longtext));
 
 #define add_typeadv_inner( type, text, longtext, advc ) \
     add_typedesc_inner( type, text, longtext ) \
     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
 
-#define add_typename_inner( type, name, text, longtext, advc, cb ) \
+#define add_typename_inner( type, name, text, longtext, advc ) \
     add_typeadv_inner( type, text, longtext, advc ) \
     vlc_config_set (p_config, VLC_CONFIG_NAME, \
-                    (const char *)(name), (vlc_callback_t)(cb));
+                    (const char *)(name));
 
-#define add_string_inner( type, name, text, longtext, advc, cb, v ) \
-    add_typename_inner( type, name, text, longtext, advc, cb ) \
+#define add_string_inner( type, name, text, longtext, advc, v ) \
+    add_typename_inner( type, name, text, longtext, advc ) \
     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
 
-#define add_int_inner( type, name, text, longtext, advc, cb, v ) \
-    add_typename_inner( type, name, text, longtext, advc, cb ) \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
+#define add_int_inner( type, name, text, longtext, advc, v ) \
+    add_typename_inner( type, name, text, longtext, advc ) \
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
 
 
 #define set_category( i_id ) \
     add_type_inner( CONFIG_CATEGORY ) \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
 
 #define set_subcategory( i_id ) \
     add_type_inner( CONFIG_SUBCATEGORY ) \
-    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
+    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
 
 #define set_section( text, longtext ) \
     add_typedesc_inner( CONFIG_SECTION, text, longtext )
@@ -299,82 +296,85 @@ enum vlc_module_properties
 #define add_usage_hint( text ) \
     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 
-#define add_string( name, value, p_callback, text, longtext, advc ) \
+#define add_string( name, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
-                      p_callback, value )
+                      value )
 
-#define add_password( name, value, p_callback, text, longtext, advc ) \
+#define add_password( name, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
-                      p_callback, value )
+                      value )
 
-#define add_file( name, value, p_callback, text, longtext, advc ) \
-    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
-                      p_callback, value )
+#define add_loadfile( name, value, text, longtext, advc ) \
+    add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
+                      value )
 
-#define add_directory( name, value, p_callback, text, longtext, advc ) \
+#define add_savefile( name, value, text, longtext, advc ) \
+    add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
+                      value )
+
+#define add_directory( name, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
-                      p_callback, value )
+                      value )
+
+#define add_font( name, value, text, longtext, advc )\
+    add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
+                      value )
 
-#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
+#define add_module( name, psz_caps, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
-                      p_callback, value ) \
+                      value ) \
     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 
-#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
+#define add_module_list( name, psz_caps, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
-                      p_callback, value ) \
+                      value ) \
     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 
 #ifndef __PLUGIN__
-#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
+#define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
-                      p_callback, value ) \
+                      value ) \
     change_integer_range (i_subcategory /* gruik */, 0);
 
-#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
+#define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
-                      advc, p_callback, value ) \
+                      advc, value ) \
     change_integer_range (i_subcategory /* gruik */, 0);
 #endif
 
-#define add_integer( name, value, p_callback, text, longtext, advc ) \
-    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
-                   p_callback, value )
+#define add_integer( name, value, text, longtext, advc ) \
+    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
 
-#if !defined(WIN32) && !defined(SYS_LINUX)
-#define add_key( name, value, p_callback, text, longtext, advc ) \
-    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
-                   value )
-#else
-#define add_key( name, value, p_callback, text, longtext, advc ) \
-    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
-                   p_callback, value ) \
-    add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
-                   p_callback, KEY_UNSET )
-#endif
+#define add_rgb( name, value, text, longtext, advc ) \
+    add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
+    change_integer_range( 0, 0xFFFFFF )
+
+#define add_key( name, value, text, longtext, advc ) \
+    add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
+                   KEY_UNSET ) \
+    add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
 
-#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
-    add_integer( name, value, p_callback, text, longtext, advc ) \
+#define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
+    add_integer( name, value, text, longtext, advc ) \
     change_integer_range( i_min, i_max )
 
-#define add_float( name, v, p_callback, text, longtext, advc ) \
-    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
+#define add_float( name, v, text, longtext, advc ) \
+    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
 
-#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
-    add_float( name, value, p_callback, text, longtext, advc ) \
+#define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
+    add_float( name, value, text, longtext, advc ) \
     change_float_range( f_min, f_max )
 
-#define add_bool( name, v, p_callback, text, longtext, advc ) \
-    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
-                        p_callback ) \
-    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
+#define add_bool( name, v, text, longtext, advc ) \
+    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
+    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true);
 
 /* For removed option */
 #define add_obsolete_inner( name, type ) \
     add_type_inner( type ) \
     vlc_config_set (p_config, VLC_CONFIG_NAME, \
-                    (const char *)(name), (vlc_callback_t)NULL); \
+                    (const char *)(name)); \
     vlc_config_set (p_config, VLC_CONFIG_REMOVED);
 
 #define add_obsolete_bool( name ) \
@@ -398,40 +398,38 @@ enum vlc_module_properties
     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
 
 #define change_string_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, \
                     (size_t)(sizeof (list) / sizeof (char *)), \
                     (const char *const *)(list), \
                     (const char *const *)(list_text), \
                     (vlc_callback_t)(list_update_func));
 
-#define change_integer_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
+#define change_integer_list( list, list_text ) \
+    vlc_config_set (p_config, VLC_CONFIG_LIST, \
                     (size_t)(sizeof (list) / sizeof (int)), \
                     (const int *)(list), \
                     (const char *const *)(list_text), \
-                    (vlc_callback_t)(list_update_func));
+                    (vlc_callback_t)(NULL));
 
 #define change_integer_range( minv, maxv ) \
-    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
+    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
+                    (int64_t)(minv), (int64_t)(maxv));
 
 #define change_float_range( minv, maxv ) \
     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
                     (double)(minv), (double)(maxv));
 
 #define change_action_add( pf_action, text ) \
-    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
+    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
                     (vlc_callback_t)(pf_action), (const char *)(text));
 
-#define change_internal() \
+/* For options that are saved but hidden from the preferences panel */
+#define change_private() \
     vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
 
-#define change_need_restart() \
-    vlc_config_set (p_config, VLC_CONFIG_RESTART);
-
-#define change_autosave() \
-    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
-
-#define change_unsaveable() \
+/* For options that cannot be saved in the configuration */
+#define change_volatile() \
+    change_private() \
     vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
 
 #define change_safe() \
@@ -452,7 +450,7 @@ enum vlc_module_properties
     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
-    "\x6c\x6f\x70\x70\x65\x72\x73" )
+    "\x6c\x6f\x70\x65\x72\x73" )
 #elif !defined (VLC_COPYRIGHT_EXPORT)
 # define VLC_COPYRIGHT_EXPORT
 #endif