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;
51 static void *urlcontext_child_next(void *obj, void *prev)
54 if (!prev && h->priv_data && h->prot->priv_data_class)
59 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
61 URLProtocol *p = NULL;
63 /* find the protocol that corresponds to prev */
64 while (prev && (p = ffurl_protocol_next(p)))
65 if (p->priv_data_class == prev)
68 /* find next protocol with priv options */
69 while (p = ffurl_protocol_next(p))
70 if (p->priv_data_class)
71 return p->priv_data_class;
75 static const AVOption options[] = { { NULL } };
76 const AVClass ffurl_context_class = {
77 .class_name = "URLContext",
78 .item_name = urlcontext_to_name,
80 .version = LIBAVUTIL_VERSION_INT,
81 .child_next = urlcontext_child_next,
82 .child_class_next = urlcontext_child_class_next,
86 const char *avio_enum_protocols(void **opaque, int output)
89 *opaque = ffurl_protocol_next(*opaque);
92 if ((output && p->url_write) || (!output && p->url_read))
94 return avio_enum_protocols(opaque, output);
97 int ffurl_register_protocol(URLProtocol *protocol, int size)
100 if (size < sizeof(URLProtocol)) {
101 URLProtocol *temp = av_mallocz(sizeof(URLProtocol));
102 memcpy(temp, protocol, size);
109 protocol->next = NULL;
113 static int url_alloc_for_protocol(URLContext **puc, struct URLProtocol *up,
114 const char *filename, int flags,
115 const AVIOInterruptCB *int_cb)
121 if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
124 if ((flags & AVIO_FLAG_READ) && !up->url_read) {
125 av_log(NULL, AV_LOG_ERROR,
126 "Impossible to open the '%s' protocol for reading\n", up->name);
129 if ((flags & AVIO_FLAG_WRITE) && !up->url_write) {
130 av_log(NULL, AV_LOG_ERROR,
131 "Impossible to open the '%s' protocol for writing\n", up->name);
134 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
136 err = AVERROR(ENOMEM);
139 uc->av_class = &ffurl_context_class;
140 uc->filename = (char *)&uc[1];
141 strcpy(uc->filename, filename);
144 uc->is_streamed = 0; /* default = not streamed */
145 uc->max_packet_size = 0; /* default: stream file */
146 if (up->priv_data_size) {
147 uc->priv_data = av_mallocz(up->priv_data_size);
148 if (!uc->priv_data) {
149 err = AVERROR(ENOMEM);
152 if (up->priv_data_class) {
153 int proto_len= strlen(up->name);
154 char *start = strchr(uc->filename, ',');
155 *(const AVClass **)uc->priv_data = up->priv_data_class;
156 av_opt_set_defaults(uc->priv_data);
157 if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
163 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
165 ret= av_opt_set(uc->priv_data, p, key+1, 0);
166 if (ret == AVERROR_OPTION_NOT_FOUND)
167 av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
172 av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
173 av_freep(&uc->priv_data);
175 err = AVERROR(EINVAL);
178 memmove(start, key+1, strlen(key));
183 uc->interrupt_callback = *int_cb;
190 av_freep(&uc->priv_data);
193 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
199 int ffurl_connect(URLContext *uc, AVDictionary **options)
202 uc->prot->url_open2 ? uc->prot->url_open2(uc,
206 uc->prot->url_open(uc, uc->filename, uc->flags);
209 uc->is_connected = 1;
210 /* We must be careful here as ffurl_seek() could be slow,
211 * for example for http */
212 if ((uc->flags & AVIO_FLAG_WRITE) || !strcmp(uc->prot->name, "file"))
213 if (!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
218 #define URL_SCHEME_CHARS \
219 "abcdefghijklmnopqrstuvwxyz" \
220 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
223 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
224 const AVIOInterruptCB *int_cb)
226 URLProtocol *up = NULL;
227 char proto_str[128], proto_nested[128], *ptr;
228 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
230 if (!first_protocol) {
231 av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
232 "Missing call to av_register_all()?\n");
235 if (filename[proto_len] != ':' &&
236 (filename[proto_len] != ',' || !strchr(filename + proto_len + 1, ':')) ||
237 is_dos_path(filename))
238 strcpy(proto_str, "file");
240 av_strlcpy(proto_str, filename,
241 FFMIN(proto_len + 1, sizeof(proto_str)));
243 if ((ptr = strchr(proto_str, ',')))
245 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
246 if ((ptr = strchr(proto_nested, '+')))
249 while (up = ffurl_protocol_next(up)) {
250 if (!strcmp(proto_str, up->name))
251 return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
252 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
253 !strcmp(proto_nested, up->name))
254 return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
257 if (!strcmp("https", proto_str))
258 av_log(NULL, AV_LOG_WARNING, "https protocol not found, recompile with openssl or gnutls enabled.\n");
259 return AVERROR_PROTOCOL_NOT_FOUND;
262 int ffurl_open(URLContext **puc, const char *filename, int flags,
263 const AVIOInterruptCB *int_cb, AVDictionary **options)
265 int ret = ffurl_alloc(puc, filename, flags, int_cb);
268 if (options && (*puc)->prot->priv_data_class &&
269 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
271 ret = ffurl_connect(*puc, options);
280 static inline int retry_transfer_wrapper(URLContext *h, uint8_t *buf,
281 int size, int size_min,
282 int (*transfer_func)(URLContext *h,
287 int fast_retries = 5;
288 int64_t wait_since = 0;
291 while (len < size_min) {
292 if (ff_check_interrupt(&h->interrupt_callback))
294 ret = transfer_func(h, buf + len, size - len);
295 if (ret == AVERROR(EINTR))
297 if (h->flags & AVIO_FLAG_NONBLOCK)
299 if (ret == AVERROR(EAGAIN)) {
306 wait_since = av_gettime();
307 else if (av_gettime() > wait_since + h->rw_timeout)
313 return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
315 fast_retries = FFMAX(fast_retries, 2);
321 int ffurl_read(URLContext *h, unsigned char *buf, int size)
323 if (!(h->flags & AVIO_FLAG_READ))
325 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
328 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
330 if (!(h->flags & AVIO_FLAG_READ))
332 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
335 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
337 if (!(h->flags & AVIO_FLAG_WRITE))
339 /* avoid sending too big packets */
340 if (h->max_packet_size && size > h->max_packet_size)
343 return retry_transfer_wrapper(h, (unsigned char *)buf, size, size, (void*)h->prot->url_write);
346 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
350 if (!h->prot->url_seek)
351 return AVERROR(ENOSYS);
352 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
356 int ffurl_closep(URLContext **hh)
361 return 0; /* can happen when ffurl_open fails */
363 if (h->is_connected && h->prot->url_close)
364 ret = h->prot->url_close(h);
366 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
369 if (h->prot->priv_data_size) {
370 if (h->prot->priv_data_class)
371 av_opt_free(h->priv_data);
372 av_freep(&h->priv_data);
378 int ffurl_close(URLContext *h)
380 return ffurl_closep(&h);
384 int avio_check(const char *url, int flags)
387 int ret = ffurl_alloc(&h, url, flags, NULL);
391 if (h->prot->url_check) {
392 ret = h->prot->url_check(h, flags);
394 ret = ffurl_connect(h, NULL);
403 int64_t ffurl_size(URLContext *h)
407 size = ffurl_seek(h, 0, AVSEEK_SIZE);
409 pos = ffurl_seek(h, 0, SEEK_CUR);
410 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
413 ffurl_seek(h, pos, SEEK_SET);
418 int ffurl_get_file_handle(URLContext *h)
420 if (!h->prot->url_get_file_handle)
422 return h->prot->url_get_file_handle(h);
425 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
427 if (!h->prot->url_get_multi_file_handle) {
428 if (!h->prot->url_get_file_handle)
429 return AVERROR(ENOSYS);
430 *handles = av_malloc(sizeof(**handles));
432 return AVERROR(ENOMEM);
434 *handles[0] = h->prot->url_get_file_handle(h);
437 return h->prot->url_get_multi_file_handle(h, handles, numhandles);
440 int ffurl_shutdown(URLContext *h, int flags)
442 if (!h->prot->url_shutdown)
443 return AVERROR(EINVAL);
444 return h->prot->url_shutdown(h, flags);
447 int ff_check_interrupt(AVIOInterruptCB *cb)
450 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))