2 * unbuffered io for ffmpeg system
3 * copyright (c) 2001 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
24 /* output byte stream handling */
26 typedef int64_t offset_t;
31 struct URLProtocol *prot;
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 */
36 char filename[1]; /* specified filename */
39 typedef struct URLContext URLContext;
41 typedef struct URLPollEntry {
51 typedef int URLInterruptCB(void);
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);
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
67 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
70 int url_poll(URLPollEntry *poll_table, int n, int timeout);
72 #define AVSEEK_SIZE 0x10000
74 typedef struct URLProtocol {
76 int (*url_open)(URLContext *h, const char *filename, int flags);
77 int (*url_read)(URLContext *h, unsigned char *buf, int size);
78 int (*url_write)(URLContext *h, unsigned char *buf, int size);
79 offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
80 int (*url_close)(URLContext *h);
81 struct URLProtocol *next;
84 extern URLProtocol *first_protocol;
85 extern URLInterruptCB *url_interrupt_cb;
87 int register_protocol(URLProtocol *protocol);
90 unsigned char *buffer;
92 unsigned char *buf_ptr, *buf_end;
94 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
95 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
96 offset_t (*seek)(void *opaque, offset_t offset, int whence);
97 offset_t pos; /* position in the file of the current buffer */
98 int must_flush; /* true if the next seek should flush */
99 int eof_reached; /* true if eof reached */
100 int write_flag; /* true if open for writing */
103 unsigned long checksum;
104 unsigned char *checksum_ptr;
105 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
106 int error; ///< contains the error code or 0 if no error happened
109 int init_put_byte(ByteIOContext *s,
110 unsigned char *buffer,
114 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
115 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
116 offset_t (*seek)(void *opaque, offset_t offset, int whence));
118 void put_byte(ByteIOContext *s, int b);
119 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
120 void put_le64(ByteIOContext *s, uint64_t val);
121 void put_be64(ByteIOContext *s, uint64_t val);
122 void put_le32(ByteIOContext *s, unsigned int val);
123 void put_be32(ByteIOContext *s, unsigned int val);
124 void put_le24(ByteIOContext *s, unsigned int val);
125 void put_be24(ByteIOContext *s, unsigned int val);
126 void put_le16(ByteIOContext *s, unsigned int val);
127 void put_be16(ByteIOContext *s, unsigned int val);
128 void put_tag(ByteIOContext *s, const char *tag);
130 void put_strz(ByteIOContext *s, const char *buf);
132 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
133 void url_fskip(ByteIOContext *s, offset_t offset);
134 offset_t url_ftell(ByteIOContext *s);
135 offset_t url_fsize(ByteIOContext *s);
136 int url_feof(ByteIOContext *s);
137 int url_ferror(ByteIOContext *s);
140 int url_fgetc(ByteIOContext *s);
142 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
144 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
146 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
148 void put_flush_packet(ByteIOContext *s);
150 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
151 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
152 int get_byte(ByteIOContext *s);
153 unsigned int get_le24(ByteIOContext *s);
154 unsigned int get_le32(ByteIOContext *s);
155 uint64_t get_le64(ByteIOContext *s);
156 unsigned int get_le16(ByteIOContext *s);
158 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
159 unsigned int get_be16(ByteIOContext *s);
160 unsigned int get_be24(ByteIOContext *s);
161 unsigned int get_be32(ByteIOContext *s);
162 uint64_t get_be64(ByteIOContext *s);
164 static inline int url_is_streamed(ByteIOContext *s)
166 return s->is_streamed;
169 int url_fdopen(ByteIOContext *s, URLContext *h);
170 int url_setbufsize(ByteIOContext *s, int buf_size);
171 int url_fopen(ByteIOContext *s, const char *filename, int flags);
172 int url_fclose(ByteIOContext *s);
173 URLContext *url_fileno(ByteIOContext *s);
174 int url_fget_max_packet_size(ByteIOContext *s);
176 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
177 int url_close_buf(ByteIOContext *s);
179 int url_open_dyn_buf(ByteIOContext *s);
180 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
181 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
183 unsigned long get_checksum(ByteIOContext *s);
184 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
187 extern URLProtocol file_protocol;
188 extern URLProtocol pipe_protocol;
191 extern URLProtocol udp_protocol;
192 int udp_set_remote_url(URLContext *h, const char *uri);
193 int udp_get_local_port(URLContext *h);
194 int udp_get_file_handle(URLContext *h);
197 extern URLProtocol tcp_protocol;
200 extern URLProtocol http_protocol;