]> git.sesse.net Git - vlc/blobdiff - include/input_ext-intf.h
* Fixed the BeOS compile typo.
[vlc] / include / input_ext-intf.h
index 7060fcffc184c732aac037de150a963cc9d6668d..4a94aa24f5fc15000c1a36369006def8a910c8ab 100644 (file)
@@ -1,9 +1,39 @@
-/* Structures exported to the interface */
+/*****************************************************************************
+ * 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
+ * $Id: input_ext-intf.h,v 1.38 2001/05/30 17:03:11 sam Exp $
+ *
+ * Authors: Christophe Massiot <massiot@via.ecp.fr>
+ *
+ * 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.
+ *****************************************************************************/
 
 /*
  * Communication input -> interface
  */
 #define INPUT_MAX_PLUGINS   1
+/* FIXME ! */
+#define REQUESTED_MPEG         1
+#define REQUESTED_AC3          2
+#define REQUESTED_LPCM         3
+#define REQUESTED_NOAUDIO    255
+
+#define OFFSETTOTIME_MAX_SIZE       10
 
 /*****************************************************************************
  * es_descriptor_t: elementary stream descriptor
@@ -19,12 +49,20 @@ 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 */
+    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
+                                           * for instance ; NULL if not
+                                           *  available */
 
     /* Demultiplexer information */
     void *                  p_demux_data;
     struct pgrm_descriptor_s *
                             p_pgrm;  /* very convenient in the demultiplexer */
-    boolean_t               b_discontinuity;
 
     /* PES parser information */
     struct pes_packet_s *   p_pes;                            /* Current PES */
@@ -54,9 +92,17 @@ typedef struct es_descriptor_s
 #define MPEG1_AUDIO_ES      0x03
 #define MPEG2_AUDIO_ES      0x04
 #define AC3_AUDIO_ES        0x81
-#define DVD_SPU_ES          0x82              /* 0x82 might violate the norm */
+/* 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
  *****************************************************************************
@@ -75,10 +121,10 @@ typedef struct pgrm_descriptor_s
     char *                  psz_srv_name;
 
     /* Synchronization information */
-    /* system_date = PTS_date + delta_cr + delta_absolute */
     mtime_t                 delta_cr;
-    mtime_t                 delta_absolute;
-    mtime_t                 last_cr;
+    mtime_t                 cr_ref, sysdate_ref;
+    mtime_t                 last_cr; /* reference to detect unexpected stream
+                                      * discontinuities                      */
     count_t                 c_average_count;
                            /* counter used to compute dynamic average values */
     int                     i_synchro_state;
@@ -86,19 +132,44 @@ typedef struct pgrm_descriptor_s
     /* Demultiplexer data */
     void *                  p_demux_data;
 
-    /* Decoders control */
-    struct vout_thread_s *  p_vout;
-    struct aout_thread_s *  p_aout;
-
     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
-#define SYNCHRO_NOT_STARTED 1
-#define SYNCHRO_START       2
-#define SYNCHRO_REINIT      3
+#define SYNCHRO_START       1
+#define SYNCHRO_REINIT      2
+
+/*****************************************************************************
+ * 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 */
+
+    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
@@ -109,23 +180,50 @@ typedef struct pgrm_descriptor_s
 typedef struct stream_descriptor_s
 {
     u16                     i_stream_id;                        /* stream id */
+    boolean_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,
+                                               disc or network */
     boolean_t               b_pace_control;    /* can we read when we want ? */
     boolean_t               b_seekable;               /* can we do lseek() ? */
+
     /* if (b_seekable) : */
-    off_t                   i_size;     /* total size of the file (in bytes) */
-    off_t                   i_tell;/* actual location in the file (in bytes) */
+    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
+                                         * units of 50 bytes/s) ; 0 if undef */
+
+    /* New status and rate requested by the interface */
+    int                     i_new_status, i_new_rate;
+    vlc_cond_t              stream_wait; /* interface -> input in case of a
+                                          * status change request            */
 
     /* Demultiplexer data */
     void *                  p_demux_data;
 
-    /* Programs description */
+    /* Programs descriptions */
     int                     i_pgrm_number;    /* size of the following array */
     pgrm_descriptor_t **    pp_programs;        /* array of pointers to pgrm */
 
+    /* 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 */
+    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;
 } stream_descriptor_t;
@@ -155,7 +253,6 @@ typedef struct i_p_config_s
  *****************************************************************************
  * This structure includes all the local static variables of an input thread
  *****************************************************************************/
-struct aout_thread_s;
 struct vout_thread_s;
 
 typedef struct input_thread_s
@@ -163,31 +260,59 @@ typedef struct input_thread_s
     /* 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 */
 
-    struct input_config_s * p_config;
+    /* 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 * );
+
+    /* 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 * );
+                                           /* NULL if we don't support going *
+                                            * backwards (it's gonna be fun)  */
+    void                 (* pf_seek)( struct input_thread_s *, off_t );
+
+    /* Special callback functions */
+    void                 (* pf_file_open )     ( struct input_thread_s * );
+    void                 (* pf_file_close )    ( struct input_thread_s * );
+#if !defined( SYS_BEOS ) && !defined( SYS_NTO )
+    void                 (* pf_network_open )  ( struct input_thread_s * );
+    void                 (* pf_network_close ) ( struct input_thread_s * );
+#endif
 
-    struct input_capabilities_s *
-                            pp_plugins[INPUT_MAX_PLUGINS];/* list of plugins */
-    struct input_capabilities_s *
-                            p_plugin;                     /* selected plugin */
     i_p_config_t            i_p_config;              /* plugin configuration */
+    char *                  p_source;
 
     int                     i_handle;           /* socket or file descriptor */
-    void *                  p_method_data;
+    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 */
 
     /* General stream description */
     stream_descriptor_t     stream;                            /* PAT tables */
-    es_descriptor_t         p_es[INPUT_MAX_ES];
-                                               /* carried elementary streams */
-
-    /* List of streams to demux */
-    es_descriptor_t *       pp_selected_es[INPUT_MAX_SELECTED_ES];
-
-    /* For auto-launch of decoders */
-    struct aout_thread_s *  p_default_aout;
-    struct vout_thread_s *  p_default_vout;
 
 #ifdef STATS
     count_t                 c_loops;
@@ -198,49 +323,43 @@ typedef struct input_thread_s
 #endif
 } input_thread_t;
 
-
-/*
- * Communication interface -> input
- */
-
-/*****************************************************************************
- * input_config_t
- *****************************************************************************
- * This structure is given by the interface to an input thread
- *****************************************************************************/
-typedef struct input_config_s
-{
-    /* Input method description */
-    int                         i_method;                    /* input method */
-    char *                      p_source;                          /* source */
-
-    /* For auto-launch of decoders */
-    struct aout_thread_s *      p_default_aout;
-    struct vout_thread_s *      p_default_vout;
-} input_config_t;
-
 /* Input methods */
-#define INPUT_METHOD_NONE           0            /* input thread is inactive */
-#define INPUT_METHOD_FILE          10   /* stream is read from file p_source */
-#define INPUT_METHOD_UCAST         20                         /* UDP unicast */
-#define INPUT_METHOD_MCAST         21                       /* UDP multicast */
-#define INPUT_METHOD_BCAST         22                       /* UDP broadcast */
-#define INPUT_METHOD_VLAN_BCAST    32            /* UDP broadcast with VLANs */
+/* 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 */
+
+
+/* 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
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-struct input_thread_s * input_CreateThread( struct input_config_s *,
-                                            int *pi_status );
-void                    input_DestroyThread( struct input_thread_s *,
+struct input_thread_s * input_CreateThread ( struct playlist_item_s *,
                                              int *pi_status );
-void                    input_PauseProgram( struct input_thread_s *,
-                                            struct pgrm_descriptor_s * );
-void                    input_PlayProgram( struct input_thread_s *,
-                                           struct pgrm_descriptor_s * );
-void                    input_FFProgram( struct input_thread_s *,
-                                         struct pgrm_descriptor_s * );
-void                    input_SMProgram( struct input_thread_s *,
-                                           struct pgrm_descriptor_s * );
-void                    input_RewindProgram( struct input_thread_s *,
-                                             struct pgrm_descriptor_s * );
+void input_DestroyThread( struct input_thread_s *, int *pi_status );
+
+void input_SetStatus( struct input_thread_s *, int );
+void input_SetRate  ( 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( input_thread_t *, input_area_t * );
+