avio.h 18.4 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
20 21
#ifndef AVFORMAT_AVIO_H
#define AVFORMAT_AVIO_H
22

23
/**
24
 * @file
25
 * @ingroup lavf_io
26
 * Buffered I/O operations
27 28
 */

29 30
#include <stdint.h>

31
#include "libavutil/common.h"
32
#include "libavutil/dict.h"
33
#include "libavutil/log.h"
34

35 36
#include "libavformat/version.h"

37 38 39

#define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */

40 41 42 43 44 45 46 47 48 49 50
/**
 * Callback for checking whether to abort blocking functions.
 * AVERROR_EXIT is returned in this case by the interrupted
 * function. During blocking operations, callback is called with
 * opaque as parameter. If the callback returns 1, the
 * blocking operation will be aborted.
 *
 * No members can be added to this struct without a major bump, if
 * new elements have been added after this struct in AVFormatContext
 * or AVIOContext.
 */
51
typedef struct AVIOInterruptCB {
52 53 54 55
    int (*callback)(void*);
    void *opaque;
} AVIOInterruptCB;

56 57 58 59 60 61
/**
 * Bytestream IO Context.
 * New fields can be added to the end with minor version bumps.
 * Removal, reordering and changes to existing fields require a major
 * version bump.
 * sizeof(AVIOContext) must not be used outside libav*.
62 63 64 65 66
 *
 * @note None of the function pointers in AVIOContext should be called
 *       directly, they should only be set by the client application
 *       when implementing custom I/O. Normally these are set to the
 *       function pointers specified in avio_alloc_context()
67
 */
68
typedef struct AVIOContext {
69 70 71 72 73 74 75 76 77 78 79 80
    /**
     * A class for private options.
     *
     * If this AVIOContext is created by avio_open2(), av_class is set and
     * passes the options down to protocols.
     *
     * If this AVIOContext is manually allocated, then av_class may be set by
     * the caller.
     *
     * warning -- this field can be NULL, be sure to not pass this AVIOContext
     * to any av_opt_* functions in that case.
     */
81
    const AVClass *av_class;
82 83 84 85 86 87 88 89 90
    unsigned char *buffer;  /**< Start of the buffer. */
    int buffer_size;        /**< Maximum buffer size */
    unsigned char *buf_ptr; /**< Current position in the buffer */
    unsigned char *buf_end; /**< End of the data, may be less than
                                 buffer+buffer_size if the read function returned
                                 less data than requested, e.g. for streams where
                                 no more data has been received yet. */
    void *opaque;           /**< A private pointer, passed to the read/write/seek/...
                                 functions. */
91 92 93
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
94 95 96 97
    int64_t pos;            /**< position in the file of the current buffer */
    int must_flush;         /**< true if the next seek should flush */
    int eof_reached;        /**< true if eof reached */
    int write_flag;         /**< true if open for writing */
98 99 100 101
    int max_packet_size;
    unsigned long checksum;
    unsigned char *checksum_ptr;
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
102
    int error;              /**< contains the error code or 0 if no error happened */
103 104 105
    /**
     * Pause or resume playback for network streaming protocols - e.g. MMS.
     */
106
    int (*read_pause)(void *opaque, int pause);
107 108 109 110 111
    /**
     * Seek to a given timestamp in stream with the specified stream_index.
     * Needed for some network streaming protocols which don't support seeking
     * to byte position.
     */
112 113 114 115 116 117
    int64_t (*read_seek)(void *opaque, int stream_index,
                         int64_t timestamp, int flags);
    /**
     * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
     */
    int seekable;
118 119 120 121 122

    /**
     * max filesize, used to limit allocations
     * This field is internal to libavformat and access from outside is not allowed.
     */
123
    int64_t maxsize;
124

125 126 127 128 129 130
    /**
     * avio_read and avio_write should if possible be satisfied directly
     * instead of going through a buffer, and avio_seek will always
     * call the underlying seek function directly.
     */
    int direct;
131 132 133 134 135

    /**
     * Bytes read statistic
     * This field is internal to libavformat and access from outside is not allowed.
     */
136
    int64_t bytes_read;
137 138 139 140 141

    /**
     * seek statistic
     * This field is internal to libavformat and access from outside is not allowed.
     */
142
    int seek_count;
143 144 145 146 147

    /**
     * writeout statistic
     * This field is internal to libavformat and access from outside is not allowed.
     */
148
    int writeout_count;
149 150 151 152 153 154 155

    /**
     * Original buffer size
     * used internally after probing and ensure seekback to reset the buffer size
     * This field is internal to libavformat and access from outside is not allowed.
     */
    int orig_buffer_size;
156 157
} AVIOContext;

Fabrice Bellard's avatar
Fabrice Bellard committed
158 159
/* unbuffered I/O */

160 161 162 163 164 165 166 167 168
/**
 * Return the name of the protocol that will handle the passed URL.
 *
 * NULL is returned if no protocol could be found for the given URL.
 *
 * @return Name of the protocol or NULL.
 */
const char *avio_find_protocol_name(const char *url);

169
/**
170
 * Return AVIO_FLAG_* access flags corresponding to the access permissions
171 172 173 174 175 176 177 178 179 180 181
 * of the resource in url, or a negative value corresponding to an
 * AVERROR code in case of failure. The returned access flags are
 * masked by the value in flags.
 *
 * @note This function is intrinsically unsafe, in the sense that the
 * checked resource may change its existence or permission status from
 * one call to another. Thus you should not trust the returned value,
 * unless you are sure that no other processes are accessing the
 * checked resource.
 */
int avio_check(const char *url, int flags);
182

183 184 185 186 187
/**
 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
 * freed with av_free().
 *
 * @param buffer Memory block for input/output operations via AVIOContext.
188
 *        The buffer must be allocated with av_malloc() and friends.
189 190 191
 *        It may be freed and replaced with a new buffer by libavformat.
 *        AVIOContext.buffer holds the buffer currently in use,
 *        which must be later freed with av_free().
192 193 194 195 196 197 198
 * @param buffer_size The buffer size is very important for performance.
 *        For protocols with fixed blocksize it should be set to this blocksize.
 *        For others a typical size is a cache page, e.g. 4kb.
 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
 * @param opaque An opaque pointer to user-specific data.
 * @param read_packet  A function for refilling the buffer, may be NULL.
 * @param write_packet A function for writing the buffer contents, may be NULL.
199
 *        The function may not change the input buffers content.
200 201 202 203
 * @param seek A function for seeking to specified byte position, may be NULL.
 *
 * @return Allocated AVIOContext or NULL on failure.
 */
204
AVIOContext *avio_alloc_context(
205 206 207 208
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
209
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
210
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
211
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
Fabrice Bellard's avatar
Fabrice Bellard committed
212

213 214 215 216 217 218 219 220 221 222
void avio_w8(AVIOContext *s, int b);
void avio_write(AVIOContext *s, const unsigned char *buf, int size);
void avio_wl64(AVIOContext *s, uint64_t val);
void avio_wb64(AVIOContext *s, uint64_t val);
void avio_wl32(AVIOContext *s, unsigned int val);
void avio_wb32(AVIOContext *s, unsigned int val);
void avio_wl24(AVIOContext *s, unsigned int val);
void avio_wb24(AVIOContext *s, unsigned int val);
void avio_wl16(AVIOContext *s, unsigned int val);
void avio_wb16(AVIOContext *s, unsigned int val);
Fabrice Bellard's avatar
Fabrice Bellard committed
223

224 225 226 227
/**
 * Write a NULL-terminated string.
 * @return number of bytes written.
 */
228
int avio_put_str(AVIOContext *s, const char *str);
229

230 231 232 233
/**
 * Convert an UTF-8 string to UTF-16LE and write it.
 * @return number of bytes written.
 */
234
int avio_put_str16le(AVIOContext *s, const char *str);
235

236 237 238 239 240 241 242 243 244
/**
 * Passing this as the "whence" parameter to a seek function causes it to
 * return the filesize without seeking anywhere. Supporting this is optional.
 * If it is not supported then the seek function will return <0.
 */
#define AVSEEK_SIZE 0x10000

/**
 * Oring this flag as into the "whence" parameter to a seek function causes it to
245 246
 * seek by any means (like reopening and linear reading) or other normally unreasonable
 * means that can be extremely slow.
247 248 249 250
 * This may be ignored by the seek code.
 */
#define AVSEEK_FORCE 0x20000

251
/**
252
 * fseek() equivalent for AVIOContext.
253 254
 * @return new position or AVERROR.
 */
255
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
256

Michael Niedermayer's avatar
Michael Niedermayer committed
257 258 259 260 261 262
/**
 * Skip given number of bytes forward
 * @return new position or AVERROR.
 */
int64_t avio_skip(AVIOContext *s, int64_t offset);

263
/**
264
 * ftell() equivalent for AVIOContext.
265 266
 * @return position or AVERROR.
 */
267 268 269 270
static av_always_inline int64_t avio_tell(AVIOContext *s)
{
    return avio_seek(s, 0, SEEK_CUR);
}
271 272

/**
273
 * Get the filesize.
274 275
 * @return filesize or AVERROR
 */
276
int64_t avio_size(AVIOContext *s);
277 278

/**
279
 * feof() equivalent for AVIOContext.
280 281
 * @return non zero if and only if end of file
 */
282 283 284 285 286 287
int avio_feof(AVIOContext *s);
#if FF_API_URL_FEOF
/**
 * @deprecated use avio_feof()
 */
attribute_deprecated
288
int url_feof(AVIOContext *s);
289
#endif
290

291
/** @warning currently size is limited */
292
int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
293

294
/**
295
 * Force flushing of buffered data.
296
 *
297
 * For write streams, force the buffered data to be immediately written to the output,
298
 * without to wait to fill the internal buffer.
299 300 301 302
 *
 * For read streams, discard all currently buffered data, and advance the
 * reported file position to that of the underlying stream. This does not
 * read new data, and does not perform any seeks.
303
 */
304
void avio_flush(AVIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
305

306
/**
307
 * Read size bytes from AVIOContext into buf.
308
 * @return number of bytes read or AVERROR
309
 */
310
int avio_read(AVIOContext *s, unsigned char *buf, int size);
311

312
/**
313
 * @name Functions for reading from AVIOContext
314 315 316 317 318
 * @{
 *
 * @note return 0 if EOF, so you cannot use it if EOF handling is
 *       necessary
 */
319 320 321 322 323
int          avio_r8  (AVIOContext *s);
unsigned int avio_rl16(AVIOContext *s);
unsigned int avio_rl24(AVIOContext *s);
unsigned int avio_rl32(AVIOContext *s);
uint64_t     avio_rl64(AVIOContext *s);
324 325 326 327 328 329 330
unsigned int avio_rb16(AVIOContext *s);
unsigned int avio_rb24(AVIOContext *s);
unsigned int avio_rb32(AVIOContext *s);
uint64_t     avio_rb64(AVIOContext *s);
/**
 * @}
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
331

332 333 334 335 336 337 338 339 340 341 342 343 344 345
/**
 * Read a string from pb into buf. The reading will terminate when either
 * a NULL character was encountered, maxlen bytes have been read, or nothing
 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
 * will be truncated if buf is too small.
 * Note that the string is not interpreted or validated in any way, it
 * might get truncated in the middle of a sequence for multi-byte encodings.
 *
 * @return number of bytes read (is always <= maxlen).
 * If reading ends on EOF or error, the return value will be one more than
 * bytes actually read.
 */
int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);

346 347 348 349 350 351
/**
 * Read a UTF-16 string from pb and convert it to UTF-8.
 * The reading will terminate when either a null or invalid character was
 * encountered or maxlen bytes have been read.
 * @return number of bytes read (is always <= maxlen)
 */
352 353
int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
354

355

356
/**
357
 * @name URL open modes
358 359 360 361
 * The flags argument to avio_open must be one of the following
 * constants, optionally ORed with other flags.
 * @{
 */
362 363 364
#define AVIO_FLAG_READ  1                                      /**< read-only */
#define AVIO_FLAG_WRITE 2                                      /**< write-only */
#define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE)  /**< read-write pseudo flag */
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
/**
 * @}
 */

/**
 * Use non-blocking mode.
 * If this flag is set, operations on the context will return
 * AVERROR(EAGAIN) if they can not be performed immediately.
 * If this flag is not set, operations on the context will never return
 * AVERROR(EAGAIN).
 * Note that this flag does not affect the opening/connecting of the
 * context. Connecting a protocol will always block if necessary (e.g. on
 * network protocols) but never hang (e.g. on busy devices).
 * Warning: non-blocking protocols is work-in-progress; this flag may be
 * silently ignored.
 */
381
#define AVIO_FLAG_NONBLOCK 8
382

383 384 385 386 387 388 389 390
/**
 * Use direct mode.
 * avio_read and avio_write should if possible be satisfied directly
 * instead of going through a buffer, and avio_seek will always
 * call the underlying seek function directly.
 */
#define AVIO_FLAG_DIRECT 0x8000

Stefano Sabatini's avatar
Stefano Sabatini committed
391
/**
392
 * Create and initialize a AVIOContext for accessing the
Stefano Sabatini's avatar
Stefano Sabatini committed
393 394
 * resource indicated by url.
 * @note When the resource indicated by url has been opened in
395
 * read+write mode, the AVIOContext can be used only for writing.
Stefano Sabatini's avatar
Stefano Sabatini committed
396
 *
397
 * @param s Used to return the pointer to the created AVIOContext.
Stefano Sabatini's avatar
Stefano Sabatini committed
398
 * In case of failure the pointed to value is set to NULL.
399
 * @param url resource to access
Stefano Sabatini's avatar
Stefano Sabatini committed
400 401
 * @param flags flags which control how the resource indicated by url
 * is to be opened
402
 * @return >= 0 in case of success, a negative value corresponding to an
Stefano Sabatini's avatar
Stefano Sabatini committed
403 404
 * AVERROR code in case of failure
 */
405
int avio_open(AVIOContext **s, const char *url, int flags);
Stefano Sabatini's avatar
Stefano Sabatini committed
406

407 408 409 410 411 412 413 414
/**
 * Create and initialize a AVIOContext for accessing the
 * resource indicated by url.
 * @note When the resource indicated by url has been opened in
 * read+write mode, the AVIOContext can be used only for writing.
 *
 * @param s Used to return the pointer to the created AVIOContext.
 * In case of failure the pointed to value is set to NULL.
415
 * @param url resource to access
416 417 418 419 420 421
 * @param flags flags which control how the resource indicated by url
 * is to be opened
 * @param int_cb an interrupt callback to be used at the protocols level
 * @param options  A dictionary filled with protocol-private options. On return
 * this parameter will be destroyed and replaced with a dict containing options
 * that were not found. May be NULL.
422
 * @return >= 0 in case of success, a negative value corresponding to an
423 424 425 426 427
 * AVERROR code in case of failure
 */
int avio_open2(AVIOContext **s, const char *url, int flags,
               const AVIOInterruptCB *int_cb, AVDictionary **options);

428
/**
429 430 431
 * Close the resource accessed by the AVIOContext s and free it.
 * This function can only be used if s was opened by avio_open().
 *
432 433 434
 * The internal buffer is automatically flushed before closing the
 * resource.
 *
435
 * @return 0 on success, an AVERROR < 0 on error.
436
 * @see avio_closep
437
 */
438
int avio_close(AVIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
439

440 441 442 443 444 445 446 447 448 449 450 451 452 453
/**
 * Close the resource accessed by the AVIOContext *s, free it
 * and set the pointer pointing to it to NULL.
 * This function can only be used if s was opened by avio_open().
 *
 * The internal buffer is automatically flushed before closing the
 * resource.
 *
 * @return 0 on success, an AVERROR < 0 on error.
 * @see avio_close
 */
int avio_closep(AVIOContext **s);


454
/**
455 456 457 458 459
 * Open a write only memory stream.
 *
 * @param s new IO context
 * @return zero if no error.
 */
460
int avio_open_dyn_buf(AVIOContext **s);
461

462
/**
463
 * Return the written size and a pointer to the buffer. The buffer
464 465
 * must be freed with av_free().
 * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
466
 *
467
 * @param s IO context
468
 * @param pbuffer pointer to a byte buffer
469 470
 * @return the length of the byte buffer
 */
471
int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
472

473 474 475 476 477 478 479 480 481 482 483 484 485
/**
 * Iterate through names of available protocols.
 *
 * @param opaque A private pointer representing current protocol.
 *        It must be a pointer to NULL on first iteration and will
 *        be updated by successive calls to avio_enum_protocols.
 * @param output If set to 1, iterate over output protocols,
 *               otherwise over input protocols.
 *
 * @return A static string containing the name of current protocol or NULL
 */
const char *avio_enum_protocols(void **opaque, int output);

486 487 488
/**
 * Pause and resume playing - only meaningful if using a network streaming
 * protocol (e.g. MMS).
489 490
 *
 * @param h     IO context from which to call the read_pause function pointer
491 492 493 494 495 496 497
 * @param pause 1 for pause, 0 for resume
 */
int     avio_pause(AVIOContext *h, int pause);

/**
 * Seek to a given timestamp relative to some component stream.
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
498 499
 *
 * @param h IO context from which to call the seek function pointers
500 501 502 503
 * @param stream_index The stream index that the timestamp is relative to.
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
 *        units from the beginning of the presentation.
 *        If a stream_index >= 0 is used and the protocol does not support
504
 *        seeking based on component streams, the call will fail.
505 506 507 508 509
 * @param timestamp timestamp in AVStream.time_base units
 *        or if there is no stream specified then in AV_TIME_BASE units.
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
510
 *        fail if used and not supported.
511 512 513 514 515 516
 * @return >= 0 on success
 * @see AVInputFormat::read_seek
 */
int64_t avio_seek_time(AVIOContext *h, int stream_index,
                       int64_t timestamp, int flags);

517 518 519
/* Avoid a warning. The header can not be included because it breaks c++. */
struct AVBPrint;

520 521 522 523 524 525
/**
 * Read contents of h into print buffer, up to max_size bytes, or up to EOF.
 *
 * @return 0 for success (max_size bytes read or EOF reached), negative error
 * code otherwise
 */
526
int avio_read_to_bprint(AVIOContext *h, struct AVBPrint *pb, size_t max_size);
527

528
#endif /* AVFORMAT_AVIO_H */