* modules.h : Module management functions.
*****************************************************************************
* Copyright (C) 2001 VideoLAN
+ * $Id: modules.h,v 1.39 2002/01/04 14:01:34 sam Exp $
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
*****************************************************************************/
+/*****************************************************************************
+ * Module #defines.
+ *****************************************************************************/
+
/* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 10
+#define MODULE_HIDE_DELAY 10000
+#define MODULE_SHORTCUT_MAX 10
/* The module handle type. */
#ifdef SYS_BEOS
#endif
/*****************************************************************************
- * Configuration structure
+ * Module capabilities.
*****************************************************************************/
-typedef struct module_config_s
+static __inline__ char *GetCapabilityName( unsigned int i_capa )
{
- 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;
+ /* The sole purpose of this inline function and the ugly #defines
+ * around it is to avoid having two places to modify when adding a
+ * new capability. */
+ static char *pp_capa[] =
+ {
+ "interface",
+#define MODULE_CAPABILITY_INTF 0 /* Interface */
+ "access",
+#define MODULE_CAPABILITY_ACCESS 1 /* Input */
+ "input",
+#define MODULE_CAPABILITY_INPUT 2 /* Input */
+ "decaps",
+#define MODULE_CAPABILITY_DECAPS 3 /* Decaps */
+ "decoder",
+#define MODULE_CAPABILITY_DECODER 4 /* Audio or video decoder */
+ "motion",
+#define MODULE_CAPABILITY_MOTION 5 /* Motion compensation */
+ "iDCT",
+#define MODULE_CAPABILITY_IDCT 6 /* IDCT transformation */
+ "audio output",
+#define MODULE_CAPABILITY_AOUT 7 /* Audio output */
+ "video output",
+#define MODULE_CAPABILITY_VOUT 8 /* Video output */
+ "chroma transformation",
+#define MODULE_CAPABILITY_CHROMA 9 /* colorspace conversion */
+ "iMDCT",
+#define MODULE_CAPABILITY_IMDCT 10 /* IMDCT transformation */
+ "downmix",
+#define MODULE_CAPABILITY_DOWNMIX 11 /* AC3 downmix */
+ "memcpy",
+#define MODULE_CAPABILITY_MEMCPY 12 /* memcpy */
+ "unknown"
+#define MODULE_CAPABILITY_MAX 13 /* Total number of capabilities */
+ };
+
+ return pp_capa[ (i_capa) > MODULE_CAPABILITY_MAX ? MODULE_CAPABILITY_MAX :
+ (i_capa) ];
+}
/*****************************************************************************
- * Bank and module description structures
+ * 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 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 */
+} module_bank_t;
-/* The main module structure */
+extern module_bank_t *p_module_bank;
+
+/*****************************************************************************
+ * Module description structure
+ *****************************************************************************/
typedef struct module_s
{
+ /*
+ * Variables set by the module to identify itself
+ */
+ char *psz_name; /* Module _unique_ name */
+ 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 */
+
+ struct module_functions_s *p_functions; /* Capability functions */
+ struct module_config_s *p_config; /* Module configuration structure */
+
+ /*
+ * Variables used internally by the module manager
+ */
boolean_t b_builtin; /* Set to true if the module is built in */
- module_handle_t handle; /* Unique handle to refer to the module */
- char * psz_filename; /* Module filename */
+ union
+ {
+ struct
+ {
+ module_handle_t handle; /* Unique handle */
+ char * psz_filename; /* Module filename */
+
+ } plugin;
- char * psz_name; /* Module _unique_ name */
- char * psz_longname; /* Module descriptive name */
- char * psz_version; /* Module version */
+ struct
+ {
+ int ( *pf_deactivate ) ( struct module_s * );
- int i_usage; /* Reference counter */
- int i_unused_delay; /* Delay until module is unloaded */
+ } builtin;
- struct module_s * next; /* Next module */
- struct module_s * prev; /* Previous module */
+ } is;
- u32 i_capabilities; /* Capability list */
+ int i_usage; /* Reference counter */
+ int i_unused_delay; /* Delay until module is unloaded */
- module_config_t * p_config; /* Module configuration structure table */
+ struct module_s *next; /* Next module */
+ struct module_s *prev; /* Previous module */
+
+ /*
+ * Symbol table we send to the module so that it can access vlc symbols
+ */
+ struct module_symbols_s *p_symbols;
} module_t;
-/* The module bank structure */
-typedef struct module_bank_s
+/*****************************************
+ * FIXME
+ * FIXME Capabilities
+ * FIXME
+ *******************************************/
+typedef struct memcpy_module_s
{
- module_t * first; /* First module of the bank */
+ struct module_s *p_module;
- vlc_mutex_t lock; /* Global lock -- you can't imagine how awful it
- is to design thread-safe linked lists. */
-} module_bank_t;
+ void* ( *pf_memcpy ) ( void *, const void *, size_t );
+
+} memcpy_module_t;
+
+typedef struct probedata_s
+{
+ u8 i_type;
+
+ struct
+ {
+ char * psz_data;
+ } aout;
+
+ struct
+ {
+ u32 i_chroma;
+ } vout;
+
+ struct
+ {
+ struct picture_heap_s* p_output;
+ struct picture_heap_s* p_render;
+ } chroma;
+
+} probedata_t;
+
+/* FIXME: find a nicer way to do this. */
+typedef struct function_list_s
+{
+ int ( * pf_probe ) ( probedata_t * p_data );
+
+ 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 * );
+ } intf;
+
+ /* Input 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 ** );
+ 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_program ) ( struct input_thread_s *,
+ struct pgrm_descriptor_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;
+
+ /* 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 * );
+ } 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_render ) ( struct vout_thread_s *,
+ struct picture_s * );
+ void ( * pf_display ) ( struct vout_thread_s *,
+ struct picture_s * );
+ void ( * pf_setpalette ) ( struct vout_thread_s *,
+ u16 *, u16 *, u16 * );
+ } vout;
+
+ /* Motion compensation plugin */
+ struct
+ {
+ void ( * ppppf_motion[2][2][4] ) ( yuv_data_t *, yuv_data_t *,
+ int, int );
+ } motion;
+
+ /* IDCT plugin */
+ struct
+ {
+ void ( * pf_idct_init ) ( void ** );
+ void ( * pf_sparse_idct_add )( dctelem_t *, yuv_data_t *, int,
+ void *, int );
+ void ( * pf_idct_add ) ( dctelem_t *, yuv_data_t *, int,
+ void *, int );
+ void ( * pf_sparse_idct_copy )( dctelem_t *, yuv_data_t *, int,
+ void *, int );
+ void ( * pf_idct_copy ) ( dctelem_t *, yuv_data_t *, int,
+ void *, int );
+ void ( * pf_norm_scan ) ( u8 ppi_scan[2][64] );
+ } idct;
+
+ /* Chroma transformation plugin */
+ struct
+ {
+ int ( * pf_init ) ( struct vout_thread_s * );
+ void ( * pf_end ) ( struct vout_thread_s * );
+ } 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 * );
+
+ } 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_stream_sample_2ch_to_s16 ) ( s16 *, float *, float * );
+ void ( * pf_stream_sample_1ch_to_s16 ) ( s16 *, float * );
+
+ } downmix;
+
+ /* Decoder plugins */
+ struct
+ {
+ int ( * pf_run ) ( struct decoder_config_s * p_config );
+ } dec;
+
+ /* memcpy plugins */
+ struct
+ {
+ void* ( * fast_memcpy ) ( void *, const void *, size_t );
+ } memcpy;
+
+ } functions;
+
+} function_list_t;
+
+typedef struct module_functions_s
+{
+ /* 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 dec;
+ function_list_t motion;
+ function_list_t idct;
+ function_list_t aout;
+ function_list_t vout;
+ function_list_t chroma;
+ function_list_t imdct;
+ function_list_t downmix;
+ function_list_t memcpy;
+
+} 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;
/*****************************************************************************
* Exported functions.
*****************************************************************************/
-module_bank_t * module_InitBank ( void );
-int module_DestroyBank ( module_bank_t * p_bank );
-int module_ResetBank ( module_bank_t * p_bank );
-void module_ManageBank ( module_bank_t * p_bank );
+#ifndef PLUGIN
+void module_InitBank ( void );
+void module_EndBank ( void );
+void module_ResetBank ( void );
+void module_ManageBank ( void );
+module_t * module_Need ( int, char *, probedata_t * );
+void module_Unneed ( module_t * p_module );
+
+int module_NeedMemcpy( memcpy_module_t * );
+void module_UnneedMemcpy( memcpy_module_t * );
-int module_Need ( module_t * p_module );
-int module_Unneed ( module_t * p_module );
+#else
+# define module_Need p_symbols->module_Need
+# define module_Unneed p_symbols->module_Unneed
+#endif
projects / vlc / blobdiff