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

   1 /*
   2  *
   3  * This file is part of FFmpeg.
   4  *
   5  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 const AVClass ffurl_context_class;
  38
  39 typedef struct URLContext {
  40     const AVClass *av_class;    /**< information for av_log(). Set by url_open(). */
  41     struct URLProtocol *prot;
  42     void *priv_data;
  43     char *filename;             /**< specified URL */
  44     int flags;
  45     int max_packet_size;        /**< if non zero, the stream is packetized with this max packet size */
  46     int is_streamed;            /**< true if streamed (no seek possible), default = false */
  47     int is_connected;
  48     AVIOInterruptCB interrupt_callback;
  49     int64_t rw_timeout;         /**< maximum time to wait for (network) read/write operation completion, in mcs */
  50     const char *protocol_whitelist;
  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     int     (*url_accept)(URLContext *s, URLContext **c);
  63     int     (*url_handshake)(URLContext *c);
  64
  65     /**
  66      * Read data from the protocol.
  67      * If data is immediately available (even less than size), EOF is
  68      * reached or an error occurs (including EINTR), return immediately.
  69      * Otherwise:
  70      * In non-blocking mode, return AVERROR(EAGAIN) immediately.
  71      * In blocking mode, wait for data/EOF/error with a short timeout (0.1s),
  72      * and return AVERROR(EAGAIN) on timeout.
  73      * Checking interrupt_callback, looping on EINTR and EAGAIN and until
  74      * enough data has been read is left to the calling function; see
  75      * retry_transfer_wrapper in avio.c.
  76      */
  77     int     (*url_read)( URLContext *h, unsigned char *buf, int size);
  78     int     (*url_write)(URLContext *h, const unsigned char *buf, int size);
  79     int64_t (*url_seek)( URLContext *h, int64_t pos, int whence);
  80     int     (*url_close)(URLContext *h);
  81     struct URLProtocol *next;
  82     int (*url_read_pause)(URLContext *h, int pause);
  83     int64_t (*url_read_seek)(URLContext *h, int stream_index,
  84                              int64_t timestamp, int flags);
  85     int (*url_get_file_handle)(URLContext *h);
  86     int (*url_get_multi_file_handle)(URLContext *h, int **handles,
  87                                      int *numhandles);
  88     int (*url_shutdown)(URLContext *h, int flags);
  89     int priv_data_size;
  90     const AVClass *priv_data_class;
  91     int flags;
  92     int (*url_check)(URLContext *h, int mask);
  93     int (*url_open_dir)(URLContext *h);
  94     int (*url_read_dir)(URLContext *h, AVIODirEntry **next);
  95     int (*url_close_dir)(URLContext *h);
  96     int (*url_delete)(URLContext *h);
  97     int (*url_move)(URLContext *h_src, URLContext *h_dst);
  98     const char *default_whitelist;
  99 } URLProtocol;
 100
 101 /**
 102  * Create a URLContext for accessing to the resource indicated by
 103  * url, but do not initiate the connection yet.
 104  *
 105  * @param puc pointer to the location where, in case of success, the
 106  * function puts the pointer to the created URLContext
 107  * @param flags flags which control how the resource indicated by url
 108  * is to be opened
 109  * @param int_cb interrupt callback to use for the URLContext, may be
 110  * NULL
 111  * @return >= 0 in case of success, a negative value corresponding to an
 112  * AVERROR code in case of failure
 113  */
 114 int ffurl_alloc(URLContext **puc, const char *filename, int flags,
 115                 const AVIOInterruptCB *int_cb);
 116
 117 /**
 118  * Connect an URLContext that has been allocated by ffurl_alloc
 119  *
 120  * @param options  A dictionary filled with options for nested protocols,
 121  * i.e. it will be passed to url_open2() for protocols implementing it.
 122  * This parameter will be destroyed and replaced with a dict containing options
 123  * that were not found. May be NULL.
 124  */
 125 int ffurl_connect(URLContext *uc, AVDictionary **options);
 126
 127 /**
 128  * Create an URLContext for accessing to the resource indicated by
 129  * url, and open it.
 130  *
 131  * @param puc pointer to the location where, in case of success, the
 132  * function puts the pointer to the created URLContext
 133  * @param flags flags which control how the resource indicated by url
 134  * is to be opened
 135  * @param int_cb interrupt callback to use for the URLContext, may be
 136  * NULL
 137  * @param options  A dictionary filled with protocol-private options. On return
 138  * this parameter will be destroyed and replaced with a dict containing options
 139  * that were not found. May be NULL.
 140  * @return >= 0 in case of success, a negative value corresponding to an
 141  * AVERROR code in case of failure
 142  */
 143 int ffurl_open_whitelist(URLContext **puc, const char *filename, int flags,
 144                const AVIOInterruptCB *int_cb, AVDictionary **options,
 145                const char *whitelist);
 146
 147 int ffurl_open(URLContext **puc, const char *filename, int flags,
 148                const AVIOInterruptCB *int_cb, AVDictionary **options);
 149
 150 /**
 151  * Accept an URLContext c on an URLContext s
 152  *
 153  * @param  s server context
 154  * @param  c client context, must be unallocated.
 155  * @return >= 0 on success, ff_neterrno() on failure.
 156  */
 157 int ffurl_accept(URLContext *s, URLContext **c);
 158
 159 /**
 160  * Perform one step of the protocol handshake to accept a new client.
 161  * See avio_handshake() for details.
 162  * Implementations should try to return decreasing values.
 163  * If the protocol uses an underlying protocol, the underlying handshake is
 164  * usually the first step, and the return value can be:
 165  * (largest value for this protocol) + (return value from other protocol)
 166  *
 167  * @param  c the client context
 168  * @return >= 0 on success or a negative value corresponding
 169  *         to an AVERROR code on failure
 170  */
 171 int ffurl_handshake(URLContext *c);
 172
 173 /**
 174  * Read up to size bytes from the resource accessed by h, and store
 175  * the read bytes in buf.
 176  *
 177  * @return The number of bytes actually read, or a negative value
 178  * corresponding to an AVERROR code in case of error. A value of zero
 179  * indicates that it is not possible to read more from the accessed
 180  * resource (except if the value of the size argument is also zero).
 181  */
 182 int ffurl_read(URLContext *h, unsigned char *buf, int size);
 183
 184 /**
 185  * Read as many bytes as possible (up to size), calling the
 186  * read function multiple times if necessary.
 187  * This makes special short-read handling in applications
 188  * unnecessary, if the return value is < size then it is
 189  * certain there was either an error or the end of file was reached.
 190  */
 191 int ffurl_read_complete(URLContext *h, unsigned char *buf, int size);
 192
 193 /**
 194  * Write size bytes from buf to the resource accessed by h.
 195  *
 196  * @return the number of bytes actually written, or a negative value
 197  * corresponding to an AVERROR code in case of failure
 198  */
 199 int ffurl_write(URLContext *h, const unsigned char *buf, int size);
 200
 201 /**
 202  * Change the position that will be used by the next read/write
 203  * operation on the resource accessed by h.
 204  *
 205  * @param pos specifies the new position to set
 206  * @param whence specifies how pos should be interpreted, it must be
 207  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
 208  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
 209  * (return the filesize of the requested resource, pos is ignored).
 210  * @return a negative value corresponding to an AVERROR code in case
 211  * of failure, or the resulting file position, measured in bytes from
 212  * the beginning of the file. You can use this feature together with
 213  * SEEK_CUR to read the current file position.
 214  */
 215 int64_t ffurl_seek(URLContext *h, int64_t pos, int whence);
 216
 217 /**
 218  * Close the resource accessed by the URLContext h, and free the
 219  * memory used by it. Also set the URLContext pointer to NULL.
 220  *
 221  * @return a negative value if an error condition occurred, 0
 222  * otherwise
 223  */
 224 int ffurl_closep(URLContext **h);
 225 int ffurl_close(URLContext *h);
 226
 227 /**
 228  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
 229  * if the operation is not supported by h, or another negative value
 230  * corresponding to an AVERROR error code in case of failure.
 231  */
 232 int64_t ffurl_size(URLContext *h);
 233
 234 /**
 235  * Return the file descriptor associated with this URL. For RTP, this
 236  * will return only the RTP file descriptor, not the RTCP file descriptor.
 237  *
 238  * @return the file descriptor associated with this URL, or <0 on error.
 239  */
 240 int ffurl_get_file_handle(URLContext *h);
 241
 242 /**
 243  * Return the file descriptors associated with this URL.
 244  *
 245  * @return 0 on success or <0 on error.
 246  */
 247 int ffurl_get_multi_file_handle(URLContext *h, int **handles, int *numhandles);
 248
 249 /**
 250  * Signal the URLContext that we are done reading or writing the stream.
 251  *
 252  * @param h pointer to the resource
 253  * @param flags flags which control how the resource indicated by url
 254  * is to be shutdown
 255  *
 256  * @return a negative value if an error condition occurred, 0
 257  * otherwise
 258  */
 259 int ffurl_shutdown(URLContext *h, int flags);
 260
 261 /**
 262  * Register the URLProtocol protocol.
 263  */
 264 int ffurl_register_protocol(URLProtocol *protocol);
 265
 266 /**
 267  * Check if the user has requested to interrup a blocking function
 268  * associated with cb.
 269  */
 270 int ff_check_interrupt(AVIOInterruptCB *cb);
 271
 272 /**
 273  * Iterate over all available protocols.
 274  *
 275  * @param prev result of the previous call to this functions or NULL.
 276  */
 277 URLProtocol *ffurl_protocol_next(const URLProtocol *prev);
 278
 279 /* udp.c */
 280 int ff_udp_set_remote_url(URLContext *h, const char *uri);
 281 int ff_udp_get_local_port(URLContext *h);
 282
 283 /**
 284  * Assemble a URL string from components. This is the reverse operation
 285  * of av_url_split.
 286  *
 287  * Note, this requires networking to be initialized, so the caller must
 288  * ensure ff_network_init has been called.
 289  *
 290  * @see av_url_split
 291  *
 292  * @param str the buffer to fill with the url
 293  * @param size the size of the str buffer
 294  * @param proto the protocol identifier, if null, the separator
 295  *              after the identifier is left out, too
 296  * @param authorization an optional authorization string, may be null.
 297  *                      An empty string is treated the same as a null string.
 298  * @param hostname the host name string
 299  * @param port the port number, left out from the string if negative
 300  * @param fmt a generic format string for everything to add after the
 301  *            host/port, may be null
 302  * @return the number of characters written to the destination buffer
 303  */
 304 int ff_url_join(char *str, int size, const char *proto,
 305                 const char *authorization, const char *hostname,
 306                 int port, const char *fmt, ...) av_printf_format(7, 8);
 307
 308 /**
 309  * Convert a relative url into an absolute url, given a base url.
 310  *
 311  * @param buf the buffer where output absolute url is written
 312  * @param size the size of buf
 313  * @param base the base url, may be equal to buf.
 314  * @param rel the new url, which is interpreted relative to base
 315  */
 316 void ff_make_absolute_url(char *buf, int size, const char *base,
 317                           const char *rel);
 318
 319 /**
 320  * Allocate directory entry with default values.
 321  *
 322  * @return entry or NULL on error
 323  */
 324 AVIODirEntry *ff_alloc_dir_entry(void);
 325
 326
 327 #endif /* AVFORMAT_URL_H */