nice is a phony target
[vlc.git] / include / vlc_modules.h
1 /*****************************************************************************
2  * modules.h : Module descriptor and load functions
3  *****************************************************************************
4  * Copyright (C) 2001 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
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.
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 General Public License for more details.
18  *
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  *****************************************************************************/
23
24 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 /*****************************************************************************
29  * Exported functions.
30  *****************************************************************************/
31 #define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
32 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, bool ) );
33 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
34 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
35 #define module_Exists(a,b) __module_Exists(VLC_OBJECT(a),b)
36 VLC_EXPORT( bool,  __module_Exists, ( vlc_object_t *, const char * ) );
37
38 #define module_Find(a,b) __module_Find(VLC_OBJECT(a),b)
39 VLC_EXPORT( module_t *, __module_Find, ( vlc_object_t *, const char * ) );
40 VLC_EXPORT( void, module_Put, ( module_t *module ) );
41
42 VLC_EXPORT( module_config_t *, module_GetConfig, ( const module_t *, unsigned * ) );
43 VLC_EXPORT( void, module_PutConfig, ( module_config_t * ) );
44
45
46 /* Return a NULL terminated array with the names of the modules that have a
47  * certain capability.
48  * Free after uses both the string and the table. */
49  #define module_GetModulesNamesForCapability(a,b,c) \
50                     __module_GetModulesNamesForCapability(VLC_OBJECT(a),b,c)
51 VLC_EXPORT(char **, __module_GetModulesNamesForCapability,
52                     ( vlc_object_t *p_this, const char * psz_capability,
53                       char ***psz_longname ) );
54
55 VLC_EXPORT( module_t *, vlc_module_create, ( vlc_object_t * ) );
56 VLC_EXPORT( module_t *, vlc_submodule_create, ( module_t * ) );
57 VLC_EXPORT( int, vlc_module_set, (module_t *module, int propid, void *value) );
58
59 enum vlc_module_properties
60 {
61     /* DO NOT EVER REMOVE, INSERT OR REPLACE ANY ITEM! It would break the ABI!
62      * Append new items at the end ONLY. */
63     VLC_MODULE_CPU_REQUIREMENT,
64     VLC_MODULE_SHORTCUT,
65     VLC_MODULE_SHORTNAME,
66     VLC_MODULE_DESCRIPTION,
67     VLC_MODULE_HELP,
68     VLC_MODULE_CAPABILITY,
69     VLC_MODULE_SCORE,
70     VLC_MODULE_PROGRAM,
71     VLC_MODULE_CB_OPEN,
72     VLC_MODULE_CB_CLOSE,
73     VLC_MODULE_UNLOADABLE,
74     VLC_MODULE_NAME,
75 };
76
77 VLC_EXPORT( bool, module_IsCapable, ( const module_t *m, const char *cap ) );
78 VLC_EXPORT( const char *, module_GetObjName, ( const module_t *m ) );
79 VLC_EXPORT( const char *, module_GetName, ( const module_t *m, bool long_name ) );
80 #define module_GetLongName( m ) module_GetName( m, true )
81 VLC_EXPORT( const char *, module_GetHelp, ( const module_t *m ) );