avio: add avio_open2, taking an interrupt callback and options
[ffmpeg.git] / libavformat / avio.c
1 /*
2  * unbuffered I/O
3  * Copyright (c) 2001 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 #include <unistd.h>
23
24 #include "libavutil/avstring.h"
25 #include "libavutil/dict.h"
26 #include "libavutil/opt.h"
27 #include "os_support.h"
28 #include "avformat.h"
29 #if CONFIG_NETWORK
30 #include "network.h"
31 #endif
32 #include "url.h"
33
34 static URLProtocol *first_protocol = NULL;
35
36 URLProtocol *ffurl_protocol_next(URLProtocol *prev)
37 {
38     return prev ? prev->next : first_protocol;
39 }
40
41 /** @name Logging context. */
42 /*@{*/
43 static const char *urlcontext_to_name(void *ptr)
44 {
45     URLContext *h = (URLContext *)ptr;
46     if(h->prot) return h->prot->name;
47     else        return "NULL";
48 }
49
50 static void *urlcontext_child_next(void *obj, void *prev)
51 {
52     URLContext *h = obj;
53     if (!prev && h->priv_data && h->prot->priv_data_class)
54         return h->priv_data;
55     return NULL;
56 }
57
58 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
59 {
60     URLProtocol *p = NULL;
61
62     /* find the protocol that corresponds to prev */
63     while (prev && (p = ffurl_protocol_next(p)))
64         if (p->priv_data_class == prev)
65             break;
66
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;
71     return NULL;
72
73 }
74
75 static const AVOption options[] = {{NULL}};
76 const AVClass ffurl_context_class = {
77     .class_name     = "URLContext",
78     .item_name      = urlcontext_to_name,
79     .option         = options,
80     .version        = LIBAVUTIL_VERSION_INT,
81     .child_next     = urlcontext_child_next,
82     .child_class_next = urlcontext_child_class_next,
83 };
84 /*@}*/
85
86 static int default_interrupt_cb(void);
87
88 int (*url_interrupt_cb)(void) = default_interrupt_cb;
89
90 #if FF_API_OLD_AVIO
91 URLProtocol *av_protocol_next(URLProtocol *p)
92 {
93     return ffurl_protocol_next(p);
94 }
95 #endif
96
97 const char *avio_enum_protocols(void **opaque, int output)
98 {
99     URLProtocol **p = opaque;
100     *p = ffurl_protocol_next(*p);
101     if (!*p) return NULL;
102     if ((output && (*p)->url_write) || (!output && (*p)->url_read))
103         return (*p)->name;
104     return avio_enum_protocols(opaque, output);
105 }
106
107 int ffurl_register_protocol(URLProtocol *protocol, int size)
108 {
109     URLProtocol **p;
110     if (size < sizeof(URLProtocol)) {
111         URLProtocol* temp = av_mallocz(sizeof(URLProtocol));
112         memcpy(temp, protocol, size);
113         protocol = temp;
114     }
115     p = &first_protocol;
116     while (*p != NULL) p = &(*p)->next;
117     *p = protocol;
118     protocol->next = NULL;
119     return 0;
120 }
121
122 static int url_alloc_for_protocol (URLContext **puc, struct URLProtocol *up,
123                                    const char *filename, int flags,
124                                    const AVIOInterruptCB *int_cb)
125 {
126     URLContext *uc;
127     int err;
128
129 #if CONFIG_NETWORK
130     if (!ff_network_init())
131         return AVERROR(EIO);
132 #endif
133     uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
134     if (!uc) {
135         err = AVERROR(ENOMEM);
136         goto fail;
137     }
138     uc->av_class = &ffurl_context_class;
139     uc->filename = (char *) &uc[1];
140     strcpy(uc->filename, filename);
141     uc->prot = up;
142     uc->flags = flags;
143     uc->is_streamed = 0; /* default = not streamed */
144     uc->max_packet_size = 0; /* default: stream file */
145     if (up->priv_data_size) {
146         uc->priv_data = av_mallocz(up->priv_data_size);
147         if (up->priv_data_class) {
148             *(const AVClass**)uc->priv_data = up->priv_data_class;
149             av_opt_set_defaults(uc->priv_data);
150         }
151     }
152     if (int_cb)
153         uc->interrupt_callback = *int_cb;
154
155     *puc = uc;
156     return 0;
157  fail:
158     *puc = NULL;
159 #if CONFIG_NETWORK
160     ff_network_close();
161 #endif
162     return err;
163 }
164
165 int ffurl_connect(URLContext* uc, AVDictionary **options)
166 {
167     int err =
168 #if !FF_API_OLD_AVIO
169         uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
170 #endif
171         uc->prot->url_open(uc, uc->filename, uc->flags);
172     if (err)
173         return err;
174     uc->is_connected = 1;
175     //We must be careful here as ffurl_seek() could be slow, for example for http
176     if(   (uc->flags & AVIO_FLAG_WRITE)
177        || !strcmp(uc->prot->name, "file"))
178         if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
179             uc->is_streamed= 1;
180     return 0;
181 }
182
183 #if FF_API_OLD_AVIO
184 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
185                        const char *filename, int flags)
186 {
187     int ret;
188
189     ret = url_alloc_for_protocol(puc, up, filename, flags, NULL);
190     if (ret)
191         goto fail;
192     ret = ffurl_connect(*puc, NULL);
193     if (!ret)
194         return 0;
195  fail:
196     ffurl_close(*puc);
197     *puc = NULL;
198     return ret;
199 }
200 int url_alloc(URLContext **puc, const char *filename, int flags)
201 {
202     return ffurl_alloc(puc, filename, flags, NULL);
203 }
204 int url_connect(URLContext* uc)
205 {
206     return ffurl_connect(uc, NULL);
207 }
208 int url_open(URLContext **puc, const char *filename, int flags)
209 {
210     return ffurl_open(puc, filename, flags, NULL, NULL);
211 }
212 int url_read(URLContext *h, unsigned char *buf, int size)
213 {
214     return ffurl_read(h, buf, size);
215 }
216 int url_read_complete(URLContext *h, unsigned char *buf, int size)
217 {
218     return ffurl_read_complete(h, buf, size);
219 }
220 int url_write(URLContext *h, const unsigned char *buf, int size)
221 {
222     return ffurl_write(h, buf, size);
223 }
224 int64_t url_seek(URLContext *h, int64_t pos, int whence)
225 {
226     return ffurl_seek(h, pos, whence);
227 }
228 int url_close(URLContext *h)
229 {
230     return ffurl_close(h);
231 }
232 int64_t url_filesize(URLContext *h)
233 {
234     return ffurl_size(h);
235 }
236 int url_get_file_handle(URLContext *h)
237 {
238     return ffurl_get_file_handle(h);
239 }
240 int url_get_max_packet_size(URLContext *h)
241 {
242     return h->max_packet_size;
243 }
244 void url_get_filename(URLContext *h, char *buf, int buf_size)
245 {
246     av_strlcpy(buf, h->filename, buf_size);
247 }
248 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb)
249 {
250     avio_set_interrupt_cb(interrupt_cb);
251 }
252 int av_register_protocol2(URLProtocol *protocol, int size)
253 {
254     return ffurl_register_protocol(protocol, size);
255 }
256 #endif
257
258 #define URL_SCHEME_CHARS                        \
259     "abcdefghijklmnopqrstuvwxyz"                \
260     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"                \
261     "0123456789+-."
262
263 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
264                 const AVIOInterruptCB *int_cb)
265 {
266     URLProtocol *up = NULL;
267     char proto_str[128], proto_nested[128], *ptr;
268     size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
269
270     if (filename[proto_len] != ':' || is_dos_path(filename))
271         strcpy(proto_str, "file");
272     else
273         av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
274
275     av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
276     if ((ptr = strchr(proto_nested, '+')))
277         *ptr = '\0';
278
279     while (up = ffurl_protocol_next(up)) {
280         if (!strcmp(proto_str, up->name))
281             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
282         if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
283             !strcmp(proto_nested, up->name))
284             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
285     }
286     *puc = NULL;
287     return AVERROR(ENOENT);
288 }
289
290 int ffurl_open(URLContext **puc, const char *filename, int flags,
291                const AVIOInterruptCB *int_cb, AVDictionary **options)
292 {
293     int ret = ffurl_alloc(puc, filename, flags, int_cb);
294     if (ret)
295         return ret;
296     if (options && (*puc)->prot->priv_data_class &&
297         (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
298         goto fail;
299     ret = ffurl_connect(*puc, options);
300     if (!ret)
301         return 0;
302 fail:
303     ffurl_close(*puc);
304     *puc = NULL;
305     return ret;
306 }
307
308 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
309                                          int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
310 {
311     int ret, len;
312     int fast_retries = 5;
313
314     len = 0;
315     while (len < size_min) {
316         ret = transfer_func(h, buf+len, size-len);
317         if (ret == AVERROR(EINTR))
318             continue;
319         if (h->flags & AVIO_FLAG_NONBLOCK)
320             return ret;
321         if (ret == AVERROR(EAGAIN)) {
322             ret = 0;
323             if (fast_retries)
324                 fast_retries--;
325             else
326                 usleep(1000);
327         } else if (ret < 1)
328             return ret < 0 ? ret : len;
329         if (ret)
330            fast_retries = FFMAX(fast_retries, 2);
331         len += ret;
332         if (ff_check_interrupt(&h->interrupt_callback))
333             return AVERROR_EXIT;
334     }
335     return len;
336 }
337
338 int ffurl_read(URLContext *h, unsigned char *buf, int size)
339 {
340     if (!(h->flags & AVIO_FLAG_READ))
341         return AVERROR(EIO);
342     return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
343 }
344
345 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
346 {
347     if (!(h->flags & AVIO_FLAG_READ))
348         return AVERROR(EIO);
349     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
350 }
351
352 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
353 {
354     if (!(h->flags & AVIO_FLAG_WRITE))
355         return AVERROR(EIO);
356     /* avoid sending too big packets */
357     if (h->max_packet_size && size > h->max_packet_size)
358         return AVERROR(EIO);
359
360     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_write);
361 }
362
363 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
364 {
365     int64_t ret;
366
367     if (!h->prot->url_seek)
368         return AVERROR(ENOSYS);
369     ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
370     return ret;
371 }
372
373 int ffurl_close(URLContext *h)
374 {
375     int ret = 0;
376     if (!h) return 0; /* can happen when ffurl_open fails */
377
378     if (h->is_connected && h->prot->url_close)
379         ret = h->prot->url_close(h);
380 #if CONFIG_NETWORK
381     ff_network_close();
382 #endif
383     if (h->prot->priv_data_size) {
384         if (h->prot->priv_data_class)
385             av_opt_free(h->priv_data);
386         av_free(h->priv_data);
387     }
388     av_free(h);
389     return ret;
390 }
391
392 #if FF_API_OLD_AVIO
393 int url_exist(const char *filename)
394 {
395     URLContext *h;
396     if (ffurl_open(&h, filename, AVIO_FLAG_READ, NULL, NULL) < 0)
397         return 0;
398     ffurl_close(h);
399     return 1;
400 }
401 #endif
402
403 int avio_check(const char *url, int flags)
404 {
405     URLContext *h;
406     int ret = ffurl_alloc(&h, url, flags, NULL);
407     if (ret)
408         return ret;
409
410     if (h->prot->url_check) {
411         ret = h->prot->url_check(h, flags);
412     } else {
413         ret = ffurl_connect(h, NULL);
414         if (ret >= 0)
415             ret = flags;
416     }
417
418     ffurl_close(h);
419     return ret;
420 }
421
422 int64_t ffurl_size(URLContext *h)
423 {
424     int64_t pos, size;
425
426     size= ffurl_seek(h, 0, AVSEEK_SIZE);
427     if(size<0){
428         pos = ffurl_seek(h, 0, SEEK_CUR);
429         if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
430             return size;
431         size++;
432         ffurl_seek(h, pos, SEEK_SET);
433     }
434     return size;
435 }
436
437 int ffurl_get_file_handle(URLContext *h)
438 {
439     if (!h->prot->url_get_file_handle)
440         return -1;
441     return h->prot->url_get_file_handle(h);
442 }
443
444 static int default_interrupt_cb(void)
445 {
446     return 0;
447 }
448
449 void avio_set_interrupt_cb(int (*interrupt_cb)(void))
450 {
451     if (!interrupt_cb)
452         interrupt_cb = default_interrupt_cb;
453     url_interrupt_cb = interrupt_cb;
454 }
455
456 int ff_check_interrupt(AVIOInterruptCB *cb)
457 {
458     int ret;
459     if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
460         return ret;
461     return url_interrupt_cb();
462 }
463
464 #if FF_API_OLD_AVIO
465 int av_url_read_pause(URLContext *h, int pause)
466 {
467     if (!h->prot->url_read_pause)
468         return AVERROR(ENOSYS);
469     return h->prot->url_read_pause(h, pause);
470 }
471
472 int64_t av_url_read_seek(URLContext *h,
473         int stream_index, int64_t timestamp, int flags)
474 {
475     if (!h->prot->url_read_seek)
476         return AVERROR(ENOSYS);
477     return h->prot->url_read_seek(h, stream_index, timestamp, flags);
478 }
479 #endif