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-2002 VideoLAN
   6  * $Id: input_ext-plugins.h,v 1.33 2002/07/31 20:56:50 sam 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 PADDING_PACKET_SIZE 188 /* Size of the NULL packet inserted in case
  31                                  * of data loss (this should be < 188).      */
  32 #define PADDING_PACKET_NUMBER 10 /* Number of padding packets top insert to
  33                                   * escape a decoder.                        */
  34 #define INPUT_DEFAULT_BUFSIZE 65536 /* Default buffer size to use when none
  35                                      * is natural.                           */
  36 #define NO_SEEK             -1
  37
  38 /*****************************************************************************
  39  * Prototypes from input_programs.c
  40  *****************************************************************************/
  41 VLC_EXPORT( int,  input_InitStream,( input_thread_t *, size_t ) );
  42 VLC_EXPORT( void, input_EndStream, ( input_thread_t * ) );
  43 VLC_EXPORT( pgrm_descriptor_t *, input_FindProgram,( input_thread_t *, u16 ) );
  44 VLC_EXPORT( pgrm_descriptor_t *, input_AddProgram, ( input_thread_t *, u16, size_t ) );
  45 VLC_EXPORT( void, input_DelProgram,( input_thread_t *, pgrm_descriptor_t * ) );
  46 VLC_EXPORT( int, input_SetProgram,( input_thread_t *, pgrm_descriptor_t * ) );
  47 VLC_EXPORT( input_area_t *, input_AddArea,( input_thread_t * ) );
  48 VLC_EXPORT( void, input_DelArea,   ( input_thread_t *, input_area_t * ) );
  49 VLC_EXPORT( es_descriptor_t *, input_FindES,( input_thread_t *, u16 ) );
  50 VLC_EXPORT( es_descriptor_t *, input_AddES, ( input_thread_t *, pgrm_descriptor_t *, u16, size_t ) );
  51 VLC_EXPORT( void, input_DelES,     ( input_thread_t *, es_descriptor_t * ) );
  52 VLC_EXPORT( int,  input_SelectES,  ( input_thread_t *, es_descriptor_t * ) );
  53 VLC_EXPORT( int,  input_UnselectES,( input_thread_t *, es_descriptor_t * ) );
  54
  55 /*****************************************************************************
  56  * Prototypes from input_dec.c
  57  *****************************************************************************/
  58 //decoder_capabilities_t * input_ProbeDecoder( void );
  59 decoder_fifo_t * input_RunDecoder( input_thread_t *, es_descriptor_t * );
  60 void input_EndDecoder( input_thread_t *, es_descriptor_t * );
  61 VLC_EXPORT( void, input_DecodePES, ( decoder_fifo_t *, pes_packet_t * ) );
  62 void input_EscapeDiscontinuity( input_thread_t * );
  63 void input_EscapeAudioDiscontinuity( input_thread_t * );
  64
  65 /*****************************************************************************
  66  * Prototypes from input_clock.c
  67  *****************************************************************************/
  68 void input_ClockInit( pgrm_descriptor_t * );
  69 VLC_EXPORT( int,  input_ClockManageControl, ( input_thread_t *, pgrm_descriptor_t *, mtime_t ) );
  70 VLC_EXPORT( void, input_ClockManageRef, ( input_thread_t *, pgrm_descriptor_t *, mtime_t ) );
  71 VLC_EXPORT( mtime_t, input_ClockGetTS, ( input_thread_t *, pgrm_descriptor_t *, mtime_t ) );
  72
  73 /*****************************************************************************
  74  * Prototypes from input_info.c
  75  *****************************************************************************/
  76 VLC_EXPORT( input_info_category_t *, input_InfoCategory, ( input_thread_t *, char * ) );
  77 VLC_EXPORT( int, input_AddInfo, ( input_info_category_t *, char *, char *, ... ) );
  78 int input_DelInfo( input_thread_t * p_input ); /* no need to export this */
  79 /*****************************************************************************
  80  * Prototypes from input_ext-plugins.h (buffers management)
  81  *****************************************************************************/
  82 #define input_BuffersInit(a) __input_BuffersInit(VLC_OBJECT(a))
  83 void * __input_BuffersInit( vlc_object_t * );
  84 VLC_EXPORT( void, input_BuffersEnd, ( input_thread_t *, input_buffers_t * ) );
  85
  86 VLC_EXPORT( data_buffer_t *, input_NewBuffer,   ( input_buffers_t *, size_t ) );
  87 VLC_EXPORT( void, input_ReleaseBuffer,          ( input_buffers_t *, data_buffer_t * ) );
  88 VLC_EXPORT( data_packet_t *, input_ShareBuffer, ( input_buffers_t *, data_buffer_t * ) );
  89 VLC_EXPORT( data_packet_t *, input_NewPacket,   ( input_buffers_t *, size_t ) );
  90 VLC_EXPORT( void, input_DeletePacket,           ( input_buffers_t *, data_packet_t * ) );
  91 VLC_EXPORT( pes_packet_t *, input_NewPES, ( input_buffers_t * ) );
  92 VLC_EXPORT( void, input_DeletePES,        ( input_buffers_t *, pes_packet_t * ) );
  93 VLC_EXPORT( ssize_t, input_FillBuffer,  ( input_thread_t * ) );
  94 VLC_EXPORT( ssize_t, input_Peek,        ( input_thread_t *, byte_t **, size_t ) );
  95 VLC_EXPORT( ssize_t, input_SplitBuffer, ( input_thread_t *, data_packet_t **, size_t ) );
  96 VLC_EXPORT( int, input_AccessInit,      ( input_thread_t * ) );
  97 VLC_EXPORT( void, input_AccessReinit,   ( input_thread_t * ) );
  98 VLC_EXPORT( void, input_AccessEnd,      ( input_thread_t * ) );
  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 = input_NewPacket( p_input->p_method_data,
 110                     PADDING_PACKET_SIZE )) == NULL )
 111     {
 112         msg_Err( p_input, "no new packet" );
 113         p_input->b_error = 1;
 114         return;
 115     }
 116
 117     memset( p_pad_data->p_payload_start, 0, PADDING_PACKET_SIZE );
 118     p_pad_data->b_discard_payload = 1;
 119     p_pes = p_es->p_pes;
 120
 121     if( p_pes != NULL )
 122     {
 123         p_pes->b_discontinuity = 1;
 124         p_pes->p_last->p_next = p_pad_data;
 125         p_pes->p_last = p_pad_data;
 126         p_pes->i_nb_data++;
 127     }
 128     else
 129     {
 130         if( (p_pes = input_NewPES( p_input->p_method_data )) == NULL )
 131         {
 132             msg_Err( p_input, "no PES packet" );
 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_pes->p_last = p_pad_data;
 139         p_pes->i_nb_data = 1;
 140         p_pes->b_discontinuity = 1;
 141         input_DecodePES( p_es->p_decoder_fifo, p_pes );
 142     }
 143 }
 144
 145
 146 /*
 147  * Optional MPEG demultiplexing
 148  */
 149
 150 /*****************************************************************************
 151  * Constants
 152  *****************************************************************************/
 153 #define TS_PACKET_SIZE      188                       /* Size of a TS packet */
 154 #define TS_SYNC_CODE        0x47                /* First byte of a TS packet */
 155 #define PSI_SECTION_SIZE    4096            /* Maximum size of a PSI section */
 156
 157 #define PAT_UNINITIALIZED    (1 << 6)
 158 #define PMT_UNINITIALIZED    (1 << 6)
 159
 160 #define PSI_IS_PAT          0x00
 161 #define PSI_IS_PMT          0x01
 162 #define UNKNOWN_PSI         0xff
 163
 164 /****************************************************************************
 165  * psi_callback_t
 166  ****************************************************************************
 167  * Used by TS demux to handle a PSI, either with the builtin decoder, either
 168  * with a library such as libdvbpsi
 169  ****************************************************************************/
 170 typedef void( * psi_callback_t )(
 171         input_thread_t  * p_input,
 172         data_packet_t   * p_data,
 173         es_descriptor_t * p_es,
 174         vlc_bool_t        b_unit_start );
 175
 176
 177 /*****************************************************************************
 178  * psi_section_t
 179  *****************************************************************************
 180  * Describes a PSI section. Beware, it doesn't contain pointers to the TS
 181  * packets that contain it as for a PES, but the data themselves
 182  *****************************************************************************/
 183 typedef struct psi_section_t
 184 {
 185     byte_t                  buffer[PSI_SECTION_SIZE];
 186
 187     u8                      i_section_number;
 188     u8                      i_last_section_number;
 189     u8                      i_version_number;
 190     u16                     i_section_length;
 191     u16                     i_read_in_section;
 192
 193     /* the PSI is complete */
 194     vlc_bool_t              b_is_complete;
 195
 196     /* packet missed up ? */
 197     vlc_bool_t              b_trash;
 198
 199     /*about sections  */
 200     vlc_bool_t              b_section_complete;
 201
 202     /* where are we currently ? */
 203     byte_t                * p_current;
 204
 205 } psi_section_t;
 206
 207 /*****************************************************************************
 208  * es_ts_data_t: extension of es_descriptor_t
 209  *****************************************************************************/
 210 typedef struct es_ts_data_t
 211 {
 212     vlc_bool_t              b_psi;   /* Does the stream have to be handled by
 213                                       *                    the PSI decoder ? */
 214
 215     int                     i_psi_type;  /* There are different types of PSI */
 216
 217     psi_section_t *         p_psi_section;                    /* PSI packets */
 218
 219     /* Markers */
 220     int                     i_continuity_counter;
 221 } es_ts_data_t;
 222
 223 /*****************************************************************************
 224  * pgrm_ts_data_t: extension of pgrm_descriptor_t
 225  *****************************************************************************/
 226 typedef struct pgrm_ts_data_t
 227 {
 228     u16                     i_pcr_pid;             /* PCR ES, for TS streams */
 229     int                     i_pmt_version;
 230     /* libdvbpsi pmt decoder handle */
 231     void *                  p_pmt_handle;
 232 } pgrm_ts_data_t;
 233
 234 /*****************************************************************************
 235  * stream_ts_data_t: extension of stream_descriptor_t
 236  *****************************************************************************/
 237 typedef struct stream_ts_data_t
 238 {
 239     int i_pat_version;          /* Current version of the PAT */
 240     /* libdvbpsi pmt decoder handle */
 241     void *                  p_pat_handle;
 242 } stream_ts_data_t;
 243
 244 /*****************************************************************************
 245  * stream_ps_data_t: extension of stream_descriptor_t
 246  *****************************************************************************/
 247 typedef struct stream_ps_data_t
 248 {
 249     vlc_bool_t              b_has_PSM;                 /* very rare, in fact */
 250
 251     u8                      i_PSM_version;
 252 } stream_ps_data_t;
 253
 254 /* PSM version is 5 bits, so -1 is not a valid value */
 255 #define EMPTY_PSM_VERSION   -1
 256
 257
 258 /*****************************************************************************
 259  * Prototypes
 260  *****************************************************************************/
 261 VLC_EXPORT( void, input_ParsePES,  ( input_thread_t *, es_descriptor_t * ) );
 262 VLC_EXPORT( void, input_GatherPES, ( input_thread_t *, data_packet_t *, es_descriptor_t *, vlc_bool_t, vlc_bool_t ) );
 263 VLC_EXPORT( ssize_t, input_ReadPS, ( input_thread_t *, data_packet_t ** ) );
 264 VLC_EXPORT( es_descriptor_t *, input_ParsePS, ( input_thread_t *, data_packet_t * ) );
 265 VLC_EXPORT( ssize_t, input_ReadTS, ( input_thread_t *, data_packet_t ** ) );
 266 VLC_EXPORT( void, input_DemuxPS,   ( input_thread_t *, data_packet_t * ) );
 267 VLC_EXPORT( void, input_DemuxTS,   ( input_thread_t *, data_packet_t *, void(*) ( input_thread_t *, data_packet_t *, es_descriptor_t *, vlc_bool_t ) ) );
 268
 269 /*
 270  * Optional standard file descriptor operations (input_ext-plugins.h)
 271  */
 272
 273 /*****************************************************************************
 274  * input_socket_t: private access plug-in data
 275  *****************************************************************************/
 276 struct input_socket_t
 277 {
 278     /* Unbuffered file descriptor */
 279     int i_handle;
 280 };
 281
 282 /*****************************************************************************
 283  * Prototypes
 284  *****************************************************************************/
 285 VLC_EXPORT( void, __input_FDClose, ( vlc_object_t * ) );
 286 #define input_FDClose(a) __input_FDClose(VLC_OBJECT(a))
 287 VLC_EXPORT( void, __input_FDNetworkClose, ( vlc_object_t * ) );
 288 #define input_FDNetworkClose(a) __input_FDNetworkClose(VLC_OBJECT(a))
 289 VLC_EXPORT( ssize_t, input_FDRead, ( input_thread_t *, byte_t *, size_t ) );
 290 VLC_EXPORT( ssize_t, input_FDNetworkRead, ( input_thread_t *, byte_t *, size_t ) );
 291 VLC_EXPORT( void, input_FDSeek, ( input_thread_t *, off_t ) );
 292