7e7e429117132a6b95fac21889b54a25652be5a1
[ffmpeg.git] / libavformat / avio.h
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 } URLProtocol;
138
139 typedef struct URLPollEntry {
140     URLContext *handle;
141     int events;
142     int revents;
143 } URLPollEntry;
144
145 /* not implemented */
146 attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
147
148 /**
149  * @defgroup open_modes URL open modes
150  * The flags argument to url_open and cosins must be one of the following
151  * constants, optionally ORed with other flags.
152  * @{
153  */
154 #define URL_RDONLY 0  /**< read-only */
155 #define URL_WRONLY 1  /**< write-only */
156 #define URL_RDWR   2  /**< read-write */
157 /**
158  * @}
159  */
160
161 /**
162  * Use non-blocking mode.
163  * If this flag is set, operations on the context will return
164  * AVERROR(EAGAIN) if they can not be performed immediately.
165  * If this flag is not set, operations on the context will never return
166  * AVERROR(EAGAIN).
167  * Note that this flag does not affect the opening/connecting of the
168  * context. Connecting a protocol will always block if necessary (e.g. on
169  * network protocols) but never hang (e.g. on busy devices).
170  * Warning: non-blocking protocols is work-in-progress; this flag may be
171  * silently ignored.
172  */
173 #define URL_FLAG_NONBLOCK 4
174
175 typedef int URLInterruptCB(void);
176 extern URLInterruptCB *url_interrupt_cb;
177
178 /**
179  * @defgroup old_url_funcs Old url_* functions
180  * @deprecated use the buffered API based on AVIOContext instead
181  * @{
182  */
183 attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
184                                             const char *url, int flags);
185 attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
186 attribute_deprecated int url_connect(URLContext *h);
187 attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
188 attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
189 attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
190 attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
191 attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
192 attribute_deprecated int url_close(URLContext *h);
193 attribute_deprecated int64_t url_filesize(URLContext *h);
194 attribute_deprecated int url_get_file_handle(URLContext *h);
195 attribute_deprecated int url_get_max_packet_size(URLContext *h);
196 attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
197 attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
198 attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
199                                               int64_t timestamp, int flags);
200 attribute_deprecated void url_set_interrupt_cb(int (*interrupt_cb)(void));
201 /**
202  * If protocol is NULL, returns the first registered protocol,
203  * if protocol is non-NULL, returns the next registered protocol after protocol,
204  * or NULL if protocol is the last one.
205  */
206 attribute_deprecated URLProtocol *av_protocol_next(URLProtocol *p);
207 /**
208  * Register the URLProtocol protocol.
209  *
210  * @param size the size of the URLProtocol struct referenced
211  */
212 attribute_deprecated int av_register_protocol2(URLProtocol *protocol, int size);
213 /**
214  * @}
215  */
216
217
218 typedef attribute_deprecated AVIOContext ByteIOContext;
219
220 attribute_deprecated int init_put_byte(AVIOContext *s,
221                   unsigned char *buffer,
222                   int buffer_size,
223                   int write_flag,
224                   void *opaque,
225                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
226                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
227                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
228 attribute_deprecated AVIOContext *av_alloc_put_byte(
229                   unsigned char *buffer,
230                   int buffer_size,
231                   int write_flag,
232                   void *opaque,
233                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
234                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
235                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
236
237 /**
238  * @defgroup old_avio_funcs Old put_/get_*() functions
239  * @deprecated use the avio_ -prefixed functions instead.
240  * @{
241  */
242 attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
243 attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
244 attribute_deprecated int          get_byte(AVIOContext *s);
245 attribute_deprecated unsigned int get_le16(AVIOContext *s);
246 attribute_deprecated unsigned int get_le24(AVIOContext *s);
247 attribute_deprecated unsigned int get_le32(AVIOContext *s);
248 attribute_deprecated uint64_t     get_le64(AVIOContext *s);
249 attribute_deprecated unsigned int get_be16(AVIOContext *s);
250 attribute_deprecated unsigned int get_be24(AVIOContext *s);
251 attribute_deprecated unsigned int get_be32(AVIOContext *s);
252 attribute_deprecated uint64_t     get_be64(AVIOContext *s);
253
254 attribute_deprecated void         put_byte(AVIOContext *s, int b);
255 attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
256 attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
257 attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
258 attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
259 attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
260 attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
261 attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
262 attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
263 attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
264 attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
265 attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
266 /**
267  * @}
268  */
269
270 attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
271 attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
272                                                 int64_t timestamp, int flags);
273
274 /**
275  * @defgroup old_url_f_funcs Old url_f* functions
276  * @deprecated use the avio_ -prefixed functions instead.
277  * @{
278  */
279 attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
280 attribute_deprecated int url_fclose(AVIOContext *s);
281 attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
282 attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
283 attribute_deprecated int64_t url_ftell(AVIOContext *s);
284 attribute_deprecated int64_t url_fsize(AVIOContext *s);
285 #define URL_EOF (-1)
286 attribute_deprecated int url_fgetc(AVIOContext *s);
287 attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
288 #ifdef __GNUC__
289 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
290 #else
291 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
292 #endif
293 attribute_deprecated void put_flush_packet(AVIOContext *s);
294 attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
295 attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
296 attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
297 attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
298 /**
299  * @}
300  */
301
302 /**
303  * @deprecated use AVIOContext.eof_reached
304  */
305 attribute_deprecated int url_feof(AVIOContext *s);
306 attribute_deprecated int url_ferror(AVIOContext *s);
307
308 attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
309 attribute_deprecated int udp_get_local_port(URLContext *h);
310
311 attribute_deprecated void init_checksum(AVIOContext *s,
312                    unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
313                    unsigned long checksum);
314 attribute_deprecated unsigned long get_checksum(AVIOContext *s);
315 attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
316 /** @note unlike fgets, the EOL character is not returned and a whole
317     line is parsed. return NULL if first char read was EOF */
318 attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
319 /**
320  * @deprecated use avio_get_str instead
321  */
322 attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
323 /**
324  * @deprecated Use AVIOContext.seekable field directly.
325  */
326 attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
327 {
328     return !s->seekable;
329 }
330 attribute_deprecated URLContext *url_fileno(AVIOContext *s);
331
332 /**
333  * @deprecated use AVIOContext.max_packet_size directly.
334  */
335 attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
336
337 attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
338
339 /** return the written or read size */
340 attribute_deprecated int url_close_buf(AVIOContext *s);
341 #endif // FF_API_OLD_AVIO
342
343 /**
344  * Return a non-zero value if the resource indicated by url
345  * exists, 0 otherwise.
346  */
347 int url_exist(const char *url);
348
349 /**
350  * The callback is called in blocking functions to test regulary if
351  * asynchronous interruption is needed. AVERROR_EXIT is returned
352  * in this case by the interrupted function. 'NULL' means no interrupt
353  * callback is given.
354  */
355 void avio_set_interrupt_cb(int (*interrupt_cb)(void));
356
357 #if FF_API_REGISTER_PROTOCOL
358 extern URLProtocol *first_protocol;
359 #endif
360
361 #if FF_API_REGISTER_PROTOCOL
362 /**
363  * @deprecated Use av_register_protocol() instead.
364  */
365 attribute_deprecated int register_protocol(URLProtocol *protocol);
366
367 /**
368  * @deprecated Use av_register_protocol2() instead.
369  */
370 attribute_deprecated int av_register_protocol(URLProtocol *protocol);
371 #endif
372
373 /**
374  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
375  * freed with av_free().
376  *
377  * @param buffer Memory block for input/output operations via AVIOContext.
378  * @param buffer_size The buffer size is very important for performance.
379  *        For protocols with fixed blocksize it should be set to this blocksize.
380  *        For others a typical size is a cache page, e.g. 4kb.
381  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
382  * @param opaque An opaque pointer to user-specific data.
383  * @param read_packet  A function for refilling the buffer, may be NULL.
384  * @param write_packet A function for writing the buffer contents, may be NULL.
385  * @param seek A function for seeking to specified byte position, may be NULL.
386  *
387  * @return Allocated AVIOContext or NULL on failure.
388  */
389 AVIOContext *avio_alloc_context(
390                   unsigned char *buffer,
391                   int buffer_size,
392                   int write_flag,
393                   void *opaque,
394                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
395                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
396                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
397
398 void avio_w8(AVIOContext *s, int b);
399 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
400 void avio_wl64(AVIOContext *s, uint64_t val);
401 void avio_wb64(AVIOContext *s, uint64_t val);
402 void avio_wl32(AVIOContext *s, unsigned int val);
403 void avio_wb32(AVIOContext *s, unsigned int val);
404 void avio_wl24(AVIOContext *s, unsigned int val);
405 void avio_wb24(AVIOContext *s, unsigned int val);
406 void avio_wl16(AVIOContext *s, unsigned int val);
407 void avio_wb16(AVIOContext *s, unsigned int val);
408
409 /**
410  * Write a NULL-terminated string.
411  * @return number of bytes written.
412  */
413 int avio_put_str(AVIOContext *s, const char *str);
414
415 /**
416  * Convert an UTF-8 string to UTF-16LE and write it.
417  * @return number of bytes written.
418  */
419 int avio_put_str16le(AVIOContext *s, const char *str);
420
421 /**
422  * Passing this as the "whence" parameter to a seek function causes it to
423  * return the filesize without seeking anywhere. Supporting this is optional.
424  * If it is not supported then the seek function will return <0.
425  */
426 #define AVSEEK_SIZE 0x10000
427
428 /**
429  * Oring this flag as into the "whence" parameter to a seek function causes it to
430  * seek by any means (like reopening and linear reading) or other normally unreasonble
431  * means that can be extreemly slow.
432  * This may be ignored by the seek code.
433  */
434 #define AVSEEK_FORCE 0x20000
435
436 /**
437  * fseek() equivalent for AVIOContext.
438  * @return new position or AVERROR.
439  */
440 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
441
442 /**
443  * Skip given number of bytes forward
444  * @return new position or AVERROR.
445  */
446 static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
447 {
448     return avio_seek(s, offset, SEEK_CUR);
449 }
450
451 /**
452  * ftell() equivalent for AVIOContext.
453  * @return position or AVERROR.
454  */
455 static av_always_inline int64_t avio_tell(AVIOContext *s)
456 {
457     return avio_seek(s, 0, SEEK_CUR);
458 }
459
460 /**
461  * Get the filesize.
462  * @return filesize or AVERROR
463  */
464 int64_t avio_size(AVIOContext *s);
465
466 /** @warning currently size is limited */
467 #ifdef __GNUC__
468 int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
469 #else
470 int avio_printf(AVIOContext *s, const char *fmt, ...);
471 #endif
472
473 void avio_flush(AVIOContext *s);
474
475
476 /**
477  * Read size bytes from AVIOContext into buf.
478  * @return number of bytes read or AVERROR
479  */
480 int avio_read(AVIOContext *s, unsigned char *buf, int size);
481
482 /**
483  * @defgroup avio_read Functions for reading from AVIOContext.
484  * @{
485  *
486  * @note return 0 if EOF, so you cannot use it if EOF handling is
487  *       necessary
488  */
489 int          avio_r8  (AVIOContext *s);
490 unsigned int avio_rl16(AVIOContext *s);
491 unsigned int avio_rl24(AVIOContext *s);
492 unsigned int avio_rl32(AVIOContext *s);
493 uint64_t     avio_rl64(AVIOContext *s);
494 unsigned int avio_rb16(AVIOContext *s);
495 unsigned int avio_rb24(AVIOContext *s);
496 unsigned int avio_rb32(AVIOContext *s);
497 uint64_t     avio_rb64(AVIOContext *s);
498 /**
499  * @}
500  */
501
502 /**
503  * Read a string from pb into buf. The reading will terminate when either
504  * a NULL character was encountered, maxlen bytes have been read, or nothing
505  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
506  * will be truncated if buf is too small.
507  * Note that the string is not interpreted or validated in any way, it
508  * might get truncated in the middle of a sequence for multi-byte encodings.
509  *
510  * @return number of bytes read (is always <= maxlen).
511  * If reading ends on EOF or error, the return value will be one more than
512  * bytes actually read.
513  */
514 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
515
516 /**
517  * Read a UTF-16 string from pb and convert it to UTF-8.
518  * The reading will terminate when either a null or invalid character was
519  * encountered or maxlen bytes have been read.
520  * @return number of bytes read (is always <= maxlen)
521  */
522 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
523 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
524
525
526 #if FF_API_URL_RESETBUF
527 /** Reset the buffer for reading or writing.
528  * @note Will drop any data currently in the buffer without transmitting it.
529  * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
530  *        to set up the buffer for writing. */
531 int url_resetbuf(AVIOContext *s, int flags);
532 #endif
533
534 /**
535  * @defgroup open_modes URL open modes
536  * The flags argument to avio_open must be one of the following
537  * constants, optionally ORed with other flags.
538  * @{
539  */
540 #define AVIO_RDONLY 0  /**< read-only */
541 #define AVIO_WRONLY 1  /**< write-only */
542 #define AVIO_RDWR   2  /**< read-write */
543 /**
544  * @}
545  */
546
547 /**
548  * Use non-blocking mode.
549  * If this flag is set, operations on the context will return
550  * AVERROR(EAGAIN) if they can not be performed immediately.
551  * If this flag is not set, operations on the context will never return
552  * AVERROR(EAGAIN).
553  * Note that this flag does not affect the opening/connecting of the
554  * context. Connecting a protocol will always block if necessary (e.g. on
555  * network protocols) but never hang (e.g. on busy devices).
556  * Warning: non-blocking protocols is work-in-progress; this flag may be
557  * silently ignored.
558  */
559 #define AVIO_FLAG_NONBLOCK 4
560
561 /**
562  * Create and initialize a AVIOContext for accessing the
563  * resource indicated by url.
564  * @note When the resource indicated by url has been opened in
565  * read+write mode, the AVIOContext can be used only for writing.
566  *
567  * @param s Used to return the pointer to the created AVIOContext.
568  * In case of failure the pointed to value is set to NULL.
569  * @param flags flags which control how the resource indicated by url
570  * is to be opened
571  * @return 0 in case of success, a negative value corresponding to an
572  * AVERROR code in case of failure
573  */
574 int avio_open(AVIOContext **s, const char *url, int flags);
575
576 /**
577  * Close the resource accessed by the AVIOContext s and free it.
578  * This function can only be used if s was opened by avio_open().
579  *
580  * @return 0 on success, an AVERROR < 0 on error.
581  */
582 int avio_close(AVIOContext *s);
583
584 /**
585  * Open a write only memory stream.
586  *
587  * @param s new IO context
588  * @return zero if no error.
589  */
590 int avio_open_dyn_buf(AVIOContext **s);
591
592 /**
593  * Return the written size and a pointer to the buffer. The buffer
594  * must be freed with av_free().
595  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
596  *
597  * @param s IO context
598  * @param pbuffer pointer to a byte buffer
599  * @return the length of the byte buffer
600  */
601 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
602
603 #if FF_API_UDP_GET_FILE
604 int udp_get_file_handle(URLContext *h);
605 #endif
606
607 /**
608  * Iterate through names of available protocols.
609  *
610  * @param opaque A private pointer representing current protocol.
611  *        It must be a pointer to NULL on first iteration and will
612  *        be updated by successive calls to avio_enum_protocols.
613  * @param output If set to 1, iterate over output protocols,
614  *               otherwise over input protocols.
615  *
616  * @return A static string containing the name of current protocol or NULL
617  */
618 const char *avio_enum_protocols(void **opaque, int output);
619
620 #endif /* AVFORMAT_AVIO_H */