Mercurial > libavformat.hg
annotate avio.h @ 4491:673107cf7fe6 libavformat
Do not export to the public the first_protocol symbol at the next
major bump.
There is no need for that, since av_protocol_next() already provides
access to the first registered protocol.
author | stefano |
---|---|
date | Sun, 15 Feb 2009 14:34:23 +0000 |
parents | 59e1aa351b77 |
children | dee012239d99 |
rev | line source |
---|---|
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
1 /* |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
2 * unbuffered io for ffmpeg system |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
3 * copyright (c) 2001 Fabrice Bellard |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
4 * |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
5 * This file is part of FFmpeg. |
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
6 * |
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
7 * FFmpeg is free software; you can redistribute it and/or |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
8 * modify it under the terms of the GNU Lesser General Public |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
9 * License as published by the Free Software Foundation; either |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
10 * version 2.1 of the License, or (at your option) any later version. |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
11 * |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
12 * FFmpeg is distributed in the hope that it will be useful, |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
15 * Lesser General Public License for more details. |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
16 * |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
17 * You should have received a copy of the GNU Lesser General Public |
1358
0899bfe4105c
Change license headers to say 'FFmpeg' instead of 'this program/this library'
diego
parents:
1306
diff
changeset
|
18 * License along with FFmpeg; if not, write to the Free Software |
1306
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
8bf9be9bb107
Add official LGPL license headers to the files that were missing them.
diego
parents:
1176
diff
changeset
|
20 */ |
3852 | 21 #ifndef AVFORMAT_AVIO_H |
22 #define AVFORMAT_AVIO_H | |
0 | 23 |
2171 | 24 #include <stdint.h> |
25 | |
0 | 26 /* unbuffered I/O */ |
27 | |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
28 /** |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
29 * URL Context. |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
30 * New fields can be added to the end with minor version bumps. |
2851 | 31 * Removal, reordering and changes to existing fields require a major |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
32 * version bump. |
2851 | 33 * sizeof(URLContext) must not be used outside libav*. |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
34 */ |
0 | 35 struct URLContext { |
3136
e38d5357f0d0
Add AVClass to URLContext at next major version bump
superdump
parents:
2853
diff
changeset
|
36 #if LIBAVFORMAT_VERSION_MAJOR >= 53 |
e38d5357f0d0
Add AVClass to URLContext at next major version bump
superdump
parents:
2853
diff
changeset
|
37 const AVClass *av_class; ///< information for av_log(). Set by url_open(). |
e38d5357f0d0
Add AVClass to URLContext at next major version bump
superdump
parents:
2853
diff
changeset
|
38 #endif |
0 | 39 struct URLProtocol *prot; |
885 | 40 int flags; |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
41 int is_streamed; /**< true if streamed (no seek possible), default = false */ |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
42 int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */ |
0 | 43 void *priv_data; |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
44 char *filename; /**< specified filename */ |
0 | 45 }; |
46 | |
47 typedef struct URLContext URLContext; | |
48 | |
49 typedef struct URLPollEntry { | |
50 URLContext *handle; | |
51 int events; | |
52 int revents; | |
53 } URLPollEntry; | |
54 | |
55 #define URL_RDONLY 0 | |
56 #define URL_WRONLY 1 | |
57 #define URL_RDWR 2 | |
58 | |
177 | 59 typedef int URLInterruptCB(void); |
60 | |
3744
b140b68a3747
Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents:
3198
diff
changeset
|
61 int url_open_protocol (URLContext **puc, struct URLProtocol *up, |
b140b68a3747
Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents:
3198
diff
changeset
|
62 const char *filename, int flags); |
0 | 63 int url_open(URLContext **h, const char *filename, int flags); |
64 int url_read(URLContext *h, unsigned char *buf, int size); | |
65 int url_write(URLContext *h, unsigned char *buf, int size); | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
66 int64_t url_seek(URLContext *h, int64_t pos, int whence); |
0 | 67 int url_close(URLContext *h); |
68 int url_exist(const char *filename); | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
69 int64_t url_filesize(URLContext *h); |
1875
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
70 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
71 /** |
1875
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
72 * Return the maximum packet size associated to packetized file |
2851 | 73 * handle. If the file is not packetized (stream like HTTP or file on |
1875
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
74 * disk), then 0 is returned. |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
75 * |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
76 * @param h file handle |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
77 * @return maximum packet size in bytes |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
78 */ |
0 | 79 int url_get_max_packet_size(URLContext *h); |
19 | 80 void url_get_filename(URLContext *h, char *buf, int buf_size); |
81 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
82 /** |
2851 | 83 * The callback is called in blocking functions to test regulary if |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
84 * asynchronous interruption is needed. AVERROR(EINTR) is returned |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
85 * in this case by the interrupted function. 'NULL' means no interrupt |
2851 | 86 * callback is given. |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
87 */ |
177 | 88 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb); |
89 | |
0 | 90 /* not implemented */ |
91 int url_poll(URLPollEntry *poll_table, int n, int timeout); | |
92 | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
93 /** |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
94 * Pause and resume playing - only meaningful if using a network streaming |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
95 * protocol (e.g. MMS). |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
96 * @param pause 1 for pause, 0 for resume |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
97 */ |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
98 int av_url_read_pause(URLContext *h, int pause); |
2851 | 99 |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
100 /** |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
101 * Seek to a given timestamp relative to some component stream. |
2851 | 102 * Only meaningful if using a network streaming protocol (e.g. MMS.). |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
103 * @param stream_index The stream index that the timestamp is relative to. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
104 * If stream_index is (-1) the timestamp should be in AV_TIME_BASE |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
105 * units from the beginning of the presentation. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
106 * If a stream_index >= 0 is used and the protocol does not support |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
107 * seeking based on component streams, the call will fail with ENOTSUP. |
2852 | 108 * @param timestamp timestamp in AVStream.time_base units |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
109 * or if there is no stream specified then in AV_TIME_BASE units. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
110 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
111 * and AVSEEK_FLAG_ANY. The protocol may silently ignore |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
112 * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
113 * fail with ENOTSUP if used and not supported. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
114 * @return >= 0 on success |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
115 * @see AVInputFormat::read_seek |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
116 */ |
4091 | 117 int64_t av_url_read_seek(URLContext *h, int stream_index, |
118 int64_t timestamp, int flags); | |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
119 |
1614 | 120 /** |
2165 | 121 * Passing this as the "whence" parameter to a seek function causes it to |
122 * return the filesize without seeking anywhere. Supporting this is optional. | |
123 * If it is not supported then the seek function will return <0. | |
1614 | 124 */ |
1612
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
125 #define AVSEEK_SIZE 0x10000 |
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
126 |
0 | 127 typedef struct URLProtocol { |
128 const char *name; | |
129 int (*url_open)(URLContext *h, const char *filename, int flags); | |
130 int (*url_read)(URLContext *h, unsigned char *buf, int size); | |
131 int (*url_write)(URLContext *h, unsigned char *buf, int size); | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
132 int64_t (*url_seek)(URLContext *h, int64_t pos, int whence); |
0 | 133 int (*url_close)(URLContext *h); |
134 struct URLProtocol *next; | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
135 int (*url_read_pause)(URLContext *h, int pause); |
4091 | 136 int64_t (*url_read_seek)(URLContext *h, int stream_index, |
137 int64_t timestamp, int flags); | |
0 | 138 } URLProtocol; |
139 | |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
140 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
0 | 141 extern URLProtocol *first_protocol; |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
142 #endif |
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
143 |
177 | 144 extern URLInterruptCB *url_interrupt_cb; |
0 | 145 |
4490 | 146 /** |
147 * If protocol is NULL, returns the first registered protocol, | |
148 * if protocol is non-NULL, returns the registered protocol next after protocol, | |
149 * or NULL if protocol is the last one. | |
150 */ | |
2812 | 151 URLProtocol *av_protocol_next(URLProtocol *p); |
152 | |
4488
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
153 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
154 /** |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
155 * @deprecated Use av_register_protocol() instead. |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
156 */ |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
157 attribute_deprecated int register_protocol(URLProtocol *protocol); |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
158 #endif |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
159 |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
160 int av_register_protocol(URLProtocol *protocol); |
0 | 161 |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
162 /** |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
163 * Bytestream IO Context. |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
164 * New fields can be added to the end with minor version bumps. |
2851 | 165 * Removal, reordering and changes to existing fields require a major |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
166 * version bump. |
2851 | 167 * sizeof(ByteIOContext) must not be used outside libav*. |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
168 */ |
0 | 169 typedef struct { |
170 unsigned char *buffer; | |
171 int buffer_size; | |
172 unsigned char *buf_ptr, *buf_end; | |
173 void *opaque; | |
65 | 174 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); |
554 | 175 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size); |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
176 int64_t (*seek)(void *opaque, int64_t offset, int whence); |
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
177 int64_t pos; /**< position in the file of the current buffer */ |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
178 int must_flush; /**< true if the next seek should flush */ |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
179 int eof_reached; /**< true if eof reached */ |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
180 int write_flag; /**< true if open for writing */ |
0 | 181 int is_streamed; |
182 int max_packet_size; | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
183 unsigned long checksum; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
184 unsigned char *checksum_ptr; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
185 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size); |
554 | 186 int error; ///< contains the error code or 0 if no error happened |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
187 int (*read_pause)(void *opaque, int pause); |
4091 | 188 int64_t (*read_seek)(void *opaque, int stream_index, |
189 int64_t timestamp, int flags); | |
0 | 190 } ByteIOContext; |
191 | |
192 int init_put_byte(ByteIOContext *s, | |
193 unsigned char *buffer, | |
194 int buffer_size, | |
195 int write_flag, | |
196 void *opaque, | |
65 | 197 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), |
554 | 198 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size), |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
199 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
2853 | 200 ByteIOContext *av_alloc_put_byte( |
201 unsigned char *buffer, | |
202 int buffer_size, | |
203 int write_flag, | |
204 void *opaque, | |
205 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), | |
206 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size), | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
207 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
0 | 208 |
209 void put_byte(ByteIOContext *s, int b); | |
210 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size); | |
65 | 211 void put_le64(ByteIOContext *s, uint64_t val); |
212 void put_be64(ByteIOContext *s, uint64_t val); | |
0 | 213 void put_le32(ByteIOContext *s, unsigned int val); |
214 void put_be32(ByteIOContext *s, unsigned int val); | |
937 | 215 void put_le24(ByteIOContext *s, unsigned int val); |
822 | 216 void put_be24(ByteIOContext *s, unsigned int val); |
0 | 217 void put_le16(ByteIOContext *s, unsigned int val); |
218 void put_be16(ByteIOContext *s, unsigned int val); | |
219 void put_tag(ByteIOContext *s, const char *tag); | |
220 | |
221 void put_strz(ByteIOContext *s, const char *buf); | |
222 | |
3168 | 223 /** |
224 * fseek() equivalent for ByteIOContext. | |
225 * @return new position or AVERROR. | |
226 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
227 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence); |
3168 | 228 |
229 /** | |
230 * Skip given number of bytes forward. | |
231 * @param offset number of bytes | |
232 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
233 void url_fskip(ByteIOContext *s, int64_t offset); |
3168 | 234 |
235 /** | |
236 * ftell() equivalent for ByteIOContext. | |
237 * @return position or AVERROR. | |
238 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
239 int64_t url_ftell(ByteIOContext *s); |
3168 | 240 |
241 /** | |
242 * Gets the filesize. | |
243 * @return filesize or AVERROR | |
244 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
245 int64_t url_fsize(ByteIOContext *s); |
3168 | 246 |
247 /** | |
248 * feof() equivalent for ByteIOContext. | |
249 * @return non zero if and only if end of file | |
250 */ | |
0 | 251 int url_feof(ByteIOContext *s); |
3168 | 252 |
554 | 253 int url_ferror(ByteIOContext *s); |
0 | 254 |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
255 int av_url_read_fpause(ByteIOContext *h, int pause); |
4091 | 256 int64_t av_url_read_fseek(ByteIOContext *h, int stream_index, |
257 int64_t timestamp, int flags); | |
2783
1a9db30c1d1c
Extend ByteIOContext and add the buffered IO functions:
andoma
parents:
2778
diff
changeset
|
258 |
0 | 259 #define URL_EOF (-1) |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
260 /** @note return URL_EOF (-1) if EOF */ |
0 | 261 int url_fgetc(ByteIOContext *s); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
262 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
263 /** @warning currently size is limited */ |
206
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
264 #ifdef __GNUC__ |
265
786e8286ea4a
Patch for attribute(printf) by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michaelni
parents:
206
diff
changeset
|
265 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3))); |
206
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
266 #else |
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
267 int url_fprintf(ByteIOContext *s, const char *fmt, ...); |
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
268 #endif |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
269 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
270 /** @note unlike fgets, the EOL character is not returned and a whole |
4091 | 271 line is parsed. return NULL if first char read was EOF */ |
0 | 272 char *url_fgets(ByteIOContext *s, char *buf, int buf_size); |
273 | |
274 void put_flush_packet(ByteIOContext *s); | |
275 | |
3174 | 276 |
277 /** | |
278 * Reads size bytes from ByteIOContext into buf. | |
279 * @returns number of bytes read or AVERROR | |
280 */ | |
0 | 281 int get_buffer(ByteIOContext *s, unsigned char *buf, int size); |
3174 | 282 |
283 /** | |
284 * Reads size bytes from ByteIOContext into buf. | |
3198 | 285 * This reads at most 1 packet. If that is not enough fewer bytes will be |
3174 | 286 * returned. |
287 * @returns number of bytes read or AVERROR | |
288 */ | |
389
e14fcd57ad2f
decode latency patch by (Leon van Stuivenberg <l dot vanstuivenberg at chello dot nl>)
michael
parents:
265
diff
changeset
|
289 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
290 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
291 /** @note return 0 if EOF, so you cannot use it if EOF handling is |
4091 | 292 necessary */ |
0 | 293 int get_byte(ByteIOContext *s); |
937 | 294 unsigned int get_le24(ByteIOContext *s); |
0 | 295 unsigned int get_le32(ByteIOContext *s); |
65 | 296 uint64_t get_le64(ByteIOContext *s); |
0 | 297 unsigned int get_le16(ByteIOContext *s); |
298 | |
299 char *get_strz(ByteIOContext *s, char *buf, int maxlen); | |
300 unsigned int get_be16(ByteIOContext *s); | |
822 | 301 unsigned int get_be24(ByteIOContext *s); |
0 | 302 unsigned int get_be32(ByteIOContext *s); |
65 | 303 uint64_t get_be64(ByteIOContext *s); |
0 | 304 |
2700 | 305 uint64_t ff_get_v(ByteIOContext *bc); |
2699 | 306 |
0 | 307 static inline int url_is_streamed(ByteIOContext *s) |
308 { | |
309 return s->is_streamed; | |
310 } | |
311 | |
2582 | 312 /** @note when opened as read/write, the buffers are only used for |
4091 | 313 writing */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
314 int url_fdopen(ByteIOContext **s, URLContext *h); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
315 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
316 /** @warning must be called before any I/O */ |
0 | 317 int url_setbufsize(ByteIOContext *s, int buf_size); |
2598
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
318 /** Reset the buffer for reading or writing. |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
319 * @note Will drop any data currently in the buffer without transmitting it. |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
320 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
321 * to set up the buffer for writing. */ |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
322 int url_resetbuf(ByteIOContext *s, int flags); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
323 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
324 /** @note when opened as read/write, the buffers are only used for |
4091 | 325 writing */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
326 int url_fopen(ByteIOContext **s, const char *filename, int flags); |
0 | 327 int url_fclose(ByteIOContext *s); |
328 URLContext *url_fileno(ByteIOContext *s); | |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
329 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
330 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
331 * Return the maximum packet size associated to packetized buffered file |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
332 * handle. If the file is not packetized (stream like http or file on |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
333 * disk), then 0 is returned. |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
334 * |
2747 | 335 * @param s buffered file handle |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
336 * @return maximum packet size in bytes |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
337 */ |
0 | 338 int url_fget_max_packet_size(ByteIOContext *s); |
339 | |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
340 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
341 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
342 /** return the written or read size */ |
0 | 343 int url_close_buf(ByteIOContext *s); |
344 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
345 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
346 * Open a write only memory stream. |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
347 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
348 * @param s new IO context |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
349 * @return zero if no error. |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
350 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
351 int url_open_dyn_buf(ByteIOContext **s); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
352 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
353 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
354 * Open a write only packetized memory stream with a maximum packet |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
355 * size of 'max_packet_size'. The stream is stored in a memory buffer |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
356 * with a big endian 4 byte header giving the packet size in bytes. |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
357 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
358 * @param s new IO context |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
359 * @param max_packet_size maximum packet size (must be > 0) |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
360 * @return zero if no error. |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
361 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
362 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size); |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
363 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
364 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
365 * Return the written size and a pointer to the buffer. The buffer |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
366 * must be freed with av_free(). |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
367 * @param s IO context |
2748 | 368 * @param pbuffer pointer to a byte buffer |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
369 * @return the length of the byte buffer |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
370 */ |
65 | 371 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer); |
0 | 372 |
4091 | 373 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, |
374 unsigned int len); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
375 unsigned long get_checksum(ByteIOContext *s); |
4091 | 376 void init_checksum(ByteIOContext *s, |
377 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), | |
378 unsigned long checksum); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
379 |
0 | 380 /* udp.c */ |
381 int udp_set_remote_url(URLContext *h, const char *uri); | |
382 int udp_get_local_port(URLContext *h); | |
383 int udp_get_file_handle(URLContext *h); | |
384 | |
3852 | 385 #endif /* AVFORMAT_AVIO_H */ |