Use av_get_bits_per_pixel() for computing the bits per pixel of the
[libav.git] / libavformat / avio.h
CommitLineData
04d7f601 1/*
04d7f601
DB
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
04d7f601
DB
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
98790382
SS
20#ifndef AVFORMAT_AVIO_H
21#define AVFORMAT_AVIO_H
f031df23 22
aafe9b63
SS
23/**
24 * @file libavformat/avio.h
25 * unbuffered I/O operations
3f4c2bf9
SS
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.
aafe9b63
SS
29 */
30
99545457
MR
31#include <stdint.h>
32
30f68128
DB
33#include "libavutil/common.h"
34
de6d9b64
FB
35/* unbuffered I/O */
36
1308f273
MN
37/**
38 * URL Context.
39 * New fields can be added to the end with minor version bumps.
8bfb108b 40 * Removal, reordering and changes to existing fields require a major
1308f273 41 * version bump.
8bfb108b 42 * sizeof(URLContext) must not be used outside libav*.
1308f273 43 */
597b4b3f 44typedef struct URLContext {
5acef35f
BA
45#if LIBAVFORMAT_VERSION_MAJOR >= 53
46 const AVClass *av_class; ///< information for av_log(). Set by url_open().
47#endif
de6d9b64 48 struct URLProtocol *prot;
115329f1 49 int flags;
c3316802
PI
50 int is_streamed; /**< true if streamed (no seek possible), default = false */
51 int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */
de6d9b64 52 void *priv_data;
c3316802 53 char *filename; /**< specified filename */
597b4b3f 54} URLContext;
de6d9b64
FB
55
56typedef struct URLPollEntry {
57 URLContext *handle;
58 int events;
59 int revents;
60} URLPollEntry;
61
62#define URL_RDONLY 0
63#define URL_WRONLY 1
f031df23
FB
64#define URL_RDWR 2
65
019ac05a
FB
66typedef int URLInterruptCB(void);
67
ba99cfc2
RB
68int url_open_protocol (URLContext **puc, struct URLProtocol *up,
69 const char *filename, int flags);
de6d9b64
FB
70int url_open(URLContext **h, const char *filename, int flags);
71int url_read(URLContext *h, unsigned char *buf, int size);
ddb901b7
RD
72/**
73 * Read as many bytes as possible (up to size), calling the
74 * read function multiple times if necessary.
75 * Will also retry if the read function returns AVERROR(EAGAIN).
76 * This makes special short-read handling in applications
77 * unnecessary, if the return value is < size then it is
78 * certain there was either an error or the end of file was reached.
79 */
0e848977 80int url_read_complete(URLContext *h, unsigned char *buf, int size);
de6d9b64 81int url_write(URLContext *h, unsigned char *buf, int size);
bc5c918e 82int64_t url_seek(URLContext *h, int64_t pos, int whence);
de6d9b64
FB
83int url_close(URLContext *h);
84int url_exist(const char *filename);
bc5c918e 85int64_t url_filesize(URLContext *h);
c306748c 86
c3316802 87/**
f0a80394
RB
88 * Return the file descriptor associated with this URL. For RTP, this
89 * will return only the RTP file descriptor, not the RTCP file descriptor.
90 * To get both, use rtp_get_file_handles().
91 *
92 * @return the file descriptor associated with this URL, or <0 on error.
93 */
94int url_get_file_handle(URLContext *h);
95
96/**
c306748c 97 * Return the maximum packet size associated to packetized file
8bfb108b 98 * handle. If the file is not packetized (stream like HTTP or file on
c306748c
PI
99 * disk), then 0 is returned.
100 *
101 * @param h file handle
102 * @return maximum packet size in bytes
103 */
f031df23 104int url_get_max_packet_size(URLContext *h);
f746a046
FB
105void url_get_filename(URLContext *h, char *buf, int buf_size);
106
c3316802 107/**
8bfb108b 108 * The callback is called in blocking functions to test regulary if
c3316802
PI
109 * asynchronous interruption is needed. AVERROR(EINTR) is returned
110 * in this case by the interrupted function. 'NULL' means no interrupt
8bfb108b 111 * callback is given.
c3316802 112 */
019ac05a
FB
113void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
114
de6d9b64
FB
115/* not implemented */
116int url_poll(URLPollEntry *poll_table, int n, int timeout);
117
502bdf68
MN
118/**
119 * Pause and resume playing - only meaningful if using a network streaming
120 * protocol (e.g. MMS).
121 * @param pause 1 for pause, 0 for resume
122 */
123int av_url_read_pause(URLContext *h, int pause);
8bfb108b 124
536333a0
BA
125/**
126 * Seek to a given timestamp relative to some component stream.
8bfb108b 127 * Only meaningful if using a network streaming protocol (e.g. MMS.).
536333a0
BA
128 * @param stream_index The stream index that the timestamp is relative to.
129 * If stream_index is (-1) the timestamp should be in AV_TIME_BASE
130 * units from the beginning of the presentation.
131 * If a stream_index >= 0 is used and the protocol does not support
132 * seeking based on component streams, the call will fail with ENOTSUP.
00ef4f58 133 * @param timestamp timestamp in AVStream.time_base units
536333a0
BA
134 * or if there is no stream specified then in AV_TIME_BASE units.
135 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
136 * and AVSEEK_FLAG_ANY. The protocol may silently ignore
137 * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
138 * fail with ENOTSUP if used and not supported.
139 * @return >= 0 on success
140 * @see AVInputFormat::read_seek
141 */
7f37f568
DB
142int64_t av_url_read_seek(URLContext *h, int stream_index,
143 int64_t timestamp, int flags);
536333a0 144
aa38b097 145/**
90b5b51e
DB
146 * Passing this as the "whence" parameter to a seek function causes it to
147 * return the filesize without seeking anywhere. Supporting this is optional.
148 * If it is not supported then the seek function will return <0.
aa38b097 149 */
8e287af0
MN
150#define AVSEEK_SIZE 0x10000
151
de6d9b64
FB
152typedef struct URLProtocol {
153 const char *name;
154 int (*url_open)(URLContext *h, const char *filename, int flags);
155 int (*url_read)(URLContext *h, unsigned char *buf, int size);
156 int (*url_write)(URLContext *h, unsigned char *buf, int size);
bc5c918e 157 int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
de6d9b64 158 int (*url_close)(URLContext *h);
de6d9b64 159 struct URLProtocol *next;
502bdf68 160 int (*url_read_pause)(URLContext *h, int pause);
7f37f568
DB
161 int64_t (*url_read_seek)(URLContext *h, int stream_index,
162 int64_t timestamp, int flags);
f0a80394 163 int (*url_get_file_handle)(URLContext *h);
de6d9b64
FB
164} URLProtocol;
165
d1037c12 166#if LIBAVFORMAT_VERSION_MAJOR < 53
de6d9b64 167extern URLProtocol *first_protocol;
d1037c12
SS
168#endif
169
019ac05a 170extern URLInterruptCB *url_interrupt_cb;
de6d9b64 171
9075d1e0
SS
172/**
173 * If protocol is NULL, returns the first registered protocol,
c1b02101 174 * if protocol is non-NULL, returns the next registered protocol after protocol,
9075d1e0
SS
175 * or NULL if protocol is the last one.
176 */
84be6e72
MN
177URLProtocol *av_protocol_next(URLProtocol *p);
178
65c40e4e
SS
179#if LIBAVFORMAT_VERSION_MAJOR < 53
180/**
181 * @deprecated Use av_register_protocol() instead.
182 */
183attribute_deprecated int register_protocol(URLProtocol *protocol);
184#endif
185
186int av_register_protocol(URLProtocol *protocol);
de6d9b64 187
1308f273
MN
188/**
189 * Bytestream IO Context.
190 * New fields can be added to the end with minor version bumps.
8bfb108b 191 * Removal, reordering and changes to existing fields require a major
1308f273 192 * version bump.
8bfb108b 193 * sizeof(ByteIOContext) must not be used outside libav*.
1308f273 194 */
de6d9b64
FB
195typedef struct {
196 unsigned char *buffer;
197 int buffer_size;
198 unsigned char *buf_ptr, *buf_end;
199 void *opaque;
0c1a9eda 200 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
576ae256 201 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
bc5c918e
DB
202 int64_t (*seek)(void *opaque, int64_t offset, int whence);
203 int64_t pos; /**< position in the file of the current buffer */
c3316802
PI
204 int must_flush; /**< true if the next seek should flush */
205 int eof_reached; /**< true if eof reached */
206 int write_flag; /**< true if open for writing */
de6d9b64 207 int is_streamed;
f031df23 208 int max_packet_size;
ee9f36a8
MN
209 unsigned long checksum;
210 unsigned char *checksum_ptr;
211 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
576ae256 212 int error; ///< contains the error code or 0 if no error happened
502bdf68 213 int (*read_pause)(void *opaque, int pause);
7f37f568
DB
214 int64_t (*read_seek)(void *opaque, int stream_index,
215 int64_t timestamp, int flags);
de6d9b64
FB
216} ByteIOContext;
217
218int init_put_byte(ByteIOContext *s,
219 unsigned char *buffer,
220 int buffer_size,
221 int write_flag,
222 void *opaque,
1e0f3468
RD
223 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
224 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
bc5c918e 225 int64_t (*seek)(void *opaque, int64_t offset, int whence));
1e0f3468
RD
226ByteIOContext *av_alloc_put_byte(
227 unsigned char *buffer,
228 int buffer_size,
229 int write_flag,
230 void *opaque,
0c1a9eda 231 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
576ae256 232 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
bc5c918e 233 int64_t (*seek)(void *opaque, int64_t offset, int whence));
de6d9b64
FB
234
235void put_byte(ByteIOContext *s, int b);
75bdb984 236void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
0c1a9eda
ZK
237void put_le64(ByteIOContext *s, uint64_t val);
238void put_be64(ByteIOContext *s, uint64_t val);
de6d9b64
FB
239void put_le32(ByteIOContext *s, unsigned int val);
240void put_be32(ByteIOContext *s, unsigned int val);
ea395e8c 241void put_le24(ByteIOContext *s, unsigned int val);
a254c574 242void put_be24(ByteIOContext *s, unsigned int val);
de6d9b64
FB
243void put_le16(ByteIOContext *s, unsigned int val);
244void put_be16(ByteIOContext *s, unsigned int val);
0570bf06 245void put_tag(ByteIOContext *s, const char *tag);
de6d9b64 246
3b4b29dc 247void put_strz(ByteIOContext *s, const char *buf);
75bdb984 248
67e21020
MN
249/**
250 * fseek() equivalent for ByteIOContext.
251 * @return new position or AVERROR.
252 */
bc5c918e 253int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
67e21020
MN
254
255/**
256 * Skip given number of bytes forward.
257 * @param offset number of bytes
258 */
bc5c918e 259void url_fskip(ByteIOContext *s, int64_t offset);
67e21020
MN
260
261/**
262 * ftell() equivalent for ByteIOContext.
263 * @return position or AVERROR.
264 */
bc5c918e 265int64_t url_ftell(ByteIOContext *s);
67e21020
MN
266
267/**
268 * Gets the filesize.
269 * @return filesize or AVERROR
270 */
bc5c918e 271int64_t url_fsize(ByteIOContext *s);
67e21020
MN
272
273/**
274 * feof() equivalent for ByteIOContext.
275 * @return non zero if and only if end of file
276 */
de6d9b64 277int url_feof(ByteIOContext *s);
67e21020 278
576ae256 279int url_ferror(ByteIOContext *s);
de6d9b64 280
502bdf68 281int av_url_read_fpause(ByteIOContext *h, int pause);
7f37f568
DB
282int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
283 int64_t timestamp, int flags);
e7e4810a 284
f031df23 285#define URL_EOF (-1)
c3316802 286/** @note return URL_EOF (-1) if EOF */
f031df23 287int url_fgetc(ByteIOContext *s);
a8c5ab27 288
c3316802 289/** @warning currently size is limited */
572f992e 290#ifdef __GNUC__
08f29f82 291int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
572f992e
MN
292#else
293int url_fprintf(ByteIOContext *s, const char *fmt, ...);
294#endif
a8c5ab27 295
c3316802 296/** @note unlike fgets, the EOL character is not returned and a whole
7f37f568 297 line is parsed. return NULL if first char read was EOF */
f031df23
FB
298char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
299
de6d9b64
FB
300void put_flush_packet(ByteIOContext *s);
301
4edfcecc
MN
302
303/**
304 * Reads size bytes from ByteIOContext into buf.
305 * @returns number of bytes read or AVERROR
306 */
de6d9b64 307int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
4edfcecc
MN
308
309/**
310 * Reads size bytes from ByteIOContext into buf.
4477dedc 311 * This reads at most 1 packet. If that is not enough fewer bytes will be
4edfcecc
MN
312 * returned.
313 * @returns number of bytes read or AVERROR
314 */
e15dec10 315int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
a8c5ab27 316
c3316802 317/** @note return 0 if EOF, so you cannot use it if EOF handling is
7f37f568 318 necessary */
de6d9b64 319int get_byte(ByteIOContext *s);
ea395e8c 320unsigned int get_le24(ByteIOContext *s);
de6d9b64 321unsigned int get_le32(ByteIOContext *s);
0c1a9eda 322uint64_t get_le64(ByteIOContext *s);
de6d9b64
FB
323unsigned int get_le16(ByteIOContext *s);
324
3b4b29dc 325char *get_strz(ByteIOContext *s, char *buf, int maxlen);
de6d9b64 326unsigned int get_be16(ByteIOContext *s);
a254c574 327unsigned int get_be24(ByteIOContext *s);
de6d9b64 328unsigned int get_be32(ByteIOContext *s);
0c1a9eda 329uint64_t get_be64(ByteIOContext *s);
de6d9b64 330
7798b42d 331uint64_t ff_get_v(ByteIOContext *bc);
897d3eef 332
7ac13f0c 333static inline int url_is_streamed(ByteIOContext *s)
de6d9b64
FB
334{
335 return s->is_streamed;
336}
de6d9b64 337
3576f9c6 338/** @note when opened as read/write, the buffers are only used for
7f37f568 339 writing */
899681cd 340int url_fdopen(ByteIOContext **s, URLContext *h);
a8c5ab27 341
c3316802 342/** @warning must be called before any I/O */
de6d9b64 343int url_setbufsize(ByteIOContext *s, int buf_size);
08580cb0 344#if LIBAVFORMAT_VERSION_MAJOR < 53
770d9daf
BA
345/** Reset the buffer for reading or writing.
346 * @note Will drop any data currently in the buffer without transmitting it.
347 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
348 * to set up the buffer for writing. */
349int url_resetbuf(ByteIOContext *s, int flags);
08580cb0 350#endif
a8c5ab27 351
c3316802 352/** @note when opened as read/write, the buffers are only used for
7f37f568 353 writing */
899681cd 354int url_fopen(ByteIOContext **s, const char *filename, int flags);
de6d9b64
FB
355int url_fclose(ByteIOContext *s);
356URLContext *url_fileno(ByteIOContext *s);
a8c5ab27 357
c3316802 358/**
a8c5ab27
PI
359 * Return the maximum packet size associated to packetized buffered file
360 * handle. If the file is not packetized (stream like http or file on
361 * disk), then 0 is returned.
362 *
abfe87d4 363 * @param s buffered file handle
a8c5ab27
PI
364 * @return maximum packet size in bytes
365 */
f031df23 366int url_fget_max_packet_size(ByteIOContext *s);
de6d9b64 367
899681cd 368int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
a8c5ab27 369
c3316802 370/** return the written or read size */
de6d9b64
FB
371int url_close_buf(ByteIOContext *s);
372
c3316802 373/**
a8c5ab27
PI
374 * Open a write only memory stream.
375 *
376 * @param s new IO context
377 * @return zero if no error.
378 */
899681cd 379int url_open_dyn_buf(ByteIOContext **s);
a8c5ab27 380
c3316802 381/**
a8c5ab27
PI
382 * Open a write only packetized memory stream with a maximum packet
383 * size of 'max_packet_size'. The stream is stored in a memory buffer
384 * with a big endian 4 byte header giving the packet size in bytes.
385 *
386 * @param s new IO context
387 * @param max_packet_size maximum packet size (must be > 0)
388 * @return zero if no error.
389 */
899681cd 390int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
a8c5ab27 391
c3316802 392/**
a8c5ab27
PI
393 * Return the written size and a pointer to the buffer. The buffer
394 * must be freed with av_free().
395 * @param s IO context
e8b7c70f 396 * @param pbuffer pointer to a byte buffer
a8c5ab27
PI
397 * @return the length of the byte buffer
398 */
0c1a9eda 399int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
f031df23 400
7f37f568
DB
401unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
402 unsigned int len);
ee9f36a8 403unsigned long get_checksum(ByteIOContext *s);
7f37f568
DB
404void init_checksum(ByteIOContext *s,
405 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
406 unsigned long checksum);
ee9f36a8 407
de6d9b64 408/* udp.c */
f031df23
FB
409int udp_set_remote_url(URLContext *h, const char *uri);
410int udp_get_local_port(URLContext *h);
f0a80394 411#if (LIBAVFORMAT_VERSION_MAJOR <= 52)
f031df23 412int udp_get_file_handle(URLContext *h);
f0a80394 413#endif
f031df23 414
98790382 415#endif /* AVFORMAT_AVIO_H */