avio: K&R formatting cosmetics
[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 "libavutil/avstring.h"
23 #include "libavutil/dict.h"
24 #include "libavutil/opt.h"
25 #include "libavutil/time.h"
26 #include "os_support.h"
27 #include "avformat.h"
28 #if CONFIG_NETWORK
29 #include "network.h"
30 #endif
31 #include "url.h"
32
33 static URLProtocol *first_protocol = NULL;
34
35 URLProtocol *ffurl_protocol_next(URLProtocol *prev)
36 {
37     return prev ? prev->next : first_protocol;
38 }
39
40 /** @name Logging context. */
41 /*@{*/
42 static const char *urlcontext_to_name(void *ptr)
43 {
44     URLContext *h = (URLContext *)ptr;
45     if (h->prot)
46         return h->prot->name;
47     else
48         return "NULL";
49 }
50
51 static void *urlcontext_child_next(void *obj, void *prev)
52 {
53     URLContext *h = obj;
54     if (!prev && h->priv_data && h->prot->priv_data_class)
55         return h->priv_data;
56     return NULL;
57 }
58
59 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
60 {
61     URLProtocol *p = NULL;
62
63     /* find the protocol that corresponds to prev */
64     while (prev && (p = ffurl_protocol_next(p)))
65         if (p->priv_data_class == prev)
66             break;
67
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;
72     return NULL;
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 const char *avio_enum_protocols(void **opaque, int output)
87 {
88     URLProtocol *p;
89     *opaque = ffurl_protocol_next(*opaque);
90     if (!(p = *opaque))
91         return NULL;
92     if ((output && p->url_write) || (!output && p->url_read))
93         return p->name;
94     return avio_enum_protocols(opaque, output);
95 }
96
97 int ffurl_register_protocol(URLProtocol *protocol, int size)
98 {
99     URLProtocol **p;
100     if (size < sizeof(URLProtocol)) {
101         URLProtocol *temp = av_mallocz(sizeof(URLProtocol));
102         memcpy(temp, protocol, size);
103         protocol = temp;
104     }
105     p = &first_protocol;
106     while (*p != NULL)
107         p = &(*p)->next;
108     *p             = protocol;
109     protocol->next = NULL;
110     return 0;
111 }
112
113 static int url_alloc_for_protocol(URLContext **puc, struct URLProtocol *up,
114                                   const char *filename, int flags,
115                                   const AVIOInterruptCB *int_cb)
116 {
117     URLContext *uc;
118     int err;
119
120 #if CONFIG_NETWORK
121     if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
122         return AVERROR(EIO);
123 #endif
124     uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
125     if (!uc) {
126         err = AVERROR(ENOMEM);
127         goto fail;
128     }
129     uc->av_class = &ffurl_context_class;
130     uc->filename = (char *)&uc[1];
131     strcpy(uc->filename, filename);
132     uc->prot            = up;
133     uc->flags           = flags;
134     uc->is_streamed     = 0; /* default = not streamed */
135     uc->max_packet_size = 0; /* default: stream file */
136     if (up->priv_data_size) {
137         uc->priv_data = av_mallocz(up->priv_data_size);
138         if (up->priv_data_class) {
139             *(const AVClass **)uc->priv_data = up->priv_data_class;
140             av_opt_set_defaults(uc->priv_data);
141         }
142     }
143     if (int_cb)
144         uc->interrupt_callback = *int_cb;
145
146     *puc = uc;
147     return 0;
148 fail:
149     *puc = NULL;
150 #if CONFIG_NETWORK
151     if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
152         ff_network_close();
153 #endif
154     return err;
155 }
156
157 int ffurl_connect(URLContext *uc, AVDictionary **options)
158 {
159     int err =
160         uc->prot->url_open2 ? uc->prot->url_open2(uc,
161                                                   uc->filename,
162                                                   uc->flags,
163                                                   options) :
164         uc->prot->url_open(uc, uc->filename, uc->flags);
165     if (err)
166         return err;
167     uc->is_connected = 1;
168     /* We must be careful here as ffurl_seek() could be slow,
169      * for example for http */
170     if ((uc->flags & AVIO_FLAG_WRITE) || !strcmp(uc->prot->name, "file"))
171         if (!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
172             uc->is_streamed = 1;
173     return 0;
174 }
175
176 #define URL_SCHEME_CHARS                        \
177     "abcdefghijklmnopqrstuvwxyz"                \
178     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"                \
179     "0123456789+-."
180
181 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
182                 const AVIOInterruptCB *int_cb)
183 {
184     URLProtocol *up = NULL;
185     char proto_str[128], proto_nested[128], *ptr;
186     size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
187
188     if (filename[proto_len] != ':' || is_dos_path(filename))
189         strcpy(proto_str, "file");
190     else
191         av_strlcpy(proto_str, filename,
192                    FFMIN(proto_len + 1, sizeof(proto_str)));
193
194     av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
195     if ((ptr = strchr(proto_nested, '+')))
196         *ptr = '\0';
197
198     while (up = ffurl_protocol_next(up)) {
199         if (!strcmp(proto_str, up->name))
200             return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
201         if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
202             !strcmp(proto_nested, up->name))
203             return url_alloc_for_protocol(puc, up, filename, flags, int_cb);
204     }
205     *puc = NULL;
206     return AVERROR_PROTOCOL_NOT_FOUND;
207 }
208
209 int ffurl_open(URLContext **puc, const char *filename, int flags,
210                const AVIOInterruptCB *int_cb, AVDictionary **options)
211 {
212     int ret = ffurl_alloc(puc, filename, flags, int_cb);
213     if (ret)
214         return ret;
215     if (options && (*puc)->prot->priv_data_class &&
216         (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
217         goto fail;
218     ret = ffurl_connect(*puc, options);
219     if (!ret)
220         return 0;
221 fail:
222     ffurl_close(*puc);
223     *puc = NULL;
224     return ret;
225 }
226
227 static inline int retry_transfer_wrapper(URLContext *h, uint8_t *buf,
228                                          int size, int size_min,
229                                          int (*transfer_func)(URLContext *h,
230                                                               uint8_t *buf,
231                                                               int size))
232 {
233     int ret, len;
234     int fast_retries = 5;
235
236     len = 0;
237     while (len < size_min) {
238         ret = transfer_func(h, buf + len, size - len);
239         if (ret == AVERROR(EINTR))
240             continue;
241         if (h->flags & AVIO_FLAG_NONBLOCK)
242             return ret;
243         if (ret == AVERROR(EAGAIN)) {
244             ret = 0;
245             if (fast_retries)
246                 fast_retries--;
247             else
248                 av_usleep(1000);
249         } else if (ret < 1)
250             return (ret < 0 && ret != AVERROR_EOF) ? ret : len;
251         if (ret)
252             fast_retries = FFMAX(fast_retries, 2);
253         len += ret;
254         if (ff_check_interrupt(&h->interrupt_callback))
255             return AVERROR_EXIT;
256     }
257     return len;
258 }
259
260 int ffurl_read(URLContext *h, unsigned char *buf, int size)
261 {
262     if (!(h->flags & AVIO_FLAG_READ))
263         return AVERROR(EIO);
264     return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
265 }
266
267 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
268 {
269     if (!(h->flags & AVIO_FLAG_READ))
270         return AVERROR(EIO);
271     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
272 }
273
274 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
275 {
276     if (!(h->flags & AVIO_FLAG_WRITE))
277         return AVERROR(EIO);
278     /* avoid sending too big packets */
279     if (h->max_packet_size && size > h->max_packet_size)
280         return AVERROR(EIO);
281
282     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_write);
283 }
284
285 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
286 {
287     int64_t ret;
288
289     if (!h->prot->url_seek)
290         return AVERROR(ENOSYS);
291     ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
292     return ret;
293 }
294
295 int ffurl_close(URLContext *h)
296 {
297     int ret = 0;
298     if (!h)
299         return 0;     /* can happen when ffurl_open fails */
300
301     if (h->is_connected && h->prot->url_close)
302         ret = h->prot->url_close(h);
303 #if CONFIG_NETWORK
304     if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
305         ff_network_close();
306 #endif
307     if (h->prot->priv_data_size) {
308         if (h->prot->priv_data_class)
309             av_opt_free(h->priv_data);
310         av_free(h->priv_data);
311     }
312     av_free(h);
313     return ret;
314 }
315
316 int avio_check(const char *url, int flags)
317 {
318     URLContext *h;
319     int ret = ffurl_alloc(&h, url, flags, NULL);
320     if (ret)
321         return ret;
322
323     if (h->prot->url_check) {
324         ret = h->prot->url_check(h, flags);
325     } else {
326         ret = ffurl_connect(h, NULL);
327         if (ret >= 0)
328             ret = flags;
329     }
330
331     ffurl_close(h);
332     return ret;
333 }
334
335 int64_t ffurl_size(URLContext *h)
336 {
337     int64_t pos, size;
338
339     size = ffurl_seek(h, 0, AVSEEK_SIZE);
340     if (size < 0) {
341         pos = ffurl_seek(h, 0, SEEK_CUR);
342         if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
343             return size;
344         size++;
345         ffurl_seek(h, pos, SEEK_SET);
346     }
347     return size;
348 }
349
350 int ffurl_get_file_handle(URLContext *h)
351 {
352     if (!h->prot->url_get_file_handle)
353         return -1;
354     return h->prot->url_get_file_handle(h);
355 }
356
357 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
358 {
359     if (!h->prot->url_get_multi_file_handle) {
360         if (!h->prot->url_get_file_handle)
361             return AVERROR(ENOSYS);
362         *handles = av_malloc(sizeof(*handles));
363         if (!*handles)
364             return AVERROR(ENOMEM);
365         *numhandles = 1;
366         *handles[0] = h->prot->url_get_file_handle(h);
367         return 0;
368     }
369     return h->prot->url_get_multi_file_handle(h, handles, numhandles);
370 }
371
372 int ffurl_shutdown(URLContext *h, int flags)
373 {
374     if (!h->prot->url_shutdown)
375         return AVERROR(EINVAL);
376     return h->prot->url_shutdown(h, flags);
377 }
378
379 int ff_check_interrupt(AVIOInterruptCB *cb)
380 {
381     int ret;
382     if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
383         return ret;
384     return 0;
385 }