cosmetics: Drop empty comment lines
[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     struct URLProtocol *prot;
41     void *priv_data;
42     char *filename;             /**< specified URL */
43     int flags;
44     int max_packet_size;        /**< if non zero, the stream is packetized with this max packet size */
45     int is_streamed;            /**< true if streamed (no seek possible), default = false */
46     int is_connected;
47     AVIOInterruptCB interrupt_callback;
48 } URLContext;
49
50 typedef struct URLProtocol {
51     const char *name;
52     int     (*url_open)( URLContext *h, const char *url, int flags);
53     /**
54      * This callback is to be used by protocols which open further nested
55      * protocols. options are then to be passed to ffurl_open()/ffurl_connect()
56      * for those nested protocols.
57      */
58     int     (*url_open2)(URLContext *h, const char *url, int flags, AVDictionary **options);
59
60     /**
61      * Read data from the protocol.
62      * If data is immediately available (even less than size), EOF is
63      * reached or an error occurs (including EINTR), return immediately.
64      * Otherwise:
65      * In non-blocking mode, return AVERROR(EAGAIN) immediately.
66      * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
67      * and return AVERROR(EAGAIN) on timeout.
68      * Checking interrupt_callback, looping on EINTR and EAGAIN and until
69      * enough data has been read is left to the calling function; see
70      * retry_transfer_wrapper in avio.c.
71      */
72     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
73     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
74     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
75     int     (*url_close)(URLContext *h);
76     struct URLProtocol *next;
77     int (*url_read_pause)(URLContext *h, int pause);
78     int64_t (*url_read_seek)(URLContext *h, int stream_index,
79                              int64_t timestamp, int flags);
80     int (*url_get_file_handle)(URLContext *h);
81     int (*url_get_multi_file_handle)(URLContext *h, int **handles,
82                                      int *numhandles);
83     int (*url_shutdown)(URLContext *h, int flags);
84     int priv_data_size;
85     const AVClass *priv_data_class;
86     int flags;
87     int (*url_check)(URLContext *h, int mask);
88 } URLProtocol;
89
90 /**
91  * Create a URLContext for accessing to the resource indicated by
92  * url, but do not initiate the connection yet.
93  *
94  * @param puc pointer to the location where, in case of success, the
95  * function puts the pointer to the created URLContext
96  * @param flags flags which control how the resource indicated by url
97  * is to be opened
98  * @param int_cb interrupt callback to use for the URLContext, may be
99  * NULL
100  * @return 0 in case of success, a negative value corresponding to an
101  * AVERROR code in case of failure
102  */
103 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
104                 const AVIOInterruptCB *int_cb);
105
106 /**
107  * Connect an URLContext that has been allocated by ffurl_alloc
108  *
109  * @param options  A dictionary filled with options for nested protocols,
110  * i.e. it will be passed to url_open2() for protocols implementing it.
111  * This parameter will be destroyed and replaced with a dict containing options
112  * that were not found. May be NULL.
113  */
114 int ffurl_connect(URLContext *uc, AVDictionary **options);
115
116 /**
117  * Create an URLContext for accessing to the resource indicated by
118  * url, and open it.
119  *
120  * @param puc pointer to the location where, in case of success, the
121  * function puts the pointer to the created URLContext
122  * @param flags flags which control how the resource indicated by url
123  * is to be opened
124  * @param int_cb interrupt callback to use for the URLContext, may be
125  * NULL
126  * @param options  A dictionary filled with protocol-private options. On return
127  * this parameter will be destroyed and replaced with a dict containing options
128  * that were not found. May be NULL.
129  * @return 0 in case of success, a negative value corresponding to an
130  * AVERROR code in case of failure
131  */
132 int ffurl_open(URLContext **puc, const char *filename, int flags,
133                const AVIOInterruptCB *int_cb, AVDictionary **options);
134
135 /**
136  * Read up to size bytes from the resource accessed by h, and store
137  * the read bytes in buf.
138  *
139  * @return The number of bytes actually read, or a negative value
140  * corresponding to an AVERROR code in case of error. A value of zero
141  * indicates that it is not possible to read more from the accessed
142  * resource (except if the value of the size argument is also zero).
143  */
144 int ffurl_read(URLContext *h, unsigned char *buf, int size);
145
146 /**
147  * Read as many bytes as possible (up to size), calling the
148  * read function multiple times if necessary.
149  * This makes special short-read handling in applications
150  * unnecessary, if the return value is < size then it is
151  * certain there was either an error or the end of file was reached.
152  */
153 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
154
155 /**
156  * Write size bytes from buf to the resource accessed by h.
157  *
158  * @return the number of bytes actually written, or a negative value
159  * corresponding to an AVERROR code in case of failure
160  */
161 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
162
163 /**
164  * Change the position that will be used by the next read/write
165  * operation on the resource accessed by h.
166  *
167  * @param pos specifies the new position to set
168  * @param whence specifies how pos should be interpreted, it must be
169  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
170  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
171  * (return the filesize of the requested resource, pos is ignored).
172  * @return a negative value corresponding to an AVERROR code in case
173  * of failure, or the resulting file position, measured in bytes from
174  * the beginning of the file. You can use this feature together with
175  * SEEK_CUR to read the current file position.
176  */
177 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
178
179 /**
180  * Close the resource accessed by the URLContext h, and free the
181  * memory used by it.
182  *
183  * @return a negative value if an error condition occurred, 0
184  * otherwise
185  */
186 int ffurl_close(URLContext *h);
187
188 /**
189  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
190  * if the operation is not supported by h, or another negative value
191  * corresponding to an AVERROR error code in case of failure.
192  */
193 int64_t ffurl_size(URLContext *h);
194
195 /**
196  * Return the file descriptor associated with this URL. For RTP, this
197  * will return only the RTP file descriptor, not the RTCP file descriptor.
198  *
199  * @return the file descriptor associated with this URL, or <0 on error.
200  */
201 int ffurl_get_file_handle(URLContext *h);
202
203 /**
204  * Return the file descriptors associated with this URL.
205  *
206  * @return 0 on success or <0 on error.
207  */
208 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles);
209
210 /**
211  * Signal the URLContext that we are done reading or writing the stream.
212  *
213  * @param h pointer to the resource
214  * @param flags flags which control how the resource indicated by url
215  * is to be shutdown
216  *
217  * @return a negative value if an error condition occurred, 0
218  * otherwise
219  */
220 int ffurl_shutdown(URLContext *h, int flags);
221
222 /**
223  * Register the URLProtocol protocol.
224  */
225 int ffurl_register_protocol(URLProtocol *protocol);
226
227 /**
228  * Check if the user has requested to interrup a blocking function
229  * associated with cb.
230  */
231 int ff_check_interrupt(AVIOInterruptCB *cb);
232
233 /**
234  * Iterate over all available protocols.
235  *
236  * @param prev result of the previous call to this functions or NULL.
237  */
238 URLProtocol *ffurl_protocol_next(const URLProtocol *prev);
239
240 /* udp.c */
241 int ff_udp_set_remote_url(URLContext *h, const char *uri);
242 int ff_udp_get_local_port(URLContext *h);
243
244 /**
245  * Assemble a URL string from components. This is the reverse operation
246  * of av_url_split.
247  *
248  * Note, this requires networking to be initialized, so the caller must
249  * ensure ff_network_init has been called.
250  *
251  * @see av_url_split
252  *
253  * @param str the buffer to fill with the url
254  * @param size the size of the str buffer
255  * @param proto the protocol identifier, if null, the separator
256  *              after the identifier is left out, too
257  * @param authorization an optional authorization string, may be null.
258  *                      An empty string is treated the same as a null string.
259  * @param hostname the host name string
260  * @param port the port number, left out from the string if negative
261  * @param fmt a generic format string for everything to add after the
262  *            host/port, may be null
263  * @return the number of characters written to the destination buffer
264  */
265 int ff_url_join(char *str, int size, const char *proto,
266                 const char *authorization, const char *hostname,
267                 int port, const char *fmt, ...) av_printf_format(7, 8);
268
269 /*
270  * Convert a relative url into an absolute url, given a base url.
271  *
272  * @param buf the buffer where output absolute url is written
273  * @param size the size of buf
274  * @param base the base url, may be equal to buf.
275  * @param rel the new url, which is interpreted relative to base
276  */
277 void ff_make_absolute_url(char *buf, int size, const char *base,
278                           const char *rel);
279
280
281 #endif /* AVFORMAT_URL_H */