]> git.sesse.net Git - vlc/blobdiff - include/input_ext-intf.h
* Fixed the BeOS compile typo.
[vlc] / include / input_ext-intf.h
index d4571e8bfb4776ad8f8d767a23955a86785b6627..4a94aa24f5fc15000c1a36369006def8a910c8ab 100644 (file)
@@ -4,7 +4,7 @@
  * control the pace of reading. 
  *****************************************************************************
  * Copyright (C) 1999, 2000 VideoLAN
- * $Id: input_ext-intf.h,v 1.17 2001/02/08 13:52:34 massiot Exp $
+ * $Id: input_ext-intf.h,v 1.38 2001/05/30 17:03:11 sam Exp $
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *
@@ -33,6 +33,8 @@
 #define REQUESTED_LPCM         3
 #define REQUESTED_NOAUDIO    255
 
+#define OFFSETTOTIME_MAX_SIZE       10
+
 /*****************************************************************************
  * es_descriptor_t: elementary stream descriptor
  *****************************************************************************
@@ -50,6 +52,12 @@ typedef struct es_descriptor_s
     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;
@@ -60,7 +68,6 @@ typedef struct es_descriptor_s
     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 */
-    boolean_t               b_discontinuity;               /* Stream changed */
 
     /* Decoder information */
     struct decoder_fifo_s * p_decoder_fifo;
@@ -90,6 +97,12 @@ typedef struct es_descriptor_s
 #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
  *****************************************************************************
@@ -115,15 +128,10 @@ typedef struct pgrm_descriptor_s
     count_t                 c_average_count;
                            /* counter used to compute dynamic average values */
     int                     i_synchro_state;
-    boolean_t               b_discontinuity;
 
     /* 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;
@@ -133,6 +141,36 @@ typedef struct pgrm_descriptor_s
 #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
  *****************************************************************************
@@ -142,19 +180,27 @@ 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 arbitrary units) */
-    off_t                   i_tell;             /* actual location in the file
-                                                 * (in arbitrary units) */
-    off_t                   i_seek;         /* next requested location (changed
-                                             * by the interface thread */
+    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;
@@ -173,6 +219,10 @@ typedef struct stream_descriptor_s
     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;
@@ -203,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
@@ -238,25 +287,33 @@ typedef struct input_thread_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
+
     i_p_config_t            i_p_config;              /* plugin configuration */
     char *                  p_source;
 
     int                     i_handle;           /* socket or file descriptor */
+    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 */
 
-    /* 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;
     count_t                 c_bytes;                           /* bytes read */
@@ -266,35 +323,27 @@ 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_DVD           11      /* stream is read from dvd device */
-#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
@@ -302,7 +351,15 @@ typedef struct input_config_s
 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_Play   ( struct input_thread_s * );
-void input_Pause  ( struct input_thread_s * );
-void input_Forward( struct input_thread_s *, int );
-void input_Seek   ( struct input_thread_s *, off_t );
+
+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 * );
+