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