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"
29 #include "avio_internal.h"
34 #define IO_BUFFER_SIZE 32768
37 * Do seeks within this distance ahead of the current buffer by skipping
38 * data instead of calling the protocol seek function, for seekable
41 #define SHORT_SEEK_THRESHOLD 4096
43 static void *ffio_url_child_next(void *obj, void *prev)
46 return prev ? NULL : s->opaque;
49 static const AVClass *ffio_url_child_class_next(const AVClass *prev)
51 return prev ? NULL : &ffurl_context_class;
54 static const AVOption ffio_url_options[] = {
58 const AVClass ffio_url_class = {
59 .class_name = "AVIOContext",
60 .item_name = av_default_item_name,
61 .version = LIBAVUTIL_VERSION_INT,
62 .option = ffio_url_options,
63 .child_next = ffio_url_child_next,
64 .child_class_next = ffio_url_child_class_next,
67 static void fill_buffer(AVIOContext *s);
68 static int url_resetbuf(AVIOContext *s, int flags);
70 int ffio_init_context(AVIOContext *s,
71 unsigned char *buffer,
75 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
76 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
77 int64_t (*seek)(void *opaque, int64_t offset, int whence))
80 s->buffer_size = buffer_size;
83 url_resetbuf(s, write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
84 s->write_packet = write_packet;
85 s->read_packet = read_packet;
91 s->seekable = AVIO_SEEKABLE_NORMAL;
92 s->max_packet_size = 0;
93 s->update_checksum= NULL;
94 if(!read_packet && !write_flag){
96 s->buf_end = s->buffer + buffer_size;
103 AVIOContext *avio_alloc_context(
104 unsigned char *buffer,
108 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
109 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
110 int64_t (*seek)(void *opaque, int64_t offset, int whence))
112 AVIOContext *s = av_mallocz(sizeof(AVIOContext));
115 ffio_init_context(s, buffer, buffer_size, write_flag, opaque,
116 read_packet, write_packet, seek);
120 static void flush_buffer(AVIOContext *s)
122 if (s->buf_ptr > s->buffer) {
123 if (s->write_packet && !s->error){
124 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
129 if(s->update_checksum){
130 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
131 s->checksum_ptr= s->buffer;
133 s->pos += s->buf_ptr - s->buffer;
135 s->buf_ptr = s->buffer;
138 void avio_w8(AVIOContext *s, int b)
141 if (s->buf_ptr >= s->buf_end)
145 void ffio_fill(AVIOContext *s, int b, int count)
148 int len = FFMIN(s->buf_end - s->buf_ptr, count);
149 memset(s->buf_ptr, b, len);
152 if (s->buf_ptr >= s->buf_end)
159 void avio_write(AVIOContext *s, const unsigned char *buf, int size)
162 int len = FFMIN(s->buf_end - s->buf_ptr, size);
163 memcpy(s->buf_ptr, buf, len);
166 if (s->buf_ptr >= s->buf_end)
174 void avio_flush(AVIOContext *s)
180 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
184 int force = whence & AVSEEK_FORCE;
185 whence &= ~AVSEEK_FORCE;
188 return AVERROR(EINVAL);
190 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
192 if (whence != SEEK_CUR && whence != SEEK_SET)
193 return AVERROR(EINVAL);
195 if (whence == SEEK_CUR) {
196 offset1 = pos + (s->buf_ptr - s->buffer);
201 offset1 = offset - pos;
202 if (!s->must_flush &&
203 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
204 /* can do the seek inside the buffer */
205 s->buf_ptr = s->buffer + offset1;
206 } else if ((!s->seekable ||
207 offset1 <= s->buf_end + SHORT_SEEK_THRESHOLD - s->buffer) &&
208 !s->write_flag && offset1 >= 0 &&
209 (whence != SEEK_END || force)) {
210 while(s->pos < offset && !s->eof_reached)
214 s->buf_ptr = s->buf_end + offset - s->pos;
218 #if CONFIG_MUXERS || CONFIG_NETWORK
223 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
225 return AVERROR(EPIPE);
226 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
229 s->buf_end = s->buffer;
230 s->buf_ptr = s->buffer;
237 int64_t avio_skip(AVIOContext *s, int64_t offset)
239 return avio_seek(s, offset, SEEK_CUR);
242 int64_t avio_size(AVIOContext *s)
247 return AVERROR(EINVAL);
250 return AVERROR(ENOSYS);
251 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
253 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
256 s->seek(s->opaque, s->pos, SEEK_SET);
261 int url_feof(AVIOContext *s)
269 return s->eof_reached;
272 void avio_wl32(AVIOContext *s, unsigned int val)
275 avio_w8(s, val >> 8);
276 avio_w8(s, val >> 16);
277 avio_w8(s, val >> 24);
280 void avio_wb32(AVIOContext *s, unsigned int val)
282 avio_w8(s, val >> 24);
283 avio_w8(s, val >> 16);
284 avio_w8(s, val >> 8);
288 int avio_put_str(AVIOContext *s, const char *str)
293 avio_write(s, (const unsigned char *) str, len);
299 int avio_put_str16le(AVIOContext *s, const char *str)
301 const uint8_t *q = str;
308 GET_UTF8(ch, *q++, break;)
309 PUT_UTF16(ch, tmp, avio_wl16(s, tmp);ret += 2;)
316 int ff_get_v_length(uint64_t val){
325 void ff_put_v(AVIOContext *bc, uint64_t val){
326 int i= ff_get_v_length(val);
329 avio_w8(bc, 128 | (val>>(7*i)));
331 avio_w8(bc, val&127);
334 void avio_wl64(AVIOContext *s, uint64_t val)
336 avio_wl32(s, (uint32_t)(val & 0xffffffff));
337 avio_wl32(s, (uint32_t)(val >> 32));
340 void avio_wb64(AVIOContext *s, uint64_t val)
342 avio_wb32(s, (uint32_t)(val >> 32));
343 avio_wb32(s, (uint32_t)(val & 0xffffffff));
346 void avio_wl16(AVIOContext *s, unsigned int val)
349 avio_w8(s, val >> 8);
352 void avio_wb16(AVIOContext *s, unsigned int val)
354 avio_w8(s, val >> 8);
358 void avio_wl24(AVIOContext *s, unsigned int val)
360 avio_wl16(s, val & 0xffff);
361 avio_w8(s, val >> 16);
364 void avio_wb24(AVIOContext *s, unsigned int val)
366 avio_wb16(s, val >> 8);
372 static void fill_buffer(AVIOContext *s)
374 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_end : s->buffer;
375 int len= s->buffer_size - (dst - s->buffer);
376 int max_buffer_size = s->max_packet_size ? s->max_packet_size : IO_BUFFER_SIZE;
378 /* can't fill the buffer without read_packet, just set EOF if appropiate */
379 if (!s->read_packet && s->buf_ptr >= s->buf_end)
382 /* no need to do anything if EOF already reached */
386 if(s->update_checksum && dst == s->buffer){
387 if(s->buf_end > s->checksum_ptr)
388 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
389 s->checksum_ptr= s->buffer;
392 /* make buffer smaller in case it ended up large after probing */
393 if (s->read_packet && s->buffer_size > max_buffer_size) {
394 ffio_set_buf_size(s, max_buffer_size);
396 s->checksum_ptr = dst = s->buffer;
397 len = s->buffer_size;
401 len = s->read_packet(s->opaque, dst, len);
405 /* do not modify buffer if EOF reached so that a seek back can
406 be done without rereading data */
413 s->buf_end = dst + len;
417 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
420 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
423 unsigned long ffio_get_checksum(AVIOContext *s)
425 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
426 s->update_checksum= NULL;
430 void ffio_init_checksum(AVIOContext *s,
431 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
432 unsigned long checksum)
434 s->update_checksum= update_checksum;
435 if(s->update_checksum){
436 s->checksum= checksum;
437 s->checksum_ptr= s->buf_ptr;
441 /* XXX: put an inline version */
442 int avio_r8(AVIOContext *s)
444 if (s->buf_ptr >= s->buf_end)
446 if (s->buf_ptr < s->buf_end)
447 return *s->buf_ptr++;
451 int avio_read(AVIOContext *s, unsigned char *buf, int size)
457 len = s->buf_end - s->buf_ptr;
461 if(size > s->buffer_size && !s->update_checksum){
463 len = s->read_packet(s->opaque, buf, size);
465 /* do not modify buffer if EOF reached so that a seek back can
466 be done without rereading data */
475 s->buf_ptr = s->buffer;
476 s->buf_end = s->buffer/* + len*/;
480 len = s->buf_end - s->buf_ptr;
485 memcpy(buf, s->buf_ptr, len);
492 if (s->error) return s->error;
493 if (url_feof(s)) return AVERROR_EOF;
498 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
505 len = s->buf_end - s->buf_ptr;
508 len = s->buf_end - s->buf_ptr;
512 memcpy(buf, s->buf_ptr, len);
515 if (s->error) return s->error;
516 if (url_feof(s)) return AVERROR_EOF;
521 unsigned int avio_rl16(AVIOContext *s)
525 val |= avio_r8(s) << 8;
529 unsigned int avio_rl24(AVIOContext *s)
533 val |= avio_r8(s) << 16;
537 unsigned int avio_rl32(AVIOContext *s)
541 val |= avio_rl16(s) << 16;
545 uint64_t avio_rl64(AVIOContext *s)
548 val = (uint64_t)avio_rl32(s);
549 val |= (uint64_t)avio_rl32(s) << 32;
553 unsigned int avio_rb16(AVIOContext *s)
556 val = avio_r8(s) << 8;
561 unsigned int avio_rb24(AVIOContext *s)
564 val = avio_rb16(s) << 8;
568 unsigned int avio_rb32(AVIOContext *s)
571 val = avio_rb16(s) << 16;
576 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
583 if (c && i < maxlen-1)
585 } while (c != '\n' && c);
591 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
596 return AVERROR(EINVAL);
597 // reserve 1 byte for terminating 0
598 buflen = FFMIN(buflen - 1, maxlen);
599 for (i = 0; i < buflen; i++)
600 if (!(buf[i] = avio_r8(s)))
603 for (; i < maxlen; i++)
609 #define GET_STR16(type, read) \
610 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
615 return AVERROR(EINVAL); \
616 while (ret + 1 < maxlen) {\
619 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
622 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
628 GET_STR16(le, avio_rl16)
629 GET_STR16(be, avio_rb16)
633 uint64_t avio_rb64(AVIOContext *s)
636 val = (uint64_t)avio_rb32(s) << 32;
637 val |= (uint64_t)avio_rb32(s);
641 uint64_t ffio_read_varlen(AVIOContext *bc){
647 val= (val<<7) + (tmp&127);
652 int ffio_fdopen(AVIOContext **s, URLContext *h)
655 int buffer_size, max_packet_size;
657 max_packet_size = h->max_packet_size;
658 if (max_packet_size) {
659 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
661 buffer_size = IO_BUFFER_SIZE;
663 buffer = av_malloc(buffer_size);
665 return AVERROR(ENOMEM);
667 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
668 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
671 return AVERROR(ENOMEM);
673 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
674 (*s)->max_packet_size = max_packet_size;
676 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
677 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
679 (*s)->av_class = &ffio_url_class;
683 int ffio_set_buf_size(AVIOContext *s, int buf_size)
686 buffer = av_malloc(buf_size);
688 return AVERROR(ENOMEM);
692 s->buffer_size = buf_size;
694 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
698 static int url_resetbuf(AVIOContext *s, int flags)
700 assert(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
702 if (flags & AVIO_FLAG_WRITE) {
703 s->buf_end = s->buffer + s->buffer_size;
706 s->buf_end = s->buffer;
712 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char *buf, int buf_size)
714 int64_t buffer_start;
716 int overlap, new_size, alloc_size;
719 return AVERROR(EINVAL);
721 buffer_size = s->buf_end - s->buffer;
723 /* the buffers must touch or overlap */
724 if ((buffer_start = s->pos - buffer_size) > buf_size)
725 return AVERROR(EINVAL);
727 overlap = buf_size - buffer_start;
728 new_size = buf_size + buffer_size - overlap;
730 alloc_size = FFMAX(s->buffer_size, new_size);
731 if (alloc_size > buf_size)
732 if (!(buf = av_realloc_f(buf, 1, alloc_size)))
733 return AVERROR(ENOMEM);
735 if (new_size > buf_size) {
736 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
741 s->buf_ptr = s->buffer = buf;
742 s->buffer_size = alloc_size;
744 s->buf_end = s->buf_ptr + buf_size;
751 int avio_open(AVIOContext **s, const char *filename, int flags)
753 return avio_open2(s, filename, flags, NULL, NULL);
756 int avio_open2(AVIOContext **s, const char *filename, int flags,
757 const AVIOInterruptCB *int_cb, AVDictionary **options)
762 err = ffurl_open(&h, filename, flags, int_cb, options);
765 err = ffio_fdopen(s, h);
773 int avio_close(AVIOContext *s)
775 URLContext *h = s->opaque;
779 return ffurl_close(h);
782 int avio_printf(AVIOContext *s, const char *fmt, ...)
789 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
791 avio_write(s, buf, strlen(buf));
795 int avio_pause(AVIOContext *s, int pause)
798 return AVERROR(ENOSYS);
799 return s->read_pause(s->opaque, pause);
802 int64_t avio_seek_time(AVIOContext *s, int stream_index,
803 int64_t timestamp, int flags)
805 URLContext *h = s->opaque;
808 return AVERROR(ENOSYS);
809 ret = s->read_seek(h, stream_index, timestamp, flags);
812 s->buf_ptr = s->buf_end; // Flush buffer
813 pos = s->seek(h, 0, SEEK_CUR);
816 else if (pos != AVERROR(ENOSYS))
822 /* output in a dynamic buffer */
824 typedef struct DynBuffer {
825 int pos, size, allocated_size;
828 uint8_t io_buffer[1];
831 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
833 DynBuffer *d = opaque;
834 unsigned new_size, new_allocated_size;
836 /* reallocate buffer if needed */
837 new_size = d->pos + buf_size;
838 new_allocated_size = d->allocated_size;
839 if(new_size < d->pos || new_size > INT_MAX/2)
841 while (new_size > new_allocated_size) {
842 if (!new_allocated_size)
843 new_allocated_size = new_size;
845 new_allocated_size += new_allocated_size / 2 + 1;
848 if (new_allocated_size > d->allocated_size) {
849 d->buffer = av_realloc_f(d->buffer, 1, new_allocated_size);
850 if(d->buffer == NULL)
851 return AVERROR(ENOMEM);
852 d->allocated_size = new_allocated_size;
854 memcpy(d->buffer + d->pos, buf, buf_size);
856 if (d->pos > d->size)
861 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
863 unsigned char buf1[4];
866 /* packetized write: output the header */
867 AV_WB32(buf1, buf_size);
868 ret= dyn_buf_write(opaque, buf1, 4);
873 return dyn_buf_write(opaque, buf, buf_size);
876 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
878 DynBuffer *d = opaque;
880 if (whence == SEEK_CUR)
882 else if (whence == SEEK_END)
884 if (offset < 0 || offset > 0x7fffffffLL)
890 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
893 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
895 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
897 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
899 return AVERROR(ENOMEM);
900 d->io_buffer_size = io_buffer_size;
901 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
902 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
903 max_packet_size ? NULL : dyn_buf_seek);
906 return AVERROR(ENOMEM);
908 (*s)->max_packet_size = max_packet_size;
912 int avio_open_dyn_buf(AVIOContext **s)
914 return url_open_dyn_buf_internal(s, 0);
917 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
919 if (max_packet_size <= 0)
921 return url_open_dyn_buf_internal(s, max_packet_size);
924 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
926 DynBuffer *d = s->opaque;
928 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
931 /* don't attempt to pad fixed-size packet buffers */
932 if (!s->max_packet_size) {
933 avio_write(s, padbuf, sizeof(padbuf));
934 padding = FF_INPUT_BUFFER_PADDING_SIZE;
939 *pbuffer = d->buffer;
943 return size - padding;