45a830ea885027641f1a6176cebdc0722a726f02
[vlc.git] / include / modules.h
1 /*****************************************************************************
2  * modules.h : Module management functions.
3  *****************************************************************************
4  * Copyright (C) 2001 VideoLAN
5  * $Id: modules.h,v 1.60 2002/08/15 12:11:15 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Module #defines.
26  *****************************************************************************/
27
28 /* Number of tries before we unload an unused module */
29 #define MODULE_HIDE_DELAY 50
30 #define MODULE_SHORTCUT_MAX 10
31
32 /* The module handle type. */
33 #ifdef SYS_BEOS
34 typedef int     module_handle_t;
35 #else
36 typedef void *  module_handle_t;
37 #endif
38
39 /*****************************************************************************
40  * module_bank_t: the module bank
41  *****************************************************************************
42  * This variable is accessed by any function using modules.
43  *****************************************************************************/
44 struct module_bank_t
45 {
46     VLC_COMMON_MEMBERS
47
48     module_symbols_t symbols;
49 };
50
51 /*****************************************************************************
52  * Module description structure
53  *****************************************************************************/
54 struct module_t
55 {
56     VLC_COMMON_MEMBERS
57
58     /*
59      * Variables set by the module to identify itself
60      */
61     char *psz_longname;                           /* Module descriptive name */
62
63     /*
64      * Variables set by the module to tell us what it can do
65      */
66     char *psz_program;        /* Program name which will activate the module */
67
68     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];    /* Shortcuts to the module */
69
70     char *psz_capability;                                      /* Capability */
71     int   i_score;                              /* Score for each capability */
72     u32   i_cpu;                                /* Required CPU capabilities */
73
74     vlc_bool_t b_submodule;                          /* Is this a submodule? */
75
76     /* Callbacks */
77     int  ( * pf_activate )   ( vlc_object_t * );
78     void ( * pf_deactivate ) ( vlc_object_t * );
79
80     /*
81      * Variables set by the module to store its config options
82      */
83     module_config_t *p_config;             /* Module configuration structure */
84     unsigned int     i_config_items;        /* number of configuration items */
85     unsigned int     i_bool_items;            /* number of bool config items */
86
87     /*
88      * Variables used internally by the module manager
89      */
90     /* Plugin-specific stuff */
91     module_handle_t     handle;                             /* Unique handle */
92     char *              psz_filename;                     /* Module filename */
93
94     vlc_bool_t          b_builtin;  /* Set to true if the module is built in */
95
96     /*
97      * Symbol table we send to the module so that it can access vlc symbols
98      */
99     module_symbols_t *p_symbols;
100 };
101
102 /*****************************************************************************
103  * Exported functions.
104  *****************************************************************************/
105 #define module_InitBank(a)     __module_InitBank(VLC_OBJECT(a))
106 void  __module_InitBank        ( vlc_object_t * );
107 #define module_LoadMain(a)     __module_LoadMain(VLC_OBJECT(a))
108 void  __module_LoadMain        ( vlc_object_t * );
109 #define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
110 void  __module_LoadBuiltins    ( vlc_object_t * );
111 #define module_LoadPlugins(a)  __module_LoadPlugins(VLC_OBJECT(a))
112 void  __module_LoadPlugins     ( vlc_object_t * );
113 #define module_EndBank(a)      __module_EndBank(VLC_OBJECT(a))
114 void  __module_EndBank         ( vlc_object_t * );
115 #define module_ResetBank(a)    __module_ResetBank(VLC_OBJECT(a))
116 void  __module_ResetBank       ( vlc_object_t * );
117
118 #define module_Need(a,b,c) __module_Need(VLC_OBJECT(a),b,c)
119 VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char * ) );
120 #define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
121 VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
122