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 <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
  87 #if FF_API_OLD_INTERRUPT_CB
  88 static int default_interrupt_cb(void);
  89 int (*url_interrupt_cb)(void) = default_interrupt_cb;
  90 #endif
  91
  92 URLProtocol *av_protocol_next(URLProtocol *p)
  93 {
  94     return ffurl_protocol_next(p);
  95 }
  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             int proto_len= strlen(up->name);
 149             char *start = strchr(uc->filename, ',');
 150             *(const AVClass**)uc->priv_data = up->priv_data_class;
 151             av_opt_set_defaults(uc->priv_data);
 152             if(!strncmp(up->name, uc->filename, proto_len) && uc->filename + proto_len == start){
 153                 int ret= 0;
 154                 char *p= start;
 155                 char sep= *++p;
 156                 char *key, *val;
 157                 p++;
 158                 while(ret >= 0 && (key= strchr(p, sep)) && p<key && (val = strchr(key+1, sep))){
 159                     *val= *key= 0;
 160                     ret= av_opt_set(uc->priv_data, p, key+1, 0);
 161                     if (ret == AVERROR_OPTION_NOT_FOUND)
 162                         av_log(uc, AV_LOG_ERROR, "Key '%s' not found.\n", p);
 163                     *val= *key= sep;
 164                     p= val+1;
 165                 }
 166                 if(ret<0 || p!=key){
 167                     av_log(uc, AV_LOG_ERROR, "Error parsing options string %s\n", start);
 168                     av_freep(&uc->priv_data);
 169                     av_freep(&uc);
 170                     goto fail;
 171                 }
 172                 memmove(start, key+1, strlen(key));
 173             }
 174         }
 175     }
 176     if (int_cb)
 177         uc->interrupt_callback = *int_cb;
 178
 179     *puc = uc;
 180     return 0;
 181  fail:
 182     *puc = NULL;
 183 #if CONFIG_NETWORK
 184     ff_network_close();
 185 #endif
 186     return err;
 187 }
 188
 189 int ffurl_connect(URLContext* uc, AVDictionary **options)
 190 {
 191     int err =
 192 #if !FF_API_OLD_AVIO
 193         uc->prot->url_open2 ? uc->prot->url_open2(uc, uc->filename, uc->flags, options) :
 194 #endif
 195         uc->prot->url_open(uc, uc->filename, uc->flags);
 196     if (err)
 197         return err;
 198     uc->is_connected = 1;
 199     //We must be careful here as ffurl_seek() could be slow, for example for http
 200     if(   (uc->flags & AVIO_FLAG_WRITE)
 201        || !strcmp(uc->prot->name, "file"))
 202         if(!uc->is_streamed && ffurl_seek(uc, 0, SEEK_SET) < 0)
 203             uc->is_streamed= 1;
 204     return 0;
 205 }
 206
 207 #if FF_API_OLD_AVIO
 208 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
 209                        const char *filename, int flags)
 210 {
 211     int ret;
 212
 213     ret = url_alloc_for_protocol(puc, up, filename, flags, NULL);
 214     if (ret)
 215         goto fail;
 216     ret = ffurl_connect(*puc, NULL);
 217     if (!ret)
 218         return 0;
 219  fail:
 220     ffurl_close(*puc);
 221     *puc = NULL;
 222     return ret;
 223 }
 224 int url_alloc(URLContext **puc, const char *filename, int flags)
 225 {
 226     return ffurl_alloc(puc, filename, flags, NULL);
 227 }
 228 int url_connect(URLContext* uc)
 229 {
 230     return ffurl_connect(uc, NULL);
 231 }
 232 int url_open(URLContext **puc, const char *filename, int flags)
 233 {
 234     return ffurl_open(puc, filename, flags, NULL, NULL);
 235 }
 236 int url_read(URLContext *h, unsigned char *buf, int size)
 237 {
 238     return ffurl_read(h, buf, size);
 239 }
 240 int url_read_complete(URLContext *h, unsigned char *buf, int size)
 241 {
 242     return ffurl_read_complete(h, buf, size);
 243 }
 244 int url_write(URLContext *h, const unsigned char *buf, int size)
 245 {
 246     return ffurl_write(h, buf, size);
 247 }
 248 int64_t url_seek(URLContext *h, int64_t pos, int whence)
 249 {
 250     return ffurl_seek(h, pos, whence);
 251 }
 252 int url_close(URLContext *h)
 253 {
 254     return ffurl_close(h);
 255 }
 256 int64_t url_filesize(URLContext *h)
 257 {
 258     return ffurl_size(h);
 259 }
 260 int url_get_file_handle(URLContext *h)
 261 {
 262     return ffurl_get_file_handle(h);
 263 }
 264 int url_get_max_packet_size(URLContext *h)
 265 {
 266     return h->max_packet_size;
 267 }
 268 void url_get_filename(URLContext *h, char *buf, int buf_size)
 269 {
 270     av_strlcpy(buf, h->filename, buf_size);
 271 }
 272 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb)
 273 {
 274     avio_set_interrupt_cb(interrupt_cb);
 275 }
 276 int av_register_protocol2(URLProtocol *protocol, int size)
 277 {
 278     return ffurl_register_protocol(protocol, size);
 279 }
 280 #endif
 281
 282 #define URL_SCHEME_CHARS                        \
 283     "abcdefghijklmnopqrstuvwxyz"                \
 284     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"                \
 285     "0123456789+-."
 286
 287 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
 288                 const AVIOInterruptCB *int_cb)
 289 {
 290     URLProtocol *up = NULL;
 291     char proto_str[128], proto_nested[128], *ptr;
 292     size_t proto_len = strspn(filename, URL_SCHEME_CHARS);
 293
 294     if (!first_protocol) {
 295         av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
 296                                      "Missing call to av_register_all()?\n");
 297     }
 298
 299     if (filename[proto_len] != ':' &&  filename[proto_len] != ',' || is_dos_path(filename))
 300         strcpy(proto_str, "file");
 301     else
 302         av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
 303
 304     if ((ptr = strchr(proto_str, ',')))
 305         *ptr = '\0';
 306     av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
 307     if ((ptr = strchr(proto_nested, '+')))
 308         *ptr = '\0';
 309
 310     while (up = ffurl_protocol_next(up)) {
 311         if (!strcmp(proto_str, up->name))
 312             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 313         if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
 314             !strcmp(proto_nested, up->name))
 315             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 316     }
 317     *puc = NULL;
 318     return AVERROR(ENOENT);
 319 }
 320
 321 int ffurl_open(URLContext **puc, const char *filename, int flags,
 322                const AVIOInterruptCB *int_cb, AVDictionary **options)
 323 {
 324     int ret = ffurl_alloc(puc, filename, flags, int_cb);
 325     if (ret)
 326         return ret;
 327     if (options && (*puc)->prot->priv_data_class &&
 328         (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
 329         goto fail;
 330     ret = ffurl_connect(*puc, options);
 331     if (!ret)
 332         return 0;
 333 fail:
 334     ffurl_close(*puc);
 335     *puc = NULL;
 336     return ret;
 337 }
 338
 339 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
 340                                          int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
 341 {
 342     int ret, len;
 343     int fast_retries = 5;
 344
 345     len = 0;
 346     while (len < size_min) {
 347         ret = transfer_func(h, buf+len, size-len);
 348         if (ret == AVERROR(EINTR))
 349             continue;
 350         if (h->flags & AVIO_FLAG_NONBLOCK)
 351             return ret;
 352         if (ret == AVERROR(EAGAIN)) {
 353             ret = 0;
 354             if (fast_retries)
 355                 fast_retries--;
 356             else
 357                 usleep(1000);
 358         } else if (ret < 1)
 359             return ret < 0 ? ret : len;
 360         if (ret)
 361            fast_retries = FFMAX(fast_retries, 2);
 362         len += ret;
 363         if (len < size && ff_check_interrupt(&h->interrupt_callback))
 364             return AVERROR_EXIT;
 365     }
 366     return len;
 367 }
 368
 369 int ffurl_read(URLContext *h, unsigned char *buf, int size)
 370 {
 371     if (!(h->flags & AVIO_FLAG_READ))
 372         return AVERROR(EIO);
 373     return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
 374 }
 375
 376 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
 377 {
 378     if (!(h->flags & AVIO_FLAG_READ))
 379         return AVERROR(EIO);
 380     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
 381 }
 382
 383 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
 384 {
 385     if (!(h->flags & AVIO_FLAG_WRITE))
 386         return AVERROR(EIO);
 387     /* avoid sending too big packets */
 388     if (h->max_packet_size && size > h->max_packet_size)
 389         return AVERROR(EIO);
 390
 391     return retry_transfer_wrapper(h, buf, size, size, (void*)h->prot->url_write);
 392 }
 393
 394 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
 395 {
 396     int64_t ret;
 397
 398     if (!h->prot->url_seek)
 399         return AVERROR(ENOSYS);
 400     ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
 401     return ret;
 402 }
 403
 404 int ffurl_close(URLContext *h)
 405 {
 406     int ret = 0;
 407     if (!h) return 0; /* can happen when ffurl_open fails */
 408
 409     if (h->is_connected && h->prot->url_close)
 410         ret = h->prot->url_close(h);
 411 #if CONFIG_NETWORK
 412     ff_network_close();
 413 #endif
 414     if (h->prot->priv_data_size) {
 415         if (h->prot->priv_data_class)
 416             av_opt_free(h->priv_data);
 417         av_free(h->priv_data);
 418     }
 419     av_free(h);
 420     return ret;
 421 }
 422
 423 #if FF_API_OLD_AVIO
 424 int url_exist(const char *filename)
 425 {
 426     URLContext *h;
 427     if (ffurl_open(&h, filename, AVIO_FLAG_READ, NULL, NULL) < 0)
 428         return 0;
 429     ffurl_close(h);
 430     return 1;
 431 }
 432 #endif
 433
 434 int avio_check(const char *url, int flags)
 435 {
 436     URLContext *h;
 437     int ret = ffurl_alloc(&h, url, flags, NULL);
 438     if (ret)
 439         return ret;
 440
 441     if (h->prot->url_check) {
 442         ret = h->prot->url_check(h, flags);
 443     } else {
 444         ret = ffurl_connect(h, NULL);
 445         if (ret >= 0)
 446             ret = flags;
 447     }
 448
 449     ffurl_close(h);
 450     return ret;
 451 }
 452
 453 int64_t ffurl_size(URLContext *h)
 454 {
 455     int64_t pos, size;
 456
 457     size= ffurl_seek(h, 0, AVSEEK_SIZE);
 458     if(size<0){
 459         pos = ffurl_seek(h, 0, SEEK_CUR);
 460         if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
 461             return size;
 462         size++;
 463         ffurl_seek(h, pos, SEEK_SET);
 464     }
 465     return size;
 466 }
 467
 468 int ffurl_get_file_handle(URLContext *h)
 469 {
 470     if (!h->prot->url_get_file_handle)
 471         return -1;
 472     return h->prot->url_get_file_handle(h);
 473 }
 474
 475 #if FF_API_OLD_INTERRUPT_CB
 476 static int default_interrupt_cb(void)
 477 {
 478     return 0;
 479 }
 480
 481 void avio_set_interrupt_cb(int (*interrupt_cb)(void))
 482 {
 483     if (!interrupt_cb)
 484         interrupt_cb = default_interrupt_cb;
 485     url_interrupt_cb = interrupt_cb;
 486 }
 487 #endif
 488
 489 int ff_check_interrupt(AVIOInterruptCB *cb)
 490 {
 491     int ret;
 492     if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
 493         return ret;
 494 #if FF_API_OLD_INTERRUPT_CB
 495     return url_interrupt_cb();
 496 #else
 497     return 0;
 498 #endif
 499 }
 500
 501 #if FF_API_OLD_AVIO
 502 int av_url_read_pause(URLContext *h, int pause)
 503 {
 504     if (!h->prot->url_read_pause)
 505         return AVERROR(ENOSYS);
 506     return h->prot->url_read_pause(h, pause);
 507 }
 508
 509 int64_t av_url_read_seek(URLContext *h,
 510         int stream_index, int64_t timestamp, int flags)
 511 {
 512     if (!h->prot->url_read_seek)
 513         return AVERROR(ENOSYS);
 514     return h->prot->url_read_seek(h, stream_index, timestamp, flags);
 515 }
 516 #endif