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