]> git.sesse.net Git - vlc/blobdiff - include/vlc_input.h
* Allow service discoveries to state whether they prefer being displayed as tree
[vlc] / include / vlc_input.h
index 8ae8ce1b1fe552d6083d91bdb04fb016826bbde3..44e68a399e7a8e4ca9c1097dd8e5526906cdb36d 100644 (file)
@@ -1,8 +1,8 @@
 /*****************************************************************************
- * vlc_input.h:
+ * vlc_input.h: Core input structures
  *****************************************************************************
- * Copyright (C) 1999-2004 VideoLAN
- * $Id: input_ext-intf.h 7954 2004-06-07 22:19:12Z fenrir $
+ * Copyright (C) 1999-2004 the VideoLAN team
+ * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /* __ is need because conflict with <vlc/input.h> */
 #ifndef _VLC__INPUT_H
 #define _VLC__INPUT_H 1
 
+#include <vlc_playlist.h>
+#include <vlc_meta.h>
+
+struct vlc_meta_t;
+
 /*****************************************************************************
- * input_item_t: Describes an input and is used to spawn input_thread_t objects.
+ * input_item_t: Describes an input and is used to spawn input_thread_t objects
  *****************************************************************************/
 struct info_t
 {
@@ -44,21 +49,147 @@ struct info_category_t
 
 struct input_item_t
 {
+    VLC_GC_MEMBERS
+    int        i_id;                 /**< Identifier of the item */
+
     char       *psz_name;            /**< text describing this item */
     char       *psz_uri;             /**< mrl of this item */
+    vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
 
     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*/
+    mtime_t    i_duration;           /**< Duration in milliseconds*/
+
+    uint8_t    i_type;               /**< Type (file, disc, ...) */
+    vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
 
     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 */
+    int         i_es;                /**< Number of es format descriptions */
+    es_format_t **es;                /**< Es formats */
+
+    input_stats_t *p_stats;          /**< Statistics */
+    int           i_nb_played;       /**< Number of times played */
+
+    vlc_meta_t *p_meta;
+
+    vlc_mutex_t lock;                /**< Lock for the item */
 };
 
+#define ITEM_TYPE_UNKNOWN       0
+#define ITEM_TYPE_AFILE         1
+#define ITEM_TYPE_VFILE         2
+#define ITEM_TYPE_DIRECTORY     3
+#define ITEM_TYPE_DISC          4
+#define ITEM_TYPE_CDDA          5
+#define ITEM_TYPE_CARD          6
+#define ITEM_TYPE_NET           7
+#define ITEM_TYPE_PLAYLIST      8
+#define ITEM_TYPE_NODE          9
+#define ITEM_TYPE_NUMBER        10
+
+static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
+{
+    memset( p_i, 0, sizeof(input_item_t) );
+    p_i->psz_name = 0;
+    p_i->psz_uri = 0;
+    p_i->i_es = 0;
+    p_i->es = 0;
+    p_i->i_options  = 0;
+    p_i->ppsz_options = 0;
+    p_i->i_categories = 0 ;
+    p_i->pp_categories = 0;
+    p_i->i_type = ITEM_TYPE_UNKNOWN;
+    p_i->b_fixed_name = VLC_TRUE;
+
+    p_i->p_stats = (input_stats_t*) malloc( sizeof( input_stats_t ) );
+    p_i->p_meta = NULL;
+    vlc_mutex_init( p_o, &p_i->p_stats->lock );
+
+    vlc_mutex_init( p_o, &p_i->lock );
+}
+
+static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
+                                               input_item_t *p_child )
+{
+    int i;
+    for( i = 0 ; i< p_parent->i_options; i++ )
+    {
+        char *psz_option= strdup( p_parent->ppsz_options[i] );
+        p_child->i_options++;
+        p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
+                                                  p_child->i_options *
+                                                  sizeof( char * ) );
+        p_child->ppsz_options[p_child->i_options-1] = psz_option;
+    }
+}
+
+VLC_EXPORT( void, vlc_input_item_AddOption, ( input_item_t *p_input, const char *psz_option ) );
+
+static inline void vlc_input_item_Clean( input_item_t *p_i )
+{
+    if( p_i->psz_name ) free( p_i->psz_name );
+    if( p_i->psz_uri ) free( p_i->psz_uri );
+    if( p_i->p_stats ) free( p_i->p_stats );
+    p_i->psz_name = 0;
+    p_i->psz_uri = 0;
+
+    if( p_i->p_meta ) vlc_meta_Delete( p_i->p_meta );
+
+    while( p_i->i_options )
+    {
+        p_i->i_options--;
+        if( p_i->ppsz_options[p_i->i_options] )
+            free( p_i->ppsz_options[p_i->i_options] );
+        if( !p_i->i_options ) free( p_i->ppsz_options );
+    }
+
+    while( p_i->i_es )
+    {
+        p_i->i_es--;
+        es_format_Clean( p_i->es[p_i->i_es] );
+        if( !p_i->i_es ) free( p_i->es );
+    }
+
+    while( p_i->i_categories )
+    {
+        info_category_t *p_category =
+            p_i->pp_categories[--(p_i->i_categories)];
+
+        while( p_category->i_infos )
+        {
+            p_category->i_infos--;
+
+            if( p_category->pp_infos[p_category->i_infos]->psz_name )
+                free( p_category->pp_infos[p_category->i_infos]->psz_name);
+            if( p_category->pp_infos[p_category->i_infos]->psz_value )
+                free( p_category->pp_infos[p_category->i_infos]->psz_value );
+            free( p_category->pp_infos[p_category->i_infos] );
+
+            if( !p_category->i_infos ) free( p_category->pp_infos );
+        }
+
+        if( p_category->psz_name ) free( p_category->psz_name );
+        free( p_category );
+
+        if( !p_i->i_categories ) free( p_i->pp_categories );
+    }
+
+    vlc_mutex_destroy( &p_i->lock );
+}
+
+VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
+VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
+
+#define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
+#define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
+VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char **, int)  );
+VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char **, int, int ) );
+
+VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );
+
 
 /*****************************************************************************
  * Seek point: (generalisation of chapters)
@@ -68,13 +199,15 @@ struct seekpoint_t
     int64_t i_byte_offset;
     int64_t i_time_offset;
     char    *psz_name;
+    int     i_level;
 };
 
 static inline seekpoint_t *vlc_seekpoint_New( void )
 {
     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
     point->i_byte_offset =
-    point->i_time_offset = 0;
+    point->i_time_offset = -1;
+    point->i_level = 0;
     point->psz_name = NULL;
     return point;
 }
@@ -126,6 +259,7 @@ static inline input_title_t *vlc_input_title_New( )
 
     return t;
 }
+
 static inline void vlc_input_title_Delete( input_title_t *t )
 {
     int i;
@@ -166,7 +300,6 @@ static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
     return dup;
 }
 
-
 /*****************************************************************************
  * input defines/constants.
  *****************************************************************************/
@@ -177,10 +310,13 @@ enum input_state_e
     INIT_S,
     PLAYING_S,
     PAUSE_S,
-    END_S,
+    END_S
 };
 
-/* "rate" default, min/max */
+/* "rate" default, min/max
+ * A rate below 1000 plays the movie faster,
+ * A rate above 1000 plays the movie slower.
+ */
 #define INPUT_RATE_DEFAULT  1000
 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
 #define INPUT_RATE_MAX      8000            /* Up to 1/8 */
@@ -201,6 +337,14 @@ typedef struct
     int          i_title;
     input_title_t **title;
 
+    int i_title_offset;
+    int i_seekpoint_offset;
+
+    int i_title_start;
+    int i_title_end;
+    int i_seekpoint_start;
+    int i_seekpoint_end;
+
     /* Properties */
     vlc_bool_t b_can_pace_control;
     vlc_bool_t b_can_pause;
@@ -216,6 +360,7 @@ typedef struct
 #define INPUT_UPDATE_SIZE       0x0001
 #define INPUT_UPDATE_TITLE      0x0010
 #define INPUT_UPDATE_SEEKPOINT  0x0020
+#define INPUT_UPDATE_META       0x0040
 
 /* Input control XXX: internal */
 #define INPUT_CONTROL_FIFO_SIZE    100
@@ -253,10 +398,16 @@ struct input_thread_t
     int          i_title;
     input_title_t **title;
 
+    int i_title_offset;
+    int i_seekpoint_offset;
+
     /* User bookmarks FIXME won't be easy with multiples input */
     int         i_bookmark;
     seekpoint_t **bookmark;
 
+    /* Global meta datas FIXME move to input_item_t ? */
+    vlc_meta_t  *p_meta;
+
     /* Output */
     es_out_t    *p_es_out;
     sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
@@ -272,6 +423,26 @@ struct input_thread_t
     int            i_slave;
     input_source_t **slave;
 
+    /* Stats counters */
+    struct {
+        counter_t *p_read_packets;
+        counter_t *p_read_bytes;
+        counter_t *p_input_bitrate;
+        counter_t *p_demux_read;
+        counter_t *p_demux_bitrate;
+        counter_t *p_decoded_audio;
+        counter_t *p_decoded_video;
+        counter_t *p_decoded_sub;
+        counter_t *p_sout_sent_packets;
+        counter_t *p_sout_sent_bytes;
+        counter_t *p_sout_send_bitrate;
+        counter_t *p_played_abuffers;
+        counter_t *p_lost_abuffers;
+        counter_t *p_displayed_pictures;
+        counter_t *p_lost_pictures;
+        vlc_mutex_t counters_lock;
+    } counters;
+
     /* Buffer of pending actions */
     vlc_mutex_t lock_control;
     int i_control;
@@ -288,6 +459,13 @@ struct 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 * ) );
+#define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
+VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
+#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
+VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
+
+#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
+VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
 VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );
 
@@ -312,16 +490,17 @@ enum input_query_e
     INPUT_GET_STATE,            /* arg1= int *          res=    */
     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 
-    /* input variable "audio-delay" and "spu-delay" */
+    /* input variable "audio-delay" and "sub-delay" */
     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 
     /* Meta datas */
-    INPUT_ADD_INFO,   /* arg1= char * arg2= char * arg3=...  res=can fail    */
-    INPUT_GET_INFO,   /* arg1= char * arg2= char * arg3= char ** res=can fail*/
-    INPUT_SET_NAME,   /* arg1= char * res=can fail    */
+    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
+    INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
+    INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
+    INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 
     /* Input config options */
     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
@@ -337,15 +516,18 @@ enum input_query_e
     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
+
+    /* On the fly input slave */
+    INPUT_ADD_SLAVE        /* arg1= char * */
 };
 
 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
 
-
 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
 
-#endif
+VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );
 
+#endif