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 /**
  30  * \file
  31  * This file defines structures and functions for stream (between access and demux) descriptor in vlc
  32  */
  33
  34 # ifdef __cplusplus
  35 extern "C" {
  36 # endif
  37
  38 /**
  39  * \defgroup stream Stream
  40  *
  41  *  This will allow you to easily handle read/seek in demuxer modules.
  42  * @{
  43  */
  44
  45 /* Opaque definition for text reader context */
  46 typedef struct stream_text_t stream_text_t;
  47
  48 /**
  49  * stream_t definition
  50  */
  51
  52 struct stream_t
  53 {
  54     VLC_COMMON_MEMBERS
  55
  56     /* Module properties */
  57     module_t    *p_module;
  58
  59     /* For stream filter they will hold an array of stream sources */
  60     int      i_source;
  61     stream_t **pp_source;
  62
  63     /* */
  64     int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
  65     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
  66     int      (*pf_control)( stream_t *, int i_query, va_list );
  67     void     (*pf_destroy)( stream_t *);
  68
  69     /* Private data for module */
  70     stream_sys_t *p_sys;
  71
  72     /* Text reader state */
  73     stream_text_t *p_text;
  74 };
  75
  76 /**
  77  * Possible commands to send to stream_Control() and stream_vaControl()
  78  */
  79 enum stream_query_e
  80 {
  81     /* capabilities */
  82     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
  83     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
  84
  85     /* */
  86     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
  87     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
  88
  89     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
  90
  91     STREAM_GET_MTU,             /**< arg1= int *          res=cannot fail (0 if no sense)*/
  92
  93     /* Special for direct access control from demuxer.
  94      * XXX: avoid using it by all means */
  95     STREAM_CONTROL_ACCESS,  /* arg1= int i_access_query, args   res: can fail
  96                              if access unreachable or access control answer */
  97
  98     STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
  99
 100     /* SET_RECORD:
 101      * XXX only data read through stream_Read/Block will be recorded */
 102     STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
 103 };
 104
 105 VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
 106 VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
 107 VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
 108 VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
 109 VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
 110 VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
 111 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
 112
 113 /**
 114  * Get the current position in a stream
 115  */
 116 static inline int64_t stream_Tell( stream_t *s )
 117 {
 118     int64_t i_pos;
 119     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 120     return i_pos;
 121 }
 122
 123 /**
 124  * Get the size of the stream.
 125  */
 126 static inline int64_t stream_Size( stream_t *s )
 127 {
 128     int64_t i_pos;
 129     stream_Control( s, STREAM_GET_SIZE, &i_pos );
 130     return i_pos;
 131 }
 132
 133 static inline int stream_MTU( stream_t *s )
 134 {
 135     int i_mtu;
 136     stream_Control( s, STREAM_GET_MTU, &i_mtu );
 137     return i_mtu;
 138 }
 139
 140 static inline int stream_Seek( stream_t *s, int64_t i_pos )
 141 {
 142     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 143 }
 144
 145 /**
 146  * Get the Content-Type of a stream, or NULL if unknown.
 147  * Result must be free()'d.
 148  */
 149 static inline char *stream_ContentType( stream_t *s )
 150 {
 151     char *res;
 152     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
 153         return NULL;
 154     return res;
 155 }
 156
 157 /**
 158  * Create a special stream and a demuxer, this allows chaining demuxers
 159  */
 160 #define stream_DemuxNew( a, b, c ) __stream_DemuxNew( VLC_OBJECT(a), b, c)
 161 VLC_EXPORT( stream_t *,__stream_DemuxNew, ( vlc_object_t *p_obj, const char *psz_demux, es_out_t *out ) );
 162 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
 163 VLC_EXPORT( void,      stream_DemuxDelete,( stream_t *s ) );
 164
 165 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 166 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool i_preserve_memory ) );
 167 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
 168 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
 169
 170 /**
 171  * @}
 172  */
 173
 174 # ifdef __cplusplus
 175 }
 176 # endif
 177
 178 #endif