96a2f0e5f7f0da092216976f15a408ae725856ef
[vlc.git] / include / vlc_stream.h
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  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
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.
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 General Public License for more details.
18  *
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  *****************************************************************************/
23
24 #ifndef VLC_STREAM_H
25 #define VLC_STREAM_H 1
26
27 #include <vlc_block.h>
28
29 /**
30  * \file
31  * This file defines structures and functions for stream (between access and demux) descriptor in vlc
32  */
33
34 # ifdef __cplusplus
35 extern "C" {
36 # endif
37
38 /**
39  * \defgroup stream Stream
40  *
41  *  This will allow you to easily handle read/seek in demuxer modules.
42  * @{
43  */
44
45 /* Opaque definition for text reader context */
46 typedef struct stream_text_t stream_text_t;
47
48 /**
49  * stream_t definition
50  */
51
52 struct stream_t
53 {
54     VLC_COMMON_MEMBERS
55
56     /* Module properties for stream filter */
57     module_t    *p_module;
58
59     /* Real or virtual path (it can only be changed during stream_t opening) */
60     char        *psz_path;
61
62     /* Stream source for stream filter */
63     stream_t *p_source;
64
65     /* */
66     int      (*pf_read)   ( stream_t *, void *p_read, unsigned int i_read );
67     int      (*pf_peek)   ( stream_t *, const uint8_t **pp_peek, unsigned int i_peek );
68     int      (*pf_control)( stream_t *, int i_query, va_list );
69
70     /* */
71     void     (*pf_destroy)( stream_t *);
72
73     /* Private data for module */
74     stream_sys_t *p_sys;
75
76     /* Text reader state */
77     stream_text_t *p_text;
78
79     /* Weak link to parent input */
80     input_thread_t *p_input;
81 };
82
83 /**
84  * Possible commands to send to stream_Control() and stream_vaControl()
85  */
86 enum stream_query_e
87 {
88     /* capabilities */
89     STREAM_CAN_SEEK,            /**< arg1= bool *   res=cannot fail*/
90     STREAM_CAN_FASTSEEK,        /**< arg1= bool *   res=cannot fail*/
91
92     /* */
93     STREAM_SET_POSITION,        /**< arg1= int64_t        res=can fail  */
94     STREAM_GET_POSITION,        /**< arg1= int64_t *      res=cannot fail*/
95
96     STREAM_GET_SIZE,            /**< arg1= int64_t *      res=cannot fail (0 if no sense)*/
97
98     /* Special for direct access control from demuxer.
99      * XXX: avoid using it by all means */
100     STREAM_CONTROL_ACCESS,  /* arg1= int i_access_query, args   res: can fail
101                              if access unreachable or access control answer */
102
103     /* You should update size of source if any and then update size 
104      * FIXME find a way to avoid it */
105     STREAM_UPDATE_SIZE,
106
107     /* */
108     STREAM_GET_CONTENT_TYPE,    /**< arg1= char **         res=can fail */
109
110     /* XXX only data read through stream_Read/Block will be recorded */
111     STREAM_SET_RECORD_STATE,     /**< arg1=bool, arg2=const char *psz_ext (if arg1 is true)  res=can fail */
112 };
113
114 VLC_EXPORT( int, stream_Read, ( stream_t *s, void *p_read, int i_read ) );
115 VLC_EXPORT( int, stream_Peek, ( stream_t *s, const uint8_t **pp_peek, int i_peek ) );
116 VLC_EXPORT( int, stream_vaControl, ( stream_t *s, int i_query, va_list args ) );
117 VLC_EXPORT( void, stream_Delete, ( stream_t *s ) );
118 VLC_EXPORT( int, stream_Control, ( stream_t *s, int i_query, ... ) );
119 VLC_EXPORT( block_t *, stream_Block, ( stream_t *s, int i_size ) );
120 VLC_EXPORT( char *, stream_ReadLine, ( stream_t * ) );
121
122 /**
123  * Get the current position in a stream
124  */
125 static inline int64_t stream_Tell( stream_t *s )
126 {
127     int64_t i_pos;
128     stream_Control( s, STREAM_GET_POSITION, &i_pos );
129     return i_pos;
130 }
131
132 /**
133  * Get the size of the stream.
134  */
135 static inline int64_t stream_Size( stream_t *s )
136 {
137     int64_t i_pos;
138     stream_Control( s, STREAM_GET_SIZE, &i_pos );
139     return i_pos;
140 }
141
142 static inline int stream_Seek( stream_t *s, int64_t i_pos )
143 {
144     return stream_Control( s, STREAM_SET_POSITION, i_pos );
145 }
146
147 /**
148  * Get the Content-Type of a stream, or NULL if unknown.
149  * Result must be free()'d.
150  */
151 static inline char *stream_ContentType( stream_t *s )
152 {
153     char *res;
154     if( stream_Control( s, STREAM_GET_CONTENT_TYPE, &res ) )
155         return NULL;
156     return res;
157 }
158
159 /**
160  * Create a special stream and a demuxer, this allows chaining demuxers
161  * You must delete it using stream_Delete.
162  */
163 VLC_EXPORT( stream_t *, stream_DemuxNew, ( demux_t *p_demux, const char *psz_demux, es_out_t *out ) );
164     
165 /**
166  * Send data to a stream_t handle created by stream_DemuxNew.
167  */
168 VLC_EXPORT( void,      stream_DemuxSend,  ( stream_t *s, block_t *p_block ) );
169
170 /**
171  * Create a stream_t reading from memory.
172  * You must delete it using stream_Delete.
173  */
174 #define stream_MemoryNew( a, b, c, d ) __stream_MemoryNew( VLC_OBJECT(a), b, c, d )
175 VLC_EXPORT( stream_t *,__stream_MemoryNew, (vlc_object_t *p_obj, uint8_t *p_buffer, int64_t i_size, bool b_preserve_memory ) );
176
177 /**
178  * Create a stream_t reading from an URL.
179  * You must delete it using stream_Delete.
180  */
181 #define stream_UrlNew( a, b ) __stream_UrlNew( VLC_OBJECT(a), b )
182 VLC_EXPORT( stream_t *,__stream_UrlNew, (vlc_object_t *p_this, const char *psz_url ) );
183
184 /**
185  * @}
186  */
187
188 # ifdef __cplusplus
189 }
190 # endif
191
192 #endif