add_loadfile: remove callback parameter
[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  * If we are not within a module, assume we're in the vlc core.
115  *****************************************************************************/
116 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
117 #   define MODULE_NAME main
118 #endif
119
120 /**
121  * Current plugin ABI version
122  */
123 # define MODULE_SYMBOL 1_2_0f
124 # define MODULE_SUFFIX "__1_2_0f"
125
126 /*****************************************************************************
127  * Add a few defines. You do not want to read this section. Really.
128  *****************************************************************************/
129
130 /* Explanation:
131  *
132  * if linking a module statically, we will need:
133  * #define MODULE_FUNC( zog ) module_foo_zog
134  *
135  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
136  */
137
138 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
139 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
140 #define CRUDE_HACK( y, z )  y##__##z
141
142 /* If the module is built-in, then we need to define foo_InitModule instead
143  * of InitModule. Same for Activate- and DeactivateModule. */
144 #ifdef __PLUGIN__
145 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
146 #else
147 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
148 #endif
149
150 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
151 #   define DLL_SYMBOL              __declspec(dllexport)
152 #   define CDECL_SYMBOL            __cdecl
153 #else
154 #   define DLL_SYMBOL
155 #   define CDECL_SYMBOL
156 #endif
157
158 #if defined( __cplusplus )
159 #   define EXTERN_SYMBOL           extern "C"
160 #else
161 #   define EXTERN_SYMBOL
162 #endif
163
164 /*
165  * InitModule: this function is called once and only once, when the module
166  * is looked at for the first time. We get the useful data from it, for
167  * instance the module name, its shortcuts, its capabilities... we also create
168  * a copy of its config because the module can be unloaded at any time.
169  */
170 #define vlc_module_begin( )                                                   \
171     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
172     __VLC_SYMBOL(vlc_entry) ( module_t *p_module );                           \
173                                                                               \
174     EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL                                 \
175     __VLC_SYMBOL(vlc_entry) ( module_t *p_module )                            \
176     {                                                                         \
177         module_config_t *p_config = 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_shortcut( ... ) \
199 { \
200     const char *shortcuts[] = { __VA_ARGS__ }; \
201     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
202                         sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
203         goto error; \
204 }
205
206 #define set_shortname( shortname ) \
207     if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
208                         (const char *)(shortname))) \
209         goto error;
210
211 #define set_description( desc ) \
212     if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
213                         (const char *)(desc))) \
214         goto error;
215
216 #define set_help( help ) \
217     if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
218                         (const char *)(help))) \
219         goto error;
220
221 #define set_capability( cap, score ) \
222     if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
223                         (const char *)(cap)) \
224      || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
225         goto error;
226
227 #define set_callbacks( activate, deactivate ) \
228     if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
229      || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
230         goto error;
231
232 #define cannot_unload_broken_library( ) \
233     if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
234         goto error;
235
236 #define set_text_domain( dom ) \
237     if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
238         goto error;
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, \
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 ) \
266     add_typeadv_inner( type, text, longtext, advc ) \
267     vlc_config_set (p_config, VLC_CONFIG_NAME, \
268                     (const char *)(name));
269
270 #define add_string_inner( type, name, text, longtext, advc, v ) \
271     add_typename_inner( type, name, text, longtext, advc ) \
272     vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
273
274 #define add_int_inner( type, name, text, longtext, advc, v ) \
275     add_typename_inner( type, name, text, longtext, advc ) \
276     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
277
278
279 #define set_category( i_id ) \
280     add_type_inner( CONFIG_CATEGORY ) \
281     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
282
283 #define set_subcategory( i_id ) \
284     add_type_inner( CONFIG_SUBCATEGORY ) \
285     vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(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, text, longtext, advc ) \
303     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
304                       value )
305
306 #define add_password( name, value, text, longtext, advc ) \
307     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
308                       value )
309
310 #define add_loadfile( name, value, text, longtext, advc ) \
311     add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
312                       value )
313
314 #define add_savefile( name, value, text, longtext, advc ) \
315     add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
316                       value )
317
318 #define add_directory( name, value, p_callback, text, longtext, advc ) \
319     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
320                       value )
321
322 #define add_font( name, value, text, longtext, advc )\
323     add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
324                       value )
325
326 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
327     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
328                       value ) \
329     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
330
331 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
332     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
333                       value ) \
334     vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
335
336 #ifndef __PLUGIN__
337 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
338     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
339                       value ) \
340     change_integer_range (i_subcategory /* gruik */, 0);
341
342 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
343     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
344                       advc, value ) \
345     change_integer_range (i_subcategory /* gruik */, 0);
346 #endif
347
348 #define add_integer( name, value, p_callback, text, longtext, advc ) \
349     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
350
351 #define add_key( name, value, p_callback, text, longtext, advc ) \
352     add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value ) \
353     add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
354                    KEY_UNSET )
355
356 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
357     add_integer( name, value, p_callback, text, longtext, advc ) \
358     change_integer_range( i_min, i_max )
359
360 #define add_float( name, v, p_callback, text, longtext, advc ) \
361     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
362     vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
363
364 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
365     add_float( name, value, p_callback, text, longtext, advc ) \
366     change_float_range( f_min, f_max )
367
368 #define add_bool( name, v, p_callback, text, longtext, advc ) \
369     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
370     if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true);
371
372 /* For removed option */
373 #define add_obsolete_inner( name, type ) \
374     add_type_inner( type ) \
375     vlc_config_set (p_config, VLC_CONFIG_NAME, \
376                     (const char *)(name)); \
377     vlc_config_set (p_config, VLC_CONFIG_REMOVED);
378
379 #define add_obsolete_bool( name ) \
380         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
381
382 #define add_obsolete_integer( name ) \
383         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
384
385 #define add_obsolete_float( name ) \
386         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
387
388 #define add_obsolete_string( name ) \
389         add_obsolete_inner( name, CONFIG_ITEM_STRING )
390
391 /* Modifier macros for the config options (used for fine tuning) */
392
393 #define add_deprecated_alias( name ) \
394     vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
395
396 #define change_short( ch ) \
397     vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
398
399 #define change_string_list( list, list_text, list_update_func ) \
400     vlc_config_set (p_config, VLC_CONFIG_LIST, \
401                     (size_t)(sizeof (list) / sizeof (char *)), \
402                     (const char *const *)(list), \
403                     (const char *const *)(list_text), \
404                     (vlc_callback_t)(list_update_func));
405
406 #define change_integer_list( list, list_text ) \
407     vlc_config_set (p_config, VLC_CONFIG_LIST, \
408                     (size_t)(sizeof (list) / sizeof (int)), \
409                     (const int *)(list), \
410                     (const char *const *)(list_text), \
411                     (vlc_callback_t)(NULL));
412
413 #define change_integer_range( minv, maxv ) \
414     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
415                     (int64_t)(minv), (int64_t)(maxv));
416
417 #define change_float_range( minv, maxv ) \
418     vlc_config_set (p_config, VLC_CONFIG_RANGE, \
419                     (double)(minv), (double)(maxv));
420
421 #define change_action_add( pf_action, text ) \
422     vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
423                     (vlc_callback_t)(pf_action), (const char *)(text));
424
425 #define change_need_restart() \
426     vlc_config_set (p_config, VLC_CONFIG_RESTART);
427
428 #define change_autosave() \
429     vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
430
431 /* For options that are saved but hidden from the preferences panel */
432 #define change_private() \
433     vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
434
435 /* For options that cannot be saved in the configuration */
436 #define change_volatile() \
437     change_private() \
438     vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
439
440 #define change_safe() \
441     vlc_config_set (p_config, VLC_CONFIG_SAFE);
442
443 /* Meta data plugin exports */
444 #define VLC_META_EXPORT( name, value ) \
445     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
446     __VLC_SYMBOL(vlc_entry_ ## name) (void); \
447     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
448     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
449     { \
450          return value; \
451     }
452
453 #if defined (__LIBVLC__)
454 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
455     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
456     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
457     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
458     "\x6c\x6f\x70\x65\x72\x73" )
459 #elif !defined (VLC_COPYRIGHT_EXPORT)
460 # define VLC_COPYRIGHT_EXPORT
461 #endif
462 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
463     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
464     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
465     "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
466     "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
467     "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
468
469 #define VLC_METADATA_EXPORTS \
470     VLC_COPYRIGHT_EXPORT \
471     VLC_LICENSE_EXPORT
472
473 #endif