* modules.h : Module management functions.
*****************************************************************************
* Copyright (C) 2001 VideoLAN
- * $Id: modules.h,v 1.29 2001/09/05 16:07:49 massiot Exp $
+ * $Id: modules.h,v 1.57 2002/07/20 18:01:41 sam Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
-#ifdef WIN32
-#include <sys/types.h> /* off_t */
-#endif
-
-/*****************************************************************************
- * module_bank_t, p_module_bank (global variable)
- *****************************************************************************
- * This global variable is accessed by any function using modules.
- *****************************************************************************/
-typedef struct
-{
- struct module_s * first; /* First module of the bank */
-
- vlc_mutex_t lock; /* Global lock -- you can't imagine how awful it
- is to design thread-safe linked lists. */
-} module_bank_t;
-
-extern module_bank_t *p_module_bank;
-
/*****************************************************************************
* Module #defines.
*****************************************************************************/
/* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 100
+#define MODULE_HIDE_DELAY 50
+#define MODULE_SHORTCUT_MAX 10
/* The module handle type. */
#ifdef SYS_BEOS
/*****************************************************************************
* Module capabilities.
*****************************************************************************/
+#define MODULE_CAPABILITY_MAIN 0 /* Main */
+#define MODULE_CAPABILITY_INTF 1 /* Interface */
+#define MODULE_CAPABILITY_ACCESS 2 /* Input */
+#define MODULE_CAPABILITY_DEMUX 3 /* Input */
+#define MODULE_CAPABILITY_NETWORK 4 /* Network */
+#define MODULE_CAPABILITY_DECODER 5 /* Audio or video decoder */
+#define MODULE_CAPABILITY_MOTION 6 /* Motion compensation */
+#define MODULE_CAPABILITY_IDCT 7 /* IDCT transformation */
+#define MODULE_CAPABILITY_AOUT 8 /* Audio output */
+#define MODULE_CAPABILITY_AOUT_FILTER 9 /* Audio output filter */
+#define MODULE_CAPABILITY_VOUT 10 /* Video output */
+#define MODULE_CAPABILITY_VOUT_FILTER 11 /* Video output filter */
+#define MODULE_CAPABILITY_CHROMA 12 /* colorspace conversion */
+#define MODULE_CAPABILITY_IMDCT 13 /* IMDCT transformation */
+#define MODULE_CAPABILITY_DOWNMIX 14 /* AC3 downmix */
+#define MODULE_CAPABILITY_MEMCPY 15 /* memcpy */
+#define MODULE_CAPABILITY_MAX 16 /* Total number of capabilities */
+
+#define DECLARE_MODULE_CAPABILITY_TABLE \
+ static const char *ppsz_capabilities[] = \
+ { \
+ "main", \
+ "interface", \
+ "access", \
+ "demux", \
+ "network", \
+ "decoder", \
+ "motion", \
+ "iDCT", \
+ "audio output", \
+ "audio output filter", \
+ "video output", \
+ "video output filter", \
+ "chroma transformation", \
+ "iMDCT", \
+ "downmix", \
+ "memcpy", \
+ "unknown" \
+ }
+
+#define MODULE_CAPABILITY( i_capa ) \
+ ppsz_capabilities[ ((i_capa) > MODULE_CAPABILITY_MAX) ? \
+ MODULE_CAPABILITY_MAX : (i_capa) ]
-#define MODULE_CAPABILITY_NULL 0 /* The Module can't do anything */
-#define MODULE_CAPABILITY_INTF 1 << 0 /* Interface */
-#define MODULE_CAPABILITY_ACCESS 1 << 1 /* Input */
-#define MODULE_CAPABILITY_INPUT 1 << 2 /* Input */
-#define MODULE_CAPABILITY_DECAPS 1 << 3 /* Decaps */
-#define MODULE_CAPABILITY_ADEC 1 << 4 /* Audio decoder */
-#define MODULE_CAPABILITY_VDEC 1 << 5 /* Video decoder */
-#define MODULE_CAPABILITY_MOTION 1 << 6 /* Motion compensation */
-#define MODULE_CAPABILITY_IDCT 1 << 7 /* IDCT transformation */
-#define MODULE_CAPABILITY_AOUT 1 << 8 /* Audio output */
-#define MODULE_CAPABILITY_VOUT 1 << 9 /* Video output */
-#define MODULE_CAPABILITY_YUV 1 << 10 /* YUV colorspace conversion */
-#define MODULE_CAPABILITY_IMDCT 1 << 11 /* IMDCT transformation */
-#define MODULE_CAPABILITY_DOWNMIX 1 << 12 /* AC3 downmix */
-
-/* FIXME: kludge */
-struct input_area_s;
-struct imdct_s;
-struct complex_s;
-struct dm_par_s;
-struct bit_stream_s;
-struct decoder_fifo_s;
-
-/* FIXME: not yet used */
-typedef struct probedata_s
+/*****************************************************************************
+ * module_bank_t: the module bank
+ *****************************************************************************
+ * This variable is accessed by any function using modules.
+ *****************************************************************************/
+struct module_bank_t
{
- struct
- {
- char * psz_data;
- } aout;
-} probedata_t;
+ module_t * first; /* First module in the bank */
+ int i_count; /* Number of allocated modules */
+
+ vlc_mutex_t lock; /* Global lock -- you can't imagine how awful *
+ it is to design thread-safe linked lists */
+};
-/* FIXME: find a nicer way to do this. */
-typedef struct function_list_s
+/*****************************************************************************
+ * Module description structure
+ *****************************************************************************/
+struct module_t
{
- int ( * pf_probe ) ( probedata_t * p_data );
+ VLC_COMMON_MEMBERS
+
+ /*
+ * Variables set by the module to identify itself
+ */
+ char *psz_longname; /* Module descriptive name */
+
+ /*
+ * Variables set by the module to tell us what it can do
+ */
+ char *psz_program; /* Program name which will activate the module */
+ char *pp_shortcuts[ MODULE_SHORTCUT_MAX ]; /* Shortcuts to the module */
+
+ u32 i_capabilities; /* Capability list */
+ int pi_score[ MODULE_CAPABILITY_MAX ]; /* Score for each capability */
+
+ u32 i_cpu_capabilities; /* Required CPU capabilities */
+
+ module_functions_t *p_functions; /* Capability functions */
+
+ /*
+ * Variables set by the module to store its config options
+ */
+ module_config_t *p_config; /* Module configuration structure */
+ unsigned int i_config_items; /* number of configuration items */
+ unsigned int i_bool_items; /* number of bool config items */
+
+ /*
+ * Variables used internally by the module manager
+ */
+ vlc_bool_t b_builtin; /* Set to true if the module is built in */
+ union
+ {
+ struct
+ {
+ module_handle_t handle; /* Unique handle */
+ char * psz_filename; /* Module filename */
+
+ } plugin;
+
+ struct
+ {
+ int ( *pf_deactivate ) ( module_t * );
+
+ } builtin;
+
+ } is;
+
+ int i_usage; /* Reference counter */
+ int i_unused_delay; /* Delay until module is unloaded */
+
+ module_t *next; /* Next module */
+ module_t *prev; /* Previous module */
+
+ /*
+ * Symbol table we send to the module so that it can access vlc symbols
+ */
+ module_symbols_t *p_symbols;
+};
+
+/*****************************************************************************
+ * Module functions description structure
+ *****************************************************************************/
+typedef struct function_list_t
+{
union
{
/* Interface plugin */
struct
{
- int ( * pf_open ) ( struct intf_thread_s * );
- void ( * pf_close )( struct intf_thread_s * );
- void ( * pf_run ) ( struct intf_thread_s * );
+ int ( * pf_open ) ( intf_thread_t * );
+ void ( * pf_close )( intf_thread_t * );
+ void ( * pf_run ) ( intf_thread_t * );
} intf;
- /* Input plugin */
+ /* Access plugin */
struct
{
- void ( * pf_init ) ( struct input_thread_s * );
- void ( * pf_open ) ( struct input_thread_s * );
- void ( * pf_close )( struct input_thread_s * );
- void ( * pf_end ) ( struct input_thread_s * );
- void ( * pf_init_bit_stream ) ( struct bit_stream_s *,
- struct decoder_fifo_s *,
- void (* pf_bitstream_callback)( struct bit_stream_s *,
- boolean_t ),
- void * );
-
- int ( * pf_read ) ( struct input_thread_s *,
- struct data_packet_s *
- pp_packets[] );
- void ( * pf_demux )( struct input_thread_s *,
- struct data_packet_s * );
-
- struct data_packet_s * ( * pf_new_packet ) ( void *, size_t );
- struct pes_packet_s * ( * pf_new_pes ) ( void * );
- void ( * pf_delete_packet ) ( void *, struct data_packet_s * );
- void ( * pf_delete_pes ) ( void *, struct pes_packet_s * );
-
-
- int ( * pf_set_area ) ( struct input_thread_s *,
- struct input_area_s * );
- int ( * pf_rewind ) ( struct input_thread_s * );
- void ( * pf_seek ) ( struct input_thread_s *, off_t );
- } input;
+ int ( * pf_open ) ( input_thread_t * );
+ void ( * pf_close ) ( input_thread_t * );
+ ssize_t ( * pf_read ) ( input_thread_t *, byte_t *, size_t );
+ void ( * pf_seek ) ( input_thread_t *, off_t );
+ int ( * pf_set_program ) ( input_thread_t *, pgrm_descriptor_t * );
+ int ( * pf_set_area ) ( input_thread_t *, input_area_t * );
+ } access;
+
+ /* Demux plugin */
+ struct
+ {
+ int ( * pf_init ) ( input_thread_t * );
+ void ( * pf_end ) ( input_thread_t * );
+ int ( * pf_demux ) ( input_thread_t * );
+ int ( * pf_rewind ) ( input_thread_t * );
+ } demux;
+
+ /* Network plugin */
+ struct
+ {
+ int ( * pf_open ) ( vlc_object_t *, network_socket_t * );
+ } network;
/* Audio output plugin */
struct
{
- int ( * pf_open ) ( struct aout_thread_s * );
- int ( * pf_setformat ) ( struct aout_thread_s * );
- long ( * pf_getbufinfo ) ( struct aout_thread_s *, long );
- void ( * pf_play ) ( struct aout_thread_s *, byte_t *, int );
- void ( * pf_close ) ( struct aout_thread_s * );
+ int ( * pf_open ) ( aout_thread_t * );
+ int ( * pf_setformat ) ( aout_thread_t * );
+ int ( * pf_getbufinfo ) ( aout_thread_t *, int );
+ void ( * pf_play ) ( aout_thread_t *, byte_t *, int );
+ void ( * pf_close ) ( aout_thread_t * );
} aout;
/* Video output plugin */
struct
{
- int ( * pf_create ) ( struct vout_thread_s * );
- int ( * pf_init ) ( struct vout_thread_s * );
- void ( * pf_end ) ( struct vout_thread_s * );
- void ( * pf_destroy ) ( struct vout_thread_s * );
- int ( * pf_manage ) ( struct vout_thread_s * );
- void ( * pf_display ) ( struct vout_thread_s * );
- void ( * pf_setpalette ) ( struct vout_thread_s *, u16 *red,
- u16 *green, u16 *blue, u16 *transp );
+ int ( * pf_create ) ( vout_thread_t * );
+ int ( * pf_init ) ( vout_thread_t * );
+ void ( * pf_end ) ( vout_thread_t * );
+ void ( * pf_destroy ) ( vout_thread_t * );
+ int ( * pf_manage ) ( vout_thread_t * );
+ void ( * pf_render ) ( vout_thread_t *, picture_t * );
+ void ( * pf_display ) ( vout_thread_t *, picture_t * );
} vout;
/* Motion compensation plugin */
void ( * pf_norm_scan ) ( u8 ppi_scan[2][64] );
} idct;
- /* YUV transformation plugin */
+ /* Chroma transformation plugin */
struct
{
- int ( * pf_init ) ( struct vout_thread_s * );
- int ( * pf_reset ) ( struct vout_thread_s * );
- void ( * pf_end ) ( struct vout_thread_s * );
- } yuv;
+ int ( * pf_init ) ( vout_thread_t * );
+ void ( * pf_end ) ( vout_thread_t * );
+ } chroma;
/* IMDCT plugin */
struct
{
- void ( * pf_imdct_init ) ( struct imdct_s * );
- void ( * pf_imdct_256 ) ( struct imdct_s *,
- float data[], float delay[] );
- void ( * pf_imdct_256_nol )( struct imdct_s *,
- float data[], float delay[] );
- void ( * pf_imdct_512 ) ( struct imdct_s *,
- float data[], float delay[] );
- void ( * pf_imdct_512_nol )( struct imdct_s *,
- float data[], float delay[] );
-// void ( * pf_fft_64p ) ( struct complex_s * );
+ void ( * pf_imdct_init ) ( imdct_t * );
+ void ( * pf_imdct_256 ) ( imdct_t *, float [], float [] );
+ void ( * pf_imdct_256_nol )( imdct_t *, float [], float [] );
+ void ( * pf_imdct_512 ) ( imdct_t *, float [], float [] );
+ void ( * pf_imdct_512_nol )( imdct_t *, float [], float [] );
+// void ( * pf_fft_64p ) ( complex_t * );
} imdct;
/* AC3 downmix plugin */
struct
{
- void ( * pf_downmix_3f_2r_to_2ch ) ( float *, struct dm_par_s * );
- void ( * pf_downmix_3f_1r_to_2ch ) ( float *, struct dm_par_s * );
- void ( * pf_downmix_2f_2r_to_2ch ) ( float *, struct dm_par_s * );
- void ( * pf_downmix_2f_1r_to_2ch ) ( float *, struct dm_par_s * );
- void ( * pf_downmix_3f_0r_to_2ch ) ( float *, struct dm_par_s * );
+ void ( * pf_downmix_3f_2r_to_2ch ) ( float *, dm_par_t * );
+ void ( * pf_downmix_3f_1r_to_2ch ) ( float *, dm_par_t * );
+ void ( * pf_downmix_2f_2r_to_2ch ) ( float *, dm_par_t * );
+ void ( * pf_downmix_2f_1r_to_2ch ) ( float *, dm_par_t * );
+ void ( * pf_downmix_3f_0r_to_2ch ) ( float *, dm_par_t * );
void ( * pf_stream_sample_2ch_to_s16 ) ( s16 *, float *, float * );
void ( * pf_stream_sample_1ch_to_s16 ) ( s16 *, float * );
} downmix;
+ /* Decoder plugins */
+ struct
+ {
+ int ( * pf_probe)( u8 * p_es );
+ int ( * pf_run ) ( decoder_fifo_t * p_fifo );
+ } dec;
+
+ /* memcpy plugins */
+ struct
+ {
+ void* ( * pf_memcpy ) ( void *, const void *, size_t );
+ void* ( * pf_memset ) ( void *, int, size_t );
+ } memcpy;
+
} functions;
} function_list_t;
-typedef struct module_functions_s
+struct module_functions_t
{
/* XXX: The order here has to be the same as above for the #defines */
function_list_t intf;
function_list_t access;
- function_list_t input;
- function_list_t decaps;
- function_list_t adec;
- function_list_t vdec;
+ function_list_t demux;
+ function_list_t network;
+ function_list_t dec;
function_list_t motion;
function_list_t idct;
function_list_t aout;
function_list_t vout;
- function_list_t yuv;
+ function_list_t chroma;
function_list_t imdct;
function_list_t downmix;
-
-} module_functions_t;
-
-typedef struct module_functions_s * p_module_functions_t;
-
-/*****************************************************************************
- * Macros used to build the configuration structure.
- *****************************************************************************/
-
-/* Mandatory first and last parts of the structure */
-#define MODULE_CONFIG_ITEM_START 0xdead /* The main window */
-#define MODULE_CONFIG_ITEM_END 0xbeef /* End of the window */
-
-/* Configuration widgets */
-#define MODULE_CONFIG_ITEM_WINDOW 0x0001 /* The main window */
-#define MODULE_CONFIG_ITEM_PANE 0x0002 /* A notebook pane */
-#define MODULE_CONFIG_ITEM_FRAME 0x0003 /* A frame */
-#define MODULE_CONFIG_ITEM_COMMENT 0x0004 /* A comment text */
-#define MODULE_CONFIG_ITEM_STRING 0x0005 /* A string */
-#define MODULE_CONFIG_ITEM_FILE 0x0006 /* A file selector */
-#define MODULE_CONFIG_ITEM_CHECK 0x0007 /* A checkbox */
-#define MODULE_CONFIG_ITEM_CHOOSE 0x0008 /* A choose box */
-#define MODULE_CONFIG_ITEM_RADIO 0x0009 /* A radio box */
-#define MODULE_CONFIG_ITEM_SCALE 0x000a /* A horizontal ruler */
-#define MODULE_CONFIG_ITEM_SPIN 0x000b /* A numerical selector */
-
-typedef struct module_config_s
-{
- int i_type; /* Configuration widget type */
- char * psz_text; /* Text commenting or describing the widget */
- char * psz_name; /* Variable name */
- void * p_getlist; /* Function to call to get a choice list */
- void * p_change; /* Function to call when commiting a change */
-} module_config_t;
-
-/*****************************************************************************
- * Bank and module description structures
- *****************************************************************************/
-
-/* The module description structure */
-typedef struct module_s
-{
- boolean_t b_builtin; /* Set to true if the module is built in */
-
- union
- {
- struct
- {
- module_handle_t handle; /* Unique handle */
- char * psz_filename; /* Module filename */
-
- } plugin;
-
- struct
- {
- int ( *pf_deactivate ) ( struct module_s * );
-
- } builtin;
-
- } is;
-
- char * psz_name; /* Module _unique_ name */
- char * psz_longname; /* Module descriptive name */
- char * psz_version; /* Module version */
-
- int i_usage; /* Reference counter */
- int i_unused_delay; /* Delay until module is unloaded */
-
- struct module_s * next; /* Next module */
- struct module_s * prev; /* Previous module */
-
- module_config_t *p_config; /* Module configuration structure */
- struct module_symbols_s *p_symbols;
-
- u32 i_capabilities; /* Capability list */
- p_module_functions_t p_functions; /* Capability functions */
-
-} module_t;
+ function_list_t memcpy;
+};
/*****************************************************************************
* Exported functions.
*****************************************************************************/
-void module_InitBank ( void );
-void module_EndBank ( void );
-void module_ResetBank ( void );
-void module_ManageBank ( void );
-module_t * module_Need ( int i_capabilities, void *p_data );
-void module_Unneed ( module_t * p_module );
+#define module_InitBank(a) __module_InitBank(CAST_TO_VLC_OBJECT(a))
+void __module_InitBank ( vlc_object_t * );
+#define module_LoadMain(a) __module_LoadMain(CAST_TO_VLC_OBJECT(a))
+void __module_LoadMain ( vlc_object_t * );
+#define module_LoadBuiltins(a) __module_LoadBuiltins(CAST_TO_VLC_OBJECT(a))
+void __module_LoadBuiltins ( vlc_object_t * );
+#define module_LoadPlugins(a) __module_LoadPlugins(CAST_TO_VLC_OBJECT(a))
+void __module_LoadPlugins ( vlc_object_t * );
+#define module_EndBank(a) __module_EndBank(CAST_TO_VLC_OBJECT(a))
+void __module_EndBank ( vlc_object_t * );
+#define module_ResetBank(a) __module_ResetBank(CAST_TO_VLC_OBJECT(a))
+void __module_ResetBank ( vlc_object_t * );
+#define module_ManageBank(a) __module_ManageBank(CAST_TO_VLC_OBJECT(a))
+void __module_ManageBank ( vlc_object_t * );
+
+#define module_Need(a,b,c,d) __module_Need(CAST_TO_VLC_OBJECT(a),b,c,d)
+VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, int, const char *, void * ) );
+VLC_EXPORT( void, module_Unneed, ( module_t * ) );
projects / vlc / blobdiff