]> rtime.felk.cvut.cz Git - frescor/ffmpeg.git/blob - libavformat/aviobuf.c
drop most url_fileno() calls (allows to use ByteIOContext directly in caller apps...
[frescor/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                   int (*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_tag(ByteIOContext *s, const char *tag)
257 {
258     while (*tag) {
259         put_byte(s, *tag++);
260     }
261 }
262 #endif //CONFIG_ENCODERS
263
264 /* Input stream */
265
266 static void fill_buffer(ByteIOContext *s)
267 {
268     int len;
269
270     /* no need to do anything if EOF already reached */
271     if (s->eof_reached)
272         return;
273
274     if(s->update_checksum){
275         s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
276         s->checksum_ptr= s->buffer;
277     }
278
279     len = s->read_packet(s->opaque, s->buffer, s->buffer_size);
280     if (len <= 0) {
281         /* do not modify buffer if EOF reached so that a seek back can
282            be done without rereading data */
283         s->eof_reached = 1;
284     if(len<0)
285         s->error= len;
286     } else {
287         s->pos += len;
288         s->buf_ptr = s->buffer;
289         s->buf_end = s->buffer + len;
290     }
291 }
292
293 unsigned long get_checksum(ByteIOContext *s){
294     s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
295     s->update_checksum= NULL;
296     return s->checksum;
297 }
298
299 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum){
300     s->update_checksum= update_checksum;
301     if(s->update_checksum){
302         s->checksum= s->update_checksum(checksum, NULL, 0);
303         s->checksum_ptr= s->buf_ptr;
304     }
305 }
306
307 /* NOTE: return 0 if EOF, so you cannot use it if EOF handling is
308    necessary */
309 /* XXX: put an inline version */
310 int get_byte(ByteIOContext *s)
311 {
312     if (s->buf_ptr < s->buf_end) {
313         return *s->buf_ptr++;
314     } else {
315         fill_buffer(s);
316         if (s->buf_ptr < s->buf_end)
317             return *s->buf_ptr++;
318         else
319             return 0;
320     }
321 }
322
323 /* NOTE: return URL_EOF (-1) if EOF */
324 int url_fgetc(ByteIOContext *s)
325 {
326     if (s->buf_ptr < s->buf_end) {
327         return *s->buf_ptr++;
328     } else {
329         fill_buffer(s);
330         if (s->buf_ptr < s->buf_end)
331             return *s->buf_ptr++;
332         else
333             return URL_EOF;
334     }
335 }
336
337 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
338 {
339     int len, size1;
340
341     size1 = size;
342     while (size > 0) {
343         len = s->buf_end - s->buf_ptr;
344         if (len > size)
345             len = size;
346         if (len == 0) {
347             if(size > s->buffer_size && !s->update_checksum){
348                 len = s->read_packet(s->opaque, buf, size);
349                 if (len <= 0) {
350                     /* do not modify buffer if EOF reached so that a seek back can
351                     be done without rereading data */
352                     s->eof_reached = 1;
353                     if(len<0)
354                         s->error= len;
355                     break;
356                 } else {
357                     s->pos += len;
358                     size -= len;
359                     buf += len;
360                     s->buf_ptr = s->buffer;
361                     s->buf_end = s->buffer/* + len*/;
362                 }
363             }else{
364                 fill_buffer(s);
365                 len = s->buf_end - s->buf_ptr;
366                 if (len == 0)
367                     break;
368             }
369         } else {
370             memcpy(buf, s->buf_ptr, len);
371             buf += len;
372             s->buf_ptr += len;
373             size -= len;
374         }
375     }
376     return size1 - size;
377 }
378
379 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
380 {
381     int len;
382     
383     if(size<0)
384         return -1;
385
386     len = s->buf_end - s->buf_ptr;
387     if (len == 0) {
388         fill_buffer(s);
389         len = s->buf_end - s->buf_ptr;
390     }
391     if (len > size)
392         len = size;
393     memcpy(buf, s->buf_ptr, len);
394     s->buf_ptr += len;
395     return len;
396 }
397
398 unsigned int get_le16(ByteIOContext *s)
399 {
400     unsigned int val;
401     val = get_byte(s);
402     val |= get_byte(s) << 8;
403     return val;
404 }
405
406 unsigned int get_le32(ByteIOContext *s)
407 {
408     unsigned int val;
409     val = get_byte(s);
410     val |= get_byte(s) << 8;
411     val |= get_byte(s) << 16;
412     val |= get_byte(s) << 24;
413     return val;
414 }
415
416 uint64_t get_le64(ByteIOContext *s)
417 {
418     uint64_t val;
419     val = (uint64_t)get_le32(s);
420     val |= (uint64_t)get_le32(s) << 32;
421     return val;
422 }
423
424 unsigned int get_be16(ByteIOContext *s)
425 {
426     unsigned int val;
427     val = get_byte(s) << 8;
428     val |= get_byte(s);
429     return val;
430 }
431
432 unsigned int get_be32(ByteIOContext *s)
433 {
434     unsigned int val;
435     val = get_byte(s) << 24;
436     val |= get_byte(s) << 16;
437     val |= get_byte(s) << 8;
438     val |= get_byte(s);
439     return val;
440 }
441
442 double get_be64_double(ByteIOContext *s)
443 {
444     union {
445         double d;
446         uint64_t ull;
447     } u;
448
449     u.ull = get_be64(s);
450     return u.d;
451 }
452
453 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
454 {
455     int i = 0;
456     char c;
457
458     while ((c = get_byte(s))) {
459         if (i < maxlen-1)
460             buf[i++] = c;
461     }
462     
463     buf[i] = 0; /* Ensure null terminated, but may be truncated */
464
465     return buf;
466 }
467
468 uint64_t get_be64(ByteIOContext *s)
469 {
470     uint64_t val;
471     val = (uint64_t)get_be32(s) << 32;
472     val |= (uint64_t)get_be32(s);
473     return val;
474 }
475
476 /* link with avio functions */
477
478 #ifdef CONFIG_ENCODERS
479 static int url_write_packet(void *opaque, uint8_t *buf, int buf_size)
480 {
481     URLContext *h = opaque;
482     return url_write(h, buf, buf_size);
483 }
484 #else
485 #define url_write_packet NULL
486 #endif //CONFIG_ENCODERS
487
488 static int url_read_packet(void *opaque, uint8_t *buf, int buf_size)
489 {
490     URLContext *h = opaque;
491     return url_read(h, buf, buf_size);
492 }
493
494 static int url_seek_packet(void *opaque, int64_t offset, int whence)
495 {
496     URLContext *h = opaque;
497     return url_seek(h, offset, whence);
498     //return 0;
499 }
500
501 int url_fdopen(ByteIOContext *s, URLContext *h)
502 {
503     uint8_t *buffer;
504     int buffer_size, max_packet_size;
505
506     
507     max_packet_size = url_get_max_packet_size(h);
508     if (max_packet_size) {
509         buffer_size = max_packet_size; /* no need to bufferize more than one packet */
510     } else {
511         buffer_size = IO_BUFFER_SIZE;
512     }
513     buffer = av_malloc(buffer_size);
514     if (!buffer)
515         return -ENOMEM;
516
517     if (init_put_byte(s, buffer, buffer_size, 
518                       (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
519                       url_read_packet, url_write_packet, url_seek_packet) < 0) {
520         av_free(buffer);
521         return AVERROR_IO;
522     }
523     s->is_streamed = h->is_streamed;
524     s->max_packet_size = max_packet_size;
525     return 0;
526 }
527
528 /* XXX: must be called before any I/O */
529 int url_setbufsize(ByteIOContext *s, int buf_size)
530 {
531     uint8_t *buffer;
532     buffer = av_malloc(buf_size);
533     if (!buffer)
534         return -ENOMEM;
535
536     av_free(s->buffer);
537     s->buffer = buffer;
538     s->buffer_size = buf_size;
539     s->buf_ptr = buffer;
540     if (!s->write_flag) 
541         s->buf_end = buffer;
542     else
543         s->buf_end = buffer + buf_size;
544     return 0;
545 }
546
547 /* NOTE: when opened as read/write, the buffers are only used for
548    reading */
549 int url_fopen(ByteIOContext *s, const char *filename, int flags)
550 {
551     URLContext *h;
552     int err;
553
554     err = url_open(&h, filename, flags);
555     if (err < 0)
556         return err;
557     err = url_fdopen(s, h);
558     if (err < 0) {
559         url_close(h);
560         return err;
561     }
562     return 0;
563 }
564
565 int url_fclose(ByteIOContext *s)
566 {
567     URLContext *h = s->opaque;
568     
569     av_free(s->buffer);
570     memset(s, 0, sizeof(ByteIOContext));
571     return url_close(h);
572 }
573
574 URLContext *url_fileno(ByteIOContext *s)
575 {
576     return s->opaque;
577 }
578
579 #ifdef CONFIG_ENCODERS
580 /* XXX: currently size is limited */
581 int url_fprintf(ByteIOContext *s, const char *fmt, ...)
582 {
583     va_list ap;
584     char buf[4096];
585     int ret;
586
587     va_start(ap, fmt);
588     ret = vsnprintf(buf, sizeof(buf), fmt, ap);
589     va_end(ap);
590     put_buffer(s, buf, strlen(buf));
591     return ret;
592 }
593 #endif //CONFIG_ENCODERS
594
595 /* note: unlike fgets, the EOL character is not returned and a whole
596    line is parsed. return NULL if first char read was EOF */
597 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
598 {
599     int c;
600     char *q;
601
602     c = url_fgetc(s);
603     if (c == EOF)
604         return NULL;
605     q = buf;
606     for(;;) {
607         if (c == EOF || c == '\n')
608             break;
609         if ((q - buf) < buf_size - 1)
610             *q++ = c;
611         c = url_fgetc(s);
612     }
613     if (buf_size > 0)
614         *q = '\0';
615     return buf;
616 }
617
618 /* 
619  * Return the maximum packet size associated to packetized buffered file
620  * handle. If the file is not packetized (stream like http or file on
621  * disk), then 0 is returned.
622  * 
623  * @param h buffered file handle
624  * @return maximum packet size in bytes
625  */
626 int url_fget_max_packet_size(ByteIOContext *s)
627 {
628     return s->max_packet_size;
629 }
630
631 #ifdef CONFIG_ENCODERS
632 /* buffer handling */
633 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags)
634 {
635     return init_put_byte(s, buf, buf_size, 
636                          (flags & URL_WRONLY || flags & URL_RDWR),
637                          NULL, NULL, NULL, NULL);
638 }
639
640 /* return the written or read size */
641 int url_close_buf(ByteIOContext *s)
642 {
643     put_flush_packet(s);
644     return s->buf_ptr - s->buffer;
645 }
646
647 /* output in a dynamic buffer */
648
649 typedef struct DynBuffer {
650     int pos, size, allocated_size;
651     uint8_t *buffer;
652     int io_buffer_size;
653     uint8_t io_buffer[1];
654 } DynBuffer;
655
656 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
657 {
658     DynBuffer *d = opaque;
659     int new_size, new_allocated_size;
660     
661     /* reallocate buffer if needed */
662     new_size = d->pos + buf_size;
663     new_allocated_size = d->allocated_size;
664     if(new_size < d->pos || new_size > INT_MAX/2)
665         return -1;
666     while (new_size > new_allocated_size) {
667         if (!new_allocated_size)
668             new_allocated_size = new_size;
669         else
670             new_allocated_size += new_allocated_size / 2 + 1;    
671     }
672     
673     if (new_allocated_size > d->allocated_size) {
674         d->buffer = av_realloc(d->buffer, new_allocated_size);
675         if(d->buffer == NULL)
676              return -1234;
677         d->allocated_size = new_allocated_size;
678     }
679     memcpy(d->buffer + d->pos, buf, buf_size);
680     d->pos = new_size;
681     if (d->pos > d->size)
682         d->size = d->pos;
683     return buf_size;
684 }
685
686 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
687 {
688     unsigned char buf1[4];
689     int ret;
690
691     /* packetized write: output the header */
692     buf1[0] = (buf_size >> 24);
693     buf1[1] = (buf_size >> 16);
694     buf1[2] = (buf_size >> 8);
695     buf1[3] = (buf_size);
696     ret= dyn_buf_write(opaque, buf1, 4);
697     if(ret < 0)
698         return ret;
699
700     /* then the data */
701     return dyn_buf_write(opaque, buf, buf_size);
702 }
703
704 static int dyn_buf_seek(void *opaque, offset_t offset, int whence)
705 {
706     DynBuffer *d = opaque;
707
708     if (whence == SEEK_CUR)
709         offset += d->pos;
710     else if (whence == SEEK_END)
711         offset += d->size;
712     if (offset < 0 || offset > 0x7fffffffLL)
713         return -1;
714     d->pos = offset;
715     return 0;
716 }
717
718 static int url_open_dyn_buf_internal(ByteIOContext *s, int max_packet_size)
719 {
720     DynBuffer *d;
721     int io_buffer_size, ret;
722     
723     if (max_packet_size) 
724         io_buffer_size = max_packet_size;
725     else
726         io_buffer_size = 1024;
727         
728     if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
729         return -1;
730     d = av_malloc(sizeof(DynBuffer) + io_buffer_size);
731     if (!d)
732         return -1;
733     d->io_buffer_size = io_buffer_size;
734     d->buffer = NULL;
735     d->pos = 0;
736     d->size = 0;
737     d->allocated_size = 0;
738     ret = init_put_byte(s, d->io_buffer, io_buffer_size, 
739                         1, d, NULL, 
740                         max_packet_size ? dyn_packet_buf_write : dyn_buf_write, 
741                         max_packet_size ? NULL : dyn_buf_seek);
742     if (ret == 0) {
743         s->max_packet_size = max_packet_size;
744     }
745     return ret;
746 }
747
748 /*
749  * Open a write only memory stream.
750  * 
751  * @param s new IO context
752  * @return zero if no error.
753  */
754 int url_open_dyn_buf(ByteIOContext *s)
755 {
756     return url_open_dyn_buf_internal(s, 0);
757 }
758
759 /*
760  * Open a write only packetized memory stream with a maximum packet
761  * size of 'max_packet_size'.  The stream is stored in a memory buffer
762  * with a big endian 4 byte header giving the packet size in bytes.
763  * 
764  * @param s new IO context
765  * @param max_packet_size maximum packet size (must be > 0) 
766  * @return zero if no error.
767  */
768 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size)
769 {
770     if (max_packet_size <= 0)
771         return -1;
772     return url_open_dyn_buf_internal(s, max_packet_size);
773 }
774
775 /* 
776  * Return the written size and a pointer to the buffer. The buffer
777  *  must be freed with av_free(). 
778  * @param s IO context
779  * @param pointer to a byte buffer
780  * @return the length of the byte buffer
781  */
782 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
783 {
784     DynBuffer *d = s->opaque;
785     int size;
786
787     put_flush_packet(s);
788
789     *pbuffer = d->buffer;
790     size = d->size;
791     av_free(d);
792     return size;
793 }
794 #endif //CONFIG_ENCODERS