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