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