Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 175389c8

History | View | Annotate | Download (25 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of Libav.
5
 *
6
 * Libav 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
 * Libav 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 Libav; 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
 * Buffered I/O operations
26
 */
27

    
28
#include <stdint.h>
29

    
30
#include "libavutil/common.h"
31
#include "libavutil/log.h"
32

    
33
#include "libavformat/version.h"
34

    
35

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

    
38
/**
39
 * Bytestream IO Context.
40
 * New fields can be added to the end with minor version bumps.
41
 * Removal, reordering and changes to existing fields require a major
42
 * version bump.
43
 * sizeof(AVIOContext) must not be used outside libav*.
44
 *
45
 * @note None of the function pointers in AVIOContext should be called
46
 *       directly, they should only be set by the client application
47
 *       when implementing custom I/O. Normally these are set to the
48
 *       function pointers specified in avio_alloc_context()
49
 */
50
typedef struct {
51
    unsigned char *buffer;  /**< Start of the buffer. */
52
    int buffer_size;        /**< Maximum buffer size */
53
    unsigned char *buf_ptr; /**< Current position in the buffer */
54
    unsigned char *buf_end; /**< End of the data, may be less than
55
                                 buffer+buffer_size if the read function returned
56
                                 less data than requested, e.g. for streams where
57
                                 no more data has been received yet. */
58
    void *opaque;           /**< A private pointer, passed to the read/write/seek/...
59
                                 functions. */
60
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
61
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
62
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
63
    int64_t pos;            /**< position in the file of the current buffer */
64
    int must_flush;         /**< true if the next seek should flush */
65
    int eof_reached;        /**< true if eof reached */
66
    int write_flag;         /**< true if open for writing */
67
#if FF_API_OLD_AVIO
68
    attribute_deprecated int is_streamed;
69
#endif
70
    int max_packet_size;
71
    unsigned long checksum;
72
    unsigned char *checksum_ptr;
73
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
74
    int error;              /**< contains the error code or 0 if no error happened */
75
    /**
76
     * Pause or resume playback for network streaming protocols - e.g. MMS.
77
     */
78
    int (*read_pause)(void *opaque, int pause);
79
    /**
80
     * Seek to a given timestamp in stream with the specified stream_index.
81
     * Needed for some network streaming protocols which don't support seeking
82
     * to byte position.
83
     */
84
    int64_t (*read_seek)(void *opaque, int stream_index,
85
                         int64_t timestamp, int flags);
86
    /**
87
     * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
88
     */
89
    int seekable;
90
} AVIOContext;
91

    
92
/* unbuffered I/O */
93

    
94
#if FF_API_OLD_AVIO
95
/**
96
 * URL Context.
97
 * New fields can be added to the end with minor version bumps.
98
 * Removal, reordering and changes to existing fields require a major
99
 * version bump.
100
 * sizeof(URLContext) must not be used outside libav*.
101
 * @deprecated This struct will be made private
102
 */
103
typedef struct URLContext {
104
#if FF_API_URL_CLASS
105
    const AVClass *av_class; ///< information for av_log(). Set by url_open().
106
#endif
107
    struct URLProtocol *prot;
108
    int flags;
109
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
110
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
111
    void *priv_data;
112
    char *filename; /**< specified URL */
113
    int is_connected;
114
} URLContext;
115

    
116
#define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
117

    
118
/**
119
 * @deprecated This struct is to be made private. Use the higher-level
120
 *             AVIOContext-based API instead.
121
 */
122
typedef struct URLProtocol {
123
    const char *name;
124
    int (*url_open)(URLContext *h, const char *url, int flags);
125
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
126
    int (*url_write)(URLContext *h, const unsigned char *buf, int size);
127
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
128
    int (*url_close)(URLContext *h);
129
    struct URLProtocol *next;
130
    int (*url_read_pause)(URLContext *h, int pause);
131
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
132
                             int64_t timestamp, int flags);
133
    int (*url_get_file_handle)(URLContext *h);
134
    int priv_data_size;
135
    const AVClass *priv_data_class;
136
    int flags;
137
    int (*url_check)(URLContext *h, int mask);
138
} URLProtocol;
139

    
140
typedef struct URLPollEntry {
141
    URLContext *handle;
142
    int events;
143
    int revents;
144
} URLPollEntry;
145

    
146
/* not implemented */
147
attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
148

    
149
/**
150
 * @defgroup open_modes URL open modes
151
 * The flags argument to url_open and cosins must be one of the following
152
 * constants, optionally ORed with other flags.
153
 * @{
154
 */
155
#define URL_RDONLY 0  /**< read-only */
156
#define URL_WRONLY 1  /**< write-only */
157
#define URL_RDWR   2  /**< read-write */
158
/**
159
 * @}
160
 */
161

    
162
/**
163
 * Use non-blocking mode.
164
 * If this flag is set, operations on the context will return
165
 * AVERROR(EAGAIN) if they can not be performed immediately.
166
 * If this flag is not set, operations on the context will never return
167
 * AVERROR(EAGAIN).
168
 * Note that this flag does not affect the opening/connecting of the
169
 * context. Connecting a protocol will always block if necessary (e.g. on
170
 * network protocols) but never hang (e.g. on busy devices).
171
 * Warning: non-blocking protocols is work-in-progress; this flag may be
172
 * silently ignored.
173
 */
174
#define URL_FLAG_NONBLOCK 4
175

    
176
typedef int URLInterruptCB(void);
177
extern URLInterruptCB *url_interrupt_cb;
178

    
179
/**
180
 * @defgroup old_url_funcs Old url_* functions
181
 * @deprecated use the buffered API based on AVIOContext instead
182
 * @{
183
 */
184
attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
185
                                            const char *url, int flags);
186
attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
187
attribute_deprecated int url_connect(URLContext *h);
188
attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
189
attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
190
attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
191
attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
192
attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
193
attribute_deprecated int url_close(URLContext *h);
194
attribute_deprecated int64_t url_filesize(URLContext *h);
195
attribute_deprecated int url_get_file_handle(URLContext *h);
196
attribute_deprecated int url_get_max_packet_size(URLContext *h);
197
attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
198
attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
199
attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
200
                                              int64_t timestamp, int flags);
201
attribute_deprecated void url_set_interrupt_cb(int (*interrupt_cb)(void));
202
/**
203
 * If protocol is NULL, returns the first registered protocol,
204
 * if protocol is non-NULL, returns the next registered protocol after protocol,
205
 * or NULL if protocol is the last one.
206
 */
207
attribute_deprecated URLProtocol *av_protocol_next(URLProtocol *p);
208
/**
209
 * Register the URLProtocol protocol.
210
 *
211
 * @param size the size of the URLProtocol struct referenced
212
 */
213
attribute_deprecated int av_register_protocol2(URLProtocol *protocol, int size);
214
/**
215
 * @}
216
 */
217

    
218

    
219
typedef attribute_deprecated AVIOContext ByteIOContext;
220

    
221
attribute_deprecated int init_put_byte(AVIOContext *s,
222
                  unsigned char *buffer,
223
                  int buffer_size,
224
                  int write_flag,
225
                  void *opaque,
226
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
227
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
228
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
229
attribute_deprecated AVIOContext *av_alloc_put_byte(
230
                  unsigned char *buffer,
231
                  int buffer_size,
232
                  int write_flag,
233
                  void *opaque,
234
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
235
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
236
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
237

    
238
/**
239
 * @defgroup old_avio_funcs Old put_/get_*() functions
240
 * @deprecated use the avio_ -prefixed functions instead.
241
 * @{
242
 */
243
attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
244
attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
245
attribute_deprecated int          get_byte(AVIOContext *s);
246
attribute_deprecated unsigned int get_le16(AVIOContext *s);
247
attribute_deprecated unsigned int get_le24(AVIOContext *s);
248
attribute_deprecated unsigned int get_le32(AVIOContext *s);
249
attribute_deprecated uint64_t     get_le64(AVIOContext *s);
250
attribute_deprecated unsigned int get_be16(AVIOContext *s);
251
attribute_deprecated unsigned int get_be24(AVIOContext *s);
252
attribute_deprecated unsigned int get_be32(AVIOContext *s);
253
attribute_deprecated uint64_t     get_be64(AVIOContext *s);
254

    
255
attribute_deprecated void         put_byte(AVIOContext *s, int b);
256
attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
257
attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
258
attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
259
attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
260
attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
261
attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
262
attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
263
attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
264
attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
265
attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
266
attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
267
/**
268
 * @}
269
 */
270

    
271
attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
272
attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
273
                                                int64_t timestamp, int flags);
274

    
275
/**
276
 * @defgroup old_url_f_funcs Old url_f* functions
277
 * @deprecated use the avio_ -prefixed functions instead.
278
 * @{
279
 */
280
attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
281
attribute_deprecated int url_fclose(AVIOContext *s);
282
attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
283
attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
284
attribute_deprecated int64_t url_ftell(AVIOContext *s);
285
attribute_deprecated int64_t url_fsize(AVIOContext *s);
286
#define URL_EOF (-1)
287
attribute_deprecated int url_fgetc(AVIOContext *s);
288
attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
289
#ifdef __GNUC__
290
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
291
#else
292
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
293
#endif
294
attribute_deprecated void put_flush_packet(AVIOContext *s);
295
attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
296
attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
297
attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
298
attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
299
/**
300
 * @}
301
 */
302

    
303
/**
304
 * @deprecated use AVIOContext.eof_reached
305
 */
306
attribute_deprecated int url_feof(AVIOContext *s);
307
attribute_deprecated int url_ferror(AVIOContext *s);
308

    
309
attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
310
attribute_deprecated int udp_get_local_port(URLContext *h);
311

    
312
attribute_deprecated void init_checksum(AVIOContext *s,
313
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
314
                   unsigned long checksum);
315
attribute_deprecated unsigned long get_checksum(AVIOContext *s);
316
attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
317
/** @note unlike fgets, the EOL character is not returned and a whole
318
    line is parsed. return NULL if first char read was EOF */
319
attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
320
/**
321
 * @deprecated use avio_get_str instead
322
 */
323
attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
324
/**
325
 * @deprecated Use AVIOContext.seekable field directly.
326
 */
327
attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
328
{
329
    return !s->seekable;
330
}
331
attribute_deprecated URLContext *url_fileno(AVIOContext *s);
332

    
333
/**
334
 * @deprecated use AVIOContext.max_packet_size directly.
335
 */
336
attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
337

    
338
attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
339

    
340
/** return the written or read size */
341
attribute_deprecated int url_close_buf(AVIOContext *s);
342
#endif // FF_API_OLD_AVIO
343

    
344
/**
345
 * Return a non-zero value if the resource indicated by url
346
 * exists, 0 otherwise.
347
 */
348
int url_exist(const char *url);
349

    
350
/**
351
 * Return AVIO_* access flags corresponding to the access permissions
352
 * of the resource in url, or a negative value corresponding to an
353
 * AVERROR code in case of failure. The returned access flags are
354
 * masked by the value in flags.
355
 *
356
 * @note This function is intrinsically unsafe, in the sense that the
357
 * checked resource may change its existence or permission status from
358
 * one call to another. Thus you should not trust the returned value,
359
 * unless you are sure that no other processes are accessing the
360
 * checked resource.
361
 *
362
 * @note This function is slightly broken until next major bump
363
 *       because of AVIO_RDONLY == 0. Don't use it until then.
364
 */
365
int avio_check(const char *url, int flags);
366

    
367
/**
368
 * The callback is called in blocking functions to test regulary if
369
 * asynchronous interruption is needed. AVERROR_EXIT is returned
370
 * in this case by the interrupted function. 'NULL' means no interrupt
371
 * callback is given.
372
 */
373
void avio_set_interrupt_cb(int (*interrupt_cb)(void));
374

    
375
#if FF_API_REGISTER_PROTOCOL
376
extern URLProtocol *first_protocol;
377
#endif
378

    
379
#if FF_API_REGISTER_PROTOCOL
380
/**
381
 * @deprecated Use av_register_protocol() instead.
382
 */
383
attribute_deprecated int register_protocol(URLProtocol *protocol);
384

    
385
/**
386
 * @deprecated Use av_register_protocol2() instead.
387
 */
388
attribute_deprecated int av_register_protocol(URLProtocol *protocol);
389
#endif
390

    
391
/**
392
 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
393
 * freed with av_free().
394
 *
395
 * @param buffer Memory block for input/output operations via AVIOContext.
396
 * @param buffer_size The buffer size is very important for performance.
397
 *        For protocols with fixed blocksize it should be set to this blocksize.
398
 *        For others a typical size is a cache page, e.g. 4kb.
399
 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
400
 * @param opaque An opaque pointer to user-specific data.
401
 * @param read_packet  A function for refilling the buffer, may be NULL.
402
 * @param write_packet A function for writing the buffer contents, may be NULL.
403
 * @param seek A function for seeking to specified byte position, may be NULL.
404
 *
405
 * @return Allocated AVIOContext or NULL on failure.
406
 */
407
AVIOContext *avio_alloc_context(
408
                  unsigned char *buffer,
409
                  int buffer_size,
410
                  int write_flag,
411
                  void *opaque,
412
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
413
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
414
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
415

    
416
void avio_w8(AVIOContext *s, int b);
417
void avio_write(AVIOContext *s, const unsigned char *buf, int size);
418
void avio_wl64(AVIOContext *s, uint64_t val);
419
void avio_wb64(AVIOContext *s, uint64_t val);
420
void avio_wl32(AVIOContext *s, unsigned int val);
421
void avio_wb32(AVIOContext *s, unsigned int val);
422
void avio_wl24(AVIOContext *s, unsigned int val);
423
void avio_wb24(AVIOContext *s, unsigned int val);
424
void avio_wl16(AVIOContext *s, unsigned int val);
425
void avio_wb16(AVIOContext *s, unsigned int val);
426

    
427
/**
428
 * Write a NULL-terminated string.
429
 * @return number of bytes written.
430
 */
431
int avio_put_str(AVIOContext *s, const char *str);
432

    
433
/**
434
 * Convert an UTF-8 string to UTF-16LE and write it.
435
 * @return number of bytes written.
436
 */
437
int avio_put_str16le(AVIOContext *s, const char *str);
438

    
439
/**
440
 * Passing this as the "whence" parameter to a seek function causes it to
441
 * return the filesize without seeking anywhere. Supporting this is optional.
442
 * If it is not supported then the seek function will return <0.
443
 */
444
#define AVSEEK_SIZE 0x10000
445

    
446
/**
447
 * Oring this flag as into the "whence" parameter to a seek function causes it to
448
 * seek by any means (like reopening and linear reading) or other normally unreasonble
449
 * means that can be extreemly slow.
450
 * This may be ignored by the seek code.
451
 */
452
#define AVSEEK_FORCE 0x20000
453

    
454
/**
455
 * fseek() equivalent for AVIOContext.
456
 * @return new position or AVERROR.
457
 */
458
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
459

    
460
/**
461
 * Skip given number of bytes forward
462
 * @return new position or AVERROR.
463
 */
464
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
465
{
466
    return avio_seek(s, offset, SEEK_CUR);
467
}
468

    
469
/**
470
 * ftell() equivalent for AVIOContext.
471
 * @return position or AVERROR.
472
 */
473
static av_always_inline int64_t avio_tell(AVIOContext *s)
474
{
475
    return avio_seek(s, 0, SEEK_CUR);
476
}
477

    
478
/**
479
 * Get the filesize.
480
 * @return filesize or AVERROR
481
 */
482
int64_t avio_size(AVIOContext *s);
483

    
484
/** @warning currently size is limited */
485
#ifdef __GNUC__
486
int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
487
#else
488
int avio_printf(AVIOContext *s, const char *fmt, ...);
489
#endif
490

    
491
void avio_flush(AVIOContext *s);
492

    
493

    
494
/**
495
 * Read size bytes from AVIOContext into buf.
496
 * @return number of bytes read or AVERROR
497
 */
498
int avio_read(AVIOContext *s, unsigned char *buf, int size);
499

    
500
/**
501
 * @defgroup avio_read Functions for reading from AVIOContext.
502
 * @{
503
 *
504
 * @note return 0 if EOF, so you cannot use it if EOF handling is
505
 *       necessary
506
 */
507
int          avio_r8  (AVIOContext *s);
508
unsigned int avio_rl16(AVIOContext *s);
509
unsigned int avio_rl24(AVIOContext *s);
510
unsigned int avio_rl32(AVIOContext *s);
511
uint64_t     avio_rl64(AVIOContext *s);
512
unsigned int avio_rb16(AVIOContext *s);
513
unsigned int avio_rb24(AVIOContext *s);
514
unsigned int avio_rb32(AVIOContext *s);
515
uint64_t     avio_rb64(AVIOContext *s);
516
/**
517
 * @}
518
 */
519

    
520
/**
521
 * Read a string from pb into buf. The reading will terminate when either
522
 * a NULL character was encountered, maxlen bytes have been read, or nothing
523
 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
524
 * will be truncated if buf is too small.
525
 * Note that the string is not interpreted or validated in any way, it
526
 * might get truncated in the middle of a sequence for multi-byte encodings.
527
 *
528
 * @return number of bytes read (is always <= maxlen).
529
 * If reading ends on EOF or error, the return value will be one more than
530
 * bytes actually read.
531
 */
532
int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
533

    
534
/**
535
 * Read a UTF-16 string from pb and convert it to UTF-8.
536
 * The reading will terminate when either a null or invalid character was
537
 * encountered or maxlen bytes have been read.
538
 * @return number of bytes read (is always <= maxlen)
539
 */
540
int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
541
int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
542

    
543

    
544
#if FF_API_URL_RESETBUF
545
/** Reset the buffer for reading or writing.
546
 * @note Will drop any data currently in the buffer without transmitting it.
547
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
548
 *        to set up the buffer for writing. */
549
int url_resetbuf(AVIOContext *s, int flags);
550
#endif
551

    
552
/**
553
 * @defgroup open_modes URL open modes
554
 * The flags argument to avio_open must be one of the following
555
 * constants, optionally ORed with other flags.
556
 * @{
557
 */
558
#if LIBAVFORMAT_VERSION_MAJOR < 53
559
#define AVIO_RDONLY 0  /**< read-only */
560
#define AVIO_WRONLY 1  /**< write-only */
561
#define AVIO_RDWR   2  /**< read-write */
562
#else
563
#define AVIO_RDONLY 1  /**< read-only */
564
#define AVIO_WRONLY 2  /**< write-only */
565
#define AVIO_RDWR   4  /**< read-write */
566
#endif
567
/**
568
 * @}
569
 */
570

    
571
/**
572
 * Use non-blocking mode.
573
 * If this flag is set, operations on the context will return
574
 * AVERROR(EAGAIN) if they can not be performed immediately.
575
 * If this flag is not set, operations on the context will never return
576
 * AVERROR(EAGAIN).
577
 * Note that this flag does not affect the opening/connecting of the
578
 * context. Connecting a protocol will always block if necessary (e.g. on
579
 * network protocols) but never hang (e.g. on busy devices).
580
 * Warning: non-blocking protocols is work-in-progress; this flag may be
581
 * silently ignored.
582
 */
583
#if LIBAVFORMAT_VERSION_MAJOR < 53
584
#define AVIO_FLAG_NONBLOCK 4
585
#else
586
#define AVIO_FLAG_NONBLOCK 8
587
#endif
588

    
589
/**
590
 * Create and initialize a AVIOContext for accessing the
591
 * resource indicated by url.
592
 * @note When the resource indicated by url has been opened in
593
 * read+write mode, the AVIOContext can be used only for writing.
594
 *
595
 * @param s Used to return the pointer to the created AVIOContext.
596
 * In case of failure the pointed to value is set to NULL.
597
 * @param flags flags which control how the resource indicated by url
598
 * is to be opened
599
 * @return 0 in case of success, a negative value corresponding to an
600
 * AVERROR code in case of failure
601
 */
602
int avio_open(AVIOContext **s, const char *url, int flags);
603

    
604
/**
605
 * Close the resource accessed by the AVIOContext s and free it.
606
 * This function can only be used if s was opened by avio_open().
607
 *
608
 * @return 0 on success, an AVERROR < 0 on error.
609
 */
610
int avio_close(AVIOContext *s);
611

    
612
/**
613
 * Open a write only memory stream.
614
 *
615
 * @param s new IO context
616
 * @return zero if no error.
617
 */
618
int avio_open_dyn_buf(AVIOContext **s);
619

    
620
/**
621
 * Return the written size and a pointer to the buffer. The buffer
622
 * must be freed with av_free().
623
 * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
624
 *
625
 * @param s IO context
626
 * @param pbuffer pointer to a byte buffer
627
 * @return the length of the byte buffer
628
 */
629
int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
630

    
631
#if FF_API_UDP_GET_FILE
632
int udp_get_file_handle(URLContext *h);
633
#endif
634

    
635
/**
636
 * Iterate through names of available protocols.
637
 *
638
 * @param opaque A private pointer representing current protocol.
639
 *        It must be a pointer to NULL on first iteration and will
640
 *        be updated by successive calls to avio_enum_protocols.
641
 * @param output If set to 1, iterate over output protocols,
642
 *               otherwise over input protocols.
643
 *
644
 * @return A static string containing the name of current protocol or NULL
645
 */
646
const char *avio_enum_protocols(void **opaque, int output);
647

    
648
/**
649
 * Pause and resume playing - only meaningful if using a network streaming
650
 * protocol (e.g. MMS).
651
 * @param pause 1 for pause, 0 for resume
652
 */
653
int     avio_pause(AVIOContext *h, int pause);
654

    
655
/**
656
 * Seek to a given timestamp relative to some component stream.
657
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
658
 * @param stream_index The stream index that the timestamp is relative to.
659
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
660
 *        units from the beginning of the presentation.
661
 *        If a stream_index >= 0 is used and the protocol does not support
662
 *        seeking based on component streams, the call will fail with ENOTSUP.
663
 * @param timestamp timestamp in AVStream.time_base units
664
 *        or if there is no stream specified then in AV_TIME_BASE units.
665
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
666
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
667
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
668
 *        fail with ENOTSUP if used and not supported.
669
 * @return >= 0 on success
670
 * @see AVInputFormat::read_seek
671
 */
672
int64_t avio_seek_time(AVIOContext *h, int stream_index,
673
                       int64_t timestamp, int flags);
674

    
675
#endif /* AVFORMAT_AVIO_H */