X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=libavformat%2Favio.h;h=5aa24ca0a72d1c14334266a5219546ad1d9233ba;hb=4bae2251264d7818a3da50275fb7d3862b335900;hp=5a8d19f354fe5598d6365c736c360ad09f56b787;hpb=e7e4810aaef4c11b9a2d62c5656d76917bdd5a27;p=ffmpeg diff --git a/libavformat/avio.h b/libavformat/avio.h index 5a8d19f354f..5aa24ca0a72 100644 --- a/libavformat/avio.h +++ b/libavformat/avio.h @@ -1,5 +1,4 @@ /* - * unbuffered io for ffmpeg system * copyright (c) 2001 Fabrice Bellard * * This file is part of FFmpeg. @@ -18,31 +17,41 @@ * License along with FFmpeg; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef FFMPEG_AVIO_H -#define FFMPEG_AVIO_H +#ifndef AVFORMAT_AVIO_H +#define AVFORMAT_AVIO_H -#include +/** + * @file libavformat/avio.h + * unbuffered I/O operations + * + * @warning This file has to be considered an internal but installed + * header, so it should not be directly included in your projects. + */ -/* output byte stream handling */ +#include -typedef int64_t offset_t; +#include "libavutil/common.h" /* unbuffered I/O */ -struct URLContext { +/** + * URL 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(URLContext) must not be used outside libav*. + */ +typedef struct URLContext { +#if LIBAVFORMAT_VERSION_MAJOR >= 53 + const AVClass *av_class; ///< information for av_log(). Set by url_open(). +#endif struct URLProtocol *prot; int flags; 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 */ void *priv_data; -#if LIBAVFORMAT_VERSION_INT >= (52<<16) char *filename; /**< specified filename */ -#else - char filename[1]; /**< specified filename */ -#endif -}; - -typedef struct URLContext URLContext; +} URLContext; typedef struct URLPollEntry { URLContext *handle; @@ -56,17 +65,29 @@ typedef struct URLPollEntry { typedef int URLInterruptCB(void); +int url_open_protocol (URLContext **puc, struct URLProtocol *up, + const char *filename, int flags); int url_open(URLContext **h, const char *filename, int flags); int url_read(URLContext *h, unsigned char *buf, int size); +int url_read_complete(URLContext *h, unsigned char *buf, int size); int url_write(URLContext *h, unsigned char *buf, int size); -offset_t url_seek(URLContext *h, offset_t pos, int whence); +int64_t url_seek(URLContext *h, int64_t pos, int whence); int url_close(URLContext *h); int url_exist(const char *filename); -offset_t url_filesize(URLContext *h); +int64_t url_filesize(URLContext *h); + +/** + * Return the file descriptor associated with this URL. For RTP, this + * will return only the RTP file descriptor, not the RTCP file descriptor. + * To get both, use rtp_get_file_handles(). + * + * @return the file descriptor associated with this URL, or <0 on error. + */ +int url_get_file_handle(URLContext *h); /** * Return the maximum packet size associated to packetized file - * handle. If the file is not packetized (stream like http or file on + * handle. If the file is not packetized (stream like HTTP or file on * disk), then 0 is returned. * * @param h file handle @@ -76,31 +97,32 @@ int url_get_max_packet_size(URLContext *h); void url_get_filename(URLContext *h, char *buf, int buf_size); /** - * the callback is called in blocking functions to test regulary if + * The callback is called in blocking functions to test regulary if * asynchronous interruption is needed. AVERROR(EINTR) is returned * in this case by the interrupted function. 'NULL' means no interrupt - * callback is given. i + * callback is given. */ void url_set_interrupt_cb(URLInterruptCB *interrupt_cb); /* not implemented */ int url_poll(URLPollEntry *poll_table, int n, int timeout); -/** Start playing or resume paused playout. Only meaningful if using a network - * streaming protocol (e.g. MMS). */ -int av_url_read_play(URLContext *h); -/** Pause playing - only meaningful if using a network streaming protocol - * (e.g. MMS). */ -int av_url_read_pause(URLContext *h); +/** + * Pause and resume playing - only meaningful if using a network streaming + * protocol (e.g. MMS). + * @param pause 1 for pause, 0 for resume + */ +int av_url_read_pause(URLContext *h, int pause); + /** * Seek to a given timestamp relative to some component stream. - * Only meaningful if using a network streaming protocol (e.g. MMS.) + * 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 time_stamp timestamp timestamp in AVStream.time_base units + * @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 @@ -109,8 +131,8 @@ int av_url_read_pause(URLContext *h); * @return >= 0 on success * @see AVInputFormat::read_seek */ -int av_url_read_seek(URLContext *h, - int stream_index, int64_t timestamp, int flags); +int64_t av_url_read_seek(URLContext *h, int stream_index, + int64_t timestamp, int flags); /** * Passing this as the "whence" parameter to a seek function causes it to @@ -124,20 +146,44 @@ typedef struct URLProtocol { int (*url_open)(URLContext *h, const char *filename, int flags); int (*url_read)(URLContext *h, unsigned char *buf, int size); int (*url_write)(URLContext *h, unsigned char *buf, int size); - offset_t (*url_seek)(URLContext *h, offset_t pos, int whence); + int64_t (*url_seek)(URLContext *h, int64_t pos, int whence); int (*url_close)(URLContext *h); struct URLProtocol *next; - int (*url_read_play)(URLContext *h); - int (*url_read_pause)(URLContext *h); - int (*url_read_seek)(URLContext *h, - int stream_index, int64_t timestamp, int flags); + 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); } URLProtocol; +#if LIBAVFORMAT_VERSION_MAJOR < 53 extern URLProtocol *first_protocol; +#endif + extern URLInterruptCB *url_interrupt_cb; -int register_protocol(URLProtocol *protocol); +/** + * If protocol is NULL, returns the first registered protocol, + * if protocol is non-NULL, returns the next registered protocol after protocol, + * or NULL if protocol is the last one. + */ +URLProtocol *av_protocol_next(URLProtocol *p); +#if LIBAVFORMAT_VERSION_MAJOR < 53 +/** + * @deprecated Use av_register_protocol() instead. + */ +attribute_deprecated int register_protocol(URLProtocol *protocol); +#endif + +int av_register_protocol(URLProtocol *protocol); + +/** + * 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(ByteIOContext) must not be used outside libav*. + */ typedef struct { unsigned char *buffer; int buffer_size; @@ -145,8 +191,8 @@ typedef struct { void *opaque; int (*read_packet)(void *opaque, uint8_t *buf, int buf_size); int (*write_packet)(void *opaque, uint8_t *buf, int buf_size); - offset_t (*seek)(void *opaque, offset_t offset, int whence); - offset_t pos; /**< position in the file of the current buffer */ + int64_t (*seek)(void *opaque, int64_t offset, int whence); + 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 */ @@ -156,10 +202,9 @@ typedef struct { unsigned char *checksum_ptr; unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size); int error; ///< contains the error code or 0 if no error happened - int (*read_play)(void *opaque); - int (*read_pause)(void *opaque); - int (*read_seek)(void *opaque, - int stream_index, int64_t timestamp, int flags); + int (*read_pause)(void *opaque, int pause); + int64_t (*read_seek)(void *opaque, int stream_index, + int64_t timestamp, int flags); } ByteIOContext; int init_put_byte(ByteIOContext *s, @@ -169,7 +214,15 @@ int init_put_byte(ByteIOContext *s, void *opaque, int (*read_packet)(void *opaque, uint8_t *buf, int buf_size), int (*write_packet)(void *opaque, uint8_t *buf, int buf_size), - offset_t (*seek)(void *opaque, offset_t offset, int whence)); + int64_t (*seek)(void *opaque, int64_t offset, int whence)); +ByteIOContext *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)); void put_byte(ByteIOContext *s, int b); void put_buffer(ByteIOContext *s, const unsigned char *buf, int size); @@ -185,17 +238,41 @@ void put_tag(ByteIOContext *s, const char *tag); void put_strz(ByteIOContext *s, const char *buf); -offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence); -void url_fskip(ByteIOContext *s, offset_t offset); -offset_t url_ftell(ByteIOContext *s); -offset_t url_fsize(ByteIOContext *s); +/** + * fseek() equivalent for ByteIOContext. + * @return new position or AVERROR. + */ +int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence); + +/** + * Skip given number of bytes forward. + * @param offset number of bytes + */ +void url_fskip(ByteIOContext *s, int64_t offset); + +/** + * ftell() equivalent for ByteIOContext. + * @return position or AVERROR. + */ +int64_t url_ftell(ByteIOContext *s); + +/** + * Gets the filesize. + * @return filesize or AVERROR + */ +int64_t url_fsize(ByteIOContext *s); + +/** + * feof() equivalent for ByteIOContext. + * @return non zero if and only if end of file + */ int url_feof(ByteIOContext *s); + int url_ferror(ByteIOContext *s); -int av_url_read_fplay(ByteIOContext *h); -int av_url_read_fpause(ByteIOContext *h); -int av_url_read_fseek(ByteIOContext *h, - int stream_index, int64_t timestamp, int flags); +int av_url_read_fpause(ByteIOContext *h, int pause); +int64_t av_url_read_fseek(ByteIOContext *h, int stream_index, + int64_t timestamp, int flags); #define URL_EOF (-1) /** @note return URL_EOF (-1) if EOF */ @@ -209,16 +286,28 @@ int url_fprintf(ByteIOContext *s, const char *fmt, ...); #endif /** @note unlike fgets, the EOL character is not returned and a whole - line is parsed. return NULL if first char read was EOF */ + line is parsed. return NULL if first char read was EOF */ char *url_fgets(ByteIOContext *s, char *buf, int buf_size); void put_flush_packet(ByteIOContext *s); + +/** + * Reads size bytes from ByteIOContext into buf. + * @returns number of bytes read or AVERROR + */ int get_buffer(ByteIOContext *s, unsigned char *buf, int size); + +/** + * Reads size bytes from ByteIOContext into buf. + * This reads at most 1 packet. If that is not enough fewer bytes will be + * returned. + * @returns number of bytes read or AVERROR + */ int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size); /** @note return 0 if EOF, so you cannot use it if EOF handling is - necessary */ + necessary */ int get_byte(ByteIOContext *s); unsigned int get_le24(ByteIOContext *s); unsigned int get_le32(ByteIOContext *s); @@ -239,19 +328,21 @@ static inline int url_is_streamed(ByteIOContext *s) } /** @note when opened as read/write, the buffers are only used for - writing */ + writing */ int url_fdopen(ByteIOContext **s, URLContext *h); /** @warning must be called before any I/O */ int url_setbufsize(ByteIOContext *s, int buf_size); +#if LIBAVFORMAT_VERSION_MAJOR < 53 /** Reset the buffer for reading or writing. * @note Will drop any data currently in the buffer without transmitting it. * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY * to set up the buffer for writing. */ int url_resetbuf(ByteIOContext *s, int flags); +#endif /** @note when opened as read/write, the buffers are only used for - writing */ + writing */ int url_fopen(ByteIOContext **s, const char *filename, int flags); int url_fclose(ByteIOContext *s); URLContext *url_fileno(ByteIOContext *s); @@ -299,13 +390,18 @@ int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size); */ int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer); -unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, unsigned int len); +unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, + unsigned int len); unsigned long get_checksum(ByteIOContext *s); -void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum); +void init_checksum(ByteIOContext *s, + unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), + unsigned long checksum); /* udp.c */ int udp_set_remote_url(URLContext *h, const char *uri); int udp_get_local_port(URLContext *h); +#if (LIBAVFORMAT_VERSION_MAJOR <= 52) int udp_get_file_handle(URLContext *h); +#endif -#endif /* FFMPEG_AVIO_H */ +#endif /* AVFORMAT_AVIO_H */