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)
147 av_assert2(b>=-128 && b<=255);
149 if (s->buf_ptr >= s->buf_end)
153 void ffio_fill(AVIOContext *s, int b, int count)
156 int len = FFMIN(s->buf_end - s->buf_ptr, count);
157 memset(s->buf_ptr, b, len);
160 if (s->buf_ptr >= s->buf_end)
167 void avio_write(AVIOContext *s, const unsigned char *buf, int size)
169 if (s->direct && !s->update_checksum) {
171 writeout(s, buf, size);
175 int len = FFMIN(s->buf_end - s->buf_ptr, size);
176 memcpy(s->buf_ptr, buf, len);
179 if (s->buf_ptr >= s->buf_end)
187 void avio_flush(AVIOContext *s)
193 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
197 int force = whence & AVSEEK_FORCE;
198 whence &= ~AVSEEK_FORCE;
201 return AVERROR(EINVAL);
203 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
205 if (whence != SEEK_CUR && whence != SEEK_SET)
206 return AVERROR(EINVAL);
208 if (whence == SEEK_CUR) {
209 offset1 = pos + (s->buf_ptr - s->buffer);
214 offset1 = offset - pos;
215 if (!s->must_flush && (!s->direct || !s->seek) &&
216 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
217 /* can do the seek inside the buffer */
218 s->buf_ptr = s->buffer + offset1;
219 } else if ((!s->seekable ||
220 offset1 <= s->buf_end + SHORT_SEEK_THRESHOLD - s->buffer) &&
221 !s->write_flag && offset1 >= 0 &&
222 (!s->direct || !s->seek) &&
223 (whence != SEEK_END || force)) {
224 while(s->pos < offset && !s->eof_reached)
228 s->buf_ptr = s->buf_end + offset - s->pos;
237 return AVERROR(EPIPE);
238 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
242 s->buf_end = s->buffer;
243 s->buf_ptr = s->buffer;
250 int64_t avio_skip(AVIOContext *s, int64_t offset)
252 return avio_seek(s, offset, SEEK_CUR);
255 int64_t avio_size(AVIOContext *s)
260 return AVERROR(EINVAL);
263 return AVERROR(ENOSYS);
264 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
266 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
269 s->seek(s->opaque, s->pos, SEEK_SET);
274 int url_feof(AVIOContext *s)
282 return s->eof_reached;
285 void avio_wl32(AVIOContext *s, unsigned int val)
287 avio_w8(s, (uint8_t) val );
288 avio_w8(s, (uint8_t)(val >> 8 ));
289 avio_w8(s, (uint8_t)(val >> 16));
290 avio_w8(s, val >> 24 );
293 void avio_wb32(AVIOContext *s, unsigned int val)
295 avio_w8(s, val >> 24 );
296 avio_w8(s, (uint8_t)(val >> 16));
297 avio_w8(s, (uint8_t)(val >> 8 ));
298 avio_w8(s, (uint8_t) val );
301 int avio_put_str(AVIOContext *s, const char *str)
306 avio_write(s, (const unsigned char *) str, len);
312 int avio_put_str16le(AVIOContext *s, const char *str)
314 const uint8_t *q = str;
321 GET_UTF8(ch, *q++, break;)
322 PUT_UTF16(ch, tmp, avio_wl16(s, tmp);ret += 2;)
329 int ff_get_v_length(uint64_t val){
338 void ff_put_v(AVIOContext *bc, uint64_t val){
339 int i= ff_get_v_length(val);
342 avio_w8(bc, 128 | (uint8_t)(val>>(7*i)));
344 avio_w8(bc, val&127);
347 void avio_wl64(AVIOContext *s, uint64_t val)
349 avio_wl32(s, (uint32_t)(val & 0xffffffff));
350 avio_wl32(s, (uint32_t)(val >> 32));
353 void avio_wb64(AVIOContext *s, uint64_t val)
355 avio_wb32(s, (uint32_t)(val >> 32));
356 avio_wb32(s, (uint32_t)(val & 0xffffffff));
359 void avio_wl16(AVIOContext *s, unsigned int val)
361 avio_w8(s, (uint8_t)val);
362 avio_w8(s, (int)val >> 8);
365 void avio_wb16(AVIOContext *s, unsigned int val)
367 avio_w8(s, (int)val >> 8);
368 avio_w8(s, (uint8_t)val);
371 void avio_wl24(AVIOContext *s, unsigned int val)
373 avio_wl16(s, val & 0xffff);
374 avio_w8(s, (int)val >> 16);
377 void avio_wb24(AVIOContext *s, unsigned int val)
379 avio_wb16(s, (int)val >> 8);
380 avio_w8(s, (uint8_t)val);
385 static void fill_buffer(AVIOContext *s)
387 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_end : s->buffer;
388 int len= s->buffer_size - (dst - s->buffer);
389 int max_buffer_size = s->max_packet_size ? s->max_packet_size : IO_BUFFER_SIZE;
391 /* can't fill the buffer without read_packet, just set EOF if appropriate */
392 if (!s->read_packet && s->buf_ptr >= s->buf_end)
395 /* no need to do anything if EOF already reached */
399 if(s->update_checksum && dst == s->buffer){
400 if(s->buf_end > s->checksum_ptr)
401 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
402 s->checksum_ptr= s->buffer;
405 /* make buffer smaller in case it ended up large after probing */
406 if (s->read_packet && s->buffer_size > max_buffer_size) {
407 ffio_set_buf_size(s, max_buffer_size);
409 s->checksum_ptr = dst = s->buffer;
410 len = s->buffer_size;
414 len = s->read_packet(s->opaque, dst, len);
418 /* do not modify buffer if EOF reached so that a seek back can
419 be done without rereading data */
426 s->buf_end = dst + len;
427 s->bytes_read += len;
431 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
434 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
437 unsigned long ffio_get_checksum(AVIOContext *s)
439 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
440 s->update_checksum= NULL;
444 void ffio_init_checksum(AVIOContext *s,
445 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
446 unsigned long checksum)
448 s->update_checksum= update_checksum;
449 if(s->update_checksum){
450 s->checksum= checksum;
451 s->checksum_ptr= s->buf_ptr;
455 /* XXX: put an inline version */
456 int avio_r8(AVIOContext *s)
458 if (s->buf_ptr >= s->buf_end)
460 if (s->buf_ptr < s->buf_end)
461 return *s->buf_ptr++;
465 int avio_read(AVIOContext *s, unsigned char *buf, int size)
471 len = s->buf_end - s->buf_ptr;
475 if((s->direct || size > s->buffer_size) && !s->update_checksum){
477 len = s->read_packet(s->opaque, buf, size);
479 /* do not modify buffer if EOF reached so that a seek back can
480 be done without rereading data */
487 s->bytes_read += len;
490 s->buf_ptr = s->buffer;
491 s->buf_end = s->buffer/* + len*/;
495 len = s->buf_end - s->buf_ptr;
500 memcpy(buf, s->buf_ptr, len);
507 if (s->error) return s->error;
508 if (url_feof(s)) return AVERROR_EOF;
513 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
520 len = s->buf_end - s->buf_ptr;
523 len = s->buf_end - s->buf_ptr;
527 memcpy(buf, s->buf_ptr, len);
530 if (s->error) return s->error;
531 if (url_feof(s)) return AVERROR_EOF;
536 unsigned int avio_rl16(AVIOContext *s)
540 val |= avio_r8(s) << 8;
544 unsigned int avio_rl24(AVIOContext *s)
548 val |= avio_r8(s) << 16;
552 unsigned int avio_rl32(AVIOContext *s)
556 val |= avio_rl16(s) << 16;
560 uint64_t avio_rl64(AVIOContext *s)
563 val = (uint64_t)avio_rl32(s);
564 val |= (uint64_t)avio_rl32(s) << 32;
568 unsigned int avio_rb16(AVIOContext *s)
571 val = avio_r8(s) << 8;
576 unsigned int avio_rb24(AVIOContext *s)
579 val = avio_rb16(s) << 8;
583 unsigned int avio_rb32(AVIOContext *s)
586 val = avio_rb16(s) << 16;
591 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
598 if (c && i < maxlen-1)
600 } while (c != '\n' && c);
606 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
611 return AVERROR(EINVAL);
612 // reserve 1 byte for terminating 0
613 buflen = FFMIN(buflen - 1, maxlen);
614 for (i = 0; i < buflen; i++)
615 if (!(buf[i] = avio_r8(s)))
618 for (; i < maxlen; i++)
624 #define GET_STR16(type, read) \
625 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
630 return AVERROR(EINVAL); \
631 while (ret + 1 < maxlen) {\
634 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
637 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
643 GET_STR16(le, avio_rl16)
644 GET_STR16(be, avio_rb16)
648 uint64_t avio_rb64(AVIOContext *s)
651 val = (uint64_t)avio_rb32(s) << 32;
652 val |= (uint64_t)avio_rb32(s);
656 uint64_t ffio_read_varlen(AVIOContext *bc){
662 val= (val<<7) + (tmp&127);
667 int ffio_fdopen(AVIOContext **s, URLContext *h)
670 int buffer_size, max_packet_size;
672 max_packet_size = h->max_packet_size;
673 if (max_packet_size) {
674 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
676 buffer_size = IO_BUFFER_SIZE;
678 buffer = av_malloc(buffer_size);
680 return AVERROR(ENOMEM);
682 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
683 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
686 return AVERROR(ENOMEM);
688 (*s)->direct = h->flags & AVIO_FLAG_DIRECT;
689 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
690 (*s)->max_packet_size = max_packet_size;
692 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
693 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
695 (*s)->av_class = &ffio_url_class;
699 int ffio_set_buf_size(AVIOContext *s, int buf_size)
702 buffer = av_malloc(buf_size);
704 return AVERROR(ENOMEM);
708 s->buffer_size = buf_size;
710 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
714 static int url_resetbuf(AVIOContext *s, int flags)
716 av_assert1(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
718 if (flags & AVIO_FLAG_WRITE) {
719 s->buf_end = s->buffer + s->buffer_size;
722 s->buf_end = s->buffer;
728 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **bufp, int buf_size)
730 int64_t buffer_start;
732 int overlap, new_size, alloc_size;
733 uint8_t *buf = *bufp;
737 return AVERROR(EINVAL);
740 buffer_size = s->buf_end - s->buffer;
742 /* the buffers must touch or overlap */
743 if ((buffer_start = s->pos - buffer_size) > buf_size) {
745 return AVERROR(EINVAL);
748 overlap = buf_size - buffer_start;
749 new_size = buf_size + buffer_size - overlap;
751 alloc_size = FFMAX(s->buffer_size, new_size);
752 if (alloc_size > buf_size)
753 if (!(buf = (*bufp) = av_realloc_f(buf, 1, alloc_size)))
754 return AVERROR(ENOMEM);
756 if (new_size > buf_size) {
757 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
762 s->buf_ptr = s->buffer = buf;
763 s->buffer_size = alloc_size;
765 s->buf_end = s->buf_ptr + buf_size;
772 int avio_open(AVIOContext **s, const char *filename, int flags)
774 return avio_open2(s, filename, flags, NULL, NULL);
777 int avio_open2(AVIOContext **s, const char *filename, int flags,
778 const AVIOInterruptCB *int_cb, AVDictionary **options)
783 err = ffurl_open(&h, filename, flags, int_cb, options);
786 err = ffio_fdopen(s, h);
794 int avio_close(AVIOContext *s)
803 av_freep(&s->buffer);
805 av_log(s, AV_LOG_DEBUG, "Statistics: %"PRId64" bytes read, %d seeks\n", s->bytes_read, s->seek_count);
807 return ffurl_close(h);
810 int avio_closep(AVIOContext **s)
812 int ret = avio_close(*s);
817 int avio_printf(AVIOContext *s, const char *fmt, ...)
824 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
826 avio_write(s, buf, strlen(buf));
830 int avio_pause(AVIOContext *s, int pause)
833 return AVERROR(ENOSYS);
834 return s->read_pause(s->opaque, pause);
837 int64_t avio_seek_time(AVIOContext *s, int stream_index,
838 int64_t timestamp, int flags)
840 URLContext *h = s->opaque;
843 return AVERROR(ENOSYS);
844 ret = s->read_seek(h, stream_index, timestamp, flags);
847 s->buf_ptr = s->buf_end; // Flush buffer
848 pos = s->seek(h, 0, SEEK_CUR);
851 else if (pos != AVERROR(ENOSYS))
857 /* output in a dynamic buffer */
859 typedef struct DynBuffer {
860 int pos, size, allocated_size;
863 uint8_t io_buffer[1];
866 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
868 DynBuffer *d = opaque;
869 unsigned new_size, new_allocated_size;
871 /* reallocate buffer if needed */
872 new_size = d->pos + buf_size;
873 new_allocated_size = d->allocated_size;
874 if(new_size < d->pos || new_size > INT_MAX/2)
876 while (new_size > new_allocated_size) {
877 if (!new_allocated_size)
878 new_allocated_size = new_size;
880 new_allocated_size += new_allocated_size / 2 + 1;
883 if (new_allocated_size > d->allocated_size) {
884 d->buffer = av_realloc_f(d->buffer, 1, new_allocated_size);
885 if(d->buffer == NULL)
886 return AVERROR(ENOMEM);
887 d->allocated_size = new_allocated_size;
889 memcpy(d->buffer + d->pos, buf, buf_size);
891 if (d->pos > d->size)
896 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
898 unsigned char buf1[4];
901 /* packetized write: output the header */
902 AV_WB32(buf1, buf_size);
903 ret= dyn_buf_write(opaque, buf1, 4);
908 return dyn_buf_write(opaque, buf, buf_size);
911 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
913 DynBuffer *d = opaque;
915 if (whence == SEEK_CUR)
917 else if (whence == SEEK_END)
919 if (offset < 0 || offset > 0x7fffffffLL)
925 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
928 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
930 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
932 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
934 return AVERROR(ENOMEM);
935 d->io_buffer_size = io_buffer_size;
936 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
937 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
938 max_packet_size ? NULL : dyn_buf_seek);
941 return AVERROR(ENOMEM);
943 (*s)->max_packet_size = max_packet_size;
947 int avio_open_dyn_buf(AVIOContext **s)
949 return url_open_dyn_buf_internal(s, 0);
952 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
954 if (max_packet_size <= 0)
956 return url_open_dyn_buf_internal(s, max_packet_size);
959 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
961 DynBuffer *d = s->opaque;
963 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
966 /* don't attempt to pad fixed-size packet buffers */
967 if (!s->max_packet_size) {
968 avio_write(s, padbuf, sizeof(padbuf));
969 padding = FF_INPUT_BUFFER_PADDING_SIZE;
974 *pbuffer = d->buffer;
978 return size - padding;