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

   1 /*****************************************************************************
   2  * vlc_stream.h: Stream (between access and demux) descriptor and methods
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 the VideoLAN team
   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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_STREAM_H
  25 #define _VLC_STREAM_H 1
  26
  27 #include <vlc_block.h>
  28
  29 # ifdef __cplusplus
  30 extern "C" {
  31 # endif
  32
  33 /**
  34  * \defgroup stream Stream
  35  *
  36  *  This will allow you to easily handle read/seek in demuxer modules.
  37  * @{
  38  */
  39
  40 /**
  41  * Possible commands to send to stream_Control() and stream_vaControl()
  42  */
  43 enum stream_query_e
  44 {
  45     /* capabilities */
  46     STREAM_CAN_SEEK,            /**< arg1= vlc_bool_t *   res=cannot fail*/
  47     STREAM_CAN_FASTSEEK,        /**< arg1= vlc_bool_t *   res=cannot fail*/
  48
  49     /* */
  50     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
  51     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
  52
  53     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
  54
  55     STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
  56
  57     /* Special for direct access control from demuxer.
  58      * XXX: avoid using it by all means */
  59     STREAM_CONTROL_ACCESS   /* arg1= int i_access_query, args   res: can fail
  60                              if access unreachable or access control answer */
  61 };
  62
  63 /**
  64  * stream_t definition
  65  */
  66 struct stream_t
  67 {
  68     VLC_COMMON_MEMBERS
  69
  70     block_t *(*pf_block)  ( stream_t *, int i_size );
  71     int      (*pf_read)   ( stream_t *, void *p_read, int i_read );
  72     int      (*pf_peek)   ( stream_t *, uint8_t **pp_peek, int i_peek );
  73     int      (*pf_control)( stream_t *, int i_query, va_list );
  74     void     (*pf_destroy)( stream_t *);
  75
  76     stream_sys_t *p_sys;
  77
  78     /* UTF-16 and UTF-32 file reading */
  79     vlc_iconv_t     conv;
  80     int             i_char_width;
  81     vlc_bool_t      b_little_endian;
  82 };
  83
  84 /**
  85  * Try to read "i_read" bytes into a buffer pointed by "p_read".  If
  86  * "p_read" is NULL then data are skipped instead of read.  The return
  87  * value is the real numbers of bytes read/skip. If this value is less
  88  * than i_read that means that it's the end of the stream.
  89  */
  90 static inline int stream_Read( stream_t *s, void *p_read, int i_read )
  91 {
  92     return s->pf_read( s, p_read, i_read );
  93 }
  94
  95 /**
  96  * Store in pp_peek a pointer to the next "i_peek" bytes in the stream
  97  * \return The real numbers of valid bytes, if it's less
  98  * or equal to 0, *pp_peek is invalid.
  99  * \note pp_peek is a pointer to internal buffer and it will be invalid as
 100  * soons as other stream_* functions are called.
 101  * \note Due to input limitation, it could be less than i_peek without meaning
 102  * the end of the stream (but only when you have i_peek >=
 103  * p_input->i_bufsize)
 104  */
 105 static inline int stream_Peek( stream_t *s, uint8_t **pp_peek, int i_peek )
 106 {
 107     return s->pf_peek( s, pp_peek, i_peek );
 108 }
 109
 110 /**
 111  * Use to control the "stream_t *". Look at #stream_query_e for
 112  * possible "i_query" value and format arguments.  Return VLC_SUCCESS
 113  * if ... succeed ;) and VLC_EGENERIC if failed or unimplemented
 114  */
 115 static inline int stream_vaControl( stream_t *s, int i_query, va_list args )
 116 {
 117     return s->pf_control( s, i_query, args );
 118 }
 119
 120 /**
 121  * Destroy a stream
 122  */
 123 static inline void stream_Delete( stream_t *s )
 124 {
 125     s->pf_destroy( s );
 126 }
 127
 128 static inline int stream_Control( stream_t *s, int i_query, ... )
 129 {
 130     va_list args;
 131     int     i_result;
 132
 133     if ( s == NULL )
 134         return VLC_EGENERIC;
 135
 136     va_start( args, i_query );
 137     i_result = s->pf_control( s, i_query, args );
 138     va_end( args );
 139     return i_result;
 140 }
 141
 142 /**
 143  * Get the current position in a stream
 144  */
 145 static inline int64_t stream_Tell( stream_t *s )
 146 {
 147     int64_t i_pos;
 148     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 149     return i_pos;
 150 }
 151
 152 /**
 153  * Get the size of the stream.
 154  */
 155 static inline int64_t stream_Size( stream_t *s )
 156 {
 157     int64_t i_pos;
 158     stream_Control( s, STREAM_GET_SIZE, &i_pos );
 159     return i_pos;
 160 }
 161 static inline int stream_MTU( stream_t *s )
 162 {
 163     int i_mtu;
 164     stream_Control( s, STREAM_GET_MTU, &i_mtu );
 165     return i_mtu;
 166 }
 167 static inline int stream_Seek( stream_t *s, int64_t i_pos )
 168 {
 169     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 170 }
 171
 172 /**
 173  * Read "i_size" bytes and store them in a block_t. If less than "i_size"
 174  * bytes are available then return what is left and if nothing is availble,
 175  * return NULL.
 176  */
 177 static inline block_t *stream_Block( stream_t *s, int i_size )
 178 {
 179     if( i_size <= 0 ) return NULL;
 180
 181     if( s->pf_block )
 182     {
 183         return s->pf_block( s, i_size );
 184     }
 185     else
 186     {
 187         /* emulate block read */
 188         block_t *p_bk = block_New( s, i_size );
 189         if( p_bk )
 190         {
 191             p_bk->i_buffer = stream_Read( s, p_bk->p_buffer, i_size );
 192             if( p_bk->i_buffer > 0 )
 193             {
 194                 return p_bk;
 195             }
 196         }
 197         if( p_bk ) block_Release( p_bk );
 198         return NULL;
 199     }
 200 }
 201
 202 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
 203
 204 /**
 205  * Create a special stream and a demuxer, this allows chaining demuxers
 206  */
 207 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
 208 VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
 209 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 210 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 211
 212
 213 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 214 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 ) );
 215 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
 216 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
 217
 218 /**
 219  * @}
 220  */
 221
 222 # ifdef __cplusplus
 223 }
 224 # endif
 225
 226 #endif