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             *(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 (!first_protocol) {
 271         av_log(NULL, AV_LOG_WARNING, "No URL Protocols are registered. "
 272                                      "Missing call to av_register_all()?\n");
 273     }
 274
 275     if (filename[proto_len] != ':' || is_dos_path(filename))
 276         strcpy(proto_str, "file");
 277     else
 278         av_strlcpy(proto_str, filename, FFMIN(proto_len+1, sizeof(proto_str)));
 279
 280     av_strlcpy(proto_nested, proto_str, sizeof(proto_nested));
 281     if ((ptr = strchr(proto_nested, '+')))
 282         *ptr = '\0';
 283
 284     while (up = ffurl_protocol_next(up)) {
 285         if (!strcmp(proto_str, up->name))
 286             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 287         if (up->flags & URL_PROTOCOL_FLAG_NESTED_SCHEME &&
 288             !strcmp(proto_nested, up->name))
 289             return url_alloc_for_protocol (puc, up, filename, flags, int_cb);
 290     }
 291     *puc = NULL;
 292     return AVERROR(ENOENT);
 293 }
 294
 295 int ffurl_open(URLContext **puc, const char *filename, int flags,
 296                const AVIOInterruptCB *int_cb, AVDictionary **options)
 297 {
 298     int ret = ffurl_alloc(puc, filename, flags, int_cb);
 299     if (ret)
 300         return ret;
 301     if (options && (*puc)->prot->priv_data_class &&
 302         (ret = av_opt_set_dict((*puc)->priv_data, options)) < 0)
 303         goto fail;
 304     ret = ffurl_connect(*puc, options);
 305     if (!ret)
 306         return 0;
 307 fail:
 308     ffurl_close(*puc);
 309     *puc = NULL;
 310     return ret;
 311 }
 312
 313 static inline int retry_transfer_wrapper(URLContext *h, unsigned char *buf, int size, int size_min,
 314                                          int (*transfer_func)(URLContext *h, unsigned char *buf, int size))
 315 {
 316     int ret, len;
 317     int fast_retries = 5;
 318
 319     len = 0;
 320     while (len < size_min) {
 321         ret = transfer_func(h, buf+len, size-len);
 322         if (ret == AVERROR(EINTR))
 323             continue;
 324         if (h->flags & AVIO_FLAG_NONBLOCK)
 325             return ret;
 326         if (ret == AVERROR(EAGAIN)) {
 327             ret = 0;
 328             if (fast_retries)
 329                 fast_retries--;
 330             else
 331                 usleep(1000);
 332         } else if (ret < 1)
 333             return ret < 0 ? ret : len;
 334         if (ret)
 335            fast_retries = FFMAX(fast_retries, 2);
 336         len += ret;
 337         if (len < size && ff_check_interrupt(&h->interrupt_callback))
 338             return AVERROR_EXIT;
 339     }
 340     return len;
 341 }
 342
 343 int ffurl_read(URLContext *h, unsigned char *buf, int size)
 344 {
 345     if (!(h->flags & AVIO_FLAG_READ))
 346         return AVERROR(EIO);
 347     return retry_transfer_wrapper(h, buf, size, 1, h->prot->url_read);
 348 }
 349
 350 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size)
 351 {
 352     if (!(h->flags & AVIO_FLAG_READ))
 353         return AVERROR(EIO);
 354     return retry_transfer_wrapper(h, buf, size, size, h->prot->url_read);
 355 }
 356
 357 int ffurl_write(URLContext *h, const unsigned char *buf, int size)
 358 {
 359     if (!(h->flags & AVIO_FLAG_WRITE))
 360         return AVERROR(EIO);
 361     /* avoid sending too big packets */
 362     if (h->max_packet_size && size > h->max_packet_size)
 363         return AVERROR(EIO);
 364
 365     return retry_transfer_wrapper(h, buf, size, size, (void*)h->prot->url_write);
 366 }
 367
 368 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence)
 369 {
 370     int64_t ret;
 371
 372     if (!h->prot->url_seek)
 373         return AVERROR(ENOSYS);
 374     ret = h->prot->url_seek(h, pos, whence & ~AVSEEK_FORCE);
 375     return ret;
 376 }
 377
 378 int ffurl_close(URLContext *h)
 379 {
 380     int ret = 0;
 381     if (!h) return 0; /* can happen when ffurl_open fails */
 382
 383     if (h->is_connected && h->prot->url_close)
 384         ret = h->prot->url_close(h);
 385 #if CONFIG_NETWORK
 386     ff_network_close();
 387 #endif
 388     if (h->prot->priv_data_size) {
 389         if (h->prot->priv_data_class)
 390             av_opt_free(h->priv_data);
 391         av_free(h->priv_data);
 392     }
 393     av_free(h);
 394     return ret;
 395 }
 396
 397 #if FF_API_OLD_AVIO
 398 int url_exist(const char *filename)
 399 {
 400     URLContext *h;
 401     if (ffurl_open(&h, filename, AVIO_FLAG_READ, NULL, NULL) < 0)
 402         return 0;
 403     ffurl_close(h);
 404     return 1;
 405 }
 406 #endif
 407
 408 int avio_check(const char *url, int flags)
 409 {
 410     URLContext *h;
 411     int ret = ffurl_alloc(&h, url, flags, NULL);
 412     if (ret)
 413         return ret;
 414
 415     if (h->prot->url_check) {
 416         ret = h->prot->url_check(h, flags);
 417     } else {
 418         ret = ffurl_connect(h, NULL);
 419         if (ret >= 0)
 420             ret = flags;
 421     }
 422
 423     ffurl_close(h);
 424     return ret;
 425 }
 426
 427 int64_t ffurl_size(URLContext *h)
 428 {
 429     int64_t pos, size;
 430
 431     size= ffurl_seek(h, 0, AVSEEK_SIZE);
 432     if(size<0){
 433         pos = ffurl_seek(h, 0, SEEK_CUR);
 434         if ((size = ffurl_seek(h, -1, SEEK_END)) < 0)
 435             return size;
 436         size++;
 437         ffurl_seek(h, pos, SEEK_SET);
 438     }
 439     return size;
 440 }
 441
 442 int ffurl_get_file_handle(URLContext *h)
 443 {
 444     if (!h->prot->url_get_file_handle)
 445         return -1;
 446     return h->prot->url_get_file_handle(h);
 447 }
 448
 449 #if FF_API_OLD_INTERRUPT_CB
 450 static int default_interrupt_cb(void)
 451 {
 452     return 0;
 453 }
 454
 455 void avio_set_interrupt_cb(int (*interrupt_cb)(void))
 456 {
 457     if (!interrupt_cb)
 458         interrupt_cb = default_interrupt_cb;
 459     url_interrupt_cb = interrupt_cb;
 460 }
 461 #endif
 462
 463 int ff_check_interrupt(AVIOInterruptCB *cb)
 464 {
 465     int ret;
 466     if (cb && cb->callback && (ret = cb->callback(cb->opaque)))
 467         return ret;
 468 #if FF_API_OLD_INTERRUPT_CB
 469     return url_interrupt_cb();
 470 #else
 471     return 0;
 472 #endif
 473 }
 474
 475 #if FF_API_OLD_AVIO
 476 int av_url_read_pause(URLContext *h, int pause)
 477 {
 478     if (!h->prot->url_read_pause)
 479         return AVERROR(ENOSYS);
 480     return h->prot->url_read_pause(h, pause);
 481 }
 482
 483 int64_t av_url_read_seek(URLContext *h,
 484         int stream_index, int64_t timestamp, int flags)
 485 {
 486     if (!h->prot->url_read_seek)
 487         return AVERROR(ENOSYS);
 488     return h->prot->url_read_seek(h, stream_index, timestamp, flags);
 489 }
 490 #endif