]> git.sesse.net Git - vlc/blobdiff - include/modules.h
* Mandatory step for video output IV and the audio output quality
[vlc] / include / modules.h
index 4e2d3dd6b2c9214b4dbd17218b7565aa19d11182..3752aad30deadb4afeaf2aed8d487f9e0a15a0cc 100644 (file)
@@ -2,6 +2,7 @@
  * modules.h : Module management functions.
  *****************************************************************************
  * Copyright (C) 2001 VideoLAN
+ * $Id: modules.h,v 1.22 2001/05/01 04:18:17 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
+
+/*****************************************************************************
+ * bank_t, p_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. */
+} bank_t;
+
+extern bank_t *p_bank;
+
+/*****************************************************************************
+ * Module #defines.
+ *****************************************************************************/
+
 /* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 10
+#define MODULE_HIDE_DELAY 100
 
 /* The module handle type. */
 #ifdef SYS_BEOS
@@ -31,8 +55,181 @@ typedef void *  module_handle_t;
 #endif
 
 /*****************************************************************************
- * Configuration structure
+ * Module capabilities.
  *****************************************************************************/
+
+#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  /* Video decoder */
+#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_AFX      1 << 11  /* Audio effects */
+#define MODULE_CAPABILITY_VFX      1 << 12  /* Video effects */
+
+/* FIXME: kludge */
+struct input_area_s;
+
+/* FIXME: not yet used */
+typedef struct probedata_s
+{
+    struct
+    {
+        char * psz_data;
+    } aout;
+} 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 * );
+
+            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;
+
+        /* 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_display )    ( struct vout_thread_s * );
+            void ( * pf_setpalette ) ( struct vout_thread_s *, u16 *red,
+                                       u16 *green, u16 *blue, u16 *transp );
+        } vout;
+
+        /* Motion compensation plugin */
+        struct
+        {
+#define motion_functions( yuv ) \
+            void ( * pf_field_field_##yuv ) ( struct macroblock_s * ); \
+            void ( * pf_field_16x8_##yuv )  ( struct macroblock_s * ); \
+            void ( * pf_field_dmv_##yuv )   ( struct macroblock_s * ); \
+            void ( * pf_frame_field_##yuv ) ( struct macroblock_s * ); \
+            void ( * pf_frame_frame_##yuv ) ( struct macroblock_s * ); \
+            void ( * pf_frame_dmv_##yuv )   ( struct macroblock_s * );
+            motion_functions( 420 )
+            motion_functions( 422 )
+            motion_functions( 444 )
+#undef motion_functions
+        } motion;
+
+        /* IDCT plugin */
+        struct
+        {
+            void ( * pf_init )         ( struct vdec_thread_s * );
+            void ( * pf_sparse_idct )  ( struct vdec_thread_s *,
+                                         dctelem_t *, int );
+            void ( * pf_idct )         ( struct vdec_thread_s *,
+                                         dctelem_t *, int );
+            void ( * pf_norm_scan )    ( u8 ppi_scan[2][64] );
+        } idct;
+
+        /* YUV 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;
+
+    } 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 adec;
+    function_list_t vdec;
+    function_list_t motion;
+    function_list_t idct;
+    function_list_t aout;
+    function_list_t vout;
+    function_list_t yuv;
+    function_list_t afx;
+    function_list_t vfx;
+
+} 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 */
@@ -46,13 +243,27 @@ typedef struct module_config_s
  * Bank and module description structures
  *****************************************************************************/
 
-/* The main module structure */
+/* The module description structure */
 typedef struct module_s
 {
     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;
+
+        struct
+        {
+            int ( *pf_deactivate ) ( struct module_s * );
+
+        } builtin;
+
+    } is;
 
     char *              psz_name;                    /* Module _unique_ name */
     char *              psz_longname;             /* Module descriptive name */
@@ -64,29 +275,20 @@ typedef struct module_s
     struct module_s *   next;                                 /* Next module */
     struct module_s *   prev;                             /* Previous module */
 
-    u32                 i_capabilities;                   /* Capability list */
-
     module_config_t *   p_config;    /* Module configuration structure table */
 
-} module_t;
+    u32                     i_capabilities;               /* Capability list */
+    p_module_functions_t    p_functions;             /* Capability functions */
 
-/* The module bank structure */
-typedef struct module_bank_s
-{
-    module_t *          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;
+} module_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 );
-
-int module_Need    ( module_t * p_module );
-int module_Unneed  ( module_t * p_module );
+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 );