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, (int)(shortcut))) \
 126         goto error
 127
 128 #define set_shortname( shortname ) \
 129     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
 130         (const char *)(shortname))) \
 131         goto error
 132
 133 #define set_description( desc ) \
 134     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
 135                         (const char *)(desc))) \
 136         goto error
 137
 138 #define set_help( help ) \
 139     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
 140         goto error
 141
 142 #define set_capability( cap, score ) \
 143     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, (int)(cap)) \
 144      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
 145         goto error
 146
 147 #define set_callbacks( activate, deactivate ) \
 148     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
 149      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
 150         goto error
 151
 152 #define linked_with_a_crap_library_which_uses_atexit( ) \
 153     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
 154         goto error
 155
 156 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
 157 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
 158 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
 159 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
 160 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
 161
 162 enum vlc_module_properties
 163 {
 164     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 165      * Append new items at the end ONLY. */
 166     VLC_MODULE_CPU_REQUIREMENT,
 167     VLC_MODULE_SHORTCUT,
 168     VLC_MODULE_SHORTNAME,
 169     VLC_MODULE_DESCRIPTION,
 170     VLC_MODULE_HELP,
 171     VLC_MODULE_CAPABILITY,
 172     VLC_MODULE_SCORE,
 173     VLC_MODULE_PROGRAM,
 174     VLC_MODULE_CB_OPEN,
 175     VLC_MODULE_CB_CLOSE,
 176     VLC_MODULE_NO_UNLOAD,
 177     VLC_MODULE_NAME,
 178 };
 179
 180 enum vlc_config_properties
 181 {
 182     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
 183      * Append new items at the end ONLY. */
 184
 185     VLC_CONFIG_NAME,
 186     /* command line name (args=const char *, vlc_callback_t) */
 187
 188     VLC_CONFIG_DESC,
 189     /* description (args=const char *, const char *) */
 190
 191     VLC_CONFIG_VALUE,
 192     /* actual value (args=int/double/const char *) */
 193
 194     VLC_CONFIG_RANGE,
 195     /* minimum value (args=int/double/const char * twice) */
 196
 197     VLC_CONFIG_ADVANCED,
 198     /* enable advanced flag (args=none) */
 199
 200     VLC_CONFIG_VOLATILE,
 201     /* don't write variable to storage (args=none) */
 202
 203     VLC_CONFIG_PERSISTENT,
 204     /* always write variable to storage (args=none) */
 205
 206     VLC_CONFIG_RESTART,
 207     /* restart required to apply value change (args=none) */
 208
 209     VLC_CONFIG_PRIVATE,
 210     /* hide from user (args=none) */
 211
 212     VLC_CONFIG_REMOVED,
 213     /* tag as no longer supported (args=none) */
 214
 215     VLC_CONFIG_CAPABILITY,
 216     /* capability for a module or list thereof (args=const char*) */
 217
 218     VLC_CONFIG_SHORTCUT,
 219     /* one-character (short) command line option name (args=char) */
 220
 221     VLC_CONFIG_LIST,
 222     /* possible values list
 223      * (args=size_t, const <type> *, const char *const *) */
 224
 225     VLC_CONFIG_ADD_ACTION,
 226     /* add value change callback (args=vlc_callback_t, const char *) */
 227
 228     VLC_CONFIG_OLDNAME,
 229     /* former option name (args=const char *) */
 230
 231     VLC_CONFIG_SAFE,
 232     /* tag as modifiable by untrusted input item "sources" (args=none) */
 233 };
 234
 235 /*****************************************************************************
 236  * Macros used to build the configuration structure.
 237  *
 238  * Note that internally we support only 3 types of config data: int, float
 239  *   and string.
 240  *   The other types declared here just map to one of these 3 basic types but
 241  *   have the advantage of also providing very good hints to a configuration
 242  *   interface so as to make it more user friendly.
 243  * The configuration structure also includes category hints. These hints can
 244  *   provide a configuration interface with some very useful data and again
 245  *   allow for a more user friendly interface.
 246  *****************************************************************************/
 247
 248 #define add_type_inner( type ) \
 249     p_config = vlc_config_create (p_module, type)
 250
 251 #define add_typedesc_inner( type, text, longtext ) \
 252     add_type_inner( type ); \
 253     vlc_config_set (p_config, VLC_CONFIG_DESC, \
 254                     (const char *)(text), (const char *)(longtext))
 255
 256 #define add_typeadv_inner( type, text, longtext, advc ) \
 257     add_typedesc_inner( type, text, longtext ); \
 258     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
 259
 260 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
 261     add_typeadv_inner( type, text, longtext, advc ); \
 262     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 263                     (const char *)(name), (vlc_callback_t)(cb))
 264
 265 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
 266     add_typename_inner( type, name, text, longtext, advc, cb ); \
 267     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v))
 268
 269 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
 270     add_typename_inner( type, name, text, longtext, advc, cb ); \
 271     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v))
 272
 273
 274 #define set_category( i_id ) \
 275     add_type_inner( CONFIG_CATEGORY ); \
 276     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 277
 278 #define set_subcategory( i_id ) \
 279     add_type_inner( CONFIG_SUBCATEGORY ); \
 280     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
 281
 282 #define set_section( text, longtext ) \
 283     add_typedesc_inner( CONFIG_SECTION, text, longtext )
 284
 285 #define add_category_hint( text, longtext, advc ) \
 286     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
 287
 288 #define add_subcategory_hint( text, longtext ) \
 289     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
 290
 291 #define end_subcategory_hint \
 292     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
 293
 294 #define add_usage_hint( text ) \
 295     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 296
 297 #define add_string( name, value, p_callback, text, longtext, advc ) \
 298     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
 299
 300 #define add_password( name, value, p_callback, text, longtext, advc ) \
 301     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
 302
 303 #define add_file( name, value, p_callback, text, longtext, advc ) \
 304     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
 305
 306 #define add_directory( name, value, p_callback, text, longtext, advc ) \
 307     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
 308
 309 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
 310     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
 311     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
 312
 313 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
 314     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
 315     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
 316
 317 #ifndef __PLUGIN__
 318 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 319     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
 320     p_config->min.i = i_subcategory /* gruik */
 321
 322 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 323     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
 324     p_config->min.i = i_subcategory /* gruik */
 325 #endif
 326
 327 #define add_integer( name, value, p_callback, text, longtext, advc ) \
 328     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
 329
 330 #define add_key( name, value, p_callback, text, longtext, advc ) \
 331     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
 332
 333 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
 334     add_integer( name, value, p_callback, text, longtext, advc ); \
 335     change_integer_range( i_min, i_max )
 336
 337 #define add_float( name, v, p_callback, text, longtext, advc ) \
 338     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
 339     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
 340
 341 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
 342     add_float( name, value, p_callback, text, longtext, advc ); \
 343     change_float_range( f_min, f_max )
 344
 345 #define add_bool( name, v, p_callback, text, longtext, advc ) \
 346     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
 347     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
 348
 349 /* For removed option */
 350 #define add_obsolete_inner( name, type ) \
 351     add_type_inner( type ); \
 352     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 353                     (const char *)(name), (vlc_callback_t)NULL); \
 354     vlc_config_set (p_config, VLC_CONFIG_REMOVED)
 355
 356 #define add_obsolete_bool( name ) \
 357         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
 358
 359 #define add_obsolete_integer( name ) \
 360         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
 361
 362 #define add_obsolete_float( name ) \
 363         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
 364
 365 #define add_obsolete_string( name ) \
 366         add_obsolete_inner( name, CONFIG_ITEM_STRING )
 367
 368 /* Modifier macros for the config options (used for fine tuning) */
 369
 370 #define add_deprecated_alias( name ) \
 371     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
 372
 373 #define change_short( ch ) \
 374     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
 375
 376 #define change_string_list( list, list_text, list_update_func ) \
 377     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 378                     (size_t)(sizeof (list) / sizeof (char *)), \
 379                     (const char *const *)(list), \
 380                     (const char *const *)(list_text), \
 381                     list_update_func)
 382
 383 #define change_integer_list( list, list_text, list_update_func ) \
 384     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 385                     (size_t)(sizeof (list) / sizeof (int)), \
 386                     (const int *)(list), \
 387                     (const char *const *)(list_text), \
 388                     list_update_func)
 389
 390 #define change_float_list( list, list_text, list_update_func ) \
 391     vlc_config_set (p_config, VLC_CONFIG_LIST, \
 392                     (size_t)(sizeof (list) / sizeof (float)), \
 393                     (const float *)(list), \
 394                     (const char *const *)(list_text), \
 395                     list_update_func)
 396
 397 #define change_integer_range( minv, maxv ) \
 398     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
 399
 400 #define change_float_range( minv, maxv ) \
 401     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
 402                     (double)(minv), (double)(maxv))
 403
 404 #define change_action_add( pf_action, text ) \
 405     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
 406                     (vlc_callback_t)(pf_action), (const char *)(text))
 407
 408 #define change_internal() \
 409     vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
 410
 411 #define change_need_restart() \
 412     vlc_config_set (p_config, VLC_CONFIG_RESTART)
 413
 414 #define change_autosave() \
 415     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
 416
 417 #define change_unsaveable() \
 418     vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
 419
 420 #define change_unsafe() (void)0 /* no-op */
 421
 422 #define change_safe() \
 423     vlc_config_set (p_config, VLC_CONFIG_SAFE)
 424
 425 #endif