vlc_stream.h 13.2 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_stream.h: Stream (between access and demux) descriptor and methods
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2004 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
12 13 14 15
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25
#ifndef VLC_STREAM_H
#define VLC_STREAM_H 1
26

Clément Stenac's avatar
Clément Stenac committed
27 28
#include <vlc_block.h>

29 30 31 32
# ifdef __cplusplus
extern "C" {
# endif

33 34
/**
 * \defgroup stream Stream
35 36
 * \ingroup input
 * Buffered input byte streams
37
 * @{
38 39
 * \file
 * Byte streams and byte stream filter modules interface
40 41
 */

Laurent Aimar's avatar
Laurent Aimar committed
42 43 44 45 46 47 48 49
/**
 * stream_t definition
 */

struct stream_t
{
    VLC_COMMON_MEMBERS

50
    /* Module properties for stream filter */
Laurent Aimar's avatar
Laurent Aimar committed
51 52
    module_t    *p_module;

53
    char        *psz_url;
54

55 56
    /* Stream source for stream filter */
    stream_t *p_source;
Laurent Aimar's avatar
Laurent Aimar committed
57

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
    /**
     * Read data.
     *
     * Callback to read data from the stream into a caller-supplied buffer.
     *
     * This may be NULL if the stream is actually a directory rather than a
     * byte stream, or if \ref stream_t.pf_block is non-NULL.
     *
     * \param buf buffer to read data into
     * \param len buffer length (in bytes)
     *
     * \retval -1 no data available yet
     * \retval 0 end of stream (incl. fatal error)
     * \retval positive number of bytes read (no more than len)
     */
    ssize_t     (*pf_read)(stream_t *, void *buf, size_t len);

    /**
     * Read data block.
     *
     * Callback to read a block of data. The data is read into a block of
     * memory allocated by the stream. For some streams, data can be read more
     * efficiently in block of a certain size, and/or using a custom allocator
     * for buffers. In such case, this callback should be provided instead of
     * \ref stream_t.pf_read; otherwise, this should be NULL.
     *
     * \param eof storage space for end-of-stream flag [OUT]
     * (*eof is always false when invoking pf_block(); pf_block() should set
     *  *eof to true if it detects the end of the stream)
     *
     * \return a data block,
     * NULL if no data available yet, on error and at end-of-stream
     */
    block_t    *(*pf_block)(stream_t *, bool *eof);

    /**
     * Read directory.
     *
     * Callback to fill an item node from a directory
     * (see doc/browsing.txt for details).
     *
     * NULL if the stream is not a directory.
     */
    int         (*pf_readdir)(stream_t *, input_item_node_t *);

    /**
     * Seek.
     *
     * Callback to set the stream pointer (in bytes from start).
     *
     * May be NULL if seeking is not supported.
     */
110
    int         (*pf_seek)(stream_t *, uint64_t);
111

112 113 114 115 116 117 118 119 120 121 122 123
    /**
     * Stream control.
     *
     * Cannot be NULL.
     *
     * \see stream_query_e
     */
    int         (*pf_control)(stream_t *, int i_query, va_list);

    /**
     * Private data pointer
     */
124
    void *p_sys;
Laurent Aimar's avatar
Laurent Aimar committed
125

126 127
    /* Weak link to parent input */
    input_thread_t *p_input;
Laurent Aimar's avatar
Laurent Aimar committed
128 129
};

130 131 132 133 134 135
/**
 * Possible commands to send to stream_Control() and stream_vaControl()
 */
enum stream_query_e
{
    /* capabilities */
136 137
    STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
    STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
138 139
    STREAM_CAN_PAUSE,           /**< arg1= bool *   res=cannot fail*/
    STREAM_CAN_CONTROL_PACE,    /**< arg1= bool *   res=cannot fail*/
140
    /* */
141
    STREAM_GET_SIZE=6,          /**< arg1= uint64_t *     res=can fail */
142
    STREAM_IS_DIRECTORY,        /**< arg1= bool *, res=can fail*/
143

144
    /* */
145 146
    STREAM_GET_PTS_DELAY = 0x101,/**< arg1= int64_t* res=cannot fail */
    STREAM_GET_TITLE_INFO, /**< arg1=input_title_t*** arg2=int* res=can fail */
147 148
    STREAM_GET_TITLE,       /**< arg1=unsigned * res=can fail */
    STREAM_GET_SEEKPOINT,   /**< arg1=unsigned * res=can fail */
149
    STREAM_GET_META,        /**< arg1= vlc_meta_t *       res=can fail */
150
    STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
151
    STREAM_GET_SIGNAL,      /**< arg1=double *pf_quality, arg2=double *pf_strength   res=can fail */
152

153
    STREAM_SET_PAUSE_STATE = 0x200, /**< arg1= bool        res=can fail */
154 155
    STREAM_SET_TITLE,       /**< arg1= int          res=can fail */
    STREAM_SET_SEEKPOINT,   /**< arg1= int          res=can fail */
156

157
    /* XXX only data read through stream_Read/Block will be recorded */
158
    STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
159 160 161 162

    STREAM_SET_PRIVATE_ID_STATE = 0x1000, /* arg1= int i_private_data, bool b_selected    res=can fail */
    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 */
    STREAM_GET_PRIVATE_ID_STATE,          /* arg1=int i_private_data arg2=bool *          res=can fail */
163 164
};

165 166 167 168 169 170 171 172 173 174 175 176 177
/**
 * Reads data from a byte stream.
 *
 * This function always waits for the requested number of bytes, unless a fatal
 * error is encountered or the end-of-stream is reached first.
 *
 * If the buffer is NULL, data is skipped instead of read. This is effectively
 * a relative forward seek, but it works even on non-seekable streams.
 *
 * \param buf start of buffer to read data into [OUT]
 * \param len number of bytes to read
 * \return the number of bytes read or a negative value on error.
 */
178
VLC_API ssize_t stream_Read(stream_t *, void *, size_t) VLC_USED;
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

/**
 * Peeks at data from a byte stream.
 *
 * This function buffers for the requested number of bytes, waiting if
 * necessary. Then it stores a pointer to the buffer. Unlike stream_Read()
 * or stream_Block(), this function does not modify the stream read offset.
 *
 * \note
 * The buffer remains valid until the next read/peek or seek operation on the
 * same stream. In case of error, the buffer address is undefined.
 *
 * \param bufp storage space for the buffer address [OUT]
 * \param len number of bytes to peek
 * \return the number of bytes actually available (shorter than requested if
 * the end-of-stream is reached), or a negative value on error.
 */
196
VLC_API ssize_t stream_Peek(stream_t *, const uint8_t **, size_t) VLC_USED;
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/**
 * Reads a data block from a byte stream.
 *
 * This function dequeues the next block of data from the byte stream. The
 * byte stream back-end decides on the size of the block; the caller cannot
 * make any assumption about it.
 *
 * The function might also return NULL spuriously - this does not necessarily
 * imply that the stream is ended nor that it has encountered a nonrecoverable
 * error.
 *
 * This function should be used instead of stream_Read() or stream_Peek() when
 * the caller can handle reads of any size.
 *
 * \return either a data block or NULL
 */
VLC_API block_t *stream_ReadBlock(stream_t *) VLC_USED;

216 217 218 219 220 221 222
/**
 * Tells the current stream position.
 *
 * @return the byte offset from the beginning of the stream (cannot fail)
 */
VLC_API uint64_t stream_Tell(const stream_t *) VLC_USED;

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
/**
 * Checks for end of stream.
 *
 * Checks if the last attempt to reads data from the stream encountered the
 * end of stream before the attempt could be fully satisfied.
 * The value is initially false, and is reset to false by stream_Seek().
 *
 * \note The function can return false even though the current stream position
 * is equal to the stream size. It will return true after the following attempt
 * to read more than zero bytes.
 *
 * \note It might be possible to read after the end of the stream.
 * It implies the size of the stream increased asynchronously in the mean time.
 * Streams of most types cannot trigger such a case,
 * but regular local files notably can.
 *
 * \note In principles, the stream size should match the stream offset when
 * the end-of-stream is reached. But that rule is not enforced; it is entirely
 * dependent on the underlying implementation of the stream.
 */
VLC_API bool stream_Eof(const stream_t *) VLC_USED;

245 246 247 248 249 250 251 252
/**
 * Sets the current stream position.
 *
 * @param offset byte offset from the beginning of the stream
 * @return zero on success, a negative value on error
 */
VLC_API int stream_Seek(stream_t *, uint64_t offset) VLC_USED;

253 254 255
VLC_API int stream_vaControl( stream_t *s, int i_query, va_list args );
VLC_API void stream_Delete( stream_t *s );
VLC_API int stream_Control( stream_t *s, int i_query, ... );
256
VLC_API block_t * stream_Block( stream_t *s, size_t );
257
VLC_API char * stream_ReadLine( stream_t * );
258
VLC_API int stream_ReadDir( stream_t *, input_item_node_t * );
259

260
VLC_API stream_t *stream_CommonNew(vlc_object_t *, void (*)(stream_t *));
François Cartegnie's avatar
François Cartegnie committed
261

262 263 264
/**
 * Get the size of the stream.
 */
265 266 267 268 269
VLC_USED static inline int stream_GetSize( stream_t *s, uint64_t *size )
{
    return stream_Control( s, STREAM_GET_SIZE, size );
}

270 271
static inline int64_t stream_Size( stream_t *s )
{
272
    uint64_t i_pos;
273

274 275
    if( stream_GetSize( s, &i_pos ) )
        return 0;
276 277
    if( i_pos >> 62 )
        return (int64_t)1 << 62;
278 279
    return i_pos;
}
280 281 282 283 284 285 286 287 288 289 290 291 292

/**
 * Get the Content-Type of a stream, or NULL if unknown.
 * Result must be free()'d.
 */
static inline char *stream_ContentType( stream_t *s )
{
    char *res;
    if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
        return NULL;
    return res;
}

293
/**
294 295 296 297 298 299 300
 * Create a stream from a memory buffer.
 *
 * \param obj parent VLC object
 * \param base start address of the memory buffer to read from
 * \param size size in bytes of the memory buffer
 * \param preserve if false, free(base) will be called when the stream is
 *                 destroyed; if true, the memory buffer is preserved
301
 */
302 303 304 305
VLC_API stream_t *stream_MemoryNew(vlc_object_t *obj, uint8_t *base,
                                   size_t size, bool preserve) VLC_USED;
#define stream_MemoryNew(a, b, c, d) \
        stream_MemoryNew(VLC_OBJECT(a), b, c, d)
306 307

/**
Pierre Ynard's avatar
Pierre Ynard committed
308
 * Create a stream_t reading from a URL.
309 310
 * You must delete it using stream_Delete.
 */
311
VLC_API stream_t * stream_UrlNew(vlc_object_t *p_this, const char *psz_url );
312 313
#define stream_UrlNew( a, b ) stream_UrlNew( VLC_OBJECT(a), b )

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
/**
 * \defgroup stream_fifo FIFO stream
 * In-memory anonymous pipe
  @{
 */

/**
 * Creates a FIFO stream.
 *
 * Creates a non-seekable byte stream object whose byte stream is generated
 * by another thread in the process. This is the LibVLC equivalent of an
 * anonymous pipe/FIFO.
 *
 * On the reader side, the normal stream functions are used,
 * e.g. stream_Read() and stream_Delete().
 *
 * The created stream object is automatically destroyed when both the reader
 * and the writer sides have been closed, with stream_Delete() and
 * vlc_stream_fifo_Close() respectively.
 *
 * \param parent parent VLC object for the stream
 * \return a stream object or NULL on memory error.
 */
VLC_API stream_t *vlc_stream_fifo_New(vlc_object_t *parent);

/**
 * Writes a block to a FIFO stream.
 *
 * \param s FIFO stream created by vlc_stream_fifo_New()
 * \param block data block to write to the stream
 * \return 0 on success. -1 if the reader end has already been closed
 * (errno is then set to EPIPE, and the block is deleted).
 *
 * \bug No congestion control is performed. If the reader end is not keeping
 * up with the writer end, buffers will accumulate in memory.
 */
VLC_API int vlc_stream_fifo_Queue(stream_t *s, block_t *block);

/**
 * Writes data to a FIFO stream.
 *
 * This is a convenience helper for vlc_stream_fifo_Queue().
 * \param s FIFO stream created by vlc_stream_fifo_New()
 * \param buf start address of data to write
 * \param len length of data to write in bytes
 * \return len on success, or -1 on error (errno is set accordingly)
 */
VLC_API ssize_t vlc_stream_fifo_Write(stream_t *s, const void *buf,
                                      size_t len);

/**
 * Terminates a FIFO stream.
 *
 * Marks the end of the FIFO stream and releases any underlying resources.
 * \param s FIFO stream created by vlc_stream_fifo_New()
 */
VLC_API void vlc_stream_fifo_Close(stream_t *s);

/**
 * @}
 */
375

376 377 378 379
/**
 * Try to add a stream filter to an open stream.
 * @return New stream to use, or NULL if the filter could not be added.
 **/
380
VLC_API stream_t* stream_FilterNew( stream_t *p_source, const char *psz_stream_filter );
381 382 383 384 385

/**
 * Default ReadDir implementation for stream Filter. This implementation just
 * forward the pf_readdir call to the p_source stream.
 */
386
VLC_API int stream_FilterDefaultReadDir( stream_t *s, input_item_node_t *p_node );
387 388 389 390 391 392 393

/**
 * Sets stream_FilterDefaultReadDir as the pf_readdir callback for this stream filter
 */
#define stream_FilterSetDefaultReadDir(p_stream) \
    p_stream->pf_readdir = stream_FilterDefaultReadDir;

394 395 396 397
/**
 * @}
 */

398 399 400 401
# ifdef __cplusplus
}
# endif

402
#endif