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_API int vlc_plugin_set(module_t *, module_config_t *, int, ...);
34 #define vlc_module_set( mod, ... ) vlc_plugin_set ((mod), NULL, __VA_ARGS__)
35 #define vlc_config_set( cfg, ... ) vlc_plugin_set (NULL, (cfg), __VA_ARGS__)
37 enum vlc_module_properties
42 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
43 * Append new items at the end ONLY. */
44 VLC_MODULE_CPU_REQUIREMENT=0x100,
46 VLC_MODULE_CAPABILITY,
53 VLC_MODULE_DESCRIPTION,
55 VLC_MODULE_TEXTDOMAIN,
56 /* Insert new VLC_MODULE_* here */
58 /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
59 * Append new items at the end ONLY. */
60 VLC_CONFIG_NAME=0x1000,
61 /* command line name (args=const char *) */
64 /* actual value (args=int/double/const char *) */
67 /* minimum value (args=int/double/const char * twice) */
70 /* enable advanced flag (args=none) */
73 /* don't write variable to storage (args=none) */
75 VLC_CONFIG_PERSISTENT_OBSOLETE,
76 /* unused (ignored) */
79 /* hide from user (args=none) */
82 /* tag as no longer supported (args=none) */
84 VLC_CONFIG_CAPABILITY,
85 /* capability for a module or list thereof (args=const char*) */
88 /* one-character (short) command line option name (args=char) */
91 /* former option name (args=const char *) */
94 /* tag as modifiable by untrusted input item "sources" (args=none) */
97 /* description (args=const char *, const char *, const char *) */
100 /* possible values list
101 * (args=const char *, size_t, const <type> *, const char *const *) */
103 VLC_CONFIG_ADD_ACTION,
104 /* add value change callback
105 * (args=const char *, vlc_callback_t, const char *) */
107 /* Insert new VLC_CONFIG_* here */
111 * Current plugin ABI version
113 # define MODULE_SYMBOL 1_2_0i
114 # define MODULE_SUFFIX "__1_2_0i"
116 /*****************************************************************************
117 * Add a few defines. You do not want to read this section. Really.
118 *****************************************************************************/
122 * if linking a module statically, we will need:
123 * #define MODULE_FUNC( zog ) module_foo_zog
125 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
128 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
129 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
130 #define CRUDE_HACK( y, z ) y##__##z
132 /* If the module is built-in, then we need to define foo_InitModule instead
133 * of InitModule. Same for Activate- and DeactivateModule. */
135 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
137 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
141 #if defined (__PLUGIN__)
143 # define DLL_SYMBOL __declspec(dllexport)
145 # define CDECL_SYMBOL __cdecl
146 # elif defined (__GNUC__) && (__GNUC__ >= 4)
147 # define DLL_SYMBOL __attribute__((visibility("default")))
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 \
169 module_t *CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (void); \
170 EXTERN_SYMBOL DLL_SYMBOL \
171 module_t *CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (void) \
173 module_t *module, *p_submodule; \
174 module_config_t *p_config = NULL; \
175 if (vlc_plugin_set (NULL, NULL, VLC_MODULE_CREATE, &module)) \
177 if (vlc_module_set (module, VLC_MODULE_NAME, (MODULE_STRING))) \
179 p_submodule = module;
181 #define vlc_module_end() \
189 #define add_submodule( ) \
190 if (vlc_plugin_set (module, NULL, VLC_MODULE_CREATE, &p_submodule)) \
193 #define add_shortcut( ... ) \
195 const char *shortcuts[] = { __VA_ARGS__ }; \
196 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
197 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
201 #define set_shortname( shortname ) \
202 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
203 (const char *)(shortname))) \
206 #define set_description( desc ) \
207 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
208 (const char *)(desc))) \
211 #define set_help( help ) \
212 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
213 (const char *)(help))) \
216 #define set_capability( cap, score ) \
217 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
218 (const char *)(cap)) \
219 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
222 #define set_callbacks( activate, deactivate ) \
223 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
224 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
227 #define cannot_unload_broken_library( ) \
228 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
231 #define set_text_domain( dom ) \
232 if (vlc_module_set (module, VLC_MODULE_TEXTDOMAIN, (dom))) \
235 /*****************************************************************************
236 * Macros used to build the configuration structure.
238 * Note that internally we support only 3 types of config data: int, float
240 * The other types declared here just map to one of these 3 basic types but
241 * have the advantage of also providing very good hints to a configuration
242 * interface so as to make it more user friendly.
243 * The configuration structure also includes category hints. These hints can
244 * provide a configuration interface with some very useful data and again
245 * allow for a more user friendly interface.
246 *****************************************************************************/
248 #define add_type_inner( type ) \
249 vlc_plugin_set (module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
251 #define add_typedesc_inner( type, text, longtext ) \
252 add_type_inner( type ) \
253 vlc_config_set (p_config, VLC_CONFIG_DESC, \
254 (const char *)(text), (const char *)(longtext));
256 #define add_typeadv_inner( type, text, longtext, advc ) \
257 add_typedesc_inner( type, text, longtext ) \
258 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
260 #define add_typename_inner( type, name, text, longtext, advc ) \
261 add_typeadv_inner( type, text, longtext, advc ) \
262 vlc_config_set (p_config, VLC_CONFIG_NAME, \
263 (const char *)(name));
265 #define add_string_inner( type, name, text, longtext, advc, v ) \
266 add_typename_inner( type, name, text, longtext, advc ) \
267 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
269 #define add_int_inner( type, name, text, longtext, advc, v ) \
270 add_typename_inner( type, name, text, longtext, advc ) \
271 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
274 #define set_category( i_id ) \
275 add_type_inner( CONFIG_CATEGORY ) \
276 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
278 #define set_subcategory( i_id ) \
279 add_type_inner( CONFIG_SUBCATEGORY ) \
280 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
282 #define set_section( text, longtext ) \
283 add_typedesc_inner( CONFIG_SECTION, text, longtext )
285 #define add_category_hint( text, longtext, advc ) \
286 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
288 #define add_subcategory_hint( text, longtext ) \
289 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
291 #define end_subcategory_hint \
292 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
294 #define add_usage_hint( text ) \
295 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
297 #define add_string( name, value, text, longtext, advc ) \
298 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
301 #define add_password( name, value, text, longtext, advc ) \
302 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
305 #define add_loadfile( name, value, text, longtext, advc ) \
306 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
309 #define add_savefile( name, value, text, longtext, advc ) \
310 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
313 #define add_directory( name, value, text, longtext, advc ) \
314 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
317 #define add_font( name, value, text, longtext, advc )\
318 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
321 #define add_module( name, psz_caps, value, text, longtext, advc ) \
322 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
324 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
326 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
327 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
329 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
332 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
333 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
335 change_integer_range (i_subcategory /* gruik */, 0);
337 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
338 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
340 change_integer_range (i_subcategory /* gruik */, 0);
343 #define add_integer( name, value, text, longtext, advc ) \
344 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
346 #define add_rgb( name, value, text, longtext, advc ) \
347 add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
348 change_integer_range( 0, 0xFFFFFF )
350 #define add_key( name, value, text, longtext, advc ) \
351 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
353 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
355 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
356 add_integer( name, value, text, longtext, advc ) \
357 change_integer_range( i_min, i_max )
359 #define add_float( name, v, text, longtext, advc ) \
360 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
361 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
363 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
364 add_float( name, value, text, longtext, advc ) \
365 change_float_range( f_min, f_max )
367 #define add_bool( name, v, text, longtext, advc ) \
368 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
369 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true);
371 /* For removed option */
372 #define add_obsolete_inner( name, type ) \
373 add_type_inner( type ) \
374 vlc_config_set (p_config, VLC_CONFIG_NAME, \
375 (const char *)(name)); \
376 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
378 #define add_obsolete_bool( name ) \
379 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
381 #define add_obsolete_integer( name ) \
382 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
384 #define add_obsolete_float( name ) \
385 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
387 #define add_obsolete_string( name ) \
388 add_obsolete_inner( name, CONFIG_ITEM_STRING )
390 /* Modifier macros for the config options (used for fine tuning) */
392 #define add_deprecated_alias( name ) \
393 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
395 #define change_short( ch ) \
396 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
398 #define change_string_list( list, list_text, list_update_func ) \
399 vlc_config_set (p_config, VLC_CONFIG_LIST, \
400 (size_t)(sizeof (list) / sizeof (char *)), \
401 (const char *const *)(list), \
402 (const char *const *)(list_text), \
403 (vlc_callback_t)(list_update_func));
405 #define change_integer_list( list, list_text ) \
406 vlc_config_set (p_config, VLC_CONFIG_LIST, \
407 (size_t)(sizeof (list) / sizeof (int)), \
408 (const int *)(list), \
409 (const char *const *)(list_text), \
410 (vlc_callback_t)(NULL));
412 #define change_integer_range( minv, maxv ) \
413 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
414 (int64_t)(minv), (int64_t)(maxv));
416 #define change_float_range( minv, maxv ) \
417 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
418 (double)(minv), (double)(maxv));
420 #define change_action_add( pf_action, text ) \
421 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
422 (vlc_callback_t)(pf_action), (const char *)(text));
424 /* For options that are saved but hidden from the preferences panel */
425 #define change_private() \
426 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
428 /* For options that cannot be saved in the configuration */
429 #define change_volatile() \
431 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
433 #define change_safe() \
434 vlc_config_set (p_config, VLC_CONFIG_SAFE);
436 /* Meta data plugin exports */
437 #define VLC_META_EXPORT( name, value ) \
438 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
439 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
440 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
441 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
446 #if defined (__LIBVLC__)
447 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
448 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
449 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
450 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
451 "\x6c\x6f\x70\x65\x72\x73" )
452 #elif !defined (VLC_COPYRIGHT_EXPORT)
453 # define VLC_COPYRIGHT_EXPORT
455 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
456 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
457 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
458 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
459 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
460 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
462 #define VLC_METADATA_EXPORTS \
463 VLC_COPYRIGHT_EXPORT \