vlc_stream.h 7.31 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
/**
 * stream_t definition
 */

struct stream_t
{
    VLC_COMMON_MEMBERS
49
    bool        b_error;
Laurent Aimar's avatar
Laurent Aimar committed
50

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

54
    char        *psz_url;
55

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

    /* */
60
    int         (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
Thomas Guillem's avatar
Thomas Guillem committed
61
    input_item_t *(*pf_readdir)( stream_t * );
62
    int         (*pf_control)( stream_t *, int i_query, va_list );
63 64

    /* */
Laurent Aimar's avatar
Laurent Aimar committed
65 66 67 68 69
    void     (*pf_destroy)( stream_t *);

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

70 71
    /* Weak link to parent input */
    input_thread_t *p_input;
Laurent Aimar's avatar
Laurent Aimar committed
72 73
};

74 75 76 77 78 79
/**
 * Possible commands to send to stream_Control() and stream_vaControl()
 */
enum stream_query_e
{
    /* capabilities */
80 81
    STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
    STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
82 83
    STREAM_CAN_PAUSE,           /**< arg1= bool *   res=cannot fail*/
    STREAM_CAN_CONTROL_PACE,    /**< arg1= bool *   res=cannot fail*/
84
    /* */
85 86
    STREAM_SET_POSITION,        /**< arg1= uint64_t       res=can fail  */
    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 92
    STREAM_GET_PTS_DELAY = 0x101,/**< arg1= int64_t* res=cannot fail */
    STREAM_GET_TITLE_INFO, /**< arg1=input_title_t*** arg2=int* res=can fail */
93 94
    STREAM_GET_TITLE,       /**< arg1=unsigned * res=can fail */
    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 101
    STREAM_SET_TITLE,       /**< arg1= int          res=can fail */
    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 107 108

    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 */
109 110
};

111 112
VLC_API ssize_t stream_Read(stream_t *, void *, size_t);
VLC_API ssize_t stream_Peek(stream_t *, const uint8_t **, size_t);
113 114 115 116 117
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, ... );
VLC_API block_t * stream_Block( stream_t *s, int i_size );
VLC_API char * stream_ReadLine( stream_t * );
Thomas Guillem's avatar
Thomas Guillem committed
118
VLC_API input_item_t *stream_ReadDir( stream_t * );
119 120 121 122

/**
 * Get the current position in a stream
 */
123 124
static inline int64_t stream_Tell( stream_t *s )
{
125
    uint64_t i_pos;
126
    stream_Control( s, STREAM_GET_POSITION, &i_pos );
127 128
    if( i_pos >> 62 )
        return (int64_t)1 << 62;
129 130
    return i_pos;
}
131 132 133 134

/**
 * Get the size of the stream.
 */
135 136
static inline int64_t stream_Size( stream_t *s )
{
137
    uint64_t i_pos;
138 139 140

    if( stream_Control( s, STREAM_GET_SIZE, &i_pos ) )
        i_pos = 0;
141 142
    if( i_pos >> 62 )
        return (int64_t)1 << 62;
143 144
    return i_pos;
}
145

146
static inline int stream_Seek( stream_t *s, uint64_t i_pos )
147 148 149 150
{
    return stream_Control( s, STREAM_SET_POSITION, i_pos );
}

151 152 153 154 155 156 157 158 159 160 161 162
/**
 * 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;
}

163 164
/**
 * Create a special stream and a demuxer, this allows chaining demuxers
165
 * You must delete it using stream_Delete.
166
 */
167
VLC_API stream_t * stream_DemuxNew( demux_t *p_demux, const char *psz_demux, es_out_t *out );
Antoine Cellerier's avatar
Antoine Cellerier committed
168

169
/**
170
 * Send data to a stream handle created by stream_DemuxNew().
171
 */
172
VLC_API void stream_DemuxSend( stream_t *s, block_t *p_block );
173

174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
/**
 * Perform a <b>demux</b> (i.e. DEMUX_...) control request on a stream handle
 * created by stream_DemuxNew().
 */
VLC_API int stream_DemuxControlVa( stream_t *s, int, va_list );

static inline int stream_DemuxControl( stream_t *s, int query, ... )
{
    va_list ap;
    int ret;

    va_start( ap, query );
    ret = stream_DemuxControlVa( s, query, ap );
    va_end( ap );
    return ret;
}

191 192 193 194
/**
 * Create a stream_t reading from memory.
 * You must delete it using stream_Delete.
 */
195
VLC_API stream_t * stream_MemoryNew(vlc_object_t *p_obj, uint8_t *p_buffer, uint64_t i_size, bool b_preserve_memory );
196
#define stream_MemoryNew( a, b, c, d ) stream_MemoryNew( VLC_OBJECT(a), b, c, d )
197 198

/**
Pierre Ynard's avatar
Pierre Ynard committed
199
 * Create a stream_t reading from a URL.
200 201
 * You must delete it using stream_Delete.
 */
202
VLC_API stream_t * stream_UrlNew(vlc_object_t *p_this, const char *psz_url );
203 204
#define stream_UrlNew( a, b ) stream_UrlNew( VLC_OBJECT(a), b )

205

206 207 208 209
/**
 * Try to add a stream filter to an open stream.
 * @return New stream to use, or NULL if the filter could not be added.
 **/
210
VLC_API stream_t* stream_FilterNew( stream_t *p_source, const char *psz_stream_filter );
211 212 213 214 215

/**
 * Default ReadDir implementation for stream Filter. This implementation just
 * forward the pf_readdir call to the p_source stream.
 */
Thomas Guillem's avatar
Thomas Guillem committed
216
VLC_API input_item_t *stream_FilterDefaultReadDir( stream_t *s );
217 218 219 220 221 222 223

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

224 225 226 227
/**
 * @}
 */

228 229 230 231
# ifdef __cplusplus
}
# endif

232
#endif