git.sesse.net Git - ffmpeg/blob - libavformat/url.h

   1 /*
   2  *
   3  * This file is part of Libav.
   4  *
   5  * Libav is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * Libav is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with Libav; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 /**
  21  * @file
  22  * unbuffered private I/O API
  23  */
  24
  25 #ifndef AVFORMAT_URL_H
  26 #define AVFORMAT_URL_H
  27
  28 #include "avio.h"
  29 #include "libavformat/version.h"
  30
  31 #include "libavutil/dict.h"
  32 #include "libavutil/log.h"
  33
  34 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
  35 #define URL_PROTOCOL_FLAG_NETWORK       2 /*< The protocol uses network */
  36
  37 extern int (*url_interrupt_cb)(void);
  38
  39 extern const AVClass ffurl_context_class;
  40
  41 typedef struct URLContext {
  42     const AVClass *av_class;    /**< information for av_log(). Set by url_open(). */
  43     struct URLProtocol *prot;
  44     void *priv_data;
  45     char *filename;             /**< specified URL */
  46     int flags;
  47     int max_packet_size;        /**< if non zero, the stream is packetized with this max packet size */
  48     int is_streamed;            /**< true if streamed (no seek possible), default = false */
  49     int is_connected;
  50     AVIOInterruptCB interrupt_callback;
  51 } URLContext;
  52
  53 typedef struct URLProtocol {
  54     const char *name;
  55     int     (*url_open)( URLContext *h, const char *url, int flags);
  56     /**
  57      * This callback is to be used by protocols which open further nested
  58      * protocols. options are then to be passed to ffurl_open()/ffurl_connect()
  59      * for those nested protocols.
  60      */
  61     int     (*url_open2)(URLContext *h, const char *url, int flags, AVDictionary **options);
  62
  63     /**
  64      * Read data from the protocol.
  65      * If data is immediately available (even less than size), EOF is
  66      * reached or an error occurs (including EINTR), return immediately.
  67      * Otherwise:
  68      * In non-blocking mode, return AVERROR(EAGAIN) immediately.
  69      * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
  70      * and return AVERROR(EAGAIN) on timeout.
  71      * Checking interrupt_callback, looping on EINTR and EAGAIN and until
  72      * enough data has been read is left to the calling function; see
  73      * retry_transfer_wrapper in avio.c.
  74      */
  75     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
  76     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
  77     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
  78     int     (*url_close)(URLContext *h);
  79     struct URLProtocol *next;
  80     int (*url_read_pause)(URLContext *h, int pause);
  81     int64_t (*url_read_seek)(URLContext *h, int stream_index,
  82                              int64_t timestamp, int flags);
  83     int (*url_get_file_handle)(URLContext *h);
  84     int (*url_get_multi_file_handle)(URLContext *h, int **handles,
  85                                      int *numhandles);
  86     int (*url_shutdown)(URLContext *h, int flags);
  87     int priv_data_size;
  88     const AVClass *priv_data_class;
  89     int flags;
  90     int (*url_check)(URLContext *h, int mask);
  91 } URLProtocol;
  92
  93 /**
  94  * Create a URLContext for accessing to the resource indicated by
  95  * url, but do not initiate the connection yet.
  96  *
  97  * @param puc pointer to the location where, in case of success, the
  98  * function puts the pointer to the created URLContext
  99  * @param flags flags which control how the resource indicated by url
 100  * is to be opened
 101  * @param int_cb interrupt callback to use for the URLContext, may be
 102  * NULL
 103  * @return 0 in case of success, a negative value corresponding to an
 104  * AVERROR code in case of failure
 105  */
 106 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
 107                 const AVIOInterruptCB *int_cb);
 108
 109 /**
 110  * Connect an URLContext that has been allocated by ffurl_alloc
 111  *
 112  * @param options  A dictionary filled with options for nested protocols,
 113  * i.e. it will be passed to url_open2() for protocols implementing it.
 114  * This parameter will be destroyed and replaced with a dict containing options
 115  * that were not found. May be NULL.
 116  */
 117 int ffurl_connect(URLContext *uc, AVDictionary **options);
 118
 119 /**
 120  * Create an URLContext for accessing to the resource indicated by
 121  * url, and open it.
 122  *
 123  * @param puc pointer to the location where, in case of success, the
 124  * function puts the pointer to the created URLContext
 125  * @param flags flags which control how the resource indicated by url
 126  * is to be opened
 127  * @param int_cb interrupt callback to use for the URLContext, may be
 128  * NULL
 129  * @param options  A dictionary filled with protocol-private options. On return
 130  * this parameter will be destroyed and replaced with a dict containing options
 131  * that were not found. May be NULL.
 132  * @return 0 in case of success, a negative value corresponding to an
 133  * AVERROR code in case of failure
 134  */
 135 int ffurl_open(URLContext **puc, const char *filename, int flags,
 136                const AVIOInterruptCB *int_cb, AVDictionary **options);
 137
 138 /**
 139  * Read up to size bytes from the resource accessed by h, and store
 140  * the read bytes in buf.
 141  *
 142  * @return The number of bytes actually read, or a negative value
 143  * corresponding to an AVERROR code in case of error. A value of zero
 144  * indicates that it is not possible to read more from the accessed
 145  * resource (except if the value of the size argument is also zero).
 146  */
 147 int ffurl_read(URLContext *h, unsigned char *buf, int size);
 148
 149 /**
 150  * Read as many bytes as possible (up to size), calling the
 151  * read function multiple times if necessary.
 152  * This makes special short-read handling in applications
 153  * unnecessary, if the return value is < size then it is
 154  * certain there was either an error or the end of file was reached.
 155  */
 156 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
 157
 158 /**
 159  * Write size bytes from buf to the resource accessed by h.
 160  *
 161  * @return the number of bytes actually written, or a negative value
 162  * corresponding to an AVERROR code in case of failure
 163  */
 164 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
 165
 166 /**
 167  * Change the position that will be used by the next read/write
 168  * operation on the resource accessed by h.
 169  *
 170  * @param pos specifies the new position to set
 171  * @param whence specifies how pos should be interpreted, it must be
 172  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
 173  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
 174  * (return the filesize of the requested resource, pos is ignored).
 175  * @return a negative value corresponding to an AVERROR code in case
 176  * of failure, or the resulting file position, measured in bytes from
 177  * the beginning of the file. You can use this feature together with
 178  * SEEK_CUR to read the current file position.
 179  */
 180 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
 181
 182 /**
 183  * Close the resource accessed by the URLContext h, and free the
 184  * memory used by it.
 185  *
 186  * @return a negative value if an error condition occurred, 0
 187  * otherwise
 188  */
 189 int ffurl_close(URLContext *h);
 190
 191 /**
 192  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
 193  * if the operation is not supported by h, or another negative value
 194  * corresponding to an AVERROR error code in case of failure.
 195  */
 196 int64_t ffurl_size(URLContext *h);
 197
 198 /**
 199  * Return the file descriptor associated with this URL. For RTP, this
 200  * will return only the RTP file descriptor, not the RTCP file descriptor.
 201  *
 202  * @return the file descriptor associated with this URL, or <0 on error.
 203  */
 204 int ffurl_get_file_handle(URLContext *h);
 205
 206 /**
 207  * Return the file descriptors associated with this URL.
 208  *
 209  * @return 0 on success or <0 on error.
 210  */
 211 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles);
 212
 213 /**
 214  * Signal the URLContext that we are done reading or writing the stream.
 215  *
 216  * @param h pointer to the resource
 217  * @param flags flags which control how the resource indicated by url
 218  * is to be shutdown
 219  *
 220  * @return a negative value if an error condition occurred, 0
 221  * otherwise
 222  */
 223 int ffurl_shutdown(URLContext *h, int flags);
 224
 225 /**
 226  * Register the URLProtocol protocol.
 227  *
 228  * @param size the size of the URLProtocol struct referenced
 229  */
 230 int ffurl_register_protocol(URLProtocol *protocol, int size);
 231
 232 /**
 233  * Check if the user has requested to interrup a blocking function
 234  * associated with cb.
 235  */
 236 int ff_check_interrupt(AVIOInterruptCB *cb);
 237
 238 /**
 239  * Iterate over all available protocols.
 240  *
 241  * @param prev result of the previous call to this functions or NULL.
 242  */
 243 URLProtocol *ffurl_protocol_next(URLProtocol *prev);
 244
 245 /* udp.c */
 246 int ff_udp_set_remote_url(URLContext *h, const char *uri);
 247 int ff_udp_get_local_port(URLContext *h);
 248
 249 #endif /* AVFORMAT_URL_H */