git.sesse.net Git - vlc/blob - include/vlc_stream.h

   1 /*****************************************************************************
   2  * vlc_stream.h
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_STREAM_H
  25 #define _VLC_STREAM_H 1
  26
  27 /**
  28  * \defgroup stream Stream
  29  *
  30  *  This will allow you to easily handle read/seek in demuxer modules.
  31  * @{
  32  */
  33
  34 /**
  35  * Possible commands to send to stream_Control() and stream_vaControl()
  36  */
  37 enum stream_query_e
  38 {
  39     /* capabilities */
  40     STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
  41     STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
  42
  43     /* */
  44     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
  45     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
  46
  47     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
  48
  49     STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
  50
  51     /* Special for direct access control from demuxer.
  52      * XXX: avoid using it by all means */
  53     STREAM_CONTROL_ACCESS,      /* arg1= int i_access_query, args   res: can fail
  54                                    if access unreachable or access control answer */
  55 };
  56
  57 /**
  58  * stream_t definition
  59  */
  60 struct stream_t
  61 {
  62     VLC_COMMON_MEMBERS
  63
  64     block_t *(*pf_block)  ( stream_t *, int i_size );
  65     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
  66     int      (*pf_peek)   ( stream_t *, uint8_t **pp_peek, int i_peek );
  67     int      (*pf_control)( stream_t *, int i_query, va_list );
  68     void     (*pf_destroy)( stream_t *);
  69
  70     stream_sys_t *p_sys;
  71 };
  72
  73 /**
  74  * Try to read "i_read" bytes into a buffer pointed by "p_read".  If
  75  * "p_read" is NULL then data are skipped instead of read.  The return
  76  * value is the real numbers of bytes read/skip. If this value is less
  77  * than i_read that means that it's the end of the stream.
  78  */
  79 static inline int stream_Read( stream_t *s, void *p_read, int i_read )
  80 {
  81     return s->pf_read( s, p_read, i_read );
  82 }
  83
  84 /**
  85  * Store in pp_peek a pointer to the next "i_peek" bytes in the stream
  86  * \return The real numbers of valid bytes, if it's less
  87  * or equal to 0, *pp_peek is invalid.
  88  * \note pp_peek is a pointer to internal buffer and it will be invalid as
  89  * soons as other stream_* functions are called.
  90  * \note Due to input limitation, it could be less than i_peek without meaning
  91  * the end of the stream (but only when you have i_peek >=
  92  * p_input->i_bufsize)
  93  */
  94 static inline int stream_Peek( stream_t *s, uint8_t **pp_peek, int i_peek )
  95 {
  96     return s->pf_peek( s, pp_peek, i_peek );
  97 }
  98
  99 /**
 100  * Use to control the "stream_t *". Look at #stream_query_e for
 101  * possible "i_query" value and format arguments.  Return VLC_SUCCESS
 102  * if ... succeed ;) and VLC_EGENERIC if failed or unimplemented
 103  */
 104 static inline int stream_vaControl( stream_t *s, int i_query, va_list args )
 105 {
 106     return s->pf_control( s, i_query, args );
 107 }
 108
 109 /**
 110  * Destroy a stream
 111  */
 112 static inline void stream_Delete( stream_t *s )
 113 {
 114     s->pf_destroy( s );
 115 }
 116
 117 static inline int stream_Control( stream_t *s, int i_query, ... )
 118 {
 119     va_list args;
 120     int     i_result;
 121
 122     va_start( args, i_query );
 123     i_result = s->pf_control( s, i_query, args );
 124     va_end( args );
 125     return i_result;
 126 }
 127
 128 /**
 129  * Get the current position in a stream
 130  */
 131 static inline int64_t stream_Tell( stream_t *s )
 132 {
 133     int64_t i_pos;
 134     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 135     return i_pos;
 136 }
 137
 138 /**
 139  * Get the size of the stream.
 140  */
 141 static inline int64_t stream_Size( stream_t *s )
 142 {
 143     int64_t i_pos;
 144     stream_Control( s, STREAM_GET_SIZE, &i_pos );
 145     return i_pos;
 146 }
 147 static inline int stream_MTU( stream_t *s )
 148 {
 149     int i_mtu;
 150     stream_Control( s, STREAM_GET_MTU, &i_mtu );
 151     return i_mtu;
 152 }
 153 static inline int stream_Seek( stream_t *s, int64_t i_pos )
 154 {
 155     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 156 }
 157
 158 /**
 159  * Read "i_size" bytes and store them in a block_t. If less than "i_size"
 160  * bytes are available then return what is left and if nothing is availble,
 161  * return NULL.
 162  */
 163 static inline block_t *stream_Block( stream_t *s, int i_size )
 164 {
 165     if( i_size <= 0 ) return NULL;
 166
 167     if( s->pf_block )
 168     {
 169         return s->pf_block( s, i_size );
 170     }
 171     else
 172     {
 173         /* emulate block read */
 174         block_t *p_bk = block_New( s, i_size );
 175         if( p_bk )
 176         {
 177             p_bk->i_buffer = stream_Read( s, p_bk->p_buffer, i_size );
 178             if( p_bk->i_buffer > 0 )
 179             {
 180                 return p_bk;
 181             }
 182         }
 183         if( p_bk ) block_Release( p_bk );
 184         return NULL;
 185     }
 186 }
 187
 188 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
 189
 190 /**
 191  * Create a special stream and a demuxer, this allows chaining demuxers
 192  */
 193 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
 194 VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, char *psz_demux, es_out_t *out ) );
 195 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 196 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 197
 198
 199 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 200 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, vlc_bool_t i_preserve_memory ) );
 201 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
 202 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
 203
 204 /**
 205  * @}
 206  */
 207
 208 #endif