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
26 * Buffered I/O operations
31 #include "libavutil/common.h"
32 #include "libavutil/dict.h"
33 #include "libavutil/log.h"
35 #include "libavformat/version.h"
37 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
40 * Callback for checking whether to abort blocking functions.
41 * AVERROR_EXIT is returned in this case by the interrupted
42 * function. During blocking operations, callback is called with
43 * opaque as parameter. If the callback returns 1, the
44 * blocking operation will be aborted.
46 * No members can be added to this struct without a major bump, if
47 * new elements have been added after this struct in AVFormatContext
50 typedef struct AVIOInterruptCB {
51 int (*callback)(void*);
56 * Directory entry types.
58 enum AVIODirEntryType {
60 AVIO_ENTRY_BLOCK_DEVICE,
61 AVIO_ENTRY_CHARACTER_DEVICE,
63 AVIO_ENTRY_NAMED_PIPE,
64 AVIO_ENTRY_SYMBOLIC_LINK,
73 * Describes single entry of the directory.
75 * Only name and type fields are guaranteed be set.
76 * Rest of fields are protocol or/and platform dependent and might be unknown.
78 typedef struct AVIODirEntry {
79 char *name; /**< Filename */
80 int type; /**< Type of the entry */
81 int utf8; /**< Set to 1 when name is encoded with UTF-8, 0 otherwise.
82 Name can be encoded with UTF-8 eventhough 0 is set. */
83 int64_t size; /**< File size in bytes, -1 if unknown. */
84 int64_t modification_timestamp; /**< Time of last modification in microseconds since unix
85 epoch, -1 if unknown. */
86 int64_t access_timestamp; /**< Time of last access in microseconds since unix epoch,
88 int64_t status_change_timestamp; /**< Time of last status change in microseconds since unix
89 epoch, -1 if unknown. */
90 int64_t user_id; /**< User ID of owner, -1 if unknown. */
91 int64_t group_id; /**< Group ID of owner, -1 if unknown. */
92 int64_t filemode; /**< Unix file mode, -1 if unknown. */
95 typedef struct AVIODirContext {
96 struct URLContext *url_context;
100 * Bytestream IO Context.
101 * New fields can be added to the end with minor version bumps.
102 * Removal, reordering and changes to existing fields require a major
104 * sizeof(AVIOContext) must not be used outside libav*.
106 * @note None of the function pointers in AVIOContext should be called
107 * directly, they should only be set by the client application
108 * when implementing custom I/O. Normally these are set to the
109 * function pointers specified in avio_alloc_context()
111 typedef struct AVIOContext {
113 * A class for private options.
115 * If this AVIOContext is created by avio_open2(), av_class is set and
116 * passes the options down to protocols.
118 * If this AVIOContext is manually allocated, then av_class may be set by
121 * warning -- this field can be NULL, be sure to not pass this AVIOContext
122 * to any av_opt_* functions in that case.
124 const AVClass *av_class;
125 unsigned char *buffer; /**< Start of the buffer. */
126 int buffer_size; /**< Maximum buffer size */
127 unsigned char *buf_ptr; /**< Current position in the buffer */
128 unsigned char *buf_end; /**< End of the data, may be less than
129 buffer+buffer_size if the read function returned
130 less data than requested, e.g. for streams where
131 no more data has been received yet. */
132 void *opaque; /**< A private pointer, passed to the read/write/seek/...
134 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
135 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
136 int64_t (*seek)(void *opaque, int64_t offset, int whence);
137 int64_t pos; /**< position in the file of the current buffer */
138 int must_flush; /**< true if the next seek should flush */
139 int eof_reached; /**< true if eof reached */
140 int write_flag; /**< true if open for writing */
142 unsigned long checksum;
143 unsigned char *checksum_ptr;
144 unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
145 int error; /**< contains the error code or 0 if no error happened */
147 * Pause or resume playback for network streaming protocols - e.g. MMS.
149 int (*read_pause)(void *opaque, int pause);
151 * Seek to a given timestamp in stream with the specified stream_index.
152 * Needed for some network streaming protocols which don't support seeking
155 int64_t (*read_seek)(void *opaque, int stream_index,
156 int64_t timestamp, int flags);
158 * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
163 * max filesize, used to limit allocations
164 * This field is internal to libavformat and access from outside is not allowed.
169 * avio_read and avio_write should if possible be satisfied directly
170 * instead of going through a buffer, and avio_seek will always
171 * call the underlying seek function directly.
176 * Bytes read statistic
177 * This field is internal to libavformat and access from outside is not allowed.
183 * This field is internal to libavformat and access from outside is not allowed.
189 * This field is internal to libavformat and access from outside is not allowed.
194 * Original buffer size
195 * used internally after probing and ensure seekback to reset the buffer size
196 * This field is internal to libavformat and access from outside is not allowed.
198 int orig_buffer_size;
204 * Return the name of the protocol that will handle the passed URL.
206 * NULL is returned if no protocol could be found for the given URL.
208 * @return Name of the protocol or NULL.
210 const char *avio_find_protocol_name(const char *url);
213 * Return AVIO_FLAG_* access flags corresponding to the access permissions
214 * of the resource in url, or a negative value corresponding to an
215 * AVERROR code in case of failure. The returned access flags are
216 * masked by the value in flags.
218 * @note This function is intrinsically unsafe, in the sense that the
219 * checked resource may change its existence or permission status from
220 * one call to another. Thus you should not trust the returned value,
221 * unless you are sure that no other processes are accessing the
224 int avio_check(const char *url, int flags);
227 * Open directory for reading.
229 * @param s directory read context. Pointer to a NULL pointer must be passed.
230 * @param url directory to be listed.
231 * @param options A dictionary filled with protocol-private options. On return
232 * this parameter will be destroyed and replaced with a dictionary
233 * containing options that were not found. May be NULL.
234 * @return >=0 on success or negative on error.
236 int avio_open_dir(AVIODirContext **s, const char *url, AVDictionary **options);
239 * Get next directory entry.
241 * Returned entry must be freed with avio_free_directory_entry(). In particular
242 * it may outlive AVIODirContext.
244 * @param s directory read context.
245 * @param[out] next next entry or NULL when no more entries.
246 * @return >=0 on success or negative on error. End of list is not considered an
249 int avio_read_dir(AVIODirContext *s, AVIODirEntry **next);
254 * @note Entries created using avio_read_dir() are not deleted and must be
255 * freeded with avio_free_directory_entry().
257 * @param s directory read context.
258 * @return >=0 on success or negative on error.
260 int avio_close_dir(AVIODirContext **s);
263 * Free entry allocated by avio_read_dir().
265 * @param entry entry to be freed.
267 void avio_free_directory_entry(AVIODirEntry **entry);
270 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
271 * freed with av_free().
273 * @param buffer Memory block for input/output operations via AVIOContext.
274 * The buffer must be allocated with av_malloc() and friends.
275 * It may be freed and replaced with a new buffer by libavformat.
276 * AVIOContext.buffer holds the buffer currently in use,
277 * which must be later freed with av_free().
278 * @param buffer_size The buffer size is very important for performance.
279 * For protocols with fixed blocksize it should be set to this blocksize.
280 * For others a typical size is a cache page, e.g. 4kb.
281 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
282 * @param opaque An opaque pointer to user-specific data.
283 * @param read_packet A function for refilling the buffer, may be NULL.
284 * @param write_packet A function for writing the buffer contents, may be NULL.
285 * The function may not change the input buffers content.
286 * @param seek A function for seeking to specified byte position, may be NULL.
288 * @return Allocated AVIOContext or NULL on failure.
290 AVIOContext *avio_alloc_context(
291 unsigned char *buffer,
295 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
296 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
297 int64_t (*seek)(void *opaque, int64_t offset, int whence));
299 void avio_w8(AVIOContext *s, int b);
300 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
301 void avio_wl64(AVIOContext *s, uint64_t val);
302 void avio_wb64(AVIOContext *s, uint64_t val);
303 void avio_wl32(AVIOContext *s, unsigned int val);
304 void avio_wb32(AVIOContext *s, unsigned int val);
305 void avio_wl24(AVIOContext *s, unsigned int val);
306 void avio_wb24(AVIOContext *s, unsigned int val);
307 void avio_wl16(AVIOContext *s, unsigned int val);
308 void avio_wb16(AVIOContext *s, unsigned int val);
311 * Write a NULL-terminated string.
312 * @return number of bytes written.
314 int avio_put_str(AVIOContext *s, const char *str);
317 * Convert an UTF-8 string to UTF-16LE and write it.
318 * @return number of bytes written.
320 int avio_put_str16le(AVIOContext *s, const char *str);
323 * Convert an UTF-8 string to UTF-16BE and write it.
324 * @return number of bytes written.
326 int avio_put_str16be(AVIOContext *s, const char *str);
329 * Passing this as the "whence" parameter to a seek function causes it to
330 * return the filesize without seeking anywhere. Supporting this is optional.
331 * If it is not supported then the seek function will return <0.
333 #define AVSEEK_SIZE 0x10000
336 * Oring this flag as into the "whence" parameter to a seek function causes it to
337 * seek by any means (like reopening and linear reading) or other normally unreasonable
338 * means that can be extremely slow.
339 * This may be ignored by the seek code.
341 #define AVSEEK_FORCE 0x20000
344 * fseek() equivalent for AVIOContext.
345 * @return new position or AVERROR.
347 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
350 * Skip given number of bytes forward
351 * @return new position or AVERROR.
353 int64_t avio_skip(AVIOContext *s, int64_t offset);
356 * ftell() equivalent for AVIOContext.
357 * @return position or AVERROR.
359 static av_always_inline int64_t avio_tell(AVIOContext *s)
361 return avio_seek(s, 0, SEEK_CUR);
366 * @return filesize or AVERROR
368 int64_t avio_size(AVIOContext *s);
371 * feof() equivalent for AVIOContext.
372 * @return non zero if and only if end of file
374 int avio_feof(AVIOContext *s);
377 * @deprecated use avio_feof()
380 int url_feof(AVIOContext *s);
383 /** @warning currently size is limited */
384 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
387 * Force flushing of buffered data.
389 * For write streams, force the buffered data to be immediately written to the output,
390 * without to wait to fill the internal buffer.
392 * For read streams, discard all currently buffered data, and advance the
393 * reported file position to that of the underlying stream. This does not
394 * read new data, and does not perform any seeks.
396 void avio_flush(AVIOContext *s);
399 * Read size bytes from AVIOContext into buf.
400 * @return number of bytes read or AVERROR
402 int avio_read(AVIOContext *s, unsigned char *buf, int size);
405 * @name Functions for reading from AVIOContext
408 * @note return 0 if EOF, so you cannot use it if EOF handling is
411 int avio_r8 (AVIOContext *s);
412 unsigned int avio_rl16(AVIOContext *s);
413 unsigned int avio_rl24(AVIOContext *s);
414 unsigned int avio_rl32(AVIOContext *s);
415 uint64_t avio_rl64(AVIOContext *s);
416 unsigned int avio_rb16(AVIOContext *s);
417 unsigned int avio_rb24(AVIOContext *s);
418 unsigned int avio_rb32(AVIOContext *s);
419 uint64_t avio_rb64(AVIOContext *s);
425 * Read a string from pb into buf. The reading will terminate when either
426 * a NULL character was encountered, maxlen bytes have been read, or nothing
427 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
428 * will be truncated if buf is too small.
429 * Note that the string is not interpreted or validated in any way, it
430 * might get truncated in the middle of a sequence for multi-byte encodings.
432 * @return number of bytes read (is always <= maxlen).
433 * If reading ends on EOF or error, the return value will be one more than
434 * bytes actually read.
436 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
439 * Read a UTF-16 string from pb and convert it to UTF-8.
440 * The reading will terminate when either a null or invalid character was
441 * encountered or maxlen bytes have been read.
442 * @return number of bytes read (is always <= maxlen)
444 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
445 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
449 * @name URL open modes
450 * The flags argument to avio_open must be one of the following
451 * constants, optionally ORed with other flags.
454 #define AVIO_FLAG_READ 1 /**< read-only */
455 #define AVIO_FLAG_WRITE 2 /**< write-only */
456 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE) /**< read-write pseudo flag */
462 * Use non-blocking mode.
463 * If this flag is set, operations on the context will return
464 * AVERROR(EAGAIN) if they can not be performed immediately.
465 * If this flag is not set, operations on the context will never return
467 * Note that this flag does not affect the opening/connecting of the
468 * context. Connecting a protocol will always block if necessary (e.g. on
469 * network protocols) but never hang (e.g. on busy devices).
470 * Warning: non-blocking protocols is work-in-progress; this flag may be
473 #define AVIO_FLAG_NONBLOCK 8
477 * avio_read and avio_write should if possible be satisfied directly
478 * instead of going through a buffer, and avio_seek will always
479 * call the underlying seek function directly.
481 #define AVIO_FLAG_DIRECT 0x8000
484 * Create and initialize a AVIOContext for accessing the
485 * resource indicated by url.
486 * @note When the resource indicated by url has been opened in
487 * read+write mode, the AVIOContext can be used only for writing.
489 * @param s Used to return the pointer to the created AVIOContext.
490 * In case of failure the pointed to value is set to NULL.
491 * @param url resource to access
492 * @param flags flags which control how the resource indicated by url
494 * @return >= 0 in case of success, a negative value corresponding to an
495 * AVERROR code in case of failure
497 int avio_open(AVIOContext **s, const char *url, int flags);
500 * Create and initialize a AVIOContext for accessing the
501 * resource indicated by url.
502 * @note When the resource indicated by url has been opened in
503 * read+write mode, the AVIOContext can be used only for writing.
505 * @param s Used to return the pointer to the created AVIOContext.
506 * In case of failure the pointed to value is set to NULL.
507 * @param url resource to access
508 * @param flags flags which control how the resource indicated by url
510 * @param int_cb an interrupt callback to be used at the protocols level
511 * @param options A dictionary filled with protocol-private options. On return
512 * this parameter will be destroyed and replaced with a dict containing options
513 * that were not found. May be NULL.
514 * @return >= 0 in case of success, a negative value corresponding to an
515 * AVERROR code in case of failure
517 int avio_open2(AVIOContext **s, const char *url, int flags,
518 const AVIOInterruptCB *int_cb, AVDictionary **options);
521 * Close the resource accessed by the AVIOContext s and free it.
522 * This function can only be used if s was opened by avio_open().
524 * The internal buffer is automatically flushed before closing the
527 * @return 0 on success, an AVERROR < 0 on error.
530 int avio_close(AVIOContext *s);
533 * Close the resource accessed by the AVIOContext *s, free it
534 * and set the pointer pointing to it to NULL.
535 * This function can only be used if s was opened by avio_open().
537 * The internal buffer is automatically flushed before closing the
540 * @return 0 on success, an AVERROR < 0 on error.
543 int avio_closep(AVIOContext **s);
547 * Open a write only memory stream.
549 * @param s new IO context
550 * @return zero if no error.
552 int avio_open_dyn_buf(AVIOContext **s);
555 * Return the written size and a pointer to the buffer. The buffer
556 * must be freed with av_free().
557 * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
559 * @param s IO context
560 * @param pbuffer pointer to a byte buffer
561 * @return the length of the byte buffer
563 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
566 * Iterate through names of available protocols.
568 * @param opaque A private pointer representing current protocol.
569 * It must be a pointer to NULL on first iteration and will
570 * be updated by successive calls to avio_enum_protocols.
571 * @param output If set to 1, iterate over output protocols,
572 * otherwise over input protocols.
574 * @return A static string containing the name of current protocol or NULL
576 const char *avio_enum_protocols(void **opaque, int output);
579 * Pause and resume playing - only meaningful if using a network streaming
580 * protocol (e.g. MMS).
582 * @param h IO context from which to call the read_pause function pointer
583 * @param pause 1 for pause, 0 for resume
585 int avio_pause(AVIOContext *h, int pause);
588 * Seek to a given timestamp relative to some component stream.
589 * Only meaningful if using a network streaming protocol (e.g. MMS.).
591 * @param h IO context from which to call the seek function pointers
592 * @param stream_index The stream index that the timestamp is relative to.
593 * If stream_index is (-1) the timestamp should be in AV_TIME_BASE
594 * units from the beginning of the presentation.
595 * If a stream_index >= 0 is used and the protocol does not support
596 * seeking based on component streams, the call will fail.
597 * @param timestamp timestamp in AVStream.time_base units
598 * or if there is no stream specified then in AV_TIME_BASE units.
599 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
600 * and AVSEEK_FLAG_ANY. The protocol may silently ignore
601 * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
602 * fail if used and not supported.
603 * @return >= 0 on success
604 * @see AVInputFormat::read_seek
606 int64_t avio_seek_time(AVIOContext *h, int stream_index,
607 int64_t timestamp, int flags);
609 /* Avoid a warning. The header can not be included because it breaks c++. */
613 * Read contents of h into print buffer, up to max_size bytes, or up to EOF.
615 * @return 0 for success (max_size bytes read or EOF reached), negative error
618 int avio_read_to_bprint(AVIOContext *h, struct AVBPrint *pb, size_t max_size);
620 #endif /* AVFORMAT_AVIO_H */