vlc_plugin.h 17.3 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 37 38 39 40 41 42 43 44 45
#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
 */
# define MODULE_SYMBOL 0_9_0k
# define MODULE_SUFFIX "__0_9_0k"

/*****************************************************************************
 * 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 88 89 90 91 92 93 94 95
#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.
 */
#if defined (__PLUGIN__) || defined (__BUILTIN__)
EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
E_(vlc_entry) ( module_t *p_module );
#endif

#define vlc_module_begin( )                                                   \
    EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
    __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
    {                                                                         \
        module_config_t *p_config = NULL;                                     \
96
        const char *domain = NULL;                                            \
97 98 99 100
        if (vlc_module_set (p_module, VLC_MODULE_NAME,                        \
                            (const char *)(MODULE_STRING)))                   \
            goto error;                                                       \
        {                                                                     \
101
            module_t *p_submodule = p_module;
102 103 104 105 106 107 108 109

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

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

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

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

#define set_shortname( shortname ) \
126 127
    if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
                        (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 137
    if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
                        (const char *)(help))) \
138
        goto error;
139 140

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

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

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

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

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

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

192
    VLC_CONFIG_DESC_NODOMAIN,
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 224
    /* 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) */

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

229
    VLC_CONFIG_ADD_ACTION_NODOMAIN,
230 231 232 233 234 235 236
    /* 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) */
237 238 239 240 241 242 243 244 245 246 247

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

/*****************************************************************************
 * 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 ) \
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 273
    add_typedesc_inner( type, text, longtext ) \
    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 282
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    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 286
    add_typename_inner( type, name, text, longtext, advc, cb ) \
    vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
287 288 289


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

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

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

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

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

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

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

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

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

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

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

#define add_key( name, value, p_callback, text, longtext, advc ) \
355 356
    add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
                   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 361 362
    change_integer_range( i_min, i_max )

#define add_float( name, v, p_callback, text, longtext, advc ) \
363 364
    add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
    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 369 370
    change_float_range( f_min, f_max )

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

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

#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 ) \
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 405 406
                    (size_t)(sizeof (list) / sizeof (char *)), \
                    (const char *const *)(list), \
                    (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 412 413
                    (size_t)(sizeof (list) / sizeof (int)), \
                    (const int *)(list), \
                    (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 419 420
                    (size_t)(sizeof (list) / sizeof (float)), \
                    (const float *)(list), \
                    (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 427

#define change_float_range( minv, maxv ) \
    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