git.sesse.net Git - vlc/blob - include/vlc_plugin.h

   1 /*****************************************************************************
   2  * vlc_plugin.h : Macros used from within a module.
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * Copyright © 2007-2008 Rémi Denis-Courmont
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LIBVLC_MODULES_MACROS_H
  25 # define LIBVLC_MODULES_MACROS_H 1
  26
  27 /*****************************************************************************
  28  * If we are not within a module, assume we're in the vlc core.
  29  *****************************************************************************/
  30 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
  31 #   define MODULE_NAME main
  32 #endif
  33
  34 /**
  35  * Current plugin ABI version
  36  */
  37 # define MODULE_SYMBOL 0_9_0k
  38 # define MODULE_SUFFIX "__0_9_0k"
  39
  40 /*****************************************************************************
  41  * Add a few defines. You do not want to read this section. Really.
  42  *****************************************************************************/
  43
  44 /* Explanation:
  45  *
  46  * if HAVE_DYNAMIC_PLUGINS is NOT set, we will need:
  47  * #define MODULE_FUNC( zog ) module_foo_zog
  48  *
  49  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
  50  */
  51
  52 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
  53 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
  54 #define CRUDE_HACK( y, z )  y##__##z
  55
  56 /* If the module is built-in, then we need to define foo_InitModule instead
  57  * of InitModule. Same for Activate- and DeactivateModule. */
  58 #ifdef __PLUGIN__
  59 #   define E_( function )          CONCATENATE( function, MODULE_SYMBOL )
  60 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
  61 #else
  62 #   define E_( function )          CONCATENATE( function, MODULE_NAME )
  63 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
  64 #endif
  65
  66 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
  67 #   define DLL_SYMBOL              __declspec(dllexport)
  68 #   define CDECL_SYMBOL            __cdecl
  69 #elif defined (HAVE_ATTRIBUTE_VISIBILITY)
  70 #   define DLL_SYMBOL __attribute__((visibility("default")))
  71 #   define CDECL_SYMBOL
  72 #else
  73 #   define DLL_SYMBOL
  74 #   define CDECL_SYMBOL
  75 #endif
  76
  77 #if defined( __cplusplus )
  78 #   define EXTERN_SYMBOL           extern "C"
  79 #else
  80 #   define EXTERN_SYMBOL
  81 #endif
  82
  83 /*
  84  * InitModule: this function is called once and only once, when the module
  85  * is looked at for the first time. We get the useful data from it, for
  86  * instance the module name, its shortcuts, its capabilities... we also create
  87  * a copy of its config because the module can be unloaded at any time.
  88  */
  89 #if defined (__PLUGIN__) || defined (__BUILTIN__)
  90 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
  91 E_(vlc_entry) ( module_t *p_module );
  92 #endif
  93
  94 #define vlc_module_begin( )                                                   \
  95     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
  96     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
  97     {                                                                         \
  98         module_config_t *p_config = NULL;                                     \
  99         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
 100                             (const char *)(MODULE_STRING)))                   \
 101             goto error;                                                       \
 102         {                                                                     \
 103             module_t *p_submodule = p_module /* the ; gets added */
 104
 105 #define vlc_module_end( )                                                     \
 106         }                                                                     \
 107         (void)p_config;                                                       \
 108         return VLC_SUCCESS;                                                   \
 109                                                                               \
 110     error:                                                                    \
 111         return VLC_EGENERIC;                                                  \
 112     }                                                                         \
 113     struct _u_n_u_s_e_d_ /* the ; gets added */
 114
 115
 116 #define add_submodule( ) \
 117     p_submodule = vlc_submodule_create( p_module )
 118
 119 #define add_requirement( cap ) \
 120     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
 121                         (int)(CPU_CAPABILITY_##cap))) \
 122         goto error
 123
 124 #define add_shortcut( shortcut ) \
 125     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
 126         (const char *)(shortcut))) \
 127         goto error
 128
 129 #define set_shortname( shortname ) \
 130     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
 131         (const char *)(shortname))) \
 132         goto error
 133
 134 #define set_description( desc ) \
 135     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
 136                         (const char *)(desc))) \
 137         goto error
 138
 139 #define set_help( help ) \
 140     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
 141         goto error
 142
 143 #define set_capability( cap, score ) \
 144     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
 145                         (const char *)(cap)) \
 146      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
 147         goto error
 148
 149 #define set_callbacks( activate, deactivate ) \
 150     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
 151      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
 152         goto error
 153
 154 #define linked_with_a_crap_library_which_uses_atexit( ) \
 155     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
 156         goto error
 157
 158 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 159 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
 160 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
 161 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
 162 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
 163
 164 enum vlc_module_properties
 165 {
 166     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 167      * Append new items at the end ONLY. */
 168     VLC_MODULE_CPU_REQUIREMENT,
 169     VLC_MODULE_SHORTCUT,
 170     VLC_MODULE_SHORTNAME,
 171     VLC_MODULE_DESCRIPTION,
 172     VLC_MODULE_HELP,
 173     VLC_MODULE_CAPABILITY,
 174     VLC_MODULE_SCORE,
 175     VLC_MODULE_PROGRAM,
 176     VLC_MODULE_CB_OPEN,
 177     VLC_MODULE_CB_CLOSE,
 178     VLC_MODULE_NO_UNLOAD,
 179     VLC_MODULE_NAME,
 180 };
 181
 182 enum vlc_config_properties
 183 {
 184     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 185      * Append new items at the end ONLY. */
 186
 187     VLC_CONFIG_NAME,
 188     /* command line name (args=const char *, vlc_callback_t) */
 189
 190     VLC_CONFIG_DESC,
 191     /* description (args=const char *, const char *) */
 192
 193     VLC_CONFIG_VALUE,
 194     /* actual value (args=int/double/const char *) */
 195
 196     VLC_CONFIG_RANGE,
 197     /* minimum value (args=int/double/const char * twice) */
 198
 199     VLC_CONFIG_ADVANCED,
 200     /* enable advanced flag (args=none) */
 201
 202     VLC_CONFIG_VOLATILE,
 203     /* don't write variable to storage (args=none) */
 204
 205     VLC_CONFIG_PERSISTENT,
 206     /* always write variable to storage (args=none) */
 207
 208     VLC_CONFIG_RESTART,
 209     /* restart required to apply value change (args=none) */
 210
 211     VLC_CONFIG_PRIVATE,
 212     /* hide from user (args=none) */
 213
 214     VLC_CONFIG_REMOVED,
 215     /* tag as no longer supported (args=none) */
 216
 217     VLC_CONFIG_CAPABILITY,
 218     /* capability for a module or list thereof (args=const char*) */
 219
 220     VLC_CONFIG_SHORTCUT,
 221     /* one-character (short) command line option name (args=char) */
 222
 223     VLC_CONFIG_LIST,
 224     /* possible values list
 225      * (args=size_t, const <type> *, const char *const *) */
 226
 227     VLC_CONFIG_ADD_ACTION,
 228     /* add value change callback (args=vlc_callback_t, const char *) */
 229
 230     VLC_CONFIG_OLDNAME,
 231     /* former option name (args=const char *) */
 232
 233     VLC_CONFIG_SAFE,
 234     /* tag as modifiable by untrusted input item "sources" (args=none) */
 235 };
 236
 237 /*****************************************************************************
 238  * Macros used to build the configuration structure.
 239  *
 240  * Note that internally we support only 3 types of config data: int, float
 241  *   and string.
 242  *   The other types declared here just map to one of these 3 basic types but
 243  *   have the advantage of also providing very good hints to a configuration
 244  *   interface so as to make it more user friendly.
 245  * The configuration structure also includes category hints. These hints can
 246  *   provide a configuration interface with some very useful data and again
 247  *   allow for a more user friendly interface.
 248  *****************************************************************************/
 249
 250 #define add_type_inner( type ) \
 251     p_config = vlc_config_create (p_module, type)
 252
 253 #define add_typedesc_inner( type, text, longtext ) \
 254     add_type_inner( type ); \
 255     vlc_config_set (p_config, VLC_CONFIG_DESC, \
 256                     (const char *)(text), (const char *)(longtext))
 257
 258 #define add_typeadv_inner( type, text, longtext, advc ) \
 259     add_typedesc_inner( type, text, longtext ); \
 260     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
 261
 262 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
 263     add_typeadv_inner( type, text, longtext, advc ); \
 264     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 265                     (const char *)(name), (vlc_callback_t)(cb))
 266
 267 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
 268     add_typename_inner( type, name, text, longtext, advc, cb ); \
 269     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
 270
 271 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
 272     add_typename_inner( type, name, text, longtext, advc, cb ); \
 273     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
 274
 275
 276 #define set_category( i_id ) \
 277     add_type_inner( CONFIG_CATEGORY ); \
 278     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 279
 280 #define set_subcategory( i_id ) \
 281     add_type_inner( CONFIG_SUBCATEGORY ); \
 282     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 283
 284 #define set_section( text, longtext ) \
 285     add_typedesc_inner( CONFIG_SECTION, text, longtext )
 286
 287 #define add_category_hint( text, longtext, advc ) \
 288     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
 289
 290 #define add_subcategory_hint( text, longtext ) \
 291     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
 292
 293 #define end_subcategory_hint \
 294     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
 295
 296 #define add_usage_hint( text ) \
 297     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 298
 299 #define add_string( name, value, p_callback, text, longtext, advc ) \
 300     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
 301
 302 #define add_password( name, value, p_callback, text, longtext, advc ) \
 303     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
 304
 305 #define add_file( name, value, p_callback, text, longtext, advc ) \
 306     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
 307
 308 #define add_directory( name, value, p_callback, text, longtext, advc ) \
 309     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
 310
 311 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
 312     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
 313     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
 314
 315 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
 316     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
 317     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
 318
 319 #ifndef __PLUGIN__
 320 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 321     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
 322     p_config->min.i = i_subcategory /* gruik */
 323
 324 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 325     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
 326     p_config->min.i = i_subcategory /* gruik */
 327 #endif
 328
 329 #define add_integer( name, value, p_callback, text, longtext, advc ) \
 330     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
 331
 332 #define add_key( name, value, p_callback, text, longtext, advc ) \
 333     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
 334
 335 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
 336     add_integer( name, value, p_callback, text, longtext, advc ); \
 337     change_integer_range( i_min, i_max )
 338
 339 #define add_float( name, v, p_callback, text, longtext, advc ) \
 340     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
 341     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
 342
 343 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
 344     add_float( name, value, p_callback, text, longtext, advc ); \
 345     change_float_range( f_min, f_max )
 346
 347 #define add_bool( name, v, p_callback, text, longtext, advc ) \
 348     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
 349     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
 350
 351 /* For removed option */
 352 #define add_obsolete_inner( name, type ) \
 353     add_type_inner( type ); \
 354     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 355                     (const char *)(name), (vlc_callback_t)NULL); \
 356     vlc_config_set (p_config, VLC_CONFIG_REMOVED)
 357
 358 #define add_obsolete_bool( name ) \
 359         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
 360
 361 #define add_obsolete_integer( name ) \
 362         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
 363
 364 #define add_obsolete_float( name ) \
 365         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
 366
 367 #define add_obsolete_string( name ) \
 368         add_obsolete_inner( name, CONFIG_ITEM_STRING )
 369
 370 /* Modifier macros for the config options (used for fine tuning) */
 371
 372 #define add_deprecated_alias( name ) \
 373     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
 374
 375 #define change_short( ch ) \
 376     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
 377
 378 #define change_string_list( list, list_text, list_update_func ) \
 379     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 380                     (size_t)(sizeof (list) / sizeof (char *)), \
 381                     (const char *const *)(list), \
 382                     (const char *const *)(list_text), \
 383                     list_update_func)
 384
 385 #define change_integer_list( list, list_text, list_update_func ) \
 386     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 387                     (size_t)(sizeof (list) / sizeof (int)), \
 388                     (const int *)(list), \
 389                     (const char *const *)(list_text), \
 390                     list_update_func)
 391
 392 #define change_float_list( list, list_text, list_update_func ) \
 393     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 394                     (size_t)(sizeof (list) / sizeof (float)), \
 395                     (const float *)(list), \
 396                     (const char *const *)(list_text), \
 397                     list_update_func)
 398
 399 #define change_integer_range( minv, maxv ) \
 400     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
 401
 402 #define change_float_range( minv, maxv ) \
 403     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
 404                     (double)(minv), (double)(maxv))
 405
 406 #define change_action_add( pf_action, text ) \
 407     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
 408                     (vlc_callback_t)(pf_action), (const char *)(text))
 409
 410 #define change_internal() \
 411     vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
 412
 413 #define change_need_restart() \
 414     vlc_config_set (p_config, VLC_CONFIG_RESTART)
 415
 416 #define change_autosave() \
 417     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
 418
 419 #define change_unsaveable() \
 420     vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
 421
 422 #define change_unsafe() (void)0 /* no-op */
 423
 424 #define change_safe() \
 425     vlc_config_set (p_config, VLC_CONFIG_SAFE)
 426
 427 #endif