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