]> git.sesse.net Git - vlc/blobdiff - include/vlc_access.h
macosx: Fix a memleak.
[vlc] / include / vlc_access.h
index a1b4212b6f098571974d63fc92f68e5b99312ee2..26a867c5737bd6a2820e8c5bd879de03f2051a78 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
- * vlc_access.h
+ * vlc_access.h: Access descriptor, queries and methods
  *****************************************************************************
- * Copyright (C) 1999-2004 VideoLAN
+ * Copyright (C) 1999-2006 the VideoLAN team
  * $Id$
  *
  * Authors: 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.
  *****************************************************************************/
 
 #ifndef _VLC_ACCESS_H
 #define _VLC_ACCESS_H 1
 
+#include <vlc_block.h>
+
 /**
  * \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_CAN_SEEK,        /* arg1= bool*    cannot fail */
+    ACCESS_CAN_FASTSEEK,    /* arg1= bool*    cannot fail */
+    ACCESS_CAN_PAUSE,       /* arg1= bool*    cannot fail */
+    ACCESS_CAN_CONTROL_PACE,/* arg1= bool*    cannot fail */
 
     /* */
     ACCESS_GET_MTU,         /* arg1= int*           cannot fail(0 if no sense)*/
@@ -46,7 +48,7 @@ enum access_query_e
     ACCESS_GET_META,        /* arg1= vlc_meta_t **  res=can fail    */
 
     /* */
-    ACCESS_SET_PAUSE_STATE, /* arg1= vlc_bool_t     can fail */
+    ACCESS_SET_PAUSE_STATE, /* arg1= bool     can fail */
 
     /* */
     ACCESS_SET_TITLE,       /* arg1= int            can fail */
@@ -54,9 +56,11 @@ enum access_query_e
 
     /* Special mode for access/demux communication
      * XXX: avoid to use it unless you can't */
-    ACCESS_SET_PRIVATE_ID_STATE,    /* arg1= int i_private_data, vlc_bool_t b_selected can fail */
+    ACCESS_SET_PRIVATE_ID_STATE,    /* arg1= int i_private_data, bool b_selected can fail */
     ACCESS_SET_PRIVATE_ID_CA,    /* arg1= int i_program_number, uint16_t i_vpid, uint16_t i_apid1, uint16_t i_apid2, uint16_t i_apid3, uint8_t i_length, uint8_t *p_data */
-    ACCESS_GET_PRIVATE_ID_STATE,    /* arg1=int i_private_data arg2=vlc_bool_t *  res=can fail */
+    ACCESS_GET_PRIVATE_ID_STATE,    /* arg1=int i_private_data arg2=bool *  res=can fail */
+
+    ACCESS_GET_CONTENT_TYPE, /* arg1=char **ppsz_content_type */
 };
 
 struct access_t
@@ -74,13 +78,13 @@ struct access_t
     access_t    *p_source;
 
     /* Access can fill this entry to force a demuxer
-     * XXX: fill it once you know for sure you will succed
+     * XXX: fill it once you know for sure you will succeed
      * (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 */
+    ssize_t     (*pf_read) ( access_t *, uint8_t *, size_t );  /* 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.
@@ -99,33 +103,67 @@ struct access_t
 
         int64_t      i_size;    /* Write only for access, read only for input */
         int64_t      i_pos;     /* idem */
-        vlc_bool_t   b_eof;     /* idem */
+        bool   b_eof;     /* idem */
 
         int          i_title;    /* idem, start from 0 (could be menu) */
         int          i_seekpoint;/* idem, start from 0 */
+
+        bool   b_prebuffered; /* Read only for input */
     } info;
     access_sys_t *p_sys;
 };
 
-#define access2_New( a, b, c, d, e ) __access2_New(VLC_OBJECT(a), b, c, d, e )
-VLC_EXPORT( access_t *, __access2_New,  ( vlc_object_t *p_obj, char *psz_access, char *psz_demux, char *psz_path, vlc_bool_t b_quick ) );
-VLC_EXPORT( access_t *, access2_FilterNew, ( access_t *p_source, char *psz_access_filter ) );
-VLC_EXPORT( void,      access2_Delete, ( access_t * ) );
-
-static inline int access2_vaControl( access_t *p_access, int i_query, va_list args )
+static inline int access_vaControl( access_t *p_access, int i_query, va_list args )
 {
     if( !p_access ) return VLC_EGENERIC;
     return p_access->pf_control( p_access, i_query, args );
 }
-static inline int access2_Control( access_t *p_access, int i_query, ... )
+
+static inline int access_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 );
+    i_result = access_vaControl( p_access, i_query, args );
     va_end( args );
     return i_result;
 }
 
+static inline char *access_GetContentType( access_t *p_access )
+{
+    char *res;
+    if( access_Control( p_access, ACCESS_GET_CONTENT_TYPE, &res ) )
+        return NULL;
+    return res;
+}
+
+static inline void access_InitFields( access_t *p_a )
+{
+    p_a->info.i_update = 0;
+    p_a->info.i_size = 0;
+    p_a->info.i_pos = 0;
+    p_a->info.b_eof = false;
+    p_a->info.i_title = 0;
+    p_a->info.i_seekpoint = 0;
+}
+
+#define ACCESS_SET_CALLBACKS( read, block, control, seek ) \
+    p_access->pf_read = read;  \
+    p_access->pf_block = block; \
+    p_access->pf_control = control; \
+    p_access->pf_seek = seek; \
+
+#define STANDARD_READ_ACCESS_INIT \
+    access_InitFields( p_access ); \
+    ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek ); \
+    MALLOC_ERR( p_access->p_sys, access_sys_t ); \
+    p_sys = p_access->p_sys; memset( p_sys, 0, sizeof( access_sys_t ) );
+
+#define STANDARD_BLOCK_ACCESS_INIT \
+    access_InitFields( p_access ); \
+    ACCESS_SET_CALLBACKS( NULL, Block, Control, Seek ); \
+    MALLOC_ERR( p_access->p_sys, access_sys_t ); \
+    p_sys = p_access->p_sys; memset( p_sys, 0, sizeof( access_sys_t ) );
+
 #endif