include/vlc_stream.h

   1 /*****************************************************************************
   2  * vlc_stream.h: Stream (between access and demux) descriptor and methods
   3  *****************************************************************************
   4  * Copyright (C) 1999-2004 VLC authors and 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 it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * 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  * \ingroup input
  36  * Buffered input byte streams
  37  * @{
  38  * \file
  39  * Byte streams and byte stream filter modules interface
  40  */
  41
  42 /**
  43  * stream_t definition
  44  */
  45
  46 struct stream_t
  47 {
  48     VLC_COMMON_MEMBERS
  49     bool        b_error;
  50
  51     /* Module properties for stream filter */
  52     module_t    *p_module;
  53
  54     char        *psz_url;
  55
  56     /* Stream source for stream filter */
  57     stream_t *p_source;
  58
  59     /* */
  60     ssize_t     (*pf_read)(stream_t *, void *, size_t);
  61     input_item_t *(*pf_readdir)( stream_t * );
  62     int         (*pf_control)( stream_t *, int i_query, va_list );
  63
  64     /* */
  65     void     (*pf_destroy)( stream_t *);
  66
  67     /* Private data for module */
  68     stream_sys_t *p_sys;
  69
  70     /* Weak link to parent input */
  71     input_thread_t *p_input;
  72 };
  73
  74 /**
  75  * Possible commands to send to stream_Control() and stream_vaControl()
  76  */
  77 enum stream_query_e
  78 {
  79     /* capabilities */
  80     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
  81     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
  82     STREAM_CAN_PAUSE,           /**< arg1= bool *   res=cannot fail*/
  83     STREAM_CAN_CONTROL_PACE,    /**< arg1= bool *   res=cannot fail*/
  84     /* */
  85     STREAM_SET_POSITION,        /**< arg1= uint64_t       res=can fail  */
  86     STREAM_GET_POSITION,        /**< arg1= uint64_t *     res=cannot fail*/
  87     STREAM_GET_SIZE,            /**< arg1= uint64_t *     res=can fail */
  88     STREAM_IS_DIRECTORY,        /**< arg1= bool *, arg2= bool *, arg3=bool *, res=cannot fail*/
  89
  90     /* */
  91     STREAM_GET_PTS_DELAY = 0x101,/**< arg1= int64_t* res=cannot fail */
  92     STREAM_GET_TITLE_INFO, /**< arg1=input_title_t*** arg2=int* res=can fail */
  93     STREAM_GET_TITLE,       /**< arg1=unsigned * res=can fail */
  94     STREAM_GET_SEEKPOINT,   /**< arg1=unsigned * res=can fail */
  95     STREAM_GET_META,        /**< arg1= vlc_meta_t **       res=can fail */
  96     STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
  97     STREAM_GET_SIGNAL,      /**< arg1=double *pf_quality, arg2=double *pf_strength   res=can fail */
  98
  99     STREAM_SET_PAUSE_STATE = 0x200, /**< arg1= bool        res=can fail */
 100     STREAM_SET_TITLE,       /**< arg1= int          res=can fail */
 101     STREAM_SET_SEEKPOINT,   /**< arg1= int          res=can fail */
 102
 103     /* XXX only data read through stream_Read/Block will be recorded */
 104     STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
 105
 106     STREAM_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected    res=can fail */
 107     STREAM_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 */
 108     STREAM_GET_PRIVATE_ID_STATE,          /* arg1=int i_private_data arg2=bool *          res=can fail */
 109     STREAM_GET_PRIVATE_BLOCK, /**< arg1= block_t **b, arg2=bool *eof */
 110 };
 111
 112 VLC_API ssize_t stream_Read(stream_t *, void *, size_t);
 113 VLC_API ssize_t stream_Peek(stream_t *, const uint8_t **, size_t);
 114 VLC_API int stream_vaControl( stream_t *s, int i_query, va_list args );
 115 VLC_API void stream_Delete( stream_t *s );
 116 VLC_API int stream_Control( stream_t *s, int i_query, ... );
 117 VLC_API block_t * stream_Block( stream_t *s, size_t );
 118 VLC_API char * stream_ReadLine( stream_t * );
 119 VLC_API input_item_t *stream_ReadDir( stream_t * );
 120
 121 /**
 122  * Get the current position in a stream
 123  */
 124 static inline int64_t stream_Tell( stream_t *s )
 125 {
 126     uint64_t i_pos;
 127     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 128     if( i_pos >> 62 )
 129         return (int64_t)1 << 62;
 130     return i_pos;
 131 }
 132
 133 /**
 134  * Get the size of the stream.
 135  */
 136 VLC_USED static inline int stream_GetSize( stream_t *s, uint64_t *size )
 137 {
 138     return stream_Control( s, STREAM_GET_SIZE, size );
 139 }
 140
 141 static inline int64_t stream_Size( stream_t *s )
 142 {
 143     uint64_t i_pos;
 144
 145     if( stream_GetSize( s, &i_pos ) )
 146         return 0;
 147     if( i_pos >> 62 )
 148         return (int64_t)1 << 62;
 149     return i_pos;
 150 }
 151
 152 static inline int stream_Seek( stream_t *s, uint64_t i_pos )
 153 {
 154     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 155 }
 156
 157 /**
 158  * Get the Content-Type of a stream, or NULL if unknown.
 159  * Result must be free()'d.
 160  */
 161 static inline char *stream_ContentType( stream_t *s )
 162 {
 163     char *res;
 164     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
 165         return NULL;
 166     return res;
 167 }
 168
 169 /**
 170  * Create a special stream and a demuxer, this allows chaining demuxers
 171  * You must delete it using stream_Delete.
 172  */
 173 VLC_API stream_t * stream_DemuxNew( demux_t *p_demux, const char *psz_demux, es_out_t *out );
 174
 175 /**
 176  * Send data to a stream handle created by stream_DemuxNew().
 177  */
 178 VLC_API void stream_DemuxSend( stream_t *s, block_t *p_block );
 179
 180 /**
 181  * Perform a <b>demux</b> (i.e. DEMUX_...) control request on a stream handle
 182  * created by stream_DemuxNew().
 183  */
 184 VLC_API int stream_DemuxControlVa( stream_t *s, int, va_list );
 185
 186 static inline int stream_DemuxControl( stream_t *s, int query, ... )
 187 {
 188     va_list ap;
 189     int ret;
 190
 191     va_start( ap, query );
 192     ret = stream_DemuxControlVa( s, query, ap );
 193     va_end( ap );
 194     return ret;
 195 }
 196
 197 /**
 198  * Create a stream_t reading from memory.
 199  * You must delete it using stream_Delete.
 200  */
 201 VLC_API stream_t * stream_MemoryNew(vlc_object_t *p_obj, uint8_t *p_buffer, uint64_t i_size, bool b_preserve_memory );
 202 #define stream_MemoryNew( a, b, c, d ) stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 203
 204 /**
 205  * Create a stream_t reading from a URL.
 206  * You must delete it using stream_Delete.
 207  */
 208 VLC_API stream_t * stream_UrlNew(vlc_object_t *p_this, const char *psz_url );
 209 #define stream_UrlNew( a, b ) stream_UrlNew( VLC_OBJECT(a), b )
 210
 211
 212 /**
 213  * Try to add a stream filter to an open stream.
 214  * @return New stream to use, or NULL if the filter could not be added.
 215  **/
 216 VLC_API stream_t* stream_FilterNew( stream_t *p_source, const char *psz_stream_filter );
 217
 218 /**
 219  * Default ReadDir implementation for stream Filter. This implementation just
 220  * forward the pf_readdir call to the p_source stream.
 221  */
 222 VLC_API input_item_t *stream_FilterDefaultReadDir( stream_t *s );
 223
 224 /**
 225  * Sets stream_FilterDefaultReadDir as the pf_readdir callback for this stream filter
 226  */
 227 #define stream_FilterSetDefaultReadDir(p_stream) \
 228     p_stream->pf_readdir = stream_FilterDefaultReadDir;
 229
 230 /**
 231  * @}
 232  */
 233
 234 # ifdef __cplusplus
 235 }
 236 # endif
 237
 238 #endif