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 |
eca06cbe |
* @ingroup lavf_io |
6084ee5d |
* Buffered I/O operations |
aafe9b63 |
*/
|
99545457 |
#include <stdint.h>
|
30f68128 |
#include "libavutil/common.h" |
1dee0aca |
#include "libavutil/dict.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 */
/** |
6aa0b98f |
* Callback for checking whether to abort blocking functions.
* AVERROR_EXIT is returned in this case by the interrupted
* function. During blocking operations, callback is called with
* opaque as parameter. If the callback returns 1, the
* blocking operation will be aborted.
*
* No members can be added to this struct without a major bump, if
* new elements have been added after this struct in AVFormatContext
* or AVIOContext.
*/ |
0575772f |
typedef struct AVIOInterruptCB { |
6aa0b98f |
int (*callback)(void*);
void *opaque;
} AVIOInterruptCB;
/** |
fafa7290 |
* 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 |
*/ |
0575772f |
typedef struct AVIOContext { |
1dee0aca |
/**
* A class for private options.
*
* If this AVIOContext is created by avio_open2(), av_class is set and
* passes the options down to protocols.
*
* If this AVIOContext is manually allocated, then av_class may be set by
* the caller.
*
* warning -- this field can be NULL, be sure to not pass this AVIOContext
* to any av_opt_* functions in that case.
*/ |
6208313a |
const AVClass *av_class; |
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 |
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; |
47572323 |
/**
* max filesize, used to limit allocations
* This field is internal to libavformat and access from outside is not allowed.
*/ |
c6ae7f64 |
int64_t maxsize; |
a45605a1 |
|
c6ae7f64 |
/**
* avio_read and avio_write should if possible be satisfied directly
* instead of going through a buffer, and avio_seek will always
* call the underlying seek function directly.
*/
int direct; |
11153a93 |
/**
* Bytes read statistic
* This field is internal to libavformat and access from outside is not allowed.
*/ |
c6ae7f64 |
int64_t bytes_read; |
11153a93 |
/**
* seek statistic
* This field is internal to libavformat and access from outside is not allowed.
*/ |
c6ae7f64 |
int seek_count; |
ad6a50c0 |
/**
* writeout statistic
* This field is internal to libavformat and access from outside is not allowed.
*/ |
c6ae7f64 |
int writeout_count; |
fafa7290 |
} AVIOContext;
|
de6d9b64 |
/* unbuffered I/O */
|
37744e32 |
/** |
db3c9701 |
* Return the name of the protocol that will handle the passed URL.
*
* NULL is returned if no protocol could be found for the given URL.
*
* @return Name of the protocol or NULL.
*/
const char *avio_find_protocol_name(const char *url);
/** |
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 |
|
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. |
55cdd454 |
* The function may not change the input buffers content. |
3c96c648 |
* @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 |
1f68bac5 |
* seek by any means (like reopening and linear reading) or other normally unreasonable
* means that can be extremely slow. |
230a4686 |
* 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 */ |
9abbe8cc |
int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3); |
a8c5ab27 |
|
63f57f85 |
/**
* Force flushing of buffered data to the output s.
*
* Force the buffered data to be immediately written to the output,
* without to wait to fill the internal buffer.
*/ |
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 |
/** |
21a19b79 |
* @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 |
/** |
21a19b79 |
* @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 |
/** |
a45605a1 |
* Use direct mode.
* avio_read and avio_write should if possible be satisfied directly
* instead of going through a buffer, and avio_seek will always
* call the underlying seek function directly.
*/
#define AVIO_FLAG_DIRECT 0x8000
/** |
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. |
4d7ab5cf |
* @param url resource to access |
fe4fbb58 |
* @param flags flags which control how the resource indicated by url
* is to be opened |
d5ec8ba7 |
* @return >= 0 in case of success, a negative value corresponding to an |
fe4fbb58 |
* AVERROR code in case of failure
*/ |
ebb92e07 |
int avio_open(AVIOContext **s, const char *url, int flags); |
fe4fbb58 |
|
c3316802 |
/** |
1dee0aca |
* Create and initialize a AVIOContext for accessing the
* resource indicated by url.
* @note When the resource indicated by url has been opened in
* read+write mode, the AVIOContext can be used only for writing.
*
* @param s Used to return the pointer to the created AVIOContext.
* In case of failure the pointed to value is set to NULL. |
4d7ab5cf |
* @param url resource to access |
1dee0aca |
* @param flags flags which control how the resource indicated by url
* is to be opened
* @param int_cb an interrupt callback to be used at the protocols level
* @param options A dictionary filled with protocol-private options. On return
* this parameter will be destroyed and replaced with a dict containing options
* that were not found. May be NULL. |
d5ec8ba7 |
* @return >= 0 in case of success, a negative value corresponding to an |
1dee0aca |
* AVERROR code in case of failure
*/
int avio_open2(AVIOContext **s, const char *url, int flags,
const AVIOInterruptCB *int_cb, AVDictionary **options);
/** |
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().
* |
72521354 |
* The internal buffer is automatically flushed before closing the
* resource.
* |
e782a0c6 |
* @return 0 on success, an AVERROR < 0 on error. |
b522000e |
* @see avio_closep |
a8c5ab27 |
*/ |
22a3212e |
int avio_close(AVIOContext *s); |
de6d9b64 |
|
c3316802 |
/** |
b522000e |
* Close the resource accessed by the AVIOContext *s, free it
* and set the pointer pointing to it to NULL.
* This function can only be used if s was opened by avio_open().
*
* The internal buffer is automatically flushed before closing the
* resource.
*
* @return 0 on success, an AVERROR < 0 on error.
* @see avio_close
*/
int avio_closep(AVIOContext **s);
/** |
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.
*
* @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). |
4d7ab5cf |
*
* @param h IO context from which to call the read_pause function pointer |
ff1ec0c3 |
* @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.). |
4d7ab5cf |
*
* @param h IO context from which to call the seek function pointers |
ff1ec0c3 |
* @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 |
077b086d |
* seeking based on component streams, the call will fail. |
ff1ec0c3 |
* @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 |
077b086d |
* fail if used and not supported. |
ff1ec0c3 |
* @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 */ |