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
22 #include "libavutil/crc.h"
23 #include "libavutil/intreadwrite.h"
28 #define IO_BUFFER_SIZE 32768
30 static void fill_buffer(ByteIOContext *s);
31 #if LIBAVFORMAT_VERSION_MAJOR >= 53
32 static int url_resetbuf(ByteIOContext *s, int flags);
35 int init_put_byte(ByteIOContext *s,
36 unsigned char *buffer,
40 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
41 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
42 int64_t (*seek)(void *opaque, int64_t offset, int whence))
45 s->buffer_size = buffer_size;
48 url_resetbuf(s, write_flag ? URL_WRONLY : URL_RDONLY);
49 s->write_packet = write_packet;
50 s->read_packet = read_packet;
57 s->max_packet_size = 0;
58 s->update_checksum= NULL;
59 if(!read_packet && !write_flag){
61 s->buf_end = s->buffer + buffer_size;
68 ByteIOContext *av_alloc_put_byte(
69 unsigned char *buffer,
73 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
74 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
75 int64_t (*seek)(void *opaque, int64_t offset, int whence))
77 ByteIOContext *s = av_mallocz(sizeof(ByteIOContext));
78 init_put_byte(s, buffer, buffer_size, write_flag, opaque,
79 read_packet, write_packet, seek);
83 static void flush_buffer(ByteIOContext *s)
85 if (s->buf_ptr > s->buffer) {
86 if (s->write_packet && !s->error){
87 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
92 if(s->update_checksum){
93 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
94 s->checksum_ptr= s->buffer;
96 s->pos += s->buf_ptr - s->buffer;
98 s->buf_ptr = s->buffer;
101 void put_byte(ByteIOContext *s, int b)
104 if (s->buf_ptr >= s->buf_end)
108 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
111 int len = FFMIN(s->buf_end - s->buf_ptr, size);
112 memcpy(s->buf_ptr, buf, len);
115 if (s->buf_ptr >= s->buf_end)
123 void put_flush_packet(ByteIOContext *s)
129 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence)
133 int force = whence & AVSEEK_FORCE;
134 whence &= ~AVSEEK_FORCE;
137 return AVERROR(EINVAL);
139 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
141 if (whence != SEEK_CUR && whence != SEEK_SET)
142 return AVERROR(EINVAL);
144 if (whence == SEEK_CUR) {
145 offset1 = pos + (s->buf_ptr - s->buffer);
150 offset1 = offset - pos;
151 if (!s->must_flush &&
152 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
153 /* can do the seek inside the buffer */
154 s->buf_ptr = s->buffer + offset1;
155 } else if(s->is_streamed && !s->write_flag && offset1 >= 0 &&
156 (whence != SEEK_END || force)) {
157 while(s->pos < offset && !s->eof_reached)
161 s->buf_ptr = s->buf_end + offset - s->pos;
165 #if CONFIG_MUXERS || CONFIG_NETWORK
170 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
172 return AVERROR(EPIPE);
173 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
176 s->buf_end = s->buffer;
177 s->buf_ptr = s->buffer;
184 void url_fskip(ByteIOContext *s, int64_t offset)
186 url_fseek(s, offset, SEEK_CUR);
189 int64_t url_ftell(ByteIOContext *s)
191 return url_fseek(s, 0, SEEK_CUR);
194 int64_t url_fsize(ByteIOContext *s)
199 return AVERROR(EINVAL);
202 return AVERROR(ENOSYS);
203 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
205 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
208 s->seek(s->opaque, s->pos, SEEK_SET);
213 int url_feof(ByteIOContext *s)
217 return s->eof_reached;
220 int url_ferror(ByteIOContext *s)
227 void put_le32(ByteIOContext *s, unsigned int val)
230 put_byte(s, val >> 8);
231 put_byte(s, val >> 16);
232 put_byte(s, val >> 24);
235 void put_be32(ByteIOContext *s, unsigned int val)
237 put_byte(s, val >> 24);
238 put_byte(s, val >> 16);
239 put_byte(s, val >> 8);
243 void put_strz(ByteIOContext *s, const char *str)
246 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
251 void put_le64(ByteIOContext *s, uint64_t val)
253 put_le32(s, (uint32_t)(val & 0xffffffff));
254 put_le32(s, (uint32_t)(val >> 32));
257 void put_be64(ByteIOContext *s, uint64_t val)
259 put_be32(s, (uint32_t)(val >> 32));
260 put_be32(s, (uint32_t)(val & 0xffffffff));
263 void put_le16(ByteIOContext *s, unsigned int val)
266 put_byte(s, val >> 8);
269 void put_be16(ByteIOContext *s, unsigned int val)
271 put_byte(s, val >> 8);
275 void put_le24(ByteIOContext *s, unsigned int val)
277 put_le16(s, val & 0xffff);
278 put_byte(s, val >> 16);
281 void put_be24(ByteIOContext *s, unsigned int val)
283 put_be16(s, val >> 8);
287 void put_tag(ByteIOContext *s, const char *tag)
296 static void fill_buffer(ByteIOContext *s)
298 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
299 int len= s->buffer_size - (dst - s->buffer);
300 int max_buffer_size = s->max_packet_size ? s->max_packet_size : IO_BUFFER_SIZE;
302 assert(s->buf_ptr == s->buf_end);
304 /* no need to do anything if EOF already reached */
308 if(s->update_checksum && dst == s->buffer){
309 if(s->buf_end > s->checksum_ptr)
310 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
311 s->checksum_ptr= s->buffer;
314 /* make buffer smaller in case it ended up large after probing */
315 if (s->buffer_size > max_buffer_size) {
316 url_setbufsize(s, max_buffer_size);
318 s->checksum_ptr = dst = s->buffer;
319 len = s->buffer_size;
323 len = s->read_packet(s->opaque, dst, len);
327 /* do not modify buffer if EOF reached so that a seek back can
328 be done without rereading data */
335 s->buf_end = dst + len;
339 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
342 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
345 unsigned long get_checksum(ByteIOContext *s)
347 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
348 s->update_checksum= NULL;
352 void init_checksum(ByteIOContext *s,
353 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
354 unsigned long checksum)
356 s->update_checksum= update_checksum;
357 if(s->update_checksum){
358 s->checksum= checksum;
359 s->checksum_ptr= s->buf_ptr;
363 /* XXX: put an inline version */
364 int get_byte(ByteIOContext *s)
366 if (s->buf_ptr < s->buf_end) {
367 return *s->buf_ptr++;
370 if (s->buf_ptr < s->buf_end)
371 return *s->buf_ptr++;
377 int url_fgetc(ByteIOContext *s)
379 if (s->buf_ptr < s->buf_end) {
380 return *s->buf_ptr++;
383 if (s->buf_ptr < s->buf_end)
384 return *s->buf_ptr++;
390 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
396 len = s->buf_end - s->buf_ptr;
400 if(size > s->buffer_size && !s->update_checksum){
402 len = s->read_packet(s->opaque, buf, size);
404 /* do not modify buffer if EOF reached so that a seek back can
405 be done without rereading data */
414 s->buf_ptr = s->buffer;
415 s->buf_end = s->buffer/* + len*/;
419 len = s->buf_end - s->buf_ptr;
424 memcpy(buf, s->buf_ptr, len);
431 if (url_ferror(s)) return url_ferror(s);
432 if (url_feof(s)) return AVERROR_EOF;
437 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
444 len = s->buf_end - s->buf_ptr;
447 len = s->buf_end - s->buf_ptr;
451 memcpy(buf, s->buf_ptr, len);
454 if (url_ferror(s)) return url_ferror(s);
455 if (url_feof(s)) return AVERROR_EOF;
460 unsigned int get_le16(ByteIOContext *s)
464 val |= get_byte(s) << 8;
468 unsigned int get_le24(ByteIOContext *s)
472 val |= get_byte(s) << 16;
476 unsigned int get_le32(ByteIOContext *s)
480 val |= get_le16(s) << 16;
484 uint64_t get_le64(ByteIOContext *s)
487 val = (uint64_t)get_le32(s);
488 val |= (uint64_t)get_le32(s) << 32;
492 unsigned int get_be16(ByteIOContext *s)
495 val = get_byte(s) << 8;
500 unsigned int get_be24(ByteIOContext *s)
503 val = get_be16(s) << 8;
507 unsigned int get_be32(ByteIOContext *s)
510 val = get_be16(s) << 16;
515 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
520 while ((c = get_byte(s))) {
525 buf[i] = 0; /* Ensure null terminated, but may be truncated */
530 uint64_t get_be64(ByteIOContext *s)
533 val = (uint64_t)get_be32(s) << 32;
534 val |= (uint64_t)get_be32(s);
538 uint64_t ff_get_v(ByteIOContext *bc){
544 val= (val<<7) + (tmp&127);
549 int url_fdopen(ByteIOContext **s, URLContext *h)
552 int buffer_size, max_packet_size;
554 max_packet_size = url_get_max_packet_size(h);
555 if (max_packet_size) {
556 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
558 buffer_size = IO_BUFFER_SIZE;
560 buffer = av_malloc(buffer_size);
562 return AVERROR(ENOMEM);
564 *s = av_mallocz(sizeof(ByteIOContext));
567 return AVERROR(ENOMEM);
570 if (init_put_byte(*s, buffer, buffer_size,
571 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
572 url_read, url_write, url_seek) < 0) {
577 (*s)->is_streamed = h->is_streamed;
578 (*s)->max_packet_size = max_packet_size;
580 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
581 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
586 int url_setbufsize(ByteIOContext *s, int buf_size)
589 buffer = av_malloc(buf_size);
591 return AVERROR(ENOMEM);
595 s->buffer_size = buf_size;
597 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
601 #if LIBAVFORMAT_VERSION_MAJOR < 53
602 int url_resetbuf(ByteIOContext *s, int flags)
604 static int url_resetbuf(ByteIOContext *s, int flags)
607 #if LIBAVFORMAT_VERSION_MAJOR < 53
608 if (flags & URL_RDWR)
609 return AVERROR(EINVAL);
611 assert(flags == URL_WRONLY || flags == URL_RDONLY);
614 if (flags & URL_WRONLY) {
615 s->buf_end = s->buffer + s->buffer_size;
618 s->buf_end = s->buffer;
624 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size)
626 int64_t buffer_start;
628 int overlap, new_size;
631 return AVERROR(EINVAL);
633 buffer_size = s->buf_end - s->buffer;
635 /* the buffers must touch or overlap */
636 if ((buffer_start = s->pos - buffer_size) > buf_size)
637 return AVERROR(EINVAL);
639 overlap = buf_size - buffer_start;
640 new_size = buf_size + buffer_size - overlap;
642 if (new_size > buf_size) {
643 if (!(buf = av_realloc(buf, new_size)))
644 return AVERROR(ENOMEM);
646 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
651 s->buf_ptr = s->buffer = buf;
652 s->pos = s->buffer_size = buf_size;
653 s->buf_end = s->buf_ptr + buf_size;
660 int url_fopen(ByteIOContext **s, const char *filename, int flags)
665 err = url_open(&h, filename, flags);
668 err = url_fdopen(s, h);
676 int url_fclose(ByteIOContext *s)
678 URLContext *h = s->opaque;
685 URLContext *url_fileno(ByteIOContext *s)
691 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
698 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
700 put_buffer(s, buf, strlen(buf));
703 #endif //CONFIG_MUXERS
705 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
715 if (c == EOF || c == '\n')
717 if ((q - buf) < buf_size - 1)
726 int url_fget_max_packet_size(ByteIOContext *s)
728 return s->max_packet_size;
731 int av_url_read_fpause(ByteIOContext *s, int pause)
734 return AVERROR(ENOSYS);
735 return s->read_pause(s->opaque, pause);
738 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
739 int64_t timestamp, int flags)
741 URLContext *h = s->opaque;
744 return AVERROR(ENOSYS);
745 ret = s->read_seek(h, stream_index, timestamp, flags);
748 s->buf_ptr = s->buf_end; // Flush buffer
749 pos = s->seek(h, 0, SEEK_CUR);
752 else if (pos != AVERROR(ENOSYS))
758 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
759 * back to the server even if CONFIG_MUXERS is false. */
760 #if CONFIG_MUXERS || CONFIG_NETWORK
761 /* buffer handling */
762 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
765 *s = av_mallocz(sizeof(ByteIOContext));
767 return AVERROR(ENOMEM);
768 ret = init_put_byte(*s, buf, buf_size,
769 (flags & URL_WRONLY || flags & URL_RDWR),
770 NULL, NULL, NULL, NULL);
776 int url_close_buf(ByteIOContext *s)
779 return s->buf_ptr - s->buffer;
782 /* output in a dynamic buffer */
784 typedef struct DynBuffer {
785 int pos, size, allocated_size;
788 uint8_t io_buffer[1];
791 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
793 DynBuffer *d = opaque;
794 unsigned new_size, new_allocated_size;
796 /* reallocate buffer if needed */
797 new_size = d->pos + buf_size;
798 new_allocated_size = d->allocated_size;
799 if(new_size < d->pos || new_size > INT_MAX/2)
801 while (new_size > new_allocated_size) {
802 if (!new_allocated_size)
803 new_allocated_size = new_size;
805 new_allocated_size += new_allocated_size / 2 + 1;
808 if (new_allocated_size > d->allocated_size) {
809 d->buffer = av_realloc(d->buffer, new_allocated_size);
810 if(d->buffer == NULL)
811 return AVERROR(ENOMEM);
812 d->allocated_size = new_allocated_size;
814 memcpy(d->buffer + d->pos, buf, buf_size);
816 if (d->pos > d->size)
821 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
823 unsigned char buf1[4];
826 /* packetized write: output the header */
827 AV_WB32(buf1, buf_size);
828 ret= dyn_buf_write(opaque, buf1, 4);
833 return dyn_buf_write(opaque, buf, buf_size);
836 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
838 DynBuffer *d = opaque;
840 if (whence == SEEK_CUR)
842 else if (whence == SEEK_END)
844 if (offset < 0 || offset > 0x7fffffffLL)
850 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
854 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
856 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
858 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
860 return AVERROR(ENOMEM);
861 *s = av_mallocz(sizeof(ByteIOContext));
864 return AVERROR(ENOMEM);
866 d->io_buffer_size = io_buffer_size;
867 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
869 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
870 max_packet_size ? NULL : dyn_buf_seek);
872 (*s)->max_packet_size = max_packet_size;
880 int url_open_dyn_buf(ByteIOContext **s)
882 return url_open_dyn_buf_internal(s, 0);
885 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
887 if (max_packet_size <= 0)
889 return url_open_dyn_buf_internal(s, max_packet_size);
892 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
894 DynBuffer *d = s->opaque;
896 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
899 /* don't attempt to pad fixed-size packet buffers */
900 if (!s->max_packet_size) {
901 put_buffer(s, padbuf, sizeof(padbuf));
902 padding = FF_INPUT_BUFFER_PADDING_SIZE;
907 *pbuffer = d->buffer;
911 return size - padding;
913 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */