1 /*****************************************************************************
2 * vlc_stream.h: Stream (between access and demux) descriptor and methods
3 *****************************************************************************
4 * Copyright (C) 1999-2004 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
25 #define VLC_STREAM_H 1
27 #include <vlc_block.h>
31 * This file defines structures and functions for stream (between access and demux) descriptor in vlc
39 * \defgroup stream Stream
41 * This will allow you to easily handle read/seek in demuxer modules.
45 /* Opaque definition for text reader context */
46 typedef struct stream_text_t stream_text_t
;
57 /* Module properties for stream filter */
61 /* Real or virtual path (it can only be changed during stream_t opening) */
64 /* Stream source for stream filter */
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_control
)( stream_t
*, int i_query
, va_list );
73 void (*pf_destroy
)( stream_t
*);
75 /* Private data for module */
78 /* Text reader state */
79 stream_text_t
*p_text
;
81 /* Weak link to parent input */
82 input_thread_t
*p_input
;
86 * Possible commands to send to stream_Control() and stream_vaControl()
91 STREAM_CAN_SEEK
, /**< arg1= bool * res=cannot fail*/
92 STREAM_CAN_FASTSEEK
, /**< arg1= bool * res=cannot fail*/
95 STREAM_SET_POSITION
, /**< arg1= uint64_t res=can fail */
96 STREAM_GET_POSITION
, /**< arg1= uint64_t * res=cannot fail*/
98 STREAM_GET_SIZE
, /**< arg1= uint64_t * res=cannot fail (0 if no sense)*/
100 /* Special for direct access control from demuxer.
101 * XXX: avoid using it by all means */
102 STREAM_CONTROL_ACCESS
, /* arg1= int i_access_query, args res: can fail
103 if access unreachable or access control answer */
105 /* You should update size of source if any and then update size
106 * FIXME find a way to avoid it */
110 STREAM_GET_CONTENT_TYPE
, /**< arg1= char ** res=can fail */
112 /* XXX only data read through stream_Read/Block will be recorded */
113 STREAM_SET_RECORD_STATE
, /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true) res=can fail */
116 VLC_EXPORT( int, stream_Read
, ( stream_t
*s
, void *p_read
, int i_read
) );
117 VLC_EXPORT( int, stream_Peek
, ( stream_t
*s
, const uint8_t **pp_peek
, int i_peek
) );
118 VLC_EXPORT( int, stream_vaControl
, ( stream_t
*s
, int i_query
, va_list args
) );
119 VLC_EXPORT( void, stream_Delete
, ( stream_t
*s
) );
120 VLC_EXPORT( int, stream_Control
, ( stream_t
*s
, int i_query
, ... ) );
121 VLC_EXPORT( block_t
*, stream_Block
, ( stream_t
*s
, int i_size
) );
122 VLC_EXPORT( char *, stream_ReadLine
, ( stream_t
* ) );
125 * Get the current position in a stream
127 static inline int64_t stream_Tell( stream_t
*s
)
130 stream_Control( s
, STREAM_GET_POSITION
, &i_pos
);
132 return (int64_t)1 << 62;
137 * Get the size of the stream.
139 static inline int64_t stream_Size( stream_t
*s
)
142 stream_Control( s
, STREAM_GET_SIZE
, &i_pos
);
144 return (int64_t)1 << 62;
148 static inline int stream_Seek( stream_t
*s
, uint64_t i_pos
)
150 return stream_Control( s
, STREAM_SET_POSITION
, i_pos
);
154 * Get the Content-Type of a stream, or NULL if unknown.
155 * Result must be free()'d.
157 static inline char *stream_ContentType( stream_t
*s
)
160 if( stream_Control( s
, STREAM_GET_CONTENT_TYPE
, &res
) )
166 * Create a special stream and a demuxer, this allows chaining demuxers
167 * You must delete it using stream_Delete.
169 VLC_EXPORT( stream_t
*, stream_DemuxNew
, ( demux_t
*p_demux
, const char *psz_demux
, es_out_t
*out
) );
172 * Send data to a stream_t handle created by stream_DemuxNew.
174 VLC_EXPORT( void, stream_DemuxSend
, ( stream_t
*s
, block_t
*p_block
) );
177 * Create a stream_t reading from memory.
178 * You must delete it using stream_Delete.
180 VLC_EXPORT( stream_t
*, stream_MemoryNew
, (vlc_object_t
*p_obj
, uint8_t *p_buffer
, uint64_t i_size
, bool b_preserve_memory
) );
181 #define stream_MemoryNew( a, b, c, d ) stream_MemoryNew( VLC_OBJECT(a), b, c, d )
184 * Create a stream_t reading from a URL.
185 * You must delete it using stream_Delete.
187 VLC_EXPORT( stream_t
*, stream_UrlNew
, (vlc_object_t
*p_this
, const char *psz_url
) );
188 #define stream_UrlNew( a, b ) stream_UrlNew( VLC_OBJECT(a), b )
192 * Try to add a stream filter to an open stream.
193 * @return New stream to use, or NULL if the filter could not be added.
195 VLC_EXPORT( stream_t
*, stream_FilterNew
, ( stream_t
*p_source
, const char *psz_stream_filter
) );