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( 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,
76 /* always write variable to storage (args=none) */
79 /* restart required to apply value change (args=none) */
82 /* hide from user (args=none) */
85 /* tag as no longer supported (args=none) */
87 VLC_CONFIG_CAPABILITY,
88 /* capability for a module or list thereof (args=const char*) */
91 /* one-character (short) command line option name (args=char) */
94 /* former option name (args=const char *) */
97 /* tag as modifiable by untrusted input item "sources" (args=none) */
100 /* description (args=const char *, const char *, const char *) */
103 /* possible values list
104 * (args=const char *, size_t, const <type> *, const char *const *) */
106 VLC_CONFIG_ADD_ACTION,
107 /* add value change callback
108 * (args=const char *, vlc_callback_t, const char *) */
110 /* Insert new VLC_CONFIG_* here */
114 * Current plugin ABI version
116 # define MODULE_SYMBOL 1_2_0g
117 # define MODULE_SUFFIX "__1_2_0g"
119 /*****************************************************************************
120 * Add a few defines. You do not want to read this section. Really.
121 *****************************************************************************/
125 * if linking a module statically, we will need:
126 * #define MODULE_FUNC( zog ) module_foo_zog
128 * this can't easily be done with the C preprocessor, thus a few ugly hacks.
131 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
132 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
133 #define CRUDE_HACK( y, z ) y##__##z
135 /* If the module is built-in, then we need to define foo_InitModule instead
136 * of InitModule. Same for Activate- and DeactivateModule. */
138 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_SYMBOL )
140 # define __VLC_SYMBOL( symbol ) CONCATENATE( symbol, MODULE_NAME )
143 #if defined( __PLUGIN__ ) && ( defined( WIN32 ) || defined( UNDER_CE ) )
144 # define DLL_SYMBOL __declspec(dllexport)
145 # define CDECL_SYMBOL __cdecl
148 # define CDECL_SYMBOL
151 #if defined( __cplusplus )
152 # define EXTERN_SYMBOL extern "C"
154 # define EXTERN_SYMBOL
158 * InitModule: this function is called once and only once, when the module
159 * is looked at for the first time. We get the useful data from it, for
160 * instance the module name, its shortcuts, its capabilities... we also create
161 * a copy of its config because the module can be unloaded at any time.
163 #define vlc_module_begin( ) \
164 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
165 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ); \
167 EXTERN_SYMBOL DLL_SYMBOL int CDECL_SYMBOL \
168 __VLC_SYMBOL(vlc_entry) ( module_t *p_module ) \
170 module_config_t *p_config = NULL; \
171 if (vlc_module_set (p_module, VLC_MODULE_NAME, \
172 (const char *)(MODULE_STRING))) \
175 module_t *p_submodule = p_module;
177 #define vlc_module_end( ) \
180 return VLC_SUCCESS; \
183 return VLC_EGENERIC; \
187 #define add_submodule( ) \
188 if (vlc_plugin_set (p_module, NULL, VLC_SUBMODULE_CREATE, &p_submodule)) \
191 #define add_shortcut( ... ) \
193 const char *shortcuts[] = { __VA_ARGS__ }; \
194 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTCUT, \
195 sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
199 #define set_shortname( shortname ) \
200 if (vlc_module_set (p_submodule, VLC_MODULE_SHORTNAME, \
201 (const char *)(shortname))) \
204 #define set_description( desc ) \
205 if (vlc_module_set (p_submodule, VLC_MODULE_DESCRIPTION, \
206 (const char *)(desc))) \
209 #define set_help( help ) \
210 if (vlc_module_set (p_submodule, VLC_MODULE_HELP, \
211 (const char *)(help))) \
214 #define set_capability( cap, score ) \
215 if (vlc_module_set (p_submodule, VLC_MODULE_CAPABILITY, \
216 (const char *)(cap)) \
217 || vlc_module_set (p_submodule, VLC_MODULE_SCORE, (int)(score))) \
220 #define set_callbacks( activate, deactivate ) \
221 if (vlc_module_set (p_submodule, VLC_MODULE_CB_OPEN, activate) \
222 || vlc_module_set (p_submodule, VLC_MODULE_CB_CLOSE, deactivate)) \
225 #define cannot_unload_broken_library( ) \
226 if (vlc_module_set (p_submodule, VLC_MODULE_NO_UNLOAD)) \
229 #define set_text_domain( dom ) \
230 if (vlc_module_set (p_module, VLC_MODULE_TEXTDOMAIN, (dom))) \
233 /*****************************************************************************
234 * Macros used to build the configuration structure.
236 * Note that internally we support only 3 types of config data: int, float
238 * The other types declared here just map to one of these 3 basic types but
239 * have the advantage of also providing very good hints to a configuration
240 * interface so as to make it more user friendly.
241 * The configuration structure also includes category hints. These hints can
242 * provide a configuration interface with some very useful data and again
243 * allow for a more user friendly interface.
244 *****************************************************************************/
246 #define add_type_inner( type ) \
247 vlc_plugin_set (p_module, NULL, VLC_CONFIG_CREATE, (type), &p_config);
249 #define add_typedesc_inner( type, text, longtext ) \
250 add_type_inner( type ) \
251 vlc_config_set (p_config, VLC_CONFIG_DESC, \
252 (const char *)(text), (const char *)(longtext));
254 #define add_typeadv_inner( type, text, longtext, advc ) \
255 add_typedesc_inner( type, text, longtext ) \
256 if (advc) vlc_config_set (p_config, VLC_CONFIG_ADVANCED);
258 #define add_typename_inner( type, name, text, longtext, advc ) \
259 add_typeadv_inner( type, text, longtext, advc ) \
260 vlc_config_set (p_config, VLC_CONFIG_NAME, \
261 (const char *)(name));
263 #define add_string_inner( type, name, text, longtext, advc, v ) \
264 add_typename_inner( type, name, text, longtext, advc ) \
265 vlc_config_set (p_config, VLC_CONFIG_VALUE, (const char *)(v));
267 #define add_int_inner( type, name, text, longtext, advc, v ) \
268 add_typename_inner( type, name, text, longtext, advc ) \
269 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(v));
272 #define set_category( i_id ) \
273 add_type_inner( CONFIG_CATEGORY ) \
274 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
276 #define set_subcategory( i_id ) \
277 add_type_inner( CONFIG_SUBCATEGORY ) \
278 vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)(i_id));
280 #define set_section( text, longtext ) \
281 add_typedesc_inner( CONFIG_SECTION, text, longtext )
283 #define add_category_hint( text, longtext, advc ) \
284 add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
286 #define add_subcategory_hint( text, longtext ) \
287 add_typedesc_inner( CONFIG_HINT_SUBCATEGORY, text, longtext )
289 #define end_subcategory_hint \
290 add_type_inner( CONFIG_HINT_SUBCATEGORY_END )
292 #define add_usage_hint( text ) \
293 add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
295 #define add_string( name, value, text, longtext, advc ) \
296 add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
299 #define add_password( name, value, text, longtext, advc ) \
300 add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
303 #define add_loadfile( name, value, text, longtext, advc ) \
304 add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
307 #define add_savefile( name, value, text, longtext, advc ) \
308 add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
311 #define add_directory( name, value, text, longtext, advc ) \
312 add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
315 #define add_font( name, value, text, longtext, advc )\
316 add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
319 #define add_module( name, psz_caps, value, p_callback, text, longtext, advc ) \
320 add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
322 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
324 #define add_module_list( name, psz_caps, value, p_callback, text, longtext, advc ) \
325 add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
327 vlc_config_set (p_config, VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
330 #define add_module_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
331 add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
333 change_integer_range (i_subcategory /* gruik */, 0);
335 #define add_module_list_cat( name, i_subcategory, value, p_callback, text, longtext, advc ) \
336 add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
338 change_integer_range (i_subcategory /* gruik */, 0);
341 #define add_integer( name, value, text, longtext, advc ) \
342 add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
344 #define add_key( name, value, text, longtext, advc ) \
345 add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
347 change_need_restart() \
348 add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
350 #define add_integer_with_range( name, value, i_min, i_max, p_callback, text, longtext, advc ) \
351 add_integer( name, value, text, longtext, advc ) \
352 change_integer_range( i_min, i_max )
354 #define add_float( name, v, text, longtext, advc ) \
355 add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
356 vlc_config_set (p_config, VLC_CONFIG_VALUE, (double)(v));
358 #define add_float_with_range( name, value, f_min, f_max, p_callback, text, longtext, advc ) \
359 add_float( name, value, text, longtext, advc ) \
360 change_float_range( f_min, f_max )
362 #define add_bool( name, v, text, longtext, advc ) \
363 add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
364 if (v) vlc_config_set (p_config, VLC_CONFIG_VALUE, (int64_t)true);
366 /* For removed option */
367 #define add_obsolete_inner( name, type ) \
368 add_type_inner( type ) \
369 vlc_config_set (p_config, VLC_CONFIG_NAME, \
370 (const char *)(name)); \
371 vlc_config_set (p_config, VLC_CONFIG_REMOVED);
373 #define add_obsolete_bool( name ) \
374 add_obsolete_inner( name, CONFIG_ITEM_BOOL )
376 #define add_obsolete_integer( name ) \
377 add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
379 #define add_obsolete_float( name ) \
380 add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
382 #define add_obsolete_string( name ) \
383 add_obsolete_inner( name, CONFIG_ITEM_STRING )
385 /* Modifier macros for the config options (used for fine tuning) */
387 #define add_deprecated_alias( name ) \
388 vlc_config_set (p_config, VLC_CONFIG_OLDNAME, (const char *)(name));
390 #define change_short( ch ) \
391 vlc_config_set (p_config, VLC_CONFIG_SHORTCUT, (int)(ch));
393 #define change_string_list( list, list_text, list_update_func ) \
394 vlc_config_set (p_config, VLC_CONFIG_LIST, \
395 (size_t)(sizeof (list) / sizeof (char *)), \
396 (const char *const *)(list), \
397 (const char *const *)(list_text), \
398 (vlc_callback_t)(list_update_func));
400 #define change_integer_list( list, list_text ) \
401 vlc_config_set (p_config, VLC_CONFIG_LIST, \
402 (size_t)(sizeof (list) / sizeof (int)), \
403 (const int *)(list), \
404 (const char *const *)(list_text), \
405 (vlc_callback_t)(NULL));
407 #define change_integer_range( minv, maxv ) \
408 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
409 (int64_t)(minv), (int64_t)(maxv));
411 #define change_float_range( minv, maxv ) \
412 vlc_config_set (p_config, VLC_CONFIG_RANGE, \
413 (double)(minv), (double)(maxv));
415 #define change_action_add( pf_action, text ) \
416 vlc_config_set (p_config, VLC_CONFIG_ADD_ACTION, \
417 (vlc_callback_t)(pf_action), (const char *)(text));
419 #define change_need_restart() \
420 vlc_config_set (p_config, VLC_CONFIG_RESTART);
422 #define change_autosave() \
423 vlc_config_set (p_config, VLC_CONFIG_PERSISTENT);
425 /* For options that are saved but hidden from the preferences panel */
426 #define change_private() \
427 vlc_config_set (p_config, VLC_CONFIG_PRIVATE);
429 /* For options that cannot be saved in the configuration */
430 #define change_volatile() \
432 vlc_config_set (p_config, VLC_CONFIG_VOLATILE);
434 #define change_safe() \
435 vlc_config_set (p_config, VLC_CONFIG_SAFE);
437 /* Meta data plugin exports */
438 #define VLC_META_EXPORT( name, value ) \
439 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
440 __VLC_SYMBOL(vlc_entry_ ## name) (void); \
441 EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
442 __VLC_SYMBOL(vlc_entry_ ## name) (void) \
447 #if defined (__LIBVLC__)
448 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
449 "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
450 "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
451 "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
452 "\x6c\x6f\x70\x65\x72\x73" )
453 #elif !defined (VLC_COPYRIGHT_EXPORT)
454 # define VLC_COPYRIGHT_EXPORT
456 #define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
457 "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
458 "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
459 "\x47\x4e\x55\x20\x47\x65\x6e\x65\x72\x61\x6c\x20\x50\x75\x62\x6c" \
460 "\x69\x63\x20\x4c\x69\x63\x65\x6e\x73\x65\x2c\x20\x76\x65\x72\x73" \
461 "\x69\x6f\x6e\x20\x32\x20\x6f\x72\x20\x6c\x61\x74\x65\x72\x2e" )
463 #define VLC_METADATA_EXPORTS \
464 VLC_COPYRIGHT_EXPORT \