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 {
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
+ * the read bytes in buf.
+ *
+ * @return The number of bytes actually read, or a negative value
+ * corresponding to an AVERROR code in case of error. A value of zero
+ * indicates that it is not possible to read more from the accessed
+ * resource (except if the value of the size argument is also zero).
+ */
int url_read(URLContext *h, unsigned char *buf, int size);
+
/**
* Read as many bytes as possible (up to size), calling the
* read function multiple times if necessary.
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);
/**
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);
attribute_deprecated int register_protocol(URLProtocol *protocol);
#endif
+/**
+ * Registers the URLProtocol protocol.
+ */
int av_register_protocol(URLProtocol *protocol);
/**
/** @note when opened as read/write, the buffers are only used for
writing */
-int url_fopen(ByteIOContext **s, const char *filename, int flags);
+int url_fopen(ByteIOContext **s, const char *url, int flags);
int url_fclose(ByteIOContext *s);
URLContext *url_fileno(ByteIOContext *s);