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

   1 /*****************************************************************************
   2  * input_ext-intf.h: structures of the input exported to the interface
   3  * This header provides structures to read the stream descriptors and
   4  * control the pace of reading.
   5  *****************************************************************************
   6  * Copyright (C) 1999, 2000 VideoLAN
   7  * $Id: input_ext-intf.h,v 1.36 2001/05/01 12:22:18 sam Exp $
   8  *
   9  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*
  27  * Communication input -> interface
  28  */
  29 #define INPUT_MAX_PLUGINS   1
  30 /* FIXME ! */
  31 #define REQUESTED_MPEG         1
  32 #define REQUESTED_AC3          2
  33 #define REQUESTED_LPCM         3
  34 #define REQUESTED_NOAUDIO    255
  35
  36 #define OFFSETTOTIME_MAX_SIZE       10
  37
  38 /*****************************************************************************
  39  * es_descriptor_t: elementary stream descriptor
  40  *****************************************************************************
  41  * Describes an elementary stream, and includes fields required to handle and
  42  * demultiplex this elementary stream.
  43  *****************************************************************************/
  44 struct decoder_fifo_s;                         /* defined in input_ext-dec.h */
  45 struct pgrm_descriptor_s;
  46
  47 typedef struct es_descriptor_s
  48 {
  49     u16                     i_id;            /* stream ID for PS, PID for TS */
  50     u8                      i_stream_id;     /* stream ID defined in the PES */
  51     u8                      i_type;                           /* stream type */
  52     boolean_t               b_audio;      /* is the stream an audio stream that
  53                                            * will need to be discarded with
  54                                            * fast forward and slow motion ?  */
  55     u8                      i_cat;        /* stream category: video, audio,
  56                                            * spu, other */
  57
  58     char                    psz_desc[20]; /* description of ES: audio language
  59                                            * for instance ; NULL if not
  60                                            *  available */
  61
  62     /* Demultiplexer information */
  63     void *                  p_demux_data;
  64     struct pgrm_descriptor_s *
  65                             p_pgrm;  /* very convenient in the demultiplexer */
  66
  67     /* PES parser information */
  68     struct pes_packet_s *   p_pes;                            /* Current PES */
  69     struct data_packet_s *  p_last;   /* The last packet gathered at present */
  70     int                     i_pes_real_size;   /* as indicated by the header */
  71
  72     /* Decoder information */
  73     struct decoder_fifo_s * p_decoder_fifo;
  74     vlc_thread_t            thread_id;                  /* ID of the decoder */
  75
  76 #ifdef STATS
  77     count_t                 c_payload_bytes;/* total of payload useful bytes */
  78     count_t                 c_packets;                 /* total packets read */
  79     count_t                 c_invalid_packets;       /* invalid packets read */
  80 #endif
  81 } es_descriptor_t;
  82
  83 /* Special PID values - note that the PID is only on 13 bits, and that values
  84  * greater than 0x1fff have no meaning in a stream */
  85 #define PROGRAM_ASSOCIATION_TABLE_PID   0x0000
  86 #define CONDITIONNAL_ACCESS_TABLE_PID   0x0001                   /* not used */
  87 #define EMPTY_ID                        0xffff    /* empty record in a table */
  88
  89 /* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
  90 #define MPEG1_VIDEO_ES      0x01
  91 #define MPEG2_VIDEO_ES      0x02
  92 #define MPEG1_AUDIO_ES      0x03
  93 #define MPEG2_AUDIO_ES      0x04
  94 #define AC3_AUDIO_ES        0x81
  95 /* These ones might violate the norm : */
  96 #define DVD_SPU_ES          0x82
  97 #define LPCM_AUDIO_ES       0x83
  98 #define UNKNOWN_ES          0xFF
  99
 100 /* ES Categories to be used by interface plugins */
 101 #define VIDEO_ES        0x00
 102 #define AUDIO_ES        0x01
 103 #define SPU_ES          0x02
 104 #define NAV_ES          0x03
 105 #define UNKNOWN_ES      0xFF
 106 /*****************************************************************************
 107  * pgrm_descriptor_t
 108  *****************************************************************************
 109  * Describes a program and list associated elementary streams. It is build by
 110  * the PSI decoder upon the informations carried in program map sections
 111  *****************************************************************************/
 112 typedef struct pgrm_descriptor_s
 113 {
 114     /* Program characteristics */
 115     u16                     i_number;                      /* program number */
 116     u8                      i_version;                     /* version number */
 117     boolean_t               b_is_ok;      /* Is the description up to date ? */
 118
 119     /* Service Descriptor (program name) - DVB extension */
 120     u8                      i_srv_type;
 121     char *                  psz_srv_name;
 122
 123     /* Synchronization information */
 124     mtime_t                 delta_cr;
 125     mtime_t                 cr_ref, sysdate_ref;
 126     mtime_t                 last_cr; /* reference to detect unexpected stream
 127                                       * discontinuities                      */
 128     count_t                 c_average_count;
 129                            /* counter used to compute dynamic average values */
 130     int                     i_synchro_state;
 131
 132     /* Demultiplexer data */
 133     void *                  p_demux_data;
 134
 135     int                     i_es_number;      /* size of the following array */
 136     es_descriptor_t **      pp_es;                /* array of pointers to ES */
 137 } pgrm_descriptor_t;
 138
 139 /* Synchro states */
 140 #define SYNCHRO_OK          0
 141 #define SYNCHRO_START       1
 142 #define SYNCHRO_REINIT      2
 143
 144 /*****************************************************************************
 145  * input_area_t
 146  *****************************************************************************
 147  * Attributes for current area (title for DVD)
 148  *****************************************************************************/
 149 typedef struct input_area_s
 150 {
 151     /* selected area attributes */
 152     int                     i_id;        /* identificator for area */
 153     off_t                   i_start;     /* start offset of area */
 154     off_t                   i_size;      /* total size of the area
 155                                           * (in arbitrary units) */
 156
 157     /* navigation parameters */
 158     off_t                   i_tell;      /* actual location in the area
 159                                           * (in arbitrary units) */
 160     off_t                   i_seek;      /* next requested location
 161                                           * (changed by the interface thread */
 162
 163     /* area subdivision */
 164     int                     i_part_nb;   /* number of parts (chapter for DVD)*/
 165     int                     i_part;      /* currently selected part */
 166
 167     int                     i_angle_nb;  /* number of angles/title units */
 168     int                     i_angle;
 169
 170     /* offset to plugin related data */
 171     off_t                   i_plugin_data;
 172 } input_area_t;
 173
 174 /*****************************************************************************
 175  * stream_descriptor_t
 176  *****************************************************************************
 177  * Describes a stream and list its associated programs. Build upon
 178  * the information carried in program association sections (for instance)
 179  *****************************************************************************/
 180 typedef struct stream_descriptor_s
 181 {
 182     u16                     i_stream_id;                        /* stream id */
 183     boolean_t               b_changed;    /* if stream has been changed,
 184                                              we have to inform the interface */
 185     vlc_mutex_t             stream_lock;  /* to be taken every time you read
 186                                            * or modify stream, pgrm or es    */
 187
 188     /* Input method data */
 189     int                     i_method;       /* input method for stream: file,
 190                                                disc or network */
 191     boolean_t               b_pace_control;    /* can we read when we want ? */
 192     boolean_t               b_seekable;               /* can we do lseek() ? */
 193
 194     /* if (b_seekable) : */
 195     int                     i_area_nb;
 196     input_area_t **         pp_areas;      /* list of areas in stream == offset
 197                                             * interval with own properties */
 198     input_area_t *          p_selected_area;
 199     u32                     i_mux_rate; /* the rate we read the stream (in
 200                                          * units of 50 bytes/s) ; 0 if undef */
 201
 202     /* New status and rate requested by the interface */
 203     int                     i_new_status, i_new_rate;
 204     vlc_cond_t              stream_wait; /* interface -> input in case of a
 205                                           * status change request            */
 206
 207     /* Demultiplexer data */
 208     void *                  p_demux_data;
 209
 210     /* Programs descriptions */
 211     int                     i_pgrm_number;    /* size of the following array */
 212     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
 213
 214     /* ES descriptions */
 215     int                     i_es_number;
 216     es_descriptor_t **      pp_es;             /* carried elementary streams */
 217     int                     i_selected_es_number;
 218     es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
 219
 220     /* Stream control */
 221     stream_ctrl_t           control;
 222 } stream_descriptor_t;
 223
 224 /*****************************************************************************
 225  * i_p_config_t
 226  *****************************************************************************
 227  * This structure gives plugins pointers to the useful functions of input
 228  *****************************************************************************/
 229 struct input_thread_s;
 230 struct data_packet_s;
 231 struct es_descriptor_s;
 232
 233 typedef struct i_p_config_s
 234 {
 235     int                 (* pf_peek_stream)( struct input_thread_s *,
 236                                             byte_t * buffer, size_t );
 237     void                (* pf_demux_pes)( struct input_thread_s *,
 238                                           struct data_packet_s *,
 239                                           struct es_descriptor_s *,
 240                                           boolean_t b_unit_start,
 241                                           boolean_t b_packet_lost );
 242 } i_p_config_t;
 243
 244 /*****************************************************************************
 245  * input_thread_t
 246  *****************************************************************************
 247  * This structure includes all the local static variables of an input thread
 248  *****************************************************************************/
 249 struct vout_thread_s;
 250
 251 typedef struct input_thread_s
 252 {
 253     /* Thread properties and locks */
 254     boolean_t               b_die;                             /* 'die' flag */
 255     boolean_t               b_error;
 256     boolean_t               b_eof;
 257     vlc_thread_t            thread_id;            /* id for thread functions */
 258     int *                   pi_status;              /* temporary status flag */
 259
 260     /* Input module */
 261     struct module_s *       p_input_module;
 262
 263     /* Init/End */
 264     void                 (* pf_init)( struct input_thread_s * );
 265     void                 (* pf_open)( struct input_thread_s * );
 266     void                 (* pf_close)( struct input_thread_s * );
 267     void                 (* pf_end)( struct input_thread_s * );
 268
 269     /* Read & Demultiplex */
 270     int                  (* pf_read)( struct input_thread_s *,
 271                                       struct data_packet_s * pp_packets[] );
 272     void                 (* pf_demux)( struct input_thread_s *,
 273                                        struct data_packet_s * );
 274
 275     /* Packet management facilities */
 276     struct data_packet_s *(*pf_new_packet)( void *, size_t );
 277     struct pes_packet_s *(* pf_new_pes)( void * );
 278     void                 (* pf_delete_packet)( void *,
 279                                                struct data_packet_s * );
 280     void                 (* pf_delete_pes)( void *, struct pes_packet_s * );
 281
 282     /* Stream control capabilities */
 283     int                  (* pf_set_area)( struct input_thread_s *,
 284                                           struct input_area_s * );
 285     int                  (* pf_rewind)( struct input_thread_s * );
 286                                            /* NULL if we don't support going *
 287                                             * backwards (it's gonna be fun)  */
 288     void                 (* pf_seek)( struct input_thread_s *, off_t );
 289
 290     i_p_config_t            i_p_config;              /* plugin configuration */
 291     char *                  p_source;
 292
 293     int                     i_handle;           /* socket or file descriptor */
 294     int                     i_read_once;        /* number of packet read by
 295                                                  * pf_read once */
 296     void *                  p_method_data;     /* data of the packet manager */
 297     void *                  p_plugin_data;             /* data of the plugin */
 298
 299     /* General stream description */
 300     stream_descriptor_t     stream;                            /* PAT tables */
 301
 302 #ifdef STATS
 303     count_t                 c_loops;
 304     count_t                 c_bytes;                           /* bytes read */
 305     count_t                 c_payload_bytes;         /* payload useful bytes */
 306     count_t                 c_packets_read;                  /* packets read */
 307     count_t                 c_packets_trashed;            /* trashed packets */
 308 #endif
 309 } input_thread_t;
 310
 311 /* Input methods */
 312 /* The first figure is a general method that can be used in interface plugins ;
 313  * The second figure is a detailed sub-method */
 314 #define INPUT_METHOD_NONE         0x0            /* input thread is inactive */
 315 #define INPUT_METHOD_FILE        0x10   /* stream is read from file p_source */
 316 #define INPUT_METHOD_DISC        0x20   /* stream is read directly from disc */
 317 #define INPUT_METHOD_DVD         0x21             /* stream is read from DVD */
 318 #define INPUT_METHOD_VCD         0x22             /* stream is read from VCD */
 319 #define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
 320 #define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
 321 #define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
 322 #define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
 323 #define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */
 324
 325
 326 /* Status changing methods */
 327 #define INPUT_STATUS_END            0
 328 #define INPUT_STATUS_PLAY           1
 329 #define INPUT_STATUS_PAUSE          2
 330 #define INPUT_STATUS_FASTER         3
 331 #define INPUT_STATUS_SLOWER         4
 332
 333 /*****************************************************************************
 334  * Prototypes
 335  *****************************************************************************/
 336 struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
 337                                              int *pi_status );
 338 void input_DestroyThread( struct input_thread_s *, int *pi_status );
 339
 340 void input_SetStatus( struct input_thread_s *, int );
 341 void input_SetRate  ( struct input_thread_s *, int );
 342 void input_Seek     ( struct input_thread_s *, off_t );
 343 void input_DumpStream( struct input_thread_s * );
 344 char * input_OffsetToTime( struct input_thread_s *, char * psz_buffer, off_t );
 345 int  input_ChangeES ( struct input_thread_s *, struct es_descriptor_s *, u8 );
 346 int  input_ToggleES ( struct input_thread_s *,
 347                       struct es_descriptor_s *,
 348                       boolean_t );