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 = AVIO_SEEKABLE_NORMAL;
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;
327 GET_UTF8(ch, *q++, break;)
328 PUT_UTF16(ch, tmp, avio_wl16(s, tmp); ret += 2;)
335 int ff_get_v_length(uint64_t val)
345 void ff_put_v(AVIOContext *bc, uint64_t val)
347 int i = ff_get_v_length(val);
350 avio_w8(bc, 128 | (uint8_t)(val >> (7*i)));
352 avio_w8(bc, val & 127);
355 void avio_wl64(AVIOContext *s, uint64_t val)
357 avio_wl32(s, (uint32_t)(val & 0xffffffff));
358 avio_wl32(s, (uint32_t)(val >> 32));
361 void avio_wb64(AVIOContext *s, uint64_t val)
363 avio_wb32(s, (uint32_t)(val >> 32));
364 avio_wb32(s, (uint32_t)(val & 0xffffffff));
367 void avio_wl16(AVIOContext *s, unsigned int val)
369 avio_w8(s, (uint8_t)val);
370 avio_w8(s, (int)val >> 8);
373 void avio_wb16(AVIOContext *s, unsigned int val)
375 avio_w8(s, (int)val >> 8);
376 avio_w8(s, (uint8_t)val);
379 void avio_wl24(AVIOContext *s, unsigned int val)
381 avio_wl16(s, val & 0xffff);
382 avio_w8(s, (int)val >> 16);
385 void avio_wb24(AVIOContext *s, unsigned int val)
387 avio_wb16(s, (int)val >> 8);
388 avio_w8(s, (uint8_t)val);
393 static void fill_buffer(AVIOContext *s)
395 uint8_t *dst = !s->max_packet_size &&
396 s->buf_end - s->buffer < s->buffer_size ?
397 s->buf_end : s->buffer;
398 int len = s->buffer_size - (dst - s->buffer);
399 int max_buffer_size = s->max_packet_size ?
400 s->max_packet_size : IO_BUFFER_SIZE;
402 /* can't fill the buffer without read_packet, just set EOF if appropriate */
403 if (!s->read_packet && s->buf_ptr >= s->buf_end)
406 /* no need to do anything if EOF already reached */
410 if (s->update_checksum && dst == s->buffer) {
411 if (s->buf_end > s->checksum_ptr)
412 s->checksum = s->update_checksum(s->checksum, s->checksum_ptr,
413 s->buf_end - s->checksum_ptr);
414 s->checksum_ptr = s->buffer;
417 /* make buffer smaller in case it ended up large after probing */
418 if (s->read_packet && s->buffer_size > max_buffer_size) {
419 ffio_set_buf_size(s, max_buffer_size);
421 s->checksum_ptr = dst = s->buffer;
422 len = s->buffer_size;
426 len = s->read_packet(s->opaque, dst, len);
430 /* do not modify buffer if EOF reached so that a seek back can
431 be done without rereading data */
438 s->buf_end = dst + len;
439 s->bytes_read += len;
443 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
446 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
449 unsigned long ffio_get_checksum(AVIOContext *s)
451 s->checksum = s->update_checksum(s->checksum, s->checksum_ptr,
452 s->buf_ptr - s->checksum_ptr);
453 s->update_checksum = NULL;
457 void ffio_init_checksum(AVIOContext *s,
458 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
459 unsigned long checksum)
461 s->update_checksum = update_checksum;
462 if (s->update_checksum) {
463 s->checksum = checksum;
464 s->checksum_ptr = s->buf_ptr;
468 /* XXX: put an inline version */
469 int avio_r8(AVIOContext *s)
471 if (s->buf_ptr >= s->buf_end)
473 if (s->buf_ptr < s->buf_end)
474 return *s->buf_ptr++;
478 int avio_read(AVIOContext *s, unsigned char *buf, int size)
484 len = s->buf_end - s->buf_ptr;
487 if (len == 0 || s->write_flag) {
488 if((s->direct || size > s->buffer_size) && !s->update_checksum){
490 len = s->read_packet(s->opaque, buf, size);
492 /* do not modify buffer if EOF reached so that a seek back can
493 be done without rereading data */
500 s->bytes_read += len;
503 s->buf_ptr = s->buffer;
504 s->buf_end = s->buffer/* + len*/;
508 len = s->buf_end - s->buf_ptr;
513 memcpy(buf, s->buf_ptr, len);
520 if (s->error) return s->error;
521 if (url_feof(s)) return AVERROR_EOF;
526 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
533 if (s->read_packet && s->write_flag) {
534 len = s->read_packet(s->opaque, buf, size);
540 len = s->buf_end - s->buf_ptr;
542 /* Reset the buf_end pointer to the start of the buffer, to make sure
543 * the fill_buffer call tries to read as much data as fits into the
544 * full buffer, instead of just what space is left after buf_end.
545 * This avoids returning partial packets at the end of the buffer,
546 * for packet based inputs.
548 s->buf_end = s->buf_ptr = s->buffer;
550 len = s->buf_end - s->buf_ptr;
554 memcpy(buf, s->buf_ptr, len);
557 if (s->error) return s->error;
558 if (url_feof(s)) return AVERROR_EOF;
563 unsigned int avio_rl16(AVIOContext *s)
567 val |= avio_r8(s) << 8;
571 unsigned int avio_rl24(AVIOContext *s)
575 val |= avio_r8(s) << 16;
579 unsigned int avio_rl32(AVIOContext *s)
583 val |= avio_rl16(s) << 16;
587 uint64_t avio_rl64(AVIOContext *s)
590 val = (uint64_t)avio_rl32(s);
591 val |= (uint64_t)avio_rl32(s) << 32;
595 unsigned int avio_rb16(AVIOContext *s)
598 val = avio_r8(s) << 8;
603 unsigned int avio_rb24(AVIOContext *s)
606 val = avio_rb16(s) << 8;
610 unsigned int avio_rb32(AVIOContext *s)
613 val = avio_rb16(s) << 16;
618 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
625 if (c && i < maxlen-1)
627 } while (c != '\n' && c);
633 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
638 return AVERROR(EINVAL);
639 // reserve 1 byte for terminating 0
640 buflen = FFMIN(buflen - 1, maxlen);
641 for (i = 0; i < buflen; i++)
642 if (!(buf[i] = avio_r8(s)))
645 for (; i < maxlen; i++)
651 #define GET_STR16(type, read) \
652 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
657 return AVERROR(EINVAL); \
658 while (ret + 1 < maxlen) {\
661 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
664 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
670 GET_STR16(le, avio_rl16)
671 GET_STR16(be, avio_rb16)
675 uint64_t avio_rb64(AVIOContext *s)
678 val = (uint64_t)avio_rb32(s) << 32;
679 val |= (uint64_t)avio_rb32(s);
683 uint64_t ffio_read_varlen(AVIOContext *bc){
689 val= (val<<7) + (tmp&127);
694 int ffio_fdopen(AVIOContext **s, URLContext *h)
697 int buffer_size, max_packet_size;
699 max_packet_size = h->max_packet_size;
700 if (max_packet_size) {
701 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
703 buffer_size = IO_BUFFER_SIZE;
705 buffer = av_malloc(buffer_size);
707 return AVERROR(ENOMEM);
709 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
710 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
713 return AVERROR(ENOMEM);
715 (*s)->direct = h->flags & AVIO_FLAG_DIRECT;
716 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
717 (*s)->max_packet_size = max_packet_size;
719 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
720 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
722 (*s)->av_class = &ffio_url_class;
726 int ffio_set_buf_size(AVIOContext *s, int buf_size)
729 buffer = av_malloc(buf_size);
731 return AVERROR(ENOMEM);
735 s->buffer_size = buf_size;
737 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
741 static int url_resetbuf(AVIOContext *s, int flags)
743 av_assert1(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
745 if (flags & AVIO_FLAG_WRITE) {
746 s->buf_end = s->buffer + s->buffer_size;
749 s->buf_end = s->buffer;
755 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **bufp, int buf_size)
757 int64_t buffer_start;
759 int overlap, new_size, alloc_size;
760 uint8_t *buf = *bufp;
764 return AVERROR(EINVAL);
767 buffer_size = s->buf_end - s->buffer;
769 /* the buffers must touch or overlap */
770 if ((buffer_start = s->pos - buffer_size) > buf_size) {
772 return AVERROR(EINVAL);
775 overlap = buf_size - buffer_start;
776 new_size = buf_size + buffer_size - overlap;
778 alloc_size = FFMAX(s->buffer_size, new_size);
779 if (alloc_size > buf_size)
780 if (!(buf = (*bufp) = av_realloc_f(buf, 1, alloc_size)))
781 return AVERROR(ENOMEM);
783 if (new_size > buf_size) {
784 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
789 s->buf_ptr = s->buffer = buf;
790 s->buffer_size = alloc_size;
792 s->buf_end = s->buf_ptr + buf_size;
799 int avio_open(AVIOContext **s, const char *filename, int flags)
801 return avio_open2(s, filename, flags, NULL, NULL);
804 int avio_open2(AVIOContext **s, const char *filename, int flags,
805 const AVIOInterruptCB *int_cb, AVDictionary **options)
810 err = ffurl_open(&h, filename, flags, int_cb, options);
813 err = ffio_fdopen(s, h);
821 int avio_close(AVIOContext *s)
830 av_freep(&s->buffer);
832 av_log(s, AV_LOG_DEBUG, "Statistics: %d seeks, %d writeouts\n", s->seek_count, s->writeout_count);
834 av_log(s, AV_LOG_DEBUG, "Statistics: %"PRId64" bytes read, %d seeks\n", s->bytes_read, s->seek_count);
836 return ffurl_close(h);
839 int avio_closep(AVIOContext **s)
841 int ret = avio_close(*s);
846 int avio_printf(AVIOContext *s, const char *fmt, ...)
853 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
855 avio_write(s, buf, strlen(buf));
859 int avio_pause(AVIOContext *s, int pause)
862 return AVERROR(ENOSYS);
863 return s->read_pause(s->opaque, pause);
866 int64_t avio_seek_time(AVIOContext *s, int stream_index,
867 int64_t timestamp, int flags)
869 URLContext *h = s->opaque;
872 return AVERROR(ENOSYS);
873 ret = s->read_seek(h, stream_index, timestamp, flags);
876 s->buf_ptr = s->buf_end; // Flush buffer
877 pos = s->seek(h, 0, SEEK_CUR);
880 else if (pos != AVERROR(ENOSYS))
886 /* output in a dynamic buffer */
888 typedef struct DynBuffer {
889 int pos, size, allocated_size;
892 uint8_t io_buffer[1];
895 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
897 DynBuffer *d = opaque;
898 unsigned new_size, new_allocated_size;
900 /* reallocate buffer if needed */
901 new_size = d->pos + buf_size;
902 new_allocated_size = d->allocated_size;
903 if (new_size < d->pos || new_size > INT_MAX/2)
905 while (new_size > new_allocated_size) {
906 if (!new_allocated_size)
907 new_allocated_size = new_size;
909 new_allocated_size += new_allocated_size / 2 + 1;
912 if (new_allocated_size > d->allocated_size) {
913 d->buffer = av_realloc_f(d->buffer, 1, new_allocated_size);
914 if(d->buffer == NULL)
915 return AVERROR(ENOMEM);
916 d->allocated_size = new_allocated_size;
918 memcpy(d->buffer + d->pos, buf, buf_size);
920 if (d->pos > d->size)
925 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
927 unsigned char buf1[4];
930 /* packetized write: output the header */
931 AV_WB32(buf1, buf_size);
932 ret = dyn_buf_write(opaque, buf1, 4);
937 return dyn_buf_write(opaque, buf, buf_size);
940 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
942 DynBuffer *d = opaque;
944 if (whence == SEEK_CUR)
946 else if (whence == SEEK_END)
948 if (offset < 0 || offset > 0x7fffffffLL)
954 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
957 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
959 if (sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
961 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
963 return AVERROR(ENOMEM);
964 d->io_buffer_size = io_buffer_size;
965 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
966 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
967 max_packet_size ? NULL : dyn_buf_seek);
970 return AVERROR(ENOMEM);
972 (*s)->max_packet_size = max_packet_size;
976 int avio_open_dyn_buf(AVIOContext **s)
978 return url_open_dyn_buf_internal(s, 0);
981 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
983 if (max_packet_size <= 0)
985 return url_open_dyn_buf_internal(s, max_packet_size);
988 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
990 DynBuffer *d = s->opaque;
992 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
995 /* don't attempt to pad fixed-size packet buffers */
996 if (!s->max_packet_size) {
997 avio_write(s, padbuf, sizeof(padbuf));
998 padding = FF_INPUT_BUFFER_PADDING_SIZE;
1003 *pbuffer = d->buffer;
1007 return size - padding;