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
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
29 * This file implements plugin (module) macros used to define a vlc module.
32 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
33 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
34 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
35 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
36 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
38 enum vlc_module_properties
40 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
41 * Append new items at the end ONLY. */
42 VLC_MODULE_CPU_REQUIREMENT,
44 VLC_MODULE_SHORTNAME_NODOMAIN,
45 VLC_MODULE_DESCRIPTION_NODOMAIN,
46 VLC_MODULE_HELP_NODOMAIN,
47 VLC_MODULE_CAPABILITY,
54 VLC_MODULE_DESCRIPTION,
58 enum vlc_config_properties
60 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
61 * Append new items at the end ONLY. */
64 /* command line name (args=const char *, vlc_callback_t) */
66 VLC_CONFIG_DESC_NODOMAIN,
67 /* description (args=const char *, const char *) */
70 /* actual value (args=int/double/const char *) */
73 /* minimum value (args=int/double/const char * twice) */
76 /* enable advanced flag (args=none) */
79 /* don't write variable to storage (args=none) */
81 VLC_CONFIG_PERSISTENT,
82 /* always write variable to storage (args=none) */
85 /* restart required to apply value change (args=none) */
88 /* hide from user (args=none) */
91 /* tag as no longer supported (args=none) */
93 VLC_CONFIG_CAPABILITY,
94 /* capability for a module or list thereof (args=const char*) */
97 /* one-character (short) command line option name (args=char) */
99 VLC_CONFIG_LIST_NODOMAIN,
100 /* possible values list
101 * (args=size_t, const <type> *, const char *const *) */
103 VLC_CONFIG_ADD_ACTION_NODOMAIN,
104 /* add value change callback (args=vlc_callback_t, const char *) */
107 /* former option name (args=const char *) */
110 /* tag as modifiable by untrusted input item "sources" (args=none) */
113 /* description (args=const char *, const char *, const char *) */
116 /* possible values list
117 * (args=const char *, size_t, const <type> *, const char *const *) */
119 VLC_CONFIG_ADD_ACTION,
120 /* add value change callback
121 * (args=const char *, vlc_callback_t, const char *) */
124 /*****************************************************************************
125 * If we are not within a module, assume we're in the vlc core.
126 *****************************************************************************/
127 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
128 # define MODULE_NAME main
132 * Current plugin ABI version
134 # define MODULE_SYMBOL 1_0_0d
135 # define MODULE_SUFFIX "__1_0_0d"
137 /*****************************************************************************
138 * Add a few defines. You do not want to read this section. Really.
139 *****************************************************************************/
143 * if linking a module statically, we will need:
144 * #define MODULE_FUNC( zog ) module_foo_zog
146 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
149 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
150 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
151 #define CRUDE_HACK( y, z ) y##__##z
153 /* If the module is built-in, then we need to define foo_InitModule instead
154 * of InitModule. Same for Activate- and DeactivateModule. */
156 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
158 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
161 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
162 # define DLL_SYMBOL __declspec(dllexport)
163 # define CDECL_SYMBOL __cdecl
166 # define CDECL_SYMBOL
169 #if defined( __cplusplus )
170 # define EXTERN_SYMBOL extern "C"
172 # define EXTERN_SYMBOL
176 * InitModule: this function is called once and only once, when the module
177 * is looked at for the first time. We get the useful data from it, for
178 * instance the module name, its shortcuts, its capabilities... we also create
179 * a copy of its config because the module can be unloaded at any time.
181 #define vlc_module_begin( ) \
182 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
183 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ); \
185 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
186 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
188 module_config_t *p_config = NULL; \
189 const char *domain = NULL; \
190 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
191 (const char *)(MODULE_STRING))) \
194 module_t *p_submodule = p_module;
196 #define vlc_module_end( ) \
199 return VLC_SUCCESS; \
202 return VLC_EGENERIC; \
206 #define add_submodule( ) \
207 p_submodule = vlc_submodule_create( p_module );
209 #define add_requirement( cap ) \
210 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
211 (int)(CPU_CAPABILITY_##cap))) \
214 #define add_shortcut( shortcut ) \
215 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
216 (const char *)(shortcut))) \
219 #define set_shortname( shortname ) \
220 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
221 (const char *)(shortname))) \
224 #define set_description( desc ) \
225 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
226 (const char *)(desc))) \
229 #define set_help( help ) \
230 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
231 (const char *)(help))) \
234 #define set_capability( cap, score ) \
235 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
236 (const char *)(cap)) \
237 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
240 #define set_callbacks( activate, deactivate ) \
241 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
242 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
245 #define linked_with_a_crap_library_which_uses_atexit( ) \
246 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
249 #define set_text_domain( dom ) domain = (dom);
251 /*****************************************************************************
252 * Macros used to build the configuration structure.
254 * Note that internally we support only 3 types of config data: int, float
256 * The other types declared here just map to one of these 3 basic types but
257 * have the advantage of also providing very good hints to a configuration
258 * interface so as to make it more user friendly.
259 * The configuration structure also includes category hints. These hints can
260 * provide a configuration interface with some very useful data and again
261 * allow for a more user friendly interface.
262 *****************************************************************************/
264 #define add_type_inner( type ) \
265 p_config = vlc_config_create (p_module, type);
267 #define add_typedesc_inner( type, text, longtext ) \
268 add_type_inner( type ) \
269 vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
270 (const char *)(text), (const char *)(longtext));
272 #define add_typeadv_inner( type, text, longtext, advc ) \
273 add_typedesc_inner( type, text, longtext ) \
274 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
276 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
277 add_typeadv_inner( type, text, longtext, advc ) \
278 vlc_config_set (p_config, VLC_CONFIG_NAME, \
279 (const char *)(name), (vlc_callback_t)(cb));
281 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
282 add_typename_inner( type, name, text, longtext, advc, cb ) \
283 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
285 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
286 add_typename_inner( type, name, text, longtext, advc, cb ) \
287 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
290 #define set_category( i_id ) \
291 add_type_inner( CONFIG_CATEGORY ) \
292 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
294 #define set_subcategory( i_id ) \
295 add_type_inner( CONFIG_SUBCATEGORY ) \
296 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
298 #define set_section( text, longtext ) \
299 add_typedesc_inner( CONFIG_SECTION, text, longtext )
301 #define add_category_hint( text, longtext, advc ) \
302 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
304 #define add_subcategory_hint( text, longtext ) \
305 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
307 #define end_subcategory_hint \
308 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
310 #define add_usage_hint( text ) \
311 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
313 #define add_string( name, value, p_callback, text, longtext, advc ) \
314 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
317 #define add_password( name, value, p_callback, text, longtext, advc ) \
318 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
321 #define add_file( name, value, p_callback, text, longtext, advc ) \
322 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
325 #define add_directory( name, value, p_callback, text, longtext, advc ) \
326 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
329 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
330 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
331 p_callback, value ) \
332 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
334 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
335 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
336 p_callback, value ) \
337 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
340 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
341 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
342 p_callback, value ) \
343 p_config->min.i = i_subcategory /* gruik */;
345 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
346 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
347 advc, p_callback, value ) \
348 p_config->min.i = i_subcategory /* gruik */;
351 #define add_integer( name, value, p_callback, text, longtext, advc ) \
352 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
355 #if !defined(WIN32) && !defined(SYS_LINUX)
356 #define add_key( name, value, p_callback, text, longtext, advc ) \
357 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
360 #define add_key( name, value, p_callback, text, longtext, advc ) \
361 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
362 p_callback, value ) \
363 add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
364 p_callback, KEY_UNSET )
367 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
368 add_integer( name, value, p_callback, text, longtext, advc ) \
369 change_integer_range( i_min, i_max )
371 #define add_float( name, v, p_callback, text, longtext, advc ) \
372 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
373 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
375 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
376 add_float( name, value, p_callback, text, longtext, advc ) \
377 change_float_range( f_min, f_max )
379 #define add_bool( name, v, p_callback, text, longtext, advc ) \
380 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
382 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
384 /* For removed option */
385 #define add_obsolete_inner( name, type ) \
386 add_type_inner( type ) \
387 vlc_config_set (p_config, VLC_CONFIG_NAME, \
388 (const char *)(name), (vlc_callback_t)NULL); \
389 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
391 #define add_obsolete_bool( name ) \
392 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
394 #define add_obsolete_integer( name ) \
395 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
397 #define add_obsolete_float( name ) \
398 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
400 #define add_obsolete_string( name ) \
401 add_obsolete_inner( name, CONFIG_ITEM_STRING )
403 /* Modifier macros for the config options (used for fine tuning) */
405 #define add_deprecated_alias( name ) \
406 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
408 #define change_short( ch ) \
409 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
411 #define change_string_list( list, list_text, list_update_func ) \
412 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
413 (size_t)(sizeof (list) / sizeof (char *)), \
414 (const char *const *)(list), \
415 (const char *const *)(list_text), \
416 (vlc_callback_t)(list_update_func));
418 #define change_integer_list( list, list_text, list_update_func ) \
419 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
420 (size_t)(sizeof (list) / sizeof (int)), \
421 (const int *)(list), \
422 (const char *const *)(list_text), \
423 (vlc_callback_t)(list_update_func));
425 #define change_float_list( list, list_text, list_update_func ) \
426 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
427 (size_t)(sizeof (list) / sizeof (float)), \
428 (const float *)(list), \
429 (const char *const *)(list_text), \
430 (vlc_callback_t)(list_update_func));
432 #define change_integer_range( minv, maxv ) \
433 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
435 #define change_float_range( minv, maxv ) \
436 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
437 (double)(minv), (double)(maxv));
439 #define change_action_add( pf_action, text ) \
440 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
441 (vlc_callback_t)(pf_action), (const char *)(text));
443 #define change_internal() \
444 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
446 #define change_need_restart() \
447 vlc_config_set (p_config, VLC_CONFIG_RESTART);
449 #define change_autosave() \
450 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
452 #define change_unsaveable() \
453 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
455 #define change_safe() \
456 vlc_config_set (p_config, VLC_CONFIG_SAFE);
458 /* Meta data plugin exports */
459 #define VLC_META_EXPORT( name, value ) \
460 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
461 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
462 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
463 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
468 #if defined (__LIBVLC__)
469 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
470 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
471 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
472 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
473 "\x6c\x6f\x70\x70\x65\x72\x73" )
474 #elif !defined (VLC_COPYRIGHT_EXPORT)
475 # define VLC_COPYRIGHT_EXPORT
477 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
478 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
479 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
480 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
481 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
482 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
484 #define VLC_METADATA_EXPORTS \
485 VLC_COPYRIGHT_EXPORT \