2 * Buffered I/O for ffmpeg system
3 * Copyright (c) 2000,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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #define IO_BUFFER_SIZE 32768
25 int init_put_byte(ByteIOContext *s,
26 unsigned char *buffer,
30 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
31 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
32 offset_t (*seek)(void *opaque, offset_t offset, int whence))
35 s->buffer_size = buffer_size;
37 s->write_flag = write_flag;
41 s->buf_end = buffer + buffer_size;
43 s->write_packet = write_packet;
44 s->read_packet = read_packet;
51 s->max_packet_size = 0;
52 s->update_checksum= NULL;
57 #ifdef CONFIG_ENCODERS
58 static void flush_buffer(ByteIOContext *s)
60 if (s->buf_ptr > s->buffer) {
61 if (s->write_packet && !s->error){
62 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
67 if(s->update_checksum){
68 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
69 s->checksum_ptr= s->buffer;
71 s->pos += s->buf_ptr - s->buffer;
73 s->buf_ptr = s->buffer;
76 void put_byte(ByteIOContext *s, int b)
79 if (s->buf_ptr >= s->buf_end)
83 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
88 len = (s->buf_end - s->buf_ptr);
91 memcpy(s->buf_ptr, buf, len);
94 if (s->buf_ptr >= s->buf_end)
102 void put_flush_packet(ByteIOContext *s)
107 #endif //CONFIG_ENCODERS
109 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence)
113 if (whence != SEEK_CUR && whence != SEEK_SET)
116 #ifdef CONFIG_ENCODERS
118 if (whence == SEEK_CUR) {
119 offset1 = s->pos + (s->buf_ptr - s->buffer);
124 offset1 = offset - s->pos;
125 if (!s->must_flush &&
126 offset1 >= 0 && offset1 < (s->buf_end - s->buffer)) {
127 /* can do the seek inside the buffer */
128 s->buf_ptr = s->buffer + offset1;
134 s->buf_ptr = s->buffer;
135 s->seek(s->opaque, offset, SEEK_SET);
139 #endif //CONFIG_ENCODERS
141 if (whence == SEEK_CUR) {
142 offset1 = s->pos - (s->buf_end - s->buffer) + (s->buf_ptr - s->buffer);
147 offset1 = offset - (s->pos - (s->buf_end - s->buffer));
148 if (offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
149 /* can do the seek inside the buffer */
150 s->buf_ptr = s->buffer + offset1;
154 s->buf_ptr = s->buffer;
155 s->buf_end = s->buffer;
156 if (s->seek(s->opaque, offset, SEEK_SET) == (offset_t)-EPIPE)
165 void url_fskip(ByteIOContext *s, offset_t offset)
167 url_fseek(s, offset, SEEK_CUR);
170 offset_t url_ftell(ByteIOContext *s)
172 return url_fseek(s, 0, SEEK_CUR);
175 offset_t url_fsize(ByteIOContext *s)
181 size = s->seek(s->opaque, -1, SEEK_END) + 1;
182 s->seek(s->opaque, s->pos, SEEK_SET);
186 int url_feof(ByteIOContext *s)
188 return s->eof_reached;
191 int url_ferror(ByteIOContext *s)
196 #ifdef CONFIG_ENCODERS
197 void put_le32(ByteIOContext *s, unsigned int val)
200 put_byte(s, val >> 8);
201 put_byte(s, val >> 16);
202 put_byte(s, val >> 24);
205 void put_be32(ByteIOContext *s, unsigned int val)
207 put_byte(s, val >> 24);
208 put_byte(s, val >> 16);
209 put_byte(s, val >> 8);
213 /* IEEE format is assumed */
214 void put_be64_double(ByteIOContext *s, double val)
224 void put_strz(ByteIOContext *s, const char *str)
227 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
232 void put_le64(ByteIOContext *s, uint64_t val)
234 put_le32(s, (uint32_t)(val & 0xffffffff));
235 put_le32(s, (uint32_t)(val >> 32));
238 void put_be64(ByteIOContext *s, uint64_t val)
240 put_be32(s, (uint32_t)(val >> 32));
241 put_be32(s, (uint32_t)(val & 0xffffffff));
244 void put_le16(ByteIOContext *s, unsigned int val)
247 put_byte(s, val >> 8);
250 void put_be16(ByteIOContext *s, unsigned int val)
252 put_byte(s, val >> 8);
256 void put_tag(ByteIOContext *s, const char *tag)
262 #endif //CONFIG_ENCODERS
266 static void fill_buffer(ByteIOContext *s)
270 /* no need to do anything if EOF already reached */
274 if(s->update_checksum){
275 if(s->buf_end > s->checksum_ptr)
276 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
277 s->checksum_ptr= s->buffer;
280 len = s->read_packet(s->opaque, s->buffer, s->buffer_size);
282 /* do not modify buffer if EOF reached so that a seek back can
283 be done without rereading data */
289 s->buf_ptr = s->buffer;
290 s->buf_end = s->buffer + len;
294 unsigned long get_checksum(ByteIOContext *s){
295 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
296 s->update_checksum= NULL;
300 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum){
301 s->update_checksum= update_checksum;
302 if(s->update_checksum){
303 s->checksum= s->update_checksum(checksum, NULL, 0);
304 s->checksum_ptr= s->buf_ptr;
308 /* NOTE: return 0 if EOF, so you cannot use it if EOF handling is
310 /* XXX: put an inline version */
311 int get_byte(ByteIOContext *s)
313 if (s->buf_ptr < s->buf_end) {
314 return *s->buf_ptr++;
317 if (s->buf_ptr < s->buf_end)
318 return *s->buf_ptr++;
324 /* NOTE: return URL_EOF (-1) if EOF */
325 int url_fgetc(ByteIOContext *s)
327 if (s->buf_ptr < s->buf_end) {
328 return *s->buf_ptr++;
331 if (s->buf_ptr < s->buf_end)
332 return *s->buf_ptr++;
338 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
344 len = s->buf_end - s->buf_ptr;
348 if(size > s->buffer_size && !s->update_checksum){
349 len = s->read_packet(s->opaque, buf, size);
351 /* do not modify buffer if EOF reached so that a seek back can
352 be done without rereading data */
361 s->buf_ptr = s->buffer;
362 s->buf_end = s->buffer/* + len*/;
366 len = s->buf_end - s->buf_ptr;
371 memcpy(buf, s->buf_ptr, len);
380 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
387 len = s->buf_end - s->buf_ptr;
390 len = s->buf_end - s->buf_ptr;
394 memcpy(buf, s->buf_ptr, len);
399 unsigned int get_le16(ByteIOContext *s)
403 val |= get_byte(s) << 8;
407 unsigned int get_le32(ByteIOContext *s)
411 val |= get_byte(s) << 8;
412 val |= get_byte(s) << 16;
413 val |= get_byte(s) << 24;
417 uint64_t get_le64(ByteIOContext *s)
420 val = (uint64_t)get_le32(s);
421 val |= (uint64_t)get_le32(s) << 32;
425 unsigned int get_be16(ByteIOContext *s)
428 val = get_byte(s) << 8;
433 unsigned int get_be32(ByteIOContext *s)
436 val = get_byte(s) << 24;
437 val |= get_byte(s) << 16;
438 val |= get_byte(s) << 8;
443 double get_be64_double(ByteIOContext *s)
454 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
459 while ((c = get_byte(s))) {
464 buf[i] = 0; /* Ensure null terminated, but may be truncated */
469 uint64_t get_be64(ByteIOContext *s)
472 val = (uint64_t)get_be32(s) << 32;
473 val |= (uint64_t)get_be32(s);
477 /* link with avio functions */
479 #ifdef CONFIG_ENCODERS
480 static int url_write_packet(void *opaque, uint8_t *buf, int buf_size)
482 URLContext *h = opaque;
483 return url_write(h, buf, buf_size);
486 #define url_write_packet NULL
487 #endif //CONFIG_ENCODERS
489 static int url_read_packet(void *opaque, uint8_t *buf, int buf_size)
491 URLContext *h = opaque;
492 return url_read(h, buf, buf_size);
495 static offset_t url_seek_packet(void *opaque, offset_t offset, int whence)
497 URLContext *h = opaque;
498 return url_seek(h, offset, whence);
502 int url_fdopen(ByteIOContext *s, URLContext *h)
505 int buffer_size, max_packet_size;
508 max_packet_size = url_get_max_packet_size(h);
509 if (max_packet_size) {
510 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
512 buffer_size = IO_BUFFER_SIZE;
514 buffer = av_malloc(buffer_size);
518 if (init_put_byte(s, buffer, buffer_size,
519 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
520 url_read_packet, url_write_packet, url_seek_packet) < 0) {
524 s->is_streamed = h->is_streamed;
525 s->max_packet_size = max_packet_size;
529 /* XXX: must be called before any I/O */
530 int url_setbufsize(ByteIOContext *s, int buf_size)
533 buffer = av_malloc(buf_size);
539 s->buffer_size = buf_size;
544 s->buf_end = buffer + buf_size;
548 /* NOTE: when opened as read/write, the buffers are only used for
550 int url_fopen(ByteIOContext *s, const char *filename, int flags)
555 err = url_open(&h, filename, flags);
558 err = url_fdopen(s, h);
566 int url_fclose(ByteIOContext *s)
568 URLContext *h = s->opaque;
571 memset(s, 0, sizeof(ByteIOContext));
575 URLContext *url_fileno(ByteIOContext *s)
580 #ifdef CONFIG_ENCODERS
581 /* XXX: currently size is limited */
582 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
589 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
591 put_buffer(s, buf, strlen(buf));
594 #endif //CONFIG_ENCODERS
596 /* note: unlike fgets, the EOL character is not returned and a whole
597 line is parsed. return NULL if first char read was EOF */
598 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
608 if (c == EOF || c == '\n')
610 if ((q - buf) < buf_size - 1)
620 * Return the maximum packet size associated to packetized buffered file
621 * handle. If the file is not packetized (stream like http or file on
622 * disk), then 0 is returned.
624 * @param h buffered file handle
625 * @return maximum packet size in bytes
627 int url_fget_max_packet_size(ByteIOContext *s)
629 return s->max_packet_size;
632 #ifdef CONFIG_ENCODERS
633 /* buffer handling */
634 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags)
636 return init_put_byte(s, buf, buf_size,
637 (flags & URL_WRONLY || flags & URL_RDWR),
638 NULL, NULL, NULL, NULL);
641 /* return the written or read size */
642 int url_close_buf(ByteIOContext *s)
645 return s->buf_ptr - s->buffer;
648 /* output in a dynamic buffer */
650 typedef struct DynBuffer {
651 int pos, size, allocated_size;
654 uint8_t io_buffer[1];
657 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
659 DynBuffer *d = opaque;
660 int new_size, new_allocated_size;
662 /* reallocate buffer if needed */
663 new_size = d->pos + buf_size;
664 new_allocated_size = d->allocated_size;
665 if(new_size < d->pos || new_size > INT_MAX/2)
667 while (new_size > new_allocated_size) {
668 if (!new_allocated_size)
669 new_allocated_size = new_size;
671 new_allocated_size += new_allocated_size / 2 + 1;
674 if (new_allocated_size > d->allocated_size) {
675 d->buffer = av_realloc(d->buffer, new_allocated_size);
676 if(d->buffer == NULL)
678 d->allocated_size = new_allocated_size;
680 memcpy(d->buffer + d->pos, buf, buf_size);
682 if (d->pos > d->size)
687 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
689 unsigned char buf1[4];
692 /* packetized write: output the header */
693 buf1[0] = (buf_size >> 24);
694 buf1[1] = (buf_size >> 16);
695 buf1[2] = (buf_size >> 8);
696 buf1[3] = (buf_size);
697 ret= dyn_buf_write(opaque, buf1, 4);
702 return dyn_buf_write(opaque, buf, buf_size);
705 static offset_t dyn_buf_seek(void *opaque, offset_t offset, int whence)
707 DynBuffer *d = opaque;
709 if (whence == SEEK_CUR)
711 else if (whence == SEEK_END)
713 if (offset < 0 || offset > 0x7fffffffLL)
719 static int url_open_dyn_buf_internal(ByteIOContext *s, int max_packet_size)
722 int io_buffer_size, ret;
725 io_buffer_size = max_packet_size;
727 io_buffer_size = 1024;
729 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
731 d = av_malloc(sizeof(DynBuffer) + io_buffer_size);
734 d->io_buffer_size = io_buffer_size;
738 d->allocated_size = 0;
739 ret = init_put_byte(s, d->io_buffer, io_buffer_size,
741 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
742 max_packet_size ? NULL : dyn_buf_seek);
744 s->max_packet_size = max_packet_size;
750 * Open a write only memory stream.
752 * @param s new IO context
753 * @return zero if no error.
755 int url_open_dyn_buf(ByteIOContext *s)
757 return url_open_dyn_buf_internal(s, 0);
761 * Open a write only packetized memory stream with a maximum packet
762 * size of 'max_packet_size'. The stream is stored in a memory buffer
763 * with a big endian 4 byte header giving the packet size in bytes.
765 * @param s new IO context
766 * @param max_packet_size maximum packet size (must be > 0)
767 * @return zero if no error.
769 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size)
771 if (max_packet_size <= 0)
773 return url_open_dyn_buf_internal(s, max_packet_size);
777 * Return the written size and a pointer to the buffer. The buffer
778 * must be freed with av_free().
779 * @param s IO context
780 * @param pointer to a byte buffer
781 * @return the length of the byte buffer
783 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
785 DynBuffer *d = s->opaque;
790 *pbuffer = d->buffer;
795 #endif //CONFIG_ENCODERS