2 * Buffered I/O for ffmpeg system
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/intreadwrite.h"
29 #define IO_BUFFER_SIZE 32768
31 static void fill_buffer(ByteIOContext *s);
32 #if LIBAVFORMAT_VERSION_MAJOR >= 53
33 static int url_resetbuf(ByteIOContext *s, int flags);
36 int init_put_byte(ByteIOContext *s,
37 unsigned char *buffer,
41 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
42 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
43 int64_t (*seek)(void *opaque, int64_t offset, int whence))
46 s->buffer_size = buffer_size;
49 url_resetbuf(s, write_flag ? URL_WRONLY : URL_RDONLY);
50 s->write_packet = write_packet;
51 s->read_packet = read_packet;
58 s->max_packet_size = 0;
59 s->update_checksum= NULL;
60 if(!read_packet && !write_flag){
62 s->buf_end = s->buffer + buffer_size;
69 ByteIOContext *av_alloc_put_byte(
70 unsigned char *buffer,
74 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
75 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
76 int64_t (*seek)(void *opaque, int64_t offset, int whence))
78 ByteIOContext *s = av_mallocz(sizeof(ByteIOContext));
79 init_put_byte(s, buffer, buffer_size, write_flag, opaque,
80 read_packet, write_packet, seek);
84 static void flush_buffer(ByteIOContext *s)
86 if (s->buf_ptr > s->buffer) {
87 if (s->write_packet && !s->error){
88 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
93 if(s->update_checksum){
94 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
95 s->checksum_ptr= s->buffer;
97 s->pos += s->buf_ptr - s->buffer;
99 s->buf_ptr = s->buffer;
102 void put_byte(ByteIOContext *s, int b)
105 if (s->buf_ptr >= s->buf_end)
109 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
112 int len = FFMIN(s->buf_end - s->buf_ptr, size);
113 memcpy(s->buf_ptr, buf, len);
116 if (s->buf_ptr >= s->buf_end)
124 void put_flush_packet(ByteIOContext *s)
130 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence)
134 int force = whence & AVSEEK_FORCE;
135 whence &= ~AVSEEK_FORCE;
138 return AVERROR(EINVAL);
140 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
142 if (whence != SEEK_CUR && whence != SEEK_SET)
143 return AVERROR(EINVAL);
145 if (whence == SEEK_CUR) {
146 offset1 = pos + (s->buf_ptr - s->buffer);
151 offset1 = offset - pos;
152 if (!s->must_flush &&
153 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
154 /* can do the seek inside the buffer */
155 s->buf_ptr = s->buffer + offset1;
156 } else if(s->is_streamed && !s->write_flag && offset1 >= 0 &&
157 (whence != SEEK_END || force)) {
158 while(s->pos < offset && !s->eof_reached)
162 s->buf_ptr = s->buf_end + offset - s->pos;
166 #if CONFIG_MUXERS || CONFIG_NETWORK
171 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
173 return AVERROR(EPIPE);
174 if ((res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
177 s->buf_end = s->buffer;
178 s->buf_ptr = s->buffer;
185 void url_fskip(ByteIOContext *s, int64_t offset)
187 url_fseek(s, offset, SEEK_CUR);
190 int64_t url_ftell(ByteIOContext *s)
192 return url_fseek(s, 0, SEEK_CUR);
195 int64_t url_fsize(ByteIOContext *s)
200 return AVERROR(EINVAL);
203 return AVERROR(ENOSYS);
204 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
206 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
209 s->seek(s->opaque, s->pos, SEEK_SET);
214 int url_feof(ByteIOContext *s)
218 return s->eof_reached;
221 int url_ferror(ByteIOContext *s)
228 void put_le32(ByteIOContext *s, unsigned int val)
231 put_byte(s, val >> 8);
232 put_byte(s, val >> 16);
233 put_byte(s, val >> 24);
236 void put_be32(ByteIOContext *s, unsigned int val)
238 put_byte(s, val >> 24);
239 put_byte(s, val >> 16);
240 put_byte(s, val >> 8);
244 void put_strz(ByteIOContext *s, const char *str)
247 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
252 int ff_get_v_length(uint64_t val){
261 void ff_put_v(ByteIOContext *bc, uint64_t val){
262 int i= ff_get_v_length(val);
265 put_byte(bc, 128 | (val>>(7*i)));
267 put_byte(bc, val&127);
270 void put_le64(ByteIOContext *s, uint64_t val)
272 put_le32(s, (uint32_t)(val & 0xffffffff));
273 put_le32(s, (uint32_t)(val >> 32));
276 void put_be64(ByteIOContext *s, uint64_t val)
278 put_be32(s, (uint32_t)(val >> 32));
279 put_be32(s, (uint32_t)(val & 0xffffffff));
282 void put_le16(ByteIOContext *s, unsigned int val)
285 put_byte(s, val >> 8);
288 void put_be16(ByteIOContext *s, unsigned int val)
290 put_byte(s, val >> 8);
294 void put_le24(ByteIOContext *s, unsigned int val)
296 put_le16(s, val & 0xffff);
297 put_byte(s, val >> 16);
300 void put_be24(ByteIOContext *s, unsigned int val)
302 put_be16(s, val >> 8);
306 void put_tag(ByteIOContext *s, const char *tag)
315 static void fill_buffer(ByteIOContext *s)
317 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
318 int len= s->buffer_size - (dst - s->buffer);
319 int max_buffer_size = s->max_packet_size ? s->max_packet_size : IO_BUFFER_SIZE;
321 assert(s->buf_ptr == s->buf_end);
323 /* no need to do anything if EOF already reached */
327 if(s->update_checksum && dst == s->buffer){
328 if(s->buf_end > s->checksum_ptr)
329 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
330 s->checksum_ptr= s->buffer;
333 /* make buffer smaller in case it ended up large after probing */
334 if (s->buffer_size > max_buffer_size) {
335 url_setbufsize(s, max_buffer_size);
337 s->checksum_ptr = dst = s->buffer;
338 len = s->buffer_size;
342 len = s->read_packet(s->opaque, dst, len);
346 /* do not modify buffer if EOF reached so that a seek back can
347 be done without rereading data */
354 s->buf_end = dst + len;
358 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
361 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
364 unsigned long get_checksum(ByteIOContext *s)
366 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
367 s->update_checksum= NULL;
371 void init_checksum(ByteIOContext *s,
372 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
373 unsigned long checksum)
375 s->update_checksum= update_checksum;
376 if(s->update_checksum){
377 s->checksum= checksum;
378 s->checksum_ptr= s->buf_ptr;
382 /* XXX: put an inline version */
383 int get_byte(ByteIOContext *s)
385 if (s->buf_ptr < s->buf_end) {
386 return *s->buf_ptr++;
389 if (s->buf_ptr < s->buf_end)
390 return *s->buf_ptr++;
396 int url_fgetc(ByteIOContext *s)
398 if (s->buf_ptr < s->buf_end) {
399 return *s->buf_ptr++;
402 if (s->buf_ptr < s->buf_end)
403 return *s->buf_ptr++;
409 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
415 len = s->buf_end - s->buf_ptr;
419 if(size > s->buffer_size && !s->update_checksum){
421 len = s->read_packet(s->opaque, buf, size);
423 /* do not modify buffer if EOF reached so that a seek back can
424 be done without rereading data */
433 s->buf_ptr = s->buffer;
434 s->buf_end = s->buffer/* + len*/;
438 len = s->buf_end - s->buf_ptr;
443 memcpy(buf, s->buf_ptr, len);
450 if (url_ferror(s)) return url_ferror(s);
451 if (url_feof(s)) return AVERROR_EOF;
456 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
463 len = s->buf_end - s->buf_ptr;
466 len = s->buf_end - s->buf_ptr;
470 memcpy(buf, s->buf_ptr, len);
473 if (url_ferror(s)) return url_ferror(s);
474 if (url_feof(s)) return AVERROR_EOF;
479 unsigned int get_le16(ByteIOContext *s)
483 val |= get_byte(s) << 8;
487 unsigned int get_le24(ByteIOContext *s)
491 val |= get_byte(s) << 16;
495 unsigned int get_le32(ByteIOContext *s)
499 val |= get_le16(s) << 16;
503 uint64_t get_le64(ByteIOContext *s)
506 val = (uint64_t)get_le32(s);
507 val |= (uint64_t)get_le32(s) << 32;
511 unsigned int get_be16(ByteIOContext *s)
514 val = get_byte(s) << 8;
519 unsigned int get_be24(ByteIOContext *s)
522 val = get_be16(s) << 8;
526 unsigned int get_be32(ByteIOContext *s)
529 val = get_be16(s) << 16;
534 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
539 while ((c = get_byte(s))) {
544 buf[i] = 0; /* Ensure null terminated, but may be truncated */
549 uint64_t get_be64(ByteIOContext *s)
552 val = (uint64_t)get_be32(s) << 32;
553 val |= (uint64_t)get_be32(s);
557 uint64_t ff_get_v(ByteIOContext *bc){
563 val= (val<<7) + (tmp&127);
568 int url_fdopen(ByteIOContext **s, URLContext *h)
571 int buffer_size, max_packet_size;
573 max_packet_size = url_get_max_packet_size(h);
574 if (max_packet_size) {
575 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
577 buffer_size = IO_BUFFER_SIZE;
579 buffer = av_malloc(buffer_size);
581 return AVERROR(ENOMEM);
583 *s = av_mallocz(sizeof(ByteIOContext));
586 return AVERROR(ENOMEM);
589 if (init_put_byte(*s, buffer, buffer_size,
590 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
591 url_read, url_write, url_seek) < 0) {
596 (*s)->is_streamed = h->is_streamed;
597 (*s)->max_packet_size = max_packet_size;
599 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
600 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
605 int url_setbufsize(ByteIOContext *s, int buf_size)
608 buffer = av_malloc(buf_size);
610 return AVERROR(ENOMEM);
614 s->buffer_size = buf_size;
616 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
620 #if LIBAVFORMAT_VERSION_MAJOR < 53
621 int url_resetbuf(ByteIOContext *s, int flags)
623 static int url_resetbuf(ByteIOContext *s, int flags)
626 #if LIBAVFORMAT_VERSION_MAJOR < 53
627 if (flags & URL_RDWR)
628 return AVERROR(EINVAL);
630 assert(flags == URL_WRONLY || flags == URL_RDONLY);
633 if (flags & URL_WRONLY) {
634 s->buf_end = s->buffer + s->buffer_size;
637 s->buf_end = s->buffer;
643 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size)
645 int64_t buffer_start;
647 int overlap, new_size;
650 return AVERROR(EINVAL);
652 buffer_size = s->buf_end - s->buffer;
654 /* the buffers must touch or overlap */
655 if ((buffer_start = s->pos - buffer_size) > buf_size)
656 return AVERROR(EINVAL);
658 overlap = buf_size - buffer_start;
659 new_size = buf_size + buffer_size - overlap;
661 if (new_size > buf_size) {
662 if (!(buf = av_realloc(buf, new_size)))
663 return AVERROR(ENOMEM);
665 memcpy(buf + buf_size, s->buffer + overlap, buffer_size - overlap);
670 s->buf_ptr = s->buffer = buf;
671 s->pos = s->buffer_size = buf_size;
672 s->buf_end = s->buf_ptr + buf_size;
679 int url_fopen(ByteIOContext **s, const char *filename, int flags)
684 err = url_open(&h, filename, flags);
687 err = url_fdopen(s, h);
695 int url_fclose(ByteIOContext *s)
697 URLContext *h = s->opaque;
704 URLContext *url_fileno(ByteIOContext *s)
710 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
717 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
719 put_buffer(s, buf, strlen(buf));
722 #endif //CONFIG_MUXERS
724 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
734 if (c == EOF || c == '\n')
736 if ((q - buf) < buf_size - 1)
745 int url_fget_max_packet_size(ByteIOContext *s)
747 return s->max_packet_size;
750 int av_url_read_fpause(ByteIOContext *s, int pause)
753 return AVERROR(ENOSYS);
754 return s->read_pause(s->opaque, pause);
757 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
758 int64_t timestamp, int flags)
760 URLContext *h = s->opaque;
763 return AVERROR(ENOSYS);
764 ret = s->read_seek(h, stream_index, timestamp, flags);
767 s->buf_ptr = s->buf_end; // Flush buffer
768 pos = s->seek(h, 0, SEEK_CUR);
771 else if (pos != AVERROR(ENOSYS))
777 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
778 * back to the server even if CONFIG_MUXERS is false. */
779 #if CONFIG_MUXERS || CONFIG_NETWORK
780 /* buffer handling */
781 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
784 *s = av_mallocz(sizeof(ByteIOContext));
786 return AVERROR(ENOMEM);
787 ret = init_put_byte(*s, buf, buf_size,
788 (flags & URL_WRONLY || flags & URL_RDWR),
789 NULL, NULL, NULL, NULL);
795 int url_close_buf(ByteIOContext *s)
798 return s->buf_ptr - s->buffer;
801 /* output in a dynamic buffer */
803 typedef struct DynBuffer {
804 int pos, size, allocated_size;
807 uint8_t io_buffer[1];
810 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
812 DynBuffer *d = opaque;
813 unsigned new_size, new_allocated_size;
815 /* reallocate buffer if needed */
816 new_size = d->pos + buf_size;
817 new_allocated_size = d->allocated_size;
818 if(new_size < d->pos || new_size > INT_MAX/2)
820 while (new_size > new_allocated_size) {
821 if (!new_allocated_size)
822 new_allocated_size = new_size;
824 new_allocated_size += new_allocated_size / 2 + 1;
827 if (new_allocated_size > d->allocated_size) {
828 d->buffer = av_realloc(d->buffer, new_allocated_size);
829 if(d->buffer == NULL)
830 return AVERROR(ENOMEM);
831 d->allocated_size = new_allocated_size;
833 memcpy(d->buffer + d->pos, buf, buf_size);
835 if (d->pos > d->size)
840 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
842 unsigned char buf1[4];
845 /* packetized write: output the header */
846 AV_WB32(buf1, buf_size);
847 ret= dyn_buf_write(opaque, buf1, 4);
852 return dyn_buf_write(opaque, buf, buf_size);
855 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
857 DynBuffer *d = opaque;
859 if (whence == SEEK_CUR)
861 else if (whence == SEEK_END)
863 if (offset < 0 || offset > 0x7fffffffLL)
869 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
873 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
875 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
877 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
879 return AVERROR(ENOMEM);
880 *s = av_mallocz(sizeof(ByteIOContext));
883 return AVERROR(ENOMEM);
885 d->io_buffer_size = io_buffer_size;
886 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
888 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
889 max_packet_size ? NULL : dyn_buf_seek);
891 (*s)->max_packet_size = max_packet_size;
899 int url_open_dyn_buf(ByteIOContext **s)
901 return url_open_dyn_buf_internal(s, 0);
904 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
906 if (max_packet_size <= 0)
908 return url_open_dyn_buf_internal(s, max_packet_size);
911 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
913 DynBuffer *d = s->opaque;
915 static const char padbuf[FF_INPUT_BUFFER_PADDING_SIZE] = {0};
918 /* don't attempt to pad fixed-size packet buffers */
919 if (!s->max_packet_size) {
920 put_buffer(s, padbuf, sizeof(padbuf));
921 padding = FF_INPUT_BUFFER_PADDING_SIZE;
926 *pbuffer = d->buffer;
930 return size - padding;
932 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */