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

/*****************************************************************************
 * Exported functions.
 *****************************************************************************/
27

Gildas Bazin's avatar
 
Gildas Bazin committed
28
#define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
29
VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, bool ) );
30 31
#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
32
#define module_Exists(a,b) __module_Exists(VLC_OBJECT(a),b)
33
VLC_EXPORT( bool,  __module_Exists, ( vlc_object_t *, const char * ) );
34

35 36
#define module_Find(a,b) __module_Find(VLC_OBJECT(a),b)
VLC_EXPORT( module_t *, __module_Find, ( vlc_object_t *, const char * ) );
37 38
VLC_EXPORT( void, module_Put, ( module_t *module ) );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
39 40 41
VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) );

42 43 44
/* Return a NULL terminated array with the names of the modules that have a
 * certain capability.
 * Free after uses both the string and the table. */
45 46
 #define module_GetModulesNamesForCapability(a,b,c) \
                    __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)
47
VLC_EXPORT(char **, __module_GetModulesNamesForCapability,
48 49
                    ( vlc_object_t *p_this, const char * psz_capability,
                      char ***psz_longname ) );
50

51
VLC_EXPORT( bool, module_IsCapable, ( const module_t *m, const char *cap ) );
52
VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
53 54
VLC_EXPORT( const char *, module_GetName, ( const module_t *m, bool long_name ) );
#define module_GetLongName( m ) module_GetName( m, true )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
55
VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );
56 57 58 59 60


#define module_GetMainModule(a) __module_GetMainModule(VLC_OBJECT(a))
static inline module_t * __module_GetMainModule( vlc_object_t * p_this )
{
61
    return module_Find( p_this, "main" );
62 63
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
64
static inline bool module_IsMainModule( const module_t * p_module )
65 66 67
{
    return !strcmp( module_GetObjName( p_module ), "main" );
}