Mercurial > libavformat.hg
annotate avio.h @ 6160:1b4be334ef89 libavformat
Split url_open and url_open_protocol into url_alloc and url_connect
author | mstorsjo |
---|---|
date | Tue, 22 Jun 2010 14:03:37 +0000 |
parents | 3fcaee5cf416 |
children | f7090c70ed34 |
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 /** |
5969
178de7695c6c
Remove explicit filename from Doxygen @file commands.
diego
parents:
5941
diff
changeset
|
24 * @file |
4594 | 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 */ |
6160
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
54 int is_connected; |
4959
089a36c3c0db
Define struct URLContext and typedef it to URLContext in one step.
stefano
parents:
4640
diff
changeset
|
55 } URLContext; |
0 | 56 |
57 typedef struct URLPollEntry { | |
58 URLContext *handle; | |
59 int events; | |
60 int revents; | |
61 } URLPollEntry; | |
62 | |
63 #define URL_RDONLY 0 | |
64 #define URL_WRONLY 1 | |
65 #define URL_RDWR 2 | |
66 | |
177 | 67 typedef int URLInterruptCB(void); |
68 | |
5582 | 69 /** |
70 * 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
|
71 * url, and opens it using the URLProtocol up. |
5582 | 72 * |
73 * @param puc pointer to the location where, in case of success, the | |
74 * 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
|
75 * @param flags flags which control how the resource indicated by url |
5582 | 76 * is to be opened |
77 * @return 0 in case of success, a negative value corresponding to an | |
78 * AVERROR code in case of failure | |
79 */ | |
3744
b140b68a3747
Implement url_open_protocol(), which is basiclly the former url_open()
rbultje
parents:
3198
diff
changeset
|
80 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
|
81 const char *url, int flags); |
5582 | 82 |
5587 | 83 /** |
84 * Creates an URLContext for accessing to the resource indicated by | |
6160
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
85 * url, but doesn't initiate the connection yet. |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
86 * |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
87 * @param puc pointer to the location where, in case of success, the |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
88 * function puts the pointer to the created URLContext |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
89 * @param flags flags which control how the resource indicated by url |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
90 * is to be opened |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
91 * @return 0 in case of success, a negative value corresponding to an |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
92 * AVERROR code in case of failure |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
93 */ |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
94 int url_alloc(URLContext **h, const char *url, int flags); |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
95 |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
96 /** |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
97 * Connect an URLContext that has been allocated by url_alloc |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
98 */ |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
99 int url_connect(URLContext *h); |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
100 |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
101 /** |
1b4be334ef89
Split url_open and url_open_protocol into url_alloc and url_connect
mstorsjo
parents:
6159
diff
changeset
|
102 * Creates an URLContext for accessing to the resource indicated by |
5587 | 103 * url, and opens it. |
104 * | |
105 * @param puc pointer to the location where, in case of success, the | |
106 * function puts the pointer to the created URLContext | |
107 * @param flags flags which control how the resource indicated by url | |
108 * is to be opened | |
109 * @return 0 in case of success, a negative value corresponding to an | |
110 * AVERROR code in case of failure | |
111 */ | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
112 int url_open(URLContext **h, const char *url, int flags); |
5581 | 113 |
114 /** | |
115 * Reads up to size bytes from the resource accessed by h, and stores | |
116 * the read bytes in buf. | |
117 * | |
118 * @return The number of bytes actually read, or a negative value | |
119 * corresponding to an AVERROR code in case of error. A value of zero | |
120 * indicates that it is not possible to read more from the accessed | |
121 * resource (except if the value of the size argument is also zero). | |
122 */ | |
0 | 123 int url_read(URLContext *h, unsigned char *buf, int size); |
5581 | 124 |
5580
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
125 /** |
07ce73fed19f
Make url_read_complete retry on EAGAIN and return how much data it read
reimar
parents:
5320
diff
changeset
|
126 * 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
|
127 * 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
|
128 * 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
|
129 * 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
|
130 * 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
|
131 * 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
|
132 */ |
5004
84a7b7a2f252
Move function for reading whole specified amount of data from RTSP
kostya
parents:
4959
diff
changeset
|
133 int url_read_complete(URLContext *h, unsigned char *buf, int size); |
6068 | 134 int url_write(URLContext *h, const unsigned char *buf, int size); |
5903 | 135 |
136 /** | |
137 * Changes the position that will be used by the next read/write | |
138 * operation on the resource accessed by h. | |
139 * | |
140 * @param pos specifies the new position to set | |
141 * @param whence specifies how pos should be interpreted, it must be | |
142 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the | |
143 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE | |
144 * (return the filesize of the requested resource, pos is ignored). | |
145 * @return a negative value corresponding to an AVERROR code in case | |
146 * of failure, or the resulting file position, measured in bytes from | |
147 * the beginning of the file. You can use this feature together with | |
148 * SEEK_CUR to read the current file position. | |
149 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
150 int64_t url_seek(URLContext *h, int64_t pos, int whence); |
5583 | 151 |
152 /** | |
153 * Closes the resource accessed by the URLContext h, and frees the | |
154 * memory used by it. | |
155 * | |
156 * @return a negative value if an error condition occurred, 0 | |
157 * otherwise | |
158 */ | |
0 | 159 int url_close(URLContext *h); |
5583 | 160 |
5908 | 161 /** |
162 * Returns a non-zero value if the resource indicated by url | |
163 * exists, 0 otherwise. | |
164 */ | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
165 int url_exist(const char *url); |
5908 | 166 |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
167 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
|
168 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
169 /** |
4640
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
170 * 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
|
171 * 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
|
172 * 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
|
173 * |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
174 * @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
|
175 */ |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
176 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
|
177 |
b34d9614b887
Add url_get_file_handle(), which is used to get the file descriptor
rbultje
parents:
4595
diff
changeset
|
178 /** |
1875
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
179 * Return the maximum packet size associated to packetized file |
2851 | 180 * 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
|
181 * 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
|
182 * |
84ed710a9adc
Move avio.h's url_get_max_packet_size() comment from source to header file.
takis
parents:
1874
diff
changeset
|
183 * @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
|
184 * @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
|
185 */ |
0 | 186 int url_get_max_packet_size(URLContext *h); |
19 | 187 void url_get_filename(URLContext *h, char *buf, int buf_size); |
188 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
189 /** |
2851 | 190 * 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
|
191 * 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
|
192 * in this case by the interrupted function. 'NULL' means no interrupt |
2851 | 193 * callback is given. |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
194 */ |
177 | 195 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb); |
196 | |
0 | 197 /* not implemented */ |
198 int url_poll(URLPollEntry *poll_table, int n, int timeout); | |
199 | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
200 /** |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
201 * 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
|
202 * protocol (e.g. MMS). |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
203 * @param pause 1 for pause, 0 for resume |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
204 */ |
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
205 int av_url_read_pause(URLContext *h, int pause); |
2851 | 206 |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
207 /** |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
208 * Seek to a given timestamp relative to some component stream. |
2851 | 209 * 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
|
210 * @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
|
211 * 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
|
212 * units from the beginning of the presentation. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
213 * 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
|
214 * seeking based on component streams, the call will fail with ENOTSUP. |
2852 | 215 * @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
|
216 * 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
|
217 * @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
|
218 * 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
|
219 * 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
|
220 * fail with ENOTSUP if used and not supported. |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
221 * @return >= 0 on success |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
222 * @see AVInputFormat::read_seek |
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
223 */ |
4091 | 224 int64_t av_url_read_seek(URLContext *h, int stream_index, |
225 int64_t timestamp, int flags); | |
2778
50e2307414ee
Extend URLProtocol with new function pointers and api functions for
andoma
parents:
2771
diff
changeset
|
226 |
1614 | 227 /** |
2165 | 228 * Passing this as the "whence" parameter to a seek function causes it to |
229 * return the filesize without seeking anywhere. Supporting this is optional. | |
230 * If it is not supported then the seek function will return <0. | |
1614 | 231 */ |
1612
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
232 #define AVSEEK_SIZE 0x10000 |
a6eaa0762191
seekless filesize retrieving support in 7 lines of code, also doesnt break compatibility
michael
parents:
1358
diff
changeset
|
233 |
5850
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
234 /** |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
235 * Oring this flag as into the "whence" parameter to a seek function causes it to |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
236 * seek by any means (like reopening and linear reading) or other normally unreasonble |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
237 * means that can be extreemly slow. |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
238 * This may be ignored by the seek code. |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
239 */ |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
240 #define AVSEEK_FORCE 0x20000 |
a9a36b4f83a2
Add AVSEEK_FORCE flag to indicate that the code should attempt to seek
michael
parents:
5640
diff
changeset
|
241 |
0 | 242 typedef struct URLProtocol { |
243 const char *name; | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
244 int (*url_open)(URLContext *h, const char *url, int flags); |
0 | 245 int (*url_read)(URLContext *h, unsigned char *buf, int size); |
6068 | 246 int (*url_write)(URLContext *h, const unsigned char *buf, int size); |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
247 int64_t (*url_seek)(URLContext *h, int64_t pos, int whence); |
0 | 248 int (*url_close)(URLContext *h); |
249 struct URLProtocol *next; | |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
250 int (*url_read_pause)(URLContext *h, int pause); |
4091 | 251 int64_t (*url_read_seek)(URLContext *h, int stream_index, |
252 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
|
253 int (*url_get_file_handle)(URLContext *h); |
0 | 254 } URLProtocol; |
255 | |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
256 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
0 | 257 extern URLProtocol *first_protocol; |
4491
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
258 #endif |
673107cf7fe6
Do not export to the public the first_protocol symbol at the next
stefano
parents:
4490
diff
changeset
|
259 |
177 | 260 extern URLInterruptCB *url_interrupt_cb; |
0 | 261 |
4490 | 262 /** |
263 * 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
|
264 * if protocol is non-NULL, returns the next registered protocol after protocol, |
4490 | 265 * or NULL if protocol is the last one. |
266 */ | |
2812 | 267 URLProtocol *av_protocol_next(URLProtocol *p); |
268 | |
4488
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
269 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
270 /** |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
271 * @deprecated Use av_register_protocol() instead. |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
272 */ |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
273 attribute_deprecated int register_protocol(URLProtocol *protocol); |
6159
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
274 |
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
275 /** |
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
276 * @deprecated Use av_register_protocol2() instead. |
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
277 */ |
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
278 attribute_deprecated int av_register_protocol(URLProtocol *protocol); |
4488
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
279 #endif |
724c0f6a52dc
Rename register_protocol() to av_register_protocol() and deprecate
stefano
parents:
4091
diff
changeset
|
280 |
5590
da4b8a105fd3
Document av_register_protocol(), not that it really needs to be
stefano
parents:
5587
diff
changeset
|
281 /** |
da4b8a105fd3
Document av_register_protocol(), not that it really needs to be
stefano
parents:
5587
diff
changeset
|
282 * Registers the URLProtocol protocol. |
6159
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
283 * |
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
284 * @param size the size of the URLProtocol struct referenced |
5590
da4b8a105fd3
Document av_register_protocol(), not that it really needs to be
stefano
parents:
5587
diff
changeset
|
285 */ |
6159
3fcaee5cf416
Add an av_register_protocol2 function that takes a size parameter
mstorsjo
parents:
6068
diff
changeset
|
286 int av_register_protocol2(URLProtocol *protocol, int size); |
0 | 287 |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
288 /** |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
289 * Bytestream IO Context. |
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
290 * New fields can be added to the end with minor version bumps. |
2851 | 291 * Removal, reordering and changes to existing fields require a major |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
292 * version bump. |
2851 | 293 * sizeof(ByteIOContext) must not be used outside libav*. |
2849
0182bdddc45e
Document ByteIOContext and URLContext change rules.
michael
parents:
2840
diff
changeset
|
294 */ |
0 | 295 typedef struct { |
296 unsigned char *buffer; | |
297 int buffer_size; | |
298 unsigned char *buf_ptr, *buf_end; | |
299 void *opaque; | |
65 | 300 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); |
554 | 301 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
|
302 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
|
303 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
|
304 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
|
305 int eof_reached; /**< true if eof reached */ |
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
306 int write_flag; /**< true if open for writing */ |
0 | 307 int is_streamed; |
308 int max_packet_size; | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
309 unsigned long checksum; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
310 unsigned char *checksum_ptr; |
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
311 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size); |
554 | 312 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
|
313 int (*read_pause)(void *opaque, int pause); |
4091 | 314 int64_t (*read_seek)(void *opaque, int stream_index, |
315 int64_t timestamp, int flags); | |
0 | 316 } ByteIOContext; |
317 | |
318 int init_put_byte(ByteIOContext *s, | |
319 unsigned char *buffer, | |
320 int buffer_size, | |
321 int write_flag, | |
322 void *opaque, | |
65 | 323 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), |
554 | 324 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
|
325 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
2853 | 326 ByteIOContext *av_alloc_put_byte( |
327 unsigned char *buffer, | |
328 int buffer_size, | |
329 int write_flag, | |
330 void *opaque, | |
331 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), | |
332 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
|
333 int64_t (*seek)(void *opaque, int64_t offset, int whence)); |
0 | 334 |
335 void put_byte(ByteIOContext *s, int b); | |
336 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size); | |
65 | 337 void put_le64(ByteIOContext *s, uint64_t val); |
338 void put_be64(ByteIOContext *s, uint64_t val); | |
0 | 339 void put_le32(ByteIOContext *s, unsigned int val); |
340 void put_be32(ByteIOContext *s, unsigned int val); | |
937 | 341 void put_le24(ByteIOContext *s, unsigned int val); |
822 | 342 void put_be24(ByteIOContext *s, unsigned int val); |
0 | 343 void put_le16(ByteIOContext *s, unsigned int val); |
344 void put_be16(ByteIOContext *s, unsigned int val); | |
345 void put_tag(ByteIOContext *s, const char *tag); | |
346 | |
347 void put_strz(ByteIOContext *s, const char *buf); | |
348 | |
3168 | 349 /** |
350 * fseek() equivalent for ByteIOContext. | |
351 * @return new position or AVERROR. | |
352 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
353 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence); |
3168 | 354 |
355 /** | |
356 * Skip given number of bytes forward. | |
357 * @param offset number of bytes | |
358 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
359 void url_fskip(ByteIOContext *s, int64_t offset); |
3168 | 360 |
361 /** | |
362 * ftell() equivalent for ByteIOContext. | |
363 * @return position or AVERROR. | |
364 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
365 int64_t url_ftell(ByteIOContext *s); |
3168 | 366 |
367 /** | |
368 * Gets the filesize. | |
369 * @return filesize or AVERROR | |
370 */ | |
3973
549a09cf23fe
Remove offset_t typedef and use int64_t directly instead.
diego
parents:
3852
diff
changeset
|
371 int64_t url_fsize(ByteIOContext *s); |
3168 | 372 |
373 /** | |
374 * feof() equivalent for ByteIOContext. | |
375 * @return non zero if and only if end of file | |
376 */ | |
0 | 377 int url_feof(ByteIOContext *s); |
3168 | 378 |
554 | 379 int url_ferror(ByteIOContext *s); |
0 | 380 |
2839
b51319dd86e5
Merge recently added and still unused play and pause functions.
michael
parents:
2834
diff
changeset
|
381 int av_url_read_fpause(ByteIOContext *h, int pause); |
4091 | 382 int64_t av_url_read_fseek(ByteIOContext *h, int stream_index, |
383 int64_t timestamp, int flags); | |
2783
1a9db30c1d1c
Extend ByteIOContext and add the buffered IO functions:
andoma
parents:
2778
diff
changeset
|
384 |
0 | 385 #define URL_EOF (-1) |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
386 /** @note return URL_EOF (-1) if EOF */ |
0 | 387 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
|
388 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
389 /** @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
|
390 #ifdef __GNUC__ |
265
786e8286ea4a
Patch for attribute(printf) by (Michel Bardiaux <mbardiaux at peaktime dot be>)
michaelni
parents:
206
diff
changeset
|
391 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
|
392 #else |
3a493a2e5bba
libavformat/avio.h compilation problem in VisualC++ by (lethean at realtime dot ssu dot ac dot kr)
michaelni
parents:
177
diff
changeset
|
393 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
|
394 #endif |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
395 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
396 /** @note unlike fgets, the EOL character is not returned and a whole |
4091 | 397 line is parsed. return NULL if first char read was EOF */ |
0 | 398 char *url_fgets(ByteIOContext *s, char *buf, int buf_size); |
399 | |
400 void put_flush_packet(ByteIOContext *s); | |
401 | |
3174 | 402 |
403 /** | |
404 * Reads size bytes from ByteIOContext into buf. | |
5909 | 405 * @return number of bytes read or AVERROR |
3174 | 406 */ |
0 | 407 int get_buffer(ByteIOContext *s, unsigned char *buf, int size); |
3174 | 408 |
409 /** | |
410 * Reads size bytes from ByteIOContext into buf. | |
3198 | 411 * This reads at most 1 packet. If that is not enough fewer bytes will be |
3174 | 412 * returned. |
5909 | 413 * @return number of bytes read or AVERROR |
3174 | 414 */ |
389
e14fcd57ad2f
decode latency patch by (Leon van Stuivenberg <l dot vanstuivenberg at chello dot nl>)
michael
parents:
265
diff
changeset
|
415 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
|
416 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
417 /** @note return 0 if EOF, so you cannot use it if EOF handling is |
4091 | 418 necessary */ |
0 | 419 int get_byte(ByteIOContext *s); |
937 | 420 unsigned int get_le24(ByteIOContext *s); |
0 | 421 unsigned int get_le32(ByteIOContext *s); |
65 | 422 uint64_t get_le64(ByteIOContext *s); |
0 | 423 unsigned int get_le16(ByteIOContext *s); |
424 | |
425 char *get_strz(ByteIOContext *s, char *buf, int maxlen); | |
426 unsigned int get_be16(ByteIOContext *s); | |
822 | 427 unsigned int get_be24(ByteIOContext *s); |
0 | 428 unsigned int get_be32(ByteIOContext *s); |
65 | 429 uint64_t get_be64(ByteIOContext *s); |
0 | 430 |
2700 | 431 uint64_t ff_get_v(ByteIOContext *bc); |
2699 | 432 |
0 | 433 static inline int url_is_streamed(ByteIOContext *s) |
434 { | |
435 return s->is_streamed; | |
436 } | |
437 | |
5632 | 438 /** |
439 * Creates and initializes a ByteIOContext for accessing the | |
440 * resource referenced by the URLContext h. | |
441 * @note When the URLContext h has been opened in read+write mode, the | |
442 * ByteIOContext can be used only for writing. | |
443 * | |
444 * @param s Used to return the pointer to the created ByteIOContext. | |
445 * In case of failure the pointed to value is set to NULL. | |
446 * @return 0 in case of success, a negative value corresponding to an | |
447 * AVERROR code in case of failure | |
448 */ | |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
449 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
|
450 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
451 /** @warning must be called before any I/O */ |
0 | 452 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
|
453 #if LIBAVFORMAT_VERSION_MAJOR < 53 |
2598
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
454 /** Reset the buffer for reading or writing. |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
455 * @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
|
456 * @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
|
457 * to set up the buffer for writing. */ |
fc7f8ee4700b
Add functionality to set the direction of a ByteIOContext buffer.
benoit
parents:
2582
diff
changeset
|
458 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
|
459 #endif |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
460 |
5640 | 461 /** |
5941
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
462 * Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file. |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
463 * Used after probing to avoid seeking. |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
464 * Joins buf and s->buffer, taking any overlap into consideration. |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
465 * @note s->buffer must overlap with buf or they can't be joined and the function fails |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
466 * @note This function is NOT part of the public API |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
467 * |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
468 * @param s The read-only ByteIOContext to rewind |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
469 * @param buf The probe buffer containing the first buf_size bytes of the file |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
470 * @param buf_size The size of buf |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
471 * @return 0 in case of success, a negative value corresponding to an |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
472 * AVERROR code in case of failure |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
473 */ |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
474 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size); |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
475 |
bde9a4b67f86
Reusing the probe buffer to rewind the ByteIOContext in ff_probe_input_buffer() instead of seeking back to the start of the file. Once exhausted, the size of the buffer is reduced.
thardin
parents:
5909
diff
changeset
|
476 /** |
5640 | 477 * Creates and initializes a ByteIOContext for accessing the |
478 * resource indicated by url. | |
479 * @note When the resource indicated by url has been opened in | |
480 * read+write mode, the ByteIOContext can be used only for writing. | |
481 * | |
482 * @param s Used to return the pointer to the created ByteIOContext. | |
483 * In case of failure the pointed to value is set to NULL. | |
484 * @param flags flags which control how the resource indicated by url | |
485 * is to be opened | |
486 * @return 0 in case of success, a negative value corresponding to an | |
487 * AVERROR code in case of failure | |
488 */ | |
5585
333f55aab3a2
Favor the term "URL" over "filename", as the API deals with URLs
stefano
parents:
5583
diff
changeset
|
489 int url_fopen(ByteIOContext **s, const char *url, int flags); |
5640 | 490 |
0 | 491 int url_fclose(ByteIOContext *s); |
492 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
|
493 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
494 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
495 * 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
|
496 * 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
|
497 * 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
|
498 * |
2747 | 499 * @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
|
500 * @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
|
501 */ |
0 | 502 int url_fget_max_packet_size(ByteIOContext *s); |
503 | |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
504 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
|
505 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
506 /** return the written or read size */ |
0 | 507 int url_close_buf(ByteIOContext *s); |
508 | |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
509 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
510 * 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
|
511 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
512 * @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
|
513 * @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
|
514 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
515 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
|
516 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
517 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
518 * 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
|
519 * 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
|
520 * 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
|
521 * |
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
522 * @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
|
523 * @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
|
524 * @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
|
525 */ |
2771
d52c718e83f9
Use dynamically allocated ByteIOContext in AVFormatContext
andoma
parents:
2748
diff
changeset
|
526 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
|
527 |
1876
247fdf49ffb8
Convert all the comment sections into Doxygen compatible comments, same for
takis
parents:
1875
diff
changeset
|
528 /** |
1874
3328f652d741
Move aviobuf.c comments to avio.h. By moving the aviobuf.c comments to avio.h,
takis
parents:
1787
diff
changeset
|
529 * 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
|
530 * 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
|
531 * @param s IO context |
2748 | 532 * @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
|
533 * @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
|
534 */ |
65 | 535 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer); |
0 | 536 |
4091 | 537 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, |
538 unsigned int len); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
539 unsigned long get_checksum(ByteIOContext *s); |
4091 | 540 void init_checksum(ByteIOContext *s, |
541 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), | |
542 unsigned long checksum); | |
418
41da3366d341
checksuming for nut & nice checksum API for libavformat
michael
parents:
389
diff
changeset
|
543 |
0 | 544 /* udp.c */ |
545 int udp_set_remote_url(URLContext *h, const char *uri); | |
546 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
|
547 #if (LIBAVFORMAT_VERSION_MAJOR <= 52) |
0 | 548 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
|
549 #endif |
0 | 550 |
3852 | 551 #endif /* AVFORMAT_AVIO_H */ |