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.35 2001/05/01 04:18:17 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     /* Decoders control */
 136     struct vout_thread_s *  p_vout;
 137
 138     int                     i_es_number;      /* size of the following array */
 139     es_descriptor_t **      pp_es;                /* array of pointers to ES */
 140 } pgrm_descriptor_t;
 141
 142 /* Synchro states */
 143 #define SYNCHRO_OK          0
 144 #define SYNCHRO_START       1
 145 #define SYNCHRO_REINIT      2
 146
 147 /*****************************************************************************
 148  * input_area_t
 149  *****************************************************************************
 150  * Attributes for current area (title for DVD)
 151  *****************************************************************************/
 152 typedef struct input_area_s
 153 {
 154     /* selected area attributes */
 155     int                     i_id;        /* identificator for area */
 156     off_t                   i_start;     /* start offset of area */
 157     off_t                   i_size;      /* total size of the area
 158                                           * (in arbitrary units) */
 159
 160     /* navigation parameters */
 161     off_t                   i_tell;      /* actual location in the area
 162                                           * (in arbitrary units) */
 163     off_t                   i_seek;      /* next requested location
 164                                           * (changed by the interface thread */
 165
 166     /* area subdivision */
 167     int                     i_part_nb;   /* number of parts (chapter for DVD)*/
 168     int                     i_part;      /* currently selected part */
 169
 170     int                     i_angle_nb;  /* number of angles/title units */
 171     int                     i_angle;
 172
 173     /* offset to plugin related data */
 174     off_t                   i_plugin_data;
 175 } input_area_t;
 176
 177 /*****************************************************************************
 178  * stream_descriptor_t
 179  *****************************************************************************
 180  * Describes a stream and list its associated programs. Build upon
 181  * the information carried in program association sections (for instance)
 182  *****************************************************************************/
 183 typedef struct stream_descriptor_s
 184 {
 185     u16                     i_stream_id;                        /* stream id */
 186     boolean_t               b_changed;    /* if stream has been changed,
 187                                              we have to inform the interface */
 188     vlc_mutex_t             stream_lock;  /* to be taken every time you read
 189                                            * or modify stream, pgrm or es    */
 190
 191     /* Input method data */
 192     int                     i_method;       /* input method for stream: file,
 193                                                disc or network */
 194     boolean_t               b_pace_control;    /* can we read when we want ? */
 195     boolean_t               b_seekable;               /* can we do lseek() ? */
 196
 197     /* if (b_seekable) : */
 198     int                     i_area_nb;
 199     input_area_t **         pp_areas;      /* list of areas in stream == offset
 200                                             * interval with own properties */
 201     input_area_t *          p_selected_area;
 202     u32                     i_mux_rate; /* the rate we read the stream (in
 203                                          * units of 50 bytes/s) ; 0 if undef */
 204
 205     /* New status and rate requested by the interface */
 206     int                     i_new_status, i_new_rate;
 207     vlc_cond_t              stream_wait; /* interface -> input in case of a
 208                                           * status change request            */
 209
 210     /* Demultiplexer data */
 211     void *                  p_demux_data;
 212
 213     /* Programs descriptions */
 214     int                     i_pgrm_number;    /* size of the following array */
 215     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
 216
 217     /* ES descriptions */
 218     int                     i_es_number;
 219     es_descriptor_t **      pp_es;             /* carried elementary streams */
 220     int                     i_selected_es_number;
 221     es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
 222
 223     /* Stream control */
 224     stream_ctrl_t           control;
 225 } stream_descriptor_t;
 226
 227 /*****************************************************************************
 228  * i_p_config_t
 229  *****************************************************************************
 230  * This structure gives plugins pointers to the useful functions of input
 231  *****************************************************************************/
 232 struct input_thread_s;
 233 struct data_packet_s;
 234 struct es_descriptor_s;
 235
 236 typedef struct i_p_config_s
 237 {
 238     int                 (* pf_peek_stream)( struct input_thread_s *,
 239                                             byte_t * buffer, size_t );
 240     void                (* pf_demux_pes)( struct input_thread_s *,
 241                                           struct data_packet_s *,
 242                                           struct es_descriptor_s *,
 243                                           boolean_t b_unit_start,
 244                                           boolean_t b_packet_lost );
 245 } i_p_config_t;
 246
 247 /*****************************************************************************
 248  * input_thread_t
 249  *****************************************************************************
 250  * This structure includes all the local static variables of an input thread
 251  *****************************************************************************/
 252 struct vout_thread_s;
 253
 254 typedef struct input_thread_s
 255 {
 256     /* Thread properties and locks */
 257     boolean_t               b_die;                             /* 'die' flag */
 258     boolean_t               b_error;
 259     boolean_t               b_eof;
 260     vlc_thread_t            thread_id;            /* id for thread functions */
 261     int *                   pi_status;              /* temporary status flag */
 262
 263     /* Input module */
 264     struct module_s *       p_input_module;
 265
 266     /* Init/End */
 267     void                 (* pf_init)( struct input_thread_s * );
 268     void                 (* pf_open)( struct input_thread_s * );
 269     void                 (* pf_close)( struct input_thread_s * );
 270     void                 (* pf_end)( struct input_thread_s * );
 271
 272     /* Read & Demultiplex */
 273     int                  (* pf_read)( struct input_thread_s *,
 274                                       struct data_packet_s * pp_packets[] );
 275     void                 (* pf_demux)( struct input_thread_s *,
 276                                        struct data_packet_s * );
 277
 278     /* Packet management facilities */
 279     struct data_packet_s *(*pf_new_packet)( void *, size_t );
 280     struct pes_packet_s *(* pf_new_pes)( void * );
 281     void                 (* pf_delete_packet)( void *,
 282                                                struct data_packet_s * );
 283     void                 (* pf_delete_pes)( void *, struct pes_packet_s * );
 284
 285     /* Stream control capabilities */
 286     int                  (* pf_set_area)( struct input_thread_s *,
 287                                           struct input_area_s * );
 288     int                  (* pf_rewind)( struct input_thread_s * );
 289                                            /* NULL if we don't support going *
 290                                             * backwards (it's gonna be fun)  */
 291     void                 (* pf_seek)( struct input_thread_s *, off_t );
 292
 293     i_p_config_t            i_p_config;              /* plugin configuration */
 294     char *                  p_source;
 295
 296     int                     i_handle;           /* socket or file descriptor */
 297     int                     i_read_once;        /* number of packet read by
 298                                                  * pf_read once */
 299     void *                  p_method_data;     /* data of the packet manager */
 300     void *                  p_plugin_data;             /* data of the plugin */
 301
 302     /* General stream description */
 303     stream_descriptor_t     stream;                            /* PAT tables */
 304
 305     /* For auto-launch of decoders */
 306     struct vout_thread_s *  p_default_vout;
 307
 308 #ifdef STATS
 309     count_t                 c_loops;
 310     count_t                 c_bytes;                           /* bytes read */
 311     count_t                 c_payload_bytes;         /* payload useful bytes */
 312     count_t                 c_packets_read;                  /* packets read */
 313     count_t                 c_packets_trashed;            /* trashed packets */
 314 #endif
 315 } input_thread_t;
 316
 317 /* Input methods */
 318 /* The first figure is a general method that can be used in interface plugins ;
 319  * The second figure is a detailed sub-method */
 320 #define INPUT_METHOD_NONE         0x0            /* input thread is inactive */
 321 #define INPUT_METHOD_FILE        0x10   /* stream is read from file p_source */
 322 #define INPUT_METHOD_DISC        0x20   /* stream is read directly from disc */
 323 #define INPUT_METHOD_DVD         0x21             /* stream is read from DVD */
 324 #define INPUT_METHOD_VCD         0x22             /* stream is read from VCD */
 325 #define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
 326 #define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
 327 #define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
 328 #define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
 329 #define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */
 330
 331
 332 /* Status changing methods */
 333 #define INPUT_STATUS_END            0
 334 #define INPUT_STATUS_PLAY           1
 335 #define INPUT_STATUS_PAUSE          2
 336 #define INPUT_STATUS_FASTER         3
 337 #define INPUT_STATUS_SLOWER         4
 338
 339 /*****************************************************************************
 340  * Prototypes
 341  *****************************************************************************/
 342 struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
 343                                              int *pi_status );
 344 void input_DestroyThread( struct input_thread_s *, int *pi_status );
 345
 346 void input_SetStatus( struct input_thread_s *, int );
 347 void input_SetRate  ( struct input_thread_s *, int );
 348 void input_Seek     ( struct input_thread_s *, off_t );
 349 void input_DumpStream( struct input_thread_s * );
 350 char * input_OffsetToTime( struct input_thread_s *, char * psz_buffer, off_t );
 351 int  input_ChangeES ( struct input_thread_s *, struct es_descriptor_s *, u8 );
 352 int  input_ToggleES ( struct input_thread_s *,
 353                       struct es_descriptor_s *,
 354                       boolean_t );