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 HAVE_DYNAMIC_PLUGINS is NOT set, 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
69 #elif defined (HAVE_ATTRIBUTE_VISIBILITY)
70 # define DLL_SYMBOL __attribute__((visibility("default")))
77 #if defined( __cplusplus )
78 # define EXTERN_SYMBOL extern "C"
80 # define EXTERN_SYMBOL
84 * InitModule: this function is called once and only once, when the module
85 * is looked at for the first time. We get the useful data from it, for
86 * instance the module name, its shortcuts, its capabilities... we also create
87 * a copy of its config because the module can be unloaded at any time.
89 #if defined (__PLUGIN__) || defined (__BUILTIN__)
90 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL
91 E_(vlc_entry) ( module_t *p_module );
94 #define vlc_module_begin( ) \
95 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
96 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
98 module_config_t *p_config = NULL; \
99 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
100 (const char *)(MODULE_STRING))) \
103 module_t *p_submodule = p_module /* the ; gets added */
105 #define vlc_module_end( ) \
108 return VLC_SUCCESS; \
111 return VLC_EGENERIC; \
113 struct _u_n_u_s_e_d_ /* the ; gets added */
116 #define add_submodule( ) \
117 p_submodule = vlc_submodule_create( p_module )
119 #define add_requirement( cap ) \
120 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
121 (int)(CPU_CAPABILITY_##cap))) \
124 #define add_shortcut( shortcut ) \
125 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, (int)(shortcut))) \
128 #define set_shortname( shortname ) \
129 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
130 (const char *)(shortname))) \
133 #define set_description( desc ) \
134 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
135 (const char *)(desc))) \
138 #define set_help( help ) \
139 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, (const char *)(help))) \
142 #define set_capability( cap, score ) \
143 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
144 (const char *)(cap)) \
145 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
148 #define set_callbacks( activate, deactivate ) \
149 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
150 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
153 #define linked_with_a_crap_library_which_uses_atexit( ) \
154 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
157 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
158 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
159 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
160 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
161 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
163 enum vlc_module_properties
165 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
166 * Append new items at the end ONLY. */
167 VLC_MODULE_CPU_REQUIREMENT,
169 VLC_MODULE_SHORTNAME,
170 VLC_MODULE_DESCRIPTION,
172 VLC_MODULE_CAPABILITY,
177 VLC_MODULE_NO_UNLOAD,
181 enum vlc_config_properties
183 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
184 * Append new items at the end ONLY. */
187 /* command line name (args=const char *, vlc_callback_t) */
190 /* description (args=const char *, const char *) */
193 /* actual value (args=int/double/const char *) */
196 /* minimum value (args=int/double/const char * twice) */
199 /* enable advanced flag (args=none) */
202 /* don't write variable to storage (args=none) */
204 VLC_CONFIG_PERSISTENT,
205 /* always write variable to storage (args=none) */
208 /* restart required to apply value change (args=none) */
211 /* hide from user (args=none) */
214 /* tag as no longer supported (args=none) */
216 VLC_CONFIG_CAPABILITY,
217 /* capability for a module or list thereof (args=const char*) */
220 /* one-character (short) command line option name (args=char) */
223 /* possible values list
224 * (args=size_t, const <type> *, const char *const *) */
226 VLC_CONFIG_ADD_ACTION,
227 /* add value change callback (args=vlc_callback_t, const char *) */
230 /* former option name (args=const char *) */
233 /* tag as modifiable by untrusted input item "sources" (args=none) */
236 /*****************************************************************************
237 * Macros used to build the configuration structure.
239 * Note that internally we support only 3 types of config data: int, float
241 * The other types declared here just map to one of these 3 basic types but
242 * have the advantage of also providing very good hints to a configuration
243 * interface so as to make it more user friendly.
244 * The configuration structure also includes category hints. These hints can
245 * provide a configuration interface with some very useful data and again
246 * allow for a more user friendly interface.
247 *****************************************************************************/
249 #define add_type_inner( type ) \
250 p_config = vlc_config_create (p_module, type)
252 #define add_typedesc_inner( type, text, longtext ) \
253 add_type_inner( type ); \
254 vlc_config_set (p_config, VLC_CONFIG_DESC, \
255 (const char *)(text), (const char *)(longtext))
257 #define add_typeadv_inner( type, text, longtext, advc ) \
258 add_typedesc_inner( type, text, longtext ); \
259 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED)
261 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
262 add_typeadv_inner( type, text, longtext, advc ); \
263 vlc_config_set (p_config, VLC_CONFIG_NAME, \
264 (const char *)(name), (vlc_callback_t)(cb))
266 #define add_string_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, (const char *)(v))
270 #define add_int_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, (int)(v))
275 #define set_category( i_id ) \
276 add_type_inner( CONFIG_CATEGORY ); \
277 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
279 #define set_subcategory( i_id ) \
280 add_type_inner( CONFIG_SUBCATEGORY ); \
281 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id))
283 #define set_section( text, longtext ) \
284 add_typedesc_inner( CONFIG_SECTION, text, longtext )
286 #define add_category_hint( text, longtext, advc ) \
287 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
289 #define add_subcategory_hint( text, longtext ) \
290 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
292 #define end_subcategory_hint \
293 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
295 #define add_usage_hint( text ) \
296 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
298 #define add_string( name, value, p_callback, text, longtext, advc ) \
299 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, p_callback, value )
301 #define add_password( name, value, p_callback, text, longtext, advc ) \
302 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, p_callback, value )
304 #define add_file( name, value, p_callback, text, longtext, advc ) \
305 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, p_callback, value )
307 #define add_directory( name, value, p_callback, text, longtext, advc ) \
308 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, p_callback, value )
310 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
311 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, p_callback, value ); \
312 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
314 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
315 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, p_callback, value ); \
316 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps))
319 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
320 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, p_callback, value ); \
321 p_config->min.i = i_subcategory /* gruik */
323 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
324 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, advc, p_callback, value ); \
325 p_config->min.i = i_subcategory /* gruik */
328 #define add_integer( name, value, p_callback, text, longtext, advc ) \
329 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, p_callback, value )
331 #define add_key( name, value, p_callback, text, longtext, advc ) \
332 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, value )
334 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
335 add_integer( name, value, p_callback, text, longtext, advc ); \
336 change_integer_range( i_min, i_max )
338 #define add_float( name, v, p_callback, text, longtext, advc ) \
339 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ); \
340 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v))
342 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
343 add_float( name, value, p_callback, text, longtext, advc ); \
344 change_float_range( f_min, f_max )
346 #define add_bool( name, v, p_callback, text, longtext, advc ) \
347 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, p_callback ); \
348 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true)
350 /* For removed option */
351 #define add_obsolete_inner( name, type ) \
352 add_type_inner( type ); \
353 vlc_config_set (p_config, VLC_CONFIG_NAME, \
354 (const char *)(name), (vlc_callback_t)NULL); \
355 vlc_config_set (p_config, VLC_CONFIG_REMOVED)
357 #define add_obsolete_bool( name ) \
358 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
360 #define add_obsolete_integer( name ) \
361 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
363 #define add_obsolete_float( name ) \
364 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
366 #define add_obsolete_string( name ) \
367 add_obsolete_inner( name, CONFIG_ITEM_STRING )
369 /* Modifier macros for the config options (used for fine tuning) */
371 #define add_deprecated_alias( name ) \
372 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
374 #define change_short( ch ) \
375 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch))
377 #define change_string_list( list, list_text, list_update_func ) \
378 vlc_config_set (p_config, VLC_CONFIG_LIST, \
379 (size_t)(sizeof (list) / sizeof (char *)), \
380 (const char *const *)(list), \
381 (const char *const *)(list_text), \
384 #define change_integer_list( list, list_text, list_update_func ) \
385 vlc_config_set (p_config, VLC_CONFIG_LIST, \
386 (size_t)(sizeof (list) / sizeof (int)), \
387 (const int *)(list), \
388 (const char *const *)(list_text), \
391 #define change_float_list( list, list_text, list_update_func ) \
392 vlc_config_set (p_config, VLC_CONFIG_LIST, \
393 (size_t)(sizeof (list) / sizeof (float)), \
394 (const float *)(list), \
395 (const char *const *)(list_text), \
398 #define change_integer_range( minv, maxv ) \
399 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv))
401 #define change_float_range( minv, maxv ) \
402 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
403 (double)(minv), (double)(maxv))
405 #define change_action_add( pf_action, text ) \
406 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
407 (vlc_callback_t)(pf_action), (const char *)(text))
409 #define change_internal() \
410 vlc_config_set (p_config, VLC_CONFIG_PRIVATE)
412 #define change_need_restart() \
413 vlc_config_set (p_config, VLC_CONFIG_RESTART)
415 #define change_autosave() \
416 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT)
418 #define change_unsaveable() \
419 vlc_config_set (p_config, VLC_CONFIG_VOLATILE)
421 #define change_unsafe() (void)0 /* no-op */
423 #define change_safe() \
424 vlc_config_set (p_config, VLC_CONFIG_SAFE)