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
  25 int ffio_init_context(AVIOContext *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                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
  33
  34
  35 /**
  36  * Read size bytes from AVIOContext into buf.
  37  * This reads at most 1 packet. If that is not enough fewer bytes will be
  38  * returned.
  39  * @return number of bytes read or AVERROR
  40  */
  41 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size);
  42
  43 void ffio_fill(AVIOContext *s, int b, int count);
  44
  45 static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
  46 {
  47     avio_wl32(pb, MKTAG(s[0], s[1], s[2], s[3]));
  48 }
  49
  50 /**
  51  * Rewind the AVIOContext using the specified buffer containing the first buf_size bytes of the file.
  52  * Used after probing to avoid seeking.
  53  * Joins buf and s->buffer, taking any overlap into consideration.
  54  * @note s->buffer must overlap with buf or they can't be joined and the function fails
  55  *
  56  * @param s The read-only AVIOContext to rewind
  57  * @param buf The probe buffer containing the first buf_size bytes of the file
  58  * @param buf_size The size of buf
  59  * @return 0 in case of success, a negative value corresponding to an
  60  * AVERROR code in case of failure
  61  */
  62 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char *buf, int buf_size);
  63
  64 uint64_t ffio_read_varlen(AVIOContext *bc);
  65
  66 /** @warning must be called before any I/O */
  67 int ffio_set_buf_size(AVIOContext *s, int buf_size);
  68
  69 /**
  70  * Pause and resume playing - only meaningful if using a network streaming
  71  * protocol (e.g. MMS).
  72  * @param pause 1 for pause, 0 for resume
  73  */
  74 int     ffio_read_pause(AVIOContext *h,    int pause);
  75 /**
  76  * Seek to a given timestamp relative to some component stream.
  77  * Only meaningful if using a network streaming protocol (e.g. MMS.).
  78  * @param stream_index The stream index that the timestamp is relative to.
  79  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
  80  *        units from the beginning of the presentation.
  81  *        If a stream_index >= 0 is used and the protocol does not support
  82  *        seeking based on component streams, the call will fail with ENOTSUP.
  83  * @param timestamp timestamp in AVStream.time_base units
  84  *        or if there is no stream specified then in AV_TIME_BASE units.
  85  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
  86  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
  87  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
  88  *        fail with ENOTSUP if used and not supported.
  89  * @return >= 0 on success
  90  * @see AVInputFormat::read_seek
  91  */
  92 int64_t ffio_read_seek (AVIOContext *h,    int stream_index,
  93                         int64_t timestamp, int flags);
  94
  95 void ffio_init_checksum(AVIOContext *s,
  96                         unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
  97                         unsigned long checksum);
  98 unsigned long ffio_get_checksum(AVIOContext *s);
  99 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
 100                                     unsigned int len);
 101
 102 /**
 103  * Open a write only packetized memory stream with a maximum packet
 104  * size of 'max_packet_size'.  The stream is stored in a memory buffer
 105  * with a big endian 4 byte header giving the packet size in bytes.
 106  *
 107  * @param s new IO context
 108  * @param max_packet_size maximum packet size (must be > 0)
 109  * @return zero if no error.
 110  */
 111 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
 112
 113 /**
 114  * Create and initialize a AVIOContext for accessing the
 115  * resource referenced by the URLContext h.
 116  * @note When the URLContext h has been opened in read+write mode, the
 117  * AVIOContext can be used only for writing.
 118  *
 119  * @param s Used to return the pointer to the created AVIOContext.
 120  * In case of failure the pointed to value is set to NULL.
 121  * @return 0 in case of success, a negative value corresponding to an
 122  * AVERROR code in case of failure
 123  */
 124 int ffio_fdopen(AVIOContext **s, URLContext *h);
 125
 126 #endif // AVFORMAT_AVIO_INTERNAL_H