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.24 2001/05/15 16:19:42 sam 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 #ifdef WIN32
  25 #include <sys/types.h>                                              /* off_t */
  26 #endif
  27
  28 /*****************************************************************************
  29  * module_bank_t, p_module_bank (global variable)
  30  *****************************************************************************
  31  * This global variable is accessed by any function using modules.
  32  *****************************************************************************/
  33 typedef struct
  34 {
  35     struct module_s *   first; /* First module of the bank */
  36
  37     vlc_mutex_t         lock;  /* Global lock -- you can't imagine how awful it
  38                                   is to design thread-safe linked lists. */
  39 } module_bank_t;
  40
  41 extern module_bank_t *p_module_bank;
  42
  43 /*****************************************************************************
  44  * Module #defines.
  45  *****************************************************************************/
  46
  47 /* Number of tries before we unload an unused module */
  48 #define MODULE_HIDE_DELAY 100
  49
  50 /* The module handle type. */
  51 #ifdef SYS_BEOS
  52 typedef int     module_handle_t;
  53 #else
  54 typedef void *  module_handle_t;
  55 #endif
  56
  57 /*****************************************************************************
  58  * Module capabilities.
  59  *****************************************************************************/
  60
  61 #define MODULE_CAPABILITY_NULL     0        /* The Module can't do anything */
  62 #define MODULE_CAPABILITY_INTF     1 <<  0  /* Interface */
  63 #define MODULE_CAPABILITY_ACCESS   1 <<  1  /* Input */
  64 #define MODULE_CAPABILITY_INPUT    1 <<  2  /* Input */
  65 #define MODULE_CAPABILITY_DECAPS   1 <<  3  /* Decaps */
  66 #define MODULE_CAPABILITY_ADEC     1 <<  4  /* Audio decoder */
  67 #define MODULE_CAPABILITY_VDEC     1 <<  5  /* Video decoder */
  68 #define MODULE_CAPABILITY_MOTION   1 <<  6  /* Motion compensation */
  69 #define MODULE_CAPABILITY_IDCT     1 <<  7  /* IDCT transformation */
  70 #define MODULE_CAPABILITY_AOUT     1 <<  8  /* Audio output */
  71 #define MODULE_CAPABILITY_VOUT     1 <<  9  /* Video output */
  72 #define MODULE_CAPABILITY_YUV      1 << 10  /* YUV colorspace conversion */
  73 #define MODULE_CAPABILITY_IMDCT    1 << 11  /* IMDCT transformation */
  74 #define MODULE_CAPABILITY_DOWNMIX  1 << 12  /* AC3 downmix */
  75
  76 /* FIXME: kludge */
  77 struct input_area_s;
  78 struct imdct_s;
  79 struct complex_s;
  80 struct dm_par_s;
  81
  82 /* FIXME: not yet used */
  83 typedef struct probedata_s
  84 {
  85     struct
  86     {
  87         char * psz_data;
  88     } aout;
  89 } probedata_t;
  90
  91 /* FIXME: find a nicer way to do this. */
  92 typedef struct function_list_s
  93 {
  94     int ( * pf_probe ) ( probedata_t * p_data );
  95
  96     union
  97     {
  98         /* Interface plugin */
  99         struct
 100         {
 101             int  ( * pf_open ) ( struct intf_thread_s * );
 102             void ( * pf_close )( struct intf_thread_s * );
 103             void ( * pf_run )  ( struct intf_thread_s * );
 104         } intf;
 105
 106         /* Input plugin */
 107         struct
 108         {
 109             void ( * pf_init ) ( struct input_thread_s * );
 110             void ( * pf_open ) ( struct input_thread_s * );
 111             void ( * pf_close )( struct input_thread_s * );
 112             void ( * pf_end )  ( struct input_thread_s * );
 113
 114             int  ( * pf_read ) ( struct input_thread_s *,
 115                                  struct data_packet_s *
 116                                         pp_packets[] );
 117             void ( * pf_demux )( struct input_thread_s *,
 118                                  struct data_packet_s * );
 119
 120             struct data_packet_s * ( * pf_new_packet ) ( void *, size_t );
 121             struct pes_packet_s *  ( * pf_new_pes )    ( void * );
 122             void ( * pf_delete_packet )  ( void *, struct data_packet_s * );
 123             void ( * pf_delete_pes )     ( void *, struct pes_packet_s * );
 124
 125
 126             int  ( * pf_set_area ) ( struct input_thread_s *,
 127                                      struct input_area_s * );
 128             int  ( * pf_rewind )   ( struct input_thread_s * );
 129             void ( * pf_seek )     ( struct input_thread_s *, off_t );
 130         } input;
 131
 132         /* Audio output plugin */
 133         struct
 134         {
 135             int  ( * pf_open )       ( struct aout_thread_s * );
 136             int  ( * pf_setformat )  ( struct aout_thread_s * );
 137             long ( * pf_getbufinfo ) ( struct aout_thread_s *, long );
 138             void ( * pf_play )       ( struct aout_thread_s *, byte_t *, int );
 139             void ( * pf_close )      ( struct aout_thread_s * );
 140         } aout;
 141
 142         /* Video output plugin */
 143         struct
 144         {
 145             int  ( * pf_create )     ( struct vout_thread_s * );
 146             int  ( * pf_init )       ( struct vout_thread_s * );
 147             void ( * pf_end )        ( struct vout_thread_s * );
 148             void ( * pf_destroy )    ( struct vout_thread_s * );
 149             int  ( * pf_manage )     ( struct vout_thread_s * );
 150             void ( * pf_display )    ( struct vout_thread_s * );
 151             void ( * pf_setpalette ) ( struct vout_thread_s *, u16 *red,
 152                                        u16 *green, u16 *blue, u16 *transp );
 153         } vout;
 154
 155         /* Motion compensation plugin */
 156         struct
 157         {
 158 #define motion_functions( yuv ) \
 159             void ( * pf_field_field_##yuv ) ( struct macroblock_s * ); \
 160             void ( * pf_field_16x8_##yuv )  ( struct macroblock_s * ); \
 161             void ( * pf_field_dmv_##yuv )   ( struct macroblock_s * ); \
 162             void ( * pf_frame_field_##yuv ) ( struct macroblock_s * ); \
 163             void ( * pf_frame_frame_##yuv ) ( struct macroblock_s * ); \
 164             void ( * pf_frame_dmv_##yuv )   ( struct macroblock_s * );
 165             motion_functions( 420 )
 166             motion_functions( 422 )
 167             motion_functions( 444 )
 168 #undef motion_functions
 169         } motion;
 170
 171         /* IDCT plugin */
 172         struct
 173         {
 174             void ( * pf_idct_init )    ( struct vdec_thread_s * );
 175             void ( * pf_sparse_idct )  ( struct vdec_thread_s *,
 176                                          dctelem_t *, int );
 177             void ( * pf_idct )         ( struct vdec_thread_s *,
 178                                          dctelem_t *, int );
 179             void ( * pf_norm_scan )    ( u8 ppi_scan[2][64] );
 180
 181             void ( * pf_vdec_init )    ( struct vdec_thread_s * );
 182             void ( * pf_decode_mb_c )  ( struct vdec_thread_s *,
 183                                          struct macroblock_s * );
 184             void ( * pf_decode_mb_bw ) ( struct vdec_thread_s *,
 185                                          struct macroblock_s * );
 186         } idct;
 187
 188         /* YUV transformation plugin */
 189         struct
 190         {
 191             int  ( * pf_init )         ( struct vout_thread_s * );
 192             int  ( * pf_reset )        ( struct vout_thread_s * );
 193             void ( * pf_end )          ( struct vout_thread_s * );
 194         } yuv;
 195
 196         /* IMDCT plugin */
 197         struct
 198         {
 199             void ( * pf_imdct_init )   ( struct imdct_s * );
 200             void ( * pf_imdct_256 )    ( struct imdct_s *,
 201                                          float data[], float delay[] );
 202             void ( * pf_imdct_256_nol )( struct imdct_s *,
 203                                          float data[], float delay[] );
 204             void ( * pf_imdct_512 )    ( struct imdct_s *,
 205                                          float data[], float delay[] );
 206             void ( * pf_imdct_512_nol )( struct imdct_s *,
 207                                          float data[], float delay[] );
 208 //            void ( * pf_fft_64p )      ( struct complex_s * );
 209
 210         } imdct;
 211
 212         /* AC3 downmix plugin */
 213         struct
 214         {
 215             void ( * pf_downmix_3f_2r_to_2ch ) ( float *, struct dm_par_s * );
 216             void ( * pf_downmix_3f_1r_to_2ch ) ( float *, struct dm_par_s * );
 217             void ( * pf_downmix_2f_2r_to_2ch ) ( float *, struct dm_par_s * );
 218             void ( * pf_downmix_2f_1r_to_2ch ) ( float *, struct dm_par_s * );
 219             void ( * pf_downmix_3f_0r_to_2ch ) ( float *, struct dm_par_s * );
 220             void ( * pf_stream_sample_2ch_to_s16 ) ( s16 *, float *, float * );
 221             void ( * pf_stream_sample_1ch_to_s16 ) ( s16 *, float * );
 222
 223         } downmix;
 224
 225     } functions;
 226
 227 } function_list_t;
 228
 229 typedef struct module_functions_s
 230 {
 231     /* XXX: The order here has to be the same as above for the #defines */
 232     function_list_t intf;
 233     function_list_t access;
 234     function_list_t input;
 235     function_list_t decaps;
 236     function_list_t adec;
 237     function_list_t vdec;
 238     function_list_t motion;
 239     function_list_t idct;
 240     function_list_t aout;
 241     function_list_t vout;
 242     function_list_t yuv;
 243     function_list_t imdct;
 244     function_list_t downmix;
 245
 246 } module_functions_t;
 247
 248 typedef struct module_functions_s * p_module_functions_t;
 249
 250 /*****************************************************************************
 251  * Macros used to build the configuration structure.
 252  *****************************************************************************/
 253
 254 /* Mandatory first and last parts of the structure */
 255 #define MODULE_CONFIG_ITEM_START       0xdead  /* The main window */
 256 #define MODULE_CONFIG_ITEM_END         0xbeef  /* End of the window */
 257
 258 /* Configuration widgets */
 259 #define MODULE_CONFIG_ITEM_WINDOW      0x0001  /* The main window */
 260 #define MODULE_CONFIG_ITEM_PANE        0x0002  /* A notebook pane */
 261 #define MODULE_CONFIG_ITEM_FRAME       0x0003  /* A frame */
 262 #define MODULE_CONFIG_ITEM_COMMENT     0x0004  /* A comment text */
 263 #define MODULE_CONFIG_ITEM_STRING      0x0005  /* A string */
 264 #define MODULE_CONFIG_ITEM_FILE        0x0006  /* A file selector */
 265 #define MODULE_CONFIG_ITEM_CHECK       0x0007  /* A checkbox */
 266 #define MODULE_CONFIG_ITEM_CHOOSE      0x0008  /* A choose box */
 267 #define MODULE_CONFIG_ITEM_RADIO       0x0009  /* A radio box */
 268 #define MODULE_CONFIG_ITEM_SCALE       0x000a  /* A horizontal ruler */
 269 #define MODULE_CONFIG_ITEM_SPIN        0x000b  /* A numerical selector */
 270
 271 typedef struct module_config_s
 272 {
 273     int         i_type;                         /* Configuration widget type */
 274     char *      psz_text;        /* Text commenting or describing the widget */
 275     char *      psz_name;                                   /* Variable name */
 276     void *      p_getlist;          /* Function to call to get a choice list */
 277     void *      p_change;        /* Function to call when commiting a change */
 278 } module_config_t;
 279
 280 /*****************************************************************************
 281  * Bank and module description structures
 282  *****************************************************************************/
 283
 284 /* The module description structure */
 285 typedef struct module_s
 286 {
 287     boolean_t           b_builtin;  /* Set to true if the module is built in */
 288
 289     union
 290     {
 291         struct
 292         {
 293             module_handle_t     handle;                     /* Unique handle */
 294             char *              psz_filename;             /* Module filename */
 295
 296         } plugin;
 297
 298         struct
 299         {
 300             int ( *pf_deactivate ) ( struct module_s * );
 301
 302         } builtin;
 303
 304     } is;
 305
 306     char *              psz_name;                    /* Module _unique_ name */
 307     char *              psz_longname;             /* Module descriptive name */
 308     char *              psz_version;                       /* Module version */
 309
 310     int                 i_usage;                        /* Reference counter */
 311     int                 i_unused_delay;    /* Delay until module is unloaded */
 312
 313     struct module_s *   next;                                 /* Next module */
 314     struct module_s *   prev;                             /* Previous module */
 315
 316     module_config_t *   p_config;    /* Module configuration structure table */
 317
 318     u32                     i_capabilities;               /* Capability list */
 319     p_module_functions_t    p_functions;             /* Capability functions */
 320
 321 } module_t;
 322
 323 /*****************************************************************************
 324  * Exported functions.
 325  *****************************************************************************/
 326 void            module_InitBank     ( void );
 327 void            module_EndBank      ( void );
 328 void            module_ResetBank    ( void );
 329 void            module_ManageBank   ( void );
 330 module_t *      module_Need         ( int i_capabilities, void *p_data );
 331 void            module_Unneed       ( module_t * p_module );
 332