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