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;
85 url_resetbuf(s, write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
86 s->write_packet = write_packet;
87 s->read_packet = read_packet;
93 s->seekable = AVIO_SEEKABLE_NORMAL;
94 s->max_packet_size = 0;
95 s->update_checksum= NULL;
96 if(!read_packet && !write_flag){
98 s->buf_end = s->buffer + buffer_size;
100 s->read_pause = NULL;
105 AVIOContext *avio_alloc_context(
106 unsigned char *buffer,
110 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
111 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
112 int64_t (*seek)(void *opaque, int64_t offset, int whence))
114 AVIOContext *s = av_mallocz(sizeof(AVIOContext));
117 ffio_init_context(s, buffer, buffer_size, write_flag, opaque,
118 read_packet, write_packet, seek);
122 static void writeout(AVIOContext *s, const uint8_t *data, int len)
124 if (s->write_packet && !s->error){
125 int ret= s->write_packet(s->opaque, (uint8_t *)data, len);
133 static void flush_buffer(AVIOContext *s)
135 if (s->buf_ptr > s->buffer) {
136 writeout(s, s->buffer, s->buf_ptr - s->buffer);
137 if(s->update_checksum){
138 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
139 s->checksum_ptr= s->buffer;
142 s->buf_ptr = s->buffer;
145 void avio_w8(AVIOContext *s, int b)
148 if (s->buf_ptr >= s->buf_end)
152 void ffio_fill(AVIOContext *s, int b, int count)
155 int len = FFMIN(s->buf_end - s->buf_ptr, count);
156 memset(s->buf_ptr, b, len);
159 if (s->buf_ptr >= s->buf_end)
166 void avio_write(AVIOContext *s, const unsigned char *buf, int size)
168 if (s->direct && !s->update_checksum) {
170 writeout(s, buf, size);
174 int len = FFMIN(s->buf_end - s->buf_ptr, size);
175 memcpy(s->buf_ptr, buf, len);
178 if (s->buf_ptr >= s->buf_end)
186 void avio_flush(AVIOContext *s)
192 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
196 int force = whence & AVSEEK_FORCE;
197 whence &= ~AVSEEK_FORCE;
200 return AVERROR(EINVAL);
202 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
204 if (whence != SEEK_CUR && whence != SEEK_SET)
205 return AVERROR(EINVAL);
207 if (whence == SEEK_CUR) {
208 offset1 = pos + (s->buf_ptr - s->buffer);
213 offset1 = offset - pos;
214 if (!s->must_flush && (!s->direct || !s->seek) &&
215 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
216 /* can do the seek inside the buffer */
217 s->buf_ptr = s->buffer + offset1;
218 } else if ((!s->seekable ||
219 offset1 <= s->buf_end + SHORT_SEEK_THRESHOLD - s->buffer) &&
220 !s->write_flag && offset1 >= 0 &&
221 (!s->direct || !s->seek) &&
222 (whence != SEEK_END || force)) {
223 while(s->pos < offset && !s->eof_reached)
227 s->buf_ptr = s->buf_end + offset - s->pos;
236 return AVERROR(EPIPE);
237 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
241 s->buf_end = s->buffer;
242 s->buf_ptr = s->buffer;
249 int64_t avio_skip(AVIOContext *s, int64_t offset)
251 return avio_seek(s, offset, SEEK_CUR);
254 int64_t avio_size(AVIOContext *s)
259 return AVERROR(EINVAL);
262 return AVERROR(ENOSYS);
263 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
265 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
268 s->seek(s->opaque, s->pos, SEEK_SET);
273 int url_feof(AVIOContext *s)
281 return s->eof_reached;
284 void avio_wl32(AVIOContext *s, unsigned int val)
287 avio_w8(s, val >> 8);
288 avio_w8(s, val >> 16);
289 avio_w8(s, val >> 24);
292 void avio_wb32(AVIOContext *s, unsigned int val)
294 avio_w8(s, val >> 24);
295 avio_w8(s, val >> 16);
296 avio_w8(s, val >> 8);
300 int avio_put_str(AVIOContext *s, const char *str)
305 avio_write(s, (const unsigned char *) str, len);
311 int avio_put_str16le(AVIOContext *s, const char *str)
313 const uint8_t *q = str;
320 GET_UTF8(ch, *q++, break;)
321 PUT_UTF16(ch, tmp, avio_wl16(s, tmp);ret += 2;)
328 int ff_get_v_length(uint64_t val){
337 void ff_put_v(AVIOContext *bc, uint64_t val){
338 int i= ff_get_v_length(val);
341 avio_w8(bc, 128 | (val>>(7*i)));
343 avio_w8(bc, val&127);
346 void avio_wl64(AVIOContext *s, uint64_t val)
348 avio_wl32(s, (uint32_t)(val & 0xffffffff));
349 avio_wl32(s, (uint32_t)(val >> 32));
352 void avio_wb64(AVIOContext *s, uint64_t val)
354 avio_wb32(s, (uint32_t)(val >> 32));
355 avio_wb32(s, (uint32_t)(val & 0xffffffff));
358 void avio_wl16(AVIOContext *s, unsigned int val)
361 avio_w8(s, val >> 8);
364 void avio_wb16(AVIOContext *s, unsigned int val)
366 avio_w8(s, val >> 8);
370 void avio_wl24(AVIOContext *s, unsigned int val)
372 avio_wl16(s, val & 0xffff);
373 avio_w8(s, val >> 16);
376 void avio_wb24(AVIOContext *s, unsigned int val)
378 avio_wb16(s, val >> 8);
384 static void fill_buffer(AVIOContext *s)
386 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_end : s->buffer;
387 int len= s->buffer_size - (dst - s->buffer);
388 int max_buffer_size = s->max_packet_size ? s->max_packet_size : IO_BUFFER_SIZE;
390 /* can't fill the buffer without read_packet, just set EOF if appropriate */
391 if (!s->read_packet && s->buf_ptr >= s->buf_end)
394 /* no need to do anything if EOF already reached */
398 if(s->update_checksum && dst == s->buffer){
399 if(s->buf_end > s->checksum_ptr)
400 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
401 s->checksum_ptr= s->buffer;
404 /* make buffer smaller in case it ended up large after probing */
405 if (s->read_packet && s->buffer_size > max_buffer_size) {
406 ffio_set_buf_size(s, max_buffer_size);
408 s->checksum_ptr = dst = s->buffer;
409 len = s->buffer_size;
413 len = s->read_packet(s->opaque, dst, len);
417 /* do not modify buffer if EOF reached so that a seek back can
418 be done without rereading data */
425 s->buf_end = dst + len;
426 s->bytes_read += len;
430 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
433 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
436 unsigned long ffio_get_checksum(AVIOContext *s)
438 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
439 s->update_checksum= NULL;
443 void ffio_init_checksum(AVIOContext *s,
444 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
445 unsigned long checksum)
447 s->update_checksum= update_checksum;
448 if(s->update_checksum){
449 s->checksum= checksum;
450 s->checksum_ptr= s->buf_ptr;
454 /* XXX: put an inline version */
455 int avio_r8(AVIOContext *s)
457 if (s->buf_ptr >= s->buf_end)
459 if (s->buf_ptr < s->buf_end)
460 return *s->buf_ptr++;
464 int avio_read(AVIOContext *s, unsigned char *buf, int size)
470 len = s->buf_end - s->buf_ptr;
474 if((s->direct || size > s->buffer_size) && !s->update_checksum){
476 len = s->read_packet(s->opaque, buf, size);
478 /* do not modify buffer if EOF reached so that a seek back can
479 be done without rereading data */
486 s->bytes_read += len;
489 s->buf_ptr = s->buffer;
490 s->buf_end = s->buffer/* + len*/;
494 len = s->buf_end - s->buf_ptr;
499 memcpy(buf, s->buf_ptr, len);
506 if (s->error) return s->error;
507 if (url_feof(s)) return AVERROR_EOF;
512 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
519 len = s->buf_end - s->buf_ptr;
522 len = s->buf_end - s->buf_ptr;
526 memcpy(buf, s->buf_ptr, len);
529 if (s->error) return s->error;
530 if (url_feof(s)) return AVERROR_EOF;
535 unsigned int avio_rl16(AVIOContext *s)
539 val |= avio_r8(s) << 8;
543 unsigned int avio_rl24(AVIOContext *s)
547 val |= avio_r8(s) << 16;
551 unsigned int avio_rl32(AVIOContext *s)
555 val |= avio_rl16(s) << 16;
559 uint64_t avio_rl64(AVIOContext *s)
562 val = (uint64_t)avio_rl32(s);
563 val |= (uint64_t)avio_rl32(s) << 32;
567 unsigned int avio_rb16(AVIOContext *s)
570 val = avio_r8(s) << 8;
575 unsigned int avio_rb24(AVIOContext *s)
578 val = avio_rb16(s) << 8;
582 unsigned int avio_rb32(AVIOContext *s)
585 val = avio_rb16(s) << 16;
590 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
597 if (c && i < maxlen-1)
599 } while (c != '\n' && c);
605 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
610 return AVERROR(EINVAL);
611 // reserve 1 byte for terminating 0
612 buflen = FFMIN(buflen - 1, maxlen);
613 for (i = 0; i < buflen; i++)
614 if (!(buf[i] = avio_r8(s)))
617 for (; i < maxlen; i++)
623 #define GET_STR16(type, read) \
624 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
629 return AVERROR(EINVAL); \
630 while (ret + 1 < maxlen) {\
633 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
636 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
642 GET_STR16(le, avio_rl16)
643 GET_STR16(be, avio_rb16)
647 uint64_t avio_rb64(AVIOContext *s)
650 val = (uint64_t)avio_rb32(s) << 32;
651 val |= (uint64_t)avio_rb32(s);
655 uint64_t ffio_read_varlen(AVIOContext *bc){
661 val= (val<<7) + (tmp&127);
666 int ffio_fdopen(AVIOContext **s, URLContext *h)
669 int buffer_size, max_packet_size;
671 max_packet_size = h->max_packet_size;
672 if (max_packet_size) {
673 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
675 buffer_size = IO_BUFFER_SIZE;
677 buffer = av_malloc(buffer_size);
679 return AVERROR(ENOMEM);
681 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
682 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
685 return AVERROR(ENOMEM);
687 (*s)->direct = h->flags & AVIO_FLAG_DIRECT;
688 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
689 (*s)->max_packet_size = max_packet_size;
691 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
692 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
694 (*s)->av_class = &ffio_url_class;
698 int ffio_set_buf_size(AVIOContext *s, int buf_size)
701 buffer = av_malloc(buf_size);
703 return AVERROR(ENOMEM);
707 s->buffer_size = buf_size;
709 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
713 static int url_resetbuf(AVIOContext *s, int flags)
715 av_assert1(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
717 if (flags & AVIO_FLAG_WRITE) {
718 s->buf_end = s->buffer + s->buffer_size;
721 s->buf_end = s->buffer;
727 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **bufp, int buf_size)
729 int64_t buffer_start;
731 int overlap, new_size, alloc_size;
732 uint8_t *buf = *bufp;
736 return AVERROR(EINVAL);
739 buffer_size = s->buf_end - s->buffer;
741 /* the buffers must touch or overlap */
742 if ((buffer_start = s->pos - buffer_size) > buf_size) {
744 return AVERROR(EINVAL);
747 overlap = buf_size - buffer_start;
748 new_size = buf_size + buffer_size - overlap;
750 alloc_size = FFMAX(s->buffer_size, new_size);
751 if (alloc_size > buf_size)
752 if (!(buf = (*bufp) = av_realloc_f(buf, 1, alloc_size)))
753 return AVERROR(ENOMEM);
755 if (new_size > buf_size) {
756 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
761 s->buf_ptr = s->buffer = buf;
762 s->buffer_size = alloc_size;
764 s->buf_end = s->buf_ptr + buf_size;
771 int avio_open(AVIOContext **s, const char *filename, int flags)
773 return avio_open2(s, filename, flags, NULL, NULL);
776 int avio_open2(AVIOContext **s, const char *filename, int flags,
777 const AVIOInterruptCB *int_cb, AVDictionary **options)
782 err = ffurl_open(&h, filename, flags, int_cb, options);
785 err = ffio_fdopen(s, h);
793 int avio_close(AVIOContext *s)
802 av_freep(&s->buffer);
804 av_log(s, AV_LOG_DEBUG, "Statistics: %"PRId64" bytes read, %d seeks\n", s->bytes_read, s->seek_count);
806 return ffurl_close(h);
809 int avio_closep(AVIOContext **s)
811 int ret = avio_close(*s);
816 int avio_printf(AVIOContext *s, const char *fmt, ...)
823 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
825 avio_write(s, buf, strlen(buf));
829 int avio_pause(AVIOContext *s, int pause)
832 return AVERROR(ENOSYS);
833 return s->read_pause(s->opaque, pause);
836 int64_t avio_seek_time(AVIOContext *s, int stream_index,
837 int64_t timestamp, int flags)
839 URLContext *h = s->opaque;
842 return AVERROR(ENOSYS);
843 ret = s->read_seek(h, stream_index, timestamp, flags);
846 s->buf_ptr = s->buf_end; // Flush buffer
847 pos = s->seek(h, 0, SEEK_CUR);
850 else if (pos != AVERROR(ENOSYS))
856 /* output in a dynamic buffer */
858 typedef struct DynBuffer {
859 int pos, size, allocated_size;
862 uint8_t io_buffer[1];
865 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
867 DynBuffer *d = opaque;
868 unsigned new_size, new_allocated_size;
870 /* reallocate buffer if needed */
871 new_size = d->pos + buf_size;
872 new_allocated_size = d->allocated_size;
873 if(new_size < d->pos || new_size > INT_MAX/2)
875 while (new_size > new_allocated_size) {
876 if (!new_allocated_size)
877 new_allocated_size = new_size;
879 new_allocated_size += new_allocated_size / 2 + 1;
882 if (new_allocated_size > d->allocated_size) {
883 d->buffer = av_realloc_f(d->buffer, 1, new_allocated_size);
884 if(d->buffer == NULL)
885 return AVERROR(ENOMEM);
886 d->allocated_size = new_allocated_size;
888 memcpy(d->buffer + d->pos, buf, buf_size);
890 if (d->pos > d->size)
895 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
897 unsigned char buf1[4];
900 /* packetized write: output the header */
901 AV_WB32(buf1, buf_size);
902 ret= dyn_buf_write(opaque, buf1, 4);
907 return dyn_buf_write(opaque, buf, buf_size);
910 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
912 DynBuffer *d = opaque;
914 if (whence == SEEK_CUR)
916 else if (whence == SEEK_END)
918 if (offset < 0 || offset > 0x7fffffffLL)
924 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
927 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
929 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
931 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
933 return AVERROR(ENOMEM);
934 d->io_buffer_size = io_buffer_size;
935 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
936 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
937 max_packet_size ? NULL : dyn_buf_seek);
940 return AVERROR(ENOMEM);
942 (*s)->max_packet_size = max_packet_size;
946 int avio_open_dyn_buf(AVIOContext **s)
948 return url_open_dyn_buf_internal(s, 0);
951 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
953 if (max_packet_size <= 0)
955 return url_open_dyn_buf_internal(s, max_packet_size);
958 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
960 DynBuffer *d = s->opaque;
962 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
965 /* don't attempt to pad fixed-size packet buffers */
966 if (!s->max_packet_size) {
967 avio_write(s, padbuf, sizeof(padbuf));
968 padding = FF_INPUT_BUFFER_PADDING_SIZE;
973 *pbuffer = d->buffer;
977 return size - padding;