vlc_plugin.h 18.7 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_plugin.h : Macros used from within a module.
3
 *****************************************************************************
4 5 6 7
 * Copyright (C) 2001-2006 the VideoLAN team
 * Copyright © 2007-2008 Rémi Denis-Courmont
 *
 * 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 27 28 29 30 31 32 33 34 35 36
#ifndef LIBVLC_MODULES_MACROS_H
# define LIBVLC_MODULES_MACROS_H 1

/*****************************************************************************
 * 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
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
37 38
# define MODULE_SYMBOL 0_9_0m
# define MODULE_SUFFIX "__0_9_0m"
39 40 41 42 43 44 45

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

/* Explanation:
 *
46
 * if linking a module statically, we will need:
47 48 49 50 51
 * #define MODULE_FUNC( zog ) module_foo_zog
 *
 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
 */

52
/* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
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
#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 E_( function )          CONCATENATE( function, MODULE_SYMBOL )
#   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
#else
#   define E_( function )          CONCATENATE( function, MODULE_NAME )
#   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                                 \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
88 89 90
    E_(vlc_entry) ( module_t *p_module );                                     \
                                                                              \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
91 92 93
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
    {                                                                         \
        module_config_t *p_config = NULL;                                     \
94
        const char *domain = NULL;                                            \
95 96 97 98
        if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                            (const char *)(MODULE_STRING)))                   \
            goto error;                                                       \
        {                                                                     \
99
            module_t *p_submodule = p_module;
100 101 102 103 104 105 106 107

#define vlc_module_end( )                                                     \
        }                                                                     \
        (void)p_config;                                                       \
        return VLC_SUCCESS;                                                   \
                                                                              \
    error:                                                                    \
        return VLC_EGENERIC;                                                  \
108 109
    }                                                                         \
    VLC_METADATA_EXPORTS
110 111

#define add_submodule( ) \
112
    p_submodule = vlc_submodule_create( p_module );
113 114 115 116

#define add_requirement( cap ) \
    if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
                        (int)(CPU_CAPABILITY_##cap))) \
117
        goto error;
118 119

#define add_shortcut( shortcut ) \
Rafaël Carré's avatar
Rafaël Carré committed
120 121
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
        (const char *)(shortcut))) \
122
        goto error;
123 124

#define set_shortname( shortname ) \
125 126
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
                        (const char *)(shortname))) \
127
        goto error;
128 129

#define set_description( desc ) \
130
    if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
131
                        (const char *)(desc))) \
132
        goto error;
133 134

#define set_help( help ) \
135 136
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
                        (const char *)(help))) \
137
        goto error;
138 139

#define set_capability( cap, score ) \
140 141
    if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
                        (const char *)(cap)) \
142
     || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
143
        goto error;
144 145 146 147

#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)) \
148
        goto error;
149 150 151

#define linked_with_a_crap_library_which_uses_atexit( ) \
    if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
152
        goto error;
153

154 155
#define set_text_domain( dom ) domain = (dom);

156 157 158 159 160 161 162 163 164 165 166 167
VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
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,
168 169 170
    VLC_MODULE_SHORTNAME_NODOMAIN,
    VLC_MODULE_DESCRIPTION_NODOMAIN,
    VLC_MODULE_HELP_NODOMAIN,
171 172
    VLC_MODULE_CAPABILITY,
    VLC_MODULE_SCORE,
173
    VLC_MODULE_PROGRAM, /* obsoleted */
174 175 176 177
    VLC_MODULE_CB_OPEN,
    VLC_MODULE_CB_CLOSE,
    VLC_MODULE_NO_UNLOAD,
    VLC_MODULE_NAME,
178 179 180
    VLC_MODULE_SHORTNAME,
    VLC_MODULE_DESCRIPTION,
    VLC_MODULE_HELP,
181 182 183 184 185 186 187 188 189 190
};

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) */

191
    VLC_CONFIG_DESC_NODOMAIN,
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
    /* description (args=const char *, const char *) */

    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) */

224
    VLC_CONFIG_LIST_NODOMAIN,
225 226 227
    /* possible values list
     * (args=size_t, const <type> *, const char *const *) */

228
    VLC_CONFIG_ADD_ACTION_NODOMAIN,
229 230 231 232 233 234 235
    /* add value change callback (args=vlc_callback_t, const char *) */

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

    VLC_CONFIG_SAFE,
    /* tag as modifiable by untrusted input item "sources" (args=none) */
236 237 238 239 240 241 242 243 244 245 246

    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 *) */
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
};

/*****************************************************************************
 * 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 ) \
263
    p_config = vlc_config_create (p_module, type);
264 265

#define add_typedesc_inner( type, text, longtext ) \
266
    add_type_inner( type ) \
267
    vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
268
                    (const char *)(text), (const char *)(longtext));
269 270

#define add_typeadv_inner( type, text, longtext, advc ) \
271 272
    add_typedesc_inner( type, text, longtext ) \
    if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
273 274

#define add_typename_inner( type, name, text, longtext, advc, cb ) \
275
    add_typeadv_inner( type, text, longtext, advc ) \
276
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
277
                    (const char *)(name), (vlc_callback_t)(cb));
278 279

#define add_string_inner( type, name, text, longtext, advc, cb, v ) \
280 281
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
282 283

#define add_int_inner( type, name, text, longtext, advc, cb, v ) \
284 285
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
286 287 288


#define set_category( i_id ) \
289 290
    add_type_inner( CONFIG_CATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
291 292

#define set_subcategory( i_id ) \
293 294
    add_type_inner( CONFIG_SUBCATEGORY ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

#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 ) \
312 313
    add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
                      p_callback, value )
314 315

#define add_password( name, value, p_callback, text, longtext, advc ) \
316 317
    add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
                      p_callback, value )
318 319

#define add_file( name, value, p_callback, text, longtext, advc ) \
320 321
    add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
                      p_callback, value )
322 323

#define add_directory( name, value, p_callback, text, longtext, advc ) \
324 325
    add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
                      p_callback, value )
326 327

#define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
328 329 330
    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));
331 332

#define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
333 334 335
    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));
336 337 338

#ifndef __PLUGIN__
#define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
339 340 341
    add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
                      p_callback, value ) \
    p_config->min.i = i_subcategory /* gruik */;
342 343

#define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
344 345 346
    add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
                      advc, p_callback, value ) \
    p_config->min.i = i_subcategory /* gruik */;
347 348 349
#endif

#define add_integer( name, value, p_callback, text, longtext, advc ) \
350 351
    add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
                   p_callback, value )
352 353

#define add_key( name, value, p_callback, text, longtext, advc ) \
354 355
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
                   value )
356 357

#define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
358
    add_integer( name, value, p_callback, text, longtext, advc ) \
359 360 361
    change_integer_range( i_min, i_max )

#define add_float( name, v, p_callback, text, longtext, advc ) \
362 363
    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
364 365

#define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
366
    add_float( name, value, p_callback, text, longtext, advc ) \
367 368 369
    change_float_range( f_min, f_max )

#define add_bool( name, v, p_callback, text, longtext, advc ) \
370 371 372
    add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
                        p_callback ) \
    if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
373 374 375

/* For removed option */
#define add_obsolete_inner( name, type ) \
376
    add_type_inner( type ) \
377 378
    vlc_config_set (p_config, VLC_CONFIG_NAME, \
                    (const char *)(name), (vlc_callback_t)NULL); \
379
    vlc_config_set (p_config, VLC_CONFIG_REMOVED);
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

#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 ) \
    vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))

#define change_short( ch ) \
399
    vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
400 401

#define change_string_list( list, list_text, list_update_func ) \
402
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
403 404 405
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (const char *const *)(list_text), \
406
                    list_update_func);
407 408

#define change_integer_list( list, list_text, list_update_func ) \
409
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
410 411 412
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (const char *const *)(list_text), \
413
                    list_update_func);
414 415

#define change_float_list( list, list_text, list_update_func ) \
416
    vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
417 418 419
                    (size_t)(sizeof (list) / sizeof (float)), \
                    (const float *)(list), \
                    (const char *const *)(list_text), \
420
                    list_update_func);
421 422

#define change_integer_range( minv, maxv ) \
423
    vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
424 425 426

#define change_float_range( minv, maxv ) \
    vlc_config_set (p_config, VLC_CONFIG_RANGE, \
427
                    (double)(minv), (double)(maxv));
428 429

#define change_action_add( pf_action, text ) \
430
    vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
431
                    (vlc_callback_t)(pf_action), (const char *)(text));
432 433

#define change_internal() \
434
    vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
435 436

#define change_need_restart() \
437
    vlc_config_set (p_config, VLC_CONFIG_RESTART);
438 439

#define change_autosave() \
440
    vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
441 442

#define change_unsaveable() \
443
    vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
444

445
#define change_unsafe() (void)0; /* no-op */
446

447
#define change_safe() \
448
    vlc_config_set (p_config, VLC_CONFIG_SAFE);
449

450 451
/* Meta data plugin exports */
#define VLC_META_EXPORT( name, value ) \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
452 453
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
    E_(vlc_entry_ ## name) (void); \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
454
    EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
455 456 457 458 459 460
    __VLC_SYMBOL(vlc_entry_ ## name) (void) \
    { \
         return value; \
    }

#if defined (__LIBVLC__)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
461 462 463
# 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
464
    "\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
465
    "\x6c\x6f\x70\x70\x65\x72\x73" )
466 467 468 469
#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
470 471 472 473 474
    "\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" )
475 476 477 478 479

#define VLC_METADATA_EXPORTS \
    VLC_COPYRIGHT_EXPORT \
    VLC_LICENSE_EXPORT

480
#endif