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-2009 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  * \file
  29  * This file implements plugin (module) macros used to define a vlc module.
  30  */
  31
  32 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
  33 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
  34 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
  35 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
  36 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
  37
  38 enum vlc_module_properties
  39 {
  40     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  41      * Append new items at the end ONLY. */
  42     VLC_MODULE_CPU_REQUIREMENT,
  43     VLC_MODULE_SHORTCUT,
  44     VLC_MODULE_CAPABILITY,
  45     VLC_MODULE_SCORE,
  46     VLC_MODULE_CB_OPEN,
  47     VLC_MODULE_CB_CLOSE,
  48     VLC_MODULE_NO_UNLOAD,
  49     VLC_MODULE_NAME,
  50     VLC_MODULE_SHORTNAME,
  51     VLC_MODULE_DESCRIPTION,
  52     VLC_MODULE_HELP,
  53 };
  54
  55 enum vlc_config_properties
  56 {
  57     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
  58      * Append new items at the end ONLY. */
  59
  60     VLC_CONFIG_NAME,
  61     /* command line name (args=const char *, vlc_callback_t) */
  62
  63     VLC_CONFIG_VALUE,
  64     /* actual value (args=int/double/const char *) */
  65
  66     VLC_CONFIG_RANGE,
  67     /* minimum value (args=int/double/const char * twice) */
  68
  69     VLC_CONFIG_ADVANCED,
  70     /* enable advanced flag (args=none) */
  71
  72     VLC_CONFIG_VOLATILE,
  73     /* don't write variable to storage (args=none) */
  74
  75     VLC_CONFIG_PERSISTENT,
  76     /* always write variable to storage (args=none) */
  77
  78     VLC_CONFIG_RESTART,
  79     /* restart required to apply value change (args=none) */
  80
  81     VLC_CONFIG_PRIVATE,
  82     /* hide from user (args=none) */
  83
  84     VLC_CONFIG_REMOVED,
  85     /* tag as no longer supported (args=none) */
  86
  87     VLC_CONFIG_CAPABILITY,
  88     /* capability for a module or list thereof (args=const char*) */
  89
  90     VLC_CONFIG_SHORTCUT,
  91     /* one-character (short) command line option name (args=char) */
  92
  93     VLC_CONFIG_OLDNAME,
  94     /* former option name (args=const char *) */
  95
  96     VLC_CONFIG_SAFE,
  97     /* tag as modifiable by untrusted input item "sources" (args=none) */
  98
  99     VLC_CONFIG_DESC,
 100     /* description (args=const char *, const char *, const char *) */
 101
 102     VLC_CONFIG_LIST,
 103     /* possible values list
 104      * (args=const char *, size_t, const <type> *, const char *const *) */
 105
 106     VLC_CONFIG_ADD_ACTION,
 107     /* add value change callback
 108      * (args=const char *, vlc_callback_t, const char *) */
 109 };
 110
 111 /*****************************************************************************
 112  * If we are not within a module, assume we're in the vlc core.
 113  *****************************************************************************/
 114 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
 115 #   define MODULE_NAME main
 116 #endif
 117
 118 /**
 119  * Current plugin ABI version
 120  */
 121 # define MODULE_SYMBOL 1_0_0d
 122 # define MODULE_SUFFIX "__1_0_0d"
 123
 124 /*****************************************************************************
 125  * Add a few defines. You do not want to read this section. Really.
 126  *****************************************************************************/
 127
 128 /* Explanation:
 129  *
 130  * if linking a module statically, we will need:
 131  * #define MODULE_FUNC( zog ) module_foo_zog
 132  *
 133  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 134  */
 135
 136 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
 137 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
 138 #define CRUDE_HACK( y, z )  y##__##z
 139
 140 /* If the module is built-in, then we need to define foo_InitModule instead
 141  * of InitModule. Same for Activate- and DeactivateModule. */
 142 #ifdef __PLUGIN__
 143 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
 144 #else
 145 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
 146 #endif
 147
 148 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
 149 #   define DLL_SYMBOL              __declspec(dllexport)
 150 #   define CDECL_SYMBOL            __cdecl
 151 #else
 152 #   define DLL_SYMBOL
 153 #   define CDECL_SYMBOL
 154 #endif
 155
 156 #if defined( __cplusplus )
 157 #   define EXTERN_SYMBOL           extern "C"
 158 #else
 159 #   define EXTERN_SYMBOL
 160 #endif
 161
 162 /*
 163  * InitModule: this function is called once and only once, when the module
 164  * is looked at for the first time. We get the useful data from it, for
 165  * instance the module name, its shortcuts, its capabilities... we also create
 166  * a copy of its config because the module can be unloaded at any time.
 167  */
 168 #define vlc_module_begin( )                                                   \
 169     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
 170     __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
 171                                                                               \
 172     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
 173     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
 174     {                                                                         \
 175         module_config_t *p_config = NULL;                                     \
 176         const char *domain = NULL;                                            \
 177         if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
 178                             (const char *)(MODULE_STRING)))                   \
 179             goto error;                                                       \
 180         {                                                                     \
 181             module_t *p_submodule = p_module;
 182
 183 #define vlc_module_end( )                                                     \
 184         }                                                                     \
 185         (void)p_config;                                                       \
 186         return VLC_SUCCESS;                                                   \
 187                                                                               \
 188     error:                                                                    \
 189         return VLC_EGENERIC;                                                  \
 190     }                                                                         \
 191     VLC_METADATA_EXPORTS
 192
 193 #define add_submodule( ) \
 194     p_submodule = vlc_submodule_create( p_module );
 195
 196 #define add_requirement( cap ) \
 197     if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
 198                         (int)(CPU_CAPABILITY_##cap))) \
 199         goto error;
 200
 201 #define add_shortcut( shortcut ) \
 202     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
 203         (const char *)(shortcut))) \
 204         goto error;
 205
 206 #define set_shortname( shortname ) \
 207     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
 208                         (const char *)(shortname))) \
 209         goto error;
 210
 211 #define set_description( desc ) \
 212     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
 213                         (const char *)(desc))) \
 214         goto error;
 215
 216 #define set_help( help ) \
 217     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
 218                         (const char *)(help))) \
 219         goto error;
 220
 221 #define set_capability( cap, score ) \
 222     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
 223                         (const char *)(cap)) \
 224      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
 225         goto error;
 226
 227 #define set_callbacks( activate, deactivate ) \
 228     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
 229      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
 230         goto error;
 231
 232 #define linked_with_a_crap_library_which_uses_atexit( ) \
 233     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
 234         goto error;
 235
 236 #define set_text_domain( dom ) domain = (dom);
 237
 238 /*****************************************************************************
 239  * Macros used to build the configuration structure.
 240  *
 241  * Note that internally we support only 3 types of config data: int, float
 242  *   and string.
 243  *   The other types declared here just map to one of these 3 basic types but
 244  *   have the advantage of also providing very good hints to a configuration
 245  *   interface so as to make it more user friendly.
 246  * The configuration structure also includes category hints. These hints can
 247  *   provide a configuration interface with some very useful data and again
 248  *   allow for a more user friendly interface.
 249  *****************************************************************************/
 250
 251 #define add_type_inner( type ) \
 252     p_config = vlc_config_create (p_module, type);
 253
 254 #define add_typedesc_inner( type, text, longtext ) \
 255     add_type_inner( type ) \
 256     vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
 257                     (const char *)(text), (const char *)(longtext));
 258
 259 #define add_typeadv_inner( type, text, longtext, advc ) \
 260     add_typedesc_inner( type, text, longtext ) \
 261     if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
 262
 263 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
 264     add_typeadv_inner( type, text, longtext, advc ) \
 265     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 266                     (const char *)(name), (vlc_callback_t)(cb));
 267
 268 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
 269     add_typename_inner( type, name, text, longtext, advc, cb ) \
 270     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
 271
 272 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
 273     add_typename_inner( type, name, text, longtext, advc, cb ) \
 274     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
 275
 276
 277 #define set_category( i_id ) \
 278     add_type_inner( CONFIG_CATEGORY ) \
 279     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 280
 281 #define set_subcategory( i_id ) \
 282     add_type_inner( CONFIG_SUBCATEGORY ) \
 283     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
 284
 285 #define set_section( text, longtext ) \
 286     add_typedesc_inner( CONFIG_SECTION, text, longtext )
 287
 288 #define add_category_hint( text, longtext, advc ) \
 289     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
 290
 291 #define add_subcategory_hint( text, longtext ) \
 292     add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
 293
 294 #define end_subcategory_hint \
 295     add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
 296
 297 #define add_usage_hint( text ) \
 298     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
 299
 300 #define add_string( name, value, p_callback, text, longtext, advc ) \
 301     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
 302                       p_callback, value )
 303
 304 #define add_password( name, value, p_callback, text, longtext, advc ) \
 305     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
 306                       p_callback, value )
 307
 308 #define add_file( name, value, p_callback, text, longtext, advc ) \
 309     add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
 310                       p_callback, value )
 311
 312 #define add_directory( name, value, p_callback, text, longtext, advc ) \
 313     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
 314                       p_callback, value )
 315
 316 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
 317     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
 318                       p_callback, value ) \
 319     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 320
 321 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
 322     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
 323                       p_callback, value ) \
 324     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
 325
 326 #ifndef __PLUGIN__
 327 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 328     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
 329                       p_callback, value ) \
 330     p_config->min.i = i_subcategory /* gruik */;
 331
 332 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
 333     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
 334                       advc, p_callback, value ) \
 335     p_config->min.i = i_subcategory /* gruik */;
 336 #endif
 337
 338 #define add_integer( name, value, p_callback, text, longtext, advc ) \
 339     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
 340                    p_callback, value )
 341
 342 #if !defined(WIN32) && !defined(SYS_LINUX)
 343 #define add_key( name, value, p_callback, text, longtext, advc ) \
 344     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
 345                    value )
 346 #else
 347 #define add_key( name, value, p_callback, text, longtext, advc ) \
 348     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
 349                    p_callback, value ) \
 350     add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
 351                    p_callback, KEY_UNSET )
 352 #endif
 353
 354 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
 355     add_integer( name, value, p_callback, text, longtext, advc ) \
 356     change_integer_range( i_min, i_max )
 357
 358 #define add_float( name, v, p_callback, text, longtext, advc ) \
 359     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
 360     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
 361
 362 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
 363     add_float( name, value, p_callback, text, longtext, advc ) \
 364     change_float_range( f_min, f_max )
 365
 366 #define add_bool( name, v, p_callback, text, longtext, advc ) \
 367     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
 368                         p_callback ) \
 369     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
 370
 371 /* For removed option */
 372 #define add_obsolete_inner( name, type ) \
 373     add_type_inner( type ) \
 374     vlc_config_set (p_config, VLC_CONFIG_NAME, \
 375                     (const char *)(name), (vlc_callback_t)NULL); \
 376     vlc_config_set (p_config, VLC_CONFIG_REMOVED);
 377
 378 #define add_obsolete_bool( name ) \
 379         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
 380
 381 #define add_obsolete_integer( name ) \
 382         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
 383
 384 #define add_obsolete_float( name ) \
 385         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
 386
 387 #define add_obsolete_string( name ) \
 388         add_obsolete_inner( name, CONFIG_ITEM_STRING )
 389
 390 /* Modifier macros for the config options (used for fine tuning) */
 391
 392 #define add_deprecated_alias( name ) \
 393     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
 394
 395 #define change_short( ch ) \
 396     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
 397
 398 #define change_string_list( list, list_text, list_update_func ) \
 399     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 400                     (size_t)(sizeof (list) / sizeof (char *)), \
 401                     (const char *const *)(list), \
 402                     (const char *const *)(list_text), \
 403                     (vlc_callback_t)(list_update_func));
 404
 405 #define change_integer_list( list, list_text, list_update_func ) \
 406     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 407                     (size_t)(sizeof (list) / sizeof (int)), \
 408                     (const int *)(list), \
 409                     (const char *const *)(list_text), \
 410                     (vlc_callback_t)(list_update_func));
 411
 412 #define change_float_list( list, list_text, list_update_func ) \
 413     vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
 414                     (size_t)(sizeof (list) / sizeof (float)), \
 415                     (const float *)(list), \
 416                     (const char *const *)(list_text), \
 417                     (vlc_callback_t)(list_update_func));
 418
 419 #define change_integer_range( minv, maxv ) \
 420     vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
 421
 422 #define change_float_range( minv, maxv ) \
 423     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
 424                     (double)(minv), (double)(maxv));
 425
 426 #define change_action_add( pf_action, text ) \
 427     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
 428                     (vlc_callback_t)(pf_action), (const char *)(text));
 429
 430 #define change_internal() \
 431     vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
 432
 433 #define change_need_restart() \
 434     vlc_config_set (p_config, VLC_CONFIG_RESTART);
 435
 436 #define change_autosave() \
 437     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
 438
 439 #define change_unsaveable() \
 440     vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
 441
 442 #define change_safe() \
 443     vlc_config_set (p_config, VLC_CONFIG_SAFE);
 444
 445 /* Meta data plugin exports */
 446 #define VLC_META_EXPORT( name, value ) \
 447     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
 448     __VLC_SYMBOL(vlc_entry_ ## name) (void); \
 449     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
 450     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
 451     { \
 452          return value; \
 453     }
 454
 455 #if defined (__LIBVLC__)
 456 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
 457     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
 458     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
 459     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
 460     "\x6c\x6f\x70\x70\x65\x72\x73" )
 461 #elif !defined (VLC_COPYRIGHT_EXPORT)
 462 # define VLC_COPYRIGHT_EXPORT
 463 #endif
 464 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
 465     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
 466     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
 467     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
 468     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
 469     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
 470
 471 #define VLC_METADATA_EXPORTS \
 472     VLC_COPYRIGHT_EXPORT \
 473     VLC_LICENSE_EXPORT
 474
 475 #endif