1 /*****************************************************************************
2 * modules.h : Module management functions.
3 *****************************************************************************
4 * Copyright (C) 2001 VideoLAN
6 * Authors: Samuel Hocevar <sam@zoy.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
21 *****************************************************************************/
23 /* Number of tries before we unload an unused module */
24 #define MODULE_HIDE_DELAY 20
26 /* The module handle type. */
28 typedef int module_handle_t;
30 typedef void * module_handle_t;
33 /*****************************************************************************
34 * Module capabilities.
35 *****************************************************************************/
37 #define MODULE_CAPABILITY_NULL 0 /* The Module can't do anything */
38 #define MODULE_CAPABILITY_INTF 1 << 0 /* Interface */
39 #define MODULE_CAPABILITY_INPUT 1 << 1 /* Input */
40 #define MODULE_CAPABILITY_DECAPS 1 << 2 /* Decaps */
41 #define MODULE_CAPABILITY_ADEC 1 << 3 /* Audio decoder */
42 #define MODULE_CAPABILITY_VDEC 1 << 4 /* Video decoder */
43 #define MODULE_CAPABILITY_IDCT 1 << 5 /* IDCT transformation */
44 #define MODULE_CAPABILITY_AOUT 1 << 6 /* Audio output */
45 #define MODULE_CAPABILITY_VOUT 1 << 7 /* Video output */
46 #define MODULE_CAPABILITY_YUV 1 << 8 /* YUV colorspace conversion */
47 #define MODULE_CAPABILITY_AFX 1 << 9 /* Audio effects */
48 #define MODULE_CAPABILITY_VFX 1 << 10 /* Video effects */
50 /* FIXME: not yet used */
51 typedef struct probedata_s
59 /* FIXME: find a nicer way to do this. */
60 typedef struct function_list_s
62 int ( * pf_probe ) ( probedata_t * p_data );
68 int ( * pf_open ) ( struct aout_thread_s * p_aout );
69 int ( * pf_setformat ) ( struct aout_thread_s * p_aout );
70 long ( * pf_getbufinfo ) ( struct aout_thread_s * p_aout,
72 void ( * pf_play ) ( struct aout_thread_s * p_aout,
73 byte_t *buffer, int i_size );
74 void ( * pf_close ) ( struct aout_thread_s * p_aout );
79 void ( * pf_init ) ( struct vdec_thread_s * p_vdec );
80 void ( * pf_sparse_idct ) ( struct vdec_thread_s * p_vdec,
83 void ( * pf_idct ) ( struct vdec_thread_s * p_vdec,
86 void ( * pf_norm_scan ) ( u8 ppi_scan[2][64] );
91 int ( * pf_init ) ( struct vout_thread_s * p_vout );
92 int ( * pf_reset ) ( struct vout_thread_s * p_vout );
93 void ( * pf_end ) ( struct vout_thread_s * p_vout );
100 typedef struct module_functions_s
102 /* XXX: The order here has to be the same as above for the #defines */
103 function_list_t intf;
104 function_list_t input;
105 function_list_t decaps;
106 function_list_t adec;
107 function_list_t vdec;
108 function_list_t idct;
109 function_list_t aout;
110 function_list_t vout;
115 } module_functions_t;
117 typedef struct module_functions_s * p_module_functions_t;
119 /*****************************************************************************
120 * Macros used to build the configuration structure.
121 *****************************************************************************/
123 /* Mandatory first and last parts of the structure */
124 #define MODULE_CONFIG_ITEM_START 0xdead /* The main window */
125 #define MODULE_CONFIG_ITEM_END 0xbeef /* End of the window */
127 /* Configuration widgets */
128 #define MODULE_CONFIG_ITEM_WINDOW 0x0001 /* The main window */
129 #define MODULE_CONFIG_ITEM_PANE 0x0002 /* A notebook pane */
130 #define MODULE_CONFIG_ITEM_FRAME 0x0003 /* A frame */
131 #define MODULE_CONFIG_ITEM_COMMENT 0x0004 /* A comment text */
132 #define MODULE_CONFIG_ITEM_STRING 0x0005 /* A string */
133 #define MODULE_CONFIG_ITEM_FILE 0x0006 /* A file selector */
134 #define MODULE_CONFIG_ITEM_CHECK 0x0007 /* A checkbox */
135 #define MODULE_CONFIG_ITEM_CHOOSE 0x0008 /* A choose box */
136 #define MODULE_CONFIG_ITEM_RADIO 0x0009 /* A radio box */
137 #define MODULE_CONFIG_ITEM_SCALE 0x000a /* A horizontal ruler */
138 #define MODULE_CONFIG_ITEM_SPIN 0x000b /* A numerical selector */
140 typedef struct module_config_s
142 int i_type; /* Configuration widget type */
143 char * psz_text; /* Text commenting or describing the widget */
144 char * psz_name; /* Variable name */
145 void * p_getlist; /* Function to call to get a choice list */
146 void * p_change; /* Function to call when commiting a change */
149 /*****************************************************************************
150 * Bank and module description structures
151 *****************************************************************************/
153 /* The module bank structure */
154 typedef struct module_bank_s
156 struct module_s * first; /* First module of the bank */
158 vlc_mutex_t lock; /* Global lock -- you can't imagine how awful it
159 is to design thread-safe linked lists. */
162 /* The module description structure */
163 typedef struct module_s
165 boolean_t b_builtin; /* Set to true if the module is built in */
167 module_handle_t handle; /* Unique handle to refer to the module */
168 char * psz_filename; /* Module filename */
170 char * psz_name; /* Module _unique_ name */
171 char * psz_longname; /* Module descriptive name */
172 char * psz_version; /* Module version */
174 int i_usage; /* Reference counter */
175 int i_unused_delay; /* Delay until module is unloaded */
177 struct module_s * next; /* Next module */
178 struct module_s * prev; /* Previous module */
180 module_config_t * p_config; /* Module configuration structure table */
182 u32 i_capabilities; /* Capability list */
183 p_module_functions_t p_functions; /* Capability functions */
187 /*****************************************************************************
188 * Exported functions.
189 *****************************************************************************/
190 module_bank_t * module_CreateBank ( void );
191 void module_InitBank ( module_bank_t * p_bank );
192 void module_DestroyBank ( module_bank_t * p_bank );
193 void module_ResetBank ( module_bank_t * p_bank );
194 void module_ManageBank ( module_bank_t * p_bank );
196 module_t * module_Need ( module_bank_t *p_bank,
197 int i_capabilities, void *p_data );
198 void module_Unneed ( module_bank_t * p_bank,
199 module_t * p_module );