keys: define Print and Pause keys
[vlc.git] / include / vlc_plugin.h
1 /*****************************************************************************
2  * vlc_plugin.h : Macros used from within a module.
3  *****************************************************************************
4  * Copyright (C) 2001-2006 VLC authors and VideoLAN
5  * Copyright © 2007-2009 Rémi Denis-Courmont
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef LIBVLC_MODULES_MACROS_H
25 # define LIBVLC_MODULES_MACROS_H 1
26
27 /**
28  * \file
29  * This file implements plugin (module) macros used to define a vlc module.
30  */
31
32 enum vlc_module_properties
33 {
34     VLC_MODULE_CREATE,
35     VLC_CONFIG_CREATE,
36
37     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
38      * Append new items at the end ONLY. */
39     VLC_MODULE_CPU_REQUIREMENT=0x100,
40     VLC_MODULE_SHORTCUT,
41     VLC_MODULE_CAPABILITY,
42     VLC_MODULE_SCORE,
43     VLC_MODULE_CB_OPEN,
44     VLC_MODULE_CB_CLOSE,
45     VLC_MODULE_NO_UNLOAD,
46     VLC_MODULE_NAME,
47     VLC_MODULE_SHORTNAME,
48     VLC_MODULE_DESCRIPTION,
49     VLC_MODULE_HELP,
50     VLC_MODULE_TEXTDOMAIN,
51     /* Insert new VLC_MODULE_* here */
52
53     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
54      * Append new items at the end ONLY. */
55     VLC_CONFIG_NAME=0x1000,
56     /* command line name (args=const char *) */
57
58     VLC_CONFIG_VALUE,
59     /* actual value (args=int/double/const char *) */
60
61     VLC_CONFIG_RANGE,
62     /* minimum value (args=int/double/const char * twice) */
63
64     VLC_CONFIG_ADVANCED,
65     /* enable advanced flag (args=none) */
66
67     VLC_CONFIG_VOLATILE,
68     /* don't write variable to storage (args=none) */
69
70     VLC_CONFIG_PERSISTENT_OBSOLETE,
71     /* unused (ignored) */
72
73     VLC_CONFIG_PRIVATE,
74     /* hide from user (args=none) */
75
76     VLC_CONFIG_REMOVED,
77     /* tag as no longer supported (args=none) */
78
79     VLC_CONFIG_CAPABILITY,
80     /* capability for a module or list thereof (args=const char*) */
81
82     VLC_CONFIG_SHORTCUT,
83     /* one-character (short) command line option name (args=char) */
84
85     VLC_CONFIG_OLDNAME_OBSOLETE,
86     /* unused (ignored) */
87
88     VLC_CONFIG_SAFE,
89     /* tag as modifiable by untrusted input item "sources" (args=none) */
90
91     VLC_CONFIG_DESC,
92     /* description (args=const char *, const char *, const char *) */
93
94     VLC_CONFIG_LIST_OBSOLETE,
95     /* unused (ignored) */
96
97     VLC_CONFIG_ADD_ACTION_OBSOLETE,
98     /* unused (ignored) */
99
100     VLC_CONFIG_LIST,
101     /* list of suggested values
102      * (args=size_t, const <type> *, const char *const *) */
103
104     VLC_CONFIG_LIST_CB,
105     /* callback for suggested values
106      * (args=size_t (*)(vlc_object_t *, <type> **, char ***)) */
107
108     /* Insert new VLC_CONFIG_* here */
109 };
110
111 /* Configuration hint types */
112 #define CONFIG_HINT_CATEGORY                0x02  /* Start of new category */
113 #define CONFIG_HINT_USAGE                   0x05  /* Usage information */
114
115 #define CONFIG_CATEGORY                     0x06 /* Set category */
116 #define CONFIG_SUBCATEGORY                  0x07 /* Set subcategory */
117 #define CONFIG_SECTION                      0x08 /* Start of new section */
118
119 /* Configuration item types */
120 #define CONFIG_ITEM_FLOAT                   0x20  /* Float option */
121 #define CONFIG_ITEM_INTEGER                 0x40  /* Integer option */
122 #define CONFIG_ITEM_RGB                     0x41  /* RGB color option */
123 #define CONFIG_ITEM_BOOL                    0x60  /* Bool option */
124 #define CONFIG_ITEM_STRING                  0x80  /* String option */
125 #define CONFIG_ITEM_PASSWORD                0x81  /* Password option (*) */
126 #define CONFIG_ITEM_KEY                     0x82  /* Hot key option */
127 #define CONFIG_ITEM_MODULE                  0x84  /* Module option */
128 #define CONFIG_ITEM_MODULE_CAT              0x85  /* Module option */
129 #define CONFIG_ITEM_MODULE_LIST             0x86  /* Module option */
130 #define CONFIG_ITEM_MODULE_LIST_CAT         0x87  /* Module option */
131 #define CONFIG_ITEM_LOADFILE                0x8C  /* Read file option */
132 #define CONFIG_ITEM_SAVEFILE                0x8D  /* Written file option */
133 #define CONFIG_ITEM_DIRECTORY               0x8E  /* Directory option */
134 #define CONFIG_ITEM_FONT                    0x8F  /* Font option */
135
136 #define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
137
138 /* Categories and subcategories */
139 #define CAT_INTERFACE 1
140 #define SUBCAT_INTERFACE_GENERAL 101
141 #define SUBCAT_INTERFACE_MAIN 102
142 #define SUBCAT_INTERFACE_CONTROL 103
143 #define SUBCAT_INTERFACE_HOTKEYS 104
144
145 #define CAT_AUDIO 2
146 #define SUBCAT_AUDIO_GENERAL 201
147 #define SUBCAT_AUDIO_AOUT 202
148 #define SUBCAT_AUDIO_AFILTER 203
149 #define SUBCAT_AUDIO_VISUAL 204
150 #define SUBCAT_AUDIO_MISC 205
151
152 #define CAT_VIDEO 3
153 #define SUBCAT_VIDEO_GENERAL 301
154 #define SUBCAT_VIDEO_VOUT 302
155 #define SUBCAT_VIDEO_VFILTER 303
156 #define SUBCAT_VIDEO_SUBPIC 305
157
158 #define CAT_INPUT 4
159 #define SUBCAT_INPUT_GENERAL 401
160 #define SUBCAT_INPUT_ACCESS 402
161 #define SUBCAT_INPUT_DEMUX 403
162 #define SUBCAT_INPUT_VCODEC 404
163 #define SUBCAT_INPUT_ACODEC 405
164 #define SUBCAT_INPUT_SCODEC 406
165 #define SUBCAT_INPUT_STREAM_FILTER 407
166
167 #define CAT_SOUT 5
168 #define SUBCAT_SOUT_GENERAL 501
169 #define SUBCAT_SOUT_STREAM 502
170 #define SUBCAT_SOUT_MUX 503
171 #define SUBCAT_SOUT_ACO 504
172 #define SUBCAT_SOUT_PACKETIZER 505
173 #define SUBCAT_SOUT_VOD 507
174
175 #define CAT_ADVANCED 6
176 #define SUBCAT_ADVANCED_MISC 602
177 #define SUBCAT_ADVANCED_NETWORK 603
178
179 #define CAT_PLAYLIST 7
180 #define SUBCAT_PLAYLIST_GENERAL 701
181 #define SUBCAT_PLAYLIST_SD 702
182 #define SUBCAT_PLAYLIST_EXPORT 703
183
184
185 /**
186  * Current plugin ABI version
187  */
188 # define MODULE_SYMBOL 2_2_0a
189 # define MODULE_SUFFIX "__2_2_0a"
190
191 /*****************************************************************************
192  * Add a few defines. You do not want to read this section. Really.
193  *****************************************************************************/
194
195 /* Explanation:
196  *
197  * if linking a module statically, we will need:
198  * #define MODULE_FUNC( zog ) module_foo_zog
199  *
200  * this can't easily be done with the C preprocessor, thus a few ugly hacks.
201  */
202
203 /* I need to do _this_ to change « foo bar » to « module_foo_bar » ! */
204 #define CONCATENATE( y, z ) CRUDE_HACK( y, z )
205 #define CRUDE_HACK( y, z )  y##__##z
206
207 /* If the module is built-in, then we need to define foo_InitModule instead
208  * of InitModule. Same for Activate- and DeactivateModule. */
209 #ifdef __PLUGIN__
210 #   define __VLC_SYMBOL( symbol  ) CONCATENATE( symbol, MODULE_SYMBOL )
211 #else
212 #   define __VLC_SYMBOL( symbol )  CONCATENATE( symbol, MODULE_NAME )
213 #endif
214
215 #define CDECL_SYMBOL
216 #if defined (__PLUGIN__)
217 # if defined (_WIN32)
218 #   define DLL_SYMBOL              __declspec(dllexport)
219 #   undef CDECL_SYMBOL
220 #   define CDECL_SYMBOL            __cdecl
221 # elif VLC_GCC_VERSION(4,0)
222 #   define DLL_SYMBOL              __attribute__((visibility("default")))
223 # else
224 #  define DLL_SYMBOL
225 # endif
226 #else
227 # define DLL_SYMBOL
228 #endif
229
230 #if defined( __cplusplus )
231 #   define EXTERN_SYMBOL           extern "C"
232 #else
233 #   define EXTERN_SYMBOL
234 #endif
235
236 typedef int (*vlc_set_cb) (void *, void *, int, ...);
237
238 #define vlc_plugin_set(...) vlc_set (opaque,   NULL, __VA_ARGS__)
239 #define vlc_module_set(...) vlc_set (opaque, module, __VA_ARGS__)
240 #define vlc_config_set(...) vlc_set (opaque, config, __VA_ARGS__)
241
242 /*
243  * InitModule: this function is called once and only once, when the module
244  * is looked at for the first time. We get the useful data from it, for
245  * instance the module name, its shortcuts, its capabilities... we also create
246  * a copy of its config because the module can be unloaded at any time.
247  */
248 #define vlc_module_begin() \
249 EXTERN_SYMBOL DLL_SYMBOL \
250 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb, void *); \
251 EXTERN_SYMBOL DLL_SYMBOL \
252 int CDECL_SYMBOL __VLC_SYMBOL(vlc_entry) (vlc_set_cb vlc_set, void *opaque) \
253 { \
254     module_t *module; \
255     module_config_t *config = NULL; \
256     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
257         goto error; \
258     if (vlc_module_set (VLC_MODULE_NAME, (MODULE_STRING))) \
259         goto error;
260
261 #define vlc_module_end() \
262     (void) config; \
263     return 0; \
264 error: \
265     return -1; \
266 } \
267 VLC_METADATA_EXPORTS
268
269 #define add_submodule( ) \
270     if (vlc_plugin_set (VLC_MODULE_CREATE, &module)) \
271         goto error;
272
273 #define add_shortcut( ... ) \
274 { \
275     const char *shortcuts[] = { __VA_ARGS__ }; \
276     if (vlc_module_set (VLC_MODULE_SHORTCUT, \
277                         sizeof(shortcuts)/sizeof(shortcuts[0]), shortcuts)) \
278         goto error; \
279 }
280
281 #define set_shortname( shortname ) \
282     if (vlc_module_set (VLC_MODULE_SHORTNAME, (const char *)(shortname))) \
283         goto error;
284
285 #define set_description( desc ) \
286     if (vlc_module_set (VLC_MODULE_DESCRIPTION, (const char *)(desc))) \
287         goto error;
288
289 #define set_help( help ) \
290     if (vlc_module_set (VLC_MODULE_HELP, (const char *)(help))) \
291         goto error;
292
293 #define set_capability( cap, score ) \
294     if (vlc_module_set (VLC_MODULE_CAPABILITY, (const char *)(cap)) \
295      || vlc_module_set (VLC_MODULE_SCORE, (int)(score))) \
296         goto error;
297
298 #define set_callbacks( activate, deactivate ) \
299     if (vlc_module_set (VLC_MODULE_CB_OPEN, activate) \
300      || vlc_module_set (VLC_MODULE_CB_CLOSE, deactivate)) \
301         goto error;
302
303 #define cannot_unload_broken_library( ) \
304     if (vlc_module_set (VLC_MODULE_NO_UNLOAD)) \
305         goto error;
306
307 #define set_text_domain( dom ) \
308     if (vlc_plugin_set (VLC_MODULE_TEXTDOMAIN, (dom))) \
309         goto error;
310
311 /*****************************************************************************
312  * Macros used to build the configuration structure.
313  *
314  * Note that internally we support only 3 types of config data: int, float
315  *   and string.
316  *   The other types declared here just map to one of these 3 basic types but
317  *   have the advantage of also providing very good hints to a configuration
318  *   interface so as to make it more user friendly.
319  * The configuration structure also includes category hints. These hints can
320  *   provide a configuration interface with some very useful data and again
321  *   allow for a more user friendly interface.
322  *****************************************************************************/
323
324 #define add_type_inner( type ) \
325     vlc_plugin_set (VLC_CONFIG_CREATE, (type), &config);
326
327 #define add_typedesc_inner( type, text, longtext ) \
328     add_type_inner( type ) \
329     vlc_config_set (VLC_CONFIG_DESC, \
330                     (const char *)(text), (const char *)(longtext));
331
332 #define add_typeadv_inner( type, text, longtext, advc ) \
333     add_typedesc_inner( type, text, longtext ) \
334     if (advc) vlc_config_set (VLC_CONFIG_ADVANCED);
335
336 #define add_typename_inner( type, name, text, longtext, advc ) \
337     add_typeadv_inner( type, text, longtext, advc ) \
338     vlc_config_set (VLC_CONFIG_NAME, (const char *)(name));
339
340 #define add_string_inner( type, name, text, longtext, advc, v ) \
341     add_typename_inner( type, name, text, longtext, advc ) \
342     vlc_config_set (VLC_CONFIG_VALUE, (const char *)(v));
343
344 #define add_int_inner( type, name, text, longtext, advc, v ) \
345     add_typename_inner( type, name, text, longtext, advc ) \
346     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(v));
347
348
349 #define set_category( i_id ) \
350     add_type_inner( CONFIG_CATEGORY ) \
351     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
352
353 #define set_subcategory( i_id ) \
354     add_type_inner( CONFIG_SUBCATEGORY ) \
355     vlc_config_set (VLC_CONFIG_VALUE, (int64_t)(i_id));
356
357 #define set_section( text, longtext ) \
358     add_typedesc_inner( CONFIG_SECTION, text, longtext )
359
360 #define add_category_hint( text, longtext, advc ) \
361     add_typeadv_inner( CONFIG_HINT_CATEGORY, text, longtext, advc )
362
363 #define add_usage_hint( text ) \
364     add_typedesc_inner( CONFIG_HINT_USAGE, text, NULL )
365
366 #define add_string( name, value, text, longtext, advc ) \
367     add_string_inner( CONFIG_ITEM_STRING, name, text, longtext, advc, \
368                       value )
369
370 #define add_password( name, value, text, longtext, advc ) \
371     add_string_inner( CONFIG_ITEM_PASSWORD, name, text, longtext, advc, \
372                       value )
373
374 #define add_loadfile( name, value, text, longtext, advc ) \
375     add_string_inner( CONFIG_ITEM_LOADFILE, name, text, longtext, advc, \
376                       value )
377
378 #define add_savefile( name, value, text, longtext, advc ) \
379     add_string_inner( CONFIG_ITEM_SAVEFILE, name, text, longtext, advc, \
380                       value )
381
382 #define add_directory( name, value, text, longtext, advc ) \
383     add_string_inner( CONFIG_ITEM_DIRECTORY, name, text, longtext, advc, \
384                       value )
385
386 #define add_font( name, value, text, longtext, advc )\
387     add_string_inner( CONFIG_ITEM_FONT, name, text, longtext, advc, \
388                       value )
389
390 #define add_module( name, psz_caps, value, text, longtext, advc ) \
391     add_string_inner( CONFIG_ITEM_MODULE, name, text, longtext, advc, \
392                       value ) \
393     vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
394
395 #define add_module_list( name, psz_caps, value, text, longtext, advc ) \
396     add_string_inner( CONFIG_ITEM_MODULE_LIST, name, text, longtext, advc, \
397                       value ) \
398     vlc_config_set (VLC_CONFIG_CAPABILITY, (const char *)(psz_caps));
399
400 #ifndef __PLUGIN__
401 #define add_module_cat( name, i_subcategory, value, text, longtext, advc ) \
402     add_string_inner( CONFIG_ITEM_MODULE_CAT, name, text, longtext, advc, \
403                       value ) \
404     change_integer_range (i_subcategory /* gruik */, 0);
405
406 #define add_module_list_cat( name, i_subcategory, value, text, longtext, advc ) \
407     add_string_inner( CONFIG_ITEM_MODULE_LIST_CAT, name, text, longtext, \
408                       advc, value ) \
409     change_integer_range (i_subcategory /* gruik */, 0);
410 #endif
411
412 #define add_integer( name, value, text, longtext, advc ) \
413     add_int_inner( CONFIG_ITEM_INTEGER, name, text, longtext, advc, value )
414
415 #define add_rgb( name, value, text, longtext, advc ) \
416     add_int_inner( CONFIG_ITEM_RGB, name, text, longtext, advc, value ) \
417     change_integer_range( 0, 0xFFFFFF )
418
419 #define add_key( name, value, text, longtext, advc ) \
420     add_string_inner( CONFIG_ITEM_KEY, "global-" name, text, longtext, advc, \
421                    KEY_UNSET ) \
422     add_string_inner( CONFIG_ITEM_KEY, name, text, longtext, advc, value )
423
424 #define add_integer_with_range( name, value, i_min, i_max, text, longtext, advc ) \
425     add_integer( name, value, text, longtext, advc ) \
426     change_integer_range( i_min, i_max )
427
428 #define add_float( name, v, text, longtext, advc ) \
429     add_typename_inner( CONFIG_ITEM_FLOAT, name, text, longtext, advc ) \
430     vlc_config_set (VLC_CONFIG_VALUE, (double)(v));
431
432 #define add_float_with_range( name, value, f_min, f_max, text, longtext, advc ) \
433     add_float( name, value, text, longtext, advc ) \
434     change_float_range( f_min, f_max )
435
436 #define add_bool( name, v, text, longtext, advc ) \
437     add_typename_inner( CONFIG_ITEM_BOOL, name, text, longtext, advc ) \
438     if (v) vlc_config_set (VLC_CONFIG_VALUE, (int64_t)true);
439
440 /* For removed option */
441 #define add_obsolete_inner( name, type ) \
442     add_type_inner( type ) \
443     vlc_config_set (VLC_CONFIG_NAME, (const char *)(name)); \
444     vlc_config_set (VLC_CONFIG_REMOVED);
445
446 #define add_obsolete_bool( name ) \
447         add_obsolete_inner( name, CONFIG_ITEM_BOOL )
448
449 #define add_obsolete_integer( name ) \
450         add_obsolete_inner( name, CONFIG_ITEM_INTEGER )
451
452 #define add_obsolete_float( name ) \
453         add_obsolete_inner( name, CONFIG_ITEM_FLOAT )
454
455 #define add_obsolete_string( name ) \
456         add_obsolete_inner( name, CONFIG_ITEM_STRING )
457
458 /* Modifier macros for the config options (used for fine tuning) */
459
460 #define change_short( ch ) \
461     vlc_config_set (VLC_CONFIG_SHORTCUT, (int)(ch));
462
463 #define change_string_list( list, list_text ) \
464     vlc_config_set (VLC_CONFIG_LIST, \
465                     (size_t)(sizeof (list) / sizeof (char *)), \
466                     (const char *const *)(list), \
467                     (const char *const *)(list_text));
468
469 #define change_string_cb( cb ) \
470     vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
471
472 #define change_integer_list( list, list_text ) \
473     vlc_config_set (VLC_CONFIG_LIST, \
474                     (size_t)(sizeof (list) / sizeof (int)), \
475                     (const int *)(list), \
476                     (const char *const *)(list_text));
477
478 #define change_integer_cb( cb ) \
479     vlc_config_set (VLC_CONFIG_LIST_CB, (cb));
480
481 #define change_integer_range( minv, maxv ) \
482     vlc_config_set (VLC_CONFIG_RANGE, (int64_t)(minv), (int64_t)(maxv));
483
484 #define change_float_range( minv, maxv ) \
485     vlc_config_set (VLC_CONFIG_RANGE, (double)(minv), (double)(maxv));
486
487 #define change_action_add( pf_action, text ) \
488     (void)(pf_action, text);
489
490 /* For options that are saved but hidden from the preferences panel */
491 #define change_private() \
492     vlc_config_set (VLC_CONFIG_PRIVATE);
493
494 /* For options that cannot be saved in the configuration */
495 #define change_volatile() \
496     change_private() \
497     vlc_config_set (VLC_CONFIG_VOLATILE);
498
499 #define change_safe() \
500     vlc_config_set (VLC_CONFIG_SAFE);
501
502 /* Meta data plugin exports */
503 #define VLC_META_EXPORT( name, value ) \
504     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
505     __VLC_SYMBOL(vlc_entry_ ## name) (void); \
506     EXTERN_SYMBOL DLL_SYMBOL const char * CDECL_SYMBOL \
507     __VLC_SYMBOL(vlc_entry_ ## name) (void) \
508     { \
509          return value; \
510     }
511
512 #if defined (__LIBVLC__)
513 # define VLC_COPYRIGHT_EXPORT VLC_META_EXPORT (copyright, \
514     "\x43\x6f\x70\x79\x72\x69\x67\x68\x74\x20\x28\x43\x29\x20\x74\x68" \
515     "\x65\x20\x56\x69\x64\x65\x6f\x4c\x41\x4e\x20\x56\x4c\x43\x20\x6d" \
516     "\x65\x64\x69\x61\x20\x70\x6c\x61\x79\x65\x72\x20\x64\x65\x76\x65" \
517     "\x6c\x6f\x70\x65\x72\x73" )
518 # define VLC_LICENSE_EXPORT VLC_META_EXPORT (license, \
519     "\x4c\x69\x63\x65\x6e\x73\x65\x64\x20\x75\x6e\x64\x65\x72\x20\x74" \
520     "\x68\x65\x20\x74\x65\x72\x6d\x73\x20\x6f\x66\x20\x74\x68\x65\x20" \
521     "\x47\x4e\x55\x20\x4c\x65\x73\x73\x65\x72\x20\x47\x65\x6e\x65\x72" \
522     "\x61\x6c\x20\x50\x75\x62\x6c\x69\x63\x20\x4c\x69\x63\x65\x6e\x73" \
523     "\x65\x2c\x20\x76\x65\x72\x73\x69\x6f\x6e\x20\x32\x2e\x31\x20\x6f" \
524     "\x72\x20\x6c\x61\x74\x65\x72\x2e" )
525 #else
526 # if !defined (VLC_COPYRIGHT_EXPORT)
527 #  define VLC_COPYRIGHT_EXPORT
528 # endif
529 # if !defined (VLC_LICENSE_EXPORT)
530 #  define VLC_LICENSE_EXPORT
531 # endif
532 #endif
533
534 #define VLC_METADATA_EXPORTS \
535     VLC_COPYRIGHT_EXPORT \
536     VLC_LICENSE_EXPORT
537
538 #endif