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_submodule_create, ( module_t * ) );
33 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, ...) );
34 VLC_EXPORT( module_config_t *, vlc_config_create, (module_t *, int type) );
35 VLC_EXPORT( int, vlc_config_set, (module_config_t *, int, ...) );
37 enum vlc_module_properties
39 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
40 * Append new items at the end ONLY. */
41 VLC_MODULE_CPU_REQUIREMENT,
43 VLC_MODULE_CAPABILITY,
50 VLC_MODULE_DESCRIPTION,
54 enum vlc_config_properties
56 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
57 * Append new items at the end ONLY. */
60 /* command line name (args=const char *, vlc_callback_t) */
63 /* actual value (args=int/double/const char *) */
66 /* minimum value (args=int/double/const char * twice) */
69 /* enable advanced flag (args=none) */
72 /* don't write variable to storage (args=none) */
74 VLC_CONFIG_PERSISTENT,
75 /* always write variable to storage (args=none) */
78 /* restart required to apply value change (args=none) */
81 /* hide from user (args=none) */
84 /* tag as no longer supported (args=none) */
86 VLC_CONFIG_CAPABILITY,
87 /* capability for a module or list thereof (args=const char*) */
90 /* one-character (short) command line option name (args=char) */
93 /* former option name (args=const char *) */
96 /* tag as modifiable by untrusted input item "sources" (args=none) */
99 /* description (args=const char *, const char *, const char *) */
102 /* possible values list
103 * (args=const char *, size_t, const <type> *, const char *const *) */
105 VLC_CONFIG_ADD_ACTION,
106 /* add value change callback
107 * (args=const char *, vlc_callback_t, const char *) */
110 /*****************************************************************************
111 * If we are not within a module, assume we're in the vlc core.
112 *****************************************************************************/
113 #if !defined( __PLUGIN__ ) && !defined( __BUILTIN__ )
114 # define MODULE_NAME main
118 * Current plugin ABI version
120 # define MODULE_SYMBOL 1_0_0d
121 # define MODULE_SUFFIX "__1_0_0d"
123 /*****************************************************************************
124 * Add a few defines. You do not want to read this section. Really.
125 *****************************************************************************/
129 * if linking a module statically, we will need:
130 * #define MODULE_FUNC( zog ) module_foo_zog
132 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
135 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
136 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
137 #define CRUDE_HACK( y, z ) y##__##z
139 /* If the module is built-in, then we need to define foo_InitModule instead
140 * of InitModule. Same for Activate- and DeactivateModule. */
142 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
144 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
147 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
148 # define DLL_SYMBOL __declspec(dllexport)
149 # define CDECL_SYMBOL __cdecl
152 # define CDECL_SYMBOL
155 #if defined( __cplusplus )
156 # define EXTERN_SYMBOL extern "C"
158 # define EXTERN_SYMBOL
162 * InitModule: this function is called once and only once, when the module
163 * is looked at for the first time. We get the useful data from it, for
164 * instance the module name, its shortcuts, its capabilities... we also create
165 * a copy of its config because the module can be unloaded at any time.
167 #define vlc_module_begin( ) \
168 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
169 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ); \
171 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
172 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
174 module_config_t *p_config = NULL; \
175 const char *domain = NULL; \
176 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
177 (const char *)(MODULE_STRING))) \
180 module_t *p_submodule = p_module;
182 #define vlc_module_end( ) \
185 return VLC_SUCCESS; \
188 return VLC_EGENERIC; \
192 #define add_submodule( ) \
193 p_submodule = vlc_submodule_create( p_module );
195 #define add_requirement( cap ) \
196 if (vlc_module_set (p_module, VLC_MODULE_CPU_REQUIREMENT, \
197 (int)(CPU_CAPABILITY_##cap))) \
200 #define add_shortcut( shortcut ) \
201 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
202 (const char *)(shortcut))) \
205 #define set_shortname( shortname ) \
206 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, domain, \
207 (const char *)(shortname))) \
210 #define set_description( desc ) \
211 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, domain, \
212 (const char *)(desc))) \
215 #define set_help( help ) \
216 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, domain, \
217 (const char *)(help))) \
220 #define set_capability( cap, score ) \
221 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
222 (const char *)(cap)) \
223 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
226 #define set_callbacks( activate, deactivate ) \
227 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
228 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
231 #define linked_with_a_crap_library_which_uses_atexit( ) \
232 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
235 #define set_text_domain( dom ) domain = (dom);
237 /*****************************************************************************
238 * Macros used to build the configuration structure.
240 * Note that internally we support only 3 types of config data: int, float
242 * The other types declared here just map to one of these 3 basic types but
243 * have the advantage of also providing very good hints to a configuration
244 * interface so as to make it more user friendly.
245 * The configuration structure also includes category hints. These hints can
246 * provide a configuration interface with some very useful data and again
247 * allow for a more user friendly interface.
248 *****************************************************************************/
250 #define add_type_inner( type ) \
251 p_config = vlc_config_create (p_module, type);
253 #define add_typedesc_inner( type, text, longtext ) \
254 add_type_inner( type ) \
255 vlc_config_set (p_config, VLC_CONFIG_DESC, domain, \
256 (const char *)(text), (const char *)(longtext));
258 #define add_typeadv_inner( type, text, longtext, advc ) \
259 add_typedesc_inner( type, text, longtext ) \
260 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
262 #define add_typename_inner( type, name, text, longtext, advc, cb ) \
263 add_typeadv_inner( type, text, longtext, advc ) \
264 vlc_config_set (p_config, VLC_CONFIG_NAME, \
265 (const char *)(name), (vlc_callback_t)(cb));
267 #define add_string_inner( type, name, text, longtext, advc, cb, v ) \
268 add_typename_inner( type, name, text, longtext, advc, cb ) \
269 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
271 #define add_int_inner( type, name, text, longtext, advc, cb, v ) \
272 add_typename_inner( type, name, text, longtext, advc, cb ) \
273 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(v));
276 #define set_category( i_id ) \
277 add_type_inner( CONFIG_CATEGORY ) \
278 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
280 #define set_subcategory( i_id ) \
281 add_type_inner( CONFIG_SUBCATEGORY ) \
282 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)(i_id));
284 #define set_section( text, longtext ) \
285 add_typedesc_inner( CONFIG_SECTION, text, longtext )
287 #define add_category_hint( text, longtext, advc ) \
288 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
290 #define add_subcategory_hint( text, longtext ) \
291 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
293 #define end_subcategory_hint \
294 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
296 #define add_usage_hint( text ) \
297 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
299 #define add_string( name, value, p_callback, text, longtext, advc ) \
300 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
303 #define add_password( name, value, p_callback, text, longtext, advc ) \
304 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
307 #define add_file( name, value, p_callback, text, longtext, advc ) \
308 add_string_inner( CONFIG_ITEM_FILE, name, text, longtext, advc, \
311 #define add_directory( name, value, p_callback, text, longtext, advc ) \
312 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
315 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
316 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
317 p_callback, value ) \
318 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
320 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
321 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
322 p_callback, value ) \
323 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
326 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
327 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
328 p_callback, value ) \
329 change_integer_range (i_subcategory /* gruik */, 0);
331 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
332 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
333 advc, p_callback, value ) \
334 change_integer_range (i_subcategory /* gruik */, 0);
337 #define add_integer( name, value, p_callback, text, longtext, advc ) \
338 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, \
341 #if !defined(WIN32) && !defined(SYS_LINUX)
342 #define add_key( name, value, p_callback, text, longtext, advc ) \
343 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, p_callback, \
346 #define add_key( name, value, p_callback, text, longtext, advc ) \
347 add_int_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, \
348 p_callback, value ) \
349 add_int_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
350 p_callback, KEY_UNSET )
353 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
354 add_integer( name, value, p_callback, text, longtext, advc ) \
355 change_integer_range( i_min, i_max )
357 #define add_float( name, v, p_callback, text, longtext, advc ) \
358 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc, p_callback ) \
359 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
361 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
362 add_float( name, value, p_callback, text, longtext, advc ) \
363 change_float_range( f_min, f_max )
365 #define add_bool( name, v, p_callback, text, longtext, advc ) \
366 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc, \
368 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int)true);
370 /* For removed option */
371 #define add_obsolete_inner( name, type ) \
372 add_type_inner( type ) \
373 vlc_config_set (p_config, VLC_CONFIG_NAME, \
374 (const char *)(name), (vlc_callback_t)NULL); \
375 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
377 #define add_obsolete_bool( name ) \
378 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
380 #define add_obsolete_integer( name ) \
381 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
383 #define add_obsolete_float( name ) \
384 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
386 #define add_obsolete_string( name ) \
387 add_obsolete_inner( name, CONFIG_ITEM_STRING )
389 /* Modifier macros for the config options (used for fine tuning) */
391 #define add_deprecated_alias( name ) \
392 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
394 #define change_short( ch ) \
395 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
397 #define change_string_list( list, list_text, list_update_func ) \
398 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
399 (size_t)(sizeof (list) / sizeof (char *)), \
400 (const char *const *)(list), \
401 (const char *const *)(list_text), \
402 (vlc_callback_t)(list_update_func));
404 #define change_integer_list( list, list_text, list_update_func ) \
405 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
406 (size_t)(sizeof (list) / sizeof (int)), \
407 (const int *)(list), \
408 (const char *const *)(list_text), \
409 (vlc_callback_t)(list_update_func));
411 #define change_float_list( list, list_text, list_update_func ) \
412 vlc_config_set (p_config, VLC_CONFIG_LIST, domain, \
413 (size_t)(sizeof (list) / sizeof (float)), \
414 (const float *)(list), \
415 (const char *const *)(list_text), \
416 (vlc_callback_t)(list_update_func));
418 #define change_integer_range( minv, maxv ) \
419 vlc_config_set (p_config, VLC_CONFIG_RANGE, (int)(minv), (int)(maxv));
421 #define change_float_range( minv, maxv ) \
422 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
423 (double)(minv), (double)(maxv));
425 #define change_action_add( pf_action, text ) \
426 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, domain, \
427 (vlc_callback_t)(pf_action), (const char *)(text));
429 #define change_internal() \
430 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
432 #define change_need_restart() \
433 vlc_config_set (p_config, VLC_CONFIG_RESTART);
435 #define change_autosave() \
436 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
438 #define change_unsaveable() \
439 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
441 #define change_safe() \
442 vlc_config_set (p_config, VLC_CONFIG_SAFE);
444 /* Meta data plugin exports */
445 #define VLC_META_EXPORT( name, value ) \
446 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
447 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
448 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
449 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
454 #if defined (__LIBVLC__)
455 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
456 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
457 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
458 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
459 "\x6c\x6f\x70\x70\x65\x72\x73" )
460 #elif !defined (VLC_COPYRIGHT_EXPORT)
461 # define VLC_COPYRIGHT_EXPORT
463 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
464 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
465 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
466 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
467 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
468 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
470 #define VLC_METADATA_EXPORTS \
471 VLC_COPYRIGHT_EXPORT \