]> 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 212af24828291510ea7e131a8ffa4c63b8e59a8b..cb2195d0264a7a54823418454b403d4f09eebf90 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
  * modules.h : Module management functions.
  *****************************************************************************
- * Copyright (C) 2001 VideoLAN
- * $Id: modules.h,v 1.23 2001/05/06 04:32:02 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
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
-#ifdef WIN32
-#include <sys/types.h>                                              /* off_t */
-#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 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;
-
-extern module_bank_t *p_module_bank;
-
 /*****************************************************************************
  * Module #defines.
  *****************************************************************************/
 
 /* Number of tries before we unload an unused module */
-#define MODULE_HIDE_DELAY 100
+#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.
  *****************************************************************************/
-
-#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 module_bank_t
 {
-    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;
+    VLC_COMMON_MEMBERS
 
-        /* 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_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_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 */
-        struct
-        {
-            int  ( * pf_init )         ( struct vout_thread_s * );
-            int  ( * pf_reset )        ( struct vout_thread_s * );
-            void ( * pf_end )          ( struct vout_thread_s * );
-        } yuv;
-
-    } functions;
+    int              i_usage;
+#ifndef HAVE_SHARED_LIBVLC
+    module_symbols_t symbols;
+#endif
 
-} function_list_t;
+    vlc_bool_t       b_main;
+    vlc_bool_t       b_builtins;
+    vlc_bool_t       b_plugins;
 
-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;
+    /* Plugins cache */
+    vlc_bool_t     b_cache;
+    vlc_bool_t     b_cache_dirty;
+    vlc_bool_t     b_cache_delete;
 
-} module_functions_t;
+    int            i_cache;
+    module_cache_t **pp_cache;
 
-typedef struct module_functions_s * p_module_functions_t;
+    int            i_loaded_cache;
+    module_cache_t **pp_loaded_cache;
+};
 
 /*****************************************************************************
- * Macros used to build the configuration structure.
+ * Module description 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
+struct module_t
 {
-    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;
+    VLC_COMMON_MEMBERS
+
+    /*
+     * Variables set by the module to identify itself
+     */
+    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 */
+
+    char    *psz_capability;                                   /* Capability */
+    int      i_score;                           /* Score for each capability */
+    uint32_t i_cpu;                             /* 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? */
+
+    /* Callbacks */
+    int  ( * pf_activate )   ( vlc_object_t * );
+    void ( * pf_deactivate ) ( vlc_object_t * );
+
+    /*
+     * 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
+     */
+    /* Plugin-specific stuff */
+    module_handle_t     handle;                             /* Unique handle */
+    char *              psz_filename;                     /* Module filename */
+
+    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
+     */
+    module_symbols_t *p_symbols;
+};
 
 /*****************************************************************************
- * Bank and module description structures
+ * Module cache description structure
  *****************************************************************************/
-
-/* The module description structure */
-typedef struct module_s
+struct module_cache_t
 {
-    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 */
+    /* Mandatory cache entry header */
+    char       *psz_file;
+    int64_t    i_time;
+    int64_t    i_size;
+    vlc_bool_t b_junk;
 
-} module_t;
+    /* Optional extra data */
+    module_t *p_module;
+};
 
 /*****************************************************************************
  * Exported functions.
  *****************************************************************************/
-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 );
+#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 * ) );