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 if (s->write_packet && !s->error){
100 int ret= s->write_packet(s->opaque, s->buffer, to_write);
105 if(s->update_checksum){
106 av_log(NULL, AV_LOG_ERROR, "Checksumming not implemented in O_DIRECT patch\n");
107 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
108 s->checksum_ptr= s->buffer;
111 memcpy(s->buffer, &s->buffer[whole_blocks], data_len - whole_blocks);
112 s->buf_ptr -= whole_blocks;
115 res = s->seek(s->opaque, s->pos - to_write + whole_blocks, SEEK_SET);
117 av_log(NULL, AV_LOG_ERROR, "seek error inside %s: %lld\n", __func__, res);
118 //av_log(NULL, AV_LOG_ERROR, "ZZZ tw=%zu, pos=%zd\n", to_write, s->pos);
122 static void flush_buffer(ByteIOContext *s)
124 av_log(NULL, AV_LOG_ERROR, "WRITE %p: pos=%zd len=%zd\n", s, s->pos, s->buf_ptr - s->buffer);
125 if (s->o_direct_flag) {
126 flush_buffer_o_direct(s);
129 if (s->buf_ptr > s->buffer) {
130 if (s->write_packet && !s->error){
131 int ret= s->write_packet(s->opaque, 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;
140 s->pos += s->buf_ptr - s->buffer;
142 s->buf_ptr = s->buffer;
145 void put_byte(ByteIOContext *s, int b)
148 if (s->buf_ptr >= s->buf_end)
152 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
157 len = (s->buf_end - s->buf_ptr);
160 memcpy(s->buf_ptr, buf, len);
163 if (s->buf_ptr >= s->buf_end)
171 void put_flush_packet(ByteIOContext *s)
177 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence)
183 return AVERROR(EINVAL);
185 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
187 if (whence != SEEK_CUR && whence != SEEK_SET)
188 return AVERROR(EINVAL);
190 if (whence == SEEK_CUR) {
191 offset1 = pos + (s->buf_ptr - s->buffer);
196 //if (s->o_direct_flag)
197 av_log(NULL, AV_LOG_ERROR, "SEEK %p: from %llu to %llu\n", s, pos, offset);
199 offset1 = offset - pos;
200 if (!s->must_flush &&
201 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
202 /* can do the seek inside the buffer */
203 s->buf_ptr = s->buffer + offset1;
204 if (s->o_direct_flag)
205 av_log(NULL, AV_LOG_ERROR, "Internal seek by %llu\n", offset1);
206 } else if(s->is_streamed && !s->write_flag &&
207 offset1 >= 0 && offset1 < (s->buf_end - s->buffer) + (1<<16)){
208 while(s->pos < offset && !s->eof_reached)
211 return AVERROR(EPIPE);
212 s->buf_ptr = s->buf_end + offset - s->pos;
214 int64_t res = AVERROR(EPIPE);
216 #if CONFIG_MUXERS || CONFIG_NETWORK
221 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
222 #warning TODO read the whole block from the file to the buffer
223 if (!s->seek || (res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
226 s->buf_end = s->buffer;
227 s->buf_ptr = s->buffer;
234 void url_fskip(ByteIOContext *s, int64_t offset)
236 url_fseek(s, offset, SEEK_CUR);
239 int64_t url_ftell(ByteIOContext *s)
241 return url_fseek(s, 0, SEEK_CUR);
244 int64_t url_fsize(ByteIOContext *s)
249 return AVERROR(EINVAL);
252 return AVERROR(EPIPE);
253 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
255 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
258 s->seek(s->opaque, s->pos, SEEK_SET);
263 int url_feof(ByteIOContext *s)
267 return s->eof_reached;
270 int url_ferror(ByteIOContext *s)
277 void put_le32(ByteIOContext *s, unsigned int val)
280 put_byte(s, val >> 8);
281 put_byte(s, val >> 16);
282 put_byte(s, val >> 24);
285 void put_be32(ByteIOContext *s, unsigned int val)
287 put_byte(s, val >> 24);
288 put_byte(s, val >> 16);
289 put_byte(s, val >> 8);
293 void put_strz(ByteIOContext *s, const char *str)
296 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
301 void put_le64(ByteIOContext *s, uint64_t val)
303 put_le32(s, (uint32_t)(val & 0xffffffff));
304 put_le32(s, (uint32_t)(val >> 32));
307 void put_be64(ByteIOContext *s, uint64_t val)
309 put_be32(s, (uint32_t)(val >> 32));
310 put_be32(s, (uint32_t)(val & 0xffffffff));
313 void put_le16(ByteIOContext *s, unsigned int val)
316 put_byte(s, val >> 8);
319 void put_be16(ByteIOContext *s, unsigned int val)
321 put_byte(s, val >> 8);
325 void put_le24(ByteIOContext *s, unsigned int val)
327 put_le16(s, val & 0xffff);
328 put_byte(s, val >> 16);
331 void put_be24(ByteIOContext *s, unsigned int val)
333 put_be16(s, val >> 8);
337 void put_tag(ByteIOContext *s, const char *tag)
346 static void fill_buffer(ByteIOContext *s)
348 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
349 int len= s->buffer_size - (dst - s->buffer);
351 assert(s->buf_ptr == s->buf_end);
353 /* no need to do anything if EOF already reached */
357 if(s->update_checksum && dst == s->buffer){
358 if(s->buf_end > s->checksum_ptr)
359 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
360 s->checksum_ptr= s->buffer;
364 len = s->read_packet(s->opaque, dst, len);
368 /* do not modify buffer if EOF reached so that a seek back can
369 be done without rereading data */
376 s->buf_end = dst + len;
380 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
383 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
386 unsigned long get_checksum(ByteIOContext *s)
388 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
389 s->update_checksum= NULL;
393 void init_checksum(ByteIOContext *s,
394 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
395 unsigned long checksum)
397 s->update_checksum= update_checksum;
398 if(s->update_checksum){
399 s->checksum= checksum;
400 s->checksum_ptr= s->buf_ptr;
404 /* XXX: put an inline version */
405 int get_byte(ByteIOContext *s)
407 if (s->buf_ptr < s->buf_end) {
408 return *s->buf_ptr++;
411 if (s->buf_ptr < s->buf_end)
412 return *s->buf_ptr++;
418 int url_fgetc(ByteIOContext *s)
420 if (s->buf_ptr < s->buf_end) {
421 return *s->buf_ptr++;
424 if (s->buf_ptr < s->buf_end)
425 return *s->buf_ptr++;
431 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
437 len = s->buf_end - s->buf_ptr;
441 if(size > s->buffer_size && !s->update_checksum){
443 len = s->read_packet(s->opaque, buf, size);
445 /* do not modify buffer if EOF reached so that a seek back can
446 be done without rereading data */
455 s->buf_ptr = s->buffer;
456 s->buf_end = s->buffer/* + len*/;
460 len = s->buf_end - s->buf_ptr;
465 memcpy(buf, s->buf_ptr, len);
474 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
481 len = s->buf_end - s->buf_ptr;
484 len = s->buf_end - s->buf_ptr;
488 memcpy(buf, s->buf_ptr, len);
493 unsigned int get_le16(ByteIOContext *s)
497 val |= get_byte(s) << 8;
501 unsigned int get_le24(ByteIOContext *s)
505 val |= get_byte(s) << 16;
509 unsigned int get_le32(ByteIOContext *s)
513 val |= get_le16(s) << 16;
517 uint64_t get_le64(ByteIOContext *s)
520 val = (uint64_t)get_le32(s);
521 val |= (uint64_t)get_le32(s) << 32;
525 unsigned int get_be16(ByteIOContext *s)
528 val = get_byte(s) << 8;
533 unsigned int get_be24(ByteIOContext *s)
536 val = get_be16(s) << 8;
540 unsigned int get_be32(ByteIOContext *s)
543 val = get_be16(s) << 16;
548 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
553 while ((c = get_byte(s))) {
558 buf[i] = 0; /* Ensure null terminated, but may be truncated */
563 uint64_t get_be64(ByteIOContext *s)
566 val = (uint64_t)get_be32(s) << 32;
567 val |= (uint64_t)get_be32(s);
571 uint64_t ff_get_v(ByteIOContext *bc){
577 val= (val<<7) + (tmp&127);
582 int url_fdopen(ByteIOContext **s, URLContext *h)
585 int buffer_size, max_packet_size;
588 max_packet_size = url_get_max_packet_size(h);
589 if (max_packet_size) {
590 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
592 buffer_size = IO_BUFFER_SIZE;
594 if (h->flags & URL_DIRECT) {
595 buffer_size = 2*buffer_size+BLOCK_SIZE;
596 buffer = memalign(sysconf(_SC_PAGESIZE), buffer_size);
599 buffer = av_malloc(buffer_size);
602 return AVERROR(ENOMEM);
604 *s = av_mallocz(sizeof(ByteIOContext));
607 return AVERROR(ENOMEM);
610 if (init_put_byte(*s, buffer, buffer_size,
611 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
612 url_read, url_write, url_seek) < 0) {
617 (*s)->is_streamed = h->is_streamed;
618 (*s)->max_packet_size = max_packet_size;
619 (*s)->o_direct_flag = !!(h->flags & URL_DIRECT);
621 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
622 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
627 int url_setbufsize(ByteIOContext *s, int buf_size)
630 buffer = av_malloc(buf_size);
632 return AVERROR(ENOMEM);
636 s->buffer_size = buf_size;
638 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
642 int url_resetbuf(ByteIOContext *s, int flags)
644 URLContext *h = s->opaque;
645 if ((flags & URL_RDWR) || (h && h->flags != flags && !h->flags & URL_RDWR))
646 return AVERROR(EINVAL);
648 if (flags & URL_WRONLY) {
649 s->buf_end = s->buffer + s->buffer_size;
652 s->buf_end = s->buffer;
658 int url_fopen(ByteIOContext **s, const char *filename, int flags)
663 av_log(NULL, AV_LOG_ERROR, "%s: %p %s\n", __func__, s, filename);
664 err = url_open(&h, filename, flags);
667 err = url_fdopen(s, h);
675 int url_fclose(ByteIOContext *s)
677 URLContext *h = s->opaque;
684 URLContext *url_fileno(ByteIOContext *s)
690 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
697 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
699 put_buffer(s, buf, strlen(buf));
702 #endif //CONFIG_MUXERS
704 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
714 if (c == EOF || c == '\n')
716 if ((q - buf) < buf_size - 1)
725 int url_fget_max_packet_size(ByteIOContext *s)
727 return s->max_packet_size;
730 int av_url_read_fpause(ByteIOContext *s, int pause)
733 return AVERROR(ENOSYS);
734 return s->read_pause(s->opaque, pause);
737 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
738 int64_t timestamp, int flags)
740 URLContext *h = s->opaque;
743 return AVERROR(ENOSYS);
744 ret = s->read_seek(h, stream_index, timestamp, flags);
746 s->buf_ptr = s->buf_end; // Flush buffer
747 s->pos = s->seek(h, 0, SEEK_CUR);
752 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
753 * back to the server even if CONFIG_MUXERS is false. */
754 #if CONFIG_MUXERS || CONFIG_NETWORK
755 /* buffer handling */
756 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
759 *s = av_mallocz(sizeof(ByteIOContext));
761 return AVERROR(ENOMEM);
762 ret = init_put_byte(*s, buf, buf_size,
763 (flags & URL_WRONLY || flags & URL_RDWR),
764 NULL, NULL, NULL, NULL);
770 int url_close_buf(ByteIOContext *s)
773 return s->buf_ptr - s->buffer;
776 /* output in a dynamic buffer */
778 typedef struct DynBuffer {
779 int pos, size, allocated_size;
782 uint8_t io_buffer[1];
785 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
787 DynBuffer *d = opaque;
788 unsigned new_size, new_allocated_size;
790 /* reallocate buffer if needed */
791 new_size = d->pos + buf_size;
792 new_allocated_size = d->allocated_size;
793 if(new_size < d->pos || new_size > INT_MAX/2)
795 while (new_size > new_allocated_size) {
796 if (!new_allocated_size)
797 new_allocated_size = new_size;
799 new_allocated_size += new_allocated_size / 2 + 1;
802 if (new_allocated_size > d->allocated_size) {
803 d->buffer = av_realloc(d->buffer, new_allocated_size);
804 if(d->buffer == NULL)
805 return AVERROR(ENOMEM);
806 d->allocated_size = new_allocated_size;
808 memcpy(d->buffer + d->pos, buf, buf_size);
810 if (d->pos > d->size)
815 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
817 unsigned char buf1[4];
820 /* packetized write: output the header */
821 AV_WB32(buf1, buf_size);
822 ret= dyn_buf_write(opaque, buf1, 4);
827 return dyn_buf_write(opaque, buf, buf_size);
830 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
832 DynBuffer *d = opaque;
834 if (whence == SEEK_CUR)
836 else if (whence == SEEK_END)
838 if (offset < 0 || offset > 0x7fffffffLL)
844 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
848 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
850 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
852 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
854 return AVERROR(ENOMEM);
855 *s = av_mallocz(sizeof(ByteIOContext));
858 return AVERROR(ENOMEM);
860 d->io_buffer_size = io_buffer_size;
861 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
863 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
864 max_packet_size ? NULL : dyn_buf_seek);
866 (*s)->max_packet_size = max_packet_size;
874 int url_open_dyn_buf(ByteIOContext **s)
876 return url_open_dyn_buf_internal(s, 0);
879 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
881 if (max_packet_size <= 0)
883 return url_open_dyn_buf_internal(s, max_packet_size);
886 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
888 DynBuffer *d = s->opaque;
893 *pbuffer = d->buffer;
899 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */