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/dict.h"
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/log.h"
26 #include "libavutil/opt.h"
27 #include "libavutil/avassert.h"
30 #include "avio_internal.h"
35 #define IO_BUFFER_SIZE 32768
38 * Do seeks within this distance ahead of the current buffer by skipping
39 * data instead of calling the protocol seek function, for seekable
42 #define SHORT_SEEK_THRESHOLD 4096
44 static void *ffio_url_child_next(void *obj, void *prev)
47 return prev ? NULL : s->opaque;
50 static const AVClass *ffio_url_child_class_next(const AVClass *prev)
52 return prev ? NULL : &ffurl_context_class;
55 static const AVOption ffio_url_options[] = {
59 const AVClass ffio_url_class = {
60 .class_name = "AVIOContext",
61 .item_name = av_default_item_name,
62 .version = LIBAVUTIL_VERSION_INT,
63 .option = ffio_url_options,
64 .child_next = ffio_url_child_next,
65 .child_class_next = ffio_url_child_class_next,
68 static void fill_buffer(AVIOContext *s);
69 static int url_resetbuf(AVIOContext *s, int flags);
71 int ffio_init_context(AVIOContext *s,
72 unsigned char *buffer,
76 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
77 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
78 int64_t (*seek)(void *opaque, int64_t offset, int whence))
81 s->buffer_size = buffer_size;
86 url_resetbuf(s, write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
88 s->write_packet = write_packet;
89 s->read_packet = read_packet;
95 s->seekable = seek ? AVIO_SEEKABLE_NORMAL : 0;
96 s->max_packet_size = 0;
97 s->update_checksum = NULL;
99 if (!read_packet && !write_flag) {
100 s->pos = buffer_size;
101 s->buf_end = s->buffer + buffer_size;
103 s->read_pause = NULL;
109 AVIOContext *avio_alloc_context(
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 int64_t (*seek)(void *opaque, int64_t offset, int whence))
118 AVIOContext *s = av_mallocz(sizeof(AVIOContext));
121 ffio_init_context(s, buffer, buffer_size, write_flag, opaque,
122 read_packet, write_packet, seek);
126 static void writeout(AVIOContext *s, const uint8_t *data, int len)
128 if (s->write_packet && !s->error) {
129 int ret = s->write_packet(s->opaque, (uint8_t *)data, len);
134 s->writeout_count ++;
138 static void flush_buffer(AVIOContext *s)
140 if (s->buf_ptr > s->buffer) {
141 writeout(s, s->buffer, s->buf_ptr - s->buffer);
142 if (s->update_checksum) {
143 s->checksum = s->update_checksum(s->checksum, s->checksum_ptr,
144 s->buf_ptr - s->checksum_ptr);
145 s->checksum_ptr = s->buffer;
148 s->buf_ptr = s->buffer;
151 void avio_w8(AVIOContext *s, int b)
153 av_assert2(b>=-128 && b<=255);
155 if (s->buf_ptr >= s->buf_end)
159 void ffio_fill(AVIOContext *s, int b, int count)
162 int len = FFMIN(s->buf_end - s->buf_ptr, count);
163 memset(s->buf_ptr, b, len);
166 if (s->buf_ptr >= s->buf_end)
173 void avio_write(AVIOContext *s, const unsigned char *buf, int size)
175 if (s->direct && !s->update_checksum) {
177 writeout(s, buf, size);
181 int len = FFMIN(s->buf_end - s->buf_ptr, size);
182 memcpy(s->buf_ptr, buf, len);
185 if (s->buf_ptr >= s->buf_end)
193 void avio_flush(AVIOContext *s)
199 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
203 int force = whence & AVSEEK_FORCE;
204 whence &= ~AVSEEK_FORCE;
207 return AVERROR(EINVAL);
209 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
211 if (whence != SEEK_CUR && whence != SEEK_SET)
212 return AVERROR(EINVAL);
214 if (whence == SEEK_CUR) {
215 offset1 = pos + (s->buf_ptr - s->buffer);
220 offset1 = offset - pos;
221 if (!s->must_flush && (!s->direct || !s->seek) &&
222 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
223 /* can do the seek inside the buffer */
224 s->buf_ptr = s->buffer + offset1;
225 } else if ((!s->seekable ||
226 offset1 <= s->buf_end + SHORT_SEEK_THRESHOLD - s->buffer) &&
227 !s->write_flag && offset1 >= 0 &&
228 (!s->direct || !s->seek) &&
229 (whence != SEEK_END || force)) {
230 while(s->pos < offset && !s->eof_reached)
234 s->buf_ptr = s->buf_end + offset - s->pos;
243 return AVERROR(EPIPE);
244 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
248 s->buf_end = s->buffer;
249 s->buf_ptr = s->buffer;
256 int64_t avio_skip(AVIOContext *s, int64_t offset)
258 return avio_seek(s, offset, SEEK_CUR);
261 int64_t avio_size(AVIOContext *s)
266 return AVERROR(EINVAL);
269 return AVERROR(ENOSYS);
270 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
272 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
275 s->seek(s->opaque, s->pos, SEEK_SET);
280 int url_feof(AVIOContext *s)
288 return s->eof_reached;
291 void avio_wl32(AVIOContext *s, unsigned int val)
293 avio_w8(s, (uint8_t) val );
294 avio_w8(s, (uint8_t)(val >> 8 ));
295 avio_w8(s, (uint8_t)(val >> 16));
296 avio_w8(s, val >> 24 );
299 void avio_wb32(AVIOContext *s, unsigned int val)
301 avio_w8(s, val >> 24 );
302 avio_w8(s, (uint8_t)(val >> 16));
303 avio_w8(s, (uint8_t)(val >> 8 ));
304 avio_w8(s, (uint8_t) val );
307 int avio_put_str(AVIOContext *s, const char *str)
312 avio_write(s, (const unsigned char *) str, len);
318 int avio_put_str16le(AVIOContext *s, const char *str)
320 const uint8_t *q = str;
328 GET_UTF8(ch, *q++, goto invalid;)
329 PUT_UTF16(ch, tmp, avio_wl16(s, tmp); ret += 2;)
332 av_log(s, AV_LOG_ERROR, "Invaid UTF8 sequence in avio_put_str16le\n");
333 err = AVERROR(EINVAL);
342 int ff_get_v_length(uint64_t val)
352 void ff_put_v(AVIOContext *bc, uint64_t val)
354 int i = ff_get_v_length(val);
357 avio_w8(bc, 128 | (uint8_t)(val >> (7*i)));
359 avio_w8(bc, val & 127);
362 void avio_wl64(AVIOContext *s, uint64_t val)
364 avio_wl32(s, (uint32_t)(val & 0xffffffff));
365 avio_wl32(s, (uint32_t)(val >> 32));
368 void avio_wb64(AVIOContext *s, uint64_t val)
370 avio_wb32(s, (uint32_t)(val >> 32));
371 avio_wb32(s, (uint32_t)(val & 0xffffffff));
374 void avio_wl16(AVIOContext *s, unsigned int val)
376 avio_w8(s, (uint8_t)val);
377 avio_w8(s, (int)val >> 8);
380 void avio_wb16(AVIOContext *s, unsigned int val)
382 avio_w8(s, (int)val >> 8);
383 avio_w8(s, (uint8_t)val);
386 void avio_wl24(AVIOContext *s, unsigned int val)
388 avio_wl16(s, val & 0xffff);
389 avio_w8(s, (int)val >> 16);
392 void avio_wb24(AVIOContext *s, unsigned int val)
394 avio_wb16(s, (int)val >> 8);
395 avio_w8(s, (uint8_t)val);
400 static void fill_buffer(AVIOContext *s)
402 int max_buffer_size = s->max_packet_size ?
403 s->max_packet_size : IO_BUFFER_SIZE;
404 uint8_t *dst = s->buf_end - s->buffer + max_buffer_size < s->buffer_size ?
405 s->buf_end : s->buffer;
406 int len = s->buffer_size - (dst - s->buffer);
408 /* can't fill the buffer without read_packet, just set EOF if appropriate */
409 if (!s->read_packet && s->buf_ptr >= s->buf_end)
412 /* no need to do anything if EOF already reached */
416 if (s->update_checksum && dst == s->buffer) {
417 if (s->buf_end > s->checksum_ptr)
418 s->checksum = s->update_checksum(s->checksum, s->checksum_ptr,
419 s->buf_end - s->checksum_ptr);
420 s->checksum_ptr = s->buffer;
423 /* make buffer smaller in case it ended up large after probing */
424 if (s->read_packet && s->buffer_size > max_buffer_size) {
425 if (dst == s->buffer) {
426 ffio_set_buf_size(s, max_buffer_size);
428 s->checksum_ptr = dst = s->buffer;
430 av_assert0(len >= max_buffer_size);
431 len = max_buffer_size;
435 len = s->read_packet(s->opaque, dst, len);
439 /* do not modify buffer if EOF reached so that a seek back can
440 be done without rereading data */
447 s->buf_end = dst + len;
448 s->bytes_read += len;
452 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
455 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
458 unsigned long ffio_get_checksum(AVIOContext *s)
460 s->checksum = s->update_checksum(s->checksum, s->checksum_ptr,
461 s->buf_ptr - s->checksum_ptr);
462 s->update_checksum = NULL;
466 void ffio_init_checksum(AVIOContext *s,
467 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
468 unsigned long checksum)
470 s->update_checksum = update_checksum;
471 if (s->update_checksum) {
472 s->checksum = checksum;
473 s->checksum_ptr = s->buf_ptr;
477 /* XXX: put an inline version */
478 int avio_r8(AVIOContext *s)
480 if (s->buf_ptr >= s->buf_end)
482 if (s->buf_ptr < s->buf_end)
483 return *s->buf_ptr++;
487 int avio_read(AVIOContext *s, unsigned char *buf, int size)
493 len = s->buf_end - s->buf_ptr;
496 if (len == 0 || s->write_flag) {
497 if((s->direct || size > s->buffer_size) && !s->update_checksum){
499 len = s->read_packet(s->opaque, buf, size);
501 /* do not modify buffer if EOF reached so that a seek back can
502 be done without rereading data */
509 s->bytes_read += len;
512 s->buf_ptr = s->buffer;
513 s->buf_end = s->buffer/* + len*/;
517 len = s->buf_end - s->buf_ptr;
522 memcpy(buf, s->buf_ptr, len);
529 if (s->error) return s->error;
530 if (url_feof(s)) return AVERROR_EOF;
535 int ffio_read_indirect(AVIOContext *s, unsigned char *buf, int size, const unsigned char **data)
537 if (s->buf_end - s->buf_ptr >= size && !s->write_flag) {
543 return avio_read(s, buf, size);
547 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
554 if (s->read_packet && s->write_flag) {
555 len = s->read_packet(s->opaque, buf, size);
561 len = s->buf_end - s->buf_ptr;
563 /* Reset the buf_end pointer to the start of the buffer, to make sure
564 * the fill_buffer call tries to read as much data as fits into the
565 * full buffer, instead of just what space is left after buf_end.
566 * This avoids returning partial packets at the end of the buffer,
567 * for packet based inputs.
569 s->buf_end = s->buf_ptr = s->buffer;
571 len = s->buf_end - s->buf_ptr;
575 memcpy(buf, s->buf_ptr, len);
578 if (s->error) return s->error;
579 if (url_feof(s)) return AVERROR_EOF;
584 unsigned int avio_rl16(AVIOContext *s)
588 val |= avio_r8(s) << 8;
592 unsigned int avio_rl24(AVIOContext *s)
596 val |= avio_r8(s) << 16;
600 unsigned int avio_rl32(AVIOContext *s)
604 val |= avio_rl16(s) << 16;
608 uint64_t avio_rl64(AVIOContext *s)
611 val = (uint64_t)avio_rl32(s);
612 val |= (uint64_t)avio_rl32(s) << 32;
616 unsigned int avio_rb16(AVIOContext *s)
619 val = avio_r8(s) << 8;
624 unsigned int avio_rb24(AVIOContext *s)
627 val = avio_rb16(s) << 8;
631 unsigned int avio_rb32(AVIOContext *s)
634 val = avio_rb16(s) << 16;
639 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
646 if (c && i < maxlen-1)
648 } while (c != '\n' && c);
654 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
659 return AVERROR(EINVAL);
660 // reserve 1 byte for terminating 0
661 buflen = FFMIN(buflen - 1, maxlen);
662 for (i = 0; i < buflen; i++)
663 if (!(buf[i] = avio_r8(s)))
666 for (; i < maxlen; i++)
672 #define GET_STR16(type, read) \
673 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
678 return AVERROR(EINVAL); \
679 while (ret + 1 < maxlen) {\
682 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
685 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
691 GET_STR16(le, avio_rl16)
692 GET_STR16(be, avio_rb16)
696 uint64_t avio_rb64(AVIOContext *s)
699 val = (uint64_t)avio_rb32(s) << 32;
700 val |= (uint64_t)avio_rb32(s);
704 uint64_t ffio_read_varlen(AVIOContext *bc){
710 val= (val<<7) + (tmp&127);
715 int ffio_fdopen(AVIOContext **s, URLContext *h)
718 int buffer_size, max_packet_size;
720 max_packet_size = h->max_packet_size;
721 if (max_packet_size) {
722 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
724 buffer_size = IO_BUFFER_SIZE;
726 buffer = av_malloc(buffer_size);
728 return AVERROR(ENOMEM);
730 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
731 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
734 return AVERROR(ENOMEM);
736 (*s)->direct = h->flags & AVIO_FLAG_DIRECT;
737 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
738 (*s)->max_packet_size = max_packet_size;
740 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
741 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
743 (*s)->av_class = &ffio_url_class;
747 int ffio_ensure_seekback(AVIOContext *s, int buf_size)
750 int max_buffer_size = s->max_packet_size ?
751 s->max_packet_size : IO_BUFFER_SIZE;
753 buf_size += s->buf_ptr - s->buffer + max_buffer_size;
755 if (buf_size < s->buffer_size || s->seekable)
757 av_assert0(!s->write_flag);
759 buffer = av_malloc(buf_size);
761 return AVERROR(ENOMEM);
763 memcpy(buffer, s->buffer, s->buffer_size);
765 s->buf_ptr = buffer + (s->buf_ptr - s->buffer);
766 s->buf_end = buffer + (s->buf_end - s->buffer);
768 s->buffer_size = buf_size;
772 int ffio_set_buf_size(AVIOContext *s, int buf_size)
775 buffer = av_malloc(buf_size);
777 return AVERROR(ENOMEM);
781 s->buffer_size = buf_size;
783 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
787 static int url_resetbuf(AVIOContext *s, int flags)
789 av_assert1(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
791 if (flags & AVIO_FLAG_WRITE) {
792 s->buf_end = s->buffer + s->buffer_size;
795 s->buf_end = s->buffer;
801 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **bufp, int buf_size)
803 int64_t buffer_start;
805 int overlap, new_size, alloc_size;
806 uint8_t *buf = *bufp;
810 return AVERROR(EINVAL);
813 buffer_size = s->buf_end - s->buffer;
815 /* the buffers must touch or overlap */
816 if ((buffer_start = s->pos - buffer_size) > buf_size) {
818 return AVERROR(EINVAL);
821 overlap = buf_size - buffer_start;
822 new_size = buf_size + buffer_size - overlap;
824 alloc_size = FFMAX(s->buffer_size, new_size);
825 if (alloc_size > buf_size)
826 if (!(buf = (*bufp) = av_realloc_f(buf, 1, alloc_size)))
827 return AVERROR(ENOMEM);
829 if (new_size > buf_size) {
830 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
835 s->buf_ptr = s->buffer = buf;
836 s->buffer_size = alloc_size;
838 s->buf_end = s->buf_ptr + buf_size;
845 int avio_open(AVIOContext **s, const char *filename, int flags)
847 return avio_open2(s, filename, flags, NULL, NULL);
850 int avio_open2(AVIOContext **s, const char *filename, int flags,
851 const AVIOInterruptCB *int_cb, AVDictionary **options)
856 err = ffurl_open(&h, filename, flags, int_cb, options);
859 err = ffio_fdopen(s, h);
867 int avio_close(AVIOContext *s)
876 av_freep(&s->buffer);
878 av_log(s, AV_LOG_DEBUG, "Statistics: %d seeks, %d writeouts\n", s->seek_count, s->writeout_count);
880 av_log(s, AV_LOG_DEBUG, "Statistics: %"PRId64" bytes read, %d seeks\n", s->bytes_read, s->seek_count);
882 return ffurl_close(h);
885 int avio_closep(AVIOContext **s)
887 int ret = avio_close(*s);
892 int avio_printf(AVIOContext *s, const char *fmt, ...)
899 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
901 avio_write(s, buf, strlen(buf));
905 int avio_pause(AVIOContext *s, int pause)
908 return AVERROR(ENOSYS);
909 return s->read_pause(s->opaque, pause);
912 int64_t avio_seek_time(AVIOContext *s, int stream_index,
913 int64_t timestamp, int flags)
915 URLContext *h = s->opaque;
918 return AVERROR(ENOSYS);
919 ret = s->read_seek(h, stream_index, timestamp, flags);
922 s->buf_ptr = s->buf_end; // Flush buffer
923 pos = s->seek(h, 0, SEEK_CUR);
926 else if (pos != AVERROR(ENOSYS))
932 /* output in a dynamic buffer */
934 typedef struct DynBuffer {
935 int pos, size, allocated_size;
938 uint8_t io_buffer[1];
941 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
943 DynBuffer *d = opaque;
944 unsigned new_size, new_allocated_size;
946 /* reallocate buffer if needed */
947 new_size = d->pos + buf_size;
948 new_allocated_size = d->allocated_size;
949 if (new_size < d->pos || new_size > INT_MAX/2)
951 while (new_size > new_allocated_size) {
952 if (!new_allocated_size)
953 new_allocated_size = new_size;
955 new_allocated_size += new_allocated_size / 2 + 1;
958 if (new_allocated_size > d->allocated_size) {
960 if ((err = av_reallocp(&d->buffer, new_allocated_size)) < 0) {
961 d->allocated_size = 0;
965 d->allocated_size = new_allocated_size;
967 memcpy(d->buffer + d->pos, buf, buf_size);
969 if (d->pos > d->size)
974 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
976 unsigned char buf1[4];
979 /* packetized write: output the header */
980 AV_WB32(buf1, buf_size);
981 ret = dyn_buf_write(opaque, buf1, 4);
986 return dyn_buf_write(opaque, buf, buf_size);
989 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
991 DynBuffer *d = opaque;
993 if (whence == SEEK_CUR)
995 else if (whence == SEEK_END)
997 if (offset < 0 || offset > 0x7fffffffLL)
1003 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
1006 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
1008 if (sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
1010 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
1012 return AVERROR(ENOMEM);
1013 d->io_buffer_size = io_buffer_size;
1014 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
1015 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
1016 max_packet_size ? NULL : dyn_buf_seek);
1019 return AVERROR(ENOMEM);
1021 (*s)->max_packet_size = max_packet_size;
1025 int avio_open_dyn_buf(AVIOContext **s)
1027 return url_open_dyn_buf_internal(s, 0);
1030 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
1032 if (max_packet_size <= 0)
1034 return url_open_dyn_buf_internal(s, max_packet_size);
1037 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
1041 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
1050 /* don't attempt to pad fixed-size packet buffers */
1051 if (!s->max_packet_size) {
1052 avio_write(s, padbuf, sizeof(padbuf));
1053 padding = FF_INPUT_BUFFER_PADDING_SIZE;
1058 *pbuffer = d->buffer;
1062 return size - padding;
1065 static int null_buf_write(void *opaque, uint8_t *buf, int buf_size)
1067 DynBuffer *d = opaque;
1070 if (d->pos > d->size)
1075 int ffio_open_null_buf(AVIOContext **s)
1077 int ret = url_open_dyn_buf_internal(s, 0);
1079 AVIOContext *pb = *s;
1080 pb->write_packet = null_buf_write;
1085 int ffio_close_null_buf(AVIOContext *s)
1087 DynBuffer *d = s->opaque;