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 "libavutil/avassert.h"
27 #include "os_support.h"
34 /** @name Logging context. */
36 static const char *urlcontext_to_name(void *ptr)
38 URLContext *h = (URLContext *)ptr;
45 static void *urlcontext_child_next(void *obj, void *prev)
48 if (!prev && h->priv_data && h->prot->priv_data_class)
53 #define OFFSET(x) offsetof(URLContext,x)
54 #define E AV_OPT_FLAG_ENCODING_PARAM
55 #define D AV_OPT_FLAG_DECODING_PARAM
56 static const AVOption options[] = {
57 {"protocol_whitelist", "List of protocols that are allowed to be used", OFFSET(protocol_whitelist), AV_OPT_TYPE_STRING, { .str = NULL }, CHAR_MIN, CHAR_MAX, D },
58 {"protocol_blacklist", "List of protocols that are not allowed to be used", OFFSET(protocol_blacklist), AV_OPT_TYPE_STRING, { .str = NULL }, CHAR_MIN, CHAR_MAX, D },
62 const AVClass ffurl_context_class = {
63 .class_name = "URLContext",
64 .item_name = urlcontext_to_name,
66 .version = LIBAVUTIL_VERSION_INT,
67 .child_next = urlcontext_child_next,
68 .child_class_next = ff_urlcontext_child_class_next,
72 static int url_alloc_for_protocol(URLContext **puc, const URLProtocol *up,
73 const char *filename, int flags,
74 const AVIOInterruptCB *int_cb)
80 if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
83 if ((flags & AVIO_FLAG_READ) && !up->url_read) {
84 av_log(NULL, AV_LOG_ERROR,
85 "Impossible to open the '%s' protocol for reading\n", up->name);
88 if ((flags & AVIO_FLAG_WRITE) && !up->url_write) {
89 av_log(NULL, AV_LOG_ERROR,
90 "Impossible to open the '%s' protocol for writing\n", up->name);
93 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
95 err = AVERROR(ENOMEM);
98 uc->av_class = &ffurl_context_class;
99 uc->filename = (char *)&uc[1];
100 strcpy(uc->filename, filename);
103 uc->is_streamed = 0; /* default = not streamed */
104 uc->max_packet_size = 0; /* default: stream file */
105 if (up->priv_data_size) {
106 uc->priv_data = av_mallocz(up->priv_data_size);
107 if (!uc->priv_data) {
108 err = AVERROR(ENOMEM);
111 if (up->priv_data_class) {
112 int proto_len= strlen(up->name);
113 char *start = strchr(uc->filename, ',');
114 *(const AVClass **)uc->priv_data = up->priv_data_class;
115 av_opt_set_defaults(uc->priv_data);
116 if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
123 if (strcmp(up->name, "subfile"))
124 ret = AVERROR(EINVAL);
126 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
128 if (strcmp(p, "start") && strcmp(p, "end")) {
129 ret = AVERROR_OPTION_NOT_FOUND;
131 ret= av_opt_set(uc->priv_data, p, key+1, 0);
132 if (ret == AVERROR_OPTION_NOT_FOUND)
133 av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
138 av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
139 av_freep(&uc->priv_data);
141 err = AVERROR(EINVAL);
144 memmove(start, key+1, strlen(key));
149 uc->interrupt_callback = *int_cb;
156 av_freep(&uc->priv_data);
159 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
165 int ffurl_connect(URLContext *uc, AVDictionary **options)
168 AVDictionary *tmp_opts = NULL;
169 AVDictionaryEntry *e;
174 // Check that URLContext was initialized correctly and lists are matching if set
175 av_assert0(!(e=av_dict_get(*options, "protocol_whitelist", NULL, 0)) ||
176 (uc->protocol_whitelist && !strcmp(uc->protocol_whitelist, e->value)));
177 av_assert0(!(e=av_dict_get(*options, "protocol_blacklist", NULL, 0)) ||
178 (uc->protocol_blacklist && !strcmp(uc->protocol_blacklist, e->value)));
180 if (uc->protocol_whitelist && av_match_list(uc->prot->name, uc->protocol_whitelist, ',') <= 0) {
181 av_log(uc, AV_LOG_ERROR, "Protocol not on whitelist \'%s\'!\n", uc->protocol_whitelist);
182 return AVERROR(EINVAL);
185 if (uc->protocol_blacklist && av_match_list(uc->prot->name, uc->protocol_blacklist, ',') > 0) {
186 av_log(uc, AV_LOG_ERROR, "Protocol blacklisted \'%s\'!\n", uc->protocol_blacklist);
187 return AVERROR(EINVAL);
190 if (!uc->protocol_whitelist && uc->prot->default_whitelist) {
191 av_log(uc, AV_LOG_DEBUG, "Setting default whitelist '%s'\n", uc->prot->default_whitelist);
192 uc->protocol_whitelist = av_strdup(uc->prot->default_whitelist);
193 if (!uc->protocol_whitelist) {
194 return AVERROR(ENOMEM);
196 } else if (!uc->protocol_whitelist)
197 av_log(uc, AV_LOG_DEBUG, "No default whitelist set\n"); // This should be an error once all declare a default whitelist
199 if ((err = av_dict_set(options, "protocol_whitelist", uc->protocol_whitelist, 0)) < 0)
201 if ((err = av_dict_set(options, "protocol_blacklist", uc->protocol_blacklist, 0)) < 0)
205 uc->prot->url_open2 ? uc->prot->url_open2(uc,
209 uc->prot->url_open(uc, uc->filename, uc->flags);
211 av_dict_set(options, "protocol_whitelist", NULL, 0);
212 av_dict_set(options, "protocol_blacklist", NULL, 0);
216 uc->is_connected = 1;
217 /* We must be careful here as ffurl_seek() could be slow,
218 * for example for http */
219 if ((uc->flags & AVIO_FLAG_WRITE) || !strcmp(uc->prot->name, "file"))
220 if (!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
225 int ffurl_accept(URLContext *s, URLContext **c)
228 if (s->prot->url_accept)
229 return s->prot->url_accept(s, c);
230 return AVERROR(EBADF);
233 int ffurl_handshake(URLContext *c)
236 if (c->prot->url_handshake) {
237 ret = c->prot->url_handshake(c);
245 #define URL_SCHEME_CHARS \
246 "abcdefghijklmnopqrstuvwxyz" \
247 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
250 static const struct URLProtocol *url_find_protocol(const char *filename)
252 const URLProtocol **protocols;
253 char proto_str[128], proto_nested[128], *ptr;
254 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
257 if (filename[proto_len] != ':' &&
258 (strncmp(filename, "subfile,", 8) || !strchr(filename + proto_len + 1, ':')) ||
259 is_dos_path(filename))
260 strcpy(proto_str, "file");
262 av_strlcpy(proto_str, filename,
263 FFMIN(proto_len + 1, sizeof(proto_str)));
265 if ((ptr = strchr(proto_str, ',')))
267 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
268 if ((ptr = strchr(proto_nested, '+')))
271 protocols = ffurl_get_protocols(NULL, NULL);
272 for (i = 0; protocols[i]; i++) {
273 const URLProtocol *up = protocols[i];
274 if (!strcmp(proto_str, up->name)) {
275 av_freep(&protocols);
278 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
279 !strcmp(proto_nested, up->name)) {
280 av_freep(&protocols);
288 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
289 const AVIOInterruptCB *int_cb)
291 const URLProtocol *p = NULL;
293 p = url_find_protocol(filename);
295 return url_alloc_for_protocol(puc, p, filename, flags, int_cb);
298 if (av_strstart(filename, "https:", NULL))
299 av_log(NULL, AV_LOG_WARNING, "https protocol not found, recompile FFmpeg with "
301 "or securetransport enabled.\n");
302 return AVERROR_PROTOCOL_NOT_FOUND;
305 int ffurl_open_whitelist(URLContext **puc, const char *filename, int flags,
306 const AVIOInterruptCB *int_cb, AVDictionary **options,
307 const char *whitelist, const char* blacklist)
309 AVDictionary *tmp_opts = NULL;
310 AVDictionaryEntry *e;
311 int ret = ffurl_alloc(puc, filename, flags, int_cb);
314 if (options && (*puc)->prot->priv_data_class &&
315 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
321 av_assert0(!whitelist ||
322 !(e=av_dict_get(*options, "protocol_whitelist", NULL, 0)) ||
323 !strcmp(whitelist, e->value));
324 av_assert0(!blacklist ||
325 !(e=av_dict_get(*options, "protocol_blacklist", NULL, 0)) ||
326 !strcmp(blacklist, e->value));
328 if ((ret = av_dict_set(options, "protocol_whitelist", whitelist, 0)) < 0)
331 if ((ret = av_dict_set(options, "protocol_blacklist", blacklist, 0)) < 0)
334 if ((ret = av_opt_set_dict(*puc, options)) < 0)
337 ret = ffurl_connect(*puc, options);
347 int ffurl_open(URLContext **puc, const char *filename, int flags,
348 const AVIOInterruptCB *int_cb, AVDictionary **options)
350 return ffurl_open_whitelist(puc, filename, flags,
351 int_cb, options, NULL, NULL);
354 static inline int retry_transfer_wrapper(URLContext *h, uint8_t *buf,
355 int size, int size_min,
356 int (*transfer_func)(URLContext *h,
361 int fast_retries = 5;
362 int64_t wait_since = 0;
365 while (len < size_min) {
366 if (ff_check_interrupt(&h->interrupt_callback))
368 ret = transfer_func(h, buf + len, size - len);
369 if (ret == AVERROR(EINTR))
371 if (h->flags & AVIO_FLAG_NONBLOCK)
373 if (ret == AVERROR(EAGAIN)) {
380 wait_since = av_gettime_relative();
381 else if (av_gettime_relative() > wait_since + h->rw_timeout)
387 return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
389 fast_retries = FFMAX(fast_retries, 2);
395 int ffurl_read(URLContext *h, unsigned char *buf, int size)
397 if (!(h->flags & AVIO_FLAG_READ))
399 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
402 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
404 if (!(h->flags & AVIO_FLAG_READ))
406 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
409 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
411 if (!(h->flags & AVIO_FLAG_WRITE))
413 /* avoid sending too big packets */
414 if (h->max_packet_size && size > h->max_packet_size)
417 return retry_transfer_wrapper(h, (unsigned char *)buf, size, size,
418 (int (*)(struct URLContext *, uint8_t *, int))
422 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
426 if (!h->prot->url_seek)
427 return AVERROR(ENOSYS);
428 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
432 int ffurl_closep(URLContext **hh)
437 return 0; /* can happen when ffurl_open fails */
439 if (h->is_connected && h->prot->url_close)
440 ret = h->prot->url_close(h);
442 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
445 if (h->prot->priv_data_size) {
446 if (h->prot->priv_data_class)
447 av_opt_free(h->priv_data);
448 av_freep(&h->priv_data);
455 int ffurl_close(URLContext *h)
457 return ffurl_closep(&h);
461 const char *avio_find_protocol_name(const char *url)
463 const URLProtocol *p = url_find_protocol(url);
465 return p ? p->name : NULL;
468 int avio_check(const char *url, int flags)
471 int ret = ffurl_alloc(&h, url, flags, NULL);
475 if (h->prot->url_check) {
476 ret = h->prot->url_check(h, flags);
478 ret = ffurl_connect(h, NULL);
487 int avpriv_io_move(const char *url_src, const char *url_dst)
489 URLContext *h_src, *h_dst;
490 int ret = ffurl_alloc(&h_src, url_src, AVIO_FLAG_READ_WRITE, NULL);
493 ret = ffurl_alloc(&h_dst, url_dst, AVIO_FLAG_WRITE, NULL);
499 if (h_src->prot == h_dst->prot && h_src->prot->url_move)
500 ret = h_src->prot->url_move(h_src, h_dst);
502 ret = AVERROR(ENOSYS);
509 int avpriv_io_delete(const char *url)
512 int ret = ffurl_alloc(&h, url, AVIO_FLAG_WRITE, NULL);
516 if (h->prot->url_delete)
517 ret = h->prot->url_delete(h);
519 ret = AVERROR(ENOSYS);
525 int avio_open_dir(AVIODirContext **s, const char *url, AVDictionary **options)
527 URLContext *h = NULL;
528 AVIODirContext *ctx = NULL;
532 ctx = av_mallocz(sizeof(*ctx));
534 ret = AVERROR(ENOMEM);
538 if ((ret = ffurl_alloc(&h, url, AVIO_FLAG_READ, NULL)) < 0)
541 if (h->prot->url_open_dir && h->prot->url_read_dir && h->prot->url_close_dir) {
542 if (options && h->prot->priv_data_class &&
543 (ret = av_opt_set_dict(h->priv_data, options)) < 0)
545 ret = h->prot->url_open_dir(h);
547 ret = AVERROR(ENOSYS);
552 ctx->url_context = h;
563 int avio_read_dir(AVIODirContext *s, AVIODirEntry **next)
568 if (!s || !s->url_context)
569 return AVERROR(EINVAL);
571 if ((ret = h->prot->url_read_dir(h, next)) < 0)
572 avio_free_directory_entry(next);
576 int avio_close_dir(AVIODirContext **s)
581 if (!(*s) || !(*s)->url_context)
582 return AVERROR(EINVAL);
583 h = (*s)->url_context;
584 h->prot->url_close_dir(h);
591 void avio_free_directory_entry(AVIODirEntry **entry)
593 if (!entry || !*entry)
595 av_free((*entry)->name);
599 int64_t ffurl_size(URLContext *h)
603 size = ffurl_seek(h, 0, AVSEEK_SIZE);
605 pos = ffurl_seek(h, 0, SEEK_CUR);
606 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
609 ffurl_seek(h, pos, SEEK_SET);
614 int ffurl_get_file_handle(URLContext *h)
616 if (!h->prot->url_get_file_handle)
618 return h->prot->url_get_file_handle(h);
621 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
623 if (!h->prot->url_get_multi_file_handle) {
624 if (!h->prot->url_get_file_handle)
625 return AVERROR(ENOSYS);
626 *handles = av_malloc(sizeof(**handles));
628 return AVERROR(ENOMEM);
630 *handles[0] = h->prot->url_get_file_handle(h);
633 return h->prot->url_get_multi_file_handle(h, handles, numhandles);
636 int ffurl_shutdown(URLContext *h, int flags)
638 if (!h->prot->url_shutdown)
639 return AVERROR(EINVAL);
640 return h->prot->url_shutdown(h, flags);
643 int ff_check_interrupt(AVIOInterruptCB *cb)
646 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))