1f04c8d530ba5bd113465b2e1b9db7f9b9920a4b
[ffmpeg.git] / libavformat / url.h
1 /*
2  *
3  * This file is part of Libav.
4  *
5  * Libav 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  * Libav 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 Libav; 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
33 #if !FF_API_OLD_AVIO
34 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
35
36 extern int (*url_interrupt_cb)(void);
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     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
60     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
61     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
62     int     (*url_close)(URLContext *h);
63     struct URLProtocol *next;
64     int (*url_read_pause)(URLContext *h, int pause);
65     int64_t (*url_read_seek)(URLContext *h, int stream_index,
66                              int64_t timestamp, int flags);
67     int (*url_get_file_handle)(URLContext *h);
68     int priv_data_size;
69     const AVClass *priv_data_class;
70     int flags;
71     int (*url_check)(URLContext *h, int mask);
72 } URLProtocol;
73 #endif
74
75 /**
76  * Create a URLContext for accessing to the resource indicated by
77  * url, but do not initiate the connection yet.
78  *
79  * @param puc pointer to the location where, in case of success, the
80  * function puts the pointer to the created URLContext
81  * @param flags flags which control how the resource indicated by url
82  * is to be opened
83  * @param int_cb interrupt callback to use for the URLContext, may be
84  * NULL
85  * @return 0 in case of success, a negative value corresponding to an
86  * AVERROR code in case of failure
87  */
88 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
89                 const AVIOInterruptCB *int_cb);
90
91 /**
92  * Connect an URLContext that has been allocated by ffurl_alloc
93  *
94  * @param options  A dictionary filled with options for nested protocols,
95  * i.e. it will be passed to url_open2() for protocols implementing it.
96  * This parameter will be destroyed and replaced with a dict containing options
97  * that were not found. May be NULL.
98  */
99 int ffurl_connect(URLContext *uc, AVDictionary **options);
100
101 /**
102  * Create an URLContext for accessing to the resource indicated by
103  * url, and open it.
104  *
105  * @param puc pointer to the location where, in case of success, the
106  * function puts the pointer to the created URLContext
107  * @param flags flags which control how the resource indicated by url
108  * is to be opened
109  * @param int_cb interrupt callback to use for the URLContext, may be
110  * NULL
111  * @param options  A dictionary filled with protocol-private options. On return
112  * this parameter will be destroyed and replaced with a dict containing options
113  * that were not found. May be NULL.
114  * @return 0 in case of success, a negative value corresponding to an
115  * AVERROR code in case of failure
116  */
117 int ffurl_open(URLContext **puc, const char *filename, int flags,
118                const AVIOInterruptCB *int_cb, AVDictionary **options);
119
120 /**
121  * Read up to size bytes from the resource accessed by h, and store
122  * the read bytes in buf.
123  *
124  * @return The number of bytes actually read, or a negative value
125  * corresponding to an AVERROR code in case of error. A value of zero
126  * indicates that it is not possible to read more from the accessed
127  * resource (except if the value of the size argument is also zero).
128  */
129 int ffurl_read(URLContext *h, unsigned char *buf, int size);
130
131 /**
132  * Read as many bytes as possible (up to size), calling the
133  * read function multiple times if necessary.
134  * This makes special short-read handling in applications
135  * unnecessary, if the return value is < size then it is
136  * certain there was either an error or the end of file was reached.
137  */
138 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
139
140 /**
141  * Write size bytes from buf to the resource accessed by h.
142  *
143  * @return the number of bytes actually written, or a negative value
144  * corresponding to an AVERROR code in case of failure
145  */
146 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
147
148 /**
149  * Change the position that will be used by the next read/write
150  * operation on the resource accessed by h.
151  *
152  * @param pos specifies the new position to set
153  * @param whence specifies how pos should be interpreted, it must be
154  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
155  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
156  * (return the filesize of the requested resource, pos is ignored).
157  * @return a negative value corresponding to an AVERROR code in case
158  * of failure, or the resulting file position, measured in bytes from
159  * the beginning of the file. You can use this feature together with
160  * SEEK_CUR to read the current file position.
161  */
162 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
163
164 /**
165  * Close the resource accessed by the URLContext h, and free the
166  * memory used by it.
167  *
168  * @return a negative value if an error condition occurred, 0
169  * otherwise
170  */
171 int ffurl_close(URLContext *h);
172
173 /**
174  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
175  * if the operation is not supported by h, or another negative value
176  * corresponding to an AVERROR error code in case of failure.
177  */
178 int64_t ffurl_size(URLContext *h);
179
180 /**
181  * Return the file descriptor associated with this URL. For RTP, this
182  * will return only the RTP file descriptor, not the RTCP file descriptor.
183  *
184  * @return the file descriptor associated with this URL, or <0 on error.
185  */
186 int ffurl_get_file_handle(URLContext *h);
187
188 /**
189  * Register the URLProtocol protocol.
190  *
191  * @param size the size of the URLProtocol struct referenced
192  */
193 int ffurl_register_protocol(URLProtocol *protocol, int size);
194
195 /**
196  * Check if the user has requested to interrup a blocking function
197  * associated with cb.
198  */
199 int ff_check_interrupt(AVIOInterruptCB *cb);
200
201 /**
202  * Iterate over all available protocols.
203  *
204  * @param prev result of the previous call to this functions or NULL.
205  */
206 URLProtocol *ffurl_protocol_next(URLProtocol *prev);
207
208 /* udp.c */
209 int ff_udp_set_remote_url(URLContext *h, const char *uri);
210 int ff_udp_get_local_port(URLContext *h);
211
212 #endif /* AVFORMAT_URL_H */