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