3 * Copyright (c) 2001 Fabrice Bellard
5 * This file is part of Libav.
7 * Libav is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * Libav is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with Libav; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "libavutil/avstring.h"
23 #include "libavutil/dict.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/time.h"
26 #include "os_support.h"
33 static URLProtocol *first_protocol = NULL;
35 URLProtocol *ffurl_protocol_next(URLProtocol *prev)
37 return prev ? prev->next : first_protocol;
40 /** @name Logging context. */
42 static const char *urlcontext_to_name(void *ptr)
44 URLContext *h = (URLContext *)ptr;
45 if(h->prot) return h->prot->name;
49 static void *urlcontext_child_next(void *obj, void *prev)
52 if (!prev && h->priv_data && h->prot->priv_data_class)
57 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
59 URLProtocol *p = NULL;
61 /* find the protocol that corresponds to prev */
62 while (prev && (p = ffurl_protocol_next(p)))
63 if (p->priv_data_class == prev)
66 /* find next protocol with priv options */
67 while (p = ffurl_protocol_next(p))
68 if (p->priv_data_class)
69 return p->priv_data_class;
74 static const AVOption options[] = {{NULL}};
75 const AVClass ffurl_context_class = {
76 .class_name = "URLContext",
77 .item_name = urlcontext_to_name,
79 .version = LIBAVUTIL_VERSION_INT,
80 .child_next = urlcontext_child_next,
81 .child_class_next = urlcontext_child_class_next,
86 const char *avio_enum_protocols(void **opaque, int output)
88 URLProtocol **p = opaque;
89 *p = ffurl_protocol_next(*p);
91 if ((output && (*p)->url_write) || (!output && (*p)->url_read))
93 return avio_enum_protocols(opaque, output);
96 int ffurl_register_protocol(URLProtocol *protocol, int size)
99 if (size < sizeof(URLProtocol)) {
100 URLProtocol* temp = av_mallocz(sizeof(URLProtocol));
101 memcpy(temp, protocol, size);
105 while (*p != NULL) p = &(*p)->next;
107 protocol->next = NULL;
111 static int url_alloc_for_protocol (URLContext **puc, struct URLProtocol *up,
112 const char *filename, int flags,
113 const AVIOInterruptCB *int_cb)
119 if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
122 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
124 err = AVERROR(ENOMEM);
127 uc->av_class = &ffurl_context_class;
128 uc->filename = (char *) &uc[1];
129 strcpy(uc->filename, filename);
132 uc->is_streamed = 0; /* default = not streamed */
133 uc->max_packet_size = 0; /* default: stream file */
134 if (up->priv_data_size) {
135 uc->priv_data = av_mallocz(up->priv_data_size);
136 if (up->priv_data_class) {
137 *(const AVClass**)uc->priv_data = up->priv_data_class;
138 av_opt_set_defaults(uc->priv_data);
142 uc->interrupt_callback = *int_cb;
149 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
155 int ffurl_connect(URLContext* uc, AVDictionary **options)
158 uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
159 uc->prot->url_open(uc, uc->filename, uc->flags);
162 uc->is_connected = 1;
163 //We must be careful here as ffurl_seek() could be slow, for example for http
164 if( (uc->flags & AVIO_FLAG_WRITE)
165 || !strcmp(uc->prot->name, "file"))
166 if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
171 #define URL_SCHEME_CHARS \
172 "abcdefghijklmnopqrstuvwxyz" \
173 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
176 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
177 const AVIOInterruptCB *int_cb)
179 URLProtocol *up = NULL;
180 char proto_str[128], proto_nested[128], *ptr;
181 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
183 if (filename[proto_len] != ':' || is_dos_path(filename))
184 strcpy(proto_str, "file");
186 av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
188 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
189 if ((ptr = strchr(proto_nested, '+')))
192 while (up = ffurl_protocol_next(up)) {
193 if (!strcmp(proto_str, up->name))
194 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
195 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
196 !strcmp(proto_nested, up->name))
197 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
200 return AVERROR(ENOENT);
203 int ffurl_open(URLContext **puc, const char *filename, int flags,
204 const AVIOInterruptCB *int_cb, AVDictionary **options)
206 int ret = ffurl_alloc(puc, filename, flags, int_cb);
209 if (options && (*puc)->prot->priv_data_class &&
210 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
212 ret = ffurl_connect(*puc, options);
221 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
222 int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
225 int fast_retries = 5;
228 while (len < size_min) {
229 ret = transfer_func(h, buf+len, size-len);
230 if (ret == AVERROR(EINTR))
232 if (h->flags & AVIO_FLAG_NONBLOCK)
234 if (ret == AVERROR(EAGAIN)) {
241 return ret < 0 ? ret : len;
243 fast_retries = FFMAX(fast_retries, 2);
245 if (ff_check_interrupt(&h->interrupt_callback))
251 int ffurl_read(URLContext *h, unsigned char *buf, int size)
253 if (!(h->flags & AVIO_FLAG_READ))
255 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
258 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
260 if (!(h->flags & AVIO_FLAG_READ))
262 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
265 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
267 if (!(h->flags & AVIO_FLAG_WRITE))
269 /* avoid sending too big packets */
270 if (h->max_packet_size && size > h->max_packet_size)
273 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_write);
276 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
280 if (!h->prot->url_seek)
281 return AVERROR(ENOSYS);
282 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
286 int ffurl_close(URLContext *h)
289 if (!h) return 0; /* can happen when ffurl_open fails */
291 if (h->is_connected && h->prot->url_close)
292 ret = h->prot->url_close(h);
294 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
297 if (h->prot->priv_data_size) {
298 if (h->prot->priv_data_class)
299 av_opt_free(h->priv_data);
300 av_free(h->priv_data);
306 int avio_check(const char *url, int flags)
309 int ret = ffurl_alloc(&h, url, flags, NULL);
313 if (h->prot->url_check) {
314 ret = h->prot->url_check(h, flags);
316 ret = ffurl_connect(h, NULL);
325 int64_t ffurl_size(URLContext *h)
329 size= ffurl_seek(h, 0, AVSEEK_SIZE);
331 pos = ffurl_seek(h, 0, SEEK_CUR);
332 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
335 ffurl_seek(h, pos, SEEK_SET);
340 int ffurl_get_file_handle(URLContext *h)
342 if (!h->prot->url_get_file_handle)
344 return h->prot->url_get_file_handle(h);
347 int ffurl_shutdown(URLContext *h, int flags)
349 if (!h->prot->url_shutdown)
350 return AVERROR(EINVAL);
351 return h->prot->url_shutdown(h, flags);
354 int ff_check_interrupt(AVIOInterruptCB *cb)
357 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))