libavformat/avio.h
04d7f601
 /*
  * copyright (c) 2001 Fabrice Bellard
  *
b78e7197
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
04d7f601
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
b78e7197
  * version 2.1 of the License, or (at your option) any later version.
04d7f601
  *
b78e7197
  * FFmpeg is distributed in the hope that it will be useful,
04d7f601
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
b78e7197
  * License along with FFmpeg; if not, write to the Free Software
04d7f601
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
98790382
 #ifndef AVFORMAT_AVIO_H
 #define AVFORMAT_AVIO_H
f031df23
 
aafe9b63
 /**
ba87f080
  * @file
6084ee5d
  * Buffered I/O operations
aafe9b63
  */
 
99545457
 #include <stdint.h>
 
30f68128
 #include "libavutil/common.h"
ed8d5766
 #include "libavutil/log.h"
30f68128
 
d3058be6
 #include "libavformat/version.h"
 
fafa7290
 
 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
 
 /**
  * Bytestream IO Context.
  * New fields can be added to the end with minor version bumps.
  * Removal, reordering and changes to existing fields require a major
  * version bump.
  * sizeof(AVIOContext) must not be used outside libav*.
d1c5fdf8
  *
  * @note None of the function pointers in AVIOContext should be called
  *       directly, they should only be set by the client application
  *       when implementing custom I/O. Normally these are set to the
  *       function pointers specified in avio_alloc_context()
fafa7290
  */
 typedef struct {
c1a9012d
     unsigned char *buffer;  /**< Start of the buffer. */
     int buffer_size;        /**< Maximum buffer size */
     unsigned char *buf_ptr; /**< Current position in the buffer */
     unsigned char *buf_end; /**< End of the data, may be less than
                                  buffer+buffer_size if the read function returned
                                  less data than requested, e.g. for streams where
                                  no more data has been received yet. */
     void *opaque;           /**< A private pointer, passed to the read/write/seek/...
                                  functions. */
fafa7290
     int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
     int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
     int64_t (*seek)(void *opaque, int64_t offset, int whence);
893816ba
     int64_t pos;            /**< position in the file of the current buffer */
     int must_flush;         /**< true if the next seek should flush */
     int eof_reached;        /**< true if eof reached */
     int write_flag;         /**< true if open for writing */
fafa7290
 #if FF_API_OLD_AVIO
     attribute_deprecated int is_streamed;
 #endif
     int max_packet_size;
     unsigned long checksum;
     unsigned char *checksum_ptr;
     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
893816ba
     int error;              /**< contains the error code or 0 if no error happened */
d1c5fdf8
     /**
      * Pause or resume playback for network streaming protocols - e.g. MMS.
      */
fafa7290
     int (*read_pause)(void *opaque, int pause);
d1c5fdf8
     /**
      * Seek to a given timestamp in stream with the specified stream_index.
      * Needed for some network streaming protocols which don't support seeking
      * to byte position.
      */
fafa7290
     int64_t (*read_seek)(void *opaque, int stream_index,
                          int64_t timestamp, int flags);
     /**
      * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
      */
     int seekable;
 } AVIOContext;
 
de6d9b64
 /* unbuffered I/O */
 
c486dade
 #if FF_API_OLD_AVIO
1308f273
 /**
  * URL Context.
  * New fields can be added to the end with minor version bumps.
8bfb108b
  * Removal, reordering and changes to existing fields require a major
1308f273
  * version bump.
8bfb108b
  * sizeof(URLContext) must not be used outside libav*.
c486dade
  * @deprecated This struct will be made private
1308f273
  */
597b4b3f
 typedef struct URLContext {
5acef35f
     const AVClass *av_class; ///< information for av_log(). Set by url_open().
de6d9b64
     struct URLProtocol *prot;
115329f1
     int flags;
c3316802
     int is_streamed;  /**< true if streamed (no seek possible), default = false */
     int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
de6d9b64
     void *priv_data;
725b3da9
     char *filename; /**< specified URL */
ffbb289a
     int is_connected;
597b4b3f
 } URLContext;
de6d9b64
 
37744e32
 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
 
 /**
  * @deprecated This struct is to be made private. Use the higher-level
  *             AVIOContext-based API instead.
  */
 typedef struct URLProtocol {
     const char *name;
     int (*url_open)(URLContext *h, const char *url, int flags);
     int (*url_read)(URLContext *h, unsigned char *buf, int size);
     int (*url_write)(URLContext *h, const unsigned char *buf, int size);
     int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
     int (*url_close)(URLContext *h);
     struct URLProtocol *next;
     int (*url_read_pause)(URLContext *h, int pause);
     int64_t (*url_read_seek)(URLContext *h, int stream_index,
                              int64_t timestamp, int flags);
     int (*url_get_file_handle)(URLContext *h);
     int priv_data_size;
     const AVClass *priv_data_class;
     int flags;
175389c8
     int (*url_check)(URLContext *h, int mask);
37744e32
 } URLProtocol;
 
de6d9b64
 typedef struct URLPollEntry {
     URLContext *handle;
     int events;
     int revents;
 } URLPollEntry;
 
37744e32
 /* not implemented */
 attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
 
f4bd5800
 /**
2fe47b21
  * @name URL open modes
f4bd5800
  * The flags argument to url_open and cosins must be one of the following
  * constants, optionally ORed with other flags.
  * @{
  */
5b81e295
 #define URL_RDONLY 1  /**< read-only */
 #define URL_WRONLY 2  /**< write-only */
 #define URL_RDWR   (URL_RDONLY|URL_WRONLY)  /**< read-write */
f4bd5800
 /**
  * @}
  */
 
 /**
  * Use non-blocking mode.
  * If this flag is set, operations on the context will return
  * AVERROR(EAGAIN) if they can not be performed immediately.
  * If this flag is not set, operations on the context will never return
  * AVERROR(EAGAIN).
  * Note that this flag does not affect the opening/connecting of the
  * context. Connecting a protocol will always block if necessary (e.g. on
  * network protocols) but never hang (e.g. on busy devices).
  * Warning: non-blocking protocols is work-in-progress; this flag may be
  * silently ignored.
  */
 #define URL_FLAG_NONBLOCK 4
f031df23
 
019ac05a
 typedef int URLInterruptCB(void);
37744e32
 extern URLInterruptCB *url_interrupt_cb;
019ac05a
 
333146dd
 /**
333e8943
  * @defgroup old_url_funcs Old url_* functions
2fe47b21
  * The following functions are deprecated. Use the buffered API based on #AVIOContext instead.
333e8943
  * @{
f1f78a9d
  */
333e8943
 attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                                             const char *url, int flags);
5652bb94
 attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
62eaaeac
 attribute_deprecated int url_connect(URLContext *h);
0589da0a
 attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
bc371aca
 attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
dce37564
 attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
925e908b
 attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
58a48c65
 attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
e52a9145
 attribute_deprecated int url_close(URLContext *h);
32a97d46
 attribute_deprecated int64_t url_filesize(URLContext *h);
1869ea03
 attribute_deprecated int url_get_file_handle(URLContext *h);
5958df34
 attribute_deprecated int url_get_max_packet_size(URLContext *h);
727c7aa0
 attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
fa104e14
 attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
1305d93c
 attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
                                               int64_t timestamp, int flags);
026e1757
 attribute_deprecated void url_set_interrupt_cb(int (*interrupt_cb)(void));
f1f78a9d
 
8a36b59b
 /**
ab8cfd45
  * returns the next registered protocol after the given protocol (the first if
  * NULL is given), or NULL if protocol is the last one.
9075d1e0
  */
84be6e72
 URLProtocol *av_protocol_next(URLProtocol *p);
 
d19a046e
 /**
49bd8e4b
  * Register the URLProtocol protocol.
9b07a2dc
  *
  * @param size the size of the URLProtocol struct referenced
d19a046e
  */
8e76a19b
 attribute_deprecated int av_register_protocol2(URLProtocol *protocol, int size);
1308f273
 /**
333e8943
  * @}
  */
 
de6d9b64
 
471fe57e
 typedef attribute_deprecated AVIOContext ByteIOContext;
 
ae99313a
 attribute_deprecated int init_put_byte(AVIOContext *s,
de6d9b64
                   unsigned char *buffer,
                   int buffer_size,
                   int write_flag,
                   void *opaque,
1e0f3468
                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
bc5c918e
                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
90ed2776
 attribute_deprecated AVIOContext *av_alloc_put_byte(
                   unsigned char *buffer,
                   int buffer_size,
                   int write_flag,
                   void *opaque,
                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
e63a3628
 
 /**
  * @defgroup old_avio_funcs Old put_/get_*() functions
2fe47b21
  * The following functions are deprecated. Use the "avio_"-prefixed functions instead.
e63a3628
  * @{
  */
 attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
d4e321d9
 attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
e63a3628
 attribute_deprecated int          get_byte(AVIOContext *s);
 attribute_deprecated unsigned int get_le16(AVIOContext *s);
 attribute_deprecated unsigned int get_le24(AVIOContext *s);
 attribute_deprecated unsigned int get_le32(AVIOContext *s);
 attribute_deprecated uint64_t     get_le64(AVIOContext *s);
 attribute_deprecated unsigned int get_be16(AVIOContext *s);
 attribute_deprecated unsigned int get_be24(AVIOContext *s);
 attribute_deprecated unsigned int get_be32(AVIOContext *s);
 attribute_deprecated uint64_t     get_be64(AVIOContext *s);
e9eb8d0b
 
 attribute_deprecated void         put_byte(AVIOContext *s, int b);
2df9d000
 attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
e9eb8d0b
 attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
 attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
 attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
 attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
 attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
 attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
 attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
 attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
 attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
3308ddfb
 attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
e63a3628
 /**
  * @}
  */
ebb92e07
 
933e90a6
 attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
491653ed
 attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
933e90a6
                                                 int64_t timestamp, int flags);
ebb92e07
 
 /**
  * @defgroup old_url_f_funcs Old url_f* functions
2fe47b21
  * The following functions are deprecated, use the "avio_"-prefixed functions instead.
ebb92e07
  * @{
  */
 attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
 attribute_deprecated int url_fclose(AVIOContext *s);
f59d8ff8
 attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
813cc7ab
 attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
384c9c2f
 attribute_deprecated int64_t url_ftell(AVIOContext *s);
db44ea96
 attribute_deprecated int64_t url_fsize(AVIOContext *s);
1447dc59
 #define URL_EOF (-1)
 attribute_deprecated int url_fgetc(AVIOContext *s);
59f65d95
 attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
d9d86e00
 #ifdef __GNUC__
 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
 #else
 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
 #endif
b7f2fdde
 attribute_deprecated void put_flush_packet(AVIOContext *s);
b92c5452
 attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
403ee835
 attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
6dc7d80d
 attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
724f6a0f
 attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
ebb92e07
 /**
  * @}
  */
66e5b1df
 
3e68b3ba
 attribute_deprecated int url_ferror(AVIOContext *s);
4ec153bb
 
 attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
 attribute_deprecated int udp_get_local_port(URLContext *h);
4c4427a7
 
 attribute_deprecated void init_checksum(AVIOContext *s,
                    unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
                    unsigned long checksum);
b64030f2
 attribute_deprecated unsigned long get_checksum(AVIOContext *s);
37744e32
 attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
 /** @note unlike fgets, the EOL character is not returned and a whole
     line is parsed. return NULL if first char read was EOF */
 attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
 /**
  * @deprecated use avio_get_str instead
  */
 attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
 /**
  * @deprecated Use AVIOContext.seekable field directly.
  */
 attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
 {
     return !s->seekable;
 }
 attribute_deprecated URLContext *url_fileno(AVIOContext *s);
 
 /**
  * @deprecated use AVIOContext.max_packet_size directly.
  */
 attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
 
 attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
 
 /** return the written or read size */
 attribute_deprecated int url_close_buf(AVIOContext *s);
 
 /**
  * Return a non-zero value if the resource indicated by url
  * exists, 0 otherwise.
4bde56d1
  * @deprecated Use avio_check instead.
37744e32
  */
4bde56d1
 attribute_deprecated int url_exist(const char *url);
 #endif // FF_API_OLD_AVIO
37744e32
 
 /**
59d96941
  * Return AVIO_FLAG_* access flags corresponding to the access permissions
175389c8
  * of the resource in url, or a negative value corresponding to an
  * AVERROR code in case of failure. The returned access flags are
  * masked by the value in flags.
  *
  * @note This function is intrinsically unsafe, in the sense that the
  * checked resource may change its existence or permission status from
  * one call to another. Thus you should not trust the returned value,
  * unless you are sure that no other processes are accessing the
  * checked resource.
  */
 int avio_check(const char *url, int flags);
37744e32
 
 /**
  * The callback is called in blocking functions to test regulary if
  * asynchronous interruption is needed. AVERROR_EXIT is returned
  * in this case by the interrupted function. 'NULL' means no interrupt
  * callback is given.
  */
 void avio_set_interrupt_cb(int (*interrupt_cb)(void));
 
3c96c648
 /**
  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
  * freed with av_free().
  *
  * @param buffer Memory block for input/output operations via AVIOContext.
d49051e0
  *        The buffer must be allocated with av_malloc() and friends.
3c96c648
  * @param buffer_size The buffer size is very important for performance.
  *        For protocols with fixed blocksize it should be set to this blocksize.
  *        For others a typical size is a cache page, e.g. 4kb.
  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
  * @param opaque An opaque pointer to user-specific data.
  * @param read_packet  A function for refilling the buffer, may be NULL.
  * @param write_packet A function for writing the buffer contents, may be NULL.
  * @param seek A function for seeking to specified byte position, may be NULL.
  *
  * @return Allocated AVIOContext or NULL on failure.
  */
90ed2776
 AVIOContext *avio_alloc_context(
1e0f3468
                   unsigned char *buffer,
                   int buffer_size,
                   int write_flag,
                   void *opaque,
0c1a9eda
                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
576ae256
                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
bc5c918e
                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
de6d9b64
 
e9eb8d0b
 void avio_w8(AVIOContext *s, int b);
 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
 void avio_wl64(AVIOContext *s, uint64_t val);
 void avio_wb64(AVIOContext *s, uint64_t val);
 void avio_wl32(AVIOContext *s, unsigned int val);
 void avio_wb32(AVIOContext *s, unsigned int val);
 void avio_wl24(AVIOContext *s, unsigned int val);
 void avio_wb24(AVIOContext *s, unsigned int val);
 void avio_wl16(AVIOContext *s, unsigned int val);
 void avio_wb16(AVIOContext *s, unsigned int val);
de6d9b64
 
e910a77b
 /**
  * Write a NULL-terminated string.
  * @return number of bytes written.
  */
471fe57e
 int avio_put_str(AVIOContext *s, const char *str);
75bdb984
 
67e21020
 /**
6e89b612
  * Convert an UTF-8 string to UTF-16LE and write it.
  * @return number of bytes written.
  */
471fe57e
 int avio_put_str16le(AVIOContext *s, const char *str);
6e89b612
 
 /**
230a4686
  * Passing this as the "whence" parameter to a seek function causes it to
  * return the filesize without seeking anywhere. Supporting this is optional.
  * If it is not supported then the seek function will return <0.
  */
 #define AVSEEK_SIZE 0x10000
 
 /**
  * Oring this flag as into the "whence" parameter to a seek function causes it to
  * seek by any means (like reopening and linear reading) or other normally unreasonble
  * means that can be extreemly slow.
  * This may be ignored by the seek code.
  */
 #define AVSEEK_FORCE 0x20000
 
 /**
471fe57e
  * fseek() equivalent for AVIOContext.
67e21020
  * @return new position or AVERROR.
  */
f59d8ff8
 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
67e21020
 
 /**
75a8e0f0
  * Skip given number of bytes forward
  * @return new position or AVERROR.
  */
 int64_t avio_skip(AVIOContext *s, int64_t offset);
 
 /**
471fe57e
  * ftell() equivalent for AVIOContext.
67e21020
  * @return position or AVERROR.
  */
af020732
 static av_always_inline int64_t avio_tell(AVIOContext *s)
 {
     return avio_seek(s, 0, SEEK_CUR);
 }
67e21020
 
 /**
49bd8e4b
  * Get the filesize.
67e21020
  * @return filesize or AVERROR
  */
db44ea96
 int64_t avio_size(AVIOContext *s);
67e21020
 
 /**
471fe57e
  * feof() equivalent for AVIOContext.
67e21020
  * @return non zero if and only if end of file
  */
471fe57e
 int url_feof(AVIOContext *s);
67e21020
 
c3316802
 /** @warning currently size is limited */
572f992e
 #ifdef __GNUC__
d9d86e00
 int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
572f992e
 #else
d9d86e00
 int avio_printf(AVIOContext *s, const char *fmt, ...);
572f992e
 #endif
a8c5ab27
 
b7f2fdde
 void avio_flush(AVIOContext *s);
de6d9b64
 
4edfcecc
 
 /**
471fe57e
  * Read size bytes from AVIOContext into buf.
32e543f8
  * @return number of bytes read or AVERROR
4edfcecc
  */
e63a3628
 int avio_read(AVIOContext *s, unsigned char *buf, int size);
4edfcecc
 
72d4405b
 /**
2fe47b21
  * @name Functions for reading from AVIOContext
72d4405b
  * @{
  *
  * @note return 0 if EOF, so you cannot use it if EOF handling is
  *       necessary
  */
e63a3628
 int          avio_r8  (AVIOContext *s);
 unsigned int avio_rl16(AVIOContext *s);
 unsigned int avio_rl24(AVIOContext *s);
 unsigned int avio_rl32(AVIOContext *s);
 uint64_t     avio_rl64(AVIOContext *s);
72d4405b
 unsigned int avio_rb16(AVIOContext *s);
 unsigned int avio_rb24(AVIOContext *s);
 unsigned int avio_rb32(AVIOContext *s);
 uint64_t     avio_rb64(AVIOContext *s);
 /**
  * @}
  */
de6d9b64
 
f9d6b13a
 /**
3e1a8e1e
  * Read a string from pb into buf. The reading will terminate when either
  * a NULL character was encountered, maxlen bytes have been read, or nothing
  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
  * will be truncated if buf is too small.
  * Note that the string is not interpreted or validated in any way, it
  * might get truncated in the middle of a sequence for multi-byte encodings.
  *
  * @return number of bytes read (is always <= maxlen).
  * If reading ends on EOF or error, the return value will be one more than
  * bytes actually read.
  */
 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
 
 /**
f9d6b13a
  * Read a UTF-16 string from pb and convert it to UTF-8.
  * The reading will terminate when either a null or invalid character was
  * encountered or maxlen bytes have been read.
  * @return number of bytes read (is always <= maxlen)
  */
471fe57e
 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
f9d6b13a
 
a8c5ab27
 
fe4fbb58
 /**
2fe47b21
  * @name URL open modes
f87b1b37
  * The flags argument to avio_open must be one of the following
  * constants, optionally ORed with other flags.
  * @{
  */
59d96941
 #define AVIO_FLAG_READ  1                                      /**< read-only */
 #define AVIO_FLAG_WRITE 2                                      /**< write-only */
 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE)  /**< read-write pseudo flag */
f87b1b37
 /**
  * @}
  */
 
 /**
  * Use non-blocking mode.
  * If this flag is set, operations on the context will return
  * AVERROR(EAGAIN) if they can not be performed immediately.
  * If this flag is not set, operations on the context will never return
  * AVERROR(EAGAIN).
  * Note that this flag does not affect the opening/connecting of the
  * context. Connecting a protocol will always block if necessary (e.g. on
  * network protocols) but never hang (e.g. on busy devices).
  * Warning: non-blocking protocols is work-in-progress; this flag may be
  * silently ignored.
  */
cbea3ac8
 #define AVIO_FLAG_NONBLOCK 8
f87b1b37
 
 /**
471fe57e
  * Create and initialize a AVIOContext for accessing the
fe4fbb58
  * resource indicated by url.
  * @note When the resource indicated by url has been opened in
471fe57e
  * read+write mode, the AVIOContext can be used only for writing.
fe4fbb58
  *
471fe57e
  * @param s Used to return the pointer to the created AVIOContext.
fe4fbb58
  * In case of failure the pointed to value is set to NULL.
  * @param flags flags which control how the resource indicated by url
  * is to be opened
  * @return 0 in case of success, a negative value corresponding to an
  * AVERROR code in case of failure
  */
ebb92e07
 int avio_open(AVIOContext **s, const char *url, int flags);
fe4fbb58
 
c3316802
 /**
e782a0c6
  * Close the resource accessed by the AVIOContext s and free it.
  * This function can only be used if s was opened by avio_open().
  *
  * @return 0 on success, an AVERROR < 0 on error.
a8c5ab27
  */
22a3212e
 int avio_close(AVIOContext *s);
de6d9b64
 
c3316802
 /**
a8c5ab27
  * Open a write only memory stream.
  *
  * @param s new IO context
  * @return zero if no error.
  */
b92c5452
 int avio_open_dyn_buf(AVIOContext **s);
a8c5ab27
 
c3316802
 /**
a8c5ab27
  * Return the written size and a pointer to the buffer. The buffer
403ee835
  * must be freed with av_free().
  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
de1807bb
  *
a8c5ab27
  * @param s IO context
e8b7c70f
  * @param pbuffer pointer to a byte buffer
a8c5ab27
  * @return the length of the byte buffer
  */
6dc7d80d
 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
f031df23
 
f8270bbf
 /**
  * Iterate through names of available protocols.
d4d09329
  * @note it is recommanded to use av_protocol_next() instead of this
f8270bbf
  *
  * @param opaque A private pointer representing current protocol.
  *        It must be a pointer to NULL on first iteration and will
  *        be updated by successive calls to avio_enum_protocols.
  * @param output If set to 1, iterate over output protocols,
  *               otherwise over input protocols.
  *
  * @return A static string containing the name of current protocol or NULL
  */
 const char *avio_enum_protocols(void **opaque, int output);
 
ff1ec0c3
 /**
  * Pause and resume playing - only meaningful if using a network streaming
  * protocol (e.g. MMS).
  * @param pause 1 for pause, 0 for resume
  */
 int     avio_pause(AVIOContext *h, int pause);
 
 /**
  * Seek to a given timestamp relative to some component stream.
  * Only meaningful if using a network streaming protocol (e.g. MMS.).
  * @param stream_index The stream index that the timestamp is relative to.
  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
  *        units from the beginning of the presentation.
  *        If a stream_index >= 0 is used and the protocol does not support
  *        seeking based on component streams, the call will fail with ENOTSUP.
  * @param timestamp timestamp in AVStream.time_base units
  *        or if there is no stream specified then in AV_TIME_BASE units.
  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
  *        fail with ENOTSUP if used and not supported.
  * @return >= 0 on success
  * @see AVInputFormat::read_seek
  */
 int64_t avio_seek_time(AVIOContext *h, int stream_index,
                        int64_t timestamp, int flags);
 
98790382
 #endif /* AVFORMAT_AVIO_H */