2 * unbuffered io for ffmpeg system
3 * copyright (c) 2001 Fabrice Bellard
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 /* output byte stream handling */
24 typedef int64_t offset_t;
29 struct URLProtocol *prot;
31 int is_streamed; /* true if streamed (no seek possible), default = false */
32 int max_packet_size; /* if non zero, the stream is packetized with this max packet size */
34 char filename[1]; /* specified filename */
37 typedef struct URLContext URLContext;
39 typedef struct URLPollEntry {
49 typedef int URLInterruptCB(void);
51 int url_open(URLContext **h, const char *filename, int flags);
52 int url_read(URLContext *h, unsigned char *buf, int size);
53 int url_write(URLContext *h, unsigned char *buf, int size);
54 offset_t url_seek(URLContext *h, offset_t pos, int whence);
55 int url_close(URLContext *h);
56 int url_exist(const char *filename);
57 offset_t url_filesize(URLContext *h);
58 int url_get_max_packet_size(URLContext *h);
59 void url_get_filename(URLContext *h, char *buf, int buf_size);
61 /* the callback is called in blocking functions to test regulary if
62 asynchronous interruption is needed. -EINTR is returned in this
63 case by the interrupted function. 'NULL' means no interrupt
65 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
68 int url_poll(URLPollEntry *poll_table, int n, int timeout);
70 typedef struct URLProtocol {
72 int (*url_open)(URLContext *h, const char *filename, int flags);
73 int (*url_read)(URLContext *h, unsigned char *buf, int size);
74 int (*url_write)(URLContext *h, unsigned char *buf, int size);
75 offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
76 int (*url_close)(URLContext *h);
77 struct URLProtocol *next;
80 extern URLProtocol *first_protocol;
81 extern URLInterruptCB *url_interrupt_cb;
83 int register_protocol(URLProtocol *protocol);
86 unsigned char *buffer;
88 unsigned char *buf_ptr, *buf_end;
90 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
91 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
92 offset_t (*seek)(void *opaque, offset_t offset, int whence);
93 offset_t pos; /* position in the file of the current buffer */
94 int must_flush; /* true if the next seek should flush */
95 int eof_reached; /* true if eof reached */
96 int write_flag; /* true if open for writing */
99 unsigned long checksum;
100 unsigned char *checksum_ptr;
101 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
102 int error; ///< contains the error code or 0 if no error happened
105 int init_put_byte(ByteIOContext *s,
106 unsigned char *buffer,
110 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
111 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
112 offset_t (*seek)(void *opaque, offset_t offset, int whence));
114 void put_byte(ByteIOContext *s, int b);
115 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
116 void put_le64(ByteIOContext *s, uint64_t val);
117 void put_be64(ByteIOContext *s, uint64_t val);
118 void put_le32(ByteIOContext *s, unsigned int val);
119 void put_be32(ByteIOContext *s, unsigned int val);
120 void put_le24(ByteIOContext *s, unsigned int val);
121 void put_be24(ByteIOContext *s, unsigned int val);
122 void put_le16(ByteIOContext *s, unsigned int val);
123 void put_be16(ByteIOContext *s, unsigned int val);
124 void put_tag(ByteIOContext *s, const char *tag);
126 void put_strz(ByteIOContext *s, const char *buf);
128 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
129 void url_fskip(ByteIOContext *s, offset_t offset);
130 offset_t url_ftell(ByteIOContext *s);
131 offset_t url_fsize(ByteIOContext *s);
132 int url_feof(ByteIOContext *s);
133 int url_ferror(ByteIOContext *s);
136 int url_fgetc(ByteIOContext *s);
138 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
140 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
142 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
144 void put_flush_packet(ByteIOContext *s);
146 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
147 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
148 int get_byte(ByteIOContext *s);
149 unsigned int get_le24(ByteIOContext *s);
150 unsigned int get_le32(ByteIOContext *s);
151 uint64_t get_le64(ByteIOContext *s);
152 unsigned int get_le16(ByteIOContext *s);
154 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
155 unsigned int get_be16(ByteIOContext *s);
156 unsigned int get_be24(ByteIOContext *s);
157 unsigned int get_be32(ByteIOContext *s);
158 uint64_t get_be64(ByteIOContext *s);
160 static inline int url_is_streamed(ByteIOContext *s)
162 return s->is_streamed;
165 int url_fdopen(ByteIOContext *s, URLContext *h);
166 int url_setbufsize(ByteIOContext *s, int buf_size);
167 int url_fopen(ByteIOContext *s, const char *filename, int flags);
168 int url_fclose(ByteIOContext *s);
169 URLContext *url_fileno(ByteIOContext *s);
170 int url_fget_max_packet_size(ByteIOContext *s);
172 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
173 int url_close_buf(ByteIOContext *s);
175 int url_open_dyn_buf(ByteIOContext *s);
176 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
177 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
179 unsigned long get_checksum(ByteIOContext *s);
180 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
183 extern URLProtocol file_protocol;
184 extern URLProtocol pipe_protocol;
187 extern URLProtocol udp_protocol;
188 int udp_set_remote_url(URLContext *h, const char *uri);
189 int udp_get_local_port(URLContext *h);
190 int udp_get_file_handle(URLContext *h);
193 extern URLProtocol tcp_protocol;
196 extern URLProtocol http_protocol;