vlc_stream.h 5.67 KB
Newer Older
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 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * 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 33
/**
 * \file
 * This file defines structures and functions for stream (between access and demux) descriptor in vlc
 */

34 35 36 37
# ifdef __cplusplus
extern "C" {
# endif

38 39 40 41 42 43 44
/**
 * \defgroup stream Stream
 *
 *  This will allow you to easily handle read/seek in demuxer modules.
 * @{
 */

Laurent Aimar's avatar
Laurent Aimar committed
45 46 47 48 49 50 51 52 53 54 55
/* Opaque definition for text reader context */
typedef struct stream_text_t stream_text_t;

/**
 * stream_t definition
 */

struct stream_t
{
    VLC_COMMON_MEMBERS

56
    /* Module properties for stream filter */
Laurent Aimar's avatar
Laurent Aimar committed
57 58
    module_t    *p_module;

59 60 61
    /* Real or virtual path (it can only be changed during stream_t opening) */
    char        *psz_path;

62 63
    /* Stream source for stream filter */
    stream_t *p_source;
Laurent Aimar's avatar
Laurent Aimar committed
64 65 66 67 68

    /* */
    int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
    int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
    int      (*pf_control)( stream_t *, int i_query, va_list );
69 70

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
71 72 73 74 75 76 77 78 79
    void     (*pf_destroy)( stream_t *);

    /* Private data for module */
    stream_sys_t *p_sys;

    /* Text reader state */
    stream_text_t *p_text;
};

80 81 82 83 84 85
/**
 * Possible commands to send to stream_Control() and stream_vaControl()
 */
enum stream_query_e
{
    /* capabilities */
86 87
    STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
    STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
88 89 90 91 92 93 94 95 96

    /* */
    STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
    STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/

    STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/

    /* Special for direct access control from demuxer.
     * XXX: avoid using it by all means */
97
    STREAM_CONTROL_ACCESS,  /* arg1= int i_access_query, args   res: can fail
Clément Stenac's avatar
Clément Stenac committed
98
                             if access unreachable or access control answer */
99

100 101 102 103 104
    /* You should update size of source if any and then update size 
     * FIXME find a way to avoid it */
    STREAM_UPDATE_SIZE,

    /* */
105 106
    STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */

107
    /* XXX only data read through stream_Read/Block will be recorded */
108
    STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
109 110
};

111
VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
112
VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
113 114 115 116 117
VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
118 119 120 121

/**
 * Get the current position in a stream
 */
122 123 124 125 126 127
static inline int64_t stream_Tell( stream_t *s )
{
    int64_t i_pos;
    stream_Control( s, STREAM_GET_POSITION, &i_pos );
    return i_pos;
}
128 129 130 131

/**
 * Get the size of the stream.
 */
132 133 134 135 136 137
static inline int64_t stream_Size( stream_t *s )
{
    int64_t i_pos;
    stream_Control( s, STREAM_GET_SIZE, &i_pos );
    return i_pos;
}
138

139 140 141 142 143
static inline int stream_Seek( stream_t *s, int64_t i_pos )
{
    return stream_Control( s, STREAM_SET_POSITION, i_pos );
}

144 145 146 147 148 149 150 151 152 153 154 155
/**
 * 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;
}

156 157
/**
 * Create a special stream and a demuxer, this allows chaining demuxers
158
 * You must delete it using stream_Delete.
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 163 164
/**
 * Send data to a stream_t handle created by stream_DemuxNew.
 */
165
VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
166

167 168 169 170
/**
 * Create a stream_t reading from memory.
 * You must delete it using stream_Delete.
 */
171
#define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
172 173 174 175 176 177
VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool b_preserve_memory ) );

/**
 * Create a stream_t reading from an URL.
 * You must delete it using stream_Delete.
 */
178
#define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
179
VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
180

181 182 183 184
/**
 * @}
 */

185 186 187 188
# ifdef __cplusplus
}
# endif

189
#endif