2 * This file is part of FFmpeg.
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 #ifndef AVFORMAT_AVIO_INTERNAL_H
20 #define AVFORMAT_AVIO_INTERNAL_H
25 #include "libavutil/log.h"
27 typedef struct AVIOInternal {
32 extern const AVClass ff_avio_class;
34 int ffio_init_context(AVIOContext *s,
35 unsigned char *buffer,
39 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
40 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
41 int64_t (*seek)(void *opaque, int64_t offset, int whence));
45 * Read size bytes from AVIOContext, returning a pointer.
46 * Note that the data pointed at by the returned pointer is only
47 * valid until the next call that references the same IO context.
49 * @param buf pointer to buffer into which to assemble the requested
50 * data if it is not available in contiguous addresses in the
52 * @param size number of bytes requested
53 * @param data address at which to store pointer: this will be a
54 * a direct pointer into the underlying buffer if the requested
55 * number of bytes are available at contiguous addresses, otherwise
56 * will be a copy of buf
57 * @return number of bytes read or AVERROR
59 int ffio_read_indirect(AVIOContext *s, unsigned char *buf, int size, const unsigned char **data);
62 * Read size bytes from AVIOContext into buf.
63 * This reads at most 1 packet. If that is not enough fewer bytes will be
65 * @return number of bytes read or AVERROR
67 int ffio_read_partial(AVIOContext *s, unsigned char *buf, int size);
69 void ffio_fill(AVIOContext *s, int b, int count);
71 static av_always_inline void ffio_wfourcc(AVIOContext *pb, const uint8_t *s)
73 avio_wl32(pb, MKTAG(s[0], s[1], s[2], s[3]));
77 * Rewind the AVIOContext using the specified buffer containing the first buf_size bytes of the file.
78 * Used after probing to avoid seeking.
79 * Joins buf and s->buffer, taking any overlap into consideration.
80 * @note s->buffer must overlap with buf or they can't be joined and the function fails
82 * @param s The read-only AVIOContext to rewind
83 * @param buf The probe buffer containing the first buf_size bytes of the file
84 * @param buf_size The size of buf
85 * @return >= 0 in case of success, a negative value corresponding to an
86 * AVERROR code in case of failure
88 int ffio_rewind_with_probe_data(AVIOContext *s, unsigned char **buf, int buf_size);
90 uint64_t ffio_read_varlen(AVIOContext *bc);
93 * Read size bytes from AVIOContext into buf.
94 * Check that exactly size bytes have been read.
95 * @return number of bytes read or AVERROR
97 int ffio_read_size(AVIOContext *s, unsigned char *buf, int size);
99 /** @warning must be called before any I/O */
100 int ffio_set_buf_size(AVIOContext *s, int buf_size);
103 * Ensures that the requested seekback buffer size will be available
105 * Will ensure that when reading sequentially up to buf_size, seeking
106 * within the current pos and pos+buf_size is possible.
107 * Once the stream position moves outside this window this guarantee is lost.
109 int ffio_ensure_seekback(AVIOContext *s, int64_t buf_size);
111 int ffio_limit(AVIOContext *s, int size);
113 void ffio_init_checksum(AVIOContext *s,
114 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
115 unsigned long checksum);
116 unsigned long ffio_get_checksum(AVIOContext *s);
117 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
119 unsigned long ff_crcA001_update(unsigned long checksum, const uint8_t *buf,
123 * Open a write only packetized memory stream with a maximum packet
124 * size of 'max_packet_size'. The stream is stored in a memory buffer
125 * with a big-endian 4 byte header giving the packet size in bytes.
127 * @param s new IO context
128 * @param max_packet_size maximum packet size (must be > 0)
129 * @return zero if no error.
131 int ffio_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
134 * Create and initialize a AVIOContext for accessing the
135 * resource referenced by the URLContext h.
136 * @note When the URLContext h has been opened in read+write mode, the
137 * AVIOContext can be used only for writing.
139 * @param s Used to return the pointer to the created AVIOContext.
140 * In case of failure the pointed to value is set to NULL.
141 * @return >= 0 in case of success, a negative value corresponding to an
142 * AVERROR code in case of failure
144 int ffio_fdopen(AVIOContext **s, URLContext *h);
147 * Open a write-only fake memory stream. The written data is not stored
148 * anywhere - this is only used for measuring the amount of data
151 * @param s new IO context
152 * @return zero if no error.
154 int ffio_open_null_buf(AVIOContext **s);
156 int ffio_open_whitelist(AVIOContext **s, const char *url, int flags,
157 const AVIOInterruptCB *int_cb, AVDictionary **options,
158 const char *whitelist, const char *blacklist);
161 * Close a null buffer.
163 * @param s an IO context opened by ffio_open_null_buf
164 * @return the number of bytes written to the null buffer
166 int ffio_close_null_buf(AVIOContext *s);
169 * Free a dynamic buffer.
171 * @param s a pointer to an IO context opened by avio_open_dyn_buf()
173 void ffio_free_dyn_buf(AVIOContext **s);
175 #endif /* AVFORMAT_AVIO_INTERNAL_H */