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