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.87 2003/03/24 17:15:29 gbazin 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 #ifndef _VLC_INPUT_EXT_INTF_H
  27 #define _VLC_INPUT_EXT_INTF_H 1
  28
  29 /*
  30  * Communication input -> interface
  31  */
  32 /* FIXME ! */
  33 #define REQUESTED_MPEG         1
  34 #define REQUESTED_A52          2
  35 #define REQUESTED_LPCM         3
  36 #define REQUESTED_DTS          4
  37 #define REQUESTED_NOAUDIO    255
  38
  39 #define OFFSETTOTIME_MAX_SIZE       10
  40
  41 /*****************************************************************************
  42  * es_descriptor_t: elementary stream descriptor
  43  *****************************************************************************
  44  * Describes an elementary stream, and includes fields required to handle and
  45  * demultiplex this elementary stream.
  46  *****************************************************************************/
  47 struct es_descriptor_t
  48 {
  49     uint16_t                i_id;            /* stream ID for PS, PID for TS */
  50     uint8_t                 i_stream_id;     /* stream ID defined in the PES */
  51     vlc_fourcc_t            i_fourcc;                         /* stream type */
  52     uint8_t                 i_cat;    /* stream category (audio, video, spu) */
  53     int                     i_demux_fd;   /* used to store demux device
  54                                              file handle */
  55     char                    psz_desc[20]; /* description of ES: audio language
  56                                            * for instance ; NULL if not
  57                                            *  available */
  58
  59     /* Demultiplexer information */
  60     es_sys_t *              p_demux_data;
  61     pgrm_descriptor_t *     p_pgrm;  /* very convenient in the demultiplexer */
  62
  63     /* PES parser information */
  64     pes_packet_t *          p_pes;                            /* Current PES */
  65     unsigned int            i_pes_real_size;   /* as indicated by the header */
  66
  67     /* Decoder information */
  68     decoder_fifo_t *        p_decoder_fifo;
  69     void *                  p_waveformatex;
  70     void *                  p_bitmapinfoheader;
  71
  72     count_t                 c_packets;                 /* total packets read */
  73     count_t                 c_invalid_packets;       /* invalid packets read */
  74 };
  75
  76 /* Special PID values - note that the PID is only on 13 bits, and that values
  77  * greater than 0x1fff have no meaning in a stream */
  78 #define PROGRAM_ASSOCIATION_TABLE_PID   0x0000
  79 #define CONDITIONNAL_ACCESS_TABLE_PID   0x0001                   /* not used */
  80 #define EMPTY_ID                        0xffff    /* empty record in a table */
  81
  82
  83 /* ES Categories to be used by interface plugins */
  84 #define UNKNOWN_ES      0x00
  85 #define VIDEO_ES        0x01
  86 #define AUDIO_ES        0x02
  87 #define SPU_ES          0x03
  88 #define NAV_ES          0x04
  89
  90 /*****************************************************************************
  91  * pgrm_descriptor_t
  92  *****************************************************************************
  93  * Describes a program and list associated elementary streams. It is build by
  94  * the PSI decoder upon the informations carried in program map sections
  95  *****************************************************************************/
  96 struct pgrm_descriptor_t
  97 {
  98     /* Program characteristics */
  99     uint16_t                i_number;                      /* program number */
 100     uint8_t                 i_version;                     /* version number */
 101     vlc_bool_t              b_is_ok;      /* Is the description up to date ? */
 102
 103     /* Service Descriptor (program name) - DVB extension */
 104     uint8_t                 i_srv_type;
 105     char *                  psz_srv_name;
 106
 107     /* Synchronization information */
 108     mtime_t                 delta_cr;
 109     mtime_t                 cr_ref, sysdate_ref;
 110     mtime_t                 last_cr; /* reference to detect unexpected stream
 111                                       * discontinuities                      */
 112     mtime_t                 last_syscr;
 113     count_t                 c_average_count;
 114                            /* counter used to compute dynamic average values */
 115     int                     i_synchro_state;
 116
 117     /* Demultiplexer data */
 118     pgrm_sys_t *            p_demux_data;
 119
 120     unsigned int            i_es_number;      /* size of the following array */
 121     es_descriptor_t **      pp_es;                /* array of pointers to ES */
 122 };
 123
 124 /* Synchro states */
 125 #define SYNCHRO_OK          0
 126 #define SYNCHRO_START       1
 127 #define SYNCHRO_REINIT      2
 128
 129 /*****************************************************************************
 130  * input_area_t
 131  *****************************************************************************
 132  * Attributes for current area (title for DVD)
 133  *****************************************************************************/
 134 struct input_area_t
 135 {
 136     /* selected area attributes */
 137     unsigned int            i_id;        /* identificator for area */
 138     off_t                   i_start;     /* start offset of area */
 139     off_t                   i_size;      /* total size of the area
 140                                           * (in arbitrary units) */
 141
 142     /* navigation parameters */
 143     off_t                   i_tell;      /* actual location in the area
 144                                           * (in arbitrary units) */
 145     off_t                   i_seek;      /* next requested location
 146                                           * (changed by the interface thread */
 147
 148     /* area subdivision */
 149     unsigned int            i_part_nb;   /* number of parts (chapter for DVD)*/
 150     unsigned int            i_part;      /* currently selected part */
 151
 152
 153     /* offset to plugin related data */
 154     off_t                   i_plugin_data;
 155 };
 156
 157 /**
 158  * \brief A list of info items.
 159  *
 160  * Composes a linked list of name/value pairs intended to inform the
 161  * user about the current stream
 162  * \see input_AddInfo
 163  */
 164 struct input_info_t {
 165     /**
 166      * Name of this item
 167      */
 168     char *         psz_name;
 169
 170     /**
 171      * Value of this item
 172      */
 173     char *         psz_value;
 174
 175     /**
 176      * Pointer to next item in list, or NULL it at end of list
 177      */
 178     input_info_t * p_next;
 179 };
 180
 181 /**
 182  * \brief A list of info categories.
 183  *
 184  * Composes a NULL terminated linked list of categories in which to
 185  * place info about the stream.
 186  *
 187  * \see input_InfoCategory
 188  */
 189 struct input_info_category_t {
 190     /**
 191      * The name of this category
 192      */
 193     char *                  psz_name;
 194
 195     /**
 196      * first element of a linked list containing info items
 197      */
 198     input_info_t *          p_info;
 199
 200     /**
 201      * Pointer to next element in this list, or NULL if at end of list
 202      */
 203     input_info_category_t * p_next;
 204 };
 205
 206 /*****************************************************************************
 207 * stream_descriptor_t
 208  *****************************************************************************
 209  * Describes a stream and list its associated programs. Build upon
 210  * the information carried in program association sections (for instance)
 211  *****************************************************************************/
 212 struct stream_descriptor_t
 213 {
 214     uint16_t                i_stream_id;                        /* stream id */
 215     vlc_bool_t              b_changed;    /* if stream has been changed,
 216                                              we have to inform the interface */
 217     vlc_mutex_t             stream_lock;  /* to be taken every time you read
 218                                            * or modify stream, pgrm or es    */
 219
 220     /* Input method data */
 221     unsigned int            i_method;       /* input method for stream: file,
 222                                                disc or network */
 223     vlc_bool_t              b_pace_control;    /* can we read when we want ? */
 224     vlc_bool_t              b_seekable;               /* can we do lseek() ? */
 225
 226     /* if (b_seekable) : */
 227     unsigned int            i_area_nb;
 228     input_area_t **         pp_areas;    /* list of areas in stream == offset
 229                                           * interval with own properties */
 230     input_area_t *          p_selected_area;
 231     input_area_t *          p_new_area;  /* Newly selected area from
 232                                           * the interface */
 233
 234     uint32_t                i_mux_rate; /* the rate we read the stream (in
 235                                          * units of 50 bytes/s) ; 0 if undef */
 236
 237     /* New status and rate requested by the interface */
 238     unsigned int            i_new_status, i_new_rate;
 239     int                     b_new_mute;          /* int because it can be -1 */
 240     vlc_cond_t              stream_wait; /* interface -> input in case of a
 241                                           * status change request            */
 242
 243     /* Demultiplexer data */
 244     stream_sys_t *          p_demux_data;
 245
 246     /* Programs descriptions */
 247     unsigned int            i_pgrm_number;    /* size of the following array */
 248     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
 249     pgrm_descriptor_t *     p_selected_program;   /* currently
 250                                                  selected program */
 251     pgrm_descriptor_t *     p_new_program;        /* Newly selected program */
 252     /* ES descriptions */
 253     unsigned int            i_es_number;
 254     es_descriptor_t **      pp_es;             /* carried elementary streams */
 255     unsigned int            i_selected_es_number;
 256     es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
 257     es_descriptor_t *       p_newly_selected_es;   /* ES selected from
 258                                                     * the interface */
 259     es_descriptor_t *       p_removed_es;   /* ES removed from the interface */
 260
 261     /* Stream control */
 262     stream_ctrl_t           control;
 263
 264     /* Optional stream output */
 265     sout_instance_t *       p_sout;
 266
 267     /* Input info */
 268     input_info_category_t * p_info;
 269
 270     /* Statistics */
 271     count_t                 c_packets_read;                  /* packets read */
 272     count_t                 c_packets_trashed;            /* trashed packets */
 273 };
 274
 275 /*****************************************************************************
 276  * stream_position_t
 277  *****************************************************************************
 278  * Describes the current position in the stream.
 279  *****************************************************************************/
 280 struct stream_position_t
 281 {
 282     off_t    i_tell;     /* actual location in the area (in arbitrary units) */
 283     off_t    i_size;          /* total size of the area (in arbitrary units) */
 284
 285     uint32_t i_mux_rate;                /* the rate we read the stream (in
 286                                          * units of 50 bytes/s) ; 0 if undef */
 287 };
 288
 289 #define MUTE_NO_CHANGE      -1
 290
 291 /*****************************************************************************
 292  * input_thread_t
 293  *****************************************************************************
 294  * This structure includes all the local static variables of an input thread
 295  *****************************************************************************/
 296 struct input_thread_t
 297 {
 298     VLC_COMMON_MEMBERS
 299
 300     /* Thread properties */
 301     vlc_bool_t              b_eof;
 302
 303     /* Access module */
 304     module_t *       p_access;
 305     ssize_t       (* pf_read ) ( input_thread_t *, byte_t *, size_t );
 306     int           (* pf_set_program )( input_thread_t *, pgrm_descriptor_t * );
 307     int           (* pf_set_area )( input_thread_t *, input_area_t * );
 308     void          (* pf_seek ) ( input_thread_t *, off_t );
 309     access_sys_t *   p_access_data;
 310     size_t           i_mtu;
 311     int              i_pts_delay;                        /* internal caching */
 312
 313     /* Demux module */
 314     module_t *       p_demux;
 315     int           (* pf_demux )  ( input_thread_t * );
 316     int           (* pf_rewind ) ( input_thread_t * );
 317                                            /* NULL if we don't support going *
 318                                             * backwards (it's gonna be fun)  */
 319     demux_sys_t *    p_demux_data;                      /* data of the demux */
 320
 321     /* Buffer manager */
 322     input_buffers_t *p_method_data;     /* data of the packet manager */
 323     data_buffer_t *  p_data_buffer;
 324     byte_t *         p_current_data;
 325     byte_t *         p_last_data;
 326     size_t           i_bufsize;
 327
 328     /* General stream description */
 329     stream_descriptor_t     stream;
 330
 331     /* Playlist item */
 332     char *  psz_source;
 333     char *  psz_dupsource;
 334     char *  psz_access;
 335     char *  psz_demux;
 336     char *  psz_name;
 337
 338     count_t c_loops;
 339 };
 340
 341 /* Input methods */
 342 /* The first figure is a general method that can be used in interface plugins ;
 343  * The second figure is a detailed sub-method */
 344 #define INPUT_METHOD_NONE         0x0            /* input thread is inactive */
 345 #define INPUT_METHOD_FILE        0x10   /* stream is read from file p_source */
 346 #define INPUT_METHOD_DISC        0x20   /* stream is read directly from disc */
 347 #define INPUT_METHOD_DVD         0x21             /* stream is read from DVD */
 348 #define INPUT_METHOD_VCD         0x22             /* stream is read from VCD */
 349 #define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
 350 #define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
 351 #define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
 352 #define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
 353 #define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */
 354 #define INPUT_METHOD_SATELLITE   0x40               /* stream is read from a */
 355                                                            /* satellite card */
 356 #define INPUT_METHOD_SLP         0x50                          /* SLP stream */
 357
 358 /* Status changing methods */
 359 #define INPUT_STATUS_END            0
 360 #define INPUT_STATUS_PLAY           1
 361 #define INPUT_STATUS_PAUSE          2
 362 #define INPUT_STATUS_FASTER         3
 363 #define INPUT_STATUS_SLOWER         4
 364
 365 /* Seek modes */
 366 #define INPUT_SEEK_SET       0x00
 367 #define INPUT_SEEK_CUR       0x01
 368 #define INPUT_SEEK_END       0x02
 369 #define INPUT_SEEK_BYTES     0x00
 370 #define INPUT_SEEK_SECONDS   0x10
 371 #define INPUT_SEEK_PERCENT   0x20
 372
 373 /*****************************************************************************
 374  * Prototypes
 375  *****************************************************************************/
 376 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
 377 input_thread_t * __input_CreateThread ( vlc_object_t *, playlist_item_t * );
 378 void   input_StopThread     ( input_thread_t * );
 379 void   input_DestroyThread  ( input_thread_t * );
 380
 381 #define input_SetStatus(a,b) __input_SetStatus(VLC_OBJECT(a),b)
 382 VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
 383
 384 #define input_Seek(a,b,c) __input_Seek(VLC_OBJECT(a),b,c)
 385 VLC_EXPORT( void, __input_Seek, ( vlc_object_t *, off_t, int ) );
 386
 387 #define input_Tell(a,b) __input_Tell(VLC_OBJECT(a),b)
 388 VLC_EXPORT( void, __input_Tell, ( vlc_object_t *, stream_position_t * ) );
 389
 390 VLC_EXPORT( void, input_DumpStream, ( input_thread_t * ) );
 391 VLC_EXPORT( char *, input_OffsetToTime, ( input_thread_t *, char *, off_t ) );
 392 VLC_EXPORT( int, input_ToggleES, ( input_thread_t *, es_descriptor_t *, vlc_bool_t ) );
 393 VLC_EXPORT( int, input_ChangeArea, ( input_thread_t *, input_area_t * ) );
 394 VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, uint16_t ) );
 395
 396 int    input_ToggleGrayscale( input_thread_t * );
 397 int    input_ToggleMute     ( input_thread_t * );
 398
 399 #endif /* "input_ext-intf.h" */