vlc_modules.h 3.77 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_modules.h : Module descriptor and load functions
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2001-2011 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12
 * (at your option) any later version.
13
 *
14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26
#ifndef VLC_MODULES_H
#define VLC_MODULES_H 1

27 28 29 30 31
/**
 * \file
 * This file defines functions for modules in vlc
 */

32 33 34
typedef int (*vlc_activate_t)(void *func, va_list args);
typedef void (*vlc_deactivate_t)(void *func, va_list args);

35 36 37
/*****************************************************************************
 * Exported functions.
 *****************************************************************************/
38

39
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;
40 41
#define vlc_module_load(o,c,n,s,...) \
        vlc_module_load(VLC_OBJECT(o),c,n,s,__VA_ARGS__)
42 43 44 45
VLC_API void vlc_module_unload( vlc_object_t *obj, module_t *,
                                vlc_deactivate_t deinit, ... );
#define vlc_module_unload(o,m,d,...) \
        vlc_module_unload(VLC_OBJECT(o),m,d,__VA_ARGS__)
46

47
VLC_API module_t * module_need( vlc_object_t *, const char *, const char *, bool ) VLC_USED;
48
#define module_need(a,b,c,d) module_need(VLC_OBJECT(a),b,c,d)
49 50 51 52 53 54 55 56 57 58 59 60 61

VLC_USED
static inline module_t *module_need_var(vlc_object_t *obj, const char *cap,
                                        const char *varname)
{
    char *list = var_InheritString(obj, varname);
    module_t *m = module_need(obj, cap, list, false);

    free(list);
    return m;
}
#define module_need_var(a,b,c) module_need_var(VLC_OBJECT(a),b,c)

62
VLC_API void module_unneed( vlc_object_t *, module_t * );
63
#define module_unneed(a,b) module_unneed(VLC_OBJECT(a),b)
64 65
VLC_API bool module_exists(const char *) VLC_USED;
VLC_API module_t * module_find(const char *) VLC_USED;
66

67
VLC_API module_config_t * module_config_get( const module_t *, unsigned * ) VLC_USED;
68
VLC_API void module_config_free( module_config_t * );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
69

70
VLC_API void module_list_free(module_t **);
71
VLC_API module_t ** module_list_get(size_t *n) VLC_USED;
72

73
VLC_API bool module_provides( const module_t *m, const char *cap );
74 75
VLC_API const char * module_get_object( const module_t *m ) VLC_USED;
VLC_API const char * module_get_name( const module_t *m, bool long_name ) VLC_USED;
76
#define module_GetLongName( m ) module_get_name( m, true )
77 78 79 80
VLC_API const char * module_get_help( const module_t *m ) VLC_USED;
VLC_API const char * module_get_capability( const module_t *m ) VLC_USED;
VLC_API int module_get_score( const module_t *m ) VLC_USED;
VLC_API const char * module_gettext( const module_t *, const char * ) VLC_USED;
81

82
VLC_USED static inline module_t *module_get_main (void)
83
{
84
    return module_find ("core");
85
}
86
#define module_get_main(a) module_get_main()
87

88
VLC_USED static inline bool module_is_main( const module_t * p_module )
89
{
90
    return !strcmp( module_get_object( p_module ), "core" );
91
}
92 93

#endif /* VLC_MODULES_H */