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 /**
  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     bool        b_error;
  56
  57     /* Module properties for stream filter */
  58     module_t    *p_module;
  59
  60     char        *psz_access;
  61     /* Real or virtual path (it can only be changed during stream_t opening) */
  62     char        *psz_path;
  63
  64     /* Stream source for stream filter */
  65     stream_t *p_source;
  66
  67     /* */
  68     int         (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
  69     int         (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
  70     int         (*pf_readdir)( stream_t *, input_item_node_t * );
  71     int         (*pf_control)( stream_t *, int i_query, va_list );
  72
  73     /* */
  74     void     (*pf_destroy)( stream_t *);
  75
  76     /* Private data for module */
  77     stream_sys_t *p_sys;
  78
  79     /* Text reader state */
  80     stream_text_t *p_text;
  81
  82     /* Weak link to parent input */
  83     input_thread_t *p_input;
  84 };
  85
  86 /**
  87  * Possible commands to send to stream_Control() and stream_vaControl()
  88  */
  89 enum stream_query_e
  90 {
  91     /* capabilities */
  92     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
  93     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
  94     STREAM_CAN_PAUSE,           /**< arg1= bool *   res=cannot fail*/
  95     STREAM_CAN_CONTROL_PACE,    /**< arg1= bool *   res=cannot fail*/
  96     STREAM_IS_DIRECTORY,        /**< arg1= bool *   res=cannot fail*/
  97
  98     /* */
  99     STREAM_SET_POSITION,        /**< arg1= uint64_t       res=can fail  */
 100     STREAM_GET_POSITION,        /**< arg1= uint64_t *     res=cannot fail*/
 101
 102     STREAM_GET_SIZE,            /**< arg1= uint64_t *     res=cannot fail (0 if no sense)*/
 103
 104     /* You should update size of source if any and then update size
 105      * FIXME find a way to avoid it */
 106     STREAM_UPDATE_SIZE,
 107
 108     /* */
 109     STREAM_GET_PTS_DELAY = 0x101,/**< arg1= int64_t* res=cannot fail */
 110     STREAM_GET_TITLE_INFO, /**< arg1=input_title_t*** arg2=int* res=can fail */
 111     STREAM_GET_TITLE,       /**< arg1=unsigned * res=can fail */
 112     STREAM_GET_SEEKPOINT,   /**< arg1=unsigned * res=can fail */
 113     STREAM_GET_META,        /**< arg1= vlc_meta_t **       res=can fail */
 114     STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
 115     STREAM_GET_SIGNAL,      /**< arg1=double *pf_quality, arg2=double *pf_strength   res=can fail */
 116
 117     STREAM_SET_PAUSE_STATE = 0x200, /**< arg1= bool        res=can fail */
 118     STREAM_SET_TITLE,       /**< arg1= int          res=can fail */
 119     STREAM_SET_SEEKPOINT,   /**< arg1= int          res=can fail */
 120
 121     /* XXX only data read through stream_Read/Block will be recorded */
 122     STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
 123
 124     STREAM_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected    res=can fail */
 125     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 */
 126     STREAM_GET_PRIVATE_ID_STATE,          /* arg1=int i_private_data arg2=bool *          res=can fail */
 127 };
 128
 129 VLC_API int stream_Read( stream_t *s, void *p_read, int i_read );
 130 VLC_API int stream_Peek( stream_t *s, const uint8_t **pp_peek, int i_peek );
 131 VLC_API int stream_vaControl( stream_t *s, int i_query, va_list args );
 132 VLC_API void stream_Delete( stream_t *s );
 133 VLC_API int stream_Control( stream_t *s, int i_query, ... );
 134 VLC_API block_t * stream_Block( stream_t *s, int i_size );
 135 VLC_API block_t * stream_BlockRemaining( stream_t *s, int i_max_size );
 136 VLC_API char * stream_ReadLine( stream_t * );
 137 VLC_API int stream_ReadDir( stream_t *, input_item_node_t * );
 138
 139 /**
 140  * Get the current position in a stream
 141  */
 142 static inline int64_t stream_Tell( stream_t *s )
 143 {
 144     uint64_t i_pos;
 145     stream_Control( s, STREAM_GET_POSITION, &i_pos );
 146     if( i_pos >> 62 )
 147         return (int64_t)1 << 62;
 148     return i_pos;
 149 }
 150
 151 /**
 152  * Get the size of the stream.
 153  */
 154 static inline int64_t stream_Size( stream_t *s )
 155 {
 156     uint64_t i_pos;
 157     stream_Control( s, STREAM_GET_SIZE, &i_pos );
 158     if( i_pos >> 62 )
 159         return (int64_t)1 << 62;
 160     return i_pos;
 161 }
 162
 163 static inline int stream_Seek( stream_t *s, uint64_t i_pos )
 164 {
 165     return stream_Control( s, STREAM_SET_POSITION, i_pos );
 166 }
 167
 168 /**
 169  * Get the Content-Type of a stream, or NULL if unknown.
 170  * Result must be free()'d.
 171  */
 172 static inline char *stream_ContentType( stream_t *s )
 173 {
 174     char *res;
 175     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
 176         return NULL;
 177     return res;
 178 }
 179
 180 /**
 181  * Create a special stream and a demuxer, this allows chaining demuxers
 182  * You must delete it using stream_Delete.
 183  */
 184 VLC_API stream_t * stream_DemuxNew( demux_t *p_demux, const char *psz_demux, es_out_t *out );
 185
 186 /**
 187  * Send data to a stream handle created by stream_DemuxNew().
 188  */
 189 VLC_API void stream_DemuxSend( stream_t *s, block_t *p_block );
 190
 191 /**
 192  * Perform a <b>demux</b> (i.e. DEMUX_...) control request on a stream handle
 193  * created by stream_DemuxNew().
 194  */
 195 VLC_API int stream_DemuxControlVa( stream_t *s, int, va_list );
 196
 197 static inline int stream_DemuxControl( stream_t *s, int query, ... )
 198 {
 199     va_list ap;
 200     int ret;
 201
 202     va_start( ap, query );
 203     ret = stream_DemuxControlVa( s, query, ap );
 204     va_end( ap );
 205     return ret;
 206 }
 207
 208 /**
 209  * Create a stream_t reading from memory.
 210  * You must delete it using stream_Delete.
 211  */
 212 VLC_API stream_t * stream_MemoryNew(vlc_object_t *p_obj, uint8_t *p_buffer, uint64_t i_size, bool b_preserve_memory );
 213 #define stream_MemoryNew( a, b, c, d ) stream_MemoryNew( VLC_OBJECT(a), b, c, d )
 214
 215 /**
 216  * Create a stream_t reading from a URL.
 217  * You must delete it using stream_Delete.
 218  */
 219 VLC_API stream_t * stream_UrlNew(vlc_object_t *p_this, const char *psz_url );
 220 #define stream_UrlNew( a, b ) stream_UrlNew( VLC_OBJECT(a), b )
 221
 222
 223 /**
 224  * Try to add a stream filter to an open stream.
 225  * @return New stream to use, or NULL if the filter could not be added.
 226  **/
 227 VLC_API stream_t* stream_FilterNew( stream_t *p_source, const char *psz_stream_filter );
 228
 229 /**
 230  * Default ReadDir implementation for stream Filter. This implementation just
 231  * forward the pf_readdir call to the p_source stream.
 232  */
 233 VLC_API int stream_FilterDefaultReadDir( stream_t *s, input_item_node_t *p_node );
 234
 235 /**
 236  * Sets stream_FilterDefaultReadDir as the pf_readdir callback for this stream filter
 237  */
 238 #define stream_FilterSetDefaultReadDir(p_stream) \
 239     p_stream->pf_readdir = stream_FilterDefaultReadDir;
 240
 241 /**
 242  * @}
 243  */
 244
 245 # ifdef __cplusplus
 246 }
 247 # endif
 248
 249 #endif