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_0m
38 # define MODULE_SUFFIX "__0_9_0m"
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 #define vlc_module_begin( ) \
87 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
88 E_(vlc_entry) ( module_t *p_module ); \
90 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
91 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
93 module_config_t *p_config = NULL; \
94 const char *domain = NULL; \
95 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
96 (const char *)(MODULE_STRING))) \
99 module_t *p_submodule = p_module;
101 #define vlc_module_end( ) \
104 return VLC_SUCCESS; \
107 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, domain, \
126 (const char *)(shortname))) \
129 #define set_description( desc ) \
130 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
131 (const char *)(desc))) \
134 #define set_help( help ) \
135 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
136 (const char *)(help))) \
139 #define set_capability( cap, score ) \
140 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
141 (const char *)(cap)) \
142 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
145 #define set_callbacks( activate, deactivate ) \
146 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
147 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
150 #define linked_with_a_crap_library_which_uses_atexit( ) \
151 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
154 #define set_text_domain( dom ) domain = (dom);
156 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
157 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
158 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
159 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
160 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
162 enum vlc_module_properties
164 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
165 * Append new items at the end ONLY. */
166 VLC_MODULE_CPU_REQUIREMENT,
168 VLC_MODULE_SHORTNAME_NODOMAIN,
169 VLC_MODULE_DESCRIPTION_NODOMAIN,
170 VLC_MODULE_HELP_NODOMAIN,
171 VLC_MODULE_CAPABILITY,
173 VLC_MODULE_PROGRAM, /* obsoleted */
176 VLC_MODULE_NO_UNLOAD,
178 VLC_MODULE_SHORTNAME,
179 VLC_MODULE_DESCRIPTION,
183 enum vlc_config_properties
185 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
186 * Append new items at the end ONLY. */
189 /* command line name (args=const char *, vlc_callback_t) */
191 VLC_CONFIG_DESC_NODOMAIN,
192 /* description (args=const char *, const char *) */
195 /* actual value (args=int/double/const char *) */
198 /* minimum value (args=int/double/const char * twice) */
201 /* enable advanced flag (args=none) */
204 /* don't write variable to storage (args=none) */
206 VLC_CONFIG_PERSISTENT,
207 /* always write variable to storage (args=none) */
210 /* restart required to apply value change (args=none) */
213 /* hide from user (args=none) */
216 /* tag as no longer supported (args=none) */
218 VLC_CONFIG_CAPABILITY,
219 /* capability for a module or list thereof (args=const char*) */
222 /* one-character (short) command line option name (args=char) */
224 VLC_CONFIG_LIST_NODOMAIN,
225 /* possible values list
226 * (args=size_t, const <type> *, const char *const *) */
228 VLC_CONFIG_ADD_ACTION_NODOMAIN,
229 /* add value change callback (args=vlc_callback_t, const char *) */
232 /* former option name (args=const char *) */
235 /* tag as modifiable by untrusted input item "sources" (args=none) */
238 /* description (args=const char *, const char *, const char *) */
241 /* possible values list
242 * (args=const char *, size_t, const <type> *, const char *const *) */
244 VLC_CONFIG_ADD_ACTION,
245 /* add value change callback
246 * (args=const char *, vlc_callback_t, const char *) */
249 /*****************************************************************************
250 * Macros used to build the configuration structure.
252 * Note that internally we support only 3 types of config data: int, float
254 * The other types declared here just map to one of these 3 basic types but
255 * have the advantage of also providing very good hints to a configuration
256 * interface so as to make it more user friendly.
257 * The configuration structure also includes category hints. These hints can
258 * provide a configuration interface with some very useful data and again
259 * allow for a more user friendly interface.
260 *****************************************************************************/
262 #define add_type_inner( type ) \
263 p_config = vlc_config_create (p_module, type);
265 #define add_typedesc_inner( type, text, longtext ) \
266 add_type_inner( type ) \
267 vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
268 (const char *)(text), (const char *)(longtext));
270 #define add_typeadv_inner( type, text, longtext, advc ) \
271 add_typedesc_inner( type, text, longtext ) \
272 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
274 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
275 add_typeadv_inner( type, text, longtext, advc ) \
276 vlc_config_set (p_config, VLC_CONFIG_NAME, \
277 (const char *)(name), (vlc_callback_t)(cb));
279 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
280 add_typename_inner( type, name, text, longtext, advc, cb ) \
281 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
283 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
284 add_typename_inner( type, name, text, longtext, advc, cb ) \
285 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
288 #define set_category( i_id ) \
289 add_type_inner( CONFIG_CATEGORY ) \
290 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
292 #define set_subcategory( i_id ) \
293 add_type_inner( CONFIG_SUBCATEGORY ) \
294 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
296 #define set_section( text, longtext ) \
297 add_typedesc_inner( CONFIG_SECTION, text, longtext )
299 #define add_category_hint( text, longtext, advc ) \
300 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
302 #define add_subcategory_hint( text, longtext ) \
303 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
305 #define end_subcategory_hint \
306 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
308 #define add_usage_hint( text ) \
309 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
311 #define add_string( name, value, p_callback, text, longtext, advc ) \
312 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
315 #define add_password( name, value, p_callback, text, longtext, advc ) \
316 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
319 #define add_file( name, value, p_callback, text, longtext, advc ) \
320 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
323 #define add_directory( name, value, p_callback, text, longtext, advc ) \
324 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
327 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
328 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
329 p_callback, value ) \
330 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
332 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
333 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
334 p_callback, value ) \
335 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
338 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
339 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
340 p_callback, value ) \
341 p_config->min.i = i_subcategory /* gruik */;
343 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
344 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
345 advc, p_callback, value ) \
346 p_config->min.i = i_subcategory /* gruik */;
349 #define add_integer( name, value, p_callback, text, longtext, advc ) \
350 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
353 #define add_key( name, value, p_callback, text, longtext, advc ) \
354 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
357 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
358 add_integer( name, value, p_callback, text, longtext, advc ) \
359 change_integer_range( i_min, i_max )
361 #define add_float( name, v, p_callback, text, longtext, advc ) \
362 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
363 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
365 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
366 add_float( name, value, p_callback, text, longtext, advc ) \
367 change_float_range( f_min, f_max )
369 #define add_bool( name, v, p_callback, text, longtext, advc ) \
370 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
372 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
374 /* For removed option */
375 #define add_obsolete_inner( name, type ) \
376 add_type_inner( type ) \
377 vlc_config_set (p_config, VLC_CONFIG_NAME, \
378 (const char *)(name), (vlc_callback_t)NULL); \
379 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
381 #define add_obsolete_bool( name ) \
382 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
384 #define add_obsolete_integer( name ) \
385 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
387 #define add_obsolete_float( name ) \
388 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
390 #define add_obsolete_string( name ) \
391 add_obsolete_inner( name, CONFIG_ITEM_STRING )
393 /* Modifier macros for the config options (used for fine tuning) */
395 #define add_deprecated_alias( name ) \
396 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name))
398 #define change_short( ch ) \
399 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
401 #define change_string_list( list, list_text, list_update_func ) \
402 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
403 (size_t)(sizeof (list) / sizeof (char *)), \
404 (const char *const *)(list), \
405 (const char *const *)(list_text), \
408 #define change_integer_list( list, list_text, list_update_func ) \
409 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
410 (size_t)(sizeof (list) / sizeof (int)), \
411 (const int *)(list), \
412 (const char *const *)(list_text), \
415 #define change_float_list( list, list_text, list_update_func ) \
416 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
417 (size_t)(sizeof (list) / sizeof (float)), \
418 (const float *)(list), \
419 (const char *const *)(list_text), \
422 #define change_integer_range( minv, maxv ) \
423 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
425 #define change_float_range( minv, maxv ) \
426 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
427 (double)(minv), (double)(maxv));
429 #define change_action_add( pf_action, text ) \
430 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
431 (vlc_callback_t)(pf_action), (const char *)(text));
433 #define change_internal() \
434 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
436 #define change_need_restart() \
437 vlc_config_set (p_config, VLC_CONFIG_RESTART);
439 #define change_autosave() \
440 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
442 #define change_unsaveable() \
443 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
445 #define change_unsafe() (void)0; /* no-op */
447 #define change_safe() \
448 vlc_config_set (p_config, VLC_CONFIG_SAFE);
450 /* Meta data plugin exports */
451 #define VLC_META_EXPORT( name, value ) \
452 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
453 E_(vlc_entry_ ## name) (void); \
454 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
455 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
460 #if defined (__LIBVLC__)
461 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
462 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
463 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
464 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
465 "\x6c\x6f\x70\x70\x65\x72\x73" )
466 #elif !defined (VLC_COPYRIGHT_EXPORT)
467 # define VLC_COPYRIGHT_EXPORT
469 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
470 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
471 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
472 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
473 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
474 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
476 #define VLC_METADATA_EXPORTS \
477 VLC_COPYRIGHT_EXPORT \