dc483a3ea9858ec8912dc2152fb6e92876e08258
[ffmpeg.git] / libavformat / url.h
1 /*
2  *
3  * This file is part of FFmpeg.
4  *
5  * FFmpeg is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * FFmpeg is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with FFmpeg; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  */
19
20 /**
21  * @file
22  * unbuffered private I/O API
23  */
24
25 #ifndef AVFORMAT_URL_H
26 #define AVFORMAT_URL_H
27
28 #include "avio.h"
29 #include "libavformat/version.h"
30
31 #include "libavutil/dict.h"
32 #include "libavutil/log.h"
33
34 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
35 #define URL_PROTOCOL_FLAG_NETWORK       2 /*< The protocol uses network */
36
37 extern int (*url_interrupt_cb)(void);
38
39 extern const AVClass ffurl_context_class;
40
41 typedef struct URLContext {
42     const AVClass *av_class;    /**< information for av_log(). Set by url_open(). */
43     struct URLProtocol *prot;
44     void *priv_data;
45     char *filename;             /**< specified URL */
46     int flags;
47     int max_packet_size;        /**< if non zero, the stream is packetized with this max packet size */
48     int is_streamed;            /**< true if streamed (no seek possible), default = false */
49     int is_connected;
50     AVIOInterruptCB interrupt_callback;
51 } URLContext;
52
53 typedef struct URLProtocol {
54     const char *name;
55     int     (*url_open)( URLContext *h, const char *url, int flags);
56     /**
57      * This callback is to be used by protocols which open further nested
58      * protocols. options are then to be passed to ffurl_open()/ffurl_connect()
59      * for those nested protocols.
60      */
61     int     (*url_open2)(URLContext *h, const char *url, int flags, AVDictionary **options);
62
63     /**
64      * Read data from the protocol.
65      * If data is immediately available (even less than size), EOF is
66      * reached or an error occurs (including EINTR), return immediately.
67      * Otherwise:
68      * In non-blocking mode, return AVERROR(EAGAIN) immediately.
69      * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
70      * and return AVERROR(EAGAIN) on timeout.
71      * Checking interrupt_callback, looping on EINTR and EAGAIN and until
72      * enough data has been read is left to the calling function; see
73      * retry_transfer_wrapper in avio.c.
74      */
75     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
76     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
77     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
78     int     (*url_close)(URLContext *h);
79     struct URLProtocol *next;
80     int (*url_read_pause)(URLContext *h, int pause);
81     int64_t (*url_read_seek)(URLContext *h, int stream_index,
82                              int64_t timestamp, int flags);
83     int (*url_get_file_handle)(URLContext *h);
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  * Register the URLProtocol protocol.
205  *
206  * @param size the size of the URLProtocol struct referenced
207  */
208 int ffurl_register_protocol(URLProtocol *protocol, int size);
209
210 /**
211  * Check if the user has requested to interrup a blocking function
212  * associated with cb.
213  */
214 int ff_check_interrupt(AVIOInterruptCB *cb);
215
216 /**
217  * Iterate over all available protocols.
218  *
219  * @param prev result of the previous call to this functions or NULL.
220  */
221 URLProtocol *ffurl_protocol_next(URLProtocol *prev);
222
223 /* udp.c */
224 int ff_udp_set_remote_url(URLContext *h, const char *uri);
225 int ff_udp_get_local_port(URLContext *h);
226
227 #endif /* AVFORMAT_URL_H */