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
24 #include "libavutil/avstring.h"
25 #include "libavutil/dict.h"
26 #include "libavutil/opt.h"
27 #include "os_support.h"
34 static URLProtocol *first_protocol = NULL;
36 URLProtocol *ffurl_protocol_next(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;
46 if(h->prot) return h->prot->name;
50 static void *urlcontext_child_next(void *obj, void *prev)
53 if (!prev && h->priv_data && h->prot->priv_data_class)
58 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
60 URLProtocol *p = NULL;
62 /* find the protocol that corresponds to prev */
63 while (prev && (p = ffurl_protocol_next(p)))
64 if (p->priv_data_class == prev)
67 /* find next protocol with priv options */
68 while (p = ffurl_protocol_next(p))
69 if (p->priv_data_class)
70 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,
87 #if FF_API_OLD_INTERRUPT_CB
88 static int default_interrupt_cb(void);
89 int (*url_interrupt_cb)(void) = default_interrupt_cb;
93 URLProtocol *av_protocol_next(URLProtocol *p)
95 return ffurl_protocol_next(p);
99 const char *avio_enum_protocols(void **opaque, int output)
101 URLProtocol **p = opaque;
102 *p = ffurl_protocol_next(*p);
103 if (!*p) return NULL;
104 if ((output && (*p)->url_write) || (!output && (*p)->url_read))
106 return avio_enum_protocols(opaque, output);
109 int ffurl_register_protocol(URLProtocol *protocol, int size)
112 if (size < sizeof(URLProtocol)) {
113 URLProtocol* temp = av_mallocz(sizeof(URLProtocol));
114 memcpy(temp, protocol, size);
118 while (*p != NULL) p = &(*p)->next;
120 protocol->next = NULL;
124 static int url_alloc_for_protocol (URLContext **puc, struct URLProtocol *up,
125 const char *filename, int flags,
126 const AVIOInterruptCB *int_cb)
132 if (!ff_network_init())
135 uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
137 err = AVERROR(ENOMEM);
140 uc->av_class = &ffurl_context_class;
141 uc->filename = (char *) &uc[1];
142 strcpy(uc->filename, filename);
145 uc->is_streamed = 0; /* default = not streamed */
146 uc->max_packet_size = 0; /* default: stream file */
147 if (up->priv_data_size) {
148 uc->priv_data = av_mallocz(up->priv_data_size);
149 if (up->priv_data_class) {
150 *(const AVClass**)uc->priv_data = up->priv_data_class;
151 av_opt_set_defaults(uc->priv_data);
155 uc->interrupt_callback = *int_cb;
167 int ffurl_connect(URLContext* uc, AVDictionary **options)
171 uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
173 uc->prot->url_open(uc, uc->filename, uc->flags);
176 uc->is_connected = 1;
177 //We must be careful here as ffurl_seek() could be slow, for example for http
178 if( (uc->flags & AVIO_FLAG_WRITE)
179 || !strcmp(uc->prot->name, "file"))
180 if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
186 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
187 const char *filename, int flags)
191 ret = url_alloc_for_protocol(puc, up, filename, flags, NULL);
194 ret = ffurl_connect(*puc, NULL);
202 int url_alloc(URLContext **puc, const char *filename, int flags)
204 return ffurl_alloc(puc, filename, flags, NULL);
206 int url_connect(URLContext* uc)
208 return ffurl_connect(uc, NULL);
210 int url_open(URLContext **puc, const char *filename, int flags)
212 return ffurl_open(puc, filename, flags, NULL, NULL);
214 int url_read(URLContext *h, unsigned char *buf, int size)
216 return ffurl_read(h, buf, size);
218 int url_read_complete(URLContext *h, unsigned char *buf, int size)
220 return ffurl_read_complete(h, buf, size);
222 int url_write(URLContext *h, const unsigned char *buf, int size)
224 return ffurl_write(h, buf, size);
226 int64_t url_seek(URLContext *h, int64_t pos, int whence)
228 return ffurl_seek(h, pos, whence);
230 int url_close(URLContext *h)
232 return ffurl_close(h);
234 int64_t url_filesize(URLContext *h)
236 return ffurl_size(h);
238 int url_get_file_handle(URLContext *h)
240 return ffurl_get_file_handle(h);
242 int url_get_max_packet_size(URLContext *h)
244 return h->max_packet_size;
246 void url_get_filename(URLContext *h, char *buf, int buf_size)
248 av_strlcpy(buf, h->filename, buf_size);
250 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb)
252 avio_set_interrupt_cb(interrupt_cb);
254 int av_register_protocol2(URLProtocol *protocol, int size)
256 return ffurl_register_protocol(protocol, size);
260 #define URL_SCHEME_CHARS \
261 "abcdefghijklmnopqrstuvwxyz" \
262 "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
265 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
266 const AVIOInterruptCB *int_cb)
268 URLProtocol *up = NULL;
269 char proto_str[128], proto_nested[128], *ptr;
270 size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
272 if (filename[proto_len] != ':' || is_dos_path(filename))
273 strcpy(proto_str, "file");
275 av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
277 av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
278 if ((ptr = strchr(proto_nested, '+')))
281 while (up = ffurl_protocol_next(up)) {
282 if (!strcmp(proto_str, up->name))
283 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
284 if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
285 !strcmp(proto_nested, up->name))
286 return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
289 return AVERROR(ENOENT);
292 int ffurl_open(URLContext **puc, const char *filename, int flags,
293 const AVIOInterruptCB *int_cb, AVDictionary **options)
295 int ret = ffurl_alloc(puc, filename, flags, int_cb);
298 if (options && (*puc)->prot->priv_data_class &&
299 (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
301 ret = ffurl_connect(*puc, options);
310 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
311 int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
314 int fast_retries = 5;
317 while (len < size_min) {
318 ret = transfer_func(h, buf+len, size-len);
319 if (ret == AVERROR(EINTR))
321 if (h->flags & AVIO_FLAG_NONBLOCK)
323 if (ret == AVERROR(EAGAIN)) {
330 return ret < 0 ? ret : len;
332 fast_retries = FFMAX(fast_retries, 2);
334 if (ff_check_interrupt(&h->interrupt_callback))
340 int ffurl_read(URLContext *h, unsigned char *buf, int size)
342 if (!(h->flags & AVIO_FLAG_READ))
344 return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
347 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
349 if (!(h->flags & AVIO_FLAG_READ))
351 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
354 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
356 if (!(h->flags & AVIO_FLAG_WRITE))
358 /* avoid sending too big packets */
359 if (h->max_packet_size && size > h->max_packet_size)
362 return retry_transfer_wrapper(h, buf, size, size, h->prot->url_write);
365 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
369 if (!h->prot->url_seek)
370 return AVERROR(ENOSYS);
371 ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
375 int ffurl_close(URLContext *h)
378 if (!h) return 0; /* can happen when ffurl_open fails */
380 if (h->is_connected && h->prot->url_close)
381 ret = h->prot->url_close(h);
385 if (h->prot->priv_data_size) {
386 if (h->prot->priv_data_class)
387 av_opt_free(h->priv_data);
388 av_free(h->priv_data);
395 int url_exist(const char *filename)
398 if (ffurl_open(&h, filename, AVIO_FLAG_READ, NULL, NULL) < 0)
405 int avio_check(const char *url, int flags)
408 int ret = ffurl_alloc(&h, url, flags, NULL);
412 if (h->prot->url_check) {
413 ret = h->prot->url_check(h, flags);
415 ret = ffurl_connect(h, NULL);
424 int64_t ffurl_size(URLContext *h)
428 size= ffurl_seek(h, 0, AVSEEK_SIZE);
430 pos = ffurl_seek(h, 0, SEEK_CUR);
431 if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
434 ffurl_seek(h, pos, SEEK_SET);
439 int ffurl_get_file_handle(URLContext *h)
441 if (!h->prot->url_get_file_handle)
443 return h->prot->url_get_file_handle(h);
446 #if FF_API_OLD_INTERRUPT_CB
447 static int default_interrupt_cb(void)
452 void avio_set_interrupt_cb(int (*interrupt_cb)(void))
455 interrupt_cb = default_interrupt_cb;
456 url_interrupt_cb = interrupt_cb;
460 int ff_check_interrupt(AVIOInterruptCB *cb)
463 if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
465 #if FF_API_OLD_INTERRUPT_CB
466 return url_interrupt_cb();
473 int av_url_read_pause(URLContext *h, int pause)
475 if (!h->prot->url_read_pause)
476 return AVERROR(ENOSYS);
477 return h->prot->url_read_pause(h, pause);
480 int64_t av_url_read_seek(URLContext *h,
481 int stream_index, int64_t timestamp, int flags)
483 if (!h->prot->url_read_seek)
484 return AVERROR(ENOSYS);
485 return h->prot->url_read_seek(h, stream_index, timestamp, flags);