2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 #ifndef AVFORMAT_AVIO_H
21 #define AVFORMAT_AVIO_H
26 * Buffered I/O operations
31 #include "libavutil/common.h"
32 #include "libavutil/dict.h"
33 #include "libavutil/log.h"
35 #include "libavformat/version.h"
38 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
41 * Callback for checking whether to abort blocking functions.
42 * AVERROR_EXIT is returned in this case by the interrupted
43 * function. During blocking operations, callback is called with
44 * opaque as parameter. If the callback returns 1, the
45 * blocking operation will be aborted.
47 * No members can be added to this struct without a major bump, if
48 * new elements have been added after this struct in AVFormatContext
52 int (*callback)(void*);
57 * Bytestream IO Context.
58 * New fields can be added to the end with minor version bumps.
59 * Removal, reordering and changes to existing fields require a major
61 * sizeof(AVIOContext) must not be used outside libav*.
63 * @note None of the function pointers in AVIOContext should be called
64 * directly, they should only be set by the client application
65 * when implementing custom I/O. Normally these are set to the
66 * function pointers specified in avio_alloc_context()
70 * A class for private options.
72 * If this AVIOContext is created by avio_open2(), av_class is set and
73 * passes the options down to protocols.
75 * If this AVIOContext is manually allocated, then av_class may be set by
78 * warning -- this field can be NULL, be sure to not pass this AVIOContext
79 * to any av_opt_* functions in that case.
81 const AVClass *av_class;
82 unsigned char *buffer; /**< Start of the buffer. */
83 int buffer_size; /**< Maximum buffer size */
84 unsigned char *buf_ptr; /**< Current position in the buffer */
85 unsigned char *buf_end; /**< End of the data, may be less than
86 buffer+buffer_size if the read function returned
87 less data than requested, e.g. for streams where
88 no more data has been received yet. */
89 void *opaque; /**< A private pointer, passed to the read/write/seek/...
91 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
92 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
93 int64_t (*seek)(void *opaque, int64_t offset, int whence);
94 int64_t pos; /**< position in the file of the current buffer */
95 int must_flush; /**< true if the next seek should flush */
96 int eof_reached; /**< true if eof reached */
97 int write_flag; /**< true if open for writing */
99 unsigned long checksum;
100 unsigned char *checksum_ptr;
101 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
102 int error; /**< contains the error code or 0 if no error happened */
104 * Pause or resume playback for network streaming protocols - e.g. MMS.
106 int (*read_pause)(void *opaque, int pause);
108 * Seek to a given timestamp in stream with the specified stream_index.
109 * Needed for some network streaming protocols which don't support seeking
112 int64_t (*read_seek)(void *opaque, int stream_index,
113 int64_t timestamp, int flags);
115 * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
120 * max filesize, used to limit allocations
121 * This field is internal to libavformat and access from outside is not allowed.
126 * avio_read and avio_write should if possible be satisfied directly
127 * instead of going through a buffer, and avio_seek will always
128 * call the underlying seek function directly.
136 * Return AVIO_FLAG_* access flags corresponding to the access permissions
137 * of the resource in url, or a negative value corresponding to an
138 * AVERROR code in case of failure. The returned access flags are
139 * masked by the value in flags.
141 * @note This function is intrinsically unsafe, in the sense that the
142 * checked resource may change its existence or permission status from
143 * one call to another. Thus you should not trust the returned value,
144 * unless you are sure that no other processes are accessing the
147 int avio_check(const char *url, int flags);
150 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
151 * freed with av_free().
153 * @param buffer Memory block for input/output operations via AVIOContext.
154 * The buffer must be allocated with av_malloc() and friends.
155 * @param buffer_size The buffer size is very important for performance.
156 * For protocols with fixed blocksize it should be set to this blocksize.
157 * For others a typical size is a cache page, e.g. 4kb.
158 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
159 * @param opaque An opaque pointer to user-specific data.
160 * @param read_packet A function for refilling the buffer, may be NULL.
161 * @param write_packet A function for writing the buffer contents, may be NULL.
162 * @param seek A function for seeking to specified byte position, may be NULL.
164 * @return Allocated AVIOContext or NULL on failure.
166 AVIOContext *avio_alloc_context(
167 unsigned char *buffer,
171 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
172 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
173 int64_t (*seek)(void *opaque, int64_t offset, int whence));
175 void avio_w8(AVIOContext *s, int b);
176 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
177 void avio_wl64(AVIOContext *s, uint64_t val);
178 void avio_wb64(AVIOContext *s, uint64_t val);
179 void avio_wl32(AVIOContext *s, unsigned int val);
180 void avio_wb32(AVIOContext *s, unsigned int val);
181 void avio_wl24(AVIOContext *s, unsigned int val);
182 void avio_wb24(AVIOContext *s, unsigned int val);
183 void avio_wl16(AVIOContext *s, unsigned int val);
184 void avio_wb16(AVIOContext *s, unsigned int val);
187 * Write a NULL-terminated string.
188 * @return number of bytes written.
190 int avio_put_str(AVIOContext *s, const char *str);
193 * Convert an UTF-8 string to UTF-16LE and write it.
194 * @return number of bytes written.
196 int avio_put_str16le(AVIOContext *s, const char *str);
199 * Passing this as the "whence" parameter to a seek function causes it to
200 * return the filesize without seeking anywhere. Supporting this is optional.
201 * If it is not supported then the seek function will return <0.
203 #define AVSEEK_SIZE 0x10000
206 * Oring this flag as into the "whence" parameter to a seek function causes it to
207 * seek by any means (like reopening and linear reading) or other normally unreasonble
208 * means that can be extreemly slow.
209 * This may be ignored by the seek code.
211 #define AVSEEK_FORCE 0x20000
214 * fseek() equivalent for AVIOContext.
215 * @return new position or AVERROR.
217 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
220 * Skip given number of bytes forward
221 * @return new position or AVERROR.
223 int64_t avio_skip(AVIOContext *s, int64_t offset);
226 * ftell() equivalent for AVIOContext.
227 * @return position or AVERROR.
229 static av_always_inline int64_t avio_tell(AVIOContext *s)
231 return avio_seek(s, 0, SEEK_CUR);
236 * @return filesize or AVERROR
238 int64_t avio_size(AVIOContext *s);
241 * feof() equivalent for AVIOContext.
242 * @return non zero if and only if end of file
244 int url_feof(AVIOContext *s);
246 /** @warning currently size is limited */
247 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
249 void avio_flush(AVIOContext *s);
253 * Read size bytes from AVIOContext into buf.
254 * @return number of bytes read or AVERROR
256 int avio_read(AVIOContext *s, unsigned char *buf, int size);
259 * @name Functions for reading from AVIOContext
262 * @note return 0 if EOF, so you cannot use it if EOF handling is
265 int avio_r8 (AVIOContext *s);
266 unsigned int avio_rl16(AVIOContext *s);
267 unsigned int avio_rl24(AVIOContext *s);
268 unsigned int avio_rl32(AVIOContext *s);
269 uint64_t avio_rl64(AVIOContext *s);
270 unsigned int avio_rb16(AVIOContext *s);
271 unsigned int avio_rb24(AVIOContext *s);
272 unsigned int avio_rb32(AVIOContext *s);
273 uint64_t avio_rb64(AVIOContext *s);
279 * Read a string from pb into buf. The reading will terminate when either
280 * a NULL character was encountered, maxlen bytes have been read, or nothing
281 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
282 * will be truncated if buf is too small.
283 * Note that the string is not interpreted or validated in any way, it
284 * might get truncated in the middle of a sequence for multi-byte encodings.
286 * @return number of bytes read (is always <= maxlen).
287 * If reading ends on EOF or error, the return value will be one more than
288 * bytes actually read.
290 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
293 * Read a UTF-16 string from pb and convert it to UTF-8.
294 * The reading will terminate when either a null or invalid character was
295 * encountered or maxlen bytes have been read.
296 * @return number of bytes read (is always <= maxlen)
298 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
299 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
303 * @name URL open modes
304 * The flags argument to avio_open must be one of the following
305 * constants, optionally ORed with other flags.
308 #define AVIO_FLAG_READ 1 /**< read-only */
309 #define AVIO_FLAG_WRITE 2 /**< write-only */
310 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE) /**< read-write pseudo flag */
316 * Use non-blocking mode.
317 * If this flag is set, operations on the context will return
318 * AVERROR(EAGAIN) if they can not be performed immediately.
319 * If this flag is not set, operations on the context will never return
321 * Note that this flag does not affect the opening/connecting of the
322 * context. Connecting a protocol will always block if necessary (e.g. on
323 * network protocols) but never hang (e.g. on busy devices).
324 * Warning: non-blocking protocols is work-in-progress; this flag may be
327 #define AVIO_FLAG_NONBLOCK 8
331 * avio_read and avio_write should if possible be satisfied directly
332 * instead of going through a buffer, and avio_seek will always
333 * call the underlying seek function directly.
335 #define AVIO_FLAG_DIRECT 0x8000
338 * Create and initialize a AVIOContext for accessing the
339 * resource indicated by url.
340 * @note When the resource indicated by url has been opened in
341 * read+write mode, the AVIOContext can be used only for writing.
343 * @param s Used to return the pointer to the created AVIOContext.
344 * In case of failure the pointed to value is set to NULL.
345 * @param flags flags which control how the resource indicated by url
347 * @return 0 in case of success, a negative value corresponding to an
348 * AVERROR code in case of failure
350 int avio_open(AVIOContext **s, const char *url, int flags);
353 * Create and initialize a AVIOContext for accessing the
354 * resource indicated by url.
355 * @note When the resource indicated by url has been opened in
356 * read+write mode, the AVIOContext can be used only for writing.
358 * @param s Used to return the pointer to the created AVIOContext.
359 * In case of failure the pointed to value is set to NULL.
360 * @param flags flags which control how the resource indicated by url
362 * @param int_cb an interrupt callback to be used at the protocols level
363 * @param options A dictionary filled with protocol-private options. On return
364 * this parameter will be destroyed and replaced with a dict containing options
365 * that were not found. May be NULL.
366 * @return 0 in case of success, a negative value corresponding to an
367 * AVERROR code in case of failure
369 int avio_open2(AVIOContext **s, const char *url, int flags,
370 const AVIOInterruptCB *int_cb, AVDictionary **options);
373 * Close the resource accessed by the AVIOContext s and free it.
374 * This function can only be used if s was opened by avio_open().
376 * @return 0 on success, an AVERROR < 0 on error.
378 int avio_close(AVIOContext *s);
381 * Open a write only memory stream.
383 * @param s new IO context
384 * @return zero if no error.
386 int avio_open_dyn_buf(AVIOContext **s);
389 * Return the written size and a pointer to the buffer. The buffer
390 * must be freed with av_free().
391 * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
393 * @param s IO context
394 * @param pbuffer pointer to a byte buffer
395 * @return the length of the byte buffer
397 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
400 * Iterate through names of available protocols.
401 * @note it is recommended to use av_protocol_next() instead of this
403 * @param opaque A private pointer representing current protocol.
404 * It must be a pointer to NULL on first iteration and will
405 * be updated by successive calls to avio_enum_protocols.
406 * @param output If set to 1, iterate over output protocols,
407 * otherwise over input protocols.
409 * @return A static string containing the name of current protocol or NULL
411 const char *avio_enum_protocols(void **opaque, int output);
414 * Pause and resume playing - only meaningful if using a network streaming
415 * protocol (e.g. MMS).
416 * @param pause 1 for pause, 0 for resume
418 int avio_pause(AVIOContext *h, int pause);
421 * Seek to a given timestamp relative to some component stream.
422 * Only meaningful if using a network streaming protocol (e.g. MMS.).
423 * @param stream_index The stream index that the timestamp is relative to.
424 * If stream_index is (-1) the timestamp should be in AV_TIME_BASE
425 * units from the beginning of the presentation.
426 * If a stream_index >= 0 is used and the protocol does not support
427 * seeking based on component streams, the call will fail.
428 * @param timestamp timestamp in AVStream.time_base units
429 * or if there is no stream specified then in AV_TIME_BASE units.
430 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
431 * and AVSEEK_FLAG_ANY. The protocol may silently ignore
432 * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
433 * fail if used and not supported.
434 * @return >= 0 on success
435 * @see AVInputFormat::read_seek
437 int64_t avio_seek_time(AVIOContext *h, int stream_index,
438 int64_t timestamp, int flags);
440 #endif /* AVFORMAT_AVIO_H */