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 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, "%p: YYY dl=%zd, tw=%zd\n", s, 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 static void flush_buffer(ByteIOContext *s)
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 av_log(NULL, AV_LOG_ERROR, "%p: SEEK from %llu to %llu\n", s, pos, offset);
198 offset1 = offset - pos;
199 if (!s->must_flush &&
200 offset1 >= 0 && offset1 <= (s->buf_end - s->buffer)) {
201 /* can do the seek inside the buffer */
202 s->buf_ptr = s->buffer + offset1;
203 av_log(NULL, AV_LOG_ERROR, "Internal seek by %llu\n", offset1);
204 } else if(s->is_streamed && !s->write_flag &&
205 offset1 >= 0 && offset1 < (s->buf_end - s->buffer) + (1<<16)){
206 while(s->pos < offset && !s->eof_reached)
209 return AVERROR(EPIPE);
210 s->buf_ptr = s->buf_end + offset - s->pos;
212 int64_t res = AVERROR(EPIPE);
214 #if CONFIG_MUXERS || CONFIG_NETWORK
219 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */
220 #warning TODO read the whole block from the file to the buffer
221 if (!s->seek || (res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
224 s->buf_end = s->buffer;
225 s->buf_ptr = s->buffer;
232 void url_fskip(ByteIOContext *s, int64_t offset)
234 url_fseek(s, offset, SEEK_CUR);
237 int64_t url_ftell(ByteIOContext *s)
239 return url_fseek(s, 0, SEEK_CUR);
242 int64_t url_fsize(ByteIOContext *s)
247 return AVERROR(EINVAL);
250 return AVERROR(EPIPE);
251 size = s->seek(s->opaque, 0, AVSEEK_SIZE);
253 if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
256 s->seek(s->opaque, s->pos, SEEK_SET);
261 int url_feof(ByteIOContext *s)
265 return s->eof_reached;
268 int url_ferror(ByteIOContext *s)
275 void put_le32(ByteIOContext *s, unsigned int val)
278 put_byte(s, val >> 8);
279 put_byte(s, val >> 16);
280 put_byte(s, val >> 24);
283 void put_be32(ByteIOContext *s, unsigned int val)
285 put_byte(s, val >> 24);
286 put_byte(s, val >> 16);
287 put_byte(s, val >> 8);
291 void put_strz(ByteIOContext *s, const char *str)
294 put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
299 void put_le64(ByteIOContext *s, uint64_t val)
301 put_le32(s, (uint32_t)(val & 0xffffffff));
302 put_le32(s, (uint32_t)(val >> 32));
305 void put_be64(ByteIOContext *s, uint64_t val)
307 put_be32(s, (uint32_t)(val >> 32));
308 put_be32(s, (uint32_t)(val & 0xffffffff));
311 void put_le16(ByteIOContext *s, unsigned int val)
314 put_byte(s, val >> 8);
317 void put_be16(ByteIOContext *s, unsigned int val)
319 put_byte(s, val >> 8);
323 void put_le24(ByteIOContext *s, unsigned int val)
325 put_le16(s, val & 0xffff);
326 put_byte(s, val >> 16);
329 void put_be24(ByteIOContext *s, unsigned int val)
331 put_be16(s, val >> 8);
335 void put_tag(ByteIOContext *s, const char *tag)
344 static void fill_buffer(ByteIOContext *s)
346 uint8_t *dst= !s->max_packet_size && s->buf_end - s->buffer < s->buffer_size ? s->buf_ptr : s->buffer;
347 int len= s->buffer_size - (dst - s->buffer);
349 assert(s->buf_ptr == s->buf_end);
351 /* no need to do anything if EOF already reached */
355 if(s->update_checksum && dst == s->buffer){
356 if(s->buf_end > s->checksum_ptr)
357 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
358 s->checksum_ptr= s->buffer;
362 len = s->read_packet(s->opaque, dst, len);
366 /* do not modify buffer if EOF reached so that a seek back can
367 be done without rereading data */
374 s->buf_end = dst + len;
378 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
381 return av_crc(av_crc_get_table(AV_CRC_32_IEEE), checksum, buf, len);
384 unsigned long get_checksum(ByteIOContext *s)
386 s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
387 s->update_checksum= NULL;
391 void init_checksum(ByteIOContext *s,
392 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
393 unsigned long checksum)
395 s->update_checksum= update_checksum;
396 if(s->update_checksum){
397 s->checksum= checksum;
398 s->checksum_ptr= s->buf_ptr;
402 /* XXX: put an inline version */
403 int get_byte(ByteIOContext *s)
405 if (s->buf_ptr < s->buf_end) {
406 return *s->buf_ptr++;
409 if (s->buf_ptr < s->buf_end)
410 return *s->buf_ptr++;
416 int url_fgetc(ByteIOContext *s)
418 if (s->buf_ptr < s->buf_end) {
419 return *s->buf_ptr++;
422 if (s->buf_ptr < s->buf_end)
423 return *s->buf_ptr++;
429 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
435 len = s->buf_end - s->buf_ptr;
439 if(size > s->buffer_size && !s->update_checksum){
441 len = s->read_packet(s->opaque, buf, size);
443 /* do not modify buffer if EOF reached so that a seek back can
444 be done without rereading data */
453 s->buf_ptr = s->buffer;
454 s->buf_end = s->buffer/* + len*/;
458 len = s->buf_end - s->buf_ptr;
463 memcpy(buf, s->buf_ptr, len);
472 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
479 len = s->buf_end - s->buf_ptr;
482 len = s->buf_end - s->buf_ptr;
486 memcpy(buf, s->buf_ptr, len);
491 unsigned int get_le16(ByteIOContext *s)
495 val |= get_byte(s) << 8;
499 unsigned int get_le24(ByteIOContext *s)
503 val |= get_byte(s) << 16;
507 unsigned int get_le32(ByteIOContext *s)
511 val |= get_le16(s) << 16;
515 uint64_t get_le64(ByteIOContext *s)
518 val = (uint64_t)get_le32(s);
519 val |= (uint64_t)get_le32(s) << 32;
523 unsigned int get_be16(ByteIOContext *s)
526 val = get_byte(s) << 8;
531 unsigned int get_be24(ByteIOContext *s)
534 val = get_be16(s) << 8;
538 unsigned int get_be32(ByteIOContext *s)
541 val = get_be16(s) << 16;
546 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
551 while ((c = get_byte(s))) {
556 buf[i] = 0; /* Ensure null terminated, but may be truncated */
561 uint64_t get_be64(ByteIOContext *s)
564 val = (uint64_t)get_be32(s) << 32;
565 val |= (uint64_t)get_be32(s);
569 uint64_t ff_get_v(ByteIOContext *bc){
575 val= (val<<7) + (tmp&127);
580 int url_fdopen(ByteIOContext **s, URLContext *h)
583 int buffer_size, max_packet_size;
586 max_packet_size = url_get_max_packet_size(h);
587 if (max_packet_size) {
588 buffer_size = max_packet_size; /* no need to bufferize more than one packet */
590 buffer_size = IO_BUFFER_SIZE;
592 (*s)->o_direct_flag = !!(h->flags & URL_DIRECT);
593 if ((*s)->o_direct_flag) {
594 buffer_size = 2*buffer_size+BLOCK_SIZE;
595 buffer = memalign(sysconf(_SC_PAGESIZE), buffer_size);
598 buffer = av_malloc(buffer_size);
601 return AVERROR(ENOMEM);
603 *s = av_mallocz(sizeof(ByteIOContext));
606 return AVERROR(ENOMEM);
609 if (init_put_byte(*s, buffer, buffer_size,
610 (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
611 url_read, url_write, url_seek) < 0) {
616 (*s)->is_streamed = h->is_streamed;
617 (*s)->max_packet_size = max_packet_size;
619 (*s)->read_pause = (int (*)(void *, int))h->prot->url_read_pause;
620 (*s)->read_seek = (int64_t (*)(void *, int, int64_t, int))h->prot->url_read_seek;
625 int url_setbufsize(ByteIOContext *s, int buf_size)
628 buffer = av_malloc(buf_size);
630 return AVERROR(ENOMEM);
634 s->buffer_size = buf_size;
636 url_resetbuf(s, s->write_flag ? URL_WRONLY : URL_RDONLY);
640 int url_resetbuf(ByteIOContext *s, int flags)
642 URLContext *h = s->opaque;
643 if ((flags & URL_RDWR) || (h && h->flags != flags && !h->flags & URL_RDWR))
644 return AVERROR(EINVAL);
646 if (flags & URL_WRONLY) {
647 s->buf_end = s->buffer + s->buffer_size;
650 s->buf_end = s->buffer;
656 int url_fopen(ByteIOContext **s, const char *filename, int flags)
661 err = url_open(&h, filename, flags);
664 err = url_fdopen(s, h);
672 int url_fclose(ByteIOContext *s)
674 URLContext *h = s->opaque;
681 URLContext *url_fileno(ByteIOContext *s)
687 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
694 ret = vsnprintf(buf, sizeof(buf), fmt, ap);
696 put_buffer(s, buf, strlen(buf));
699 #endif //CONFIG_MUXERS
701 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
711 if (c == EOF || c == '\n')
713 if ((q - buf) < buf_size - 1)
722 int url_fget_max_packet_size(ByteIOContext *s)
724 return s->max_packet_size;
727 int av_url_read_fpause(ByteIOContext *s, int pause)
730 return AVERROR(ENOSYS);
731 return s->read_pause(s->opaque, pause);
734 int64_t av_url_read_fseek(ByteIOContext *s, int stream_index,
735 int64_t timestamp, int flags)
737 URLContext *h = s->opaque;
740 return AVERROR(ENOSYS);
741 ret = s->read_seek(h, stream_index, timestamp, flags);
743 s->buf_ptr = s->buf_end; // Flush buffer
744 s->pos = s->seek(h, 0, SEEK_CUR);
749 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
750 * back to the server even if CONFIG_MUXERS is false. */
751 #if CONFIG_MUXERS || CONFIG_NETWORK
752 /* buffer handling */
753 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags)
756 *s = av_mallocz(sizeof(ByteIOContext));
758 return AVERROR(ENOMEM);
759 ret = init_put_byte(*s, buf, buf_size,
760 (flags & URL_WRONLY || flags & URL_RDWR),
761 NULL, NULL, NULL, NULL);
767 int url_close_buf(ByteIOContext *s)
770 return s->buf_ptr - s->buffer;
773 /* output in a dynamic buffer */
775 typedef struct DynBuffer {
776 int pos, size, allocated_size;
779 uint8_t io_buffer[1];
782 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
784 DynBuffer *d = opaque;
785 unsigned new_size, new_allocated_size;
787 /* reallocate buffer if needed */
788 new_size = d->pos + buf_size;
789 new_allocated_size = d->allocated_size;
790 if(new_size < d->pos || new_size > INT_MAX/2)
792 while (new_size > new_allocated_size) {
793 if (!new_allocated_size)
794 new_allocated_size = new_size;
796 new_allocated_size += new_allocated_size / 2 + 1;
799 if (new_allocated_size > d->allocated_size) {
800 d->buffer = av_realloc(d->buffer, new_allocated_size);
801 if(d->buffer == NULL)
802 return AVERROR(ENOMEM);
803 d->allocated_size = new_allocated_size;
805 memcpy(d->buffer + d->pos, buf, buf_size);
807 if (d->pos > d->size)
812 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
814 unsigned char buf1[4];
817 /* packetized write: output the header */
818 AV_WB32(buf1, buf_size);
819 ret= dyn_buf_write(opaque, buf1, 4);
824 return dyn_buf_write(opaque, buf, buf_size);
827 static int64_t dyn_buf_seek(void *opaque, int64_t offset, int whence)
829 DynBuffer *d = opaque;
831 if (whence == SEEK_CUR)
833 else if (whence == SEEK_END)
835 if (offset < 0 || offset > 0x7fffffffLL)
841 static int url_open_dyn_buf_internal(ByteIOContext **s, int max_packet_size)
845 unsigned io_buffer_size = max_packet_size ? max_packet_size : 1024;
847 if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
849 d = av_mallocz(sizeof(DynBuffer) + io_buffer_size);
851 return AVERROR(ENOMEM);
852 *s = av_mallocz(sizeof(ByteIOContext));
855 return AVERROR(ENOMEM);
857 d->io_buffer_size = io_buffer_size;
858 ret = init_put_byte(*s, d->io_buffer, io_buffer_size,
860 max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
861 max_packet_size ? NULL : dyn_buf_seek);
863 (*s)->max_packet_size = max_packet_size;
871 int url_open_dyn_buf(ByteIOContext **s)
873 return url_open_dyn_buf_internal(s, 0);
876 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size)
878 if (max_packet_size <= 0)
880 return url_open_dyn_buf_internal(s, max_packet_size);
883 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
885 DynBuffer *d = s->opaque;
890 *pbuffer = d->buffer;
896 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */