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