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 static URLProtocol *first_protocol = NULL;
36 URLProtocol *ffurl_protocol_next(const URLProtocol *prev)
38 return prev ? prev->next : first_protocol;
41 /** @name Logging context. */
43 static const char *urlcontext_to_name(void *ptr)
45 URLContext *h = (URLContext *)ptr;
52 static void *urlcontext_child_next(void *obj, void *prev)
55 if (!prev && h->priv_data && h->prot->priv_data_class)
60 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
62 URLProtocol *p = NULL;
64 /* find the protocol that corresponds to prev */
65 while (prev && (p = ffurl_protocol_next(p)))
66 if (p->priv_data_class == prev)
69 /* find next protocol with priv options */
70 while (p = ffurl_protocol_next(p))
71 if (p->priv_data_class)
72 return p->priv_data_class;
76 static const AVOption options[] = { { NULL } };
77 const AVClass ffurl_context_class = {
78 .class_name = "URLContext",
79 .item_name = urlcontext_to_name,
81 .version = LIBAVUTIL_VERSION_INT,
82 .child_next = urlcontext_child_next,
83 .child_class_next = urlcontext_child_class_next,
87 const char *avio_enum_protocols(void **opaque, int output)
90 *opaque = ffurl_protocol_next(*opaque);
93 if ((output && p->url_write) || (!output && p->url_read))
95 return avio_enum_protocols(opaque, output);
98 int ffurl_register_protocol(URLProtocol *protocol)
105 protocol->next = NULL;
109 static int url_alloc_for_protocol(URLContext **puc, struct URLProtocol *up,
110 const char *filename, int flags,
111 const AVIOInterruptCB *int_cb)
117 if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
120 if ((flags & AVIO_FLAG_READ) && !up->url_read) {
121 av_log(NULL, AV_LOG_ERROR,
122 "Impossible to open the '%s' protocol for reading\n", up->name);
125 if ((flags & AVIO_FLAG_WRITE) && !up->url_write) {
126 av_log(NULL, AV_LOG_ERROR,
127 "Impossible to open the '%s' protocol for writing\n", up->name);
130 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
132 err = AVERROR(ENOMEM);
135 uc->av_class = &ffurl_context_class;
136 uc->filename = (char *)&uc[1];
137 strcpy(uc->filename, filename);
140 uc->is_streamed = 0; /* default = not streamed */
141 uc->max_packet_size = 0; /* default: stream file */
142 if (up->priv_data_size) {
143 uc->priv_data = av_mallocz(up->priv_data_size);
144 if (!uc->priv_data) {
145 err = AVERROR(ENOMEM);
148 if (up->priv_data_class) {
149 int proto_len= strlen(up->name);
150 char *start = strchr(uc->filename, ',');
151 *(const AVClass **)uc->priv_data = up->priv_data_class;
152 av_opt_set_defaults(uc->priv_data);
153 if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
160 if (strcmp(up->name, "subfile"))
161 ret = AVERROR(EINVAL);
163 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
165 if (strcmp(p, "start") && strcmp(p, "end")) {
166 ret = AVERROR_OPTION_NOT_FOUND;
168 ret= av_opt_set(uc->priv_data, p, key+1, 0);
169 if (ret == AVERROR_OPTION_NOT_FOUND)
170 av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
175 av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
176 av_freep(&uc->priv_data);
178 err = AVERROR(EINVAL);
181 memmove(start, key+1, strlen(key));
186 uc->interrupt_callback = *int_cb;
193 av_freep(&uc->priv_data);
196 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
202 int ffurl_connect(URLContext *uc, AVDictionary **options)
205 uc->prot->url_open2 ? uc->prot->url_open2(uc,
209 uc->prot->url_open(uc, uc->filename, uc->flags);
212 uc->is_connected = 1;
213 /* We must be careful here as ffurl_seek() could be slow,
214 * for example for http */
215 if ((uc->flags & AVIO_FLAG_WRITE) || !strcmp(uc->prot->name, "file"))
216 if (!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
221 int ffurl_accept(URLContext *s, URLContext **c)
224 if (s->prot->url_accept)
225 return s->prot->url_accept(s, c);
226 return AVERROR(EBADF);
229 int ffurl_handshake(URLContext *c)
232 if (c->prot->url_handshake) {
233 ret = c->prot->url_handshake(c);
241 #define URL_SCHEME_CHARS \
242 "abcdefghijklmnopqrstuvwxyz" \
243 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
246 static struct URLProtocol *url_find_protocol(const char *filename)
248 URLProtocol *up = NULL;
249 char proto_str[128], proto_nested[128], *ptr;
250 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
252 if (filename[proto_len] != ':' &&
253 (strncmp(filename, "subfile,", 8) || !strchr(filename + proto_len + 1, ':')) ||
254 is_dos_path(filename))
255 strcpy(proto_str, "file");
257 av_strlcpy(proto_str, filename,
258 FFMIN(proto_len + 1, sizeof(proto_str)));
260 if ((ptr = strchr(proto_str, ',')))
262 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
263 if ((ptr = strchr(proto_nested, '+')))
266 while (up = ffurl_protocol_next(up)) {
267 if (!strcmp(proto_str, up->name))
269 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
270 !strcmp(proto_nested, up->name))
277 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
278 const AVIOInterruptCB *int_cb)
280 URLProtocol *p = NULL;
282 if (!first_protocol) {
283 av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
284 "Missing call to av_register_all()?\n");
287 p = url_find_protocol(filename);
289 return url_alloc_for_protocol(puc, p, filename, flags, int_cb);
292 if (av_strstart(filename, "https:", NULL))
293 av_log(NULL, AV_LOG_WARNING, "https protocol not found, recompile FFmpeg with "
295 "or securetransport enabled.\n");
296 return AVERROR_PROTOCOL_NOT_FOUND;
299 int ffurl_open(URLContext **puc, const char *filename, int flags,
300 const AVIOInterruptCB *int_cb, AVDictionary **options)
302 int ret = ffurl_alloc(puc, filename, flags, int_cb);
305 if (options && (*puc)->prot->priv_data_class &&
306 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
308 if ((ret = av_opt_set_dict(*puc, options)) < 0)
310 ret = ffurl_connect(*puc, options);
319 static inline int retry_transfer_wrapper(URLContext *h, uint8_t *buf,
320 int size, int size_min,
321 int (*transfer_func)(URLContext *h,
326 int fast_retries = 5;
327 int64_t wait_since = 0;
330 while (len < size_min) {
331 if (ff_check_interrupt(&h->interrupt_callback))
333 ret = transfer_func(h, buf + len, size - len);
334 if (ret == AVERROR(EINTR))
336 if (h->flags & AVIO_FLAG_NONBLOCK)
338 if (ret == AVERROR(EAGAIN)) {
345 wait_since = av_gettime_relative();
346 else if (av_gettime_relative() > wait_since + h->rw_timeout)
352 return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
354 fast_retries = FFMAX(fast_retries, 2);
360 int ffurl_read(URLContext *h, unsigned char *buf, int size)
362 if (!(h->flags & AVIO_FLAG_READ))
364 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
367 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
369 if (!(h->flags & AVIO_FLAG_READ))
371 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
374 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
376 if (!(h->flags & AVIO_FLAG_WRITE))
378 /* avoid sending too big packets */
379 if (h->max_packet_size && size > h->max_packet_size)
382 return retry_transfer_wrapper(h, (unsigned char *)buf, size, size,
383 (int (*)(struct URLContext *, uint8_t *, int))
387 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
391 if (!h->prot->url_seek)
392 return AVERROR(ENOSYS);
393 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
397 int ffurl_closep(URLContext **hh)
402 return 0; /* can happen when ffurl_open fails */
404 if (h->is_connected && h->prot->url_close)
405 ret = h->prot->url_close(h);
407 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
410 if (h->prot->priv_data_size) {
411 if (h->prot->priv_data_class)
412 av_opt_free(h->priv_data);
413 av_freep(&h->priv_data);
419 int ffurl_close(URLContext *h)
421 return ffurl_closep(&h);
425 const char *avio_find_protocol_name(const char *url)
427 URLProtocol *p = url_find_protocol(url);
429 return p ? p->name : NULL;
432 int avio_check(const char *url, int flags)
435 int ret = ffurl_alloc(&h, url, flags, NULL);
439 if (h->prot->url_check) {
440 ret = h->prot->url_check(h, flags);
442 ret = ffurl_connect(h, NULL);
451 int avpriv_io_move(const char *url_src, const char *url_dst)
453 URLContext *h_src, *h_dst;
454 int ret = ffurl_alloc(&h_src, url_src, AVIO_FLAG_READ_WRITE, NULL);
457 ret = ffurl_alloc(&h_dst, url_dst, AVIO_FLAG_WRITE, NULL);
463 if (h_src->prot == h_dst->prot && h_src->prot->url_move)
464 ret = h_src->prot->url_move(h_src, h_dst);
466 ret = AVERROR(ENOSYS);
473 int avpriv_io_delete(const char *url)
476 int ret = ffurl_alloc(&h, url, AVIO_FLAG_WRITE, NULL);
480 if (h->prot->url_delete)
481 ret = h->prot->url_delete(h);
483 ret = AVERROR(ENOSYS);
489 int avio_open_dir(AVIODirContext **s, const char *url, AVDictionary **options)
491 URLContext *h = NULL;
492 AVIODirContext *ctx = NULL;
496 ctx = av_mallocz(sizeof(*ctx));
498 ret = AVERROR(ENOMEM);
502 if ((ret = ffurl_alloc(&h, url, AVIO_FLAG_READ, NULL)) < 0)
505 if (h->prot->url_open_dir && h->prot->url_read_dir && h->prot->url_close_dir) {
506 if (options && h->prot->priv_data_class &&
507 (ret = av_opt_set_dict(h->priv_data, options)) < 0)
509 ret = h->prot->url_open_dir(h);
511 ret = AVERROR(ENOSYS);
516 ctx->url_context = h;
527 int avio_read_dir(AVIODirContext *s, AVIODirEntry **next)
532 if (!s || !s->url_context)
533 return AVERROR(EINVAL);
535 if ((ret = h->prot->url_read_dir(h, next)) < 0)
536 avio_free_directory_entry(next);
540 int avio_close_dir(AVIODirContext **s)
545 if (!(*s) || !(*s)->url_context)
546 return AVERROR(EINVAL);
547 h = (*s)->url_context;
548 h->prot->url_close_dir(h);
555 void avio_free_directory_entry(AVIODirEntry **entry)
557 if (!entry || !*entry)
559 av_free((*entry)->name);
563 int64_t ffurl_size(URLContext *h)
567 size = ffurl_seek(h, 0, AVSEEK_SIZE);
569 pos = ffurl_seek(h, 0, SEEK_CUR);
570 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
573 ffurl_seek(h, pos, SEEK_SET);
578 int ffurl_get_file_handle(URLContext *h)
580 if (!h->prot->url_get_file_handle)
582 return h->prot->url_get_file_handle(h);
585 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
587 if (!h->prot->url_get_multi_file_handle) {
588 if (!h->prot->url_get_file_handle)
589 return AVERROR(ENOSYS);
590 *handles = av_malloc(sizeof(**handles));
592 return AVERROR(ENOMEM);
594 *handles[0] = h->prot->url_get_file_handle(h);
597 return h->prot->url_get_multi_file_handle(h, handles, numhandles);
600 int ffurl_shutdown(URLContext *h, int flags)
602 if (!h->prot->url_shutdown)
603 return AVERROR(EINVAL);
604 return h->prot->url_shutdown(h, flags);
607 int ff_check_interrupt(AVIOInterruptCB *cb)
610 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))