Mercurial > libavformat.hg
annotate avio.h @ 5585:333f55aab3a2 libavformat
Favor the term "URL" over "filename", as the API deals with URLs
rather than with simple filenames.
author | stefano |
---|---|
date | Sun, 24 Jan 2010 18:18:03 +0000 |
parents | b862bba5a321 |
children | 0ab98b4a3778 |
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 | |
4595 | 26 * |
27 * @warning This file has to be considered an internal but installed | |
28 * header, so it should not be directly included in your projects. | |
4594 | 29 */ |
30 | |
2171 | 31 #include <stdint.h> |
32 | |
4524 | 33 #include "libavutil/common.h" |
34 | |
0 | 35 /* unbuffered I/O */ |
36 | |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
37 /** |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
38 * URL Context. |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
39 * New fields can be added to the end with minor version bumps. |
2851 | 40 * Removal, reordering and changes to existing fields require a major |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
41 * version bump. |
2851 | 42 * sizeof(URLContext) must not be used outside libav*. |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
43 */ |
4959
089a36c3c0db
Define struct URLContext and typedef it to URLContext in one step.
stefano
parents:
4640
diff
changeset
|
44 typedef struct URLContext { |
3136
e38d5357f0d0
Add AVClass to URLContext at next major version bump
superdump
parents:
2853
diff
changeset
|
45 #if LIBAVFORMAT_VERSION_MAJOR >= 53 |
e38d5357f0d0
Add AVClass to URLContext at next major version bump
superdump
parents:
2853
diff
changeset
|
46 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
|
47 #endif |
0 | 48 struct URLProtocol *prot; |
885 | 49 int flags; |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
50 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
|
51 int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */ |
0 | 52 void *priv_data; |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
53 char *filename; /**< specified URL */ |
4959
089a36c3c0db
Define struct URLContext and typedef it to URLContext in one step.
stefano
parents:
4640
diff
changeset
|
54 } URLContext; |
0 | 55 |
56 typedef struct URLPollEntry { | |
57 URLContext *handle; | |
58 int events; | |
59 int revents; | |
60 } URLPollEntry; | |
61 | |
62 #define URL_RDONLY 0 | |
63 #define URL_WRONLY 1 | |
64 #define URL_RDWR 2 | |
65 | |
177 | 66 typedef int URLInterruptCB(void); |
67 | |
5582 | 68 /** |
69 * Creates an URLContext for accessing to the resource indicated by | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
70 * url, and opens it using the URLProtocol up. |
5582 | 71 * |
72 * @param puc pointer to the location where, in case of success, the | |
73 * function puts the pointer to the created URLContext | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
74 * @param flags flags which control how the resource indicated by url |
5582 | 75 * is to be opened |
76 * @return 0 in case of success, a negative value corresponding to an | |
77 * AVERROR code in case of failure | |
78 */ | |
3744
b140b68a3747
Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents:
3198
diff
changeset
|
79 int url_open_protocol (URLContext **puc, struct URLProtocol *up, |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
80 const char *url, int flags); |
5582 | 81 |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
82 int url_open(URLContext **h, const char *url, int flags); |
5581 | 83 |
84 /** | |
85 * Reads up to size bytes from the resource accessed by h, and stores | |
86 * the read bytes in buf. | |
87 * | |
88 * @return The number of bytes actually read, or a negative value | |
89 * corresponding to an AVERROR code in case of error. A value of zero | |
90 * indicates that it is not possible to read more from the accessed | |
91 * resource (except if the value of the size argument is also zero). | |
92 */ | |
0 | 93 int url_read(URLContext *h, unsigned char *buf, int size); |
5581 | 94 |
5580
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
95 /** |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
96 * Read as many bytes as possible (up to size), calling the |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
97 * read function multiple times if necessary. |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
98 * Will also retry if the read function returns AVERROR(EAGAIN). |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
99 * This makes special short-read handling in applications |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
100 * unnecessary, if the return value is < size then it is |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
101 * certain there was either an error or the end of file was reached. |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
102 */ |
5004
84a7b7a2f252
Move function for reading whole specified amount of data from RTSP
kostya
parents:
4959
diff
changeset
|
103 int url_read_complete(URLContext *h, unsigned char *buf, int size); |
0 | 104 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
|
105 int64_t url_seek(URLContext *h, int64_t pos, int whence); |
5583 | 106 |
107 /** | |
108 * Closes the resource accessed by the URLContext h, and frees the | |
109 * memory used by it. | |
110 * | |
111 * @return a negative value if an error condition occurred, 0 | |
112 * otherwise | |
113 */ | |
0 | 114 int url_close(URLContext *h); |
5583 | 115 |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
116 int url_exist(const char *url); |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
117 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
|
118 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
119 /** |
4640
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
120 * Return the file descriptor associated with this URL. For RTP, this |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
121 * will return only the RTP file descriptor, not the RTCP file descriptor. |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
122 * To get both, use rtp_get_file_handles(). |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
123 * |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
124 * @return the file descriptor associated with this URL, or <0 on error. |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
125 */ |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
126 int url_get_file_handle(URLContext *h); |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
127 |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
128 /** |
1875
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
129 * Return the maximum packet size associated to packetized file |
2851 | 130 * 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
|
131 * 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
|
132 * |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
133 * @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
|
134 * @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
|
135 */ |
0 | 136 int url_get_max_packet_size(URLContext *h); |
19 | 137 void url_get_filename(URLContext *h, char *buf, int buf_size); |
138 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
139 /** |
2851 | 140 * 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
|
141 * 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
|
142 * in this case by the interrupted function. 'NULL' means no interrupt |
2851 | 143 * callback is given. |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
144 */ |
177 | 145 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb); |
146 | |
0 | 147 /* not implemented */ |
148 int url_poll(URLPollEntry *poll_table, int n, int timeout); | |
149 | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
150 /** |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
151 * 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
|
152 * protocol (e.g. MMS). |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
153 * @param pause 1 for pause, 0 for resume |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
154 */ |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
155 int av_url_read_pause(URLContext *h, int pause); |
2851 | 156 |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
157 /** |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
158 * Seek to a given timestamp relative to some component stream. |
2851 | 159 * 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
|
160 * @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
|
161 * 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
|
162 * units from the beginning of the presentation. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
163 * 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
|
164 * seeking based on component streams, the call will fail with ENOTSUP. |
2852 | 165 * @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
|
166 * 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
|
167 * @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
|
168 * 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
|
169 * 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
|
170 * fail with ENOTSUP if used and not supported. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
171 * @return >= 0 on success |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
172 * @see AVInputFormat::read_seek |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
173 */ |
4091 | 174 int64_t av_url_read_seek(URLContext *h, int stream_index, |
175 int64_t timestamp, int flags); | |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
176 |
1614 | 177 /** |
2165 | 178 * Passing this as the "whence" parameter to a seek function causes it to |
179 * return the filesize without seeking anywhere. Supporting this is optional. | |
180 * If it is not supported then the seek function will return <0. | |
1614 | 181 */ |
1612
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
182 #define AVSEEK_SIZE 0x10000 |
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
183 |
0 | 184 typedef struct URLProtocol { |
185 const char *name; | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
186 int (*url_open)(URLContext *h, const char *url, int flags); |
0 | 187 int (*url_read)(URLContext *h, unsigned char *buf, int size); |
188 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
|
189 int64_t (*url_seek)(URLContext *h, int64_t pos, int whence); |
0 | 190 int (*url_close)(URLContext *h); |
191 struct URLProtocol *next; | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
192 int (*url_read_pause)(URLContext *h, int pause); |
4091 | 193 int64_t (*url_read_seek)(URLContext *h, int stream_index, |
194 int64_t timestamp, int flags); | |
4640
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
195 int (*url_get_file_handle)(URLContext *h); |
0 | 196 } URLProtocol; |
197 | |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
198 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
0 | 199 extern URLProtocol *first_protocol; |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
200 #endif |
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
201 |
177 | 202 extern URLInterruptCB *url_interrupt_cb; |
0 | 203 |
4490 | 204 /** |
205 * 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
|
206 * if protocol is non-NULL, returns the next registered protocol after protocol, |
4490 | 207 * or NULL if protocol is the last one. |
208 */ | |
2812 | 209 URLProtocol *av_protocol_next(URLProtocol *p); |
210 | |
4488
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
211 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
212 /** |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
213 * @deprecated Use av_register_protocol() instead. |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
214 */ |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
215 attribute_deprecated int register_protocol(URLProtocol *protocol); |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
216 #endif |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
217 |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
218 int av_register_protocol(URLProtocol *protocol); |
0 | 219 |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
220 /** |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
221 * Bytestream IO Context. |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
222 * New fields can be added to the end with minor version bumps. |
2851 | 223 * Removal, reordering and changes to existing fields require a major |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
224 * version bump. |
2851 | 225 * sizeof(ByteIOContext) must not be used outside libav*. |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
226 */ |
0 | 227 typedef struct { |
228 unsigned char *buffer; | |
229 int buffer_size; | |
230 unsigned char *buf_ptr, *buf_end; | |
231 void *opaque; | |
65 | 232 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); |
554 | 233 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
|
234 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
|
235 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
|
236 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
|
237 int eof_reached; /**< true if eof reached */ |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
238 int write_flag; /**< true if open for writing */ |
0 | 239 int is_streamed; |
240 int max_packet_size; | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
241 unsigned long checksum; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
242 unsigned char *checksum_ptr; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
243 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size); |
554 | 244 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
|
245 int (*read_pause)(void *opaque, int pause); |
4091 | 246 int64_t (*read_seek)(void *opaque, int stream_index, |
247 int64_t timestamp, int flags); | |
0 | 248 } ByteIOContext; |
249 | |
250 int init_put_byte(ByteIOContext *s, | |
251 unsigned char *buffer, | |
252 int buffer_size, | |
253 int write_flag, | |
254 void *opaque, | |
65 | 255 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), |
554 | 256 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
|
257 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
2853 | 258 ByteIOContext *av_alloc_put_byte( |
259 unsigned char *buffer, | |
260 int buffer_size, | |
261 int write_flag, | |
262 void *opaque, | |
263 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), | |
264 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
|
265 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
0 | 266 |
267 void put_byte(ByteIOContext *s, int b); | |
268 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size); | |
65 | 269 void put_le64(ByteIOContext *s, uint64_t val); |
270 void put_be64(ByteIOContext *s, uint64_t val); | |
0 | 271 void put_le32(ByteIOContext *s, unsigned int val); |
272 void put_be32(ByteIOContext *s, unsigned int val); | |
937 | 273 void put_le24(ByteIOContext *s, unsigned int val); |
822 | 274 void put_be24(ByteIOContext *s, unsigned int val); |
0 | 275 void put_le16(ByteIOContext *s, unsigned int val); |
276 void put_be16(ByteIOContext *s, unsigned int val); | |
277 void put_tag(ByteIOContext *s, const char *tag); | |
278 | |
279 void put_strz(ByteIOContext *s, const char *buf); | |
280 | |
3168 | 281 /** |
282 * fseek() equivalent for ByteIOContext. | |
283 * @return new position or AVERROR. | |
284 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
285 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence); |
3168 | 286 |
287 /** | |
288 * Skip given number of bytes forward. | |
289 * @param offset number of bytes | |
290 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
291 void url_fskip(ByteIOContext *s, int64_t offset); |
3168 | 292 |
293 /** | |
294 * ftell() equivalent for ByteIOContext. | |
295 * @return position or AVERROR. | |
296 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
297 int64_t url_ftell(ByteIOContext *s); |
3168 | 298 |
299 /** | |
300 * Gets the filesize. | |
301 * @return filesize or AVERROR | |
302 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
303 int64_t url_fsize(ByteIOContext *s); |
3168 | 304 |
305 /** | |
306 * feof() equivalent for ByteIOContext. | |
307 * @return non zero if and only if end of file | |
308 */ | |
0 | 309 int url_feof(ByteIOContext *s); |
3168 | 310 |
554 | 311 int url_ferror(ByteIOContext *s); |
0 | 312 |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
313 int av_url_read_fpause(ByteIOContext *h, int pause); |
4091 | 314 int64_t av_url_read_fseek(ByteIOContext *h, int stream_index, |
315 int64_t timestamp, int flags); | |
2783
1a9db30c1d1c
Extend ByteIOContext and add the buffered IO functions:
andoma
parents:
2778
diff
changeset
|
316 |
0 | 317 #define URL_EOF (-1) |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
318 /** @note return URL_EOF (-1) if EOF */ |
0 | 319 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
|
320 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
321 /** @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
|
322 #ifdef __GNUC__ |
265
786e8286ea4a
Patch for attribute(printf) by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michaelni
parents:
206
diff
changeset
|
323 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
|
324 #else |
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
325 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
|
326 #endif |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
327 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
328 /** @note unlike fgets, the EOL character is not returned and a whole |
4091 | 329 line is parsed. return NULL if first char read was EOF */ |
0 | 330 char *url_fgets(ByteIOContext *s, char *buf, int buf_size); |
331 | |
332 void put_flush_packet(ByteIOContext *s); | |
333 | |
3174 | 334 |
335 /** | |
336 * Reads size bytes from ByteIOContext into buf. | |
337 * @returns number of bytes read or AVERROR | |
338 */ | |
0 | 339 int get_buffer(ByteIOContext *s, unsigned char *buf, int size); |
3174 | 340 |
341 /** | |
342 * Reads size bytes from ByteIOContext into buf. | |
3198 | 343 * This reads at most 1 packet. If that is not enough fewer bytes will be |
3174 | 344 * returned. |
345 * @returns number of bytes read or AVERROR | |
346 */ | |
389
e14fcd57ad2f
decode latency patch by (Leon van Stuivenberg <l dot vanstuivenberg at chello dot nl>)
michael
parents:
265
diff
changeset
|
347 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
|
348 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
349 /** @note return 0 if EOF, so you cannot use it if EOF handling is |
4091 | 350 necessary */ |
0 | 351 int get_byte(ByteIOContext *s); |
937 | 352 unsigned int get_le24(ByteIOContext *s); |
0 | 353 unsigned int get_le32(ByteIOContext *s); |
65 | 354 uint64_t get_le64(ByteIOContext *s); |
0 | 355 unsigned int get_le16(ByteIOContext *s); |
356 | |
357 char *get_strz(ByteIOContext *s, char *buf, int maxlen); | |
358 unsigned int get_be16(ByteIOContext *s); | |
822 | 359 unsigned int get_be24(ByteIOContext *s); |
0 | 360 unsigned int get_be32(ByteIOContext *s); |
65 | 361 uint64_t get_be64(ByteIOContext *s); |
0 | 362 |
2700 | 363 uint64_t ff_get_v(ByteIOContext *bc); |
2699 | 364 |
0 | 365 static inline int url_is_streamed(ByteIOContext *s) |
366 { | |
367 return s->is_streamed; | |
368 } | |
369 | |
2582 | 370 /** @note when opened as read/write, the buffers are only used for |
4091 | 371 writing */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
372 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
|
373 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
374 /** @warning must be called before any I/O */ |
0 | 375 int url_setbufsize(ByteIOContext *s, int buf_size); |
5320
db1e4c61789a
Make url_resetbuf() assert on wrong flags passed and make it static on next
benoit
parents:
5004
diff
changeset
|
376 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
2598
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
377 /** Reset the buffer for reading or writing. |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
378 * @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
|
379 * @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
|
380 * to set up the buffer for writing. */ |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
381 int url_resetbuf(ByteIOContext *s, int flags); |
5320
db1e4c61789a
Make url_resetbuf() assert on wrong flags passed and make it static on next
benoit
parents:
5004
diff
changeset
|
382 #endif |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
383 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
384 /** @note when opened as read/write, the buffers are only used for |
4091 | 385 writing */ |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
386 int url_fopen(ByteIOContext **s, const char *url, int flags); |
0 | 387 int url_fclose(ByteIOContext *s); |
388 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
|
389 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
390 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
391 * 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
|
392 * 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
|
393 * 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
|
394 * |
2747 | 395 * @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
|
396 * @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
|
397 */ |
0 | 398 int url_fget_max_packet_size(ByteIOContext *s); |
399 | |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
400 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
|
401 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
402 /** return the written or read size */ |
0 | 403 int url_close_buf(ByteIOContext *s); |
404 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
405 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
406 * 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
|
407 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
408 * @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
|
409 * @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
|
410 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
411 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
|
412 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
413 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
414 * 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
|
415 * 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
|
416 * 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
|
417 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
418 * @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
|
419 * @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
|
420 * @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
|
421 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
422 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
|
423 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
424 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
425 * 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
|
426 * 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
|
427 * @param s IO context |
2748 | 428 * @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
|
429 * @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
|
430 */ |
65 | 431 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer); |
0 | 432 |
4091 | 433 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, |
434 unsigned int len); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
435 unsigned long get_checksum(ByteIOContext *s); |
4091 | 436 void init_checksum(ByteIOContext *s, |
437 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), | |
438 unsigned long checksum); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
439 |
0 | 440 /* udp.c */ |
441 int udp_set_remote_url(URLContext *h, const char *uri); | |
442 int udp_get_local_port(URLContext *h); | |
4640
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
443 #if (LIBAVFORMAT_VERSION_MAJOR <= 52) |
0 | 444 int udp_get_file_handle(URLContext *h); |
4640
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
445 #endif |
0 | 446 |
3852 | 447 #endif /* AVFORMAT_AVIO_H */ |