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(ByteIOContext *s)
86 size_t data_len = s->buf_ptr - s->buffer;
88 /* Write all the 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);
98 av_log(NULL, AV_LOG_ERROR, "YYY dl=%zd, tw=%zd\n", data_len, to_write);
100 if (s->write_packet && !s->error){
101 int ret= s->write_packet(s->opaque, s->buffer, to_write);
106 if(s->update_checksum){
107 av_log(NULL, AV_LOG_ERROR, "Checksumming not implemented in O_DIRECT patch\n");
108 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
109 s->checksum_ptr= s->buffer;
111 s->pos += whole_blocks;
112 memcpy(s->buffer, &s->buffer[whole_blocks], data_len - whole_blocks);
113 s->buf_ptr -= whole_blocks;
116 res = s->seek(s->opaque, s->pos, SEEK_SET);
118 av_log(NULL, AV_LOG_ERROR, "seek error inside flush_buffer: %lld\n", res);
119 av_log(NULL, AV_LOG_ERROR, "ZZZ tw=%zu, pos=%zd\n", to_write, s->pos);
123 void put_byte(ByteIOContext *s, int b)
126 if (s->buf_ptr >= s->buf_end)
130 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
135 len = (s->buf_end - s->buf_ptr);
138 memcpy(s->buf_ptr, buf, len);
141 if (s->buf_ptr >= s->buf_end)
149 void put_flush_packet(ByteIOContext *s)
155 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence)
161 return AVERROR(EINVAL);
163 pos = s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
165 if (whence != SEEK_CUR && whence != SEEK_SET)
166 return AVERROR(EINVAL);
168 if (whence == SEEK_CUR) {
169 offset1 = pos + (s->buf_ptr - s->buffer);
174 av_log(NULL, AV_LOG_ERROR, "SEEK to %llu\n", offset);
176 offset1 = offset - pos;
177 if (!s->must_flush &&
178 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
179 /* can do the seek inside the buffer */
180 s->buf_ptr = s->buffer + offset1;
181 } else if(s->is_streamed && !s->write_flag &&
182 offset1 >= 0 && offset1 < (s->buf_end - s->buffer) + (1<<16)){
183 while(s->pos < offset && !s->eof_reached)
186 return AVERROR(EPIPE);
187 s->buf_ptr = s->buf_end + offset - s->pos;
189 int64_t res = AVERROR(EPIPE);
191 #if CONFIG_MUXERS || CONFIG_NETWORK
196 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
197 #warning TODO read the whole block from the file to the buffer
198 if (!s->seek || (res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
201 s->buf_end = s->buffer;
202 s->buf_ptr = s->buffer;
209 void url_fskip(ByteIOContext *s, int64_t offset)
211 url_fseek(s, offset, SEEK_CUR);
214 int64_t url_ftell(ByteIOContext *s)
216 return url_fseek(s, 0, SEEK_CUR);
219 int64_t url_fsize(ByteIOContext *s)
224 return AVERROR(EINVAL);
227 return AVERROR(EPIPE);
228 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
230 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
233 s->seek(s->opaque, s->pos, SEEK_SET);
238 int url_feof(ByteIOContext *s)
242 return s->eof_reached;
245 int url_ferror(ByteIOContext *s)
252 void put_le32(ByteIOContext *s, unsigned int val)
255 put_byte(s, val >> 8);
256 put_byte(s, val >> 16);
257 put_byte(s, val >> 24);
260 void put_be32(ByteIOContext *s, unsigned int val)
262 put_byte(s, val >> 24);
263 put_byte(s, val >> 16);
264 put_byte(s, val >> 8);
268 void put_strz(ByteIOContext *s, const char *str)
271 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
276 void put_le64(ByteIOContext *s, uint64_t val)
278 put_le32(s, (uint32_t)(val & 0xffffffff));
279 put_le32(s, (uint32_t)(val >> 32));
282 void put_be64(ByteIOContext *s, uint64_t val)
284 put_be32(s, (uint32_t)(val >> 32));
285 put_be32(s, (uint32_t)(val & 0xffffffff));
288 void put_le16(ByteIOContext *s, unsigned int val)
291 put_byte(s, val >> 8);
294 void put_be16(ByteIOContext *s, unsigned int val)
296 put_byte(s, val >> 8);
300 void put_le24(ByteIOContext *s, unsigned int val)
302 put_le16(s, val & 0xffff);
303 put_byte(s, val >> 16);
306 void put_be24(ByteIOContext *s, unsigned int val)
308 put_be16(s, val >> 8);
312 void put_tag(ByteIOContext *s, const char *tag)
321 static void fill_buffer(ByteIOContext *s)
323 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
324 int len= s->buffer_size - (dst - s->buffer);
326 assert(s->buf_ptr == s->buf_end);
328 /* no need to do anything if EOF already reached */
332 if(s->update_checksum && dst == s->buffer){
333 if(s->buf_end > s->checksum_ptr)
334 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
335 s->checksum_ptr= s->buffer;
339 len = s->read_packet(s->opaque, dst, len);
343 /* do not modify buffer if EOF reached so that a seek back can
344 be done without rereading data */
351 s->buf_end = dst + len;
355 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
358 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
361 unsigned long get_checksum(ByteIOContext *s)
363 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
364 s->update_checksum= NULL;
368 void init_checksum(ByteIOContext *s,
369 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
370 unsigned long checksum)
372 s->update_checksum= update_checksum;
373 if(s->update_checksum){
374 s->checksum= checksum;
375 s->checksum_ptr= s->buf_ptr;
379 /* XXX: put an inline version */
380 int get_byte(ByteIOContext *s)
382 if (s->buf_ptr < s->buf_end) {
383 return *s->buf_ptr++;
386 if (s->buf_ptr < s->buf_end)
387 return *s->buf_ptr++;
393 int url_fgetc(ByteIOContext *s)
395 if (s->buf_ptr < s->buf_end) {
396 return *s->buf_ptr++;
399 if (s->buf_ptr < s->buf_end)
400 return *s->buf_ptr++;
406 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
412 len = s->buf_end - s->buf_ptr;
416 if(size > s->buffer_size && !s->update_checksum){
418 len = s->read_packet(s->opaque, buf, size);
420 /* do not modify buffer if EOF reached so that a seek back can
421 be done without rereading data */
430 s->buf_ptr = s->buffer;
431 s->buf_end = s->buffer/* + len*/;
435 len = s->buf_end - s->buf_ptr;
440 memcpy(buf, s->buf_ptr, len);
449 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
456 len = s->buf_end - s->buf_ptr;
459 len = s->buf_end - s->buf_ptr;
463 memcpy(buf, s->buf_ptr, len);
468 unsigned int get_le16(ByteIOContext *s)
472 val |= get_byte(s) << 8;
476 unsigned int get_le24(ByteIOContext *s)
480 val |= get_byte(s) << 16;
484 unsigned int get_le32(ByteIOContext *s)
488 val |= get_le16(s) << 16;
492 uint64_t get_le64(ByteIOContext *s)
495 val = (uint64_t)get_le32(s);
496 val |= (uint64_t)get_le32(s) << 32;
500 unsigned int get_be16(ByteIOContext *s)
503 val = get_byte(s) << 8;
508 unsigned int get_be24(ByteIOContext *s)
511 val = get_be16(s) << 8;
515 unsigned int get_be32(ByteIOContext *s)
518 val = get_be16(s) << 16;
523 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
528 while ((c = get_byte(s))) {
533 buf[i] = 0; /* Ensure null terminated, but may be truncated */
538 uint64_t get_be64(ByteIOContext *s)
541 val = (uint64_t)get_be32(s) << 32;
542 val |= (uint64_t)get_be32(s);
546 uint64_t ff_get_v(ByteIOContext *bc){
552 val= (val<<7) + (tmp&127);
557 int url_fdopen(ByteIOContext **s, URLContext *h)
560 int buffer_size, max_packet_size;
563 max_packet_size = url_get_max_packet_size(h);
564 if (max_packet_size) {
565 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
567 buffer_size = IO_BUFFER_SIZE;
569 buffer_size = 2*buffer_size+BLOCK_SIZE;
570 buffer = memalign(sysconf(_SC_PAGESIZE), buffer_size);
572 return AVERROR(ENOMEM);
574 *s = av_mallocz(sizeof(ByteIOContext));
577 return AVERROR(ENOMEM);
580 if (init_put_byte(*s, buffer, buffer_size,
581 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
582 url_read, url_write, url_seek) < 0) {
587 (*s)->is_streamed = h->is_streamed;
588 (*s)->max_packet_size = max_packet_size;
590 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
591 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
596 int url_setbufsize(ByteIOContext *s, int buf_size)
599 buffer = av_malloc(buf_size);
601 return AVERROR(ENOMEM);
605 s->buffer_size = buf_size;
607 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
611 int url_resetbuf(ByteIOContext *s, int flags)
613 URLContext *h = s->opaque;
614 if ((flags & URL_RDWR) || (h && h->flags != flags && !h->flags & URL_RDWR))
615 return AVERROR(EINVAL);
617 if (flags & URL_WRONLY) {
618 s->buf_end = s->buffer + s->buffer_size;
621 s->buf_end = s->buffer;
627 int url_fopen(ByteIOContext **s, const char *filename, int flags)
632 err = url_open(&h, filename, flags);
635 err = url_fdopen(s, h);
643 int url_fclose(ByteIOContext *s)
645 URLContext *h = s->opaque;
652 URLContext *url_fileno(ByteIOContext *s)
658 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
665 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
667 put_buffer(s, buf, strlen(buf));
670 #endif //CONFIG_MUXERS
672 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
682 if (c == EOF || c == '\n')
684 if ((q - buf) < buf_size - 1)
693 int url_fget_max_packet_size(ByteIOContext *s)
695 return s->max_packet_size;
698 int av_url_read_fpause(ByteIOContext *s, int pause)
701 return AVERROR(ENOSYS);
702 return s->read_pause(s->opaque, pause);
705 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
706 int64_t timestamp, int flags)
708 URLContext *h = s->opaque;
711 return AVERROR(ENOSYS);
712 ret = s->read_seek(h, stream_index, timestamp, flags);
714 s->buf_ptr = s->buf_end; // Flush buffer
715 s->pos = s->seek(h, 0, SEEK_CUR);
720 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
721 * back to the server even if CONFIG_MUXERS is false. */
722 #if CONFIG_MUXERS || CONFIG_NETWORK
723 /* buffer handling */
724 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
727 *s = av_mallocz(sizeof(ByteIOContext));
729 return AVERROR(ENOMEM);
730 ret = init_put_byte(*s, buf, buf_size,
731 (flags & URL_WRONLY || flags & URL_RDWR),
732 NULL, NULL, NULL, NULL);
738 int url_close_buf(ByteIOContext *s)
741 return s->buf_ptr - s->buffer;
744 /* output in a dynamic buffer */
746 typedef struct DynBuffer {
747 int pos, size, allocated_size;
750 uint8_t io_buffer[1];
753 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
755 DynBuffer *d = opaque;
756 unsigned new_size, new_allocated_size;
758 /* reallocate buffer if needed */
759 new_size = d->pos + buf_size;
760 new_allocated_size = d->allocated_size;
761 if(new_size < d->pos || new_size > INT_MAX/2)
763 while (new_size > new_allocated_size) {
764 if (!new_allocated_size)
765 new_allocated_size = new_size;
767 new_allocated_size += new_allocated_size / 2 + 1;
770 if (new_allocated_size > d->allocated_size) {
771 d->buffer = av_realloc(d->buffer, new_allocated_size);
772 if(d->buffer == NULL)
773 return AVERROR(ENOMEM);
774 d->allocated_size = new_allocated_size;
776 memcpy(d->buffer + d->pos, buf, buf_size);
778 if (d->pos > d->size)
783 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
785 unsigned char buf1[4];
788 /* packetized write: output the header */
789 AV_WB32(buf1, buf_size);
790 ret= dyn_buf_write(opaque, buf1, 4);
795 return dyn_buf_write(opaque, buf, buf_size);
798 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
800 DynBuffer *d = opaque;
802 if (whence == SEEK_CUR)
804 else if (whence == SEEK_END)
806 if (offset < 0 || offset > 0x7fffffffLL)
812 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
816 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
818 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
820 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
822 return AVERROR(ENOMEM);
823 *s = av_mallocz(sizeof(ByteIOContext));
826 return AVERROR(ENOMEM);
828 d->io_buffer_size = io_buffer_size;
829 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
831 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
832 max_packet_size ? NULL : dyn_buf_seek);
834 (*s)->max_packet_size = max_packet_size;
842 int url_open_dyn_buf(ByteIOContext **s)
844 return url_open_dyn_buf_internal(s, 0);
847 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
849 if (max_packet_size <= 0)
851 return url_open_dyn_buf_internal(s, max_packet_size);
854 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
856 DynBuffer *d = s->opaque;
861 *pbuffer = d->buffer;
867 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */