git.sesse.net Git - vlc/blob - include/modules.h

   1 /*****************************************************************************
   2  * modules.h : Module management functions.
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  * $Id: modules.h,v 1.44 2002/03/01 00:33:18 massiot Exp $
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Module #defines.
  26  *****************************************************************************/
  27
  28 /* Number of tries before we unload an unused module */
  29 #define MODULE_HIDE_DELAY 10000
  30 #define MODULE_SHORTCUT_MAX 10
  31
  32 /* The module handle type. */
  33 #ifdef SYS_BEOS
  34 typedef int     module_handle_t;
  35 #else
  36 typedef void *  module_handle_t;
  37 #endif
  38
  39 /*****************************************************************************
  40  * Module capabilities.
  41  *****************************************************************************/
  42 static __inline__ char *GetCapabilityName( unsigned int i_capa )
  43 {
  44     /* The sole purpose of this inline function and the ugly #defines
  45      * around it is to avoid having two places to modify when adding a
  46      * new capability. */
  47     static char *pp_capa[] =
  48     {
  49         "main",
  50 #define MODULE_CAPABILITY_MAIN      0  /* Main */
  51         "interface",
  52 #define MODULE_CAPABILITY_INTF      1  /* Interface */
  53         "access",
  54 #define MODULE_CAPABILITY_ACCESS    2  /* Input */
  55         "demux",
  56 #define MODULE_CAPABILITY_DEMUX     3  /* Input */
  57         "network",
  58 #define MODULE_CAPABILITY_NETWORK   4  /* Network */
  59         "decoder",
  60 #define MODULE_CAPABILITY_DECODER   5  /* Audio or video decoder */
  61         "motion",
  62 #define MODULE_CAPABILITY_MOTION    6  /* Motion compensation */
  63         "iDCT",
  64 #define MODULE_CAPABILITY_IDCT      7  /* IDCT transformation */
  65         "audio output",
  66 #define MODULE_CAPABILITY_AOUT      8  /* Audio output */
  67         "video output",
  68 #define MODULE_CAPABILITY_VOUT      9  /* Video output */
  69         "chroma transformation",
  70 #define MODULE_CAPABILITY_CHROMA   10  /* colorspace conversion */
  71         "iMDCT",
  72 #define MODULE_CAPABILITY_IMDCT    11  /* IMDCT transformation */
  73         "downmix",
  74 #define MODULE_CAPABILITY_DOWNMIX  12  /* AC3 downmix */
  75         "memcpy",
  76 #define MODULE_CAPABILITY_MEMCPY   13  /* memcpy */
  77         "unknown"
  78 #define MODULE_CAPABILITY_MAX      14  /* Total number of capabilities */
  79     };
  80
  81     return pp_capa[ (i_capa) > MODULE_CAPABILITY_MAX ? MODULE_CAPABILITY_MAX :
  82                     (i_capa) ];
  83 }
  84
  85 /*****************************************************************************
  86  * module_bank_t, p_module_bank (global variable)
  87  *****************************************************************************
  88  * This global variable is accessed by any function using modules.
  89  *****************************************************************************/
  90 typedef struct
  91 {
  92     struct module_s *   first;                   /* First module in the bank */
  93     int                 i_count;              /* Number of allocated modules */
  94
  95     vlc_mutex_t         lock;  /* Global lock -- you can't imagine how awful *
  96                                     it is to design thread-safe linked lists */
  97 } module_bank_t;
  98
  99 extern module_bank_t *p_module_bank;
 100
 101 /*****************************************************************************
 102  * Module description structure
 103  *****************************************************************************/
 104 typedef struct module_s
 105 {
 106     /*
 107      * Variables set by the module to identify itself
 108      */
 109     char *psz_name;                                  /* Module _unique_ name */
 110     char *psz_longname;                           /* Module descriptive name */
 111
 112     /*
 113      * Variables set by the module to tell us what it can do
 114      */
 115     char *psz_program;        /* Program name which will activate the module */
 116     char *pp_shortcuts[ MODULE_SHORTCUT_MAX ];    /* Shortcuts to the module */
 117
 118     u32   i_capabilities;                                 /* Capability list */
 119     int   pi_score[ MODULE_CAPABILITY_MAX ];    /* Score for each capability */
 120
 121     u32   i_cpu_capabilities;                   /* Required CPU capabilities */
 122
 123     struct module_functions_s *p_functions;          /* Capability functions */
 124     struct module_config_s  *p_config;     /* Module configuration structure */
 125     int i_config_options;                 /* number of configuration options */
 126
 127     /*
 128      * Variables used internally by the module manager
 129      */
 130     boolean_t           b_builtin;  /* Set to true if the module is built in */
 131
 132     union
 133     {
 134         struct
 135         {
 136             module_handle_t     handle;                     /* Unique handle */
 137             char *              psz_filename;             /* Module filename */
 138
 139         } plugin;
 140
 141         struct
 142         {
 143             int ( *pf_deactivate ) ( struct module_s * );
 144
 145         } builtin;
 146
 147     } is;
 148
 149     int   i_usage;                                      /* Reference counter */
 150     int   i_unused_delay;                  /* Delay until module is unloaded */
 151
 152     struct module_s *next;                                    /* Next module */
 153     struct module_s *prev;                                /* Previous module */
 154
 155     /*
 156      * Symbol table we send to the module so that it can access vlc symbols
 157      */
 158     struct module_symbols_s *p_symbols;
 159
 160 } module_t;
 161
 162 /*****************************************************************************
 163  * Module functions description structure
 164  *****************************************************************************/
 165 typedef struct function_list_s
 166 {
 167     union
 168     {
 169         /* Interface plugin */
 170         struct
 171         {
 172             int  ( * pf_open ) ( struct intf_thread_s * );
 173             void ( * pf_close )( struct intf_thread_s * );
 174             void ( * pf_run )  ( struct intf_thread_s * );
 175         } intf;
 176
 177         /* Access plugin */
 178         struct
 179         {
 180             int  ( * pf_open ) ( struct input_thread_s * );
 181             void ( * pf_close )( struct input_thread_s * );
 182             ssize_t ( * pf_read ) ( struct input_thread_s *, byte_t *, size_t );
 183             void ( * pf_seek ) ( struct input_thread_s *, off_t );
 184             int  ( * pf_set_program ) ( struct input_thread_s *,
 185                                         struct pgrm_descriptor_s * );
 186             int  ( * pf_set_area ) ( struct input_thread_s *,
 187                                      struct input_area_s * );
 188         } access;
 189
 190         /* Demux plugin */
 191         struct
 192         {
 193             int  ( * pf_init ) ( struct input_thread_s * );
 194             void ( * pf_end )  ( struct input_thread_s * );
 195             int  ( * pf_demux )( struct input_thread_s * );
 196             int  ( * pf_rewind )   ( struct input_thread_s * );
 197         } demux;
 198
 199         /* Network plugin */
 200         struct
 201         {
 202             int  ( * pf_open )( struct network_socket_s * );
 203         } network;
 204
 205         /* Audio output plugin */
 206         struct
 207         {
 208             int  ( * pf_open )       ( struct aout_thread_s * );
 209             int  ( * pf_setformat )  ( struct aout_thread_s * );
 210             int  ( * pf_getbufinfo ) ( struct aout_thread_s *, int );
 211             void ( * pf_play )       ( struct aout_thread_s *, byte_t *, int );
 212             void ( * pf_close )      ( struct aout_thread_s * );
 213         } aout;
 214
 215         /* Video output plugin */
 216         struct
 217         {
 218             int  ( * pf_create )     ( struct vout_thread_s * );
 219             int  ( * pf_init )       ( struct vout_thread_s * );
 220             void ( * pf_end )        ( struct vout_thread_s * );
 221             void ( * pf_destroy )    ( struct vout_thread_s * );
 222             int  ( * pf_manage )     ( struct vout_thread_s * );
 223             void ( * pf_render )     ( struct vout_thread_s *,
 224                                        struct picture_s * );
 225             void ( * pf_display )    ( struct vout_thread_s *,
 226                                        struct picture_s * );
 227         } vout;
 228
 229         /* Motion compensation plugin */
 230         struct
 231         {
 232             void ( * ppppf_motion[2][2][4] ) ( yuv_data_t *, yuv_data_t *,
 233                                                int, int );
 234         } motion;
 235
 236         /* IDCT plugin */
 237         struct
 238         {
 239             void ( * pf_idct_init )    ( void ** );
 240             void ( * pf_sparse_idct_add )( dctelem_t *, yuv_data_t *, int,
 241                                          void *, int );
 242             void ( * pf_idct_add )     ( dctelem_t *, yuv_data_t *, int,
 243                                          void *, int );
 244             void ( * pf_sparse_idct_copy )( dctelem_t *, yuv_data_t *, int,
 245                                          void *, int );
 246             void ( * pf_idct_copy )    ( dctelem_t *, yuv_data_t *, int,
 247                                          void *, int );
 248             void ( * pf_norm_scan )    ( u8 ppi_scan[2][64] );
 249         } idct;
 250
 251         /* Chroma transformation plugin */
 252         struct
 253         {
 254             int  ( * pf_init )         ( struct vout_thread_s * );
 255             void ( * pf_end )          ( struct vout_thread_s * );
 256         } chroma;
 257
 258         /* IMDCT plugin */
 259         struct
 260         {
 261             void ( * pf_imdct_init )   ( struct imdct_s * );
 262             void ( * pf_imdct_256 )    ( struct imdct_s *,
 263                                          float data[], float delay[] );
 264             void ( * pf_imdct_256_nol )( struct imdct_s *,
 265                                          float data[], float delay[] );
 266             void ( * pf_imdct_512 )    ( struct imdct_s *,
 267                                          float data[], float delay[] );
 268             void ( * pf_imdct_512_nol )( struct imdct_s *,
 269                                          float data[], float delay[] );
 270 //            void ( * pf_fft_64p )      ( struct complex_s * );
 271
 272         } imdct;
 273
 274         /* AC3 downmix plugin */
 275         struct
 276         {
 277             void ( * pf_downmix_3f_2r_to_2ch ) ( float *, struct dm_par_s * );
 278             void ( * pf_downmix_3f_1r_to_2ch ) ( float *, struct dm_par_s * );
 279             void ( * pf_downmix_2f_2r_to_2ch ) ( float *, struct dm_par_s * );
 280             void ( * pf_downmix_2f_1r_to_2ch ) ( float *, struct dm_par_s * );
 281             void ( * pf_downmix_3f_0r_to_2ch ) ( float *, struct dm_par_s * );
 282             void ( * pf_stream_sample_2ch_to_s16 ) ( s16 *, float *, float * );
 283             void ( * pf_stream_sample_1ch_to_s16 ) ( s16 *, float * );
 284
 285         } downmix;
 286
 287         /* Decoder plugins */
 288         struct
 289         {
 290             int  ( * pf_probe)( u8 * p_es );
 291             int  ( * pf_run ) ( struct decoder_config_s * p_config );
 292         } dec;
 293
 294         /* memcpy plugins */
 295         struct
 296         {
 297             void* ( * pf_memcpy ) ( void *, const void *, size_t );
 298             void* ( * pf_memset ) ( void *, int, size_t );
 299         } memcpy;
 300
 301     } functions;
 302
 303 } function_list_t;
 304
 305 typedef struct module_functions_s
 306 {
 307     /* XXX: The order here has to be the same as above for the #defines */
 308     function_list_t intf;
 309     function_list_t access;
 310     function_list_t demux;
 311     function_list_t network;
 312     function_list_t dec;
 313     function_list_t motion;
 314     function_list_t idct;
 315     function_list_t aout;
 316     function_list_t vout;
 317     function_list_t chroma;
 318     function_list_t imdct;
 319     function_list_t downmix;
 320     function_list_t memcpy;
 321
 322 } module_functions_t;
 323
 324 typedef struct module_functions_s * p_module_functions_t;
 325
 326 /*****************************************************************************
 327  * Exported functions.
 328  *****************************************************************************/
 329 #ifndef PLUGIN
 330 void            module_InitBank     ( void );
 331 void            module_LoadMain     ( void );
 332 void            module_LoadBuiltins ( void );
 333 void            module_LoadPlugins  ( void );
 334 void            module_EndBank      ( void );
 335 void            module_ResetBank    ( void );
 336 void            module_ManageBank   ( void );
 337 module_t *      module_Need         ( int, char *, void * );
 338 void            module_Unneed       ( module_t * p_module );
 339
 340 #else
 341 #   define module_Need p_symbols->module_Need
 342 #   define module_Unneed p_symbols->module_Unneed
 343 #endif