git.sesse.net Git - vlc/blob - include/input_ext-plugins.h

   1 /*****************************************************************************
   2  * input_ext-plugins.h: structures of the input not exported to other modules,
   3  *                      but exported to plug-ins
   4  *****************************************************************************
   5  * Copyright (C) 1999, 2000, 2001 VideoLAN
   6  * $Id: input_ext-plugins.h,v 1.7 2001/12/07 16:47:47 jobi Exp $
   7  *
   8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 /*
  26  * Communication plugin -> input
  27  */
  28
  29 /* FIXME: you've gotta move this move this, you've gotta move this move this */
  30 #define INPUT_READ_ONCE     7   /* We live in a world dominated by Ethernet. *
  31                                  * Ethernet MTU is 1500 bytes, so in a UDP   *
  32                                  * packet we can put : 1500/188 = 7 TS       *
  33                                  * packets. Have a nice day and merry Xmas.  */
  34 #define PADDING_PACKET_SIZE 188 /* Size of the NULL packet inserted in case
  35                                  * of data loss (this should be < 188).      */
  36 #define PADDING_PACKET_NUMBER 10 /* Number of padding packets top insert to
  37                                   * escape a decoder.                        */
  38 #define NO_SEEK             -1
  39
  40 /*****************************************************************************
  41  * Prototypes from input_ext-dec.c
  42  *****************************************************************************/
  43 #ifndef PLUGIN
  44 void InitBitstream  ( struct bit_stream_s *, struct decoder_fifo_s *,
  45                       void (* pf_bitstream_callback)( struct bit_stream_s *,
  46                                                       boolean_t ),
  47                       void * p_callback_arg );
  48 void NextDataPacket ( struct bit_stream_s * );
  49 #endif
  50
  51 /*****************************************************************************
  52  * Prototypes from input_programs.c
  53  *****************************************************************************/
  54 #ifndef PLUGIN
  55 int  input_InitStream( struct input_thread_s *, size_t );
  56 void input_EndStream ( struct input_thread_s * );
  57 struct pgrm_descriptor_s * input_FindProgram( struct input_thread_s *, u16 );
  58 struct pgrm_descriptor_s * input_AddProgram ( struct input_thread_s *,
  59                                               u16, size_t );
  60 void input_DelProgram( struct input_thread_s *, struct pgrm_descriptor_s * );
  61 int input_SetProgram( struct input_thread_s *, struct pgrm_descriptor_s * );
  62 struct input_area_s * input_AddArea( struct input_thread_s * );
  63 void input_DelArea   ( struct input_thread_s *, struct input_area_s * );
  64 struct es_descriptor_s * input_FindES( struct input_thread_s *, u16 );
  65 struct es_descriptor_s * input_AddES ( struct input_thread_s *,
  66                                        struct pgrm_descriptor_s *, u16,
  67                                        size_t );
  68 void input_DelES     ( struct input_thread_s *, struct es_descriptor_s * );
  69 int  input_SelectES  ( struct input_thread_s *, struct es_descriptor_s * );
  70 int  input_UnselectES( struct input_thread_s *, struct es_descriptor_s * );
  71 #endif
  72
  73 /*****************************************************************************
  74  * Prototypes from input_dec.c
  75  *****************************************************************************/
  76 #ifndef PLUGIN
  77 //decoder_capabilities_s * input_ProbeDecoder( void );
  78 vlc_thread_t input_RunDecoder( struct input_thread_s *,
  79                                struct es_descriptor_s * );
  80 void input_EndDecoder( struct input_thread_s *, struct es_descriptor_s * );
  81 void input_DecodePES ( struct decoder_fifo_s *, struct pes_packet_s * );
  82 void input_EscapeDiscontinuity( struct input_thread_s *,
  83                                 struct pgrm_descriptor_s * );
  84 void input_EscapeAudioDiscontinuity( struct input_thread_s * );
  85 #endif
  86
  87 /*****************************************************************************
  88  * Prototypes from input_clock.c
  89  *****************************************************************************/
  90 #ifndef PLUGIN
  91 void input_ClockInit( struct pgrm_descriptor_s * );
  92 int  input_ClockManageControl( struct input_thread_s *,
  93                                struct pgrm_descriptor_s *, mtime_t );
  94 void input_ClockManageRef( struct input_thread_s *,
  95                            struct pgrm_descriptor_s *, mtime_t );
  96 mtime_t input_ClockGetTS( struct input_thread_s *,
  97                           struct pgrm_descriptor_s *, mtime_t );
  98 #endif
  99
 100 /*****************************************************************************
 101  * Create a NULL packet for padding in case of a data loss
 102  *****************************************************************************/
 103 static __inline__ void input_NullPacket( input_thread_t * p_input,
 104                                          es_descriptor_t * p_es )
 105 {
 106     data_packet_t *             p_pad_data;
 107     pes_packet_t *              p_pes;
 108
 109     if( (p_pad_data = p_input->pf_new_packet(
 110                     p_input->p_method_data,
 111                     PADDING_PACKET_SIZE )) == NULL )
 112     {
 113         intf_ErrMsg("Out of memory");
 114         p_input->b_error = 1;
 115         return;
 116     }
 117
 118     memset( p_pad_data->p_buffer, 0, PADDING_PACKET_SIZE );
 119     p_pad_data->b_discard_payload = 1;
 120     p_pes = p_es->p_pes;
 121
 122     if( p_pes != NULL )
 123     {
 124         p_pes->b_discontinuity = 1;
 125         p_es->p_last->p_next = p_pad_data;
 126         p_es->p_last = p_pad_data;
 127     }
 128     else
 129     {
 130         if( (p_pes = p_input->pf_new_pes( p_input->p_method_data )) == NULL )
 131         {
 132             intf_ErrMsg("Out of memory");
 133             p_input->b_error = 1;
 134             return;
 135         }
 136
 137         p_pes->i_rate = p_input->stream.control.i_rate;
 138         p_pes->p_first = p_pad_data;
 139         p_pes->b_discontinuity = 1;
 140         input_DecodePES( p_es->p_decoder_fifo, p_pes );
 141     }
 142 }
 143
 144
 145 /*
 146  * Optional netlist management
 147  */
 148
 149 /*****************************************************************************
 150  * netlist_t: structure to manage a netlist
 151  *****************************************************************************/
 152 typedef struct netlist_s
 153 {
 154     vlc_mutex_t             lock;
 155
 156     size_t                  i_buffer_size;
 157
 158     /* Buffers */
 159     byte_t *                p_buffers;                 /* Big malloc'ed area */
 160     data_packet_t *         p_data;                        /* malloc'ed area */
 161     pes_packet_t *          p_pes;                         /* malloc'ed area */
 162
 163     /* FIFOs of free packets */
 164     data_packet_t **        pp_free_data;
 165     pes_packet_t **         pp_free_pes;
 166     struct iovec *          p_free_iovec;
 167
 168     /* FIFO size */
 169     unsigned int            i_nb_iovec;
 170     unsigned int            i_nb_pes;
 171     unsigned int            i_nb_data;
 172
 173     /* Index */
 174     unsigned int            i_iovec_start, i_iovec_end;
 175     unsigned int            i_data_start, i_data_end;
 176     unsigned int            i_pes_start, i_pes_end;
 177
 178     /* Reference counters for iovec */
 179     unsigned int *          pi_refcount;
 180
 181     /* Number of blocs read once by readv */
 182     unsigned int            i_read_once;
 183 } netlist_t;
 184
 185 /*****************************************************************************
 186  * Prototypes
 187  *****************************************************************************/
 188 #ifndef PLUGIN
 189 int                     input_NetlistInit( struct input_thread_s *,
 190                                            int i_nb_iovec,
 191                                            int i_nb_data,
 192                                            int i_nb_pes,
 193                                            size_t i_buffer_size,
 194                                            int i_read_once );
 195
 196 struct iovec *          input_NetlistGetiovec( void * p_method_data );
 197 void                    input_NetlistMviovec( void * , int,
 198                                               struct data_packet_s **);
 199 struct data_packet_s *  input_NetlistNewPtr( void * );
 200 struct data_packet_s *  input_NetlistNewPacket( void *, size_t );
 201 struct pes_packet_s *   input_NetlistNewPES( void * );
 202 void                    input_NetlistDeletePacket( void *,
 203                                                    struct data_packet_s * );
 204 void                    input_NetlistDeletePES( void *,
 205                                                 struct pes_packet_s * );
 206 void                    input_NetlistEnd( struct input_thread_s * );
 207 #endif
 208
 209
 210 /*
 211  * Optional MPEG demultiplexing
 212  */
 213
 214 /*****************************************************************************
 215  * Constants
 216  *****************************************************************************/
 217 #define TS_PACKET_SIZE      188                       /* Size of a TS packet */
 218 #define PSI_SECTION_SIZE    4096            /* Maximum size of a PSI section */
 219
 220 #define PAT_UNINITIALIZED    (1 << 6)
 221 #define PMT_UNINITIALIZED    (1 << 6)
 222
 223 #define PSI_IS_PAT          0x00
 224 #define PSI_IS_PMT          0x01
 225 #define UNKNOWN_PSI         0xff
 226
 227 /*****************************************************************************
 228  * psi_section_t
 229  *****************************************************************************
 230  * Describes a PSI section. Beware, it doesn't contain pointers to the TS
 231  * packets that contain it as for a PES, but the data themselves
 232  *****************************************************************************/
 233 typedef struct psi_section_s
 234 {
 235     byte_t                  buffer[PSI_SECTION_SIZE];
 236
 237     u8                      i_section_number;
 238     u8                      i_last_section_number;
 239     u8                      i_version_number;
 240     u16                     i_section_length;
 241     u16                     i_read_in_section;
 242
 243     /* the PSI is complete */
 244     boolean_t               b_is_complete;
 245
 246     /* packet missed up ? */
 247     boolean_t               b_trash;
 248
 249     /*about sections  */
 250     boolean_t               b_section_complete;
 251
 252     /* where are we currently ? */
 253     byte_t                * p_current;
 254
 255 } psi_section_t;
 256
 257 /*****************************************************************************
 258  * es_ts_data_t: extension of es_descriptor_t
 259  *****************************************************************************/
 260 typedef struct es_ts_data_s
 261 {
 262     boolean_t               b_psi;   /* Does the stream have to be handled by
 263                                       *                    the PSI decoder ? */
 264
 265     int                     i_psi_type;  /* There are different types of PSI */
 266
 267     psi_section_t *         p_psi_section;                    /* PSI packets */
 268
 269     /* Markers */
 270     int                     i_continuity_counter;
 271 } es_ts_data_t;
 272
 273 /*****************************************************************************
 274  * pgrm_ts_data_t: extension of pgrm_descriptor_t
 275  *****************************************************************************/
 276 typedef struct pgrm_ts_data_s
 277 {
 278     u16                     i_pcr_pid;             /* PCR ES, for TS streams */
 279     int                     i_pmt_version;
 280 } pgrm_ts_data_t;
 281
 282 /*****************************************************************************
 283  * stream_ts_data_t: extension of stream_descriptor_t
 284  *****************************************************************************/
 285 typedef struct stream_ts_data_s
 286 {
 287     int i_pat_version;          /* Current version of the PAT */
 288 } stream_ts_data_t;
 289
 290 /*****************************************************************************
 291  * stream_ps_data_t: extension of stream_descriptor_t
 292  *****************************************************************************/
 293 typedef struct stream_ps_data_s
 294 {
 295     boolean_t               b_has_PSM;                 /* very rare, in fact */
 296
 297     u8                      i_PSM_version;
 298 } stream_ps_data_t;
 299
 300 /* PSM version is 5 bits, so -1 is not a valid value */
 301 #define EMPTY_PSM_VERSION   -1
 302
 303
 304 /*****************************************************************************
 305  * Prototypes
 306  *****************************************************************************/
 307 #ifndef PLUGIN
 308 void input_ParsePES  ( struct input_thread_s *, struct es_descriptor_s * );
 309 void input_GatherPES ( struct input_thread_s *, struct data_packet_s *,
 310                        struct es_descriptor_s *, boolean_t, boolean_t );
 311 es_descriptor_t * input_ParsePS( struct input_thread_s *,
 312                                  struct data_packet_s * );
 313 void input_DemuxPS   ( struct input_thread_s *, struct data_packet_s * );
 314 void input_DemuxTS   ( struct input_thread_s *, struct data_packet_s * );
 315 void input_DemuxPSI  ( struct input_thread_s *, struct data_packet_s *,
 316                        struct es_descriptor_s *, boolean_t, boolean_t );
 317 #endif