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