vlc_plugin.h 18.5 KB
Newer Older
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 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

24 25 26
#ifndef LIBVLC_MODULES_MACROS_H
# define LIBVLC_MODULES_MACROS_H 1

27 28 29 30 31
/**
 * \file
 * This file implements plugin (module) macros used to define a vlc module.
 */

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
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
{
    /* 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_SHORTCUT,
    VLC_MODULE_CAPABILITY,
    VLC_MODULE_SCORE,
    VLC_MODULE_CB_OPEN,
    VLC_MODULE_CB_CLOSE,
    VLC_MODULE_NO_UNLOAD,
    VLC_MODULE_NAME,
    VLC_MODULE_SHORTNAME,
    VLC_MODULE_DESCRIPTION,
    VLC_MODULE_HELP,
};

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_VALUE,
    /* actual value (args=int/double/const char *) */

    VLC_CONFIG_RANGE,
    /* minimum value (args=int/double/const char * twice) */

    VLC_CONFIG_ADVANCED,
    /* enable advanced flag (args=none) */

    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_PRIVATE,
    /* hide from user (args=none) */

    VLC_CONFIG_REMOVED,
    /* tag as no longer supported (args=none) */

    VLC_CONFIG_CAPABILITY,
    /* capability for a module or list thereof (args=const char*) */

    VLC_CONFIG_SHORTCUT,
    /* one-character (short) command line option name (args=char) */

    VLC_CONFIG_OLDNAME,
    /* former option name (args=const char *) */

    VLC_CONFIG_SAFE,
    /* tag as modifiable by untrusted input item "sources" (args=none) */

    VLC_CONFIG_DESC,
    /* description (args=const char *, const char *, const char *) */

    VLC_CONFIG_LIST,
    /* possible values list
     * (args=const char *, size_t, const <type> *, const char *const *) */

    VLC_CONFIG_ADD_ACTION,
    /* add value change callback
     * (args=const char *, vlc_callback_t, const char *) */
};

110 111 112 113 114 115 116 117 118 119
/*****************************************************************************
 * If we are not within a module, assume we're in the vlc core.
 *****************************************************************************/
#if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
#   define MODULE_NAME main
#endif

/**
 * Current plugin ABI version
 */
120 121
# define MODULE_SYMBOL 1_0_0d
# define MODULE_SUFFIX "__1_0_0d"
122 123 124 125 126 127 128

/*****************************************************************************
 * Add a few defines. You do not want to read this section. Really.
 *****************************************************************************/

/* Explanation:
 *
129
 * if linking a module statically, we will need:
130 131 132 133 134
 * #define MODULE_FUNC( zog ) module_foo_zog
 *
 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 */

135
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
#define CONCATENATE( y, z ) CRUDE_HACK( y, z )
#define CRUDE_HACK( y, z )  y##__##z

/* If the module is built-in, then we need to define foo_InitModule instead
 * of InitModule. Same for Activate- and DeactivateModule. */
#ifdef __PLUGIN__
#   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
#else
#   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
#endif

#if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
#   define DLL_SYMBOL              __declspec(dllexport)
#   define CDECL_SYMBOL            __cdecl
#else
#   define DLL_SYMBOL
#   define CDECL_SYMBOL
#endif

#if defined( __cplusplus )
#   define EXTERN_SYMBOL           extern "C"
#else
#   define EXTERN_SYMBOL
#endif

/*
 * 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                                 \
169
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
170 171
                                                                              \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
172 173 174
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
    {                                                                         \
        module_config_t *p_config = NULL;                                     \
175
        const char *domain = NULL;                                            \
176 177 178 179
        if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                            (const char *)(MODULE_STRING)))                   \
            goto error;                                                       \
        {                                                                     \
180
            module_t *p_submodule = p_module;
181 182 183 184 185 186 187 188

#define vlc_module_end( )                                                     \
        }                                                                     \
        (void)p_config;                                                       \
        return VLC_SUCCESS;                                                   \
                                                                              \
    error:                                                                    \
        return VLC_EGENERIC;                                                  \
189 190
    }                                                                         \
    VLC_METADATA_EXPORTS
191 192

#define add_submodule( ) \
193
    p_submodule = vlc_submodule_create( p_module );
194 195 196 197

#define add_requirement( cap ) \
    if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
                        (int)(CPU_CAPABILITY_##cap))) \
198
        goto error;
199 200

#define add_shortcut( shortcut ) \
Rafaël Carré's avatar
Rafaël Carré committed
201 202
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
        (const char *)(shortcut))) \
203
        goto error;
204 205

#define set_shortname( shortname ) \
206 207
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
                        (const char *)(shortname))) \
208
        goto error;
209 210

#define set_description( desc ) \
211
    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
212
                        (const char *)(desc))) \
213
        goto error;
214 215

#define set_help( help ) \
216 217
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
                        (const char *)(help))) \
218
        goto error;
219 220

#define set_capability( cap, score ) \
221 222
    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
                        (const char *)(cap)) \
223
     || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
224
        goto error;
225 226 227 228

#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)) \
229
        goto error;
230 231 232

#define linked_with_a_crap_library_which_uses_atexit( ) \
    if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
233
        goto error;
234

235 236
#define set_text_domain( dom ) domain = (dom);

237 238 239 240 241 242 243 244 245 246 247 248 249 250
/*****************************************************************************
 * Macros used to build the configuration structure.
 *
 * Note that internally we support only 3 types of config data: int, float
 *   and string.
 *   The other types declared here just map to one of these 3 basic types but
 *   have the advantage of also providing very good hints to a configuration
 *   interface so as to make it more user friendly.
 * The configuration structure also includes category hints. These hints can
 *   provide a configuration interface with some very useful data and again
 *   allow for a more user friendly interface.
 *****************************************************************************/

#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, domain, \
256
                    (const char *)(text), (const char *)(longtext));
257 258

#define add_typeadv_inner( type, text, longtext, advc ) \
259 260
    add_typedesc_inner( type, text, longtext ) \
    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 269
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    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 273
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
274 275 276


#define set_category( i_id ) \
277 278
    add_type_inner( CONFIG_CATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
279 280

#define set_subcategory( i_id ) \
281 282
    add_type_inner( CONFIG_SUBCATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299

#define set_section( text, longtext ) \
    add_typedesc_inner( CONFIG_SECTION, text, longtext )

#define add_category_hint( text, longtext, advc ) \
    add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )

#define add_subcategory_hint( text, longtext ) \
    add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )

#define end_subcategory_hint \
    add_type_inner( CONFIG_HINT_SUBCATEGORY_END )

#define add_usage_hint( text ) \
    add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )

#define add_string( name, value, p_callback, text, longtext, advc ) \
300 301
    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
                      p_callback, value )
302 303

#define add_password( name, value, p_callback, text, longtext, advc ) \
304 305
    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
                      p_callback, value )
306 307

#define add_file( name, value, p_callback, text, longtext, advc ) \
308 309
    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
                      p_callback, value )
310 311

#define add_directory( name, value, p_callback, text, longtext, advc ) \
312 313
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
                      p_callback, value )
314 315

#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
316 317 318
    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));
319 320

#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
321 322 323
    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));
324 325 326

#ifndef __PLUGIN__
#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
327 328
    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
                      p_callback, value ) \
329
    change_integer_range (i_subcategory /* gruik */, 0);
330 331

#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
332 333
    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
                      advc, p_callback, value ) \
334
    change_integer_range (i_subcategory /* gruik */, 0);
335 336 337
#endif

#define add_integer( name, value, p_callback, text, longtext, advc ) \
338 339
    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
                   p_callback, value )
340

341
#if !defined(WIN32) && !defined(SYS_LINUX)
342
#define add_key( name, value, p_callback, text, longtext, advc ) \
343 344
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
                   value )
Hannes Domani's avatar
Hannes Domani committed
345 346 347 348 349 350 351
#else
#define add_key( name, value, p_callback, text, longtext, advc ) \
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
                   p_callback, value ) \
    add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
                   p_callback, KEY_UNSET )
#endif
352 353

#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
354
    add_integer( name, value, p_callback, text, longtext, advc ) \
355 356 357
    change_integer_range( i_min, i_max )

#define add_float( name, v, p_callback, text, longtext, advc ) \
358 359
    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
360 361

#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
362
    add_float( name, value, p_callback, text, longtext, advc ) \
363 364 365
    change_float_range( f_min, f_max )

#define add_bool( name, v, p_callback, text, longtext, advc ) \
366 367 368
    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
                        p_callback ) \
    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
369 370 371

/* For removed option */
#define add_obsolete_inner( name, type ) \
372
    add_type_inner( type ) \
373 374
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
                    (const char *)(name), (vlc_callback_t)NULL); \
375
    vlc_config_set (p_config, VLC_CONFIG_REMOVED);
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391

#define add_obsolete_bool( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_BOOL )

#define add_obsolete_integer( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_INTEGER )

#define add_obsolete_float( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_FLOAT )

#define add_obsolete_string( name ) \
        add_obsolete_inner( name, CONFIG_ITEM_STRING )

/* Modifier macros for the config options (used for fine tuning) */

#define add_deprecated_alias( name ) \
392
    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
393 394

#define change_short( ch ) \
395
    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
396 397

#define change_string_list( list, list_text, list_update_func ) \
398
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
399 400 401
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (const char *const *)(list_text), \
402
                    (vlc_callback_t)(list_update_func));
403 404

#define change_integer_list( list, list_text, list_update_func ) \
405
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
406 407 408
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (const char *const *)(list_text), \
409
                    (vlc_callback_t)(list_update_func));
410 411

#define change_float_list( list, list_text, list_update_func ) \
412
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
413 414 415
                    (size_t)(sizeof (list) / sizeof (float)), \
                    (const float *)(list), \
                    (const char *const *)(list_text), \
416
                    (vlc_callback_t)(list_update_func));
417 418

#define change_integer_range( minv, maxv ) \
419
    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
420 421 422

#define change_float_range( minv, maxv ) \
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
423
                    (double)(minv), (double)(maxv));
424 425

#define change_action_add( pf_action, text ) \
426
    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
427
                    (vlc_callback_t)(pf_action), (const char *)(text));
428 429

#define change_internal() \
430
    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
431 432

#define change_need_restart() \
433
    vlc_config_set (p_config, VLC_CONFIG_RESTART);
434 435

#define change_autosave() \
436
    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
437 438

#define change_unsaveable() \
439
    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
440 441

#define change_safe() \
442
    vlc_config_set (p_config, VLC_CONFIG_SAFE);
443

444 445
/* Meta data plugin exports */
#define VLC_META_EXPORT( name, value ) \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
446
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
447
    __VLC_SYMBOL(vlc_entry_ ## name) (void); \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
448
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
449 450 451 452 453 454
    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
    { \
         return value; \
    }

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
455 456 457
# define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
    "\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" \
Rémi Denis-Courmont's avatar
Typo  
Rémi Denis-Courmont committed
458
    "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
459
    "\x6c\x6f\x70\x70\x65\x72\x73" )
460 461 462 463
#elif !defined (VLC_COPYRIGHT_EXPORT)
# define VLC_COPYRIGHT_EXPORT
#endif
#define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
464 465 466 467 468
    "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
    "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
    "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
    "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
    "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
469 470 471 472 473

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

474
#endif