X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_plugin.h;h=e7125dd242fbbfcfffe22172f9d19265926261c4;hb=4f0b2161aa473c6d2a88216ad32087ff3586d77f;hp=0cb3ea9fe82ee033c35e5e79644c4178009d9111;hpb=25a1b84bd5591bb4574191ed5ad7a96365603d2a;p=vlc diff --git a/include/vlc_plugin.h b/include/vlc_plugin.h index 0cb3ea9fe8..e7125dd242 100644 --- a/include/vlc_plugin.h +++ b/include/vlc_plugin.h @@ -2,7 +2,7 @@ * vlc_plugin.h : Macros used from within a module. ***************************************************************************** * Copyright (C) 2001-2006 the VideoLAN team - * Copyright © 2007-2008 Rémi Denis-Courmont + * Copyright © 2007-2009 Rémi Denis-Courmont * * Authors: Samuel Hocevar * @@ -29,24 +29,17 @@ * 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, ...) ); - enum vlc_module_properties { + VLC_MODULE_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_SHORTNAME_NODOMAIN, - VLC_MODULE_DESCRIPTION_NODOMAIN, - VLC_MODULE_HELP_NODOMAIN, VLC_MODULE_CAPABILITY, VLC_MODULE_SCORE, - VLC_MODULE_PROGRAM, /* obsoleted */ VLC_MODULE_CB_OPEN, VLC_MODULE_CB_CLOSE, VLC_MODULE_NO_UNLOAD, @@ -54,18 +47,13 @@ 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, - /* command line name (args=const char *, vlc_callback_t) */ - - VLC_CONFIG_DESC_NODOMAIN, - /* description (args=const char *, const char *) */ + VLC_CONFIG_NAME=0x1000, + /* command line name (args=const char *) */ VLC_CONFIG_VALUE, /* actual value (args=int/double/const char *) */ @@ -79,11 +67,8 @@ enum vlc_config_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) */ @@ -97,15 +82,8 @@ enum vlc_config_properties VLC_CONFIG_SHORTCUT, /* one-character (short) command line option name (args=char) */ - VLC_CONFIG_LIST_NODOMAIN, - /* possible values list - * (args=size_t, const *, const char *const *) */ - - VLC_CONFIG_ADD_ACTION_NODOMAIN, - /* add value change callback (args=vlc_callback_t, const char *) */ - - VLC_CONFIG_OLDNAME, - /* former option name (args=const char *) */ + VLC_CONFIG_OLDNAME_OBSOLETE, + /* unused (ignored) */ VLC_CONFIG_SAFE, /* tag as modifiable by untrusted input item "sources" (args=none) */ @@ -120,20 +98,15 @@ enum vlc_config_properties VLC_CONFIG_ADD_ACTION, /* add value change callback * (args=const char *, vlc_callback_t, const char *) */ -}; -/***************************************************************************** - * If we are not within a module, assume we're in the vlc core. - *****************************************************************************/ -#if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ ) -# define MODULE_NAME main -#endif + /* Insert new VLC_CONFIG_* here */ +}; /** * Current plugin ABI version */ -# define MODULE_SYMBOL 1_0_0c -# define MODULE_SUFFIX "__1_0_0c" +# define MODULE_SYMBOL 1_2_0j +# define MODULE_SUFFIX "__1_2_0j" /***************************************************************************** * Add a few defines. You do not want to read this section. Really. @@ -159,12 +132,19 @@ enum vlc_config_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 VLC_GCC_VERSION(4,0) +# 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 ) @@ -173,81 +153,80 @@ enum vlc_config_properties # define EXTERN_SYMBOL #endif +typedef int (*vlc_set_cb) (void *, void *, int, ...); + +#define vlc_plugin_set(...) vlc_set (opaque, NULL, __VA_ARGS__) +#define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__) +#define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__) + /* * InitModule: this function is called once and only once, when the module * is looked at for the first time. We get the useful data from it, for * instance the module name, its shortcuts, its capabilities... we also create * a copy of its config because the module can be unloaded at any time. */ -#define vlc_module_begin( ) \ - EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \ - __VLC_SYMBOL(vlc_entry) ( module_t *p_module ); \ - \ - EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \ - __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; \ - { \ - module_t *p_submodule = p_module; - -#define vlc_module_end( ) \ - } \ - (void)p_config; \ - return VLC_SUCCESS; \ - \ - error: \ - return VLC_EGENERIC; \ - } \ - VLC_METADATA_EXPORTS +#define vlc_module_begin() \ +EXTERN_SYMBOL DLL_SYMBOL \ +int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \ +EXTERN_SYMBOL DLL_SYMBOL \ +int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \ +{ \ + module_t *module; \ + module_config_t *config = NULL; \ + if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ + goto error; \ + if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \ + goto error; -#define add_submodule( ) \ - p_submodule = vlc_submodule_create( p_module ); +#define vlc_module_end() \ + (void) config; \ + return 0; \ +error: \ + return -1; \ +} \ +VLC_METADATA_EXPORTS -#define add_requirement( cap ) \ - if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \ - (int)(CPU_CAPABILITY_##cap))) \ +#define add_submodule( ) \ + if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \ goto error; -#define add_shortcut( shortcut ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \ - (const char *)(shortcut))) \ - goto error; +#define add_shortcut( ... ) \ +{ \ + const char *shortcuts[] = { __VA_ARGS__ }; \ + if (vlc_module_set (VLC_MODULE_SHORTCUT, \ + sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \ + goto error; \ +} #define set_shortname( shortname ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \ - (const char *)(shortname))) \ + if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \ goto error; #define set_description( desc ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \ - (const char *)(desc))) \ + if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \ goto error; #define set_help( help ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \ - (const char *)(help))) \ + if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \ goto error; #define set_capability( cap, score ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \ - (const char *)(cap)) \ - || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \ + if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \ + || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \ goto error; #define set_callbacks( activate, deactivate ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \ - || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \ + if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \ + || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \ goto error; -#define linked_with_a_crap_library_which_uses_atexit( ) \ - if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \ +#define cannot_unload_broken_library( ) \ + if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \ goto error; -#define set_text_domain( dom ) domain = (dom); +#define set_text_domain( dom ) \ + if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \ + goto error; /***************************************************************************** * Macros used to build the configuration structure. @@ -263,38 +242,37 @@ enum vlc_config_properties *****************************************************************************/ #define add_type_inner( type ) \ - p_config = vlc_config_create (p_module, type); + vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config); #define add_typedesc_inner( type, text, longtext ) \ add_type_inner( type ) \ - vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \ + vlc_config_set (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); + if (advc) vlc_config_set (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)); + vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); -#define add_string_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, (const char *)(v)); +#define add_string_inner( type, name, text, longtext, advc, v ) \ + add_typename_inner( type, name, text, longtext, advc ) \ + vlc_config_set (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 (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 (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 (VLC_CONFIG_VALUE, (int64_t)(i_id)); #define set_section( text, longtext ) \ add_typedesc_inner( CONFIG_SECTION, text, longtext ) @@ -311,75 +289,85 @@ enum vlc_config_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 ) \ - vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); + value ) \ + vlc_config_set (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 ) \ - vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps)); + value ) \ + vlc_config_set (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 ) \ - p_config->min.i = i_subcategory /* gruik */; + 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 ) \ - p_config->min.i = i_subcategory /* gruik */; + 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 ) -#define add_key( name, value, p_callback, text, longtext, advc ) \ - add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \ - value ) +#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_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_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, 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 ) \ - vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v)); +#define add_float( name, v, text, longtext, advc ) \ + add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \ + vlc_config_set (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 (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); \ - vlc_config_set (p_config, VLC_CONFIG_REMOVED); + vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \ + vlc_config_set (VLC_CONFIG_REMOVED); #define add_obsolete_bool( name ) \ add_obsolete_inner( name, CONFIG_ITEM_BOOL ) @@ -395,58 +383,44 @@ enum vlc_config_properties /* Modifier macros for the config options (used for fine tuning) */ -#define add_deprecated_alias( name ) \ - vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name)) - #define change_short( ch ) \ - vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch)); + vlc_config_set (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 (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 (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)); + (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 (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)); + vlc_config_set (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 (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); +/* For options that are saved but hidden from the preferences panel */ +#define change_private() \ + vlc_config_set (VLC_CONFIG_PRIVATE); -#define change_unsaveable() \ - vlc_config_set (p_config, VLC_CONFIG_VOLATILE); +/* For options that cannot be saved in the configuration */ +#define change_volatile() \ + change_private() \ + vlc_config_set (VLC_CONFIG_VOLATILE); #define change_safe() \ - vlc_config_set (p_config, VLC_CONFIG_SAFE); + vlc_config_set (VLC_CONFIG_SAFE); /* Meta data plugin exports */ #define VLC_META_EXPORT( name, value ) \ @@ -463,7 +437,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