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= bool *   res=cannot fail*/
  47     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   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     STREAM_GET_CONTENT_TYPE,   /**< arg1= char **         res=can file */
  63 };
  64
  65 VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
  66 VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
  67 VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
  68 VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
  69 VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
  70 VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
  71 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
  72
  73 /**
  74  * Get the current position in a stream
  75  */
  76 static inline int64_t stream_Tell( stream_t *s )
  77 {
  78     int64_t i_pos;
  79     stream_Control( s, STREAM_GET_POSITION, &i_pos );
  80     return i_pos;
  81 }
  82
  83 /**
  84  * Get the size of the stream.
  85  */
  86 static inline int64_t stream_Size( stream_t *s )
  87 {
  88     int64_t i_pos;
  89     stream_Control( s, STREAM_GET_SIZE, &i_pos );
  90     return i_pos;
  91 }
  92
  93 static inline int stream_MTU( stream_t *s )
  94 {
  95     int i_mtu;
  96     stream_Control( s, STREAM_GET_MTU, &i_mtu );
  97     return i_mtu;
  98 }
  99
 100 static inline int stream_Seek( stream_t *s, int64_t i_pos )
 101 {
 102     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 103 }
 104
 105 /**
 106  * Get the Content-Type of a stream, or NULL if unknown.
 107  * Result must be free()'d.
 108  */
 109 static inline char *stream_ContentType( stream_t *s )
 110 {
 111     char *res;
 112     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
 113         return NULL;
 114     return res;
 115 }
 116
 117 /**
 118  * Create a special stream and a demuxer, this allows chaining demuxers
 119  */
 120 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
 121 VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
 122 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 123 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 124
 125
 126 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 127 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool i_preserve_memory ) );
 128 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
 129 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
 130
 131 /**
 132  * @}
 133  */
 134
 135 # ifdef __cplusplus
 136 }
 137 # endif
 138
 139 # if defined (__PLUGIN__) || defined (__BUILTIN__)
 140    /* FIXME UGLY HACK to keep VLC_OBJECT working */
 141    /* Maybe we should make VLC_OBJECT a simple cast noawadays... */
 142 struct stream_t
 143 {
 144     VLC_COMMON_MEMBERS
 145 };
 146 # endif
 147
 148 #endif