drop most url_fileno() calls (allows to use ByteIOContext directly in caller apps...
[libav.git] / libavformat / avio.h
CommitLineData
f031df23
FB
1#ifndef AVIO_H
2#define AVIO_H
3
de6d9b64
FB
4/* output byte stream handling */
5
0c1a9eda 6typedef int64_t offset_t;
de6d9b64
FB
7
8/* unbuffered I/O */
9
10struct URLContext {
11 struct URLProtocol *prot;
12 int flags;
13 int is_streamed; /* true if streamed (no seek possible), default = false */
f031df23 14 int max_packet_size; /* if non zero, the stream is packetized with this max packet size */
de6d9b64 15 void *priv_data;
f746a046 16 char filename[1]; /* specified filename */
de6d9b64
FB
17};
18
de6d9b64
FB
19typedef struct URLContext URLContext;
20
21typedef struct URLPollEntry {
22 URLContext *handle;
23 int events;
24 int revents;
25} URLPollEntry;
26
27#define URL_RDONLY 0
28#define URL_WRONLY 1
f031df23
FB
29#define URL_RDWR 2
30
019ac05a
FB
31typedef int URLInterruptCB(void);
32
de6d9b64
FB
33int url_open(URLContext **h, const char *filename, int flags);
34int url_read(URLContext *h, unsigned char *buf, int size);
35int url_write(URLContext *h, unsigned char *buf, int size);
36offset_t url_seek(URLContext *h, offset_t pos, int whence);
de6d9b64
FB
37int url_close(URLContext *h);
38int url_exist(const char *filename);
39offset_t url_filesize(URLContext *h);
f031df23 40int url_get_max_packet_size(URLContext *h);
f746a046
FB
41void url_get_filename(URLContext *h, char *buf, int buf_size);
42
019ac05a
FB
43/* the callback is called in blocking functions to test regulary if
44 asynchronous interruption is needed. -EINTR is returned in this
45 case by the interrupted function. 'NULL' means no interrupt
46 callback is given. */
47void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
48
de6d9b64
FB
49/* not implemented */
50int url_poll(URLPollEntry *poll_table, int n, int timeout);
51
52typedef struct URLProtocol {
53 const char *name;
54 int (*url_open)(URLContext *h, const char *filename, int flags);
55 int (*url_read)(URLContext *h, unsigned char *buf, int size);
56 int (*url_write)(URLContext *h, unsigned char *buf, int size);
57 offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
58 int (*url_close)(URLContext *h);
de6d9b64
FB
59 struct URLProtocol *next;
60} URLProtocol;
61
62extern URLProtocol *first_protocol;
019ac05a 63extern URLInterruptCB *url_interrupt_cb;
de6d9b64
FB
64
65int register_protocol(URLProtocol *protocol);
66
67typedef struct {
68 unsigned char *buffer;
69 int buffer_size;
70 unsigned char *buf_ptr, *buf_end;
71 void *opaque;
0c1a9eda 72 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
576ae256 73 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
de6d9b64
FB
74 int (*seek)(void *opaque, offset_t offset, int whence);
75 offset_t pos; /* position in the file of the current buffer */
76 int must_flush; /* true if the next seek should flush */
77 int eof_reached; /* true if eof reached */
78 int write_flag; /* true if open for writing */
79 int is_streamed;
f031df23 80 int max_packet_size;
ee9f36a8
MN
81 unsigned long checksum;
82 unsigned char *checksum_ptr;
83 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
576ae256 84 int error; ///< contains the error code or 0 if no error happened
de6d9b64
FB
85} ByteIOContext;
86
87int init_put_byte(ByteIOContext *s,
88 unsigned char *buffer,
89 int buffer_size,
90 int write_flag,
91 void *opaque,
0c1a9eda 92 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
576ae256 93 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
de6d9b64
FB
94 int (*seek)(void *opaque, offset_t offset, int whence));
95
96void put_byte(ByteIOContext *s, int b);
75bdb984 97void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
0c1a9eda
ZK
98void put_le64(ByteIOContext *s, uint64_t val);
99void put_be64(ByteIOContext *s, uint64_t val);
de6d9b64
FB
100void put_le32(ByteIOContext *s, unsigned int val);
101void put_be32(ByteIOContext *s, unsigned int val);
102void put_le16(ByteIOContext *s, unsigned int val);
103void put_be16(ByteIOContext *s, unsigned int val);
0570bf06 104void put_tag(ByteIOContext *s, const char *tag);
de6d9b64 105
3b4b29dc
FB
106void put_be64_double(ByteIOContext *s, double val);
107void put_strz(ByteIOContext *s, const char *buf);
75bdb984 108
de6d9b64
FB
109offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
110void url_fskip(ByteIOContext *s, offset_t offset);
111offset_t url_ftell(ByteIOContext *s);
a965c478 112offset_t url_fsize(ByteIOContext *s);
de6d9b64 113int url_feof(ByteIOContext *s);
576ae256 114int url_ferror(ByteIOContext *s);
de6d9b64 115
f031df23
FB
116#define URL_EOF (-1)
117int url_fgetc(ByteIOContext *s);
572f992e 118#ifdef __GNUC__
08f29f82 119int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
572f992e
MN
120#else
121int url_fprintf(ByteIOContext *s, const char *fmt, ...);
122#endif
f031df23
FB
123char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
124
de6d9b64
FB
125void put_flush_packet(ByteIOContext *s);
126
127int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
e15dec10 128int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
de6d9b64
FB
129int get_byte(ByteIOContext *s);
130unsigned int get_le32(ByteIOContext *s);
0c1a9eda 131uint64_t get_le64(ByteIOContext *s);
de6d9b64
FB
132unsigned int get_le16(ByteIOContext *s);
133
3b4b29dc
FB
134double get_be64_double(ByteIOContext *s);
135char *get_strz(ByteIOContext *s, char *buf, int maxlen);
de6d9b64
FB
136unsigned int get_be16(ByteIOContext *s);
137unsigned int get_be32(ByteIOContext *s);
0c1a9eda 138uint64_t get_be64(ByteIOContext *s);
de6d9b64 139
7ac13f0c 140static inline int url_is_streamed(ByteIOContext *s)
de6d9b64
FB
141{
142 return s->is_streamed;
143}
de6d9b64
FB
144
145int url_fdopen(ByteIOContext *s, URLContext *h);
146int url_setbufsize(ByteIOContext *s, int buf_size);
147int url_fopen(ByteIOContext *s, const char *filename, int flags);
148int url_fclose(ByteIOContext *s);
149URLContext *url_fileno(ByteIOContext *s);
f031df23 150int url_fget_max_packet_size(ByteIOContext *s);
de6d9b64 151
0c1a9eda 152int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
de6d9b64
FB
153int url_close_buf(ByteIOContext *s);
154
f031df23
FB
155int url_open_dyn_buf(ByteIOContext *s);
156int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
0c1a9eda 157int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
f031df23 158
ee9f36a8
MN
159unsigned long get_checksum(ByteIOContext *s);
160void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
161unsigned long update_adler32(unsigned long adler, const uint8_t *buf, unsigned int len);
162
de6d9b64
FB
163/* file.c */
164extern URLProtocol file_protocol;
165extern URLProtocol pipe_protocol;
166
167/* udp.c */
168extern URLProtocol udp_protocol;
f031df23
FB
169int udp_set_remote_url(URLContext *h, const char *uri);
170int udp_get_local_port(URLContext *h);
171int udp_get_file_handle(URLContext *h);
172
173/* tcp.c */
174extern URLProtocol tcp_protocol;
de6d9b64
FB
175
176/* http.c */
177extern URLProtocol http_protocol;
f031df23
FB
178
179#endif
180