]> git.sesse.net Git - vlc/blobdiff - include/vlc_plugin.h
Added filter_GetInputAttachments.
[vlc] / include / vlc_plugin.h
index 7ec1cef4871b2d1ab3443a3e2aa85aa73c567825..eb957ca1406632d578067fce7633cc0b5cc754f9 100644 (file)
  * This file implements plugin (module) macros used to define a vlc module.
  */
 
-VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
-VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
-VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
-VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
-VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
+VLC_EXPORT( 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__)
 
 enum vlc_module_properties
 {
+    VLC_SUBMODULE_CREATE,
+    VLC_CONFIG_CREATE,
+
     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
      * Append new items at the end ONLY. */
-    VLC_MODULE_CPU_REQUIREMENT,
+    VLC_MODULE_CPU_REQUIREMENT=0x100,
     VLC_MODULE_SHORTCUT,
     VLC_MODULE_CAPABILITY,
     VLC_MODULE_SCORE,
@@ -50,14 +52,12 @@ enum vlc_module_properties
     VLC_MODULE_SHORTNAME,
     VLC_MODULE_DESCRIPTION,
     VLC_MODULE_HELP,
-};
+    VLC_MODULE_TEXTDOMAIN,
+    /* Insert new VLC_MODULE_* here */
 
-enum vlc_config_properties
-{
     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
      * Append new items at the end ONLY. */
-
-    VLC_CONFIG_NAME,
+    VLC_CONFIG_NAME=0x1000,
     /* command line name (args=const char *, vlc_callback_t) */
 
     VLC_CONFIG_VALUE,
@@ -106,6 +106,8 @@ enum vlc_config_properties
     VLC_CONFIG_ADD_ACTION,
     /* add value change callback
      * (args=const char *, vlc_callback_t, const char *) */
+
+    /* Insert new VLC_CONFIG_* here */
 };
 
 /*****************************************************************************
@@ -118,8 +120,8 @@ enum vlc_config_properties
 /**
  * Current plugin ABI version
  */
-# define MODULE_SYMBOL 1_0_0d
-# define MODULE_SUFFIX "__1_0_0d"
+# define MODULE_SYMBOL 1_2_0a
+# define MODULE_SUFFIX "__1_2_0a"
 
 /*****************************************************************************
  * Add a few defines. You do not want to read this section. Really.
@@ -173,7 +175,6 @@ enum vlc_config_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;                                                       \
@@ -191,11 +192,7 @@ enum vlc_config_properties
     VLC_METADATA_EXPORTS
 
 #define add_submodule( ) \
-    p_submodule = vlc_submodule_create( p_module );
-
-#define add_requirement( cap ) \
-    if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
-                        (int)(CPU_CAPABILITY_##cap))) \
+    if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
         goto error;
 
 #define add_shortcut( shortcut ) \
@@ -204,17 +201,17 @@ enum vlc_config_properties
         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;
 
@@ -229,11 +226,13 @@ enum vlc_config_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.
@@ -249,11 +248,11 @@ enum vlc_config_properties
  *****************************************************************************/
 
 #define add_type_inner( type ) \
-    p_config = vlc_config_create (p_module, type);
+    vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
 
 #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 ) \
@@ -313,6 +312,10 @@ enum vlc_config_properties
     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
                       p_callback, value )
 
+#define add_font( name, value, p_callback, text, longtext, advc )\
+    add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
+                      p_callback, value )
+
 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
                       p_callback, value ) \
@@ -327,29 +330,23 @@ enum vlc_config_properties
 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
                       p_callback, value ) \
-    p_config->min.i = i_subcategory /* gruik */;
+    change_integer_range (i_subcategory /* gruik */, 0);
 
 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
                       advc, p_callback, value ) \
-    p_config->min.i = i_subcategory /* gruik */;
+    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 )
 
-#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_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
     add_integer( name, value, p_callback, text, longtext, advc ) \
@@ -396,26 +393,19 @@ enum vlc_config_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, \
+    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));
 
-#define change_float_list( list, list_text, list_update_func ) \
-    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
-                    (size_t)(sizeof (list) / sizeof (float)), \
-                    (const float *)(list), \
-                    (const char *const *)(list_text), \
-                    (vlc_callback_t)(list_update_func));
-
 #define change_integer_range( minv, maxv ) \
     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
 
@@ -424,19 +414,22 @@ enum vlc_config_properties
                     (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() \
-    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 are saved but hidden from the preferences panel */
+#define change_private() \
+    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
+
+/* 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() \
@@ -457,7 +450,7 @@ enum vlc_config_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