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;
84 url_resetbuf(s, write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
85 s->write_packet = write_packet;
86 s->read_packet = read_packet;
92 s->seekable = AVIO_SEEKABLE_NORMAL;
93 s->max_packet_size = 0;
94 s->update_checksum= NULL;
95 if(!read_packet && !write_flag){
97 s->buf_end = s->buffer + buffer_size;
104 AVIOContext *avio_alloc_context(
105 unsigned char *buffer,
109 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
110 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
111 int64_t (*seek)(void *opaque, int64_t offset, int whence))
113 AVIOContext *s = av_mallocz(sizeof(AVIOContext));
116 ffio_init_context(s, buffer, buffer_size, write_flag, opaque,
117 read_packet, write_packet, seek);
121 static void writeout(AVIOContext *s, const uint8_t *data, int len)
123 if (s->write_packet && !s->error){
124 int ret= s->write_packet(s->opaque, data, len);
132 static void flush_buffer(AVIOContext *s)
134 if (s->buf_ptr > s->buffer) {
135 writeout(s, s->buffer, s->buf_ptr - s->buffer);
136 if(s->update_checksum){
137 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
138 s->checksum_ptr= s->buffer;
141 s->buf_ptr = s->buffer;
144 void avio_w8(AVIOContext *s, int b)
147 if (s->buf_ptr >= s->buf_end)
151 void ffio_fill(AVIOContext *s, int b, int count)
154 int len = FFMIN(s->buf_end - s->buf_ptr, count);
155 memset(s->buf_ptr, b, len);
158 if (s->buf_ptr >= s->buf_end)
165 void avio_write(AVIOContext *s, const unsigned char *buf, int size)
167 if (s->direct && !s->update_checksum) {
169 writeout(s, buf, size);
173 int len = FFMIN(s->buf_end - s->buf_ptr, size);
174 memcpy(s->buf_ptr, buf, len);
177 if (s->buf_ptr >= s->buf_end)
185 void avio_flush(AVIOContext *s)
191 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence)
195 int force = whence & AVSEEK_FORCE;
196 whence &= ~AVSEEK_FORCE;
199 return AVERROR(EINVAL);
201 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
203 if (whence != SEEK_CUR && whence != SEEK_SET)
204 return AVERROR(EINVAL);
206 if (whence == SEEK_CUR) {
207 offset1 = pos + (s->buf_ptr - s->buffer);
212 offset1 = offset - pos;
213 if (!s->must_flush && (!s->direct || !s->seek) &&
214 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
215 /* can do the seek inside the buffer */
216 s->buf_ptr = s->buffer + offset1;
217 } else if ((!s->seekable ||
218 offset1 <= s->buf_end + SHORT_SEEK_THRESHOLD - s->buffer) &&
219 !s->write_flag && offset1 >= 0 &&
220 (!s->direct || !s->seek) &&
221 (whence != SEEK_END || force)) {
222 while(s->pos < offset && !s->eof_reached)
226 s->buf_ptr = s->buf_end + offset - s->pos;
230 #if CONFIG_MUXERS || CONFIG_NETWORK
235 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
237 return AVERROR(EPIPE);
238 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 appropiate */
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;
429 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
432 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
435 unsigned long ffio_get_checksum(AVIOContext *s)
437 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
438 s->update_checksum= NULL;
442 void ffio_init_checksum(AVIOContext *s,
443 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
444 unsigned long checksum)
446 s->update_checksum= update_checksum;
447 if(s->update_checksum){
448 s->checksum= checksum;
449 s->checksum_ptr= s->buf_ptr;
453 /* XXX: put an inline version */
454 int avio_r8(AVIOContext *s)
456 if (s->buf_ptr >= s->buf_end)
458 if (s->buf_ptr < s->buf_end)
459 return *s->buf_ptr++;
463 int avio_read(AVIOContext *s, unsigned char *buf, int size)
469 len = s->buf_end - s->buf_ptr;
473 if((s->direct || size > s->buffer_size) && !s->update_checksum){
475 len = s->read_packet(s->opaque, buf, size);
477 /* do not modify buffer if EOF reached so that a seek back can
478 be done without rereading data */
487 s->buf_ptr = s->buffer;
488 s->buf_end = s->buffer/* + len*/;
492 len = s->buf_end - s->buf_ptr;
497 memcpy(buf, s->buf_ptr, len);
504 if (s->error) return s->error;
505 if (url_feof(s)) return AVERROR_EOF;
510 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size)
517 len = s->buf_end - s->buf_ptr;
520 len = s->buf_end - s->buf_ptr;
524 memcpy(buf, s->buf_ptr, len);
527 if (s->error) return s->error;
528 if (url_feof(s)) return AVERROR_EOF;
533 unsigned int avio_rl16(AVIOContext *s)
537 val |= avio_r8(s) << 8;
541 unsigned int avio_rl24(AVIOContext *s)
545 val |= avio_r8(s) << 16;
549 unsigned int avio_rl32(AVIOContext *s)
553 val |= avio_rl16(s) << 16;
557 uint64_t avio_rl64(AVIOContext *s)
560 val = (uint64_t)avio_rl32(s);
561 val |= (uint64_t)avio_rl32(s) << 32;
565 unsigned int avio_rb16(AVIOContext *s)
568 val = avio_r8(s) << 8;
573 unsigned int avio_rb24(AVIOContext *s)
576 val = avio_rb16(s) << 8;
580 unsigned int avio_rb32(AVIOContext *s)
583 val = avio_rb16(s) << 16;
588 int ff_get_line(AVIOContext *s, char *buf, int maxlen)
595 if (c && i < maxlen-1)
597 } while (c != '\n' && c);
603 int avio_get_str(AVIOContext *s, int maxlen, char *buf, int buflen)
608 return AVERROR(EINVAL);
609 // reserve 1 byte for terminating 0
610 buflen = FFMIN(buflen - 1, maxlen);
611 for (i = 0; i < buflen; i++)
612 if (!(buf[i] = avio_r8(s)))
615 for (; i < maxlen; i++)
621 #define GET_STR16(type, read) \
622 int avio_get_str16 ##type(AVIOContext *pb, int maxlen, char *buf, int buflen)\
627 return AVERROR(EINVAL); \
628 while (ret + 1 < maxlen) {\
631 GET_UTF16(ch, (ret += 2) <= maxlen ? read(pb) : 0, break;)\
634 PUT_UTF8(ch, tmp, if (q - buf < buflen - 1) *q++ = tmp;)\
640 GET_STR16(le, avio_rl16)
641 GET_STR16(be, avio_rb16)
645 uint64_t avio_rb64(AVIOContext *s)
648 val = (uint64_t)avio_rb32(s) << 32;
649 val |= (uint64_t)avio_rb32(s);
653 uint64_t ffio_read_varlen(AVIOContext *bc){
659 val= (val<<7) + (tmp&127);
664 int ffio_fdopen(AVIOContext **s, URLContext *h)
667 int buffer_size, max_packet_size;
669 max_packet_size = h->max_packet_size;
670 if (max_packet_size) {
671 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
673 buffer_size = IO_BUFFER_SIZE;
675 buffer = av_malloc(buffer_size);
677 return AVERROR(ENOMEM);
679 *s = avio_alloc_context(buffer, buffer_size, h->flags & AVIO_FLAG_WRITE, h,
680 (void*)ffurl_read, (void*)ffurl_write, (void*)ffurl_seek);
683 return AVERROR(ENOMEM);
685 (*s)->direct = h->flags & AVIO_FLAG_DIRECT;
686 (*s)->seekable = h->is_streamed ? 0 : AVIO_SEEKABLE_NORMAL;
687 (*s)->max_packet_size = max_packet_size;
689 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
690 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
692 (*s)->av_class = &ffio_url_class;
696 int ffio_set_buf_size(AVIOContext *s, int buf_size)
699 buffer = av_malloc(buf_size);
701 return AVERROR(ENOMEM);
705 s->buffer_size = buf_size;
707 url_resetbuf(s, s->write_flag ? AVIO_FLAG_WRITE : AVIO_FLAG_READ);
711 static int url_resetbuf(AVIOContext *s, int flags)
713 assert(flags == AVIO_FLAG_WRITE || flags == AVIO_FLAG_READ);
715 if (flags & AVIO_FLAG_WRITE) {
716 s->buf_end = s->buffer + s->buffer_size;
719 s->buf_end = s->buffer;
725 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char *buf, int buf_size)
727 int64_t buffer_start;
729 int overlap, new_size, alloc_size;
732 return AVERROR(EINVAL);
734 buffer_size = s->buf_end - s->buffer;
736 /* the buffers must touch or overlap */
737 if ((buffer_start = s->pos - buffer_size) > buf_size)
738 return AVERROR(EINVAL);
740 overlap = buf_size - buffer_start;
741 new_size = buf_size + buffer_size - overlap;
743 alloc_size = FFMAX(s->buffer_size, new_size);
744 if (alloc_size > buf_size)
745 if (!(buf = av_realloc_f(buf, 1, alloc_size)))
746 return AVERROR(ENOMEM);
748 if (new_size > buf_size) {
749 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
754 s->buf_ptr = s->buffer = buf;
755 s->buffer_size = alloc_size;
757 s->buf_end = s->buf_ptr + buf_size;
764 int avio_open(AVIOContext **s, const char *filename, int flags)
766 return avio_open2(s, filename, flags, NULL, NULL);
769 int avio_open2(AVIOContext **s, const char *filename, int flags,
770 const AVIOInterruptCB *int_cb, AVDictionary **options)
775 err = ffurl_open(&h, filename, flags, int_cb, options);
778 err = ffio_fdopen(s, h);
786 int avio_close(AVIOContext *s)
796 return ffurl_close(h);
799 int avio_printf(AVIOContext *s, const char *fmt, ...)
806 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
808 avio_write(s, buf, strlen(buf));
812 int avio_pause(AVIOContext *s, int pause)
815 return AVERROR(ENOSYS);
816 return s->read_pause(s->opaque, pause);
819 int64_t avio_seek_time(AVIOContext *s, int stream_index,
820 int64_t timestamp, int flags)
822 URLContext *h = s->opaque;
825 return AVERROR(ENOSYS);
826 ret = s->read_seek(h, stream_index, timestamp, flags);
829 s->buf_ptr = s->buf_end; // Flush buffer
830 pos = s->seek(h, 0, SEEK_CUR);
833 else if (pos != AVERROR(ENOSYS))
839 /* output in a dynamic buffer */
841 typedef struct DynBuffer {
842 int pos, size, allocated_size;
845 uint8_t io_buffer[1];
848 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
850 DynBuffer *d = opaque;
851 unsigned new_size, new_allocated_size;
853 /* reallocate buffer if needed */
854 new_size = d->pos + buf_size;
855 new_allocated_size = d->allocated_size;
856 if(new_size < d->pos || new_size > INT_MAX/2)
858 while (new_size > new_allocated_size) {
859 if (!new_allocated_size)
860 new_allocated_size = new_size;
862 new_allocated_size += new_allocated_size / 2 + 1;
865 if (new_allocated_size > d->allocated_size) {
866 d->buffer = av_realloc_f(d->buffer, 1, new_allocated_size);
867 if(d->buffer == NULL)
868 return AVERROR(ENOMEM);
869 d->allocated_size = new_allocated_size;
871 memcpy(d->buffer + d->pos, buf, buf_size);
873 if (d->pos > d->size)
878 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
880 unsigned char buf1[4];
883 /* packetized write: output the header */
884 AV_WB32(buf1, buf_size);
885 ret= dyn_buf_write(opaque, buf1, 4);
890 return dyn_buf_write(opaque, buf, buf_size);
893 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
895 DynBuffer *d = opaque;
897 if (whence == SEEK_CUR)
899 else if (whence == SEEK_END)
901 if (offset < 0 || offset > 0x7fffffffLL)
907 static int url_open_dyn_buf_internal(AVIOContext **s, int max_packet_size)
910 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
912 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
914 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
916 return AVERROR(ENOMEM);
917 d->io_buffer_size = io_buffer_size;
918 *s = avio_alloc_context(d->io_buffer, d->io_buffer_size, 1, d, NULL,
919 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
920 max_packet_size ? NULL : dyn_buf_seek);
923 return AVERROR(ENOMEM);
925 (*s)->max_packet_size = max_packet_size;
929 int avio_open_dyn_buf(AVIOContext **s)
931 return url_open_dyn_buf_internal(s, 0);
934 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size)
936 if (max_packet_size <= 0)
938 return url_open_dyn_buf_internal(s, max_packet_size);
941 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer)
943 DynBuffer *d = s->opaque;
945 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
948 /* don't attempt to pad fixed-size packet buffers */
949 if (!s->max_packet_size) {
950 avio_write(s, padbuf, sizeof(padbuf));
951 padding = FF_INPUT_BUFFER_PADDING_SIZE;
956 *pbuffer = d->buffer;
960 return size - padding;