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
  50     /* Module properties for stream filter */
  51     module_t    *p_module;
  52
  53     char        *psz_name;
  54     char        *psz_url; /**< Full URL or MRL (can be NULL) */
  55     const char  *psz_location; /**< Location (URL with the scheme stripped) */
  56     char        *psz_filepath; /**< Local file path (if applicable) */
  57     bool         b_preparsing; /**< True if this access is used to preparse */
  58
  59     /* Stream source for stream filter */
  60     stream_t *p_source;
  61
  62     /**
  63      * Read data.
  64      *
  65      * Callback to read data from the stream into a caller-supplied buffer.
  66      *
  67      * This may be NULL if the stream is actually a directory rather than a
  68      * byte stream, or if \ref stream_t.pf_block is non-NULL.
  69      *
  70      * \param buf buffer to read data into
  71      * \param len buffer length (in bytes)
  72      *
  73      * \retval -1 no data available yet
  74      * \retval 0 end of stream (incl. fatal error)
  75      * \retval positive number of bytes read (no more than len)
  76      */
  77     ssize_t     (*pf_read)(stream_t *, void *buf, size_t len);
  78
  79     /**
  80      * Read data block.
  81      *
  82      * Callback to read a block of data. The data is read into a block of
  83      * memory allocated by the stream. For some streams, data can be read more
  84      * efficiently in block of a certain size, and/or using a custom allocator
  85      * for buffers. In such case, this callback should be provided instead of
  86      * \ref stream_t.pf_read; otherwise, this should be NULL.
  87      *
  88      * \param eof storage space for end-of-stream flag [OUT]
  89      * (*eof is always false when invoking pf_block(); pf_block() should set
  90      *  *eof to true if it detects the end of the stream)
  91      *
  92      * \return a data block,
  93      * NULL if no data available yet, on error and at end-of-stream
  94      */
  95     block_t    *(*pf_block)(stream_t *, bool *eof);
  96
  97     /**
  98      * Read directory.
  99      *
 100      * Callback to fill an item node from a directory
 101      * (see doc/browsing.txt for details).
 102      *
 103      * NULL if the stream is not a directory.
 104      */
 105     int         (*pf_readdir)(stream_t *, input_item_node_t *);
 106
 107     /**
 108      * Seek.
 109      *
 110      * Callback to set the stream pointer (in bytes from start).
 111      *
 112      * May be NULL if seeking is not supported.
 113      */
 114     int         (*pf_seek)(stream_t *, uint64_t);
 115
 116     /**
 117      * Stream control.
 118      *
 119      * Cannot be NULL.
 120      *
 121      * \see stream_query_e
 122      */
 123     int         (*pf_control)(stream_t *, int i_query, va_list);
 124
 125     /**
 126      * Private data pointer
 127      */
 128     void *p_sys;
 129
 130     /* Weak link to parent input */
 131     input_thread_t *p_input;
 132 };
 133
 134 /**
 135  * Possible commands to send to vlc_stream_Control() and vlc_stream_vaControl()
 136  */
 137 enum stream_query_e
 138 {
 139     /* capabilities */
 140     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
 141     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
 142     STREAM_CAN_PAUSE,           /**< arg1= bool *   res=cannot fail*/
 143     STREAM_CAN_CONTROL_PACE,    /**< arg1= bool *   res=cannot fail*/
 144     /* */
 145     STREAM_GET_SIZE=6,          /**< arg1= uint64_t *     res=can fail */
 146     STREAM_IS_DIRECTORY,        /**< arg1= bool *, res=can fail*/
 147
 148     /* */
 149     STREAM_GET_PTS_DELAY = 0x101,/**< arg1= int64_t* res=cannot fail */
 150     STREAM_GET_TITLE_INFO, /**< arg1=input_title_t*** arg2=int* res=can fail */
 151     STREAM_GET_TITLE,       /**< arg1=unsigned * res=can fail */
 152     STREAM_GET_SEEKPOINT,   /**< arg1=unsigned * res=can fail */
 153     STREAM_GET_META,        /**< arg1= vlc_meta_t *       res=can fail */
 154     STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
 155     STREAM_GET_SIGNAL,      /**< arg1=double *pf_quality, arg2=double *pf_strength   res=can fail */
 156
 157     STREAM_SET_PAUSE_STATE = 0x200, /**< arg1= bool        res=can fail */
 158     STREAM_SET_TITLE,       /**< arg1= int          res=can fail */
 159     STREAM_SET_SEEKPOINT,   /**< arg1= int          res=can fail */
 160
 161     /* XXX only data read through vlc_stream_Read/Block will be recorded */
 162     STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
 163
 164     STREAM_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected    res=can fail */
 165     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 */
 166     STREAM_GET_PRIVATE_ID_STATE,          /* arg1=int i_private_data arg2=bool *          res=can fail */
 167 };
 168
 169 /**
 170  * Reads data from a byte stream.
 171  *
 172  * This function always waits for the requested number of bytes, unless a fatal
 173  * error is encountered or the end-of-stream is reached first.
 174  *
 175  * If the buffer is NULL, data is skipped instead of read. This is effectively
 176  * a relative forward seek, but it works even on non-seekable streams.
 177  *
 178  * \param buf start of buffer to read data into [OUT]
 179  * \param len number of bytes to read
 180  * \return the number of bytes read or a negative value on error.
 181  */
 182 VLC_API ssize_t vlc_stream_Read(stream_t *, void *buf, size_t len) VLC_USED;
 183
 184 /**
 185  * Reads partial data from a byte stream.
 186  *
 187  * This function waits until some data is available for reading from the
 188  * stream, a fatal error is encountered or the end-of-stream is reached.
 189  *
 190  * Unlike vlc_stream_Read(), this function does not wait for the full requested
 191  * bytes count. It can return a short count even before the end of the stream
 192  * and in the absence of any error.
 193  *
 194  * \param buf start of buffer to read data into [OUT]
 195  * \param len buffer size (maximum number of bytes to read)
 196  * \return the number of bytes read or a negative value on error.
 197  */
 198 VLC_API ssize_t vlc_stream_ReadPartial(stream_t *, void *buf, size_t len)
 199 VLC_USED;
 200
 201 /**
 202  * Peeks at data from a byte stream.
 203  *
 204  * This function buffers for the requested number of bytes, waiting if
 205  * necessary. Then it stores a pointer to the buffer. Unlike vlc_stream_Read()
 206  * or vlc_stream_Block(), this function does not modify the stream read offset.
 207  *
 208  * \note
 209  * The buffer remains valid until the next read/peek or seek operation on the
 210  * same stream. In case of error, the buffer address is undefined.
 211  *
 212  * \param bufp storage space for the buffer address [OUT]
 213  * \param len number of bytes to peek
 214  * \return the number of bytes actually available (shorter than requested if
 215  * the end-of-stream is reached), or a negative value on error.
 216  */
 217 VLC_API ssize_t vlc_stream_Peek(stream_t *, const uint8_t **, size_t) VLC_USED;
 218
 219 /**
 220  * Reads a data block from a byte stream.
 221  *
 222  * This function dequeues the next block of data from the byte stream. The
 223  * byte stream back-end decides on the size of the block; the caller cannot
 224  * make any assumption about it.
 225  *
 226  * The function might also return NULL spuriously - this does not necessarily
 227  * imply that the stream is ended nor that it has encountered a nonrecoverable
 228  * error.
 229  *
 230  * This function should be used instead of vlc_stream_Read() or
 231  * vlc_stream_Peek() when the caller can handle reads of any size.
 232  *
 233  * \return either a data block or NULL
 234  */
 235 VLC_API block_t *vlc_stream_ReadBlock(stream_t *) VLC_USED;
 236
 237 /**
 238  * Tells the current stream position.
 239  *
 240  * @return the byte offset from the beginning of the stream (cannot fail)
 241  */
 242 VLC_API uint64_t vlc_stream_Tell(const stream_t *) VLC_USED;
 243
 244 /**
 245  * Checks for end of stream.
 246  *
 247  * Checks if the last attempt to reads data from the stream encountered the
 248  * end of stream before the attempt could be fully satisfied.
 249  * The value is initially false, and is reset to false by vlc_stream_Seek().
 250  *
 251  * \note The function can return false even though the current stream position
 252  * is equal to the stream size. It will return true after the following attempt
 253  * to read more than zero bytes.
 254  *
 255  * \note It might be possible to read after the end of the stream.
 256  * It implies the size of the stream increased asynchronously in the mean time.
 257  * Streams of most types cannot trigger such a case,
 258  * but regular local files notably can.
 259  *
 260  * \note In principles, the stream size should match the stream offset when
 261  * the end-of-stream is reached. But that rule is not enforced; it is entirely
 262  * dependent on the underlying implementation of the stream.
 263  */
 264 VLC_API bool vlc_stream_Eof(const stream_t *) VLC_USED;
 265
 266 /**
 267  * Sets the current stream position.
 268  *
 269  * @param offset byte offset from the beginning of the stream
 270  * @return zero on success, a negative value on error
 271  */
 272 VLC_API int vlc_stream_Seek(stream_t *, uint64_t offset) VLC_USED;
 273
 274 VLC_API int vlc_stream_vaControl(stream_t *s, int query, va_list args);
 275
 276 static inline int vlc_stream_Control(stream_t *s, int query, ...)
 277 {
 278     va_list ap;
 279     int ret;
 280
 281     va_start(ap, query);
 282     ret = vlc_stream_vaControl(s, query, ap);
 283     va_end(ap);
 284     return ret;
 285 }
 286
 287 VLC_API block_t *vlc_stream_Block(stream_t *s, size_t);
 288 VLC_API char *vlc_stream_ReadLine(stream_t *);
 289 VLC_API int vlc_stream_ReadDir(stream_t *, input_item_node_t *);
 290
 291 /**
 292  * Closes a byte stream.
 293  * \param s byte stream to close
 294  */
 295 VLC_API void vlc_stream_Delete(stream_t *s);
 296
 297 VLC_API stream_t *vlc_stream_CommonNew(vlc_object_t *, void (*)(stream_t *));
 298
 299 /**
 300  * Get the size of the stream.
 301  */
 302 VLC_USED static inline int vlc_stream_GetSize( stream_t *s, uint64_t *size )
 303 {
 304     return vlc_stream_Control( s, STREAM_GET_SIZE, size );
 305 }
 306
 307 static inline int64_t stream_Size( stream_t *s )
 308 {
 309     uint64_t i_pos;
 310
 311     if( vlc_stream_GetSize( s, &i_pos ) )
 312         return 0;
 313     if( i_pos >> 62 )
 314         return (int64_t)1 << 62;
 315     return i_pos;
 316 }
 317
 318 /**
 319  * Get the Content-Type of a stream, or NULL if unknown.
 320  * Result must be free()'d.
 321  */
 322 static inline char *stream_ContentType( stream_t *s )
 323 {
 324     char *res;
 325     if( vlc_stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
 326         return NULL;
 327     return res;
 328 }
 329
 330 /**
 331  * Get the mime-type of a stream
 332  *
 333  * \warning the returned resource is to be freed by the caller
 334  * \return the mime-type, or `NULL` if unknown
 335  **/
 336 static inline char *stream_MimeType( stream_t *s )
 337 {
 338     char* mime_type = stream_ContentType( s );
 339
 340     if( mime_type ) /* strip parameters */
 341         mime_type[strcspn( mime_type, " ;" )] = '\0';
 342
 343     return mime_type;
 344 }
 345
 346 /**
 347  * Create a stream from a memory buffer.
 348  *
 349  * \param obj parent VLC object
 350  * \param base start address of the memory buffer to read from
 351  * \param size size in bytes of the memory buffer
 352  * \param preserve if false, free(base) will be called when the stream is
 353  *                 destroyed; if true, the memory buffer is preserved
 354  */
 355 VLC_API stream_t *vlc_stream_MemoryNew(vlc_object_t *obj, uint8_t *base,
 356                                        size_t size, bool preserve) VLC_USED;
 357 #define vlc_stream_MemoryNew(a, b, c, d) \
 358         vlc_stream_MemoryNew(VLC_OBJECT(a), b, c, d)
 359
 360 /**
 361  * Create a stream_t reading from a URL.
 362  * You must delete it using vlc_stream_Delete.
 363  */
 364 VLC_API stream_t * vlc_stream_NewURL(vlc_object_t *obj, const char *url)
 365 VLC_USED;
 366 #define vlc_stream_NewURL(a, b) vlc_stream_NewURL(VLC_OBJECT(a), b)
 367
 368 /**
 369  * \defgroup stream_fifo FIFO stream
 370  * In-memory anonymous pipe
 371   @{
 372  */
 373
 374 /**
 375  * Creates a FIFO stream.
 376  *
 377  * Creates a non-seekable byte stream object whose byte stream is generated
 378  * by another thread in the process. This is the LibVLC equivalent of an
 379  * anonymous pipe/FIFO.
 380  *
 381  * On the reader side, the normal stream functions are used,
 382  * e.g. vlc_stream_Read() and vlc_stream_Delete().
 383  *
 384  * The created stream object is automatically destroyed when both the reader
 385  * and the writer sides have been closed, with vlc_stream_Delete() and
 386  * vlc_stream_fifo_Close() respectively.
 387  *
 388  * \param parent parent VLC object for the stream
 389  * \return a stream object or NULL on memory error.
 390  */
 391 VLC_API stream_t *vlc_stream_fifo_New(vlc_object_t *parent);
 392
 393 /**
 394  * Writes a block to a FIFO stream.
 395  *
 396  * \param s FIFO stream created by vlc_stream_fifo_New()
 397  * \param block data block to write to the stream
 398  * \return 0 on success. -1 if the reader end has already been closed
 399  * (errno is then set to EPIPE, and the block is deleted).
 400  *
 401  * \bug No congestion control is performed. If the reader end is not keeping
 402  * up with the writer end, buffers will accumulate in memory.
 403  */
 404 VLC_API int vlc_stream_fifo_Queue(stream_t *s, block_t *block);
 405
 406 /**
 407  * Writes data to a FIFO stream.
 408  *
 409  * This is a convenience helper for vlc_stream_fifo_Queue().
 410  * \param s FIFO stream created by vlc_stream_fifo_New()
 411  * \param buf start address of data to write
 412  * \param len length of data to write in bytes
 413  * \return len on success, or -1 on error (errno is set accordingly)
 414  */
 415 VLC_API ssize_t vlc_stream_fifo_Write(stream_t *s, const void *buf,
 416                                       size_t len);
 417
 418 /**
 419  * Terminates a FIFO stream.
 420  *
 421  * Marks the end of the FIFO stream and releases any underlying resources.
 422  * \param s FIFO stream created by vlc_stream_fifo_New()
 423  */
 424 VLC_API void vlc_stream_fifo_Close(stream_t *s);
 425
 426 /**
 427  * @}
 428  */
 429
 430 /**
 431  * Try to add a stream filter to an open stream.
 432  * @return New stream to use, or NULL if the filter could not be added.
 433  **/
 434 VLC_API stream_t* vlc_stream_FilterNew( stream_t *p_source, const char *psz_stream_filter );
 435
 436 /**
 437  * Default ReadDir implementation for stream Filter. This implementation just
 438  * forward the pf_readdir call to the p_source stream.
 439  */
 440 VLC_API int vlc_stream_FilterDefaultReadDir(stream_t *s,
 441                                             input_item_node_t *p_node);
 442
 443 /**
 444  * Sets vlc_stream_FilterDefaultReadDir as the pf_readdir callback for this
 445  * stream filter.
 446  */
 447 #define stream_FilterSetDefaultReadDir(stream) \
 448 do { \
 449     (stream)->pf_readdir = vlc_stream_FilterDefaultReadDir; \
 450 } while (0)
 451
 452 /**
 453  * @}
 454  */
 455
 456 # ifdef __cplusplus
 457 }
 458 # endif
 459
 460 #endif