Include msrledec.h: It contains the prototype for ff_msrle_decode().

[ffmpeg] / libavformat / avio.h

diff --git a/libavformat/avio.h b/libavformat/avio.h
index 0ab351310e877e095d09f719bd73d212fa487656..80ec48f7256eeb385020ff9c435018dc0c481008 100644 (file)
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -50,7 +50,7 @@ typedef struct URLContext {
     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;
-    char *filename; /**< specified filename */
+    char *filename; /**< specified URL */
 } URLContext;
 
 typedef struct URLPollEntry {
@@ -65,9 +65,32 @@ 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.
+ *
+ * @param puc pointer to the location where, in case of success, the
+ * function puts the pointer to the created URLContext
+ * @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
+ */
 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
-                       const char *filename, int flags);
-int url_open(URLContext **h, const char *filename, int flags);
+                       const char *url, int flags);
+
+/**
+ * Creates an URLContext for accessing to the resource indicated by
+ * url, and opens it.
+ *
+ * @param puc pointer to the location where, in case of success, the
+ * function puts the pointer to the created URLContext
+ * @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
+ */
+int url_open(URLContext **h, const char *url, int flags);
 
 /**
  * Reads up to size bytes from the resource accessed by h, and stores
@@ -91,8 +114,17 @@ 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);
 int64_t url_seek(URLContext *h, int64_t pos, int whence);
+
+/**
+ * Closes the resource accessed by the URLContext h, and frees the
+ * memory used by it.
+ *
+ * @return a negative value if an error condition occurred, 0
+ * otherwise
+ */
 int url_close(URLContext *h);
-int url_exist(const char *filename);
+
+int url_exist(const char *url);
 int64_t url_filesize(URLContext *h);
 
 /**
@@ -162,7 +194,7 @@ int64_t av_url_read_seek(URLContext *h, int stream_index,
 
 typedef struct URLProtocol {
     const char *name;
-    int (*url_open)(URLContext *h, const char *filename, int flags);
+    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, unsigned char *buf, int size);
     int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
@@ -194,6 +226,9 @@ URLProtocol *av_protocol_next(URLProtocol *p);
 attribute_deprecated int register_protocol(URLProtocol *protocol);
 #endif
 
+/**
+ * Registers the URLProtocol protocol.
+ */
 int av_register_protocol(URLProtocol *protocol);
 
 /**
@@ -346,8 +381,17 @@ static inline int url_is_streamed(ByteIOContext *s)
     return s->is_streamed;
 }
 
-/** @note when opened as read/write, the buffers are only used for
-    writing */
+/**
+ * Creates and initializes 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.
+ *
+ * @param s Used to return the pointer to the created ByteIOContext.
+ * In case of failure the pointed to value is set to NULL.
+ * @return 0 in case of success, a negative value corresponding to an
+ * AVERROR code in case of failure
+ */
 int url_fdopen(ByteIOContext **s, URLContext *h);
 
 /** @warning must be called before any I/O */
@@ -360,9 +404,21 @@ int url_setbufsize(ByteIOContext *s, int buf_size);
 int url_resetbuf(ByteIOContext *s, int flags);
 #endif
 
-/** @note when opened as read/write, the buffers are only used for
-    writing */
-int url_fopen(ByteIOContext **s, const char *filename, int flags);
+/**
+ * Creates and initializes 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.
+ *
+ * @param s Used to return the pointer to the created ByteIOContext.
+ * 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
+ */
+int url_fopen(ByteIOContext **s, const char *url, int flags);
+
 int url_fclose(ByteIOContext *s);
 URLContext *url_fileno(ByteIOContext *s);