]> git.sesse.net Git - vlc/blobdiff - include/modules.h
* modules/audio_output/directx.c: backport of directx audio changes (13374). Needs...
[vlc] / include / modules.h
index 4f806fc3e39cbbedcdf8eb149c9372086edf9637..cb2195d0264a7a54823418454b403d4f09eebf90 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * modules.h : Module management functions.
  *****************************************************************************
- * Copyright (C) 2001 VideoLAN
- * $Id: modules.h,v 1.43 2002/02/24 22:06:50 sam Exp $
+ * Copyright (C) 2001 the VideoLAN team
+ * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *
@@ -10,7 +10,7 @@
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *****************************************************************************/
 
 /* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 10000
-#define MODULE_SHORTCUT_MAX 10
+#define MODULE_HIDE_DELAY 50
+#define MODULE_SHORTCUT_MAX 50
 
 /* The module handle type. */
-#ifdef SYS_BEOS
-typedef int     module_handle_t;
-#else
-typedef void *  module_handle_t;
+#if defined(HAVE_DL_DYLD)
+#   if defined (HAVE_MACH_O_DYLD_H)
+#       include <mach-o/dyld.h>
+#   endif
+typedef NSModule module_handle_t;
+#elif defined(HAVE_IMAGE_H)
+typedef int module_handle_t;
+#elif defined(WIN32) || defined(UNDER_CE)
+typedef void * module_handle_t;
+#elif defined(HAVE_DL_DLOPEN)
+typedef void * module_handle_t;
+#elif defined(HAVE_DL_SHL_LOAD)
+typedef shl_t module_handle_t;
 #endif
 
 /*****************************************************************************
- * Module capabilities.
+ * module_bank_t: the module bank
+ *****************************************************************************
+ * This variable is accessed by any function using modules.
  *****************************************************************************/
-static __inline__ char *GetCapabilityName( unsigned int i_capa )
+struct module_bank_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[] =
-    {
-        "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 */
-    };
+    VLC_COMMON_MEMBERS
 
-    return pp_capa[ (i_capa) > MODULE_CAPABILITY_MAX ? MODULE_CAPABILITY_MAX :
-                    (i_capa) ];
-}
+    int              i_usage;
+#ifndef HAVE_SHARED_LIBVLC
+    module_symbols_t symbols;
+#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 in the bank */
-    int                 i_count;              /* Number of allocated modules */
+    vlc_bool_t       b_main;
+    vlc_bool_t       b_builtins;
+    vlc_bool_t       b_plugins;
+
+    /* Plugins cache */
+    vlc_bool_t     b_cache;
+    vlc_bool_t     b_cache_dirty;
+    vlc_bool_t     b_cache_delete;
 
-    vlc_mutex_t         lock;  /* Global lock -- you can't imagine how awful *
-                                    it is to design thread-safe linked lists */
-} module_bank_t;
+    int            i_cache;
+    module_cache_t **pp_cache;
 
-extern module_bank_t *p_module_bank;
+    int            i_loaded_cache;
+    module_cache_t **pp_loaded_cache;
+};
 
 /*****************************************************************************
  * 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_shortname;                                      /* Module 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 */
+    char    *psz_capability;                                   /* Capability */
+    int      i_score;                           /* Score for each capability */
+    uint32_t i_cpu;                             /* Required CPU capabilities */
 
-    u32   i_cpu_capabilities;                   /* Required CPU capabilities */
+    vlc_bool_t b_unloadable;                          /* Can we be dlclosed? */
+    vlc_bool_t b_reentrant;                             /* Are we reentrant? */
+    vlc_bool_t b_submodule;                          /* Is this a submodule? */
 
-    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 */
+    /* Callbacks */
+    int  ( * pf_activate )   ( vlc_object_t * );
+    void ( * pf_deactivate ) ( vlc_object_t * );
 
     /*
-     * Variables used internally by the module manager
+     * Variables set by the module to store its config options
      */
-    boolean_t           b_builtin;  /* Set to true if the module is built in */
+    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 */
 
-    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 */
+    /*
+     * Variables used internally by the module manager
+     */
+    /* Plugin-specific stuff */
+    module_handle_t     handle;                             /* Unique handle */
+    char *              psz_filename;                     /* Module filename */
 
-    struct module_s *next;                                    /* Next module */
-    struct module_s *prev;                                /* Previous module */
+    vlc_bool_t          b_builtin;  /* Set to true if the module is built in */
+    vlc_bool_t          b_loaded;        /* Set to true if the dll is loaded */
 
     /*
      * 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
+ * Module cache description structure
  *****************************************************************************/
-typedef struct function_list_s
-{
-    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
-        {
-            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;
-
-        /* Audio output plugin */
-        struct
-        {
-            int  ( * pf_open )       ( struct aout_thread_s * );
-            int  ( * pf_setformat )  ( struct aout_thread_s * );
-            int  ( * pf_getbufinfo ) ( struct aout_thread_s *, int );
-            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 * );
-        } 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_probe)( u8 * p_es );
-            int  ( * pf_run ) ( struct decoder_config_s * p_config );
-        } 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_cache_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 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;
+    /* Mandatory cache entry header */
+    char       *psz_file;
+    int64_t    i_time;
+    int64_t    i_size;
+    vlc_bool_t b_junk;
 
-} module_functions_t;
-
-typedef struct module_functions_s * p_module_functions_t;
+    /* Optional extra data */
+    module_t *p_module;
+};
 
 /*****************************************************************************
  * 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(VLC_OBJECT(a))
+void  __module_InitBank        ( vlc_object_t * );
+#define module_LoadMain(a)     __module_LoadMain(VLC_OBJECT(a))
+void  __module_LoadMain        ( vlc_object_t * );
+#define module_LoadBuiltins(a) __module_LoadBuiltins(VLC_OBJECT(a))
+void  __module_LoadBuiltins    ( vlc_object_t * );
+#define module_LoadPlugins(a)  __module_LoadPlugins(VLC_OBJECT(a))
+void  __module_LoadPlugins     ( vlc_object_t * );
+#define module_EndBank(a)      __module_EndBank(VLC_OBJECT(a))
+void  __module_EndBank         ( vlc_object_t * );
+#define module_ResetBank(a)    __module_ResetBank(VLC_OBJECT(a))
+void  __module_ResetBank       ( vlc_object_t * );
+
+#define module_Need(a,b,c,d) __module_Need(VLC_OBJECT(a),b,c,d)
+VLC_EXPORT( module_t *, __module_Need, ( vlc_object_t *, const char *, const char *, vlc_bool_t ) );
+#define module_Unneed(a,b) __module_Unneed(VLC_OBJECT(a),b)
+VLC_EXPORT( void, __module_Unneed, ( vlc_object_t *, module_t * ) );
 
-#else
-#   define module_Need p_symbols->module_Need
-#   define module_Unneed p_symbols->module_Unneed
-#endif