X-Git-Url: https://rtime.felk.cvut.cz/gitweb/frescor/ffmpeg.git/blobdiff_plain/f12c8656f5c3dab0f719e8eae3897408e60eac4d..3789d48fc4ed515fd4fc879b9cdb2c6ffcc46cad:/libavformat/avio.h diff --git a/libavformat/avio.h b/libavformat/avio.h index e8a8bc606..b8b35afe8 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,14 +17,20 @@ * 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 */ @@ -59,16 +64,28 @@ typedef struct URLPollEntry { #define URL_RDONLY 0 #define URL_WRONLY 1 #define URL_RDWR 2 +#define URL_DIRECT 4 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_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 @@ -116,8 +133,8 @@ int av_url_read_pause(URLContext *h, int pause); * @return >= 0 on success * @see AVInputFormat::read_seek */ -offset_t 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 @@ -131,20 +148,36 @@ 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_pause)(URLContext *h, int pause); - offset_t (*url_read_seek)(URLContext *h, - int stream_index, int64_t timestamp, int flags); + 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; +/** + * 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); -int register_protocol(URLProtocol *protocol); +#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. @@ -160,11 +193,12 @@ 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 */ + int o_direct_flag; /**< true if the underlaying file is open with O_DIRECT */ int is_streamed; int max_packet_size; unsigned long checksum; @@ -172,8 +206,8 @@ typedef struct { 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_pause)(void *opaque, int pause); - offset_t (*read_seek)(void *opaque, - int stream_index, int64_t timestamp, int flags); + int64_t (*read_seek)(void *opaque, int stream_index, + int64_t timestamp, int flags); } ByteIOContext; int init_put_byte(ByteIOContext *s, @@ -183,7 +217,7 @@ 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, @@ -191,7 +225,7 @@ ByteIOContext *av_alloc_put_byte( 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)); void put_byte(ByteIOContext *s, int b); void put_buffer(ByteIOContext *s, const unsigned char *buf, int size); @@ -207,16 +241,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_fpause(ByteIOContext *h, int pause); -offset_t av_url_read_fseek(ByteIOContext *h, - int stream_index, int64_t timestamp, int flags); +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 */ @@ -230,16 +289,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); @@ -260,7 +331,7 @@ 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 */ @@ -272,7 +343,7 @@ int url_setbufsize(ByteIOContext *s, int buf_size); int url_resetbuf(ByteIOContext *s, int flags); /** @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); @@ -320,13 +391,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 */