Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 3c96c648

History | View | Annotate | Download (24.8 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
 * unbuffered I/O operations
26
 *
27
 * @warning This file has to be considered an internal but installed
28
 * header, so it should not be directly included in your projects.
29
 */
30

    
31
#include <stdint.h>
32

    
33
#include "libavutil/common.h"
34
#include "libavutil/log.h"
35

    
36
#include "libavformat/version.h"
37

    
38
/* unbuffered I/O */
39

    
40
/**
41
 * URL Context.
42
 * New fields can be added to the end with minor version bumps.
43
 * Removal, reordering and changes to existing fields require a major
44
 * version bump.
45
 * sizeof(URLContext) must not be used outside libav*.
46
 */
47
typedef struct URLContext {
48
#if FF_API_URL_CLASS
49
    const AVClass *av_class; ///< information for av_log(). Set by url_open().
50
#endif
51
    struct URLProtocol *prot;
52
    int flags;
53
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
54
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
55
    void *priv_data;
56
    char *filename; /**< specified URL */
57
    int is_connected;
58
} URLContext;
59

    
60
typedef struct URLPollEntry {
61
    URLContext *handle;
62
    int events;
63
    int revents;
64
} URLPollEntry;
65

    
66
/**
67
 * @defgroup open_modes URL open modes
68
 * The flags argument to url_open and cosins must be one of the following
69
 * constants, optionally ORed with other flags.
70
 * @{
71
 */
72
#define URL_RDONLY 0  /**< read-only */
73
#define URL_WRONLY 1  /**< write-only */
74
#define URL_RDWR   2  /**< read-write */
75
/**
76
 * @}
77
 */
78

    
79
/**
80
 * Use non-blocking mode.
81
 * If this flag is set, operations on the context will return
82
 * AVERROR(EAGAIN) if they can not be performed immediately.
83
 * If this flag is not set, operations on the context will never return
84
 * AVERROR(EAGAIN).
85
 * Note that this flag does not affect the opening/connecting of the
86
 * context. Connecting a protocol will always block if necessary (e.g. on
87
 * network protocols) but never hang (e.g. on busy devices).
88
 * Warning: non-blocking protocols is work-in-progress; this flag may be
89
 * silently ignored.
90
 */
91
#define URL_FLAG_NONBLOCK 4
92

    
93
typedef int URLInterruptCB(void);
94

    
95
/**
96
 * Create a URLContext for accessing to the resource indicated by
97
 * url, and open it using the URLProtocol up.
98
 *
99
 * @param puc pointer to the location where, in case of success, the
100
 * function puts the pointer to the created URLContext
101
 * @param flags flags which control how the resource indicated by url
102
 * is to be opened
103
 * @return 0 in case of success, a negative value corresponding to an
104
 * AVERROR code in case of failure
105
 */
106
int url_open_protocol (URLContext **puc, struct URLProtocol *up,
107
                       const char *url, int flags);
108

    
109
/**
110
 * Create a URLContext for accessing to the resource indicated by
111
 * url, but do not initiate the connection yet.
112
 *
113
 * @param puc pointer to the location where, in case of success, the
114
 * function puts the pointer to the created URLContext
115
 * @param flags flags which control how the resource indicated by url
116
 * is to be opened
117
 * @return 0 in case of success, a negative value corresponding to an
118
 * AVERROR code in case of failure
119
 */
120
int url_alloc(URLContext **h, const char *url, int flags);
121

    
122
/**
123
 * Connect an URLContext that has been allocated by url_alloc
124
 */
125
int url_connect(URLContext *h);
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
 * @return 0 in case of success, a negative value corresponding to an
136
 * AVERROR code in case of failure
137
 */
138
int url_open(URLContext **h, const char *url, int flags);
139

    
140
/**
141
 * Read up to size bytes from the resource accessed by h, and store
142
 * the read bytes in buf.
143
 *
144
 * @return The number of bytes actually read, or a negative value
145
 * corresponding to an AVERROR code in case of error. A value of zero
146
 * indicates that it is not possible to read more from the accessed
147
 * resource (except if the value of the size argument is also zero).
148
 */
149
int url_read(URLContext *h, unsigned char *buf, int size);
150

    
151
/**
152
 * Read as many bytes as possible (up to size), calling the
153
 * read function multiple times if necessary.
154
 * This makes special short-read handling in applications
155
 * unnecessary, if the return value is < size then it is
156
 * certain there was either an error or the end of file was reached.
157
 */
158
int url_read_complete(URLContext *h, unsigned char *buf, int size);
159

    
160
/**
161
 * Write size bytes from buf to the resource accessed by h.
162
 *
163
 * @return the number of bytes actually written, or a negative value
164
 * corresponding to an AVERROR code in case of failure
165
 */
166
int url_write(URLContext *h, const unsigned char *buf, int size);
167

    
168
/**
169
 * Passing this as the "whence" parameter to a seek function causes it to
170
 * return the filesize without seeking anywhere. Supporting this is optional.
171
 * If it is not supported then the seek function will return <0.
172
 */
173
#define AVSEEK_SIZE 0x10000
174

    
175
/**
176
 * Change the position that will be used by the next read/write
177
 * operation on the resource accessed by h.
178
 *
179
 * @param pos specifies the new position to set
180
 * @param whence specifies how pos should be interpreted, it must be
181
 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
182
 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
183
 * (return the filesize of the requested resource, pos is ignored).
184
 * @return a negative value corresponding to an AVERROR code in case
185
 * of failure, or the resulting file position, measured in bytes from
186
 * the beginning of the file. You can use this feature together with
187
 * SEEK_CUR to read the current file position.
188
 */
189
int64_t url_seek(URLContext *h, int64_t pos, int whence);
190

    
191
/**
192
 * Close the resource accessed by the URLContext h, and free the
193
 * memory used by it.
194
 *
195
 * @return a negative value if an error condition occurred, 0
196
 * otherwise
197
 */
198
int url_close(URLContext *h);
199

    
200
/**
201
 * Return a non-zero value if the resource indicated by url
202
 * exists, 0 otherwise.
203
 */
204
int url_exist(const char *url);
205

    
206
/**
207
 * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
208
 * if the operation is not supported by h, or another negative value
209
 * corresponding to an AVERROR error code in case of failure.
210
 */
211
int64_t url_filesize(URLContext *h);
212

    
213
/**
214
 * Return the file descriptor associated with this URL. For RTP, this
215
 * will return only the RTP file descriptor, not the RTCP file descriptor.
216
 *
217
 * @return the file descriptor associated with this URL, or <0 on error.
218
 */
219
int url_get_file_handle(URLContext *h);
220

    
221
/**
222
 * Return the maximum packet size associated to packetized file
223
 * handle. If the file is not packetized (stream like HTTP or file on
224
 * disk), then 0 is returned.
225
 *
226
 * @param h file handle
227
 * @return maximum packet size in bytes
228
 */
229
int url_get_max_packet_size(URLContext *h);
230

    
231
/**
232
 * Copy the filename of the resource accessed by h to buf.
233
 *
234
 * @param buf_size size in bytes of buf
235
 */
236
void url_get_filename(URLContext *h, char *buf, int buf_size);
237

    
238
/**
239
 * The callback is called in blocking functions to test regulary if
240
 * asynchronous interruption is needed. AVERROR_EXIT is returned
241
 * in this case by the interrupted function. 'NULL' means no interrupt
242
 * callback is given.
243
 */
244
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
245

    
246
/* not implemented */
247
int url_poll(URLPollEntry *poll_table, int n, int timeout);
248

    
249
/**
250
 * Pause and resume playing - only meaningful if using a network streaming
251
 * protocol (e.g. MMS).
252
 * @param pause 1 for pause, 0 for resume
253
 */
254
int av_url_read_pause(URLContext *h, int pause);
255

    
256
/**
257
 * Seek to a given timestamp relative to some component stream.
258
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
259
 * @param stream_index The stream index that the timestamp is relative to.
260
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
261
 *        units from the beginning of the presentation.
262
 *        If a stream_index >= 0 is used and the protocol does not support
263
 *        seeking based on component streams, the call will fail with ENOTSUP.
264
 * @param timestamp timestamp in AVStream.time_base units
265
 *        or if there is no stream specified then in AV_TIME_BASE units.
266
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
267
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
268
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
269
 *        fail with ENOTSUP if used and not supported.
270
 * @return >= 0 on success
271
 * @see AVInputFormat::read_seek
272
 */
273
int64_t av_url_read_seek(URLContext *h, int stream_index,
274
                         int64_t timestamp, int flags);
275

    
276
/**
277
 * Oring this flag as into the "whence" parameter to a seek function causes it to
278
 * seek by any means (like reopening and linear reading) or other normally unreasonble
279
 * means that can be extreemly slow.
280
 * This may be ignored by the seek code.
281
 */
282
#define AVSEEK_FORCE 0x20000
283

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

    
286
typedef struct URLProtocol {
287
    const char *name;
288
    int (*url_open)(URLContext *h, const char *url, int flags);
289
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
290
    int (*url_write)(URLContext *h, const unsigned char *buf, int size);
291
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
292
    int (*url_close)(URLContext *h);
293
    struct URLProtocol *next;
294
    int (*url_read_pause)(URLContext *h, int pause);
295
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
296
                             int64_t timestamp, int flags);
297
    int (*url_get_file_handle)(URLContext *h);
298
    int priv_data_size;
299
    const AVClass *priv_data_class;
300
    int flags;
301
} URLProtocol;
302

    
303
#if FF_API_REGISTER_PROTOCOL
304
extern URLProtocol *first_protocol;
305
#endif
306

    
307
extern URLInterruptCB *url_interrupt_cb;
308

    
309
/**
310
 * If protocol is NULL, returns the first registered protocol,
311
 * if protocol is non-NULL, returns the next registered protocol after protocol,
312
 * or NULL if protocol is the last one.
313
 */
314
URLProtocol *av_protocol_next(URLProtocol *p);
315

    
316
#if FF_API_REGISTER_PROTOCOL
317
/**
318
 * @deprecated Use av_register_protocol() instead.
319
 */
320
attribute_deprecated int register_protocol(URLProtocol *protocol);
321

    
322
/**
323
 * @deprecated Use av_register_protocol2() instead.
324
 */
325
attribute_deprecated int av_register_protocol(URLProtocol *protocol);
326
#endif
327

    
328
/**
329
 * Register the URLProtocol protocol.
330
 *
331
 * @param size the size of the URLProtocol struct referenced
332
 */
333
int av_register_protocol2(URLProtocol *protocol, int size);
334

    
335
/**
336
 * Bytestream IO Context.
337
 * New fields can be added to the end with minor version bumps.
338
 * Removal, reordering and changes to existing fields require a major
339
 * version bump.
340
 * sizeof(AVIOContext) must not be used outside libav*.
341
 */
342
typedef struct {
343
    unsigned char *buffer;
344
    int buffer_size;
345
    unsigned char *buf_ptr, *buf_end;
346
    void *opaque;
347
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
348
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
349
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
350
    int64_t pos; /**< position in the file of the current buffer */
351
    int must_flush; /**< true if the next seek should flush */
352
    int eof_reached; /**< true if eof reached */
353
    int write_flag;  /**< true if open for writing */
354
    int is_streamed;
355
    int max_packet_size;
356
    unsigned long checksum;
357
    unsigned char *checksum_ptr;
358
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
359
    int error;         ///< contains the error code or 0 if no error happened
360
    int (*read_pause)(void *opaque, int pause);
361
    int64_t (*read_seek)(void *opaque, int stream_index,
362
                         int64_t timestamp, int flags);
363
} AVIOContext;
364

    
365
#if FF_API_OLD_AVIO
366
typedef attribute_deprecated AVIOContext ByteIOContext;
367

    
368
attribute_deprecated int init_put_byte(AVIOContext *s,
369
                  unsigned char *buffer,
370
                  int buffer_size,
371
                  int write_flag,
372
                  void *opaque,
373
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
374
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
375
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
376
attribute_deprecated AVIOContext *av_alloc_put_byte(
377
                  unsigned char *buffer,
378
                  int buffer_size,
379
                  int write_flag,
380
                  void *opaque,
381
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
382
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
383
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
384

    
385
/**
386
 * @defgroup old_avio_funcs Old put_/get_*() functions
387
 * @deprecated use the avio_ -prefixed functions instead.
388
 * @{
389
 */
390
attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
391
attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
392
attribute_deprecated int          get_byte(AVIOContext *s);
393
attribute_deprecated unsigned int get_le16(AVIOContext *s);
394
attribute_deprecated unsigned int get_le24(AVIOContext *s);
395
attribute_deprecated unsigned int get_le32(AVIOContext *s);
396
attribute_deprecated uint64_t     get_le64(AVIOContext *s);
397
attribute_deprecated unsigned int get_be16(AVIOContext *s);
398
attribute_deprecated unsigned int get_be24(AVIOContext *s);
399
attribute_deprecated unsigned int get_be32(AVIOContext *s);
400
attribute_deprecated uint64_t     get_be64(AVIOContext *s);
401

    
402
attribute_deprecated void         put_byte(AVIOContext *s, int b);
403
attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
404
attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
405
attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
406
attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
407
attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
408
attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
409
attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
410
attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
411
attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
412
attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
413
attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
414
/**
415
 * @}
416
 */
417

    
418
attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
419
attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
420
                                                int64_t timestamp, int flags);
421

    
422
/**
423
 * @defgroup old_url_f_funcs Old url_f* functions
424
 * @deprecated use the avio_ -prefixed functions instead.
425
 * @{
426
 */
427
attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
428
attribute_deprecated int url_fclose(AVIOContext *s);
429
attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
430
attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
431
attribute_deprecated int64_t url_ftell(AVIOContext *s);
432
attribute_deprecated int64_t url_fsize(AVIOContext *s);
433
#define URL_EOF (-1)
434
attribute_deprecated int url_fgetc(AVIOContext *s);
435
attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
436
#ifdef __GNUC__
437
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
438
#else
439
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
440
#endif
441
attribute_deprecated void put_flush_packet(AVIOContext *s);
442
/**
443
 * @}
444
 */
445

    
446
/**
447
 * @deprecated use AVIOContext.eof_reached
448
 */
449
attribute_deprecated int url_feof(AVIOContext *s);
450
attribute_deprecated int url_ferror(AVIOContext *s);
451

    
452
attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
453
attribute_deprecated int udp_get_local_port(URLContext *h);
454

    
455
attribute_deprecated void init_checksum(AVIOContext *s,
456
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
457
                   unsigned long checksum);
458
attribute_deprecated unsigned long get_checksum(AVIOContext *s);
459
#endif
460

    
461
/**
462
 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
463
 * freed with av_free().
464
 *
465
 * @param buffer Memory block for input/output operations via AVIOContext.
466
 * @param buffer_size The buffer size is very important for performance.
467
 *        For protocols with fixed blocksize it should be set to this blocksize.
468
 *        For others a typical size is a cache page, e.g. 4kb.
469
 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
470
 * @param opaque An opaque pointer to user-specific data.
471
 * @param read_packet  A function for refilling the buffer, may be NULL.
472
 * @param write_packet A function for writing the buffer contents, may be NULL.
473
 * @param seek A function for seeking to specified byte position, may be NULL.
474
 *
475
 * @return Allocated AVIOContext or NULL on failure.
476
 */
477
AVIOContext *avio_alloc_context(
478
                  unsigned char *buffer,
479
                  int buffer_size,
480
                  int write_flag,
481
                  void *opaque,
482
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
483
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
484
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
485

    
486
void avio_w8(AVIOContext *s, int b);
487
void avio_write(AVIOContext *s, const unsigned char *buf, int size);
488
void avio_wl64(AVIOContext *s, uint64_t val);
489
void avio_wb64(AVIOContext *s, uint64_t val);
490
void avio_wl32(AVIOContext *s, unsigned int val);
491
void avio_wb32(AVIOContext *s, unsigned int val);
492
void avio_wl24(AVIOContext *s, unsigned int val);
493
void avio_wb24(AVIOContext *s, unsigned int val);
494
void avio_wl16(AVIOContext *s, unsigned int val);
495
void avio_wb16(AVIOContext *s, unsigned int val);
496

    
497
#if FF_API_OLD_AVIO
498
attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
499
#endif
500

    
501
/**
502
 * Write a NULL-terminated string.
503
 * @return number of bytes written.
504
 */
505
int avio_put_str(AVIOContext *s, const char *str);
506

    
507
/**
508
 * Convert an UTF-8 string to UTF-16LE and write it.
509
 * @return number of bytes written.
510
 */
511
int avio_put_str16le(AVIOContext *s, const char *str);
512

    
513
/**
514
 * fseek() equivalent for AVIOContext.
515
 * @return new position or AVERROR.
516
 */
517
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
518

    
519
/**
520
 * Skip given number of bytes forward
521
 * @return new position or AVERROR.
522
 */
523
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
524
{
525
    return avio_seek(s, offset, SEEK_CUR);
526
}
527

    
528
/**
529
 * ftell() equivalent for AVIOContext.
530
 * @return position or AVERROR.
531
 */
532
static av_always_inline int64_t avio_tell(AVIOContext *s)
533
{
534
    return avio_seek(s, 0, SEEK_CUR);
535
}
536

    
537
/**
538
 * Get the filesize.
539
 * @return filesize or AVERROR
540
 */
541
int64_t avio_size(AVIOContext *s);
542

    
543
/** @warning currently size is limited */
544
#ifdef __GNUC__
545
int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
546
#else
547
int avio_printf(AVIOContext *s, const char *fmt, ...);
548
#endif
549

    
550
#if FF_API_OLD_AVIO
551
/** @note unlike fgets, the EOL character is not returned and a whole
552
    line is parsed. return NULL if first char read was EOF */
553
attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
554
#endif
555

    
556
void avio_flush(AVIOContext *s);
557

    
558

    
559
/**
560
 * Read size bytes from AVIOContext into buf.
561
 * @return number of bytes read or AVERROR
562
 */
563
int avio_read(AVIOContext *s, unsigned char *buf, int size);
564

    
565
/** @note return 0 if EOF, so you cannot use it if EOF handling is
566
    necessary */
567
int          avio_r8  (AVIOContext *s);
568
unsigned int avio_rl16(AVIOContext *s);
569
unsigned int avio_rl24(AVIOContext *s);
570
unsigned int avio_rl32(AVIOContext *s);
571
uint64_t     avio_rl64(AVIOContext *s);
572

    
573
/**
574
 * Read a string from pb into buf. The reading will terminate when either
575
 * a NULL character was encountered, maxlen bytes have been read, or nothing
576
 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
577
 * will be truncated if buf is too small.
578
 * Note that the string is not interpreted or validated in any way, it
579
 * might get truncated in the middle of a sequence for multi-byte encodings.
580
 *
581
 * @return number of bytes read (is always <= maxlen).
582
 * If reading ends on EOF or error, the return value will be one more than
583
 * bytes actually read.
584
 */
585
int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
586

    
587
/**
588
 * Read a UTF-16 string from pb and convert it to UTF-8.
589
 * The reading will terminate when either a null or invalid character was
590
 * encountered or maxlen bytes have been read.
591
 * @return number of bytes read (is always <= maxlen)
592
 */
593
int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
594
int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
595

    
596
#if FF_API_OLD_AVIO
597
/**
598
 * @deprecated use avio_get_str instead
599
 */
600
attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
601
#endif
602
unsigned int avio_rb16(AVIOContext *s);
603
unsigned int avio_rb24(AVIOContext *s);
604
unsigned int avio_rb32(AVIOContext *s);
605
uint64_t     avio_rb64(AVIOContext *s);
606

    
607
static inline int url_is_streamed(AVIOContext *s)
608
{
609
    return s->is_streamed;
610
}
611

    
612
/**
613
 * Create and initialize a AVIOContext for accessing the
614
 * resource referenced by the URLContext h.
615
 * @note When the URLContext h has been opened in read+write mode, the
616
 * AVIOContext can be used only for writing.
617
 *
618
 * @param s Used to return the pointer to the created AVIOContext.
619
 * In case of failure the pointed to value is set to NULL.
620
 * @return 0 in case of success, a negative value corresponding to an
621
 * AVERROR code in case of failure
622
 */
623
int url_fdopen(AVIOContext **s, URLContext *h);
624

    
625
#if FF_API_URL_RESETBUF
626
/** Reset the buffer for reading or writing.
627
 * @note Will drop any data currently in the buffer without transmitting it.
628
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
629
 *        to set up the buffer for writing. */
630
int url_resetbuf(AVIOContext *s, int flags);
631
#endif
632

    
633
/**
634
 * Create and initialize a AVIOContext for accessing the
635
 * resource indicated by url.
636
 * @note When the resource indicated by url has been opened in
637
 * read+write mode, the AVIOContext can be used only for writing.
638
 *
639
 * @param s Used to return the pointer to the created AVIOContext.
640
 * In case of failure the pointed to value is set to NULL.
641
 * @param flags flags which control how the resource indicated by url
642
 * is to be opened
643
 * @return 0 in case of success, a negative value corresponding to an
644
 * AVERROR code in case of failure
645
 */
646
int avio_open(AVIOContext **s, const char *url, int flags);
647

    
648
int avio_close(AVIOContext *s);
649

    
650
#if FF_API_OLD_AVIO
651
attribute_deprecated URLContext *url_fileno(AVIOContext *s);
652

    
653
/**
654
 * @deprecated use AVIOContext.max_packet_size directly.
655
 */
656
attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
657

    
658
attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
659

    
660
/** return the written or read size */
661
attribute_deprecated int url_close_buf(AVIOContext *s);
662
#endif
663

    
664
/**
665
 * Open a write only memory stream.
666
 *
667
 * @param s new IO context
668
 * @return zero if no error.
669
 */
670
int url_open_dyn_buf(AVIOContext **s);
671

    
672
/**
673
 * Open a write only packetized memory stream with a maximum packet
674
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
675
 * with a big endian 4 byte header giving the packet size in bytes.
676
 *
677
 * @param s new IO context
678
 * @param max_packet_size maximum packet size (must be > 0)
679
 * @return zero if no error.
680
 */
681
int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
682

    
683
/**
684
 * Return the written size and a pointer to the buffer. The buffer
685
 * must be freed with av_free(). If the buffer is opened with
686
 * url_open_dyn_buf, then padding of FF_INPUT_BUFFER_PADDING_SIZE is
687
 * added; if opened with url_open_dyn_packet_buf, no padding is added.
688
 *
689
 * @param s IO context
690
 * @param pbuffer pointer to a byte buffer
691
 * @return the length of the byte buffer
692
 */
693
int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
694

    
695
#if FF_API_UDP_GET_FILE
696
int udp_get_file_handle(URLContext *h);
697
#endif
698

    
699
#endif /* AVFORMAT_AVIO_H */