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(const 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)
104 protocol->next = NULL;
108 static int url_alloc_for_protocol(URLContext **puc, struct URLProtocol *up,
109 const char *filename, int flags,
110 const AVIOInterruptCB *int_cb)
116 if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
119 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
121 err = AVERROR(ENOMEM);
124 uc->av_class = &ffurl_context_class;
125 uc->filename = (char *)&uc[1];
126 strcpy(uc->filename, filename);
129 uc->is_streamed = 0; /* default = not streamed */
130 uc->max_packet_size = 0; /* default: stream file */
131 if (up->priv_data_size) {
132 uc->priv_data = av_mallocz(up->priv_data_size);
133 if (!uc->priv_data) {
134 err = AVERROR(ENOMEM);
137 if (up->priv_data_class) {
138 *(const AVClass **)uc->priv_data = up->priv_data_class;
139 av_opt_set_defaults(uc->priv_data);
143 uc->interrupt_callback = *int_cb;
150 av_freep(&uc->priv_data);
153 if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
159 int ffurl_connect(URLContext *uc, AVDictionary **options)
162 uc->prot->url_open2 ? uc->prot->url_open2(uc,
166 uc->prot->url_open(uc, uc->filename, uc->flags);
169 uc->is_connected = 1;
170 /* We must be careful here as ffurl_seek() could be slow,
171 * for example for http */
172 if ((uc->flags & AVIO_FLAG_WRITE) || !strcmp(uc->prot->name, "file"))
173 if (!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
178 #define URL_SCHEME_CHARS \
179 "abcdefghijklmnopqrstuvwxyz" \
180 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
183 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
184 const AVIOInterruptCB *int_cb)
186 URLProtocol *up = NULL;
187 char proto_str[128], proto_nested[128], *ptr;
188 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
190 if (filename[proto_len] != ':' || is_dos_path(filename))
191 strcpy(proto_str, "file");
193 av_strlcpy(proto_str, filename,
194 FFMIN(proto_len + 1, sizeof(proto_str)));
196 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
197 if ((ptr = strchr(proto_nested, '+')))
200 while (up = ffurl_protocol_next(up)) {
201 if (!strcmp(proto_str, up->name))
202 return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
203 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
204 !strcmp(proto_nested, up->name))
205 return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
208 return AVERROR_PROTOCOL_NOT_FOUND;
211 int ffurl_open(URLContext **puc, const char *filename, int flags,
212 const AVIOInterruptCB *int_cb, AVDictionary **options)
214 int ret = ffurl_alloc(puc, filename, flags, int_cb);
217 if (options && (*puc)->prot->priv_data_class &&
218 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
220 ret = ffurl_connect(*puc, options);
229 static inline int retry_transfer_wrapper(URLContext *h, uint8_t *buf,
230 int size, int size_min,
231 int (*transfer_func)(URLContext *h,
236 int fast_retries = 5;
239 while (len < size_min) {
240 ret = transfer_func(h, buf + len, size - len);
241 if (ret == AVERROR(EINTR))
243 if (h->flags & AVIO_FLAG_NONBLOCK)
245 if (ret == AVERROR(EAGAIN)) {
252 return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
254 fast_retries = FFMAX(fast_retries, 2);
256 if (ff_check_interrupt(&h->interrupt_callback))
262 int ffurl_read(URLContext *h, unsigned char *buf, int size)
264 if (!(h->flags & AVIO_FLAG_READ))
266 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
269 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
271 if (!(h->flags & AVIO_FLAG_READ))
273 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
276 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
278 if (!(h->flags & AVIO_FLAG_WRITE))
280 /* avoid sending too big packets */
281 if (h->max_packet_size && size > h->max_packet_size)
284 return retry_transfer_wrapper(h, buf, size, size,
285 (int (*)(struct URLContext *, uint8_t *, int))
289 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
293 if (!h->prot->url_seek)
294 return AVERROR(ENOSYS);
295 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
299 int ffurl_close(URLContext *h)
303 return 0; /* can happen when ffurl_open fails */
305 if (h->is_connected && h->prot->url_close)
306 ret = h->prot->url_close(h);
308 if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
311 if (h->prot->priv_data_size) {
312 if (h->prot->priv_data_class)
313 av_opt_free(h->priv_data);
314 av_free(h->priv_data);
320 int avio_check(const char *url, int flags)
323 int ret = ffurl_alloc(&h, url, flags, NULL);
327 if (h->prot->url_check) {
328 ret = h->prot->url_check(h, flags);
330 ret = ffurl_connect(h, NULL);
339 int64_t ffurl_size(URLContext *h)
343 size = ffurl_seek(h, 0, AVSEEK_SIZE);
345 pos = ffurl_seek(h, 0, SEEK_CUR);
346 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
349 ffurl_seek(h, pos, SEEK_SET);
354 int ffurl_get_file_handle(URLContext *h)
356 if (!h->prot->url_get_file_handle)
358 return h->prot->url_get_file_handle(h);
361 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
363 if (!h->prot->url_get_multi_file_handle) {
364 if (!h->prot->url_get_file_handle)
365 return AVERROR(ENOSYS);
366 *handles = av_malloc(sizeof(**handles));
368 return AVERROR(ENOMEM);
370 *handles[0] = h->prot->url_get_file_handle(h);
373 return h->prot->url_get_multi_file_handle(h, handles, numhandles);
376 int ffurl_shutdown(URLContext *h, int flags)
378 if (!h->prot->url_shutdown)
379 return AVERROR(EINVAL);
380 return h->prot->url_shutdown(h, flags);
383 int ff_check_interrupt(AVIOInterruptCB *cb)
386 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))