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