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