2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
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.
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.
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
20 #ifndef AVFORMAT_AVIO_H
21 #define AVFORMAT_AVIO_H
25 * unbuffered I/O operations
27 * @warning This file has to be considered an internal but installed
28 * header, so it should not be directly included in your projects.
33 #include "libavutil/common.h"
34 #include "libavutil/log.h"
36 #include "libavformat/version.h"
42 * New fields can be added to the end with minor version bumps.
43 * Removal, reordering and changes to existing fields require a major
45 * sizeof(URLContext) must not be used outside libav*.
47 typedef struct URLContext {
49 const AVClass *av_class; ///< information for av_log(). Set by url_open().
51 struct URLProtocol *prot;
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 */
56 char *filename; /**< specified URL */
60 typedef struct URLPollEntry {
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.
72 #define URL_RDONLY 0 /**< read-only */
73 #define URL_WRONLY 1 /**< write-only */
74 #define URL_RDWR 2 /**< read-write */
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
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
91 #define URL_FLAG_NONBLOCK 4
93 typedef int URLInterruptCB(void);
96 * Create a URLContext for accessing to the resource indicated by
97 * url, and open it using the URLProtocol up.
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
103 * @return 0 in case of success, a negative value corresponding to an
104 * AVERROR code in case of failure
106 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
107 const char *url, int flags);
110 * Create a URLContext for accessing to the resource indicated by
111 * url, but do not initiate the connection yet.
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
117 * @return 0 in case of success, a negative value corresponding to an
118 * AVERROR code in case of failure
120 int url_alloc(URLContext **h, const char *url, int flags);
123 * Connect an URLContext that has been allocated by url_alloc
125 int url_connect(URLContext *h);
128 * Create an URLContext for accessing to the resource indicated by
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
135 * @return 0 in case of success, a negative value corresponding to an
136 * AVERROR code in case of failure
138 int url_open(URLContext **h, const char *url, int flags);
141 * Read up to size bytes from the resource accessed by h, and store
142 * the read bytes in buf.
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).
149 int url_read(URLContext *h, unsigned char *buf, int size);
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.
158 int url_read_complete(URLContext *h, unsigned char *buf, int size);
161 * Write size bytes from buf to the resource accessed by h.
163 * @return the number of bytes actually written, or a negative value
164 * corresponding to an AVERROR code in case of failure
166 int url_write(URLContext *h, const unsigned char *buf, int size);
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.
173 #define AVSEEK_SIZE 0x10000
176 * Change the position that will be used by the next read/write
177 * operation on the resource accessed by h.
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.
189 int64_t url_seek(URLContext *h, int64_t pos, int whence);
192 * Close the resource accessed by the URLContext h, and free the
195 * @return a negative value if an error condition occurred, 0
198 int url_close(URLContext *h);
201 * Return a non-zero value if the resource indicated by url
202 * exists, 0 otherwise.
204 int url_exist(const char *url);
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.
211 int64_t url_filesize(URLContext *h);
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.
217 * @return the file descriptor associated with this URL, or <0 on error.
219 int url_get_file_handle(URLContext *h);
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.
226 * @param h file handle
227 * @return maximum packet size in bytes
229 int url_get_max_packet_size(URLContext *h);
232 * Copy the filename of the resource accessed by h to buf.
234 * @param buf_size size in bytes of buf
236 void url_get_filename(URLContext *h, char *buf, int buf_size);
239 * The callback is called in blocking functions to test regulary if
240 * asynchronous interruption is needed. AVERROR(EINTR) is returned
241 * in this case by the interrupted function. 'NULL' means no interrupt
244 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
246 /* not implemented */
247 int url_poll(URLPollEntry *poll_table, int n, int timeout);
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
254 int av_url_read_pause(URLContext *h, int pause);
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
273 int64_t av_url_read_seek(URLContext *h, int stream_index,
274 int64_t timestamp, int flags);
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.
282 #define AVSEEK_FORCE 0x20000
284 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
286 typedef struct URLProtocol {
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);
299 const AVClass *priv_data_class;
303 #if FF_API_REGISTER_PROTOCOL
304 extern URLProtocol *first_protocol;
307 extern URLInterruptCB *url_interrupt_cb;
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.
314 URLProtocol *av_protocol_next(URLProtocol *p);
316 #if FF_API_REGISTER_PROTOCOL
318 * @deprecated Use av_register_protocol() instead.
320 attribute_deprecated int register_protocol(URLProtocol *protocol);
323 * @deprecated Use av_register_protocol2() instead.
325 attribute_deprecated int av_register_protocol(URLProtocol *protocol);
329 * Register the URLProtocol protocol.
331 * @param size the size of the URLProtocol struct referenced
333 int av_register_protocol2(URLProtocol *protocol, int size);
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
340 * sizeof(AVIOContext) must not be used outside libav*.
343 unsigned char *buffer;
345 unsigned char *buf_ptr, *buf_end;
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 */
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);
366 typedef attribute_deprecated AVIOContext ByteIOContext;
368 attribute_deprecated int init_put_byte(AVIOContext *s,
369 unsigned char *buffer,
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,
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));
386 * @defgroup old_avio_funcs Old put_/get_*() functions
387 * @deprecated use the avio_ -prefixed functions instead.
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);
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);
420 * @defgroup old_url_f_funcs Old url_f* functions
421 * @deprecated use the avio_ -prefixed functions instead.
424 attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
425 attribute_deprecated int url_fclose(AVIOContext *s);
426 attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
427 attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
428 attribute_deprecated int64_t url_ftell(AVIOContext *s);
429 attribute_deprecated int64_t url_fsize(AVIOContext *s);
431 attribute_deprecated int url_fgetc(AVIOContext *s);
437 * @deprecated use AVIOContext.eof_reached
439 attribute_deprecated int url_feof(AVIOContext *s);
440 attribute_deprecated int url_ferror(AVIOContext *s);
443 AVIOContext *avio_alloc_context(
444 unsigned char *buffer,
448 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
449 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
450 int64_t (*seek)(void *opaque, int64_t offset, int whence));
452 void avio_w8(AVIOContext *s, int b);
453 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
454 void avio_wl64(AVIOContext *s, uint64_t val);
455 void avio_wb64(AVIOContext *s, uint64_t val);
456 void avio_wl32(AVIOContext *s, unsigned int val);
457 void avio_wb32(AVIOContext *s, unsigned int val);
458 void avio_wl24(AVIOContext *s, unsigned int val);
459 void avio_wb24(AVIOContext *s, unsigned int val);
460 void avio_wl16(AVIOContext *s, unsigned int val);
461 void avio_wb16(AVIOContext *s, unsigned int val);
464 attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
468 * Write a NULL-terminated string.
469 * @return number of bytes written.
471 int avio_put_str(AVIOContext *s, const char *str);
474 * Convert an UTF-8 string to UTF-16LE and write it.
475 * @return number of bytes written.
477 int avio_put_str16le(AVIOContext *s, const char *str);
480 * fseek() equivalent for AVIOContext.
481 * @return new position or AVERROR.
483 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
486 * Skip given number of bytes forward
487 * @return new position or AVERROR.
489 #define avio_skip(s, offset) avio_seek(s, offset, SEEK_CUR)
492 * ftell() equivalent for AVIOContext.
493 * @return position or AVERROR.
495 #define avio_tell(s) avio_seek((s), 0, SEEK_CUR)
499 * @return filesize or AVERROR
501 int64_t avio_size(AVIOContext *s);
503 int av_url_read_fpause(AVIOContext *h, int pause);
504 int64_t av_url_read_fseek(AVIOContext *h, int stream_index,
505 int64_t timestamp, int flags);
507 /** @warning currently size is limited */
509 int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
511 int url_fprintf(AVIOContext *s, const char *fmt, ...);
515 /** @note unlike fgets, the EOL character is not returned and a whole
516 line is parsed. return NULL if first char read was EOF */
517 attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
520 void put_flush_packet(AVIOContext *s);
524 * Read size bytes from AVIOContext into buf.
525 * @return number of bytes read or AVERROR
527 int avio_read(AVIOContext *s, unsigned char *buf, int size);
529 /** @note return 0 if EOF, so you cannot use it if EOF handling is
531 int avio_r8 (AVIOContext *s);
532 unsigned int avio_rl16(AVIOContext *s);
533 unsigned int avio_rl24(AVIOContext *s);
534 unsigned int avio_rl32(AVIOContext *s);
535 uint64_t avio_rl64(AVIOContext *s);
538 * Read a string from pb into buf. The reading will terminate when either
539 * a NULL character was encountered, maxlen bytes have been read, or nothing
540 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
541 * will be truncated if buf is too small.
542 * Note that the string is not interpreted or validated in any way, it
543 * might get truncated in the middle of a sequence for multi-byte encodings.
545 * @return number of bytes read (is always <= maxlen).
546 * If reading ends on EOF or error, the return value will be one more than
547 * bytes actually read.
549 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
552 * Read a UTF-16 string from pb and convert it to UTF-8.
553 * The reading will terminate when either a null or invalid character was
554 * encountered or maxlen bytes have been read.
555 * @return number of bytes read (is always <= maxlen)
557 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
558 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
562 * @deprecated use avio_get_str instead
564 attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
566 unsigned int avio_rb16(AVIOContext *s);
567 unsigned int avio_rb24(AVIOContext *s);
568 unsigned int avio_rb32(AVIOContext *s);
569 uint64_t avio_rb64(AVIOContext *s);
571 uint64_t ff_get_v(AVIOContext *bc);
573 static inline int url_is_streamed(AVIOContext *s)
575 return s->is_streamed;
579 * Create and initialize a AVIOContext for accessing the
580 * resource referenced by the URLContext h.
581 * @note When the URLContext h has been opened in read+write mode, the
582 * AVIOContext can be used only for writing.
584 * @param s Used to return the pointer to the created AVIOContext.
585 * In case of failure the pointed to value is set to NULL.
586 * @return 0 in case of success, a negative value corresponding to an
587 * AVERROR code in case of failure
589 int url_fdopen(AVIOContext **s, URLContext *h);
591 /** @warning must be called before any I/O */
592 int url_setbufsize(AVIOContext *s, int buf_size);
593 #if FF_API_URL_RESETBUF
594 /** Reset the buffer for reading or writing.
595 * @note Will drop any data currently in the buffer without transmitting it.
596 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
597 * to set up the buffer for writing. */
598 int url_resetbuf(AVIOContext *s, int flags);
602 * Create and initialize a AVIOContext for accessing the
603 * resource indicated by url.
604 * @note When the resource indicated by url has been opened in
605 * read+write mode, the AVIOContext can be used only for writing.
607 * @param s Used to return the pointer to the created AVIOContext.
608 * In case of failure the pointed to value is set to NULL.
609 * @param flags flags which control how the resource indicated by url
611 * @return 0 in case of success, a negative value corresponding to an
612 * AVERROR code in case of failure
614 int avio_open(AVIOContext **s, const char *url, int flags);
616 int avio_close(AVIOContext *s);
617 URLContext *url_fileno(AVIOContext *s);
621 * @deprecated use AVIOContext.max_packet_size directly.
623 attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
626 int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
628 /** return the written or read size */
629 int url_close_buf(AVIOContext *s);
632 * Open a write only memory stream.
634 * @param s new IO context
635 * @return zero if no error.
637 int url_open_dyn_buf(AVIOContext **s);
640 * Open a write only packetized memory stream with a maximum packet
641 * size of 'max_packet_size'. The stream is stored in a memory buffer
642 * with a big endian 4 byte header giving the packet size in bytes.
644 * @param s new IO context
645 * @param max_packet_size maximum packet size (must be > 0)
646 * @return zero if no error.
648 int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
651 * Return the written size and a pointer to the buffer. The buffer
652 * must be freed with av_free(). If the buffer is opened with
653 * url_open_dyn_buf, then padding of FF_INPUT_BUFFER_PADDING_SIZE is
654 * added; if opened with url_open_dyn_packet_buf, no padding is added.
656 * @param s IO context
657 * @param pbuffer pointer to a byte buffer
658 * @return the length of the byte buffer
660 int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
662 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
664 unsigned long get_checksum(AVIOContext *s);
665 void init_checksum(AVIOContext *s,
666 unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
667 unsigned long checksum);
670 int udp_set_remote_url(URLContext *h, const char *uri);
671 int udp_get_local_port(URLContext *h);
672 #if FF_API_UDP_GET_FILE
673 int udp_get_file_handle(URLContext *h);
676 #endif /* AVFORMAT_AVIO_H */