ef72c195c13246b151918f9fc300c505e250a498
[ffmpeg.git] / libavformat / aviobuf.c
1 /*
2  * Buffered I/O for ffmpeg system
3  * Copyright (c) 2000,2001 Fabrice Bellard
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19 #include "avformat.h"
20 #include "avio.h"
21 #include <stdarg.h>
22
23 #define IO_BUFFER_SIZE 32768
24
25 int init_put_byte(ByteIOContext *s,
26                   unsigned char *buffer,
27                   int buffer_size,
28                   int write_flag,
29                   void *opaque,
30                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
31                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
32                   offset_t (*seek)(void *opaque, offset_t offset, int whence))
33 {
34     s->buffer = buffer;
35     s->buffer_size = buffer_size;
36     s->buf_ptr = buffer;
37     s->write_flag = write_flag;
38     if (!s->write_flag)
39         s->buf_end = buffer;
40     else
41         s->buf_end = buffer + buffer_size;
42     s->opaque = opaque;
43     s->write_packet = write_packet;
44     s->read_packet = read_packet;
45     s->seek = seek;
46     s->pos = 0;
47     s->must_flush = 0;
48     s->eof_reached = 0;
49     s->error = 0;
50     s->is_streamed = 0;
51     s->max_packet_size = 0;
52     s->update_checksum= NULL;
53     return 0;
54 }
55
56 static void flush_buffer(ByteIOContext *s)
57 {
58     if (s->buf_ptr > s->buffer) {
59         if (s->write_packet && !s->error){
60             int ret= s->write_packet(s->opaque, s->buffer, s->buf_ptr - s->buffer);
61             if(ret < 0){
62                 s->error = ret;
63             }
64         }
65         if(s->update_checksum){
66             s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
67             s->checksum_ptr= s->buffer;
68         }
69         s->pos += s->buf_ptr - s->buffer;
70     }
71     s->buf_ptr = s->buffer;
72 }
73
74 void put_byte(ByteIOContext *s, int b)
75 {
76     *(s->buf_ptr)++ = b;
77     if (s->buf_ptr >= s->buf_end)
78         flush_buffer(s);
79 }
80
81 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size)
82 {
83     int len;
84
85     while (size > 0) {
86         len = (s->buf_end - s->buf_ptr);
87         if (len > size)
88             len = size;
89         memcpy(s->buf_ptr, buf, len);
90         s->buf_ptr += len;
91
92         if (s->buf_ptr >= s->buf_end)
93             flush_buffer(s);
94
95         buf += len;
96         size -= len;
97     }
98 }
99
100 void put_flush_packet(ByteIOContext *s)
101 {
102     flush_buffer(s);
103     s->must_flush = 0;
104 }
105
106 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence)
107 {
108     offset_t offset1;
109     offset_t pos= s->pos - (s->write_flag ? 0 : (s->buf_end - s->buffer));
110
111     if (whence != SEEK_CUR && whence != SEEK_SET)
112         return -EINVAL;
113
114     if (whence == SEEK_CUR) {
115         offset1 = pos + (s->buf_ptr - s->buffer);
116         if (offset == 0)
117             return offset1;
118         offset += offset1;
119     }
120     offset1 = offset - pos;
121     if (!s->must_flush &&
122         offset1 >= 0 && offset1 < (s->buf_end - s->buffer)) {
123         /* can do the seek inside the buffer */
124         s->buf_ptr = s->buffer + offset1;
125     } else {
126 #ifdef CONFIG_MUXERS
127         if (s->write_flag) {
128             flush_buffer(s);
129             s->must_flush = 1;
130         } else
131 #endif //CONFIG_MUXERS
132         {
133             s->buf_end = s->buffer;
134         }
135         s->buf_ptr = s->buffer;
136         if (!s->seek || s->seek(s->opaque, offset, SEEK_SET) == (offset_t)-EPIPE)
137             return -EPIPE;
138         s->pos = offset;
139     }
140     s->eof_reached = 0;
141     return offset;
142 }
143
144 void url_fskip(ByteIOContext *s, offset_t offset)
145 {
146     url_fseek(s, offset, SEEK_CUR);
147 }
148
149 offset_t url_ftell(ByteIOContext *s)
150 {
151     return url_fseek(s, 0, SEEK_CUR);
152 }
153
154 offset_t url_fsize(ByteIOContext *s)
155 {
156     offset_t size;
157
158     if (!s->seek)
159         return -EPIPE;
160     size = s->seek(s->opaque, -1, SEEK_END) + 1;
161     s->seek(s->opaque, s->pos, SEEK_SET);
162     return size;
163 }
164
165 int url_feof(ByteIOContext *s)
166 {
167     return s->eof_reached;
168 }
169
170 int url_ferror(ByteIOContext *s)
171 {
172     return s->error;
173 }
174
175 #if defined(CONFIG_MUXERS) || defined(CONFIG_PROTOCOLS)
176 void put_le32(ByteIOContext *s, unsigned int val)
177 {
178     put_byte(s, val);
179     put_byte(s, val >> 8);
180     put_byte(s, val >> 16);
181     put_byte(s, val >> 24);
182 }
183
184 void put_be32(ByteIOContext *s, unsigned int val)
185 {
186     put_byte(s, val >> 24);
187     put_byte(s, val >> 16);
188     put_byte(s, val >> 8);
189     put_byte(s, val);
190 }
191
192 void put_strz(ByteIOContext *s, const char *str)
193 {
194     if (str)
195         put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
196     else
197         put_byte(s, 0);
198 }
199
200 void put_le64(ByteIOContext *s, uint64_t val)
201 {
202     put_le32(s, (uint32_t)(val & 0xffffffff));
203     put_le32(s, (uint32_t)(val >> 32));
204 }
205
206 void put_be64(ByteIOContext *s, uint64_t val)
207 {
208     put_be32(s, (uint32_t)(val >> 32));
209     put_be32(s, (uint32_t)(val & 0xffffffff));
210 }
211
212 void put_le16(ByteIOContext *s, unsigned int val)
213 {
214     put_byte(s, val);
215     put_byte(s, val >> 8);
216 }
217
218 void put_be16(ByteIOContext *s, unsigned int val)
219 {
220     put_byte(s, val >> 8);
221     put_byte(s, val);
222 }
223
224 void put_le24(ByteIOContext *s, unsigned int val)
225 {
226     put_le16(s, val & 0xffff);
227     put_byte(s, val >> 16);
228 }
229
230 void put_be24(ByteIOContext *s, unsigned int val)
231 {
232     put_be16(s, val >> 8);
233     put_byte(s, val);
234 }
235
236 void put_tag(ByteIOContext *s, const char *tag)
237 {
238     while (*tag) {
239         put_byte(s, *tag++);
240     }
241 }
242 #endif //CONFIG_MUXERS || CONFIG_PROTOCOLS
243
244 /* Input stream */
245
246 static void fill_buffer(ByteIOContext *s)
247 {
248     int len;
249
250     /* no need to do anything if EOF already reached */
251     if (s->eof_reached)
252         return;
253
254     if(s->update_checksum){
255         if(s->buf_end > s->checksum_ptr)
256             s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
257         s->checksum_ptr= s->buffer;
258     }
259
260     len = s->read_packet(s->opaque, s->buffer, s->buffer_size);
261     if (len <= 0) {
262         /* do not modify buffer if EOF reached so that a seek back can
263            be done without rereading data */
264         s->eof_reached = 1;
265     if(len<0)
266         s->error= len;
267     } else {
268         s->pos += len;
269         s->buf_ptr = s->buffer;
270         s->buf_end = s->buffer + len;
271     }
272 }
273
274 unsigned long get_checksum(ByteIOContext *s){
275     s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
276     s->update_checksum= NULL;
277     return s->checksum;
278 }
279
280 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum){
281     s->update_checksum= update_checksum;
282     if(s->update_checksum){
283         s->checksum= checksum;
284         s->checksum_ptr= s->buf_ptr;
285     }
286 }
287
288 /* NOTE: return 0 if EOF, so you cannot use it if EOF handling is
289    necessary */
290 /* XXX: put an inline version */
291 int get_byte(ByteIOContext *s)
292 {
293     if (s->buf_ptr < s->buf_end) {
294         return *s->buf_ptr++;
295     } else {
296         fill_buffer(s);
297         if (s->buf_ptr < s->buf_end)
298             return *s->buf_ptr++;
299         else
300             return 0;
301     }
302 }
303
304 /* NOTE: return URL_EOF (-1) if EOF */
305 int url_fgetc(ByteIOContext *s)
306 {
307     if (s->buf_ptr < s->buf_end) {
308         return *s->buf_ptr++;
309     } else {
310         fill_buffer(s);
311         if (s->buf_ptr < s->buf_end)
312             return *s->buf_ptr++;
313         else
314             return URL_EOF;
315     }
316 }
317
318 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
319 {
320     int len, size1;
321
322     size1 = size;
323     while (size > 0) {
324         len = s->buf_end - s->buf_ptr;
325         if (len > size)
326             len = size;
327         if (len == 0) {
328             if(size > s->buffer_size && !s->update_checksum){
329                 len = s->read_packet(s->opaque, buf, size);
330                 if (len <= 0) {
331                     /* do not modify buffer if EOF reached so that a seek back can
332                     be done without rereading data */
333                     s->eof_reached = 1;
334                     if(len<0)
335                         s->error= len;
336                     break;
337                 } else {
338                     s->pos += len;
339                     size -= len;
340                     buf += len;
341                     s->buf_ptr = s->buffer;
342                     s->buf_end = s->buffer/* + len*/;
343                 }
344             }else{
345                 fill_buffer(s);
346                 len = s->buf_end - s->buf_ptr;
347                 if (len == 0)
348                     break;
349             }
350         } else {
351             memcpy(buf, s->buf_ptr, len);
352             buf += len;
353             s->buf_ptr += len;
354             size -= len;
355         }
356     }
357     return size1 - size;
358 }
359
360 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
361 {
362     int len;
363
364     if(size<0)
365         return -1;
366
367     len = s->buf_end - s->buf_ptr;
368     if (len == 0) {
369         fill_buffer(s);
370         len = s->buf_end - s->buf_ptr;
371     }
372     if (len > size)
373         len = size;
374     memcpy(buf, s->buf_ptr, len);
375     s->buf_ptr += len;
376     return len;
377 }
378
379 unsigned int get_le16(ByteIOContext *s)
380 {
381     unsigned int val;
382     val = get_byte(s);
383     val |= get_byte(s) << 8;
384     return val;
385 }
386
387 unsigned int get_le24(ByteIOContext *s)
388 {
389     unsigned int val;
390     val = get_le16(s);
391     val |= get_byte(s) << 16;
392     return val;
393 }
394
395 unsigned int get_le32(ByteIOContext *s)
396 {
397     unsigned int val;
398     val = get_le16(s);
399     val |= get_le16(s) << 16;
400     return val;
401 }
402
403 uint64_t get_le64(ByteIOContext *s)
404 {
405     uint64_t val;
406     val = (uint64_t)get_le32(s);
407     val |= (uint64_t)get_le32(s) << 32;
408     return val;
409 }
410
411 unsigned int get_be16(ByteIOContext *s)
412 {
413     unsigned int val;
414     val = get_byte(s) << 8;
415     val |= get_byte(s);
416     return val;
417 }
418
419 unsigned int get_be24(ByteIOContext *s)
420 {
421     unsigned int val;
422     val = get_be16(s) << 8;
423     val |= get_byte(s);
424     return val;
425 }
426 unsigned int get_be32(ByteIOContext *s)
427 {
428     unsigned int val;
429     val = get_be16(s) << 16;
430     val |= get_be16(s);
431     return val;
432 }
433
434 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
435 {
436     int i = 0;
437     char c;
438
439     while ((c = get_byte(s))) {
440         if (i < maxlen-1)
441             buf[i++] = c;
442     }
443
444     buf[i] = 0; /* Ensure null terminated, but may be truncated */
445
446     return buf;
447 }
448
449 uint64_t get_be64(ByteIOContext *s)
450 {
451     uint64_t val;
452     val = (uint64_t)get_be32(s) << 32;
453     val |= (uint64_t)get_be32(s);
454     return val;
455 }
456
457 /* link with avio functions */
458
459 #ifdef CONFIG_MUXERS
460 static int url_write_packet(void *opaque, uint8_t *buf, int buf_size)
461 {
462     URLContext *h = opaque;
463     return url_write(h, buf, buf_size);
464 }
465 #else
466 #define         url_write_packet NULL
467 #endif //CONFIG_MUXERS
468
469 static int url_read_packet(void *opaque, uint8_t *buf, int buf_size)
470 {
471     URLContext *h = opaque;
472     return url_read(h, buf, buf_size);
473 }
474
475 static offset_t url_seek_packet(void *opaque, offset_t offset, int whence)
476 {
477     URLContext *h = opaque;
478     return url_seek(h, offset, whence);
479     //return 0;
480 }
481
482 int url_fdopen(ByteIOContext *s, URLContext *h)
483 {
484     uint8_t *buffer;
485     int buffer_size, max_packet_size;
486
487
488     max_packet_size = url_get_max_packet_size(h);
489     if (max_packet_size) {
490         buffer_size = max_packet_size; /* no need to bufferize more than one packet */
491     } else {
492         buffer_size = IO_BUFFER_SIZE;
493     }
494     buffer = av_malloc(buffer_size);
495     if (!buffer)
496         return -ENOMEM;
497
498     if (init_put_byte(s, buffer, buffer_size,
499                       (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
500                       url_read_packet, url_write_packet, url_seek_packet) < 0) {
501         av_free(buffer);
502         return AVERROR_IO;
503     }
504     s->is_streamed = h->is_streamed;
505     s->max_packet_size = max_packet_size;
506     return 0;
507 }
508
509 /* XXX: must be called before any I/O */
510 int url_setbufsize(ByteIOContext *s, int buf_size)
511 {
512     uint8_t *buffer;
513     buffer = av_malloc(buf_size);
514     if (!buffer)
515         return -ENOMEM;
516
517     av_free(s->buffer);
518     s->buffer = buffer;
519     s->buffer_size = buf_size;
520     s->buf_ptr = buffer;
521     if (!s->write_flag)
522         s->buf_end = buffer;
523     else
524         s->buf_end = buffer + buf_size;
525     return 0;
526 }
527
528 /* NOTE: when opened as read/write, the buffers are only used for
529    reading */
530 int url_fopen(ByteIOContext *s, const char *filename, int flags)
531 {
532     URLContext *h;
533     int err;
534
535     err = url_open(&h, filename, flags);
536     if (err < 0)
537         return err;
538     err = url_fdopen(s, h);
539     if (err < 0) {
540         url_close(h);
541         return err;
542     }
543     return 0;
544 }
545
546 int url_fclose(ByteIOContext *s)
547 {
548     URLContext *h = s->opaque;
549
550     av_free(s->buffer);
551     memset(s, 0, sizeof(ByteIOContext));
552     return url_close(h);
553 }
554
555 URLContext *url_fileno(ByteIOContext *s)
556 {
557     return s->opaque;
558 }
559
560 #ifdef CONFIG_MUXERS
561 /* XXX: currently size is limited */
562 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
563 {
564     va_list ap;
565     char buf[4096];
566     int ret;
567
568     va_start(ap, fmt);
569     ret = vsnprintf(buf, sizeof(buf), fmt, ap);
570     va_end(ap);
571     put_buffer(s, buf, strlen(buf));
572     return ret;
573 }
574 #endif //CONFIG_MUXERS
575
576 /* note: unlike fgets, the EOL character is not returned and a whole
577    line is parsed. return NULL if first char read was EOF */
578 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
579 {
580     int c;
581     char *q;
582
583     c = url_fgetc(s);
584     if (c == EOF)
585         return NULL;
586     q = buf;
587     for(;;) {
588         if (c == EOF || c == '\n')
589             break;
590         if ((q - buf) < buf_size - 1)
591             *q++ = c;
592         c = url_fgetc(s);
593     }
594     if (buf_size > 0)
595         *q = '\0';
596     return buf;
597 }
598
599 /*
600  * Return the maximum packet size associated to packetized buffered file
601  * handle. If the file is not packetized (stream like http or file on
602  * disk), then 0 is returned.
603  *
604  * @param h buffered file handle
605  * @return maximum packet size in bytes
606  */
607 int url_fget_max_packet_size(ByteIOContext *s)
608 {
609     return s->max_packet_size;
610 }
611
612 #ifdef CONFIG_MUXERS
613 /* buffer handling */
614 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags)
615 {
616     return init_put_byte(s, buf, buf_size,
617                          (flags & URL_WRONLY || flags & URL_RDWR),
618                          NULL, NULL, NULL, NULL);
619 }
620
621 /* return the written or read size */
622 int url_close_buf(ByteIOContext *s)
623 {
624     put_flush_packet(s);
625     return s->buf_ptr - s->buffer;
626 }
627
628 /* output in a dynamic buffer */
629
630 typedef struct DynBuffer {
631     int pos, size, allocated_size;
632     uint8_t *buffer;
633     int io_buffer_size;
634     uint8_t io_buffer[1];
635 } DynBuffer;
636
637 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
638 {
639     DynBuffer *d = opaque;
640     int new_size, new_allocated_size;
641
642     /* reallocate buffer if needed */
643     new_size = d->pos + buf_size;
644     new_allocated_size = d->allocated_size;
645     if(new_size < d->pos || new_size > INT_MAX/2)
646         return -1;
647     while (new_size > new_allocated_size) {
648         if (!new_allocated_size)
649             new_allocated_size = new_size;
650         else
651             new_allocated_size += new_allocated_size / 2 + 1;
652     }
653
654     if (new_allocated_size > d->allocated_size) {
655         d->buffer = av_realloc(d->buffer, new_allocated_size);
656         if(d->buffer == NULL)
657              return -1234;
658         d->allocated_size = new_allocated_size;
659     }
660     memcpy(d->buffer + d->pos, buf, buf_size);
661     d->pos = new_size;
662     if (d->pos > d->size)
663         d->size = d->pos;
664     return buf_size;
665 }
666
667 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
668 {
669     unsigned char buf1[4];
670     int ret;
671
672     /* packetized write: output the header */
673     buf1[0] = (buf_size >> 24);
674     buf1[1] = (buf_size >> 16);
675     buf1[2] = (buf_size >> 8);
676     buf1[3] = (buf_size);
677     ret= dyn_buf_write(opaque, buf1, 4);
678     if(ret < 0)
679         return ret;
680
681     /* then the data */
682     return dyn_buf_write(opaque, buf, buf_size);
683 }
684
685 static offset_t dyn_buf_seek(void *opaque, offset_t offset, int whence)
686 {
687     DynBuffer *d = opaque;
688
689     if (whence == SEEK_CUR)
690         offset += d->pos;
691     else if (whence == SEEK_END)
692         offset += d->size;
693     if (offset < 0 || offset > 0x7fffffffLL)
694         return -1;
695     d->pos = offset;
696     return 0;
697 }
698
699 static int url_open_dyn_buf_internal(ByteIOContext *s, int max_packet_size)
700 {
701     DynBuffer *d;
702     int io_buffer_size, ret;
703
704     if (max_packet_size)
705         io_buffer_size = max_packet_size;
706     else
707         io_buffer_size = 1024;
708
709     if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
710         return -1;
711     d = av_malloc(sizeof(DynBuffer) + io_buffer_size);
712     if (!d)
713         return -1;
714     d->io_buffer_size = io_buffer_size;
715     d->buffer = NULL;
716     d->pos = 0;
717     d->size = 0;
718     d->allocated_size = 0;
719     ret = init_put_byte(s, d->io_buffer, io_buffer_size,
720                         1, d, NULL,
721                         max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
722                         max_packet_size ? NULL : dyn_buf_seek);
723     if (ret == 0) {
724         s->max_packet_size = max_packet_size;
725     }
726     return ret;
727 }
728
729 /*
730  * Open a write only memory stream.
731  *
732  * @param s new IO context
733  * @return zero if no error.
734  */
735 int url_open_dyn_buf(ByteIOContext *s)
736 {
737     return url_open_dyn_buf_internal(s, 0);
738 }
739
740 /*
741  * Open a write only packetized memory stream with a maximum packet
742  * size of 'max_packet_size'.  The stream is stored in a memory buffer
743  * with a big endian 4 byte header giving the packet size in bytes.
744  *
745  * @param s new IO context
746  * @param max_packet_size maximum packet size (must be > 0)
747  * @return zero if no error.
748  */
749 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size)
750 {
751     if (max_packet_size <= 0)
752         return -1;
753     return url_open_dyn_buf_internal(s, max_packet_size);
754 }
755
756 /*
757  * Return the written size and a pointer to the buffer. The buffer
758  *  must be freed with av_free().
759  * @param s IO context
760  * @param pointer to a byte buffer
761  * @return the length of the byte buffer
762  */
763 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
764 {
765     DynBuffer *d = s->opaque;
766     int size;
767
768     put_flush_packet(s);
769
770     *pbuffer = d->buffer;
771     size = d->size;
772     av_free(d);
773     return size;
774 }
775 #endif //CONFIG_MUXERS