LGPL
[vlc.git] / include / vlc_modules.h
1 /*****************************************************************************
2  * modules.h : Module descriptor and load functions
3  *****************************************************************************
4  * Copyright (C) 2001-2011 VLC authors and VideoLAN
5  * $Id$
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 /**
25  * \file
26  * This file defines functions for modules in vlc
27  */
28
29 typedef int (*vlc_activate_t)(void *func, va_list args);
30 typedef void (*vlc_deactivate_t)(void *func, va_list args);
31
32 /*****************************************************************************
33  * Exported functions.
34  *****************************************************************************/
35
36 VLC_API module_t * vlc_module_load( vlc_object_t *obj, const char *cap, const char *name, bool strict, vlc_activate_t probe, ... ) VLC_USED;
37 #define vlc_module_load(o,c,n,s,...) \
38         vlc_module_load(VLC_OBJECT(o),c,n,s,__VA_ARGS__)
39 VLC_API void vlc_module_unload( module_t *, vlc_deactivate_t deinit, ... );
40
41 VLC_API module_t * module_need( vlc_object_t *, const char *, const char *, bool ) VLC_USED;
42 #define module_need(a,b,c,d) module_need(VLC_OBJECT(a),b,c,d)
43 VLC_API void module_unneed( vlc_object_t *, module_t * );
44 #define module_unneed(a,b) module_unneed(VLC_OBJECT(a),b)
45 VLC_API bool module_exists(const char *) VLC_USED;
46 VLC_API module_t * module_find(const char *) VLC_USED;
47
48 int module_start(vlc_object_t *, const module_t *);
49 #define module_start(o, m) module_start(VLC_OBJECT(o),m)
50 void module_stop(vlc_object_t *, const module_t *);
51 #define module_stop(o, m) module_stop(VLC_OBJECT(o),m)
52
53 VLC_API module_config_t * module_config_get( const module_t *, unsigned * ) VLC_USED;
54 VLC_API void module_config_free( module_config_t * );
55
56 VLC_API void module_list_free(module_t **);
57 VLC_API module_t ** module_list_get(size_t *n) VLC_USED;
58
59 VLC_API bool module_provides( const module_t *m, const char *cap );
60 VLC_API const char * module_get_object( const module_t *m ) VLC_USED;
61 VLC_API const char * module_get_name( const module_t *m, bool long_name ) VLC_USED;
62 #define module_GetLongName( m ) module_get_name( m, true )
63 VLC_API const char * module_get_help( const module_t *m ) VLC_USED;
64 VLC_API const char * module_get_capability( const module_t *m ) VLC_USED;
65 VLC_API int module_get_score( const module_t *m ) VLC_USED;
66 VLC_API const char * module_gettext( const module_t *, const char * ) VLC_USED;
67
68 VLC_USED static inline module_t *module_get_main (void)
69 {
70     return module_find ("main");
71 }
72 #define module_get_main(a) module_get_main()
73
74 VLC_USED static inline bool module_is_main( const module_t * p_module )
75 {
76     return !strcmp( module_get_object( p_module ), "main" );
77 }