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
7 * Authors: Samuel Hocevar <sam@zoy.org>
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.
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.
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 *****************************************************************************/
24 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
27 /*****************************************************************************
28 * If we are not within a module, assume we're in the vlc core.
29 *****************************************************************************/
30 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
31 # define MODULE_NAME main
35 * Current plugin ABI version
37 # define MODULE_SYMBOL 0_9_0k
38 # define MODULE_SUFFIX "__0_9_0k"
40 /*****************************************************************************
41 * Add a few defines. You do not want to read this section. Really.
42 *****************************************************************************/
46 * if linking a module statically, we will need:
47 * #define MODULE_FUNC( zog ) module_foo_zog
49 * 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 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
54 #define CRUDE_HACK( y, z ) y##__##z
56 /* If the module is built-in, then we need to define foo_InitModule instead
57 * of InitModule. Same for Activate- and DeactivateModule. */
59 # define E_( function ) CONCATENATE( function, MODULE_SYMBOL )
60 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
62 # define E_( function ) CONCATENATE( function, MODULE_NAME )
63 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
66 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
67 # define DLL_SYMBOL __declspec(dllexport)
68 # define CDECL_SYMBOL __cdecl
74 #if defined( __cplusplus )
75 # define EXTERN_SYMBOL extern "C"
77 # define EXTERN_SYMBOL
81 * InitModule: this function is called once and only once, when the module
82 * is looked at for the first time. We get the useful data from it, for
83 * instance the module name, its shortcuts, its capabilities... we also create
84 * a copy of its config because the module can be unloaded at any time.
86 #if defined (__PLUGIN__) || defined (__BUILTIN__)
87 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
88 E_(vlc_entry) ( module_t *p_module );
91 #define vlc_module_begin( ) \
92 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
93 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
95 module_config_t *p_config = NULL; \
96 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
97 (const char *)(MODULE_STRING))) \
100 module_t *p_submodule = p_module;
102 #define vlc_module_end( ) \
105 return VLC_SUCCESS; \
108 return VLC_EGENERIC; \
111 #define add_submodule( ) \
112 p_submodule = vlc_submodule_create( p_module );
114 #define add_requirement( cap ) \
115 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
116 (int)(CPU_CAPABILITY_##cap))) \
119 #define add_shortcut( shortcut ) \
120 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
121 (const char *)(shortcut))) \
124 #define set_shortname( shortname ) \
125 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
126 (const char *)(shortname))) \
129 #define set_description( desc ) \
130 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
131 (const char *)(desc))) \
134 #define set_help( help ) \
135 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
138 #define set_capability( cap, score ) \
139 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
140 (const char *)(cap)) \
141 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
144 #define set_callbacks( activate, deactivate ) \
145 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
146 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
149 #define linked_with_a_crap_library_which_uses_atexit( ) \
150 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
153 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
154 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
155 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
156 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
157 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
159 enum vlc_module_properties
161 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
162 * Append new items at the end ONLY. */
163 VLC_MODULE_CPU_REQUIREMENT,
165 VLC_MODULE_SHORTNAME,
166 VLC_MODULE_DESCRIPTION,
168 VLC_MODULE_CAPABILITY,
173 VLC_MODULE_NO_UNLOAD,
177 enum vlc_config_properties
179 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
180 * Append new items at the end ONLY. */
183 /* command line name (args=const char *, vlc_callback_t) */
186 /* description (args=const char *, const char *) */
189 /* actual value (args=int/double/const char *) */
192 /* minimum value (args=int/double/const char * twice) */
195 /* enable advanced flag (args=none) */
198 /* don't write variable to storage (args=none) */
200 VLC_CONFIG_PERSISTENT,
201 /* always write variable to storage (args=none) */
204 /* restart required to apply value change (args=none) */
207 /* hide from user (args=none) */
210 /* tag as no longer supported (args=none) */
212 VLC_CONFIG_CAPABILITY,
213 /* capability for a module or list thereof (args=const char*) */
216 /* one-character (short) command line option name (args=char) */
219 /* possible values list
220 * (args=size_t, const <type> *, const char *const *) */
222 VLC_CONFIG_ADD_ACTION,
223 /* add value change callback (args=vlc_callback_t, const char *) */
226 /* former option name (args=const char *) */
229 /* tag as modifiable by untrusted input item "sources" (args=none) */
232 /*****************************************************************************
233 * Macros used to build the configuration structure.
235 * Note that internally we support only 3 types of config data: int, float
237 * The other types declared here just map to one of these 3 basic types but
238 * have the advantage of also providing very good hints to a configuration
239 * interface so as to make it more user friendly.
240 * The configuration structure also includes category hints. These hints can
241 * provide a configuration interface with some very useful data and again
242 * allow for a more user friendly interface.
243 *****************************************************************************/
245 #define add_type_inner( type ) \
246 p_config = vlc_config_create (p_module, type);
248 #define add_typedesc_inner( type, text, longtext ) \
249 add_type_inner( type ) \
250 vlc_config_set (p_config, VLC_CONFIG_DESC, \
251 (const char *)(text), (const char *)(longtext));
253 #define add_typeadv_inner( type, text, longtext, advc ) \
254 add_typedesc_inner( type, text, longtext ) \
255 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
257 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
258 add_typeadv_inner( type, text, longtext, advc ) \
259 vlc_config_set (p_config, VLC_CONFIG_NAME, \
260 (const char *)(name), (vlc_callback_t)(cb));
262 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
263 add_typename_inner( type, name, text, longtext, advc, cb ) \
264 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
266 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
267 add_typename_inner( type, name, text, longtext, advc, cb ) \
268 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
271 #define set_category( i_id ) \
272 add_type_inner( CONFIG_CATEGORY ) \
273 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
275 #define set_subcategory( i_id ) \
276 add_type_inner( CONFIG_SUBCATEGORY ) \
277 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
279 #define set_section( text, longtext ) \
280 add_typedesc_inner( CONFIG_SECTION, text, longtext )
282 #define add_category_hint( text, longtext, advc ) \
283 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
285 #define add_subcategory_hint( text, longtext ) \
286 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
288 #define end_subcategory_hint \
289 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
291 #define add_usage_hint( text ) \
292 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
294 #define add_string( name, value, p_callback, text, longtext, advc ) \
295 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
298 #define add_password( name, value, p_callback, text, longtext, advc ) \
299 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
302 #define add_file( name, value, p_callback, text, longtext, advc ) \
303 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
306 #define add_directory( name, value, p_callback, text, longtext, advc ) \
307 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
310 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
311 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
312 p_callback, value ) \
313 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
315 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
316 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
317 p_callback, value ) \
318 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
321 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
322 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
323 p_callback, value ) \
324 p_config->min.i = i_subcategory /* gruik */;
326 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
327 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
328 advc, p_callback, value ) \
329 p_config->min.i = i_subcategory /* gruik */;
332 #define add_integer( name, value, p_callback, text, longtext, advc ) \
333 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
336 #define add_key( name, value, p_callback, text, longtext, advc ) \
337 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
340 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
341 add_integer( name, value, p_callback, text, longtext, advc ) \
342 change_integer_range( i_min, i_max )
344 #define add_float( name, v, p_callback, text, longtext, advc ) \
345 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
346 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
348 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
349 add_float( name, value, p_callback, text, longtext, advc ) \
350 change_float_range( f_min, f_max )
352 #define add_bool( name, v, p_callback, text, longtext, advc ) \
353 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
355 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
357 /* For removed option */
358 #define add_obsolete_inner( name, type ) \
359 add_type_inner( type ) \
360 vlc_config_set (p_config, VLC_CONFIG_NAME, \
361 (const char *)(name), (vlc_callback_t)NULL); \
362 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
364 #define add_obsolete_bool( name ) \
365 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
367 #define add_obsolete_integer( name ) \
368 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
370 #define add_obsolete_float( name ) \
371 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
373 #define add_obsolete_string( name ) \
374 add_obsolete_inner( name, CONFIG_ITEM_STRING )
376 /* Modifier macros for the config options (used for fine tuning) */
378 #define add_deprecated_alias( name ) \
379 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
381 #define change_short( ch ) \
382 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
384 #define change_string_list( list, list_text, list_update_func ) \
385 vlc_config_set (p_config, VLC_CONFIG_LIST, \
386 (size_t)(sizeof (list) / sizeof (char *)), \
387 (const char *const *)(list), \
388 (const char *const *)(list_text), \
391 #define change_integer_list( list, list_text, list_update_func ) \
392 vlc_config_set (p_config, VLC_CONFIG_LIST, \
393 (size_t)(sizeof (list) / sizeof (int)), \
394 (const int *)(list), \
395 (const char *const *)(list_text), \
398 #define change_float_list( list, list_text, list_update_func ) \
399 vlc_config_set (p_config, VLC_CONFIG_LIST, \
400 (size_t)(sizeof (list) / sizeof (float)), \
401 (const float *)(list), \
402 (const char *const *)(list_text), \
405 #define change_integer_range( minv, maxv ) \
406 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
408 #define change_float_range( minv, maxv ) \
409 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
410 (double)(minv), (double)(maxv));
412 #define change_action_add( pf_action, text ) \
413 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
414 (vlc_callback_t)(pf_action), (const char *)(text));
416 #define change_internal() \
417 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
419 #define change_need_restart() \
420 vlc_config_set (p_config, VLC_CONFIG_RESTART);
422 #define change_autosave() \
423 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
425 #define change_unsaveable() \
426 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
428 #define change_unsafe() (void)0; /* no-op */
430 #define change_safe() \
431 vlc_config_set (p_config, VLC_CONFIG_SAFE);