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

   1 /*****************************************************************************
   2  * modules.h : Module management functions.
   3  *****************************************************************************
   4  * Copyright (C) 2001 VideoLAN
   5  *
   6  * Authors: Samuel Hocevar <sam@zoy.org>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  21  *****************************************************************************/
  22
  23 /* Number of tries before we unload an unused module */
  24 #define MODULE_HIDE_DELAY 20
  25
  26 /* The module handle type. */
  27 #ifdef SYS_BEOS
  28 typedef int     module_handle_t;
  29 #else
  30 typedef void *  module_handle_t;
  31 #endif
  32
  33 /*****************************************************************************
  34  * Module capabilities.
  35  *****************************************************************************/
  36
  37 #define MODULE_CAPABILITY_NULL     0        /* The Module can't do anything */
  38 #define MODULE_CAPABILITY_INTF     1 <<  0  /* Interface */
  39 #define MODULE_CAPABILITY_ACCESS   1 <<  1  /* Input */
  40 #define MODULE_CAPABILITY_INPUT    1 <<  2  /* Input */
  41 #define MODULE_CAPABILITY_DECAPS   1 <<  3  /* Decaps */
  42 #define MODULE_CAPABILITY_ADEC     1 <<  4  /* Audio decoder */
  43 #define MODULE_CAPABILITY_VDEC     1 <<  5  /* Video decoder */
  44 #define MODULE_CAPABILITY_MOTION   1 <<  6  /* Video decoder */
  45 #define MODULE_CAPABILITY_IDCT     1 <<  7  /* IDCT transformation */
  46 #define MODULE_CAPABILITY_AOUT     1 <<  8  /* Audio output */
  47 #define MODULE_CAPABILITY_VOUT     1 <<  9  /* Video output */
  48 #define MODULE_CAPABILITY_YUV      1 << 10  /* YUV colorspace conversion */
  49 #define MODULE_CAPABILITY_AFX      1 << 11  /* Audio effects */
  50 #define MODULE_CAPABILITY_VFX      1 << 12  /* Video effects */
  51
  52 /* FIXME: not yet used */
  53 typedef struct probedata_s
  54 {
  55     struct
  56     {
  57         char * psz_data;
  58     } aout;
  59 } probedata_t;
  60
  61 /* FIXME: find a nicer way to do this. */
  62 typedef struct function_list_s
  63 {
  64     int ( * pf_probe ) ( probedata_t * p_data );
  65
  66     union
  67     {
  68         /* Input plugin */
  69         struct
  70         {
  71             void ( * pf_init ) ( struct input_thread_s * );
  72             void ( * pf_open ) ( struct input_thread_s * );
  73             void ( * pf_close )( struct input_thread_s * );
  74             void ( * pf_end )  ( struct input_thread_s * );
  75
  76             int  ( * pf_read ) ( struct input_thread_s *,
  77                                  struct data_packet_s *
  78                                         pp_packets[] );
  79             void ( * pf_demux )( struct input_thread_s *,
  80                                  struct data_packet_s * );
  81
  82             struct data_packet_s * ( * pf_new_packet ) ( void *, size_t );
  83             struct pes_packet_s *  ( * pf_new_pes )    ( void * );
  84             void ( * pf_delete_packet )  ( void *, struct data_packet_s * );
  85             void ( * pf_delete_pes )     ( void *, struct pes_packet_s * );
  86
  87             int  ( * pf_rewind ) ( struct input_thread_s * );
  88             int  ( * pf_seek )   ( struct input_thread_s *, off_t );
  89         } input;
  90
  91         /* Audio output plugin */
  92         struct
  93         {
  94             int  ( * pf_open )       ( struct aout_thread_s * );
  95             int  ( * pf_setformat )  ( struct aout_thread_s * );
  96             long ( * pf_getbufinfo ) ( struct aout_thread_s *, long );
  97             void ( * pf_play )       ( struct aout_thread_s *, byte_t *, int );
  98             void ( * pf_close )      ( struct aout_thread_s * );
  99         } aout;
 100
 101         /* Motion compensation plugin */
 102         struct
 103         {
 104 #define motion_functions( yuv ) \
 105             void ( * pf_field_field_##yuv ) ( struct macroblock_s * ); \
 106             void ( * pf_field_16x8_##yuv )  ( struct macroblock_s * ); \
 107             void ( * pf_field_dmv_##yuv )   ( struct macroblock_s * ); \
 108             void ( * pf_frame_field_##yuv ) ( struct macroblock_s * ); \
 109             void ( * pf_frame_frame_##yuv ) ( struct macroblock_s * ); \
 110             void ( * pf_frame_dmv_##yuv )   ( struct macroblock_s * );
 111             motion_functions( 420 )
 112             motion_functions( 422 )
 113             motion_functions( 444 )
 114 #undef motion_functions
 115         } motion;
 116
 117         /* IDCT plugin */
 118         struct
 119         {
 120             void ( * pf_init )         ( struct vdec_thread_s * );
 121             void ( * pf_sparse_idct )  ( struct vdec_thread_s *,
 122                                          dctelem_t *, int );
 123             void ( * pf_idct )         ( struct vdec_thread_s *,
 124                                          dctelem_t *, int );
 125             void ( * pf_norm_scan )    ( u8 ppi_scan[2][64] );
 126         } idct;
 127
 128         /* YUV transformation plugin */
 129         struct
 130         {
 131             int  ( * pf_init )         ( struct vout_thread_s * );
 132             int  ( * pf_reset )        ( struct vout_thread_s * );
 133             void ( * pf_end )          ( struct vout_thread_s * );
 134         } yuv;
 135
 136     } functions;
 137
 138 } function_list_t;
 139
 140 typedef struct module_functions_s
 141 {
 142     /* XXX: The order here has to be the same as above for the #defines */
 143     function_list_t intf;
 144     function_list_t access;
 145     function_list_t input;
 146     function_list_t decaps;
 147     function_list_t adec;
 148     function_list_t vdec;
 149     function_list_t motion;
 150     function_list_t idct;
 151     function_list_t aout;
 152     function_list_t vout;
 153     function_list_t yuv;
 154     function_list_t afx;
 155     function_list_t vfx;
 156
 157 } module_functions_t;
 158
 159 typedef struct module_functions_s * p_module_functions_t;
 160
 161 /*****************************************************************************
 162  * Macros used to build the configuration structure.
 163  *****************************************************************************/
 164
 165 /* Mandatory first and last parts of the structure */
 166 #define MODULE_CONFIG_ITEM_START       0xdead  /* The main window */
 167 #define MODULE_CONFIG_ITEM_END         0xbeef  /* End of the window */
 168
 169 /* Configuration widgets */
 170 #define MODULE_CONFIG_ITEM_WINDOW      0x0001  /* The main window */
 171 #define MODULE_CONFIG_ITEM_PANE        0x0002  /* A notebook pane */
 172 #define MODULE_CONFIG_ITEM_FRAME       0x0003  /* A frame */
 173 #define MODULE_CONFIG_ITEM_COMMENT     0x0004  /* A comment text */
 174 #define MODULE_CONFIG_ITEM_STRING      0x0005  /* A string */
 175 #define MODULE_CONFIG_ITEM_FILE        0x0006  /* A file selector */
 176 #define MODULE_CONFIG_ITEM_CHECK       0x0007  /* A checkbox */
 177 #define MODULE_CONFIG_ITEM_CHOOSE      0x0008  /* A choose box */
 178 #define MODULE_CONFIG_ITEM_RADIO       0x0009  /* A radio box */
 179 #define MODULE_CONFIG_ITEM_SCALE       0x000a  /* A horizontal ruler */
 180 #define MODULE_CONFIG_ITEM_SPIN        0x000b  /* A numerical selector */
 181
 182 typedef struct module_config_s
 183 {
 184     int         i_type;                         /* Configuration widget type */
 185     char *      psz_text;        /* Text commenting or describing the widget */
 186     char *      psz_name;                                   /* Variable name */
 187     void *      p_getlist;          /* Function to call to get a choice list */
 188     void *      p_change;        /* Function to call when commiting a change */
 189 } module_config_t;
 190
 191 /*****************************************************************************
 192  * Bank and module description structures
 193  *****************************************************************************/
 194
 195 /* The module bank structure */
 196 typedef struct module_bank_s
 197 {
 198     struct module_s *   first; /* First module of the bank */
 199
 200     vlc_mutex_t         lock;  /* Global lock -- you can't imagine how awful it
 201                                   is to design thread-safe linked lists. */
 202 } module_bank_t;
 203
 204 /* The module description structure */
 205 typedef struct module_s
 206 {
 207     boolean_t           b_builtin;  /* Set to true if the module is built in */
 208
 209     module_handle_t     handle;      /* Unique handle to refer to the module */
 210     char *              psz_filename;                     /* Module filename */
 211
 212     char *              psz_name;                    /* Module _unique_ name */
 213     char *              psz_longname;             /* Module descriptive name */
 214     char *              psz_version;                       /* Module version */
 215
 216     int                 i_usage;                        /* Reference counter */
 217     int                 i_unused_delay;    /* Delay until module is unloaded */
 218
 219     struct module_s *   next;                                 /* Next module */
 220     struct module_s *   prev;                             /* Previous module */
 221
 222     module_config_t *   p_config;    /* Module configuration structure table */
 223
 224     u32                     i_capabilities;               /* Capability list */
 225     p_module_functions_t    p_functions;             /* Capability functions */
 226
 227 } module_t;
 228
 229 /*****************************************************************************
 230  * Exported functions.
 231  *****************************************************************************/
 232 module_bank_t * module_CreateBank   ( void );
 233 void            module_InitBank     ( module_bank_t * p_bank );
 234 void            module_DestroyBank  ( module_bank_t * p_bank );
 235 void            module_ResetBank    ( module_bank_t * p_bank );
 236 void            module_ManageBank   ( module_bank_t * p_bank );
 237
 238 module_t *      module_Need         ( module_bank_t *p_bank,
 239                                       int i_capabilities, void *p_data );
 240 void            module_Unneed       ( module_bank_t * p_bank,
 241                                       module_t * p_module );
 242