3 * Copyright (c) 2001 Fabrice Bellard
5 * This file is part of FFmpeg.
7 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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)
89 *opaque = ffurl_protocol_next(*opaque);
90 if (!(p = *opaque)) return NULL;
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 if ((flags & AVIO_FLAG_READ) && !up->url_read) {
123 av_log(NULL, AV_LOG_ERROR,
124 "Impossible to open the '%s' protocol for reading\n", up->name);
127 if ((flags & AVIO_FLAG_WRITE) && !up->url_write) {
128 av_log(NULL, AV_LOG_ERROR,
129 "Impossible to open the '%s' protocol for writing\n", up->name);
132 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
134 err = AVERROR(ENOMEM);
137 uc->av_class = &ffurl_context_class;
138 uc->filename = (char *) &uc[1];
139 strcpy(uc->filename, filename);
142 uc->is_streamed = 0; /* default = not streamed */
143 uc->max_packet_size = 0; /* default: stream file */
144 if (up->priv_data_size) {
145 uc->priv_data = av_mallocz(up->priv_data_size);
146 if (up->priv_data_class) {
147 int proto_len= strlen(up->name);
148 char *start = strchr(uc->filename, ',');
149 *(const AVClass**)uc->priv_data = up->priv_data_class;
150 av_opt_set_defaults(uc->priv_data);
151 if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
157 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
159 ret= av_opt_set(uc->priv_data, p, key+1, 0);
160 if (ret == AVERROR_OPTION_NOT_FOUND)
161 av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
166 av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
167 av_freep(&uc->priv_data);
169 err = AVERROR(EINVAL);
172 memmove(start, key+1, strlen(key));
177 uc->interrupt_callback = *int_cb;
184 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
190 int ffurl_connect(URLContext* uc, AVDictionary **options)
193 uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
194 uc->prot->url_open(uc, uc->filename, uc->flags);
197 uc->is_connected = 1;
198 //We must be careful here as ffurl_seek() could be slow, for example for http
199 if( (uc->flags & AVIO_FLAG_WRITE)
200 || !strcmp(uc->prot->name, "file"))
201 if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
206 #define URL_SCHEME_CHARS \
207 "abcdefghijklmnopqrstuvwxyz" \
208 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
211 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
212 const AVIOInterruptCB *int_cb)
214 URLProtocol *up = NULL;
215 char proto_str[128], proto_nested[128], *ptr;
216 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
218 if (!first_protocol) {
219 av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
220 "Missing call to av_register_all()?\n");
223 if (filename[proto_len] != ':' &&
224 (filename[proto_len] != ',' || !strchr(filename + proto_len + 1, ':')) ||
225 is_dos_path(filename))
226 strcpy(proto_str, "file");
228 av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
230 if ((ptr = strchr(proto_str, ',')))
232 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
233 if ((ptr = strchr(proto_nested, '+')))
236 while (up = ffurl_protocol_next(up)) {
237 if (!strcmp(proto_str, up->name))
238 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
239 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
240 !strcmp(proto_nested, up->name))
241 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
244 return AVERROR_PROTOCOL_NOT_FOUND;
247 int ffurl_open(URLContext **puc, const char *filename, int flags,
248 const AVIOInterruptCB *int_cb, AVDictionary **options)
250 int ret = ffurl_alloc(puc, filename, flags, int_cb);
253 if (options && (*puc)->prot->priv_data_class &&
254 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
256 ret = ffurl_connect(*puc, options);
265 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
266 int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
269 int fast_retries = 5;
270 int64_t wait_since = 0;
273 while (len < size_min) {
274 ret = transfer_func(h, buf+len, size-len);
275 if (ret == AVERROR(EINTR))
277 if (h->flags & AVIO_FLAG_NONBLOCK)
279 if (ret == AVERROR(EAGAIN)) {
286 wait_since = av_gettime();
287 else if (av_gettime() > wait_since + h->rw_timeout)
293 return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
295 fast_retries = FFMAX(fast_retries, 2);
297 if (len < size && ff_check_interrupt(&h->interrupt_callback))
303 int ffurl_read(URLContext *h, unsigned char *buf, int size)
305 if (!(h->flags & AVIO_FLAG_READ))
307 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
310 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
312 if (!(h->flags & AVIO_FLAG_READ))
314 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
317 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
319 if (!(h->flags & AVIO_FLAG_WRITE))
321 /* avoid sending too big packets */
322 if (h->max_packet_size && size > h->max_packet_size)
325 return retry_transfer_wrapper(h, (unsigned char *)buf, size, size, (void*)h->prot->url_write);
328 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
332 if (!h->prot->url_seek)
333 return AVERROR(ENOSYS);
334 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
338 int ffurl_closep(URLContext **hh)
342 if (!h) return 0; /* can happen when ffurl_open fails */
344 if (h->is_connected && h->prot->url_close)
345 ret = h->prot->url_close(h);
347 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
350 if (h->prot->priv_data_size) {
351 if (h->prot->priv_data_class)
352 av_opt_free(h->priv_data);
353 av_freep(&h->priv_data);
359 int ffurl_close(URLContext *h)
361 return ffurl_closep(&h);
365 int avio_check(const char *url, int flags)
368 int ret = ffurl_alloc(&h, url, flags, NULL);
372 if (h->prot->url_check) {
373 ret = h->prot->url_check(h, flags);
375 ret = ffurl_connect(h, NULL);
384 int64_t ffurl_size(URLContext *h)
388 size= ffurl_seek(h, 0, AVSEEK_SIZE);
390 pos = ffurl_seek(h, 0, SEEK_CUR);
391 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
394 ffurl_seek(h, pos, SEEK_SET);
399 int ffurl_get_file_handle(URLContext *h)
401 if (!h->prot->url_get_file_handle)
403 return h->prot->url_get_file_handle(h);
406 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
408 if (!h->prot->url_get_multi_file_handle) {
409 if (!h->prot->url_get_file_handle)
410 return AVERROR(ENOSYS);
411 *handles = av_malloc(sizeof(**handles));
413 return AVERROR(ENOMEM);
415 *handles[0] = h->prot->url_get_file_handle(h);
418 return h->prot->url_get_multi_file_handle(h, handles, numhandles);
421 int ffurl_shutdown(URLContext *h, int flags)
423 if (!h->prot->url_shutdown)
424 return AVERROR(EINVAL);
425 return h->prot->url_shutdown(h, flags);
428 int ff_check_interrupt(AVIOInterruptCB *cb)
431 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))