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