Change license headers to say 'FFmpeg' instead of 'this program/this library'
[ffmpeg.git] / libavformat / avio.h
1 /*
2  * unbuffered io for ffmpeg system
3  * copyright (c) 2001 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #ifndef AVIO_H
22 #define AVIO_H
23
24 /* output byte stream handling */
25
26 typedef int64_t offset_t;
27
28 /* unbuffered I/O */
29
30 struct URLContext {
31     struct URLProtocol *prot;
32     int flags;
33     int is_streamed;  /* true if streamed (no seek possible), default = false */
34     int max_packet_size;  /* if non zero, the stream is packetized with this max packet size */
35     void *priv_data;
36     char filename[1]; /* specified filename */
37 };
38
39 typedef struct URLContext URLContext;
40
41 typedef struct URLPollEntry {
42     URLContext *handle;
43     int events;
44     int revents;
45 } URLPollEntry;
46
47 #define URL_RDONLY 0
48 #define URL_WRONLY 1
49 #define URL_RDWR   2
50
51 typedef int URLInterruptCB(void);
52
53 int url_open(URLContext **h, const char *filename, int flags);
54 int url_read(URLContext *h, unsigned char *buf, int size);
55 int url_write(URLContext *h, unsigned char *buf, int size);
56 offset_t url_seek(URLContext *h, offset_t pos, int whence);
57 int url_close(URLContext *h);
58 int url_exist(const char *filename);
59 offset_t url_filesize(URLContext *h);
60 int url_get_max_packet_size(URLContext *h);
61 void url_get_filename(URLContext *h, char *buf, int buf_size);
62
63 /* the callback is called in blocking functions to test regulary if
64    asynchronous interruption is needed. -EINTR is returned in this
65    case by the interrupted function. 'NULL' means no interrupt
66    callback is given. */
67 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
68
69 /* not implemented */
70 int url_poll(URLPollEntry *poll_table, int n, int timeout);
71
72 typedef struct URLProtocol {
73     const char *name;
74     int (*url_open)(URLContext *h, const char *filename, int flags);
75     int (*url_read)(URLContext *h, unsigned char *buf, int size);
76     int (*url_write)(URLContext *h, unsigned char *buf, int size);
77     offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
78     int (*url_close)(URLContext *h);
79     struct URLProtocol *next;
80 } URLProtocol;
81
82 extern URLProtocol *first_protocol;
83 extern URLInterruptCB *url_interrupt_cb;
84
85 int register_protocol(URLProtocol *protocol);
86
87 typedef struct {
88     unsigned char *buffer;
89     int buffer_size;
90     unsigned char *buf_ptr, *buf_end;
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     offset_t (*seek)(void *opaque, offset_t offset, int whence);
95     offset_t pos; /* position in the file of the current buffer */
96     int must_flush; /* true if the next seek should flush */
97     int eof_reached; /* true if eof reached */
98     int write_flag;  /* true if open for writing */
99     int is_streamed;
100     int max_packet_size;
101     unsigned long checksum;
102     unsigned char *checksum_ptr;
103     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
104     int error;         ///< contains the error code or 0 if no error happened
105 } ByteIOContext;
106
107 int init_put_byte(ByteIOContext *s,
108                   unsigned char *buffer,
109                   int buffer_size,
110                   int write_flag,
111                   void *opaque,
112                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
113                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
114                   offset_t (*seek)(void *opaque, offset_t offset, int whence));
115
116 void put_byte(ByteIOContext *s, int b);
117 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
118 void put_le64(ByteIOContext *s, uint64_t val);
119 void put_be64(ByteIOContext *s, uint64_t val);
120 void put_le32(ByteIOContext *s, unsigned int val);
121 void put_be32(ByteIOContext *s, unsigned int val);
122 void put_le24(ByteIOContext *s, unsigned int val);
123 void put_be24(ByteIOContext *s, unsigned int val);
124 void put_le16(ByteIOContext *s, unsigned int val);
125 void put_be16(ByteIOContext *s, unsigned int val);
126 void put_tag(ByteIOContext *s, const char *tag);
127
128 void put_strz(ByteIOContext *s, const char *buf);
129
130 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
131 void url_fskip(ByteIOContext *s, offset_t offset);
132 offset_t url_ftell(ByteIOContext *s);
133 offset_t url_fsize(ByteIOContext *s);
134 int url_feof(ByteIOContext *s);
135 int url_ferror(ByteIOContext *s);
136
137 #define URL_EOF (-1)
138 int url_fgetc(ByteIOContext *s);
139 #ifdef __GNUC__
140 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
141 #else
142 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
143 #endif
144 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
145
146 void put_flush_packet(ByteIOContext *s);
147
148 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
149 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
150 int get_byte(ByteIOContext *s);
151 unsigned int get_le24(ByteIOContext *s);
152 unsigned int get_le32(ByteIOContext *s);
153 uint64_t get_le64(ByteIOContext *s);
154 unsigned int get_le16(ByteIOContext *s);
155
156 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
157 unsigned int get_be16(ByteIOContext *s);
158 unsigned int get_be24(ByteIOContext *s);
159 unsigned int get_be32(ByteIOContext *s);
160 uint64_t get_be64(ByteIOContext *s);
161
162 static inline int url_is_streamed(ByteIOContext *s)
163 {
164     return s->is_streamed;
165 }
166
167 int url_fdopen(ByteIOContext *s, URLContext *h);
168 int url_setbufsize(ByteIOContext *s, int buf_size);
169 int url_fopen(ByteIOContext *s, const char *filename, int flags);
170 int url_fclose(ByteIOContext *s);
171 URLContext *url_fileno(ByteIOContext *s);
172 int url_fget_max_packet_size(ByteIOContext *s);
173
174 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
175 int url_close_buf(ByteIOContext *s);
176
177 int url_open_dyn_buf(ByteIOContext *s);
178 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
179 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
180
181 unsigned long get_checksum(ByteIOContext *s);
182 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
183
184 /* file.c */
185 extern URLProtocol file_protocol;
186 extern URLProtocol pipe_protocol;
187
188 /* udp.c */
189 extern URLProtocol udp_protocol;
190 int udp_set_remote_url(URLContext *h, const char *uri);
191 int udp_get_local_port(URLContext *h);
192 int udp_get_file_handle(URLContext *h);
193
194 /* tcp.c  */
195 extern URLProtocol tcp_protocol;
196
197 /* http.c */
198 extern URLProtocol http_protocol;
199
200 #endif
201