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

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20 #ifndef AVFORMAT_AVIO_H
  21 #define AVFORMAT_AVIO_H
  22
  23 /**
  24  * @file
  25  * @ingroup lavf_io
  26  * Buffered I/O operations
  27  */
  28
  29 #include <stdint.h>
  30
  31 #include "libavutil/common.h"
  32 #include "libavutil/dict.h"
  33 #include "libavutil/log.h"
  34
  35 #include "libavformat/version.h"
  36
  37
  38 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
  39
  40 /**
  41  * Callback for checking whether to abort blocking functions.
  42  * AVERROR_EXIT is returned in this case by the interrupted
  43  * function. During blocking operations, callback is called with
  44  * opaque as parameter. If the callback returns 1, the
  45  * blocking operation will be aborted.
  46  *
  47  * No members can be added to this struct without a major bump, if
  48  * new elements have been added after this struct in AVFormatContext
  49  * or AVIOContext.
  50  */
  51 typedef struct {
  52     int (*callback)(void*);
  53     void *opaque;
  54 } AVIOInterruptCB;
  55
  56 /**
  57  * Bytestream IO Context.
  58  * New fields can be added to the end with minor version bumps.
  59  * Removal, reordering and changes to existing fields require a major
  60  * version bump.
  61  * sizeof(AVIOContext) must not be used outside libav*.
  62  *
  63  * @note None of the function pointers in AVIOContext should be called
  64  *       directly, they should only be set by the client application
  65  *       when implementing custom I/O. Normally these are set to the
  66  *       function pointers specified in avio_alloc_context()
  67  */
  68 typedef struct {
  69 #if !FF_API_OLD_AVIO
  70     /**
  71      * A class for private options.
  72      *
  73      * If this AVIOContext is created by avio_open2(), av_class is set and
  74      * passes the options down to protocols.
  75      *
  76      * If this AVIOContext is manually allocated, then av_class may be set by
  77      * the caller.
  78      *
  79      * warning -- this field can be NULL, be sure to not pass this AVIOContext
  80      * to any av_opt_* functions in that case.
  81      */
  82     AVClass *av_class;
  83 #endif
  84     unsigned char *buffer;  /**< Start of the buffer. */
  85     int buffer_size;        /**< Maximum buffer size */
  86     unsigned char *buf_ptr; /**< Current position in the buffer */
  87     unsigned char *buf_end; /**< End of the data, may be less than
  88                                  buffer+buffer_size if the read function returned
  89                                  less data than requested, e.g. for streams where
  90                                  no more data has been received yet. */
  91     void *opaque;           /**< A private pointer, passed to the read/write/seek/...
  92                                  functions. */
  93     int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
  94     int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
  95     int64_t (*seek)(void *opaque, int64_t offset, int whence);
  96     int64_t pos;            /**< position in the file of the current buffer */
  97     int must_flush;         /**< true if the next seek should flush */
  98     int eof_reached;        /**< true if eof reached */
  99     int write_flag;         /**< true if open for writing */
 100 #if FF_API_OLD_AVIO
 101     attribute_deprecated int is_streamed;
 102 #endif
 103     int max_packet_size;
 104     unsigned long checksum;
 105     unsigned char *checksum_ptr;
 106     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
 107     int error;              /**< contains the error code or 0 if no error happened */
 108     /**
 109      * Pause or resume playback for network streaming protocols - e.g. MMS.
 110      */
 111     int (*read_pause)(void *opaque, int pause);
 112     /**
 113      * Seek to a given timestamp in stream with the specified stream_index.
 114      * Needed for some network streaming protocols which don't support seeking
 115      * to byte position.
 116      */
 117     int64_t (*read_seek)(void *opaque, int stream_index,
 118                          int64_t timestamp, int flags);
 119     /**
 120      * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
 121      */
 122     int seekable;
 123
 124     /**
 125      * max filesize, used to limit allocations
 126      * This field is internal to libavformat and access from outside is not allowed.
 127      */
 128      int64_t maxsize;
 129 } AVIOContext;
 130
 131 /* unbuffered I/O */
 132
 133 #if FF_API_OLD_AVIO
 134 /**
 135  * URL Context.
 136  * New fields can be added to the end with minor version bumps.
 137  * Removal, reordering and changes to existing fields require a major
 138  * version bump.
 139  * sizeof(URLContext) must not be used outside libav*.
 140  * @deprecated This struct will be made private
 141  */
 142 typedef struct URLContext {
 143     const AVClass *av_class; ///< information for av_log(). Set by url_open().
 144     struct URLProtocol *prot;
 145     int flags;
 146     int is_streamed;  /**< true if streamed (no seek possible), default = false */
 147     int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
 148     void *priv_data;
 149     char *filename; /**< specified URL */
 150     int is_connected;
 151     AVIOInterruptCB interrupt_callback;
 152 } URLContext;
 153
 154 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
 155 #define URL_PROTOCOL_FLAG_NETWORK       2 /*< The protocol uses network */
 156
 157 /**
 158  * @deprecated This struct is to be made private. Use the higher-level
 159  *             AVIOContext-based API instead.
 160  */
 161 typedef struct URLProtocol {
 162     const char *name;
 163     int (*url_open)(URLContext *h, const char *url, int flags);
 164     int (*url_read)(URLContext *h, unsigned char *buf, int size);
 165     int (*url_write)(URLContext *h, const unsigned char *buf, int size);
 166     int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
 167     int (*url_close)(URLContext *h);
 168     struct URLProtocol *next;
 169     int (*url_read_pause)(URLContext *h, int pause);
 170     int64_t (*url_read_seek)(URLContext *h, int stream_index,
 171                              int64_t timestamp, int flags);
 172     int (*url_get_file_handle)(URLContext *h);
 173     int priv_data_size;
 174     const AVClass *priv_data_class;
 175     int flags;
 176     int (*url_check)(URLContext *h, int mask);
 177 } URLProtocol;
 178
 179 typedef struct URLPollEntry {
 180     URLContext *handle;
 181     int events;
 182     int revents;
 183 } URLPollEntry;
 184
 185 /* not implemented */
 186 attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
 187
 188 /**
 189  * @name URL open modes
 190  * The flags argument to url_open and cosins must be one of the following
 191  * constants, optionally ORed with other flags.
 192  * @{
 193  */
 194 #define URL_RDONLY 1  /**< read-only */
 195 #define URL_WRONLY 2  /**< write-only */
 196 #define URL_RDWR   (URL_RDONLY|URL_WRONLY)  /**< read-write */
 197 /**
 198  * @}
 199  */
 200
 201 /**
 202  * Use non-blocking mode.
 203  * If this flag is set, operations on the context will return
 204  * AVERROR(EAGAIN) if they can not be performed immediately.
 205  * If this flag is not set, operations on the context will never return
 206  * AVERROR(EAGAIN).
 207  * Note that this flag does not affect the opening/connecting of the
 208  * context. Connecting a protocol will always block if necessary (e.g. on
 209  * network protocols) but never hang (e.g. on busy devices).
 210  * Warning: non-blocking protocols is work-in-progress; this flag may be
 211  * silently ignored.
 212  */
 213 #define URL_FLAG_NONBLOCK 8
 214
 215 typedef int URLInterruptCB(void);
 216 extern URLInterruptCB *url_interrupt_cb;
 217
 218 /**
 219  * @defgroup old_url_funcs Old url_* functions
 220  * The following functions are deprecated. Use the buffered API based on #AVIOContext instead.
 221  * @{
 222  * @ingroup lavf_io
 223  */
 224 attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
 225                                             const char *url, int flags);
 226 attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
 227 attribute_deprecated int url_connect(URLContext *h);
 228 attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
 229 attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
 230 attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
 231 attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
 232 attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
 233 attribute_deprecated int url_close(URLContext *h);
 234 attribute_deprecated int64_t url_filesize(URLContext *h);
 235 attribute_deprecated int url_get_file_handle(URLContext *h);
 236 attribute_deprecated int url_get_max_packet_size(URLContext *h);
 237 attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
 238 attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
 239 attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
 240                                               int64_t timestamp, int flags);
 241 attribute_deprecated void url_set_interrupt_cb(int (*interrupt_cb)(void));
 242
 243 /**
 244  * returns the next registered protocol after the given protocol (the first if
 245  * NULL is given), or NULL if protocol is the last one.
 246  */
 247 URLProtocol *av_protocol_next(URLProtocol *p);
 248
 249 /**
 250  * Register the URLProtocol protocol.
 251  *
 252  * @param size the size of the URLProtocol struct referenced
 253  */
 254 attribute_deprecated int av_register_protocol2(URLProtocol *protocol, int size);
 255 /**
 256  * @}
 257  */
 258
 259
 260 typedef attribute_deprecated AVIOContext ByteIOContext;
 261
 262 attribute_deprecated int init_put_byte(AVIOContext *s,
 263                   unsigned char *buffer,
 264                   int buffer_size,
 265                   int write_flag,
 266                   void *opaque,
 267                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
 268                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
 269                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
 270 attribute_deprecated AVIOContext *av_alloc_put_byte(
 271                   unsigned char *buffer,
 272                   int buffer_size,
 273                   int write_flag,
 274                   void *opaque,
 275                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
 276                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
 277                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
 278
 279 /**
 280  * @defgroup old_avio_funcs Old put_/get_*() functions
 281  * The following functions are deprecated. Use the "avio_"-prefixed functions instead.
 282  * @{
 283  * @ingroup lavf_io
 284  */
 285 attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
 286 attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
 287 attribute_deprecated int          get_byte(AVIOContext *s);
 288 attribute_deprecated unsigned int get_le16(AVIOContext *s);
 289 attribute_deprecated unsigned int get_le24(AVIOContext *s);
 290 attribute_deprecated unsigned int get_le32(AVIOContext *s);
 291 attribute_deprecated uint64_t     get_le64(AVIOContext *s);
 292 attribute_deprecated unsigned int get_be16(AVIOContext *s);
 293 attribute_deprecated unsigned int get_be24(AVIOContext *s);
 294 attribute_deprecated unsigned int get_be32(AVIOContext *s);
 295 attribute_deprecated uint64_t     get_be64(AVIOContext *s);
 296
 297 attribute_deprecated void         put_byte(AVIOContext *s, int b);
 298 attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
 299 attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
 300 attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
 301 attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
 302 attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
 303 attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
 304 attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
 305 attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
 306 attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
 307 attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
 308 attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
 309 /**
 310  * @}
 311  */
 312
 313 attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
 314 attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
 315                                                 int64_t timestamp, int flags);
 316
 317 /**
 318  * @defgroup old_url_f_funcs Old url_f* functions
 319  * The following functions are deprecated, use the "avio_"-prefixed functions instead.
 320  * @{
 321  * @ingroup lavf_io
 322  */
 323 attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
 324 attribute_deprecated int url_fclose(AVIOContext *s);
 325 attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
 326 attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
 327 attribute_deprecated int64_t url_ftell(AVIOContext *s);
 328 attribute_deprecated int64_t url_fsize(AVIOContext *s);
 329 #define URL_EOF (-1)
 330 attribute_deprecated int url_fgetc(AVIOContext *s);
 331 attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
 332 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
 333 attribute_deprecated void put_flush_packet(AVIOContext *s);
 334 attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
 335 attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
 336 attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
 337 attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
 338 /**
 339  * @}
 340  */
 341
 342 attribute_deprecated int url_ferror(AVIOContext *s);
 343
 344 attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
 345 attribute_deprecated int udp_get_local_port(URLContext *h);
 346
 347 attribute_deprecated void init_checksum(AVIOContext *s,
 348                    unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
 349                    unsigned long checksum);
 350 attribute_deprecated unsigned long get_checksum(AVIOContext *s);
 351 attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
 352 /** @note unlike fgets, the EOL character is not returned and a whole
 353     line is parsed. return NULL if first char read was EOF */
 354 attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
 355 /**
 356  * @deprecated use avio_get_str instead
 357  */
 358 attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
 359 /**
 360  * @deprecated Use AVIOContext.seekable field directly.
 361  */
 362 attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
 363 {
 364     return !s->seekable;
 365 }
 366 attribute_deprecated URLContext *url_fileno(AVIOContext *s);
 367
 368 /**
 369  * @deprecated use AVIOContext.max_packet_size directly.
 370  */
 371 attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
 372
 373 attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
 374
 375 /** return the written or read size */
 376 attribute_deprecated int url_close_buf(AVIOContext *s);
 377
 378 /**
 379  * Return a non-zero value if the resource indicated by url
 380  * exists, 0 otherwise.
 381  * @deprecated Use avio_check instead.
 382  */
 383 attribute_deprecated int url_exist(const char *url);
 384 #endif // FF_API_OLD_AVIO
 385
 386 /**
 387  * Return AVIO_FLAG_* access flags corresponding to the access permissions
 388  * of the resource in url, or a negative value corresponding to an
 389  * AVERROR code in case of failure. The returned access flags are
 390  * masked by the value in flags.
 391  *
 392  * @note This function is intrinsically unsafe, in the sense that the
 393  * checked resource may change its existence or permission status from
 394  * one call to another. Thus you should not trust the returned value,
 395  * unless you are sure that no other processes are accessing the
 396  * checked resource.
 397  */
 398 int avio_check(const char *url, int flags);
 399
 400 #if FF_API_OLD_INTERRUPT_CB
 401 /**
 402  * The callback is called in blocking functions to test regulary if
 403  * asynchronous interruption is needed. AVERROR_EXIT is returned
 404  * in this case by the interrupted function. 'NULL' means no interrupt
 405  * callback is given.
 406  * @deprecated Use interrupt_callback in AVFormatContext/avio_open2
 407  *             instead.
 408  */
 409 attribute_deprecated void avio_set_interrupt_cb(int (*interrupt_cb)(void));
 410 #endif
 411
 412 /**
 413  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
 414  * freed with av_free().
 415  *
 416  * @param buffer Memory block for input/output operations via AVIOContext.
 417  *        The buffer must be allocated with av_malloc() and friends.
 418  * @param buffer_size The buffer size is very important for performance.
 419  *        For protocols with fixed blocksize it should be set to this blocksize.
 420  *        For others a typical size is a cache page, e.g. 4kb.
 421  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
 422  * @param opaque An opaque pointer to user-specific data.
 423  * @param read_packet  A function for refilling the buffer, may be NULL.
 424  * @param write_packet A function for writing the buffer contents, may be NULL.
 425  * @param seek A function for seeking to specified byte position, may be NULL.
 426  *
 427  * @return Allocated AVIOContext or NULL on failure.
 428  */
 429 AVIOContext *avio_alloc_context(
 430                   unsigned char *buffer,
 431                   int buffer_size,
 432                   int write_flag,
 433                   void *opaque,
 434                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
 435                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
 436                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
 437
 438 void avio_w8(AVIOContext *s, int b);
 439 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
 440 void avio_wl64(AVIOContext *s, uint64_t val);
 441 void avio_wb64(AVIOContext *s, uint64_t val);
 442 void avio_wl32(AVIOContext *s, unsigned int val);
 443 void avio_wb32(AVIOContext *s, unsigned int val);
 444 void avio_wl24(AVIOContext *s, unsigned int val);
 445 void avio_wb24(AVIOContext *s, unsigned int val);
 446 void avio_wl16(AVIOContext *s, unsigned int val);
 447 void avio_wb16(AVIOContext *s, unsigned int val);
 448
 449 /**
 450  * Write a NULL-terminated string.
 451  * @return number of bytes written.
 452  */
 453 int avio_put_str(AVIOContext *s, const char *str);
 454
 455 /**
 456  * Convert an UTF-8 string to UTF-16LE and write it.
 457  * @return number of bytes written.
 458  */
 459 int avio_put_str16le(AVIOContext *s, const char *str);
 460
 461 /**
 462  * Passing this as the "whence" parameter to a seek function causes it to
 463  * return the filesize without seeking anywhere. Supporting this is optional.
 464  * If it is not supported then the seek function will return <0.
 465  */
 466 #define AVSEEK_SIZE 0x10000
 467
 468 /**
 469  * Oring this flag as into the "whence" parameter to a seek function causes it to
 470  * seek by any means (like reopening and linear reading) or other normally unreasonble
 471  * means that can be extreemly slow.
 472  * This may be ignored by the seek code.
 473  */
 474 #define AVSEEK_FORCE 0x20000
 475
 476 /**
 477  * fseek() equivalent for AVIOContext.
 478  * @return new position or AVERROR.
 479  */
 480 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
 481
 482 /**
 483  * Skip given number of bytes forward
 484  * @return new position or AVERROR.
 485  */
 486 int64_t avio_skip(AVIOContext *s, int64_t offset);
 487
 488 /**
 489  * ftell() equivalent for AVIOContext.
 490  * @return position or AVERROR.
 491  */
 492 static av_always_inline int64_t avio_tell(AVIOContext *s)
 493 {
 494     return avio_seek(s, 0, SEEK_CUR);
 495 }
 496
 497 /**
 498  * Get the filesize.
 499  * @return filesize or AVERROR
 500  */
 501 int64_t avio_size(AVIOContext *s);
 502
 503 /**
 504  * feof() equivalent for AVIOContext.
 505  * @return non zero if and only if end of file
 506  */
 507 int url_feof(AVIOContext *s);
 508
 509 /** @warning currently size is limited */
 510 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
 511
 512 void avio_flush(AVIOContext *s);
 513
 514
 515 /**
 516  * Read size bytes from AVIOContext into buf.
 517  * @return number of bytes read or AVERROR
 518  */
 519 int avio_read(AVIOContext *s, unsigned char *buf, int size);
 520
 521 /**
 522  * @name Functions for reading from AVIOContext
 523  * @{
 524  *
 525  * @note return 0 if EOF, so you cannot use it if EOF handling is
 526  *       necessary
 527  */
 528 int          avio_r8  (AVIOContext *s);
 529 unsigned int avio_rl16(AVIOContext *s);
 530 unsigned int avio_rl24(AVIOContext *s);
 531 unsigned int avio_rl32(AVIOContext *s);
 532 uint64_t     avio_rl64(AVIOContext *s);
 533 unsigned int avio_rb16(AVIOContext *s);
 534 unsigned int avio_rb24(AVIOContext *s);
 535 unsigned int avio_rb32(AVIOContext *s);
 536 uint64_t     avio_rb64(AVIOContext *s);
 537 /**
 538  * @}
 539  */
 540
 541 /**
 542  * Read a string from pb into buf. The reading will terminate when either
 543  * a NULL character was encountered, maxlen bytes have been read, or nothing
 544  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
 545  * will be truncated if buf is too small.
 546  * Note that the string is not interpreted or validated in any way, it
 547  * might get truncated in the middle of a sequence for multi-byte encodings.
 548  *
 549  * @return number of bytes read (is always <= maxlen).
 550  * If reading ends on EOF or error, the return value will be one more than
 551  * bytes actually read.
 552  */
 553 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
 554
 555 /**
 556  * Read a UTF-16 string from pb and convert it to UTF-8.
 557  * The reading will terminate when either a null or invalid character was
 558  * encountered or maxlen bytes have been read.
 559  * @return number of bytes read (is always <= maxlen)
 560  */
 561 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
 562 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
 563
 564
 565 /**
 566  * @name URL open modes
 567  * The flags argument to avio_open must be one of the following
 568  * constants, optionally ORed with other flags.
 569  * @{
 570  */
 571 #define AVIO_FLAG_READ  1                                      /**< read-only */
 572 #define AVIO_FLAG_WRITE 2                                      /**< write-only */
 573 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE)  /**< read-write pseudo flag */
 574 /**
 575  * @}
 576  */
 577
 578 /**
 579  * Use non-blocking mode.
 580  * If this flag is set, operations on the context will return
 581  * AVERROR(EAGAIN) if they can not be performed immediately.
 582  * If this flag is not set, operations on the context will never return
 583  * AVERROR(EAGAIN).
 584  * Note that this flag does not affect the opening/connecting of the
 585  * context. Connecting a protocol will always block if necessary (e.g. on
 586  * network protocols) but never hang (e.g. on busy devices).
 587  * Warning: non-blocking protocols is work-in-progress; this flag may be
 588  * silently ignored.
 589  */
 590 #define AVIO_FLAG_NONBLOCK 8
 591
 592 /**
 593  * Create and initialize a AVIOContext for accessing the
 594  * resource indicated by url.
 595  * @note When the resource indicated by url has been opened in
 596  * read+write mode, the AVIOContext can be used only for writing.
 597  *
 598  * @param s Used to return the pointer to the created AVIOContext.
 599  * In case of failure the pointed to value is set to NULL.
 600  * @param flags flags which control how the resource indicated by url
 601  * is to be opened
 602  * @return 0 in case of success, a negative value corresponding to an
 603  * AVERROR code in case of failure
 604  */
 605 int avio_open(AVIOContext **s, const char *url, int flags);
 606
 607 /**
 608  * Create and initialize a AVIOContext for accessing the
 609  * resource indicated by url.
 610  * @note When the resource indicated by url has been opened in
 611  * read+write mode, the AVIOContext can be used only for writing.
 612  *
 613  * @param s Used to return the pointer to the created AVIOContext.
 614  * In case of failure the pointed to value is set to NULL.
 615  * @param flags flags which control how the resource indicated by url
 616  * is to be opened
 617  * @param int_cb an interrupt callback to be used at the protocols level
 618  * @param options  A dictionary filled with protocol-private options. On return
 619  * this parameter will be destroyed and replaced with a dict containing options
 620  * that were not found. May be NULL.
 621  * @return 0 in case of success, a negative value corresponding to an
 622  * AVERROR code in case of failure
 623  */
 624 int avio_open2(AVIOContext **s, const char *url, int flags,
 625                const AVIOInterruptCB *int_cb, AVDictionary **options);
 626
 627 /**
 628  * Close the resource accessed by the AVIOContext s and free it.
 629  * This function can only be used if s was opened by avio_open().
 630  *
 631  * @return 0 on success, an AVERROR < 0 on error.
 632  */
 633 int avio_close(AVIOContext *s);
 634
 635 /**
 636  * Open a write only memory stream.
 637  *
 638  * @param s new IO context
 639  * @return zero if no error.
 640  */
 641 int avio_open_dyn_buf(AVIOContext **s);
 642
 643 /**
 644  * Return the written size and a pointer to the buffer. The buffer
 645  * must be freed with av_free().
 646  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
 647  *
 648  * @param s IO context
 649  * @param pbuffer pointer to a byte buffer
 650  * @return the length of the byte buffer
 651  */
 652 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
 653
 654 /**
 655  * Iterate through names of available protocols.
 656  * @note it is recommanded to use av_protocol_next() instead of this
 657  *
 658  * @param opaque A private pointer representing current protocol.
 659  *        It must be a pointer to NULL on first iteration and will
 660  *        be updated by successive calls to avio_enum_protocols.
 661  * @param output If set to 1, iterate over output protocols,
 662  *               otherwise over input protocols.
 663  *
 664  * @return A static string containing the name of current protocol or NULL
 665  */
 666 const char *avio_enum_protocols(void **opaque, int output);
 667
 668 /**
 669  * Pause and resume playing - only meaningful if using a network streaming
 670  * protocol (e.g. MMS).
 671  * @param pause 1 for pause, 0 for resume
 672  */
 673 int     avio_pause(AVIOContext *h, int pause);
 674
 675 /**
 676  * Seek to a given timestamp relative to some component stream.
 677  * Only meaningful if using a network streaming protocol (e.g. MMS.).
 678  * @param stream_index The stream index that the timestamp is relative to.
 679  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
 680  *        units from the beginning of the presentation.
 681  *        If a stream_index >= 0 is used and the protocol does not support
 682  *        seeking based on component streams, the call will fail.
 683  * @param timestamp timestamp in AVStream.time_base units
 684  *        or if there is no stream specified then in AV_TIME_BASE units.
 685  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
 686  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
 687  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
 688  *        fail if used and not supported.
 689  * @return >= 0 on success
 690  * @see AVInputFormat::read_seek
 691  */
 692 int64_t avio_seek_time(AVIOContext *h, int stream_index,
 693                        int64_t timestamp, int flags);
 694
 695 #endif /* AVFORMAT_AVIO_H */