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.63 2002/03/21 02:27:04 jobi 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 /* FIXME ! */
  30 #define REQUESTED_MPEG         1
  31 #define REQUESTED_AC3          2
  32 #define REQUESTED_LPCM         3
  33 #define REQUESTED_NOAUDIO    255
  34
  35 #define OFFSETTOTIME_MAX_SIZE       10
  36
  37 /*****************************************************************************
  38  * input_bank_t, p_input_bank (global variable)
  39  *****************************************************************************
  40  * This global variable is accessed by any function using the input.
  41  *****************************************************************************/
  42 typedef struct input_bank_s
  43 {
  44     /* Array to all the input threads */
  45     struct input_thread_s *pp_input[ INPUT_MAX_THREADS ];
  46
  47     int                   i_count;
  48     vlc_mutex_t           lock;                               /* Global lock */
  49
  50 } input_bank_t;
  51
  52 #ifndef PLUGIN
  53 extern input_bank_t *p_input_bank;
  54 #else
  55 #   define p_input_bank (p_symbols->p_input_bank)
  56 #endif
  57
  58 /*****************************************************************************
  59  * es_descriptor_t: elementary stream descriptor
  60  *****************************************************************************
  61  * Describes an elementary stream, and includes fields required to handle and
  62  * demultiplex this elementary stream.
  63  *****************************************************************************/
  64 typedef struct es_descriptor_s
  65 {
  66     u16                     i_id;            /* stream ID for PS, PID for TS */
  67     u8                      i_stream_id;     /* stream ID defined in the PES */
  68     u8                      i_type;                           /* stream type */
  69     boolean_t               b_audio;      /* is the stream an audio stream that
  70                                            * will need to be discarded with
  71                                            * fast forward and slow motion ?  */
  72     u8                      i_cat;        /* stream category: video, audio,
  73                                            * spu, other */
  74 #ifdef HAVE_SATELLITE
  75     int                     i_dmx_fd;     /* used to store demux device
  76                                              file handle */
  77 #endif
  78     char                    psz_desc[20]; /* description of ES: audio language
  79                                            * for instance ; NULL if not
  80                                            *  available */
  81
  82     /* Demultiplexer information */
  83     void *                  p_demux_data;
  84     struct pgrm_descriptor_s *
  85                             p_pgrm;  /* very convenient in the demultiplexer */
  86
  87     /* PES parser information */
  88     struct pes_packet_s *   p_pes;                            /* Current PES */
  89     int                     i_pes_real_size;   /* as indicated by the header */
  90
  91     /* Decoder information */
  92     struct decoder_fifo_s * p_decoder_fifo;
  93     vlc_thread_t            thread_id;                  /* ID of the decoder */
  94
  95     count_t                 c_packets;                 /* total packets read */
  96     count_t                 c_invalid_packets;       /* invalid packets read */
  97
  98     /* Module properties */
  99     struct module_s *         p_module;
 100     struct decoder_config_s * p_config;
 101
 102 } es_descriptor_t;
 103
 104 /* Special PID values - note that the PID is only on 13 bits, and that values
 105  * greater than 0x1fff have no meaning in a stream */
 106 #define PROGRAM_ASSOCIATION_TABLE_PID   0x0000
 107 #define CONDITIONNAL_ACCESS_TABLE_PID   0x0001                   /* not used */
 108 #define EMPTY_ID                        0xffff    /* empty record in a table */
 109
 110
 111 /* ES Categories to be used by interface plugins */
 112 #define VIDEO_ES        0x00
 113 #define AUDIO_ES        0x01
 114 #define SPU_ES          0x02
 115 #define NAV_ES          0x03
 116 #define UNKNOWN_ES      0xFF
 117
 118 /*****************************************************************************
 119  * pgrm_descriptor_t
 120  *****************************************************************************
 121  * Describes a program and list associated elementary streams. It is build by
 122  * the PSI decoder upon the informations carried in program map sections
 123  *****************************************************************************/
 124 typedef struct pgrm_descriptor_s
 125 {
 126     /* Program characteristics */
 127     u16                     i_number;                      /* program number */
 128     u8                      i_version;                     /* version number */
 129     boolean_t               b_is_ok;      /* Is the description up to date ? */
 130
 131     /* Service Descriptor (program name) - DVB extension */
 132     u8                      i_srv_type;
 133     char *                  psz_srv_name;
 134
 135     /* Synchronization information */
 136     mtime_t                 delta_cr;
 137     mtime_t                 cr_ref, sysdate_ref;
 138     mtime_t                 last_cr; /* reference to detect unexpected stream
 139                                       * discontinuities                      */
 140     mtime_t                 last_syscr;
 141     count_t                 c_average_count;
 142                            /* counter used to compute dynamic average values */
 143     int                     i_synchro_state;
 144
 145     /* Demultiplexer data */
 146     void *                  p_demux_data;
 147
 148     int                     i_es_number;      /* size of the following array */
 149     es_descriptor_t **      pp_es;                /* array of pointers to ES */
 150 } pgrm_descriptor_t;
 151
 152 /* Synchro states */
 153 #define SYNCHRO_OK          0
 154 #define SYNCHRO_START       1
 155 #define SYNCHRO_REINIT      2
 156
 157 /*****************************************************************************
 158  * input_area_t
 159  *****************************************************************************
 160  * Attributes for current area (title for DVD)
 161  *****************************************************************************/
 162 typedef struct input_area_s
 163 {
 164     /* selected area attributes */
 165     int                     i_id;        /* identificator for area */
 166     off_t                   i_start;     /* start offset of area */
 167     off_t                   i_size;      /* total size of the area
 168                                           * (in arbitrary units) */
 169
 170     /* navigation parameters */
 171     off_t                   i_tell;      /* actual location in the area
 172                                           * (in arbitrary units) */
 173     off_t                   i_seek;      /* next requested location
 174                                           * (changed by the interface thread */
 175
 176     /* area subdivision */
 177     int                     i_part_nb;   /* number of parts (chapter for DVD)*/
 178     int                     i_part;      /* currently selected part */
 179
 180
 181     /* offset to plugin related data */
 182     off_t                   i_plugin_data;
 183 } input_area_t;
 184
 185 /*****************************************************************************
 186  * stream_descriptor_t
 187  *****************************************************************************
 188  * Describes a stream and list its associated programs. Build upon
 189  * the information carried in program association sections (for instance)
 190  *****************************************************************************/
 191 typedef struct stream_descriptor_s
 192 {
 193     u16                     i_stream_id;                        /* stream id */
 194     boolean_t               b_changed;    /* if stream has been changed,
 195                                              we have to inform the interface */
 196     vlc_mutex_t             stream_lock;  /* to be taken every time you read
 197                                            * or modify stream, pgrm or es    */
 198
 199     /* Input method data */
 200     int                     i_method;       /* input method for stream: file,
 201                                                disc or network */
 202     boolean_t               b_pace_control;    /* can we read when we want ? */
 203     boolean_t               b_seekable;               /* can we do lseek() ? */
 204
 205     /* if (b_seekable) : */
 206     int                     i_area_nb;
 207     input_area_t **         pp_areas;    /* list of areas in stream == offset
 208                                           * interval with own properties */
 209     input_area_t *          p_selected_area;
 210     input_area_t *          p_new_area;  /* Newly selected area from
 211                                           * the interface */
 212
 213     u32                     i_mux_rate; /* the rate we read the stream (in
 214                                          * units of 50 bytes/s) ; 0 if undef */
 215
 216     /* New status and rate requested by the interface */
 217     int                     i_new_status, i_new_rate;
 218     int                     b_new_mute;          /* int because it can be -1 */
 219     vlc_cond_t              stream_wait; /* interface -> input in case of a
 220                                           * status change request            */
 221
 222     /* Demultiplexer data */
 223     void *                  p_demux_data;
 224
 225     /* Programs descriptions */
 226     int                     i_pgrm_number;    /* size of the following array */
 227     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
 228     pgrm_descriptor_t *     p_selected_program;   /* currently
 229                                                  selected program */
 230     pgrm_descriptor_t *     p_new_program;        /* Newly selected program */
 231     /* ES descriptions */
 232     int                     i_es_number;
 233     es_descriptor_t **      pp_es;             /* carried elementary streams */
 234     int                     i_selected_es_number;
 235     es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
 236     es_descriptor_t *       p_newly_selected_es;   /* ES selected from
 237                                                     * the interface */
 238     es_descriptor_t *       p_removed_es;   /* ES removed from the interface */
 239
 240
 241     /* Stream control */
 242     stream_ctrl_t           control;
 243
 244     /* Statistics */
 245     count_t                 c_packets_read;                  /* packets read */
 246     count_t                 c_packets_trashed;            /* trashed packets */
 247 } stream_descriptor_t;
 248
 249 #define MUTE_NO_CHANGE      -1
 250
 251 /*****************************************************************************
 252  * input_thread_t
 253  *****************************************************************************
 254  * This structure includes all the local static variables of an input thread
 255  *****************************************************************************/
 256 typedef struct input_thread_s
 257 {
 258     /* Thread properties and locks */
 259     boolean_t               b_die;                             /* 'die' flag */
 260     boolean_t               b_error;
 261     boolean_t               b_eof;
 262     vlc_thread_t            thread_id;            /* id for thread functions */
 263     int                     i_status;                         /* status flag */
 264
 265     /* Access module */
 266     struct module_s *       p_access_module;
 267     int                  (* pf_open)( struct input_thread_s * );
 268     void                 (* pf_close)( struct input_thread_s * );
 269     ssize_t              (* pf_read) ( struct input_thread_s *,
 270                                        byte_t *, size_t );
 271     int                  (* pf_set_program)( struct input_thread_s *,
 272                                              struct pgrm_descriptor_s * );
 273     int                  (* pf_set_area)( struct input_thread_s *,
 274                                           struct input_area_s * );
 275     void                 (* pf_seek)( struct input_thread_s *, off_t );
 276     void *                  p_access_data;
 277     size_t                  i_mtu;
 278
 279     /* Demux module */
 280     struct module_s *       p_demux_module;
 281     int                  (* pf_init)( struct input_thread_s * );
 282     void                 (* pf_end)( struct input_thread_s * );
 283     int                  (* pf_demux)( struct input_thread_s * );
 284     int                  (* pf_rewind)( struct input_thread_s * );
 285                                            /* NULL if we don't support going *
 286                                             * backwards (it's gonna be fun)  */
 287     void *                  p_demux_data;               /* data of the demux */
 288
 289     /* Buffer manager */
 290     struct input_buffers_s *p_method_data;     /* data of the packet manager */
 291     struct data_buffer_s *  p_data_buffer;
 292     byte_t *                p_current_data;
 293     byte_t *                p_last_data;
 294     size_t                  i_bufsize;
 295
 296     /* General stream description */
 297     stream_descriptor_t     stream;
 298
 299     /* Playlist item */
 300     char *                  psz_source;
 301     char *                  psz_access;
 302     char *                  psz_demux;
 303     char *                  psz_name;
 304
 305     count_t                 c_loops;
 306 } input_thread_t;
 307
 308 /* Input methods */
 309 /* The first figure is a general method that can be used in interface plugins ;
 310  * The second figure is a detailed sub-method */
 311 #define INPUT_METHOD_NONE         0x0            /* input thread is inactive */
 312 #define INPUT_METHOD_FILE        0x10   /* stream is read from file p_source */
 313 #define INPUT_METHOD_DISC        0x20   /* stream is read directly from disc */
 314 #define INPUT_METHOD_DVD         0x21             /* stream is read from DVD */
 315 #define INPUT_METHOD_VCD         0x22             /* stream is read from VCD */
 316 #define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
 317 #define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
 318 #define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
 319 #define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
 320 #define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */
 321 #define INPUT_METHOD_SATELLITE   0x40               /* stream is read from a */
 322                                                            /* satellite card */
 323
 324 /* Status changing methods */
 325 #define INPUT_STATUS_END            0
 326 #define INPUT_STATUS_PLAY           1
 327 #define INPUT_STATUS_PAUSE          2
 328 #define INPUT_STATUS_FASTER         3
 329 #define INPUT_STATUS_SLOWER         4
 330
 331 /*****************************************************************************
 332  * Prototypes
 333  *****************************************************************************/
 334 #ifndef PLUGIN
 335 void   input_InitBank       ( void );
 336 void   input_EndBank        ( void );
 337
 338 struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
 339                                              int *pi_status );
 340 void   input_StopThread     ( struct input_thread_s *, int *pi_status );
 341 void   input_DestroyThread  ( struct input_thread_s * );
 342
 343 void   input_SetStatus      ( struct input_thread_s *, int );
 344 void   input_Seek           ( struct input_thread_s *, off_t );
 345 void   input_DumpStream     ( struct input_thread_s * );
 346 char * input_OffsetToTime   ( struct input_thread_s *, char *, off_t );
 347 int    input_ChangeES       ( struct input_thread_s *,
 348                               struct es_descriptor_s *, u8 );
 349 int    input_ToggleES       ( struct input_thread_s *,
 350                               struct es_descriptor_s *, boolean_t );
 351 int    input_ChangeArea     ( struct input_thread_s *, struct input_area_s * );
 352 int    input_ChangeProgram  ( struct input_thread_s *, u16 );
 353 int    input_ToggleGrayscale( struct input_thread_s * );
 354 int    input_ToggleMute     ( struct input_thread_s * );
 355 int    input_SetSMP         ( struct input_thread_s *, int );
 356 #else
 357 #   define input_SetStatus      p_symbols->input_SetStatus
 358 #   define input_Seek           p_symbols->input_Seek
 359 #   define input_DumpStream     p_symbols->input_DumpStream
 360 #   define input_OffsetToTime   p_symbols->input_OffsetToTime
 361 #   define input_ChangeES       p_symbols->input_ChangeES
 362 #   define input_ToggleES       p_symbols->input_ToggleES
 363 #   define input_ChangeArea     p_symbols->input_ChangeArea
 364 #   define input_ChangeProgram  p_symbols->input_ChangeProgram
 365 #endif
 366