]> git.sesse.net Git - vlc/blobdiff - include/modules.h
* ./BUGS: added a list of known bugs. Please add your findings!
[vlc] / include / modules.h
index 33c0cbbdc74160ecef85e956a77c2fe0f4bd10a6..26e142c93d81620bcf871fc0634adc16fa9115ab 100644 (file)
@@ -2,7 +2,7 @@
  * modules.h : Module management functions.
  *****************************************************************************
  * Copyright (C) 2001 VideoLAN
- * $Id: modules.h,v 1.24 2001/05/15 16:19:42 sam Exp $
+ * $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.
  *****************************************************************************/
 
-#ifdef WIN32
-#include <sys/types.h>                                              /* off_t */
+/*****************************************************************************
+ * Module #defines.
+ *****************************************************************************/
+
+/* Number of tries before we unload an unused module */
+#define MODULE_HIDE_DELAY 10000
+#define MODULE_SHORTCUT_MAX 10
+
+/* The module handle type. */
+#ifdef SYS_BEOS
+typedef int     module_handle_t;
+#else
+typedef void *  module_handle_t;
 #endif
 
+/*****************************************************************************
+ * Module capabilities.
+ *****************************************************************************/
+static __inline__ char *GetCapabilityName( unsigned int i_capa )
+{
+    /* 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) ];
+}
+
 /*****************************************************************************
  * module_bank_t, p_module_bank (global variable)
  *****************************************************************************
  *****************************************************************************/
 typedef struct
 {
-    struct module_s *   first; /* First module of the bank */
+    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. */
+    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.
+ * 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 */
 
-/* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 100
+    /*
+     * 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 */
 
-/* The module handle type. */
-#ifdef SYS_BEOS
-typedef int     module_handle_t;
-#else
-typedef void *  module_handle_t;
-#endif
+    u32   i_capabilities;                                 /* Capability list */
+    int   pi_score[ MODULE_CAPABILITY_MAX ];    /* Score for each capability */
 
-/*****************************************************************************
- * Module capabilities.
- *****************************************************************************/
+    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 */
+
+    union
+    {
+        struct
+        {
+            module_handle_t     handle;                     /* Unique handle */
+            char *              psz_filename;             /* Module filename */
+
+        } plugin;
+
+        struct
+        {
+            int ( *pf_deactivate ) ( struct module_s * );
+
+        } builtin;
+
+    } is;
+
+    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 */
+
+    /*
+     * Symbol table we send to the module so that it can access vlc symbols
+     */
+    struct module_symbols_s *p_symbols;
+
+} module_t;
+
+/*****************************************
+ * FIXME
+ * FIXME    Capabilities
+ * FIXME
+ *******************************************/
+typedef struct memcpy_module_s
+{
+    struct module_s *p_module;
+
+    void* ( *pf_memcpy ) ( void *, const void *, size_t );
+
+} memcpy_module_t;
 
-#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;
-
-/* FIXME: not yet used */
 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. */
@@ -110,10 +213,14 @@ typedef struct function_list_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[] );
+                                 struct data_packet_s ** );
             void ( * pf_demux )( struct input_thread_s *,
                                  struct data_packet_s * );
 
@@ -122,6 +229,8 @@ typedef struct function_list_s
             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 * );
@@ -147,51 +256,42 @@ typedef struct function_list_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 );
+            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
         {
-#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
+            void ( * ppppf_motion[2][2][4] ) ( yuv_data_t *, yuv_data_t *,
+                                               int, int );
         } motion;
 
         /* IDCT plugin */
         struct
         {
-            void ( * pf_idct_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_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] );
-
-            void ( * pf_vdec_init )    ( struct vdec_thread_s * );
-            void ( * pf_decode_mb_c )  ( struct vdec_thread_s *,
-                                         struct macroblock_s * );
-            void ( * pf_decode_mb_bw ) ( struct vdec_thread_s *,
-                                         struct macroblock_s * );
         } 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;
+        } chroma;
 
         /* IMDCT plugin */
         struct
@@ -222,6 +322,18 @@ typedef struct function_list_s
 
         } 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;
@@ -233,15 +345,15 @@ typedef struct module_functions_s
     function_list_t access;
     function_list_t input;
     function_list_t decaps;
-    function_list_t adec;
-    function_list_t vdec;
+    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;
+    function_list_t memcpy;
 
 } module_functions_t;
 
@@ -277,56 +389,22 @@ typedef struct module_config_s
     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 table */
-
-    u32                     i_capabilities;               /* Capability list */
-    p_module_functions_t    p_functions;             /* Capability functions */
-
-} module_t;
-
 /*****************************************************************************
  * Exported functions.
  *****************************************************************************/
+#ifndef PLUGIN
 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 );
+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 * );
+
+#else
+#   define module_Need p_symbols->module_Need
+#   define module_Unneed p_symbols->module_Unneed
+#endif
+