]> 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 11598e13de674e39a55d43a1f26547cc6fd6e242..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.44 2001/10/02 16:46:59 massiot 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
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  *****************************************************************************/
 
+#ifndef _VLC_INPUT_EXT_INTF_H
+#define _VLC_INPUT_EXT_INTF_H 1
+
+#include "vlc_block.h"
+#include "ninput.h"
+
 /*
  * Communication input -> interface
  */
-#define INPUT_MAX_PLUGINS   1
 /* 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
  *****************************************************************************
  * 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
+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 */
-    boolean_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 */
-
-    char                    psz_desc[20]; /* description of ES: audio language
+    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;    /* description of ES: audio language
                                            * for instance ; NULL if not
                                            *  available */
 
     /* Demultiplexer information */
-    void *                  p_demux_data;
-    struct pgrm_descriptor_s *
-                            p_pgrm;  /* very convenient in the demultiplexer */
+    es_sys_t *              p_demux_data;
+    pgrm_descriptor_t *     p_pgrm;  /* very convenient in the demultiplexer */
 
     /* PES parser information */
-    struct pes_packet_s *   p_pes;                            /* Current PES */
-    struct data_packet_s *  p_last;   /* The last packet gathered at present */
-    int                     i_pes_real_size;   /* as indicated by the header */
+    pes_packet_t *          p_pes;                            /* Current PES */
+    unsigned 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 */
+    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 */
-} es_descriptor_t;
+
+    /* 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
  * 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 */
-/* ES streams types - see ISO/IEC 13818-1 table 2-29 numbers */
-#define MPEG1_VIDEO_ES      0x01
-#define MPEG2_VIDEO_ES      0x02
-#define MPEG1_AUDIO_ES      0x03
-#define MPEG2_AUDIO_ES      0x04
-#define AC3_AUDIO_ES        0x81
-/* These ones might violate the norm : */
-#define DVD_SPU_ES          0x82
-#define LPCM_AUDIO_ES       0x83
-#define UNKNOWN_ES          0xFF
-
-/* 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
  *****************************************************************************
  * 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
+struct pgrm_descriptor_t
 {
     /* Program characteristics */
-    u16                     i_number;                      /* program number */
-    u8                      i_version;                     /* version number */
-    boolean_t               b_is_ok;      /* Is the description up to date ? */
+    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 */
@@ -122,16 +108,17 @@ typedef struct pgrm_descriptor_s
     mtime_t                 cr_ref, sysdate_ref;
     mtime_t                 last_cr; /* reference to detect unexpected stream
                                       * discontinuities                      */
+    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 */
-} pgrm_descriptor_t;
+};
 
 /* Synchro states */
 #define SYNCHRO_OK          0
@@ -143,10 +130,10 @@ typedef struct pgrm_descriptor_s
  *****************************************************************************
  * Attributes for current area (title for DVD)
  *****************************************************************************/
-typedef struct input_area_s
+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) */
@@ -158,15 +145,13 @@ typedef struct input_area_s
                                           * (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 */
 
-    int                     i_angle_nb;  /* number of angles/title units */
-    int                     i_angle;
 
     /* offset to plugin related data */
     off_t                   i_plugin_data;
-} input_area_t;
+};
 
 /*****************************************************************************
  * stream_descriptor_t
@@ -174,130 +159,196 @@ typedef struct input_area_s
  * Describes a stream and list its associated programs. Build upon
  * the information carried in program association sections (for instance)
  *****************************************************************************/
-typedef struct stream_descriptor_s
+struct stream_descriptor_t
 {
-    u16                     i_stream_id;                        /* stream id */
-    boolean_t               b_changed;    /* if stream has been changed,
+    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 */
-    boolean_t               b_pace_control;    /* can we read when we want ? */
-    boolean_t               b_seekable;               /* can we do lseek() ? */
+    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
+                                                 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;
 
+    /* Optional stream output */
+    sout_instance_t *       p_sout;
+
     /* Statistics */
     count_t                 c_packets_read;                  /* packets read */
     count_t                 c_packets_trashed;            /* trashed packets */
-} stream_descriptor_t;
+};
+
+/*****************************************************************************
+ * stream_position_t
+ *****************************************************************************
+ * Describes the current position in the stream.
+ *****************************************************************************/
+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) */
+
+    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
  *****************************************************************************
  * This structure includes all the local static variables of an input thread
  *****************************************************************************/
-struct vout_thread_s;
-struct bit_stream_s;
-
-typedef struct input_thread_s
+struct input_thread_t
 {
-    /* Thread properties and locks */
-    boolean_t               b_die;                             /* 'die' flag */
-    boolean_t               b_error;
-    boolean_t               b_eof;
-    vlc_thread_t            thread_id;            /* id for thread functions */
-    int *                   pi_status;              /* temporary status flag */
-
-    /* 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 * );
-    void                 (* pf_init_bit_stream)( struct bit_stream_s *,
-                              struct decoder_fifo_s *,
-                void (* pf_bitstream_callback)( struct bit_stream_s *,
-                                                boolean_t ),
-                              void * );
-
-    /* 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 */
-    int                  (* pf_set_area)( struct input_thread_s *,
-                                          struct input_area_s * );
-    int                  (* pf_rewind)( struct input_thread_s * );
+    VLC_COMMON_MEMBERS
+
+    /* Thread properties */
+    vlc_bool_t              b_eof;
+    vlc_bool_t              b_out_pace_control;
+
+    /* Access module */
+    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 );
+    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;
+    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                 (* pf_seek)( struct input_thread_s *, off_t );
+    int           (* pf_demux_control ) ( input_thread_t *, int, va_list );
+    demux_sys_t *    p_demux_data;                      /* data of the demux */
 
-    char *                  p_source;
+    /* es out */
+    es_out_t        *p_es_out;
 
-    int                     i_handle;           /* socket or file descriptor */
-    FILE *                  p_stream;                       /* if applicable */
-    int                     i_read_once;        /* number of packet read by
-                                                 * pf_read once */
-    void *                  p_method_data;     /* data of the packet manager */
-    void *                  p_plugin_data;             /* data of the plugin */
+    /* Buffer manager */
+    input_buffers_t *p_method_data;     /* data of the packet manager */
+    data_buffer_t *  p_data_buffer;
+    byte_t *         p_current_data;
+    byte_t *         p_last_data;
+    size_t           i_bufsize;
 
     /* General stream description */
-    stream_descriptor_t     stream;                            /* PAT tables */
+    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;
 
-    count_t                 c_loops;
-} input_thread_t;
+    /* User bookmarks */
+    int         i_bookmarks;
+    seekpoint_t **pp_bookmarks;
+
+    /* private, do not touch it */
+    input_thread_sys_t  *p_sys;
+};
 
 /* Input methods */
 /* The first figure is a general method that can be used in interface plugins ;
@@ -307,12 +358,15 @@ typedef struct input_thread_s
 #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 */
 #define INPUT_METHOD_BCAST       0x33                       /* UDP broadcast */
 #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
@@ -321,23 +375,41 @@ typedef struct input_thread_s
 #define INPUT_STATUS_FASTER         3
 #define INPUT_STATUS_SLOWER         4
 
+/* Seek modes */
+#define INPUT_SEEK_SET       0x00
+#define INPUT_SEEK_CUR       0x01
+#define INPUT_SEEK_END       0x02
+#define INPUT_SEEK_BYTES     0x00
+#define INPUT_SEEK_SECONDS   0x10
+#define INPUT_SEEK_PERCENT   0x20
+
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
-                                             int *pi_status );
-void input_DestroyThread( struct input_thread_s *, int *pi_status );
-
-void input_SetStatus( struct input_thread_s *, int );
-void input_Seek     ( struct input_thread_s *, off_t );
-void input_DumpStream( struct input_thread_s * );
-char * input_OffsetToTime( struct input_thread_s *, char * psz_buffer, off_t );
-int  input_ChangeES ( struct input_thread_s *, struct es_descriptor_s *, u8 );
-int  input_ToggleES ( struct input_thread_s *,
-                      struct es_descriptor_s *,
-                      boolean_t );
-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 );
+#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(VLC_OBJECT(a),b)
+VLC_EXPORT( void, __input_SetStatus, ( vlc_object_t *, int ) );
+
+#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(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_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 *, uint16_t ) );
+
+int    input_ToggleGrayscale( input_thread_t * );
+int    input_ToggleMute     ( input_thread_t * );
 
+#endif /* "input_ext-intf.h" */