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"
30 #define IO_BUFFER_SIZE 32768
32 static void fill_buffer(ByteIOContext *s);
34 int init_put_byte(ByteIOContext *s,
35 unsigned char *buffer,
39 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
40 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
41 int64_t (*seek)(void *opaque, int64_t offset, int whence))
44 s->buffer_size = buffer_size;
47 url_resetbuf(s, write_flag ? URL_WRONLY : URL_RDONLY);
48 s->write_packet = write_packet;
49 s->read_packet = read_packet;
56 s->max_packet_size = 0;
57 s->update_checksum= NULL;
58 if(!read_packet && !write_flag){
60 s->buf_end = s->buffer + buffer_size;
67 ByteIOContext *av_alloc_put_byte(
68 unsigned char *buffer,
72 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
73 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
74 int64_t (*seek)(void *opaque, int64_t offset, int whence))
76 ByteIOContext *s = av_mallocz(sizeof(ByteIOContext));
77 init_put_byte(s, buffer, buffer_size, write_flag, opaque,
78 read_packet, write_packet, seek);
82 #define BLOCK_SIZE 512
84 static void flush_buffer_o_direct(ByteIOContext *s)
86 size_t data_len = s->buf_ptr - s->buffer;
88 /* Write all data in the buffer to the disk together with any
89 * additional space at the end of the buffer up to the first
90 * multiple of BLOCK_SIZE. The last block is always written to the
91 * disk despite not being fully filled. If the last block is not
92 * fully filled, we keep it (moved to the begginig of the buffer)
93 * and any subsequent call to this function will rewrite the block
94 * together with the additional data added to the buffer. */
95 size_t to_write = (data_len + BLOCK_SIZE - 1) & ~(BLOCK_SIZE - 1);
96 size_t whole_blocks = data_len & ~(BLOCK_SIZE - 1);
97 int64_t res = AVERROR(EPIPE);
99 av_log(NULL, AV_LOG_ERROR, " really writing %zx\n", to_write);
101 if (s->write_packet && !s->error){
102 int ret= s->write_packet(s->opaque, s->buffer, to_write);
107 if(s->update_checksum){
108 av_log(NULL, AV_LOG_ERROR, "Checksumming not implemented in O_DIRECT patch\n");
109 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
110 s->checksum_ptr= s->buffer;
113 memcpy(s->buffer, &s->buffer[whole_blocks], data_len - whole_blocks);
114 s->buf_ptr -= whole_blocks;
117 res = s->seek(s->opaque, s->pos - to_write + whole_blocks, SEEK_SET);
119 av_log(NULL, AV_LOG_ERROR, "seek error inside %s: %lld\n", __func__, res);
120 //av_log(NULL, AV_LOG_ERROR, "ZZZ tw=%zu, pos=%zd\n", to_write, s->pos);
124 static void flush_buffer(ByteIOContext *s)
126 av_log(NULL, AV_LOG_ERROR, "WRITE %p: pos=%zx len=%zx\n", s, s->pos, s->buf_ptr - s->buffer);
127 if (s->o_direct_flag) {
128 flush_buffer_o_direct(s);
131 if (s->buf_ptr > s->buffer) {
132 if (s->write_packet && !s->error){
133 int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
138 if(s->update_checksum){
139 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
140 s->checksum_ptr= s->buffer;
142 s->pos += s->buf_ptr - s->buffer;
144 s->buf_ptr = s->buffer;
147 void put_byte(ByteIOContext *s, int b)
150 if (s->buf_ptr >= s->buf_end)
154 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
159 len = (s->buf_end - s->buf_ptr);
162 memcpy(s->buf_ptr, buf, len);
165 if (s->buf_ptr >= s->buf_end)
173 void put_flush_packet(ByteIOContext *s)
179 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence)
185 return AVERROR(EINVAL);
187 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
189 if (whence != SEEK_CUR && whence != SEEK_SET)
190 return AVERROR(EINVAL);
192 if (whence == SEEK_CUR) {
193 offset1 = pos + (s->buf_ptr - s->buffer);
198 //if (s->o_direct_flag)
199 av_log(NULL, AV_LOG_ERROR, "SEEK %p: from %llx to %llx\n", s, pos, offset);
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 if (s->o_direct_flag)
207 av_log(NULL, AV_LOG_ERROR, "Internal seek by %llx\n", offset1);
208 } else if(s->is_streamed && !s->write_flag &&
209 offset1 >= 0 && offset1 < (s->buf_end - s->buffer) + (1<<16)){
210 while(s->pos < offset && !s->eof_reached)
213 return AVERROR(EPIPE);
214 s->buf_ptr = s->buf_end + offset - s->pos;
216 int64_t res = AVERROR(EPIPE);
218 #if CONFIG_MUXERS || CONFIG_NETWORK
223 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
224 if (s->o_direct_flag) {
225 /* Read the whole block from the seek destination */
226 offset1 = offset & ~(BLOCK_SIZE - 1);
227 if (!s->seek || (res = s->seek(s->opaque, offset1, SEEK_SET)) < 0)
229 av_log(NULL, AV_LOG_ERROR, "READ block from %llx\n", offset1);
230 if ((res = s->read_packet(s->opaque, s->buffer, BLOCK_SIZE)) < 0)
232 if (!s->seek || (res = s->seek(s->opaque, offset1, SEEK_SET)) < 0)
234 s->buf_ptr = s->buffer + offset - offset1;
237 if (!s->seek || (res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
240 s->buf_end = s->buffer;
241 s->buf_ptr = s->buffer;
249 void url_fskip(ByteIOContext *s, int64_t offset)
251 url_fseek(s, offset, SEEK_CUR);
254 int64_t url_ftell(ByteIOContext *s)
256 return url_fseek(s, 0, SEEK_CUR);
259 int64_t url_fsize(ByteIOContext *s)
264 return AVERROR(EINVAL);
267 return AVERROR(EPIPE);
268 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
270 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
273 s->seek(s->opaque, s->pos, SEEK_SET);
278 int url_feof(ByteIOContext *s)
282 return s->eof_reached;
285 int url_ferror(ByteIOContext *s)
292 void put_le32(ByteIOContext *s, unsigned int val)
295 put_byte(s, val >> 8);
296 put_byte(s, val >> 16);
297 put_byte(s, val >> 24);
300 void put_be32(ByteIOContext *s, unsigned int val)
302 put_byte(s, val >> 24);
303 put_byte(s, val >> 16);
304 put_byte(s, val >> 8);
308 void put_strz(ByteIOContext *s, const char *str)
311 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
316 void put_le64(ByteIOContext *s, uint64_t val)
318 put_le32(s, (uint32_t)(val & 0xffffffff));
319 put_le32(s, (uint32_t)(val >> 32));
322 void put_be64(ByteIOContext *s, uint64_t val)
324 put_be32(s, (uint32_t)(val >> 32));
325 put_be32(s, (uint32_t)(val & 0xffffffff));
328 void put_le16(ByteIOContext *s, unsigned int val)
331 put_byte(s, val >> 8);
334 void put_be16(ByteIOContext *s, unsigned int val)
336 put_byte(s, val >> 8);
340 void put_le24(ByteIOContext *s, unsigned int val)
342 put_le16(s, val & 0xffff);
343 put_byte(s, val >> 16);
346 void put_be24(ByteIOContext *s, unsigned int val)
348 put_be16(s, val >> 8);
352 void put_tag(ByteIOContext *s, const char *tag)
361 static void fill_buffer(ByteIOContext *s)
363 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
364 int len= s->buffer_size - (dst - s->buffer);
366 assert(s->buf_ptr == s->buf_end);
368 /* no need to do anything if EOF already reached */
372 if(s->update_checksum && dst == s->buffer){
373 if(s->buf_end > s->checksum_ptr)
374 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
375 s->checksum_ptr= s->buffer;
379 len = s->read_packet(s->opaque, dst, len);
383 /* do not modify buffer if EOF reached so that a seek back can
384 be done without rereading data */
391 s->buf_end = dst + len;
395 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
398 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
401 unsigned long get_checksum(ByteIOContext *s)
403 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
404 s->update_checksum= NULL;
408 void init_checksum(ByteIOContext *s,
409 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
410 unsigned long checksum)
412 s->update_checksum= update_checksum;
413 if(s->update_checksum){
414 s->checksum= checksum;
415 s->checksum_ptr= s->buf_ptr;
419 /* XXX: put an inline version */
420 int get_byte(ByteIOContext *s)
422 if (s->buf_ptr < s->buf_end) {
423 return *s->buf_ptr++;
426 if (s->buf_ptr < s->buf_end)
427 return *s->buf_ptr++;
433 int url_fgetc(ByteIOContext *s)
435 if (s->buf_ptr < s->buf_end) {
436 return *s->buf_ptr++;
439 if (s->buf_ptr < s->buf_end)
440 return *s->buf_ptr++;
446 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
452 len = s->buf_end - s->buf_ptr;
456 if(size > s->buffer_size && !s->update_checksum){
458 len = s->read_packet(s->opaque, buf, size);
460 /* do not modify buffer if EOF reached so that a seek back can
461 be done without rereading data */
470 s->buf_ptr = s->buffer;
471 s->buf_end = s->buffer/* + len*/;
475 len = s->buf_end - s->buf_ptr;
480 memcpy(buf, s->buf_ptr, len);
489 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
496 len = s->buf_end - s->buf_ptr;
499 len = s->buf_end - s->buf_ptr;
503 memcpy(buf, s->buf_ptr, len);
508 unsigned int get_le16(ByteIOContext *s)
512 val |= get_byte(s) << 8;
516 unsigned int get_le24(ByteIOContext *s)
520 val |= get_byte(s) << 16;
524 unsigned int get_le32(ByteIOContext *s)
528 val |= get_le16(s) << 16;
532 uint64_t get_le64(ByteIOContext *s)
535 val = (uint64_t)get_le32(s);
536 val |= (uint64_t)get_le32(s) << 32;
540 unsigned int get_be16(ByteIOContext *s)
543 val = get_byte(s) << 8;
548 unsigned int get_be24(ByteIOContext *s)
551 val = get_be16(s) << 8;
555 unsigned int get_be32(ByteIOContext *s)
558 val = get_be16(s) << 16;
563 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
568 while ((c = get_byte(s))) {
573 buf[i] = 0; /* Ensure null terminated, but may be truncated */
578 uint64_t get_be64(ByteIOContext *s)
581 val = (uint64_t)get_be32(s) << 32;
582 val |= (uint64_t)get_be32(s);
586 uint64_t ff_get_v(ByteIOContext *bc){
592 val= (val<<7) + (tmp&127);
597 int url_fdopen(ByteIOContext **s, URLContext *h)
600 int buffer_size, max_packet_size;
603 max_packet_size = url_get_max_packet_size(h);
604 if (max_packet_size) {
605 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
607 buffer_size = IO_BUFFER_SIZE;
609 if (h->flags & URL_DIRECT) {
610 if ((h->flags & URL_RDWR) == 0)
611 return AVERROR(EINVAL); /* We need read beacuse of url_fseek() */
612 buffer_size = 2*buffer_size+BLOCK_SIZE;
613 buffer = memalign(sysconf(_SC_PAGESIZE), buffer_size);
615 buffer = av_malloc(buffer_size);
618 return AVERROR(ENOMEM);
620 *s = av_mallocz(sizeof(ByteIOContext));
623 return AVERROR(ENOMEM);
626 if (init_put_byte(*s, buffer, buffer_size,
627 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
628 url_read, url_write, url_seek) < 0) {
633 (*s)->is_streamed = h->is_streamed;
634 (*s)->max_packet_size = max_packet_size;
635 (*s)->o_direct_flag = !!(h->flags & URL_DIRECT);
637 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
638 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
643 int url_setbufsize(ByteIOContext *s, int buf_size)
646 buffer = av_malloc(buf_size);
648 return AVERROR(ENOMEM);
652 s->buffer_size = buf_size;
654 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
658 int url_resetbuf(ByteIOContext *s, int flags)
660 URLContext *h = s->opaque;
661 if ((flags & URL_RDWR) || (h && h->flags != flags && !h->flags & URL_RDWR))
662 return AVERROR(EINVAL);
664 if (flags & URL_WRONLY) {
665 s->buf_end = s->buffer + s->buffer_size;
668 s->buf_end = s->buffer;
674 int url_fopen(ByteIOContext **s, const char *filename, int flags)
679 err = url_open(&h, filename, flags);
682 err = url_fdopen(s, h);
690 int url_fclose(ByteIOContext *s)
692 URLContext *h = s->opaque;
699 URLContext *url_fileno(ByteIOContext *s)
705 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
712 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
714 put_buffer(s, buf, strlen(buf));
717 #endif //CONFIG_MUXERS
719 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
729 if (c == EOF || c == '\n')
731 if ((q - buf) < buf_size - 1)
740 int url_fget_max_packet_size(ByteIOContext *s)
742 return s->max_packet_size;
745 int av_url_read_fpause(ByteIOContext *s, int pause)
748 return AVERROR(ENOSYS);
749 return s->read_pause(s->opaque, pause);
752 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
753 int64_t timestamp, int flags)
755 URLContext *h = s->opaque;
758 return AVERROR(ENOSYS);
759 ret = s->read_seek(h, stream_index, timestamp, flags);
761 s->buf_ptr = s->buf_end; // Flush buffer
762 s->pos = s->seek(h, 0, SEEK_CUR);
767 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
768 * back to the server even if CONFIG_MUXERS is false. */
769 #if CONFIG_MUXERS || CONFIG_NETWORK
770 /* buffer handling */
771 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
774 *s = av_mallocz(sizeof(ByteIOContext));
776 return AVERROR(ENOMEM);
777 ret = init_put_byte(*s, buf, buf_size,
778 (flags & URL_WRONLY || flags & URL_RDWR),
779 NULL, NULL, NULL, NULL);
785 int url_close_buf(ByteIOContext *s)
788 return s->buf_ptr - s->buffer;
791 /* output in a dynamic buffer */
793 typedef struct DynBuffer {
794 int pos, size, allocated_size;
797 uint8_t io_buffer[1];
800 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
802 DynBuffer *d = opaque;
803 unsigned new_size, new_allocated_size;
805 /* reallocate buffer if needed */
806 new_size = d->pos + buf_size;
807 new_allocated_size = d->allocated_size;
808 if(new_size < d->pos || new_size > INT_MAX/2)
810 while (new_size > new_allocated_size) {
811 if (!new_allocated_size)
812 new_allocated_size = new_size;
814 new_allocated_size += new_allocated_size / 2 + 1;
817 if (new_allocated_size > d->allocated_size) {
818 d->buffer = av_realloc(d->buffer, new_allocated_size);
819 if(d->buffer == NULL)
820 return AVERROR(ENOMEM);
821 d->allocated_size = new_allocated_size;
823 memcpy(d->buffer + d->pos, buf, buf_size);
825 if (d->pos > d->size)
830 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
832 unsigned char buf1[4];
835 /* packetized write: output the header */
836 AV_WB32(buf1, buf_size);
837 ret= dyn_buf_write(opaque, buf1, 4);
842 return dyn_buf_write(opaque, buf, buf_size);
845 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
847 DynBuffer *d = opaque;
849 if (whence == SEEK_CUR)
851 else if (whence == SEEK_END)
853 if (offset < 0 || offset > 0x7fffffffLL)
859 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
863 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
865 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
867 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
869 return AVERROR(ENOMEM);
870 *s = av_mallocz(sizeof(ByteIOContext));
873 return AVERROR(ENOMEM);
875 d->io_buffer_size = io_buffer_size;
876 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
878 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
879 max_packet_size ? NULL : dyn_buf_seek);
881 (*s)->max_packet_size = max_packet_size;
889 int url_open_dyn_buf(ByteIOContext **s)
891 return url_open_dyn_buf_internal(s, 0);
894 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
896 if (max_packet_size <= 0)
898 return url_open_dyn_buf_internal(s, max_packet_size);
901 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
903 DynBuffer *d = s->opaque;
908 *pbuffer = d->buffer;
914 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */