git.sesse.net Git - ffmpeg/blob - libavformat/avio_internal.h

   1 /*
   2  *
   3  * This file is part of Libav.
   4  *
   5  * Libav 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.1 of the License, or (at your option) any later version.
   9  *
  10  * Libav 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 Libav; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef AVFORMAT_AVIO_INTERNAL_H
  21 #define AVFORMAT_AVIO_INTERNAL_H
  22
  23 #include "avio.h"
  24 #include "url.h"
  25
  26 int ffio_init_context(AVIOContext *s,
  27                   unsigned char *buffer,
  28                   int buffer_size,
  29                   int write_flag,
  30                   void *opaque,
  31                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
  32                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
  33                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
  34
  35
  36 /**
  37  * Read size bytes from AVIOContext into buf.
  38  * This reads at most 1 packet. If that is not enough fewer bytes will be
  39  * returned.
  40  * @return number of bytes read or AVERROR
  41  */
  42 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size);
  43
  44 void ffio_fill(AVIOContext *s, int b, int count);
  45
  46 static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
  47 {
  48     avio_wl32(pb, MKTAG(s[0], s[1], s[2], s[3]));
  49 }
  50
  51 /**
  52  * Rewind the AVIOContext using the specified buffer containing the first buf_size bytes of the file.
  53  * Used after probing to avoid seeking.
  54  * Joins buf and s->buffer, taking any overlap into consideration.
  55  * @note s->buffer must overlap with buf or they can't be joined and the function fails
  56  *
  57  * @param s The read-only AVIOContext to rewind
  58  * @param buf The probe buffer containing the first buf_size bytes of the file
  59  * @param buf_size The size of buf
  60  * @return 0 in case of success, a negative value corresponding to an
  61  * AVERROR code in case of failure
  62  */
  63 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char *buf, int buf_size);
  64
  65 uint64_t ffio_read_varlen(AVIOContext *bc);
  66
  67 /** @warning must be called before any I/O */
  68 int ffio_set_buf_size(AVIOContext *s, int buf_size);
  69
  70 void ffio_init_checksum(AVIOContext *s,
  71                         unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
  72                         unsigned long checksum);
  73 unsigned long ffio_get_checksum(AVIOContext *s);
  74 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
  75                                     unsigned int len);
  76
  77 /**
  78  * Open a write only packetized memory stream with a maximum packet
  79  * size of 'max_packet_size'.  The stream is stored in a memory buffer
  80  * with a big endian 4 byte header giving the packet size in bytes.
  81  *
  82  * @param s new IO context
  83  * @param max_packet_size maximum packet size (must be > 0)
  84  * @return zero if no error.
  85  */
  86 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
  87
  88 /**
  89  * Create and initialize a AVIOContext for accessing the
  90  * resource referenced by the URLContext h.
  91  * @note When the URLContext h has been opened in read+write mode, the
  92  * AVIOContext can be used only for writing.
  93  *
  94  * @param s Used to return the pointer to the created AVIOContext.
  95  * In case of failure the pointed to value is set to NULL.
  96  * @return 0 in case of success, a negative value corresponding to an
  97  * AVERROR code in case of failure
  98  */
  99 int ffio_fdopen(AVIOContext **s, URLContext *h);
 100
 101 #endif /* AVFORMAT_AVIO_INTERNAL_H */