]> git.sesse.net Git - vlc/blobdiff - include/input_ext-intf.h
* src/input/control.c, include/ninput.h: Added INPUT_GET_INFO.
[vlc] / include / input_ext-intf.h
index 8e2712ac2c40d6554fafcc4ae7b57ecd67e579e4..1944abb2d2a25b9f7bd4f18711e6dd8cc8e0ef0d 100644 (file)
@@ -1,10 +1,10 @@
 /*****************************************************************************
  * 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. 
+ * control the pace of reading.
  *****************************************************************************
- * Copyright (C) 1999, 2000 VideoLAN
- * $Id: input_ext-intf.h,v 1.71 2002/07/21 19:26:13 sigmunau Exp $
+ * Copyright (C) 1999, 2000, 2003 VideoLAN
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *
@@ -12,7 +12,7 @@
  * 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
 #ifndef _VLC_INPUT_EXT_INTF_H
 #define _VLC_INPUT_EXT_INTF_H 1
 
+#include "vlc_block.h"
+#include "ninput.h"
+
 /*
  * Communication input -> interface
  */
 /* FIXME ! */
 #define REQUESTED_MPEG         1
-#define REQUESTED_AC3          2
+#define REQUESTED_A52          2
 #define REQUESTED_LPCM         3
+#define REQUESTED_DTS          4
 #define REQUESTED_NOAUDIO    255
 
-#define OFFSETTOTIME_MAX_SIZE       10
-
 /*****************************************************************************
  * es_descriptor_t: elementary stream descriptor
  *****************************************************************************
  *****************************************************************************/
 struct es_descriptor_t
 {
-    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 */
-    vlc_bool_t              b_audio;      /* is the stream an audio stream that
-                                           * will need to be discarded with
-                                           * fast forward and slow motion ?  */
-    u8                      i_cat;        /* stream category: video, audio,
-                                           * spu, other */
+    uint16_t                i_id;            /* stream ID for PS, PID for TS */
+    uint8_t                 i_stream_id;     /* stream ID defined in the PES */
+    vlc_fourcc_t            i_fourcc;                         /* stream type */
+    uint8_t                 i_cat;    /* stream category (audio, video, spu) */
     int                     i_demux_fd;   /* used to store demux device
                                              file handle */
-    char                    psz_desc[20]; /* description of ES: audio language
+    char                    *psz_desc;    /* description of ES: audio language
                                            * for instance ; NULL if not
                                            *  available */
 
     /* Demultiplexer information */
-    void *                  p_demux_data;
+    es_sys_t *              p_demux_data;
     pgrm_descriptor_t *     p_pgrm;  /* very convenient in the demultiplexer */
 
     /* PES parser information */
     pes_packet_t *          p_pes;                            /* Current PES */
-    int                     i_pes_real_size;   /* as indicated by the header */
+    unsigned int            i_pes_real_size;   /* as indicated by the header */
 
     /* Decoder information */
-    decoder_fifo_t *        p_decoder_fifo;
-    vlc_thread_t            thread_id;                  /* ID of the decoder */
+    es_format_t             fmt;
+    void *                  p_waveformatex;
+    void *                  p_bitmapinfoheader;
+    void *                  p_spuinfo;
+    /* Decoder */
+    decoder_t *             p_dec;
 
     count_t                 c_packets;                 /* total packets read */
     count_t                 c_invalid_packets;       /* invalid packets read */
 
-    /* Module properties */
-    module_t *              p_module;
+    /* XXX hack: to force a decoder instead of mode based on sout */
+    vlc_bool_t              b_force_decoder;
 };
 
 /* Special PID values - note that the PID is only on 13 bits, and that values
@@ -83,14 +85,6 @@ struct es_descriptor_t
 #define PROGRAM_ASSOCIATION_TABLE_PID   0x0000
 #define CONDITIONNAL_ACCESS_TABLE_PID   0x0001                   /* not used */
 #define EMPTY_ID                        0xffff    /* empty record in a table */
-
-/* ES Categories to be used by interface plugins */
-#define VIDEO_ES        0x00
-#define AUDIO_ES        0x01
-#define SPU_ES          0x02
-#define NAV_ES          0x03
-#define UNKNOWN_ES      0xFF
 
 /*****************************************************************************
  * pgrm_descriptor_t
@@ -101,12 +95,12 @@ struct es_descriptor_t
 struct pgrm_descriptor_t
 {
     /* Program characteristics */
-    u16                     i_number;                      /* program number */
-    u8                      i_version;                     /* version number */
+    uint16_t                i_number;                      /* program number */
+    uint8_t                 i_version;                     /* version number */
     vlc_bool_t              b_is_ok;      /* Is the description up to date ? */
 
     /* Service Descriptor (program name) - DVB extension */
-    u8                      i_srv_type;
+    uint8_t                 i_srv_type;
     char *                  psz_srv_name;
 
     /* Synchronization information */
@@ -114,15 +108,15 @@ struct pgrm_descriptor_t
     mtime_t                 cr_ref, sysdate_ref;
     mtime_t                 last_cr; /* reference to detect unexpected stream
                                       * discontinuities                      */
-    mtime_t                 last_syscr;
+    mtime_t                 last_pts;
     count_t                 c_average_count;
                            /* counter used to compute dynamic average values */
     int                     i_synchro_state;
 
     /* Demultiplexer data */
-    void *                  p_demux_data;
+    pgrm_sys_t *            p_demux_data;
 
-    int                     i_es_number;      /* size of the following array */
+    unsigned int            i_es_number;      /* size of the following array */
     es_descriptor_t **      pp_es;                /* array of pointers to ES */
 };
 
@@ -139,7 +133,7 @@ struct pgrm_descriptor_t
 struct input_area_t
 {
     /* selected area attributes */
-    int                     i_id;        /* identificator for area */
+    unsigned 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) */
@@ -151,8 +145,8 @@ struct input_area_t
                                           * (changed by the interface thread */
 
     /* area subdivision */
-    int                     i_part_nb;   /* number of parts (chapter for DVD)*/
-    int                     i_part;      /* currently selected part */
+    unsigned int            i_part_nb;   /* number of parts (chapter for DVD)*/
+    unsigned int            i_part;      /* currently selected part */
 
 
     /* offset to plugin related data */
@@ -160,90 +154,65 @@ struct input_area_t
 };
 
 /*****************************************************************************
- * input_info_t
- *****************************************************************************
- * Composes a linked list of name/value pairs intended to inform the
- * user about the current stream
- *****************************************************************************/
-struct input_info_t {
-  char *         psz_name;
-  char *         psz_value;
-  input_info_t * p_next;
-};
-
-/*****************************************************************************
- * input_info_category_t
- *****************************************************************************
- * Composes a linked list of categories in which to place info about
- * the stream.
- *****************************************************************************/
-struct input_info_category_t {
-  char *                  psz_name;
-  input_info_t *          p_info;
-  input_info_category_t * p_next;
-};
-
-/*****************************************************************************
-* stream_descriptor_t
+ * stream_descriptor_t
  *****************************************************************************
  * Describes a stream and list its associated programs. Build upon
  * the information carried in program association sections (for instance)
  *****************************************************************************/
 struct stream_descriptor_t
 {
-    u16                     i_stream_id;                        /* stream id */
+    uint16_t                i_stream_id;                        /* stream id */
     vlc_bool_t              b_changed;    /* if stream has been changed,
                                              we have to inform the interface */
     vlc_mutex_t             stream_lock;  /* to be taken every time you read
                                            * or modify stream, pgrm or es    */
 
     /* Input method data */
-    int                     i_method;       /* input method for stream: file,
+    unsigned int            i_method;       /* input method for stream: file,
                                                disc or network */
     vlc_bool_t              b_pace_control;    /* can we read when we want ? */
     vlc_bool_t              b_seekable;               /* can we do lseek() ? */
 
     /* if (b_seekable) : */
-    int                     i_area_nb;
+    unsigned int            i_area_nb;
     input_area_t **         pp_areas;    /* list of areas in stream == offset
                                           * interval with own properties */
     input_area_t *          p_selected_area;
     input_area_t *          p_new_area;  /* Newly selected area from
                                           * the interface */
 
-    u32                     i_mux_rate; /* the rate we read the stream (in
+    uint32_t                i_mux_rate; /* the rate we read the stream (in
                                          * units of 50 bytes/s) ; 0 if undef */
 
     /* New status and rate requested by the interface */
-    int                     i_new_status, i_new_rate;
+    unsigned int            i_new_status, i_new_rate;
     int                     b_new_mute;          /* int because it can be -1 */
     vlc_cond_t              stream_wait; /* interface -> input in case of a
                                           * status change request            */
-
     /* Demultiplexer data */
     void *                  p_demux_data;
 
     /* Programs descriptions */
-    int                     i_pgrm_number;    /* size of the following array */
+    unsigned int            i_pgrm_number;    /* size of the following array */
     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
-    pgrm_descriptor_t *     p_selected_program;   /* currently 
+    pgrm_descriptor_t *     p_selected_program;   /* currently
                                                  selected program */
     pgrm_descriptor_t *     p_new_program;        /* Newly selected program */
     /* ES descriptions */
-    int                     i_es_number;
+    unsigned int            i_es_number;
     es_descriptor_t **      pp_es;             /* carried elementary streams */
-    int                     i_selected_es_number;
+    unsigned int            i_selected_es_number;
     es_descriptor_t **      pp_selected_es;             /* ES with a decoder */
     es_descriptor_t *       p_newly_selected_es;   /* ES selected from
                                                     * the interface */
     es_descriptor_t *       p_removed_es;   /* ES removed from the interface */
-    
+
     /* Stream control */
     stream_ctrl_t           control;
 
-    /* Input info */
-    input_info_category_t * p_info;
-    
+    /* Optional stream output */
+    sout_instance_t *       p_sout;
+
     /* Statistics */
     count_t                 c_packets_read;                  /* packets read */
     count_t                 c_packets_trashed;            /* trashed packets */
@@ -259,12 +228,59 @@ struct stream_position_t
     off_t    i_tell;     /* actual location in the area (in arbitrary units) */
     off_t    i_size;          /* total size of the area (in arbitrary units) */
 
-    u32      i_mux_rate;                /* the rate we read the stream (in
+    uint32_t i_mux_rate;                /* the rate we read the stream (in
                                          * units of 50 bytes/s) ; 0 if undef */
 };
 
 #define MUTE_NO_CHANGE      -1
 
+/*****************************************************************************
+ * info_t
+ *****************************************************************************/
+
+/**
+ * Info item
+ */
+
+struct info_t
+{
+    char *psz_name;            /**< Name of this info */
+    char *psz_value;           /**< Value of the info */
+};
+
+/**
+ * Info category
+ * \see info_t
+ */
+struct info_category_t
+{
+    char   *psz_name;      /**< Name of this category */
+    int    i_infos;        /**< Number of infos in the category */
+    struct info_t **pp_infos;     /**< Pointer to an array of infos */
+};
+
+/*****************************************************************************
+ * input_item_t
+ *****************************************************************************
+ * Describes an input and is used to spawn input_thread_t objects.
+ *****************************************************************************/
+struct input_item_t
+{
+    char       *psz_name;            /**< text describing this item */
+    char       *psz_uri;             /**< mrl of this item */
+
+    int        i_options;            /**< Number of input options */
+    char       **ppsz_options;       /**< Array of input options */
+
+    mtime_t    i_duration;           /**< A hint about the duration of this
+                                      * item, in milliseconds*/
+
+    int        i_categories;         /**< Number of info categories */
+    info_category_t **pp_categories; /**< Pointer to the first info category */
+
+    vlc_mutex_t lock;                /**< Item cannot be changed without this lock */
+};
+
 /*****************************************************************************
  * input_thread_t
  *****************************************************************************
@@ -276,27 +292,33 @@ struct input_thread_t
 
     /* Thread properties */
     vlc_bool_t              b_eof;
+    vlc_bool_t              b_out_pace_control;
 
     /* Access module */
-    module_t *       p_access_module;
-    int           (* pf_open ) ( input_thread_t * );
-    void          (* pf_close )( input_thread_t * );
+    module_t *       p_access;
     ssize_t       (* pf_read ) ( input_thread_t *, byte_t *, size_t );
     int           (* pf_set_program )( input_thread_t *, pgrm_descriptor_t * );
     int           (* pf_set_area )( input_thread_t *, input_area_t * );
     void          (* pf_seek ) ( input_thread_t *, off_t );
-    void *           p_access_data;
+    access_sys_t *   p_access_data;
     size_t           i_mtu;
+    int              i_pts_delay;                        /* internal caching */
+    int              i_cr_average;
+
+    /* Stream */
+    stream_t        *s;
 
     /* Demux module */
-    module_t *       p_demux_module;
-    int           (* pf_init )   ( input_thread_t * );
-    void          (* pf_end )    ( input_thread_t * );
+    module_t *       p_demux;
     int           (* pf_demux )  ( input_thread_t * );
     int           (* pf_rewind ) ( input_thread_t * );
                                            /* NULL if we don't support going *
                                             * backwards (it's gonna be fun)  */
-    void *           p_demux_data;                      /* data of the demux */
+    int           (* pf_demux_control ) ( input_thread_t *, int, va_list );
+    demux_sys_t *    p_demux_data;                      /* data of the demux */
+
+    /* es out */
+    es_out_t        *p_es_out;
 
     /* Buffer manager */
     input_buffers_t *p_method_data;     /* data of the packet manager */
@@ -308,13 +330,24 @@ struct input_thread_t
     /* General stream description */
     stream_descriptor_t     stream;
 
+    /* Input item description */
+    input_item_t *p_item;
+
     /* Playlist item */
     char *  psz_source;
+    char *  psz_dupsource;
     char *  psz_access;
     char *  psz_demux;
     char *  psz_name;
 
     count_t c_loops;
+
+    /* User bookmarks */
+    int         i_bookmarks;
+    seekpoint_t **pp_bookmarks;
+
+    /* private, do not touch it */
+    input_thread_sys_t  *p_sys;
 };
 
 /* Input methods */
@@ -325,6 +358,7 @@ struct input_thread_t
 #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_CDDA        0x23            /* stream is read from CDDA */
 #define INPUT_METHOD_NETWORK     0x30         /* stream is read from network */
 #define INPUT_METHOD_UCAST       0x31                         /* UDP unicast */
 #define INPUT_METHOD_MCAST       0x32                       /* UDP multicast */
@@ -332,6 +366,7 @@ struct input_thread_t
 #define INPUT_METHOD_VLAN_BCAST  0x34            /* UDP broadcast with VLANs */
 #define INPUT_METHOD_SATELLITE   0x40               /* stream is read from a */
                                                            /* satellite card */
+#define INPUT_METHOD_SLP         0x50                          /* SLP stream */
 
 /* Status changing methods */
 #define INPUT_STATUS_END            0
@@ -351,30 +386,30 @@ struct input_thread_t
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-#define input_CreateThread(a,b,c) __input_CreateThread(CAST_TO_VLC_OBJECT(a),b,c)
-input_thread_t * __input_CreateThread ( vlc_object_t *,
-                                        playlist_item_t *, int * );
-void   input_StopThread     ( input_thread_t * );
-void   input_DestroyThread  ( input_thread_t * );
+#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
+VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
+VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
+VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 
-#define input_SetStatus(a,b) __input_SetStatus(CAST_TO_VLC_OBJECT(a),b)
+#define input_SetStatus(a,b) __input_SetStatus(VLC_OBJECT(a),b)
 VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
 
-#define input_Seek(a,b,c) __input_Seek(CAST_TO_VLC_OBJECT(a),b,c)
+#define input_SetRate(a,b) __input_SetRate(VLC_OBJECT(a),b)
+VLC_EXPORT( void, __input_SetRate, ( vlc_object_t *, int ) );
+
+#define input_Seek(a,b,c) __input_Seek(VLC_OBJECT(a),b,c)
 VLC_EXPORT( void, __input_Seek, ( vlc_object_t *, off_t, int ) );
 
-#define input_Tell(a,b) __input_Tell(CAST_TO_VLC_OBJECT(a),b)
+#define input_Tell(a,b) __input_Tell(VLC_OBJECT(a),b)
 VLC_EXPORT( void, __input_Tell, ( vlc_object_t *, stream_position_t * ) );
 
 VLC_EXPORT( void, input_DumpStream, ( input_thread_t * ) );
 VLC_EXPORT( char *, input_OffsetToTime, ( input_thread_t *, char *, off_t ) );
-VLC_EXPORT( int, input_ChangeES, ( input_thread_t *, es_descriptor_t *, u8 ) );
 VLC_EXPORT( int, input_ToggleES, ( input_thread_t *, es_descriptor_t *, vlc_bool_t ) );
 VLC_EXPORT( int, input_ChangeArea, ( input_thread_t *, input_area_t * ) );
-VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, u16 ) );
+VLC_EXPORT( int, input_ChangeProgram, ( input_thread_t *, uint16_t ) );
 
 int    input_ToggleGrayscale( input_thread_t * );
 int    input_ToggleMute     ( input_thread_t * );
-int    input_SetSMP         ( input_thread_t *, int );
 
 #endif /* "input_ext-intf.h" */