]> git.sesse.net Git - vlc/blobdiff - include/modules.h
* ALL: changed "struct foo_s" into "struct foo_t" to make greppers happy.
[vlc] / include / modules.h
index 230c400990568612489d62970394a88e0a252023..ff36725ffe3ef5b9c5b73d8ae981bb1f4d7d26cf 100644 (file)
@@ -2,7 +2,7 @@
  * modules.h : Module management functions.
  *****************************************************************************
  * Copyright (C) 2001 VideoLAN
- * $Id: modules.h,v 1.42 2002/02/24 20:51:09 gbazin Exp $
+ * $Id: modules.h,v 1.57 2002/07/20 18:01:41 sam Exp $
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
@@ -26,7 +26,7 @@
  *****************************************************************************/
 
 /* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 10000
+#define MODULE_HIDE_DELAY 50
 #define MODULE_SHORTCUT_MAX 10
 
 /* The module handle type. */
@@ -39,74 +39,74 @@ typedef void *  module_handle_t;
 /*****************************************************************************
  * 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[] =
-    {
-        "main",
-#define MODULE_CAPABILITY_MAIN      0  /* Main */
-        "interface",
-#define MODULE_CAPABILITY_INTF      1  /* Interface */
-        "access",
-#define MODULE_CAPABILITY_ACCESS    2  /* Input */
-        "input",
-#define MODULE_CAPABILITY_INPUT     3  /* Input */
-        "decaps",
-#define MODULE_CAPABILITY_DECAPS    4  /* Decaps */
-        "decoder",
-#define MODULE_CAPABILITY_DECODER   5  /* Audio or video decoder */
-        "motion",
-#define MODULE_CAPABILITY_MOTION    6  /* Motion compensation */
-        "iDCT",
-#define MODULE_CAPABILITY_IDCT      7  /* IDCT transformation */
-        "audio output",
-#define MODULE_CAPABILITY_AOUT      8  /* Audio output */
-        "video output",
-#define MODULE_CAPABILITY_VOUT      9  /* Video output */
-        "chroma transformation",
-#define MODULE_CAPABILITY_CHROMA   10  /* colorspace conversion */
-        "iMDCT",
-#define MODULE_CAPABILITY_IMDCT    11  /* IMDCT transformation */
-        "downmix",
-#define MODULE_CAPABILITY_DOWNMIX  12  /* AC3 downmix */
-        "memcpy",
-#define MODULE_CAPABILITY_MEMCPY   13  /* memcpy */
-        "unknown"
-#define MODULE_CAPABILITY_MAX      14  /* Total number of capabilities */
-    };
-
-    return pp_capa[ (i_capa) > MODULE_CAPABILITY_MAX ? MODULE_CAPABILITY_MAX :
-                    (i_capa) ];
-}
+#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) ]
 
 /*****************************************************************************
- * module_bank_t, p_module_bank (global variable)
+ * module_bank_t: the module bank
  *****************************************************************************
- * This global variable is accessed by any function using modules.
+ * This variable is accessed by any function using modules.
  *****************************************************************************/
-typedef struct
+struct module_bank_t
 {
-    struct module_s *   first;                   /* First module in the bank */
-    int                 i_count;              /* Number of allocated modules */
+    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 *
+    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 description structure
  *****************************************************************************/
-typedef struct module_s
+struct module_t
 {
+    VLC_COMMON_MEMBERS
+
     /*
      * Variables set by the module to identify itself
      */
-    char *psz_name;                                  /* Module _unique_ name */
     char *psz_longname;                           /* Module descriptive name */
 
     /*
@@ -120,14 +120,19 @@ typedef struct module_s
 
     u32   i_cpu_capabilities;                   /* Required CPU capabilities */
 
-    struct module_functions_s *p_functions;          /* Capability functions */
-    struct module_config_s  *p_config;     /* Module configuration structure */
-    int i_config_options;                 /* number of configuration options */
+    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
      */
-    boolean_t           b_builtin;  /* Set to true if the module is built in */
+    vlc_bool_t          b_builtin;  /* Set to true if the module is built in */
 
     union
     {
@@ -140,7 +145,7 @@ typedef struct module_s
 
         struct
         {
-            int ( *pf_deactivate ) ( struct module_s * );
+            int ( *pf_deactivate ) ( module_t * );
 
         } builtin;
 
@@ -149,86 +154,76 @@ typedef struct module_s
     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_t *next;                                           /* Next module */
+    module_t *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;
+    module_symbols_t *p_symbols;
+};
 
 /*****************************************************************************
  * Module functions description structure
  *****************************************************************************/
-typedef struct function_list_s
+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
         {
-            int  ( * pf_probe )( struct input_thread_s * );
-            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;
+            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_render )     ( struct vout_thread_s *,
-                                       struct picture_s * );
-            void ( * pf_display )    ( struct vout_thread_s *,
-                                       struct picture_s * );
+            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 */
@@ -256,34 +251,30 @@ typedef struct function_list_s
         /* Chroma transformation plugin */
         struct
         {
-            int  ( * pf_init )         ( struct vout_thread_s * );
-            void ( * pf_end )          ( struct vout_thread_s * );
+            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 * );
 
@@ -293,7 +284,7 @@ typedef struct function_list_s
         struct
         {
             int  ( * pf_probe)( u8 * p_es );
-            int  ( * pf_run ) ( struct decoder_config_s * p_config );
+            int  ( * pf_run ) ( decoder_fifo_t * p_fifo );
         } dec;
 
         /* memcpy plugins */
@@ -307,13 +298,13 @@ typedef struct function_list_s
 
 } 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 demux;
+    function_list_t network;
     function_list_t dec;
     function_list_t motion;
     function_list_t idct;
@@ -323,26 +314,27 @@ typedef struct module_functions_s
     function_list_t imdct;
     function_list_t downmix;
     function_list_t memcpy;
-
-} module_functions_t;
-
-typedef struct module_functions_s * p_module_functions_t;
+};
 
 /*****************************************************************************
  * Exported functions.
  *****************************************************************************/
-#ifndef PLUGIN
-void            module_InitBank     ( void );
-void            module_LoadMain     ( void );
-void            module_LoadBuiltins ( void );
-void            module_LoadPlugins  ( void );
-void            module_EndBank      ( void );
-void            module_ResetBank    ( void );
-void            module_ManageBank   ( void );
-module_t *      module_Need         ( int, char *, void * );
-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 * ) );
 
-#else
-#   define module_Need p_symbols->module_Need
-#   define module_Unneed p_symbols->module_Unneed
-#endif