input_ext-intf.h 16 KB
Newer Older
1 2 3 4 5 6
/*****************************************************************************
 * input_ext-intf.h: structures of the input exported to the interface
 * This header provides structures to read the stream descriptors and
 * control the pace of reading. 
 *****************************************************************************
 * Copyright (C) 1999, 2000 VideoLAN
7
 * $Id: input_ext-intf.h,v 1.53 2001/12/12 13:48:09 massiot Exp $
8
 *
9
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 *****************************************************************************/
25 26 27 28 29

/*
 * Communication input -> interface
 */
#define INPUT_MAX_PLUGINS   1
30
/* FIXME ! */
31 32 33
#define REQUESTED_MPEG         1
#define REQUESTED_AC3          2
#define REQUESTED_LPCM         3
34
#define REQUESTED_NOAUDIO    255
35

36 37
#define OFFSETTOTIME_MAX_SIZE       10

38 39 40 41 42 43 44 45 46 47 48 49 50 51
/*****************************************************************************
 * es_descriptor_t: elementary stream descriptor
 *****************************************************************************
 * Describes an elementary stream, and includes fields required to handle and
 * demultiplex this elementary stream.
 *****************************************************************************/
struct decoder_fifo_s;                         /* defined in input_ext-dec.h */
struct pgrm_descriptor_s;

typedef struct es_descriptor_s
{
    u16                     i_id;            /* stream ID for PS, PID for TS */
    u8                      i_stream_id;     /* stream ID defined in the PES */
    u8                      i_type;                           /* stream type */
52 53 54
    boolean_t               b_audio;      /* is the stream an audio stream that
                                           * will need to be discarded with
                                           * fast forward and slow motion ?  */
Stéphane Borel's avatar
Stéphane Borel committed
55 56
    u8                      i_cat;        /* stream category: video, audio,
                                           * spu, other */
57

Stéphane Borel's avatar
 
Stéphane Borel committed
58 59 60
    char                    psz_desc[20]; /* description of ES: audio language
                                           * for instance ; NULL if not
                                           *  available */
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

    /* Demultiplexer information */
    void *                  p_demux_data;
    struct pgrm_descriptor_s *
                            p_pgrm;  /* very convenient in the demultiplexer */

    /* PES parser information */
    struct pes_packet_s *   p_pes;                            /* Current PES */
    int                     i_pes_real_size;   /* as indicated by the header */

    /* Decoder information */
    struct decoder_fifo_s * p_decoder_fifo;
    vlc_thread_t            thread_id;                  /* ID of the decoder */

    count_t                 c_packets;                 /* total packets read */
    count_t                 c_invalid_packets;       /* invalid packets read */
Henri Fallon's avatar
 
Henri Fallon committed
77

Sam Hocevar's avatar
 
Sam Hocevar committed
78 79 80 81
    /* Module properties */
    struct module_s *         p_module;
    struct decoder_config_s * p_config;

82 83 84 85 86 87 88 89 90
} es_descriptor_t;

/* Special PID values - note that the PID is only on 13 bits, and that values
 * greater than 0x1fff have no meaning in a stream */
#define PROGRAM_ASSOCIATION_TABLE_PID   0x0000
#define CONDITIONNAL_ACCESS_TABLE_PID   0x0001                   /* not used */
#define EMPTY_ID                        0xffff    /* empty record in a table */
 

91
/* ES Categories to be used by interface plugins */
Stéphane Borel's avatar
Stéphane Borel committed
92 93 94 95 96
#define VIDEO_ES        0x00
#define AUDIO_ES        0x01
#define SPU_ES          0x02
#define NAV_ES          0x03
#define UNKNOWN_ES      0xFF
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
/*****************************************************************************
 * pgrm_descriptor_t
 *****************************************************************************
 * Describes a program and list associated elementary streams. It is build by
 * the PSI decoder upon the informations carried in program map sections
 *****************************************************************************/
typedef struct pgrm_descriptor_s
{
    /* Program characteristics */
    u16                     i_number;                      /* program number */
    u8                      i_version;                     /* version number */
    boolean_t               b_is_ok;      /* Is the description up to date ? */

    /* Service Descriptor (program name) - DVB extension */
    u8                      i_srv_type;
    char *                  psz_srv_name;

    /* Synchronization information */
    mtime_t                 delta_cr;
116
    mtime_t                 cr_ref, sysdate_ref;
117 118
    mtime_t                 last_cr; /* reference to detect unexpected stream
                                      * discontinuities                      */
119
    mtime_t                 last_syscr;
120 121 122 123 124 125 126 127 128 129 130 131 132
    count_t                 c_average_count;
                           /* counter used to compute dynamic average values */
    int                     i_synchro_state;

    /* Demultiplexer data */
    void *                  p_demux_data;

    int                     i_es_number;      /* size of the following array */
    es_descriptor_t **      pp_es;                /* array of pointers to ES */
} pgrm_descriptor_t;

/* Synchro states */
#define SYNCHRO_OK          0
133 134
#define SYNCHRO_START       1
#define SYNCHRO_REINIT      2
135

Stéphane Borel's avatar
 
Stéphane Borel committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/*****************************************************************************
 * input_area_t
 *****************************************************************************
 * Attributes for current area (title for DVD)
 *****************************************************************************/
typedef struct input_area_s
{
    /* selected area attributes */
    int                     i_id;        /* identificator for area */
    off_t                   i_start;     /* start offset of area */
    off_t                   i_size;      /* total size of the area
                                          * (in arbitrary units) */

    /* navigation parameters */
    off_t                   i_tell;      /* actual location in the area
                                          * (in arbitrary units) */
    off_t                   i_seek;      /* next requested location
                                          * (changed by the interface thread */

    /* area subdivision */
    int                     i_part_nb;   /* number of parts (chapter for DVD)*/
    int                     i_part;      /* currently selected part */

159 160 161
    int                     i_angle_nb;  /* number of angles/title units */
    int                     i_angle;

Stéphane Borel's avatar
 
Stéphane Borel committed
162 163 164 165
    /* offset to plugin related data */
    off_t                   i_plugin_data;
} input_area_t;

166 167 168 169 170 171 172 173 174
/*****************************************************************************
 * stream_descriptor_t
 *****************************************************************************
 * Describes a stream and list its associated programs. Build upon
 * the information carried in program association sections (for instance)
 *****************************************************************************/
typedef struct stream_descriptor_s
{
    u16                     i_stream_id;                        /* stream id */
175 176
    boolean_t               b_changed;    /* if stream has been changed,
                                             we have to inform the interface */
177 178 179 180
    vlc_mutex_t             stream_lock;  /* to be taken every time you read
                                           * or modify stream, pgrm or es    */

    /* Input method data */
181 182
    int                     i_method;       /* input method for stream: file,
                                               disc or network */
183 184
    boolean_t               b_pace_control;    /* can we read when we want ? */
    boolean_t               b_seekable;               /* can we do lseek() ? */
Stéphane Borel's avatar
 
Stéphane Borel committed
185

186
    /* if (b_seekable) : */
Stéphane Borel's avatar
 
Stéphane Borel committed
187
    int                     i_area_nb;
188 189
    input_area_t **         pp_areas;    /* list of areas in stream == offset
                                          * interval with own properties */
190
    input_area_t *          p_selected_area;
191 192 193
    input_area_t *          p_new_area;  /* Newly selected area from
                                          * the interface */

Christophe Massiot's avatar
Christophe Massiot committed
194 195
    u32                     i_mux_rate; /* the rate we read the stream (in
                                         * units of 50 bytes/s) ; 0 if undef */
196 197 198

    /* New status and rate requested by the interface */
    int                     i_new_status, i_new_rate;
199
    int                     b_new_mute;          /* int because it can be -1 */
200 201
    vlc_cond_t              stream_wait; /* interface -> input in case of a
                                          * status change request            */
202 203 204 205

    /* Demultiplexer data */
    void *                  p_demux_data;

206
    /* Programs descriptions */
207 208
    int                     i_pgrm_number;    /* size of the following array */
    pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
209 210 211
    pgrm_descriptor_t *     p_selected_program;   /* currently 
                                                 selected program */
    pgrm_descriptor_t *     p_new_program;        /* Newly selected program */
212 213 214 215 216
    /* ES descriptions */
    int                     i_es_number;
    es_descriptor_t **      pp_es;             /* carried elementary streams */
    int                     i_selected_es_number;
    es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
217 218 219 220
    es_descriptor_t *       p_newly_selected_es;   /* ES selected from
                                                    * the interface */
    es_descriptor_t *       p_removed_es;   /* ES removed from the interface */

221

222 223
    /* Stream control */
    stream_ctrl_t           control;
224 225 226 227

    /* Statistics */
    count_t                 c_packets_read;                  /* packets read */
    count_t                 c_packets_trashed;            /* trashed packets */
228 229
} stream_descriptor_t;

230 231
#define MUTE_NO_CHANGE      -1

232 233 234 235 236 237
/*****************************************************************************
 * input_thread_t
 *****************************************************************************
 * This structure includes all the local static variables of an input thread
 *****************************************************************************/
struct vout_thread_s;
238
struct bit_stream_s;
239 240 241 242 243 244

typedef struct input_thread_s
{
    /* Thread properties and locks */
    boolean_t               b_die;                             /* 'die' flag */
    boolean_t               b_error;
Sam Hocevar's avatar
 
Sam Hocevar committed
245
    boolean_t               b_eof;
246 247 248
    vlc_thread_t            thread_id;            /* id for thread functions */
    int *                   pi_status;              /* temporary status flag */

Sam Hocevar's avatar
 
Sam Hocevar committed
249 250 251 252 253 254 255 256
    /* Input module */
    struct module_s *       p_input_module;

    /* Init/End */
    void                 (* pf_init)( struct input_thread_s * );
    void                 (* pf_open)( struct input_thread_s * );
    void                 (* pf_close)( struct input_thread_s * );
    void                 (* pf_end)( struct input_thread_s * );
257 258 259 260 261
    void                 (* pf_init_bit_stream)( struct bit_stream_s *,
                              struct decoder_fifo_s *,
                void (* pf_bitstream_callback)( struct bit_stream_s *,
                                                boolean_t ),
                              void * );
Sam Hocevar's avatar
 
Sam Hocevar committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

    /* Read & Demultiplex */
    int                  (* pf_read)( struct input_thread_s *,
                                      struct data_packet_s * pp_packets[] );
    void                 (* pf_demux)( struct input_thread_s *,
                                       struct data_packet_s * );

    /* Packet management facilities */
    struct data_packet_s *(*pf_new_packet)( void *, size_t );
    struct pes_packet_s *(* pf_new_pes)( void * );
    void                 (* pf_delete_packet)( void *,
                                               struct data_packet_s * );
    void                 (* pf_delete_pes)( void *, struct pes_packet_s * );

    /* Stream control capabilities */
277 278
    int                  (* pf_set_program)( struct input_thread_s *,
                                             struct pgrm_descriptor_s * );
279 280
    int                  (* pf_set_area)( struct input_thread_s *,
                                          struct input_area_s * );
Sam Hocevar's avatar
 
Sam Hocevar committed
281 282 283
    int                  (* pf_rewind)( struct input_thread_s * );
                                           /* NULL if we don't support going *
                                            * backwards (it's gonna be fun)  */
284
    void                 (* pf_seek)( struct input_thread_s *, off_t );
285

Sam Hocevar's avatar
 
Sam Hocevar committed
286
    char *                  p_source;
287 288

    int                     i_handle;           /* socket or file descriptor */
289
    FILE *                  p_stream;                       /* if applicable */
Sam Hocevar's avatar
 
Sam Hocevar committed
290
    void *                  p_handle;          /* if i_handle isn't suitable */
291 292
    int                     i_read_once;        /* number of packet read by
                                                 * pf_read once */
293 294
    void *                  p_method_data;     /* data of the packet manager */
    void *                  p_plugin_data;             /* data of the plugin */
295 296 297 298 299 300 301 302

    /* General stream description */
    stream_descriptor_t     stream;                            /* PAT tables */

    count_t                 c_loops;
} input_thread_t;

/* Input methods */
303 304 305 306 307 308 309 310 311 312 313 314 315
/* The first figure is a general method that can be used in interface plugins ;
 * The second figure is a detailed sub-method */
#define INPUT_METHOD_NONE         0x0            /* input thread is inactive */
#define INPUT_METHOD_FILE        0x10   /* stream is read from file p_source */
#define INPUT_METHOD_DISC        0x20   /* stream is read directly from disc */
#define INPUT_METHOD_DVD         0x21             /* stream is read from DVD */
#define INPUT_METHOD_VCD         0x22             /* stream is read from VCD */
#define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
#define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
#define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
#define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
#define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */

316

Sam Hocevar's avatar
 
Sam Hocevar committed
317 318 319 320 321 322
/* Status changing methods */
#define INPUT_STATUS_END            0
#define INPUT_STATUS_PLAY           1
#define INPUT_STATUS_PAUSE          2
#define INPUT_STATUS_FASTER         3
#define INPUT_STATUS_SLOWER         4
Sam Hocevar's avatar
 
Sam Hocevar committed
323

324 325 326
/*****************************************************************************
 * Prototypes
 *****************************************************************************/
Sam Hocevar's avatar
 
Sam Hocevar committed
327 328
struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
                                             int *pi_status );
329
void input_DestroyThread( struct input_thread_s *, int *pi_status );
Sam Hocevar's avatar
 
Sam Hocevar committed
330

Sam Hocevar's avatar
 
Sam Hocevar committed
331 332
void input_SetStatus( struct input_thread_s *, int );
void input_Seek     ( struct input_thread_s *, off_t );
333
void input_DumpStream( struct input_thread_s * );
334
char * input_OffsetToTime( struct input_thread_s *, char * psz_buffer, off_t );
Stéphane Borel's avatar
Stéphane Borel committed
335
int  input_ChangeES ( struct input_thread_s *, struct es_descriptor_s *, u8 );
336 337 338
int  input_ToggleES ( struct input_thread_s *,
                      struct es_descriptor_s *,
                      boolean_t );
339 340 341 342
int  input_ChangeArea( struct input_thread_s *, struct input_area_s * );
int  input_ToggleGrayscale( struct input_thread_s * );
int  input_ToggleMute( struct input_thread_s * );
int  input_SetSMP( struct input_thread_s *, int );
Sam Hocevar's avatar
 
Sam Hocevar committed
343