]> git.sesse.net Git - ffmpeg/blobdiff - libavformat/avio.h
rename idroq.c to idroqdec.c
[ffmpeg] / libavformat / avio.h
index f41f6fac4109c26efd11ab25a712da7b4166797c..a33a7d98a826d4da425fade896ea27f44c4a4f70 100644 (file)
@@ -31,6 +31,7 @@
 #include <stdint.h>
 
 #include "libavutil/common.h"
+#include "libavutil/log.h"
 
 /* unbuffered I/O */
 
@@ -42,7 +43,7 @@
  * sizeof(URLContext) must not be used outside libav*.
  */
 typedef struct URLContext {
-#if LIBAVFORMAT_VERSION_MAJOR >= 53
+#if FF_API_URL_CLASS
     const AVClass *av_class; ///< information for av_log(). Set by url_open().
 #endif
     struct URLProtocol *prot;
@@ -67,8 +68,8 @@ typedef struct URLPollEntry {
 typedef int URLInterruptCB(void);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it using the URLProtocol up.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, and open it using the URLProtocol up.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -81,8 +82,8 @@ int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                        const char *url, int flags);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, but doesn't initiate the connection yet.
+ * Create a URLContext for accessing to the resource indicated by
+ * url, but do not initiate the connection yet.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -99,8 +100,8 @@ int url_alloc(URLContext **h, const char *url, int flags);
 int url_connect(URLContext *h);
 
 /**
- * Creates an URLContext for accessing to the resource indicated by
- * url, and opens it.
+ * Create an URLContext for accessing to the resource indicated by
+ * url, and open it.
  *
  * @param puc pointer to the location where, in case of success, the
  * function puts the pointer to the created URLContext
@@ -112,7 +113,7 @@ int url_connect(URLContext *h);
 int url_open(URLContext **h, const char *url, int flags);
 
 /**
- * Reads up to size bytes from the resource accessed by h, and stores
+ * Read up to size bytes from the resource accessed by h, and store
  * the read bytes in buf.
  *
  * @return The number of bytes actually read, or a negative value
@@ -134,7 +135,7 @@ int url_read_complete(URLContext *h, unsigned char *buf, int size);
 int url_write(URLContext *h, const unsigned char *buf, int size);
 
 /**
- * Changes the position that will be used by the next read/write
+ * Change the position that will be used by the next read/write
  * operation on the resource accessed by h.
  *
  * @param pos specifies the new position to set
@@ -150,7 +151,7 @@ int url_write(URLContext *h, const unsigned char *buf, int size);
 int64_t url_seek(URLContext *h, int64_t pos, int whence);
 
 /**
- * Closes the resource accessed by the URLContext h, and frees the
+ * Close the resource accessed by the URLContext h, and free the
  * memory used by it.
  *
  * @return a negative value if an error condition occurred, 0
@@ -159,7 +160,7 @@ int64_t url_seek(URLContext *h, int64_t pos, int whence);
 int url_close(URLContext *h);
 
 /**
- * Returns a non-zero value if the resource indicated by url
+ * Return a non-zero value if the resource indicated by url
  * exists, 0 otherwise.
  */
 int url_exist(const char *url);
@@ -255,7 +256,7 @@ typedef struct URLProtocol {
     const AVClass *priv_data_class;
 } URLProtocol;
 
-#if LIBAVFORMAT_VERSION_MAJOR < 53
+#if FF_API_REGISTER_PROTOCOL
 extern URLProtocol *first_protocol;
 #endif
 
@@ -268,7 +269,7 @@ extern URLInterruptCB *url_interrupt_cb;
  */
 URLProtocol *av_protocol_next(URLProtocol *p);
 
-#if LIBAVFORMAT_VERSION_MAJOR < 53
+#if FF_API_REGISTER_PROTOCOL
 /**
  * @deprecated Use av_register_protocol() instead.
  */
@@ -281,7 +282,7 @@ attribute_deprecated int av_register_protocol(URLProtocol *protocol);
 #endif
 
 /**
- * Registers the URLProtocol protocol.
+ * Register the URLProtocol protocol.
  *
  * @param size the size of the URLProtocol struct referenced
  */
@@ -357,8 +358,9 @@ int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
 /**
  * Skip given number of bytes forward.
  * @param offset number of bytes
+ * @return 0 on success, <0 on error
  */
-void url_fskip(ByteIOContext *s, int64_t offset);
+int url_fskip(ByteIOContext *s, int64_t offset);
 
 /**
  * ftell() equivalent for ByteIOContext.
@@ -367,7 +369,7 @@ void url_fskip(ByteIOContext *s, int64_t offset);
 int64_t url_ftell(ByteIOContext *s);
 
 /**
- * Gets the filesize.
+ * Get the filesize.
  * @return filesize or AVERROR
  */
 int64_t url_fsize(ByteIOContext *s);
@@ -403,13 +405,13 @@ void put_flush_packet(ByteIOContext *s);
 
 
 /**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
  * @return number of bytes read or AVERROR
  */
 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
 
 /**
- * Reads size bytes from ByteIOContext into buf.
+ * Read size bytes from ByteIOContext into buf.
  * This reads at most 1 packet. If that is not enough fewer bytes will be
  * returned.
  * @return number of bytes read or AVERROR
@@ -438,7 +440,7 @@ static inline int url_is_streamed(ByteIOContext *s)
 }
 
 /**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
  * resource referenced by the URLContext h.
  * @note When the URLContext h has been opened in read+write mode, the
  * ByteIOContext can be used only for writing.
@@ -452,7 +454,7 @@ 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
+#if FF_API_URL_RESETBUF
 /** 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
@@ -461,7 +463,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
 #endif
 
 /**
- * Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
+ * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
  * Used after probing to avoid seeking.
  * Joins buf and s->buffer, taking any overlap into consideration.
  * @note s->buffer must overlap with buf or they can't be joined and the function fails
@@ -476,7 +478,7 @@ int url_resetbuf(ByteIOContext *s, int flags);
 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
 
 /**
- * Creates and initializes a ByteIOContext for accessing the
+ * Create and initialize a ByteIOContext for accessing the
  * resource indicated by url.
  * @note When the resource indicated by url has been opened in
  * read+write mode, the ByteIOContext can be used only for writing.
@@ -529,7 +531,10 @@ int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
 
 /**
  * Return the written size and a pointer to the buffer. The buffer
- *  must be freed with av_free().
+ * must be freed with av_free(). If the buffer is opened with
+ * url_open_dyn_buf, then padding of FF_INPUT_BUFFER_PADDING_SIZE is
+ * added; if opened with url_open_dyn_packet_buf, no padding is added.
+ *
  * @param s IO context
  * @param pbuffer pointer to a byte buffer
  * @return the length of the byte buffer