]> git.sesse.net Git - vlc/blobdiff - include/ninput.h
* vlc_common: moved a few typedefs from stream_output.h
[vlc] / include / ninput.h
index 0b2f2737a9e65445a2bf77432b0bdcf2e0321a6a..e8f6e4d5aad7a5d9f9f331c7e70587edb9f82162 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * ninput.h
  *****************************************************************************
- * Copyright (C) 1999-2001 VideoLAN
+ * Copyright (C) 1999-2004 VideoLAN
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 
 #include "vlc_es.h"
 
+/* Seek point */
+struct seekpoint_t
+{
+    int64_t i_byte_offset;
+    int64_t i_time_offset;
+    char    *psz_name;
+};
+
+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->psz_name = NULL;
+    return point;
+}
+
+static inline void vlc_seekpoint_Delete( seekpoint_t *point )
+{
+    if( !point ) return;
+    if( point->psz_name ) free( point->psz_name );
+    free( point );
+}
+
+static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
+{
+    seekpoint_t *point = vlc_seekpoint_New();
+    if( src->psz_name ) point->psz_name = strdup( src->psz_name );
+    point->i_time_offset = src->i_time_offset;
+    point->i_byte_offset = src->i_byte_offset;
+    return point;
+}
+
+typedef struct
+{
+    char        *psz_name;
+
+    vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */
+
+    int64_t     i_length;   /* Length(microsecond) if known, else 0 */
+    int64_t     i_size;     /* Size (bytes) if known, else 0 */
+
+    /* Title seekpoint */
+    int         i_seekpoint;
+    seekpoint_t **seekpoint;
+
+} input_title_t;
+
+static inline input_title_t *vlc_input_title_New( )
+{
+    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
+
+    t->psz_name = NULL;
+    t->b_menu = VLC_FALSE;
+    t->i_length = 0;
+    t->i_size   = 0;
+    t->i_seekpoint = 0;
+    t->seekpoint = NULL;
+
+    return t;
+}
+static inline void vlc_input_title_Delete( input_title_t *t )
+{
+    int i;
+    if( t == NULL )
+        return;
+
+    if( t->psz_name ) free( t->psz_name );
+    for( i = 0; i < t->i_seekpoint; i++ )
+    {
+        if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
+        free( t->seekpoint[i] );
+    }
+    if( t->seekpoint ) free( t->seekpoint );
+    free( t );
+}
+
+static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
+{
+    input_title_t *dup = vlc_input_title_New( );
+    int i;
+
+    if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
+    dup->b_menu      = t->b_menu;
+    dup->i_length    = t->i_length;
+    dup->i_size      = t->i_size;
+    dup->i_seekpoint = t->i_seekpoint;
+    if( t->i_seekpoint > 0 )
+    {
+        dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
+                                                sizeof(seekpoint_t*) );
+
+        for( i = 0; i < t->i_seekpoint; i++ )
+        {
+            dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
+        }
+    }
+
+    return dup;
+}
+
+/**
+ * \defgroup es out Es Out
+ * @{
+ */
+
 enum es_out_mode_e
 {
     ES_OUT_MODE_NONE,   /* don't select anything */
@@ -51,10 +157,10 @@ enum es_out_query_e
     ES_OUT_SET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t   */
     ES_OUT_GET_ES_STATE,/* arg1= es_out_id_t* arg2=vlc_bool_t*  */
 
-    /* XXX XXX XXX Don't use them YET !!! */
+    /* PCR handling, by default dts/pts will be automatically computed using thoses PCR */
     ES_OUT_SET_PCR,             /* arg1=int64_t i_pcr(microsecond!) (using default group 0)*/
     ES_OUT_SET_GROUP_PCR,       /* arg1= int i_group, arg2=int64_t i_pcr(microsecond!)*/
-    ES_OUT_RESET_PCR    /* no arg */
+    ES_OUT_RESET_PCR,           /* no arg */
 };
 
 struct es_out_t
@@ -96,6 +202,116 @@ static inline int es_out_Control( es_out_t *out, int i_query, ... )
     return i_result;
 }
 
+/**
+ * @}
+ */
+
+/* i_update field of access_t/demux_t */
+#define INPUT_UPDATE_NONE       0x0000
+#define INPUT_UPDATE_SIZE       0x0001
+#define INPUT_UPDATE_TITLE      0x0010
+#define INPUT_UPDATE_SEEKPOINT  0x0020
+
+/**
+ * \defgroup access Access
+ * @{
+ */
+
+enum access_query_e
+{
+    /* capabilities */
+    ACCESS_CAN_SEEK,        /* arg1= vlc_bool_t*    cannot fail */
+    ACCESS_CAN_FASTSEEK,    /* arg1= vlc_bool_t*    cannot fail */
+    ACCESS_CAN_PAUSE,       /* arg1= vlc_bool_t*    cannot fail */
+    ACCESS_CAN_CONTROL_PACE,/* arg1= vlc_bool_t*    cannot fail */
+
+    /* */
+    ACCESS_GET_MTU,         /* arg1= int*           cannot fail(0 if no sense)*/
+    ACCESS_GET_PTS_DELAY,   /* arg1= int64_t*       cannot fail */
+    /* */
+    ACCESS_GET_TITLE_INFO,      /* arg1=input_title_t*** arg2=int* can fail */
+
+    /* */
+    ACCESS_SET_PAUSE_STATE, /* arg1= vlc_bool_t     can fail */
+
+    /* */
+    ACCESS_SET_TITLE,       /* arg1= int            can fail */
+    ACCESS_SET_SEEKPOINT,   /* arg1= int            can fail */
+
+    /* Special mode for access/demux communication
+     * XXX: avoid to use it unless you can't */
+    ACCESS_SET_PRIVATE_ID_STATE,    /* arg1= vlc_bool_t b_selected, int i_private_data can fail */
+};
+
+struct access_t
+{
+    VLC_COMMON_MEMBERS
+
+    /* Module properties */
+    module_t    *p_module;
+
+    /* Access name (empty if non forced) */
+    char        *psz_access;
+    /* Access path/url/filename/.... */
+    char        *psz_path;
+
+    /* Access can fill this entry to force a demuxer
+     * XXX: fill it once you know for sure you will succed
+     * (if you fail, this value won't be reseted */
+    char        *psz_demux;
+
+    /* pf_read/pf_block is used to read data.
+     * XXX A access should set one and only one of them */
+    int         (*pf_read) ( access_t *, uint8_t *, int );  /* Return -1 if no data yet, 0 if no more data, else real data read */
+    block_t    *(*pf_block)( access_t * );                  /* return a block of data in his 'natural' size, NULL if not yet data or eof */
+
+    /* Called for each seek.
+     * XXX can be null */
+    int         (*pf_seek) ( access_t *, int64_t );         /* can be null if can't seek */
+
+    /* Used to retreive and configure the access
+     * XXX mandatory. look at access_query_e to know what query you *have to* support */
+    int         (*pf_control)( access_t *, int i_query, va_list args);
+
+    /* Access has to maintain them uptodate */
+    struct
+    {
+        unsigned int i_update;  /* Access sets them on change,
+                                   Input removes them once take into account*/
+
+        int64_t      i_size;    /* Write only for access, read only for input */
+        int64_t      i_pos;     /* idem */
+        vlc_bool_t   b_eof;     /* idem */
+
+        int          i_title;    /* idem, start from 0 (could be menu) */
+        int          i_seekpoint;/* idem, start from 0 */
+    } info;
+    access_sys_t *p_sys;
+};
+
+#define access2_New( a, b, c, d ) __access2_New(VLC_OBJECT(a), b, c, d )
+VLC_EXPORT( access_t *, __access2_New,  ( vlc_object_t *p_obj, char *psz_access, char *psz_demux, char *psz_path ) );
+VLC_EXPORT( void,      access2_Delete, ( access_t * ) );
+
+static inline int access2_vaControl( access_t *p_access, int i_query, va_list args )
+{
+    return p_access->pf_control( p_access, i_query, args );
+}
+static inline int access2_Control( access_t *p_access, int i_query, ... )
+{
+    va_list args;
+    int     i_result;
+
+    va_start( args, i_query );
+    i_result = access2_vaControl( p_access, i_query, args );
+    va_end( args );
+    return i_result;
+}
+
+/**
+ * @}
+ */
+
 /**
  * \defgroup stream Stream
  *
@@ -118,7 +334,12 @@ enum stream_query_e
 
     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
 
-    STREAM_GET_MTU              /**< arg1= int *          res=cannot fail (0 if no sense)*/
+    STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
+
+    /* Special for direct access control from demuxer.
+     * XXX: avoid using it by all means */
+    STREAM_CONTROL_ACCESS,      /* arg1= int i_access_query, args   res: can fail
+                                   if access unreachable or access control answer */
 };
 
 /**
@@ -274,6 +495,18 @@ struct demux_t
     /* set by demuxer */
     int (*pf_demux)  ( demux_t * );   /* demux one frame only */
     int (*pf_control)( demux_t *, int i_query, va_list args);
+
+    /* Demux has to maintain them uptodate
+     * when it is responsible of seekpoint/title
+     * XXX: don't use them yet */
+    struct
+    {
+        unsigned int i_update;  /* Demux sets them on change,
+                                   Input removes them once take into account*/
+        /* Seekpoint/Title at demux level */
+        int          i_title;       /* idem, start from 0 (could be menu) */
+        int          i_seekpoint;   /* idem, start from 0 */
+    } info;
     demux_sys_t *p_sys;
 };
 
@@ -282,45 +515,18 @@ enum demux_query_e
     DEMUX_GET_POSITION,         /* arg1= double *       res=    */
     DEMUX_SET_POSITION,         /* arg1= double         res=can fail    */
 
+    DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=    */
     DEMUX_GET_TIME,             /* arg1= int64_t *      res=    */
     DEMUX_SET_TIME,             /* arg1= int64_t        res=can fail    */
 
-    DEMUX_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
-
     DEMUX_GET_FPS,              /* arg1= float *        res=can fail    */
-    DEMUX_GET_META              /* arg1= vlc_meta_t **  res=can fail    */
-};
+    DEMUX_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
 
-struct seekpoint_t
-{
-    int64_t i_byte_offset;
-    int64_t i_time_offset;
-    char    *psz_name;
-};
-
-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;
-    point->psz_name = NULL;
-    return point;
-}
-
-static inline void vlc_seekpoint_Delete( seekpoint_t *point )
-{
-    if( !point ) return;
-    if( point->psz_name ) free( point->psz_name );
-    free( point );
-}
+    DEMUX_GET_TITLE_INFO,       /* arg1=input_title_t*** arg2=int* can fail */
 
-static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
-{
-    seekpoint_t *point = vlc_seekpoint_New();
-    if( src->psz_name ) point->psz_name = strdup( src->psz_name );
-    point->i_time_offset = src->i_time_offset;
-    point->i_byte_offset = src->i_byte_offset;
-    return point;
-}
+    DEMUX_SET_TITLE,            /* arg1= int            can fail */
+    DEMUX_SET_SEEKPOINT,        /* arg1= int            can fail */
+};
 
 /* Demux */
 VLC_EXPORT( int, demux_vaControl,        ( input_thread_t *, int i_query, va_list  ) );
@@ -328,11 +534,15 @@ VLC_EXPORT( int, demux_Control,          ( input_thread_t *, int i_query, ...  )
 
 VLC_EXPORT( int, demux_vaControlDefault, ( input_thread_t *, int i_query, va_list  ) );
 
+/* Access */
+VLC_EXPORT( int, access_vaControl,       ( input_thread_t *, int i_query, va_list  ) );
+VLC_EXPORT( int, access_Control,         ( input_thread_t *, int i_query, ...  ) );
+VLC_EXPORT( int, access_vaControlDefault,( input_thread_t *, int i_query, va_list  ) );
+
 
-/* New demux arch: don't touch that */
 /* stream_t *s could be null and then it mean a access+demux in one */
-#define demux2_New( a, b, c, d ) __demux2_New(VLC_OBJECT(a), b, c, d)
-VLC_EXPORT( demux_t *, __demux2_New,  ( vlc_object_t *p_obj, char *psz_mrl, stream_t *s, es_out_t *out ) );
+#define demux2_New( a, b, c, d, e, f ) __demux2_New(VLC_OBJECT(a),b,c,d,e,f)
+VLC_EXPORT( demux_t *, __demux2_New,  ( vlc_object_t *p_obj, char *psz_access, char *psz_demux, char *psz_path, stream_t *s, es_out_t *out ) );
 VLC_EXPORT( void,      demux2_Delete, ( demux_t * ) );
 VLC_EXPORT( int,       demux2_vaControlHelper, ( stream_t *, int64_t i_start, int64_t i_end, int i_bitrate, int i_align, int i_query, va_list args ) );
 
@@ -369,27 +579,45 @@ VLC_EXPORT( char **, subtitles_Detect, ( input_thread_t *, char* path, char *fna
  */
 enum input_query_e
 {
+    /* input variable "position" */
     INPUT_GET_POSITION,         /* arg1= double *       res=    */
     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 
+    /* input variable "length" */
+    INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
+
+    /* input variable "time" */
     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 
-    INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
+    /* input variable "rate" (1 is DEFAULT_RATE) */
+    INPUT_GET_RATE,             /* arg1= int *          res=    */
+    INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 
-    INPUT_GET_FPS,              /* arg1= float *        res=can fail    */
-    INPUT_GET_META,             /* arg1= vlc_meta_t **  res=can fail    */
+    /* input variable "state" */
+    INPUT_GET_STATE,            /* arg1= int *          res=    */
+    INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 
+
+    /* bookmarks */
     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
+    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    */
 
+    INPUT_ADD_OPTION, /* arg1= char * arg2= 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_SET_NAME,   /* arg1= char * res=can fail    */
+
+    /* */
     INPUT_GET_SUBDELAY,    /* arg1 = int* res=can fail */
     INPUT_SET_SUBDELAY,    /* arg1 = int  res=can fail */
-
-    INPUT_GET_DIVISIONS
 };
 
 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );