git.sesse.net Git - ffmpeg/blob - libavformat/avio.c

   1 /*
   2  * unbuffered I/O
   3  * Copyright (c) 2001 Fabrice Bellard
   4  *
   5  * This file is part of FFmpeg.
   6  *
   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.
  11  *
  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.
  16  *
  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
  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) return h->prot->name;
  46     else        return "NULL";
  47 }
  48
  49 static void *urlcontext_child_next(void *obj, void *prev)
  50 {
  51     URLContext *h = obj;
  52     if (!prev && h->priv_data && h->prot->priv_data_class)
  53         return h->priv_data;
  54     return NULL;
  55 }
  56
  57 static const AVClass *urlcontext_child_class_next(const AVClass *prev)
  58 {
  59     URLProtocol *p = NULL;
  60
  61     /* find the protocol that corresponds to prev */
  62     while (prev && (p = ffurl_protocol_next(p)))
  63         if (p->priv_data_class == prev)
  64             break;
  65
  66     /* find next protocol with priv options */
  67     while (p = ffurl_protocol_next(p))
  68         if (p->priv_data_class)
  69             return p->priv_data_class;
  70     return NULL;
  71
  72 }
  73
  74 static const AVOption options[] = {{NULL}};
  75 const AVClass ffurl_context_class = {
  76     .class_name     = "URLContext",
  77     .item_name      = urlcontext_to_name,
  78     .option         = options,
  79     .version        = LIBAVUTIL_VERSION_INT,
  80     .child_next     = urlcontext_child_next,
  81     .child_class_next = urlcontext_child_class_next,
  82 };
  83 /*@}*/
  84
  85
  86 const char *avio_enum_protocols(void **opaque, int output)
  87 {
  88     URLProtocol **p = (URLProtocol **)opaque;
  89     *p = ffurl_protocol_next(*p);
  90     if (!*p) return NULL;
  91     if ((output && (*p)->url_write) || (!output && (*p)->url_read))
  92         return (*p)->name;
  93     return avio_enum_protocols(opaque, output);
  94 }
  95
  96 int ffurl_register_protocol(URLProtocol *protocol, int size)
  97 {
  98     URLProtocol **p;
  99     if (size < sizeof(URLProtocol)) {
 100         URLProtocol* temp = av_mallocz(sizeof(URLProtocol));
 101         memcpy(temp, protocol, size);
 102         protocol = temp;
 103     }
 104     p = &first_protocol;
 105     while (*p != NULL) p = &(*p)->next;
 106     *p = protocol;
 107     protocol->next = NULL;
 108     return 0;
 109 }
 110
 111 static int url_alloc_for_protocol (URLContext **puc, struct URLProtocol *up,
 112                                    const char *filename, int flags,
 113                                    const AVIOInterruptCB *int_cb)
 114 {
 115     URLContext *uc;
 116     int err;
 117
 118 #if CONFIG_NETWORK
 119     if (up->flags & URL_PROTOCOL_FLAG_NETWORK && !ff_network_init())
 120         return AVERROR(EIO);
 121 #endif
 122     uc = av_mallocz(sizeof(URLContext) + strlen(filename) + 1);
 123     if (!uc) {
 124         err = AVERROR(ENOMEM);
 125         goto fail;
 126     }
 127     uc->av_class = &ffurl_context_class;
 128     uc->filename = (char *) &uc[1];
 129     strcpy(uc->filename, filename);
 130     uc->prot = up;
 131     uc->flags = flags;
 132     uc->is_streamed = 0; /* default = not streamed */
 133     uc->max_packet_size = 0; /* default: stream file */
 134     if (up->priv_data_size) {
 135         uc->priv_data = av_mallocz(up->priv_data_size);
 136         if (up->priv_data_class) {
 137             int proto_len= strlen(up->name);
 138             char *start = strchr(uc->filename, ',');
 139             *(const AVClass**)uc->priv_data = up->priv_data_class;
 140             av_opt_set_defaults(uc->priv_data);
 141             if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
 142                 int ret= 0;
 143                 char *p= start;
 144                 char sep= *++p;
 145                 char *key, *val;
 146                 p++;
 147                 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
 148                     *val= *key= 0;
 149                     ret= av_opt_set(uc->priv_data, p, key+1, 0);
 150                     if (ret == AVERROR_OPTION_NOT_FOUND)
 151                         av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
 152                     *val= *key= sep;
 153                     p= val+1;
 154                 }
 155                 if(ret<0 || p!=key){
 156                     av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
 157                     av_freep(&uc->priv_data);
 158                     av_freep(&uc);
 159                     goto fail;
 160                 }
 161                 memmove(start, key+1, strlen(key));
 162             }
 163         }
 164     }
 165     if (int_cb)
 166         uc->interrupt_callback = *int_cb;
 167
 168     *puc = uc;
 169     return 0;
 170  fail:
 171     *puc = NULL;
 172 #if CONFIG_NETWORK
 173     if (up->flags & URL_PROTOCOL_FLAG_NETWORK)
 174         ff_network_close();
 175 #endif
 176     return err;
 177 }
 178
 179 int ffurl_connect(URLContext* uc, AVDictionary **options)
 180 {
 181     int err =
 182         uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
 183         uc->prot->url_open(uc, uc->filename, uc->flags);
 184     if (err)
 185         return err;
 186     uc->is_connected = 1;
 187     //We must be careful here as ffurl_seek() could be slow, for example for http
 188     if(   (uc->flags & AVIO_FLAG_WRITE)
 189        || !strcmp(uc->prot->name, "file"))
 190         if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
 191             uc->is_streamed= 1;
 192     return 0;
 193 }
 194
 195 #define URL_SCHEME_CHARS                        \
 196     "abcdefghijklmnopqrstuvwxyz"                \
 197     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"                \
 198     "0123456789+-."
 199
 200 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
 201                 const AVIOInterruptCB *int_cb)
 202 {
 203     URLProtocol *up = NULL;
 204     char proto_str[128], proto_nested[128], *ptr;
 205     size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
 206
 207     if (!first_protocol) {
 208         av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
 209                                      "Missing call to av_register_all()?\n");
 210     }
 211
 212     if (filename[proto_len] != ':' &&  filename[proto_len] != ',' || is_dos_path(filename))
 213         strcpy(proto_str, "file");
 214     else
 215         av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
 216
 217     if ((ptr = strchr(proto_str, ',')))
 218         *ptr = '\0';
 219     av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
 220     if ((ptr = strchr(proto_nested, '+')))
 221         *ptr = '\0';
 222
 223     while (up = ffurl_protocol_next(up)) {
 224         if (!strcmp(proto_str, up->name))
 225             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 226         if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
 227             !strcmp(proto_nested, up->name))
 228             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 229     }
 230     *puc = NULL;
 231     return AVERROR_PROTOCOL_NOT_FOUND;
 232 }
 233
 234 int ffurl_open(URLContext **puc, const char *filename, int flags,
 235                const AVIOInterruptCB *int_cb, AVDictionary **options)
 236 {
 237     int ret = ffurl_alloc(puc, filename, flags, int_cb);
 238     if (ret)
 239         return ret;
 240     if (options && (*puc)->prot->priv_data_class &&
 241         (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
 242         goto fail;
 243     ret = ffurl_connect(*puc, options);
 244     if (!ret)
 245         return 0;
 246 fail:
 247     ffurl_close(*puc);
 248     *puc = NULL;
 249     return ret;
 250 }
 251
 252 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
 253                                          int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
 254 {
 255     int ret, len;
 256     int fast_retries = 5;
 257     int64_t wait_since = 0;
 258
 259     len = 0;
 260     while (len < size_min) {
 261         ret = transfer_func(h, buf+len, size-len);
 262         if (ret == AVERROR(EINTR))
 263             continue;
 264         if (h->flags & AVIO_FLAG_NONBLOCK)
 265             return ret;
 266         if (ret == AVERROR(EAGAIN)) {
 267             ret = 0;
 268             if (fast_retries) {
 269                 fast_retries--;
 270             } else {
 271                 if (h->rw_timeout) {
 272                     if (!wait_since)
 273                         wait_since = av_gettime();
 274                     else if (av_gettime() > wait_since + h->rw_timeout)
 275                         return AVERROR(ETIMEDOUT);
 276                 }
 277                 av_usleep(1000);
 278             }
 279         } else if (ret < 1)
 280             return ret < 0 ? ret : len;
 281         if (ret)
 282            fast_retries = FFMAX(fast_retries, 2);
 283         len += ret;
 284         if (len < size && ff_check_interrupt(&h->interrupt_callback))
 285             return AVERROR_EXIT;
 286     }
 287     return len;
 288 }
 289
 290 int ffurl_read(URLContext *h, unsigned char *buf, int size)
 291 {
 292     if (!(h->flags & AVIO_FLAG_READ))
 293         return AVERROR(EIO);
 294     return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
 295 }
 296
 297 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
 298 {
 299     if (!(h->flags & AVIO_FLAG_READ))
 300         return AVERROR(EIO);
 301     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
 302 }
 303
 304 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
 305 {
 306     if (!(h->flags & AVIO_FLAG_WRITE))
 307         return AVERROR(EIO);
 308     /* avoid sending too big packets */
 309     if (h->max_packet_size && size > h->max_packet_size)
 310         return AVERROR(EIO);
 311
 312     return retry_transfer_wrapper(h, (unsigned char *)buf, size, size, (void*)h->prot->url_write);
 313 }
 314
 315 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
 316 {
 317     int64_t ret;
 318
 319     if (!h->prot->url_seek)
 320         return AVERROR(ENOSYS);
 321     ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
 322     return ret;
 323 }
 324
 325 int ffurl_closep(URLContext **hh)
 326 {
 327     URLContext *h= *hh;
 328     int ret = 0;
 329     if (!h) return 0; /* can happen when ffurl_open fails */
 330
 331     if (h->is_connected && h->prot->url_close)
 332         ret = h->prot->url_close(h);
 333 #if CONFIG_NETWORK
 334     if (h->prot->flags & URL_PROTOCOL_FLAG_NETWORK)
 335         ff_network_close();
 336 #endif
 337     if (h->prot->priv_data_size) {
 338         if (h->prot->priv_data_class)
 339             av_opt_free(h->priv_data);
 340         av_freep(&h->priv_data);
 341     }
 342     av_freep(hh);
 343     return ret;
 344 }
 345
 346 int ffurl_close(URLContext *h)
 347 {
 348     return ffurl_closep(&h);
 349 }
 350
 351
 352 int avio_check(const char *url, int flags)
 353 {
 354     URLContext *h;
 355     int ret = ffurl_alloc(&h, url, flags, NULL);
 356     if (ret)
 357         return ret;
 358
 359     if (h->prot->url_check) {
 360         ret = h->prot->url_check(h, flags);
 361     } else {
 362         ret = ffurl_connect(h, NULL);
 363         if (ret >= 0)
 364             ret = flags;
 365     }
 366
 367     ffurl_close(h);
 368     return ret;
 369 }
 370
 371 int64_t ffurl_size(URLContext *h)
 372 {
 373     int64_t pos, size;
 374
 375     size= ffurl_seek(h, 0, AVSEEK_SIZE);
 376     if(size<0){
 377         pos = ffurl_seek(h, 0, SEEK_CUR);
 378         if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
 379             return size;
 380         size++;
 381         ffurl_seek(h, pos, SEEK_SET);
 382     }
 383     return size;
 384 }
 385
 386 int ffurl_get_file_handle(URLContext *h)
 387 {
 388     if (!h->prot->url_get_file_handle)
 389         return -1;
 390     return h->prot->url_get_file_handle(h);
 391 }
 392
 393 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles)
 394 {
 395     if (!h->prot->url_get_multi_file_handle) {
 396         if (!h->prot->url_get_file_handle)
 397             return AVERROR(ENOSYS);
 398         *handles = av_malloc(sizeof(*handles));
 399         if (!*handles)
 400             return AVERROR(ENOMEM);
 401         *numhandles = 1;
 402         *handles[0] = h->prot->url_get_file_handle(h);
 403         return 0;
 404     }
 405     return h->prot->url_get_multi_file_handle(h, handles, numhandles);
 406 }
 407
 408 int ffurl_shutdown(URLContext *h, int flags)
 409 {
 410     if (!h->prot->url_shutdown)
 411         return AVERROR(EINVAL);
 412     return h->prot->url_shutdown(h, flags);
 413 }
 414
 415 int ff_check_interrupt(AVIOInterruptCB *cb)
 416 {
 417     int ret;
 418     if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
 419         return ret;
 420     return 0;
 421 }