matroskadec: don't warn about unknown spherical medata when none is present
[ffmpeg.git] / libavformat / url.h
1 /*
2  * This file is part of Libav.
3  *
4  * Libav is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * Libav is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with Libav; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /**
20  * @file
21  * unbuffered private I/O API
22  */
23
24 #ifndef AVFORMAT_URL_H
25 #define AVFORMAT_URL_H
26
27 #include "avio.h"
28 #include "libavformat/version.h"
29
30 #include "libavutil/dict.h"
31 #include "libavutil/log.h"
32
33 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
34 #define URL_PROTOCOL_FLAG_NETWORK       2 /*< The protocol uses network */
35
36 extern const AVClass ffurl_context_class;
37
38 typedef struct URLContext {
39     const AVClass *av_class;    /**< information for av_log(). Set by url_open(). */
40     const struct URLProtocol *prot;
41     /**
42      * A NULL-terminated list of protocols usable by the child contexts.
43      */
44     const struct URLProtocol **protocols;
45     void *priv_data;
46     char *filename;             /**< specified URL */
47     int flags;
48     int max_packet_size;        /**< if non zero, the stream is packetized with this max packet size */
49     int is_streamed;            /**< true if streamed (no seek possible), default = false */
50     int is_connected;
51     AVIOInterruptCB interrupt_callback;
52     int64_t rw_timeout;         /**< maximum time to wait for (network) read/write operation completion, in microseconds */
53 } URLContext;
54
55 typedef struct URLProtocol {
56     const char *name;
57     int     (*url_open)( URLContext *h, const char *url, int flags);
58     /**
59      * This callback is to be used by protocols which open further nested
60      * protocols. options are then to be passed to ffurl_open()/ffurl_connect()
61      * for those nested protocols.
62      */
63     int     (*url_open2)(URLContext *h, const char *url, int flags, AVDictionary **options);
64
65     /**
66      * Read data from the protocol.
67      * If data is immediately available (even less than size), EOF is
68      * reached or an error occurs (including EINTR), return immediately.
69      * Otherwise:
70      * In non-blocking mode, return AVERROR(EAGAIN) immediately.
71      * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
72      * and return AVERROR(EAGAIN) on timeout.
73      * Checking interrupt_callback, looping on EINTR and EAGAIN and until
74      * enough data has been read is left to the calling function; see
75      * retry_transfer_wrapper in avio.c.
76      */
77     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
78     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
79     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
80     int     (*url_close)(URLContext *h);
81     int (*url_read_pause)(URLContext *h, int pause);
82     int64_t (*url_read_seek)(URLContext *h, int stream_index,
83                              int64_t timestamp, int flags);
84     int (*url_get_file_handle)(URLContext *h);
85     int (*url_get_multi_file_handle)(URLContext *h, int **handles,
86                                      int *numhandles);
87     int (*url_shutdown)(URLContext *h, int flags);
88     int priv_data_size;
89     const AVClass *priv_data_class;
90     int flags;
91     int (*url_check)(URLContext *h, int mask);
92 } URLProtocol;
93
94 /**
95  * Create a URLContext for accessing to the resource indicated by
96  * url, but do not initiate the connection yet.
97  *
98  * @param puc pointer to the location where, in case of success, the
99  * function puts the pointer to the created URLContext
100  * @param flags flags which control how the resource indicated by url
101  * is to be opened
102  * @param int_cb interrupt callback to use for the URLContext, may be
103  * NULL
104  * @param protocols a NULL-terminate list of protocols available for use by
105  *                  this context and its children. The caller must ensure this
106  *                  list remains valid until the context is closed.
107  * @return 0 in case of success, a negative value corresponding to an
108  * AVERROR code in case of failure
109  */
110 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
111                 const AVIOInterruptCB *int_cb,
112                 const URLProtocol **protocols);
113
114 /**
115  * Connect an URLContext that has been allocated by ffurl_alloc
116  *
117  * @param options  A dictionary filled with options for nested protocols,
118  * i.e. it will be passed to url_open2() for protocols implementing it.
119  * This parameter will be destroyed and replaced with a dict containing options
120  * that were not found. May be NULL.
121  */
122 int ffurl_connect(URLContext *uc, AVDictionary **options);
123
124 /**
125  * Create an URLContext for accessing to the resource indicated by
126  * url, and open it.
127  *
128  * @param puc pointer to the location where, in case of success, the
129  * function puts the pointer to the created URLContext
130  * @param flags flags which control how the resource indicated by url
131  * is to be opened
132  * @param int_cb interrupt callback to use for the URLContext, may be
133  * NULL
134  * @param options  A dictionary filled with protocol-private options. On return
135  * this parameter will be destroyed and replaced with a dict containing options
136  * that were not found. May be NULL.
137  * @param protocols a NULL-terminate list of protocols available for use by
138  *                  this context and its children. The caller must ensure this
139  *                  list remains valid until the context is closed.
140  * @param parent An enclosing URLContext, whose generic options should
141  *               be applied to this URLContext as well.
142  * @return 0 in case of success, a negative value corresponding to an
143  * AVERROR code in case of failure
144  */
145 int ffurl_open(URLContext **puc, const char *filename, int flags,
146                const AVIOInterruptCB *int_cb, AVDictionary **options,
147                const URLProtocol **protocols, URLContext *parent);
148
149 /**
150  * Read up to size bytes from the resource accessed by h, and store
151  * the read bytes in buf.
152  *
153  * @return The number of bytes actually read, or a negative value
154  * corresponding to an AVERROR code in case of error. A value of zero
155  * indicates that it is not possible to read more from the accessed
156  * resource (except if the value of the size argument is also zero).
157  */
158 int ffurl_read(URLContext *h, unsigned char *buf, int size);
159
160 /**
161  * Read as many bytes as possible (up to size), calling the
162  * read function multiple times if necessary.
163  * This makes special short-read handling in applications
164  * unnecessary, if the return value is < size then it is
165  * certain there was either an error or the end of file was reached.
166  */
167 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
168
169 /**
170  * Write size bytes from buf to the resource accessed by h.
171  *
172  * @return the number of bytes actually written, or a negative value
173  * corresponding to an AVERROR code in case of failure
174  */
175 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
176
177 /**
178  * Change the position that will be used by the next read/write
179  * operation on the resource accessed by h.
180  *
181  * @param pos specifies the new position to set
182  * @param whence specifies how pos should be interpreted, it must be
183  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
184  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
185  * (return the filesize of the requested resource, pos is ignored).
186  * @return a negative value corresponding to an AVERROR code in case
187  * of failure, or the resulting file position, measured in bytes from
188  * the beginning of the file. You can use this feature together with
189  * SEEK_CUR to read the current file position.
190  */
191 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
192
193 /**
194  * Close the resource accessed by the URLContext h, and free the
195  * memory used by it.
196  *
197  * @return a negative value if an error condition occurred, 0
198  * otherwise
199  */
200 int ffurl_close(URLContext *h);
201
202 /**
203  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
204  * if the operation is not supported by h, or another negative value
205  * corresponding to an AVERROR error code in case of failure.
206  */
207 int64_t ffurl_size(URLContext *h);
208
209 /**
210  * Return the file descriptor associated with this URL. For RTP, this
211  * will return only the RTP file descriptor, not the RTCP file descriptor.
212  *
213  * @return the file descriptor associated with this URL, or <0 on error.
214  */
215 int ffurl_get_file_handle(URLContext *h);
216
217 /**
218  * Return the file descriptors associated with this URL.
219  *
220  * @return 0 on success or <0 on error.
221  */
222 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles);
223
224 /**
225  * Signal the URLContext that we are done reading or writing the stream.
226  *
227  * @param h pointer to the resource
228  * @param flags flags which control how the resource indicated by url
229  * is to be shutdown
230  *
231  * @return a negative value if an error condition occurred, 0
232  * otherwise
233  */
234 int ffurl_shutdown(URLContext *h, int flags);
235
236 /**
237  * Check if the user has requested to interrupt a blocking function
238  * associated with cb.
239  */
240 int ff_check_interrupt(AVIOInterruptCB *cb);
241
242 /* udp.c */
243 int ff_udp_set_remote_url(URLContext *h, const char *uri);
244 int ff_udp_get_local_port(URLContext *h);
245
246 /**
247  * Assemble a URL string from components. This is the reverse operation
248  * of av_url_split.
249  *
250  * Note, this requires networking to be initialized, so the caller must
251  * ensure ff_network_init has been called.
252  *
253  * @see av_url_split
254  *
255  * @param str the buffer to fill with the url
256  * @param size the size of the str buffer
257  * @param proto the protocol identifier, if null, the separator
258  *              after the identifier is left out, too
259  * @param authorization an optional authorization string, may be null.
260  *                      An empty string is treated the same as a null string.
261  * @param hostname the host name string
262  * @param port the port number, left out from the string if negative
263  * @param fmt a generic format string for everything to add after the
264  *            host/port, may be null
265  * @return the number of characters written to the destination buffer
266  */
267 int ff_url_join(char *str, int size, const char *proto,
268                 const char *authorization, const char *hostname,
269                 int port, const char *fmt, ...) av_printf_format(7, 8);
270
271 /*
272  * Convert a relative url into an absolute url, given a base url.
273  *
274  * @param buf the buffer where output absolute url is written
275  * @param size the size of buf
276  * @param base the base url, may be equal to buf.
277  * @param rel the new url, which is interpreted relative to base
278  */
279 void ff_make_absolute_url(char *buf, int size, const char *base,
280                           const char *rel);
281
282 const AVClass *ff_urlcontext_child_class_next(const AVClass *prev);
283
284 /**
285  * Construct a list of protocols matching a given whitelist and/or blacklist.
286  *
287  * @param whitelist a comma-separated list of allowed protocol names or NULL. If
288  *                  this is a non-empty string, only protocols in this list will
289  *                  be included.
290  * @param blacklist a comma-separated list of forbidden protocol names or NULL.
291  *                  If this is a non-empty string, all protocols in this list
292  *                  will be excluded.
293  *
294  * @return a NULL-terminated array of matching protocols. The array must be
295  * freed by the caller.
296  */
297 const URLProtocol **ffurl_get_protocols(const char *whitelist,
298                                         const char *blacklist);
299
300 #endif /* AVFORMAT_URL_H */