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 AVERROR(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         offset_t res = AVERROR(EPIPE);
 140
 141 #if defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK)
 142         if (s->write_flag) {
 143             flush_buffer(s);
 144             s->must_flush = 1;
 145         } else
 146 #endif /* defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK) */
 147         {
 148             s->buf_end = s->buffer;
 149         }
 150         s->buf_ptr = s->buffer;
 151         if (!s->seek || (res = s->seek(s->opaque, offset, SEEK_SET)) < 0)
 152             return res;
 153         s->pos = offset;
 154     }
 155     s->eof_reached = 0;
 156     return offset;
 157 }
 158
 159 void url_fskip(ByteIOContext *s, offset_t offset)
 160 {
 161     url_fseek(s, offset, SEEK_CUR);
 162 }
 163
 164 offset_t url_ftell(ByteIOContext *s)
 165 {
 166     return url_fseek(s, 0, SEEK_CUR);
 167 }
 168
 169 offset_t url_fsize(ByteIOContext *s)
 170 {
 171     offset_t size;
 172
 173     if (!s->seek)
 174         return AVERROR(EPIPE);
 175     size = s->seek(s->opaque, 0, AVSEEK_SIZE);
 176     if(size<0){
 177         if ((size = s->seek(s->opaque, -1, SEEK_END)) < 0)
 178             return size;
 179         size++;
 180         s->seek(s->opaque, s->pos, SEEK_SET);
 181     }
 182     return size;
 183 }
 184
 185 int url_feof(ByteIOContext *s)
 186 {
 187     return s->eof_reached;
 188 }
 189
 190 int url_ferror(ByteIOContext *s)
 191 {
 192     return s->error;
 193 }
 194
 195 void put_le32(ByteIOContext *s, unsigned int val)
 196 {
 197     put_byte(s, val);
 198     put_byte(s, val >> 8);
 199     put_byte(s, val >> 16);
 200     put_byte(s, val >> 24);
 201 }
 202
 203 void put_be32(ByteIOContext *s, unsigned int val)
 204 {
 205     put_byte(s, val >> 24);
 206     put_byte(s, val >> 16);
 207     put_byte(s, val >> 8);
 208     put_byte(s, val);
 209 }
 210
 211 void put_strz(ByteIOContext *s, const char *str)
 212 {
 213     if (str)
 214         put_buffer(s, (const unsigned char *) str, strlen(str) + 1);
 215     else
 216         put_byte(s, 0);
 217 }
 218
 219 void put_le64(ByteIOContext *s, uint64_t val)
 220 {
 221     put_le32(s, (uint32_t)(val & 0xffffffff));
 222     put_le32(s, (uint32_t)(val >> 32));
 223 }
 224
 225 void put_be64(ByteIOContext *s, uint64_t val)
 226 {
 227     put_be32(s, (uint32_t)(val >> 32));
 228     put_be32(s, (uint32_t)(val & 0xffffffff));
 229 }
 230
 231 void put_le16(ByteIOContext *s, unsigned int val)
 232 {
 233     put_byte(s, val);
 234     put_byte(s, val >> 8);
 235 }
 236
 237 void put_be16(ByteIOContext *s, unsigned int val)
 238 {
 239     put_byte(s, val >> 8);
 240     put_byte(s, val);
 241 }
 242
 243 void put_le24(ByteIOContext *s, unsigned int val)
 244 {
 245     put_le16(s, val & 0xffff);
 246     put_byte(s, val >> 16);
 247 }
 248
 249 void put_be24(ByteIOContext *s, unsigned int val)
 250 {
 251     put_be16(s, val >> 8);
 252     put_byte(s, val);
 253 }
 254
 255 void put_tag(ByteIOContext *s, const char *tag)
 256 {
 257     while (*tag) {
 258         put_byte(s, *tag++);
 259     }
 260 }
 261
 262 /* Input stream */
 263
 264 static void fill_buffer(ByteIOContext *s)
 265 {
 266     int len;
 267
 268     /* no need to do anything if EOF already reached */
 269     if (s->eof_reached)
 270         return;
 271
 272     if(s->update_checksum){
 273         if(s->buf_end > s->checksum_ptr)
 274             s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_end - s->checksum_ptr);
 275         s->checksum_ptr= s->buffer;
 276     }
 277
 278     len = s->read_packet(s->opaque, s->buffer, s->buffer_size);
 279     if (len <= 0) {
 280         /* do not modify buffer if EOF reached so that a seek back can
 281            be done without rereading data */
 282         s->eof_reached = 1;
 283     if(len<0)
 284         s->error= len;
 285     } else {
 286         s->pos += len;
 287         s->buf_ptr = s->buffer;
 288         s->buf_end = s->buffer + len;
 289     }
 290 }
 291
 292 unsigned long get_checksum(ByteIOContext *s){
 293     s->checksum= s->update_checksum(s->checksum, s->checksum_ptr, s->buf_ptr - s->checksum_ptr);
 294     s->update_checksum= NULL;
 295     return s->checksum;
 296 }
 297
 298 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum){
 299     s->update_checksum= update_checksum;
 300     if(s->update_checksum){
 301         s->checksum= checksum;
 302         s->checksum_ptr= s->buf_ptr;
 303     }
 304 }
 305
 306 /* XXX: put an inline version */
 307 int get_byte(ByteIOContext *s)
 308 {
 309     if (s->buf_ptr < s->buf_end) {
 310         return *s->buf_ptr++;
 311     } else {
 312         fill_buffer(s);
 313         if (s->buf_ptr < s->buf_end)
 314             return *s->buf_ptr++;
 315         else
 316             return 0;
 317     }
 318 }
 319
 320 int url_fgetc(ByteIOContext *s)
 321 {
 322     if (s->buf_ptr < s->buf_end) {
 323         return *s->buf_ptr++;
 324     } else {
 325         fill_buffer(s);
 326         if (s->buf_ptr < s->buf_end)
 327             return *s->buf_ptr++;
 328         else
 329             return URL_EOF;
 330     }
 331 }
 332
 333 int get_buffer(ByteIOContext *s, unsigned char *buf, int size)
 334 {
 335     int len, size1;
 336
 337     size1 = size;
 338     while (size > 0) {
 339         len = s->buf_end - s->buf_ptr;
 340         if (len > size)
 341             len = size;
 342         if (len == 0) {
 343             if(size > s->buffer_size && !s->update_checksum){
 344                 len = s->read_packet(s->opaque, buf, size);
 345                 if (len <= 0) {
 346                     /* do not modify buffer if EOF reached so that a seek back can
 347                     be done without rereading data */
 348                     s->eof_reached = 1;
 349                     if(len<0)
 350                         s->error= len;
 351                     break;
 352                 } else {
 353                     s->pos += len;
 354                     size -= len;
 355                     buf += len;
 356                     s->buf_ptr = s->buffer;
 357                     s->buf_end = s->buffer/* + len*/;
 358                 }
 359             }else{
 360                 fill_buffer(s);
 361                 len = s->buf_end - s->buf_ptr;
 362                 if (len == 0)
 363                     break;
 364             }
 365         } else {
 366             memcpy(buf, s->buf_ptr, len);
 367             buf += len;
 368             s->buf_ptr += len;
 369             size -= len;
 370         }
 371     }
 372     return size1 - size;
 373 }
 374
 375 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size)
 376 {
 377     int len;
 378
 379     if(size<0)
 380         return -1;
 381
 382     len = s->buf_end - s->buf_ptr;
 383     if (len == 0) {
 384         fill_buffer(s);
 385         len = s->buf_end - s->buf_ptr;
 386     }
 387     if (len > size)
 388         len = size;
 389     memcpy(buf, s->buf_ptr, len);
 390     s->buf_ptr += len;
 391     return len;
 392 }
 393
 394 unsigned int get_le16(ByteIOContext *s)
 395 {
 396     unsigned int val;
 397     val = get_byte(s);
 398     val |= get_byte(s) << 8;
 399     return val;
 400 }
 401
 402 unsigned int get_le24(ByteIOContext *s)
 403 {
 404     unsigned int val;
 405     val = get_le16(s);
 406     val |= get_byte(s) << 16;
 407     return val;
 408 }
 409
 410 unsigned int get_le32(ByteIOContext *s)
 411 {
 412     unsigned int val;
 413     val = get_le16(s);
 414     val |= get_le16(s) << 16;
 415     return val;
 416 }
 417
 418 uint64_t get_le64(ByteIOContext *s)
 419 {
 420     uint64_t val;
 421     val = (uint64_t)get_le32(s);
 422     val |= (uint64_t)get_le32(s) << 32;
 423     return val;
 424 }
 425
 426 unsigned int get_be16(ByteIOContext *s)
 427 {
 428     unsigned int val;
 429     val = get_byte(s) << 8;
 430     val |= get_byte(s);
 431     return val;
 432 }
 433
 434 unsigned int get_be24(ByteIOContext *s)
 435 {
 436     unsigned int val;
 437     val = get_be16(s) << 8;
 438     val |= get_byte(s);
 439     return val;
 440 }
 441 unsigned int get_be32(ByteIOContext *s)
 442 {
 443     unsigned int val;
 444     val = get_be16(s) << 16;
 445     val |= get_be16(s);
 446     return val;
 447 }
 448
 449 char *get_strz(ByteIOContext *s, char *buf, int maxlen)
 450 {
 451     int i = 0;
 452     char c;
 453
 454     while ((c = get_byte(s))) {
 455         if (i < maxlen-1)
 456             buf[i++] = c;
 457     }
 458
 459     buf[i] = 0; /* Ensure null terminated, but may be truncated */
 460
 461     return buf;
 462 }
 463
 464 uint64_t get_be64(ByteIOContext *s)
 465 {
 466     uint64_t val;
 467     val = (uint64_t)get_be32(s) << 32;
 468     val |= (uint64_t)get_be32(s);
 469     return val;
 470 }
 471
 472 /* link with avio functions */
 473
 474 #ifdef CONFIG_MUXERS
 475 static int url_write_packet(void *opaque, uint8_t *buf, int buf_size)
 476 {
 477     URLContext *h = opaque;
 478     return url_write(h, buf, buf_size);
 479 }
 480 #else
 481 #define         url_write_packet NULL
 482 #endif //CONFIG_MUXERS
 483
 484 static int url_read_packet(void *opaque, uint8_t *buf, int buf_size)
 485 {
 486     URLContext *h = opaque;
 487     return url_read(h, buf, buf_size);
 488 }
 489
 490 static offset_t url_seek_packet(void *opaque, offset_t offset, int whence)
 491 {
 492     URLContext *h = opaque;
 493     return url_seek(h, offset, whence);
 494     //return 0;
 495 }
 496
 497 int url_fdopen(ByteIOContext *s, URLContext *h)
 498 {
 499     uint8_t *buffer;
 500     int buffer_size, max_packet_size;
 501
 502
 503     max_packet_size = url_get_max_packet_size(h);
 504     if (max_packet_size) {
 505         buffer_size = max_packet_size; /* no need to bufferize more than one packet */
 506     } else {
 507         buffer_size = IO_BUFFER_SIZE;
 508     }
 509     buffer = av_malloc(buffer_size);
 510     if (!buffer)
 511         return AVERROR(ENOMEM);
 512
 513     if (init_put_byte(s, buffer, buffer_size,
 514                       (h->flags & URL_WRONLY || h->flags & URL_RDWR), h,
 515                       url_read_packet, url_write_packet, url_seek_packet) < 0) {
 516         av_free(buffer);
 517         return AVERROR_IO;
 518     }
 519     s->is_streamed = h->is_streamed;
 520     s->max_packet_size = max_packet_size;
 521     return 0;
 522 }
 523
 524 int url_setbufsize(ByteIOContext *s, int buf_size)
 525 {
 526     uint8_t *buffer;
 527     buffer = av_malloc(buf_size);
 528     if (!buffer)
 529         return AVERROR(ENOMEM);
 530
 531     av_free(s->buffer);
 532     s->buffer = buffer;
 533     s->buffer_size = buf_size;
 534     s->buf_ptr = buffer;
 535     if (!s->write_flag)
 536         s->buf_end = buffer;
 537     else
 538         s->buf_end = buffer + buf_size;
 539     return 0;
 540 }
 541
 542 int url_fopen(ByteIOContext *s, const char *filename, int flags)
 543 {
 544     URLContext *h;
 545     int err;
 546
 547     err = url_open(&h, filename, flags);
 548     if (err < 0)
 549         return err;
 550     err = url_fdopen(s, h);
 551     if (err < 0) {
 552         url_close(h);
 553         return err;
 554     }
 555     return 0;
 556 }
 557
 558 int url_fclose(ByteIOContext *s)
 559 {
 560     URLContext *h = s->opaque;
 561
 562     av_free(s->buffer);
 563     memset(s, 0, sizeof(ByteIOContext));
 564     return url_close(h);
 565 }
 566
 567 URLContext *url_fileno(ByteIOContext *s)
 568 {
 569     return s->opaque;
 570 }
 571
 572 #ifdef CONFIG_MUXERS
 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 char *url_fgets(ByteIOContext *s, char *buf, int buf_size)
 588 {
 589     int c;
 590     char *q;
 591
 592     c = url_fgetc(s);
 593     if (c == EOF)
 594         return NULL;
 595     q = buf;
 596     for(;;) {
 597         if (c == EOF || c == '\n')
 598             break;
 599         if ((q - buf) < buf_size - 1)
 600             *q++ = c;
 601         c = url_fgetc(s);
 602     }
 603     if (buf_size > 0)
 604         *q = '\0';
 605     return buf;
 606 }
 607
 608 int url_fget_max_packet_size(ByteIOContext *s)
 609 {
 610     return s->max_packet_size;
 611 }
 612
 613 /* url_open_dyn_buf and url_close_dyn_buf are used in rtp.c to send a response
 614  * back to the server even if CONFIG_MUXERS is not set. */
 615 #if defined(CONFIG_MUXERS) || defined(CONFIG_NETWORK)
 616 /* buffer handling */
 617 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags)
 618 {
 619     return init_put_byte(s, buf, buf_size,
 620                          (flags & URL_WRONLY || flags & URL_RDWR),
 621                          NULL, NULL, NULL, NULL);
 622 }
 623
 624 int url_close_buf(ByteIOContext *s)
 625 {
 626     put_flush_packet(s);
 627     return s->buf_ptr - s->buffer;
 628 }
 629
 630 /* output in a dynamic buffer */
 631
 632 typedef struct DynBuffer {
 633     int pos, size, allocated_size;
 634     uint8_t *buffer;
 635     int io_buffer_size;
 636     uint8_t io_buffer[1];
 637 } DynBuffer;
 638
 639 static int dyn_buf_write(void *opaque, uint8_t *buf, int buf_size)
 640 {
 641     DynBuffer *d = opaque;
 642     int new_size, new_allocated_size;
 643
 644     /* reallocate buffer if needed */
 645     new_size = d->pos + buf_size;
 646     new_allocated_size = d->allocated_size;
 647     if(new_size < d->pos || new_size > INT_MAX/2)
 648         return -1;
 649     while (new_size > new_allocated_size) {
 650         if (!new_allocated_size)
 651             new_allocated_size = new_size;
 652         else
 653             new_allocated_size += new_allocated_size / 2 + 1;
 654     }
 655
 656     if (new_allocated_size > d->allocated_size) {
 657         d->buffer = av_realloc(d->buffer, new_allocated_size);
 658         if(d->buffer == NULL)
 659              return -1234;
 660         d->allocated_size = new_allocated_size;
 661     }
 662     memcpy(d->buffer + d->pos, buf, buf_size);
 663     d->pos = new_size;
 664     if (d->pos > d->size)
 665         d->size = d->pos;
 666     return buf_size;
 667 }
 668
 669 static int dyn_packet_buf_write(void *opaque, uint8_t *buf, int buf_size)
 670 {
 671     unsigned char buf1[4];
 672     int ret;
 673
 674     /* packetized write: output the header */
 675     buf1[0] = (buf_size >> 24);
 676     buf1[1] = (buf_size >> 16);
 677     buf1[2] = (buf_size >> 8);
 678     buf1[3] = (buf_size);
 679     ret= dyn_buf_write(opaque, buf1, 4);
 680     if(ret < 0)
 681         return ret;
 682
 683     /* then the data */
 684     return dyn_buf_write(opaque, buf, buf_size);
 685 }
 686
 687 static offset_t dyn_buf_seek(void *opaque, offset_t offset, int whence)
 688 {
 689     DynBuffer *d = opaque;
 690
 691     if (whence == SEEK_CUR)
 692         offset += d->pos;
 693     else if (whence == SEEK_END)
 694         offset += d->size;
 695     if (offset < 0 || offset > 0x7fffffffLL)
 696         return -1;
 697     d->pos = offset;
 698     return 0;
 699 }
 700
 701 static int url_open_dyn_buf_internal(ByteIOContext *s, int max_packet_size)
 702 {
 703     DynBuffer *d;
 704     int io_buffer_size, ret;
 705
 706     if (max_packet_size)
 707         io_buffer_size = max_packet_size;
 708     else
 709         io_buffer_size = 1024;
 710
 711     if(sizeof(DynBuffer) + io_buffer_size < io_buffer_size)
 712         return -1;
 713     d = av_malloc(sizeof(DynBuffer) + io_buffer_size);
 714     if (!d)
 715         return -1;
 716     d->io_buffer_size = io_buffer_size;
 717     d->buffer = NULL;
 718     d->pos = 0;
 719     d->size = 0;
 720     d->allocated_size = 0;
 721     ret = init_put_byte(s, d->io_buffer, io_buffer_size,
 722                         1, d, NULL,
 723                         max_packet_size ? dyn_packet_buf_write : dyn_buf_write,
 724                         max_packet_size ? NULL : dyn_buf_seek);
 725     if (ret == 0) {
 726         s->max_packet_size = max_packet_size;
 727     }
 728     return ret;
 729 }
 730
 731 int url_open_dyn_buf(ByteIOContext *s)
 732 {
 733     return url_open_dyn_buf_internal(s, 0);
 734 }
 735
 736 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size)
 737 {
 738     if (max_packet_size <= 0)
 739         return -1;
 740     return url_open_dyn_buf_internal(s, max_packet_size);
 741 }
 742
 743 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer)
 744 {
 745     DynBuffer *d = s->opaque;
 746     int size;
 747
 748     put_flush_packet(s);
 749
 750     *pbuffer = d->buffer;
 751     size = d->size;
 752     av_free(d);
 753     return size;
 754 }
 755 #endif /* CONFIG_MUXERS || CONFIG_NETWORK */