2 * Buffered I/O for ffmpeg system
3 * Copyright (c) 2000,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
25 #define IO_BUFFER_SIZE 32768
27 static void fill_buffer(ByteIOContext *s);
29 int init_put_byte(ByteIOContext *s,
30 unsigned char *buffer,
34 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
35 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
36 offset_t (*seek)(void *opaque, offset_t offset, int whence))
39 s->buffer_size = buffer_size;
41 s->write_flag = write_flag;
45 s->buf_end = buffer + buffer_size;
47 s->write_packet = write_packet;
48 s->read_packet = read_packet;
55 s->max_packet_size = 0;
56 s->update_checksum= NULL;
57 if(!read_packet && !write_flag){
59 s->buf_end = s->buffer + buffer_size;
64 static void flush_buffer(ByteIOContext *s)
66 if (s->buf_ptr > s->buffer) {
67 if (s->write_packet && !s->error){
68 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
73 if(s->update_checksum){
74 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
75 s->checksum_ptr= s->buffer;
77 s->pos += s->buf_ptr - s->buffer;
79 s->buf_ptr = s->buffer;
82 void put_byte(ByteIOContext *s, int b)
85 if (s->buf_ptr >= s->buf_end)
89 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
94 len = (s->buf_end - s->buf_ptr);
97 memcpy(s->buf_ptr, buf, len);
100 if (s->buf_ptr >= s->buf_end)
108 void put_flush_packet(ByteIOContext *s)
114 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence)
117 offset_t pos= s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
119 if (whence != SEEK_CUR && whence != SEEK_SET)
122 if (whence == SEEK_CUR) {
123 offset1 = pos + (s->buf_ptr - s->buffer);
128 offset1 = offset - pos;
129 if (!s->must_flush &&
130 offset1 >= 0 && offset1 < (s->buf_end - s->buffer)) {
131 /* can do the seek inside the buffer */
132 s->buf_ptr = s->buffer + offset1;
133 } else if(s->is_streamed && !s->write_flag &&
134 offset1 >= 0 && offset1 < (s->buf_end - s->buffer) + (1<<16)){
135 while(s->pos < offset && !s->eof_reached)
137 s->buf_ptr = s->buf_end + offset - s->pos;
139 #if defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK)
144 #endif /* defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK) */
146 s->buf_end = s->buffer;
148 s->buf_ptr = s->buffer;
149 if (!s->seek || s->seek(s->opaque, offset, SEEK_SET) == (offset_t)-EPIPE)
157 void url_fskip(ByteIOContext *s, offset_t offset)
159 url_fseek(s, offset, SEEK_CUR);
162 offset_t url_ftell(ByteIOContext *s)
164 return url_fseek(s, 0, SEEK_CUR);
167 offset_t url_fsize(ByteIOContext *s)
173 size = s->seek(s->opaque, -1, SEEK_END) + 1;
174 s->seek(s->opaque, s->pos, SEEK_SET);
178 int url_feof(ByteIOContext *s)
180 return s->eof_reached;
183 int url_ferror(ByteIOContext *s)
188 #if defined(CONFIG_MUXERS) || defined(CONFIG_PROTOCOLS)
189 void put_le32(ByteIOContext *s, unsigned int val)
192 put_byte(s, val >> 8);
193 put_byte(s, val >> 16);
194 put_byte(s, val >> 24);
197 void put_be32(ByteIOContext *s, unsigned int val)
199 put_byte(s, val >> 24);
200 put_byte(s, val >> 16);
201 put_byte(s, val >> 8);
205 void put_strz(ByteIOContext *s, const char *str)
208 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
213 void put_le64(ByteIOContext *s, uint64_t val)
215 put_le32(s, (uint32_t)(val & 0xffffffff));
216 put_le32(s, (uint32_t)(val >> 32));
219 void put_be64(ByteIOContext *s, uint64_t val)
221 put_be32(s, (uint32_t)(val >> 32));
222 put_be32(s, (uint32_t)(val & 0xffffffff));
225 void put_le16(ByteIOContext *s, unsigned int val)
228 put_byte(s, val >> 8);
231 void put_be16(ByteIOContext *s, unsigned int val)
233 put_byte(s, val >> 8);
237 void put_le24(ByteIOContext *s, unsigned int val)
239 put_le16(s, val & 0xffff);
240 put_byte(s, val >> 16);
243 void put_be24(ByteIOContext *s, unsigned int val)
245 put_be16(s, val >> 8);
249 void put_tag(ByteIOContext *s, const char *tag)
255 #endif //CONFIG_MUXERS || CONFIG_PROTOCOLS
259 static void fill_buffer(ByteIOContext *s)
263 /* no need to do anything if EOF already reached */
267 if(s->update_checksum){
268 if(s->buf_end > s->checksum_ptr)
269 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
270 s->checksum_ptr= s->buffer;
273 len = s->read_packet(s->opaque, s->buffer, s->buffer_size);
275 /* do not modify buffer if EOF reached so that a seek back can
276 be done without rereading data */
282 s->buf_ptr = s->buffer;
283 s->buf_end = s->buffer + len;
287 unsigned long get_checksum(ByteIOContext *s){
288 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
289 s->update_checksum= NULL;
293 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum){
294 s->update_checksum= update_checksum;
295 if(s->update_checksum){
296 s->checksum= checksum;
297 s->checksum_ptr= s->buf_ptr;
301 /* NOTE: return 0 if EOF, so you cannot use it if EOF handling is
303 /* XXX: put an inline version */
304 int get_byte(ByteIOContext *s)
306 if (s->buf_ptr < s->buf_end) {
307 return *s->buf_ptr++;
310 if (s->buf_ptr < s->buf_end)
311 return *s->buf_ptr++;
317 /* NOTE: return URL_EOF (-1) if EOF */
318 int url_fgetc(ByteIOContext *s)
320 if (s->buf_ptr < s->buf_end) {
321 return *s->buf_ptr++;
324 if (s->buf_ptr < s->buf_end)
325 return *s->buf_ptr++;
331 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
337 len = s->buf_end - s->buf_ptr;
341 if(size > s->buffer_size && !s->update_checksum){
342 len = s->read_packet(s->opaque, buf, size);
344 /* do not modify buffer if EOF reached so that a seek back can
345 be done without rereading data */
354 s->buf_ptr = s->buffer;
355 s->buf_end = s->buffer/* + len*/;
359 len = s->buf_end - s->buf_ptr;
364 memcpy(buf, s->buf_ptr, len);
373 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
380 len = s->buf_end - s->buf_ptr;
383 len = s->buf_end - s->buf_ptr;
387 memcpy(buf, s->buf_ptr, len);
392 unsigned int get_le16(ByteIOContext *s)
396 val |= get_byte(s) << 8;
400 unsigned int get_le24(ByteIOContext *s)
404 val |= get_byte(s) << 16;
408 unsigned int get_le32(ByteIOContext *s)
412 val |= get_le16(s) << 16;
416 uint64_t get_le64(ByteIOContext *s)
419 val = (uint64_t)get_le32(s);
420 val |= (uint64_t)get_le32(s) << 32;
424 unsigned int get_be16(ByteIOContext *s)
427 val = get_byte(s) << 8;
432 unsigned int get_be24(ByteIOContext *s)
435 val = get_be16(s) << 8;
439 unsigned int get_be32(ByteIOContext *s)
442 val = get_be16(s) << 16;
447 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
452 while ((c = get_byte(s))) {
457 buf[i] = 0; /* Ensure null terminated, but may be truncated */
462 uint64_t get_be64(ByteIOContext *s)
465 val = (uint64_t)get_be32(s) << 32;
466 val |= (uint64_t)get_be32(s);
470 /* link with avio functions */
473 static int url_write_packet(void *opaque, uint8_t *buf, int buf_size)
475 URLContext *h = opaque;
476 return url_write(h, buf, buf_size);
479 #define url_write_packet NULL
480 #endif //CONFIG_MUXERS
482 static int url_read_packet(void *opaque, uint8_t *buf, int buf_size)
484 URLContext *h = opaque;
485 return url_read(h, buf, buf_size);
488 static offset_t url_seek_packet(void *opaque, offset_t offset, int whence)
490 URLContext *h = opaque;
491 return url_seek(h, offset, whence);
495 int url_fdopen(ByteIOContext *s, URLContext *h)
498 int buffer_size, max_packet_size;
501 max_packet_size = url_get_max_packet_size(h);
502 if (max_packet_size) {
503 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
505 buffer_size = IO_BUFFER_SIZE;
507 buffer = av_malloc(buffer_size);
511 if (init_put_byte(s, buffer, buffer_size,
512 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
513 url_read_packet, url_write_packet, url_seek_packet) < 0) {
517 s->is_streamed = h->is_streamed;
518 s->max_packet_size = max_packet_size;
522 /* XXX: must be called before any I/O */
523 int url_setbufsize(ByteIOContext *s, int buf_size)
526 buffer = av_malloc(buf_size);
532 s->buffer_size = buf_size;
537 s->buf_end = buffer + buf_size;
541 /* NOTE: when opened as read/write, the buffers are only used for
543 int url_fopen(ByteIOContext *s, const char *filename, int flags)
548 err = url_open(&h, filename, flags);
551 err = url_fdopen(s, h);
559 int url_fclose(ByteIOContext *s)
561 URLContext *h = s->opaque;
564 memset(s, 0, sizeof(ByteIOContext));
568 URLContext *url_fileno(ByteIOContext *s)
574 /* XXX: currently size is limited */
575 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
582 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
584 put_buffer(s, buf, strlen(buf));
587 #endif //CONFIG_MUXERS
589 /* note: unlike fgets, the EOL character is not returned and a whole
590 line is parsed. return NULL if first char read was EOF */
591 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
601 if (c == EOF || c == '\n')
603 if ((q - buf) < buf_size - 1)
613 * Return the maximum packet size associated to packetized buffered file
614 * handle. If the file is not packetized (stream like http or file on
615 * disk), then 0 is returned.
617 * @param h buffered file handle
618 * @return maximum packet size in bytes
620 int url_fget_max_packet_size(ByteIOContext *s)
622 return s->max_packet_size;
625 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
626 * back to the server even if CONFIG_MUXERS is not set. */
627 #if defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK)
628 /* buffer handling */
629 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags)
631 return init_put_byte(s, buf, buf_size,
632 (flags & URL_WRONLY || flags & URL_RDWR),
633 NULL, NULL, NULL, NULL);
636 /* return the written or read size */
637 int url_close_buf(ByteIOContext *s)
640 return s->buf_ptr - s->buffer;
643 /* output in a dynamic buffer */
645 typedef struct DynBuffer {
646 int pos, size, allocated_size;
649 uint8_t io_buffer[1];
652 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
654 DynBuffer *d = opaque;
655 int new_size, new_allocated_size;
657 /* reallocate buffer if needed */
658 new_size = d->pos + buf_size;
659 new_allocated_size = d->allocated_size;
660 if(new_size < d->pos || new_size > INT_MAX/2)
662 while (new_size > new_allocated_size) {
663 if (!new_allocated_size)
664 new_allocated_size = new_size;
666 new_allocated_size += new_allocated_size / 2 + 1;
669 if (new_allocated_size > d->allocated_size) {
670 d->buffer = av_realloc(d->buffer, new_allocated_size);
671 if(d->buffer == NULL)
673 d->allocated_size = new_allocated_size;
675 memcpy(d->buffer + d->pos, buf, buf_size);
677 if (d->pos > d->size)
682 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
684 unsigned char buf1[4];
687 /* packetized write: output the header */
688 buf1[0] = (buf_size >> 24);
689 buf1[1] = (buf_size >> 16);
690 buf1[2] = (buf_size >> 8);
691 buf1[3] = (buf_size);
692 ret= dyn_buf_write(opaque, buf1, 4);
697 return dyn_buf_write(opaque, buf, buf_size);
700 static offset_t dyn_buf_seek(void *opaque, offset_t offset, int whence)
702 DynBuffer *d = opaque;
704 if (whence == SEEK_CUR)
706 else if (whence == SEEK_END)
708 if (offset < 0 || offset > 0x7fffffffLL)
714 static int url_open_dyn_buf_internal(ByteIOContext *s, int max_packet_size)
717 int io_buffer_size, ret;
720 io_buffer_size = max_packet_size;
722 io_buffer_size = 1024;
724 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
726 d = av_malloc(sizeof(DynBuffer) + io_buffer_size);
729 d->io_buffer_size = io_buffer_size;
733 d->allocated_size = 0;
734 ret = init_put_byte(s, d->io_buffer, io_buffer_size,
736 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
737 max_packet_size ? NULL : dyn_buf_seek);
739 s->max_packet_size = max_packet_size;
745 * Open a write only memory stream.
747 * @param s new IO context
748 * @return zero if no error.
750 int url_open_dyn_buf(ByteIOContext *s)
752 return url_open_dyn_buf_internal(s, 0);
756 * Open a write only packetized memory stream with a maximum packet
757 * size of 'max_packet_size'. The stream is stored in a memory buffer
758 * with a big endian 4 byte header giving the packet size in bytes.
760 * @param s new IO context
761 * @param max_packet_size maximum packet size (must be > 0)
762 * @return zero if no error.
764 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size)
766 if (max_packet_size <= 0)
768 return url_open_dyn_buf_internal(s, max_packet_size);
772 * Return the written size and a pointer to the buffer. The buffer
773 * must be freed with av_free().
774 * @param s IO context
775 * @param pointer to a byte buffer
776 * @return the length of the byte buffer
778 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
780 DynBuffer *d = s->opaque;
785 *pbuffer = d->buffer;
790 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */