FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
avio.h
Go to the documentation of this file.
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  * @ingroup lavf_io
26  * Buffered I/O operations
27  */
28 
29 #include <stdint.h>
30 
31 #include "libavutil/common.h"
32 #include "libavutil/dict.h"
33 #include "libavutil/log.h"
34 
35 #include "libavformat/version.h"
36 
37 
38 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
39 
40 /**
41  * Callback for checking whether to abort blocking functions.
42  * AVERROR_EXIT is returned in this case by the interrupted
43  * function. During blocking operations, callback is called with
44  * opaque as parameter. If the callback returns 1, the
45  * blocking operation will be aborted.
46  *
47  * No members can be added to this struct without a major bump, if
48  * new elements have been added after this struct in AVFormatContext
49  * or AVIOContext.
50  */
51 typedef struct AVIOInterruptCB {
52  int (*callback)(void*);
53  void *opaque;
55 
56 /**
57  * Bytestream IO Context.
58  * New fields can be added to the end with minor version bumps.
59  * Removal, reordering and changes to existing fields require a major
60  * version bump.
61  * sizeof(AVIOContext) must not be used outside libav*.
62  *
63  * @note None of the function pointers in AVIOContext should be called
64  * directly, they should only be set by the client application
65  * when implementing custom I/O. Normally these are set to the
66  * function pointers specified in avio_alloc_context()
67  */
68 typedef struct AVIOContext {
69  /**
70  * A class for private options.
71  *
72  * If this AVIOContext is created by avio_open2(), av_class is set and
73  * passes the options down to protocols.
74  *
75  * If this AVIOContext is manually allocated, then av_class may be set by
76  * the caller.
77  *
78  * warning -- this field can be NULL, be sure to not pass this AVIOContext
79  * to any av_opt_* functions in that case.
80  */
81  const AVClass *av_class;
82  unsigned char *buffer; /**< Start of the buffer. */
83  int buffer_size; /**< Maximum buffer size */
84  unsigned char *buf_ptr; /**< Current position in the buffer */
85  unsigned char *buf_end; /**< End of the data, may be less than
86  buffer+buffer_size if the read function returned
87  less data than requested, e.g. for streams where
88  no more data has been received yet. */
89  void *opaque; /**< A private pointer, passed to the read/write/seek/...
90  functions. */
91  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
92  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
93  int64_t (*seek)(void *opaque, int64_t offset, int whence);
94  int64_t pos; /**< position in the file of the current buffer */
95  int must_flush; /**< true if the next seek should flush */
96  int eof_reached; /**< true if eof reached */
97  int write_flag; /**< true if open for writing */
99  unsigned long checksum;
100  unsigned char *checksum_ptr;
101  unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
102  int error; /**< contains the error code or 0 if no error happened */
103  /**
104  * Pause or resume playback for network streaming protocols - e.g. MMS.
105  */
106  int (*read_pause)(void *opaque, int pause);
107  /**
108  * Seek to a given timestamp in stream with the specified stream_index.
109  * Needed for some network streaming protocols which don't support seeking
110  * to byte position.
111  */
112  int64_t (*read_seek)(void *opaque, int stream_index,
113  int64_t timestamp, int flags);
114  /**
115  * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
116  */
117  int seekable;
118 
119  /**
120  * max filesize, used to limit allocations
121  * This field is internal to libavformat and access from outside is not allowed.
122  */
123  int64_t maxsize;
124 
125  /**
126  * avio_read and avio_write should if possible be satisfied directly
127  * instead of going through a buffer, and avio_seek will always
128  * call the underlying seek function directly.
129  */
130  int direct;
131 
132  /**
133  * Bytes read statistic
134  * This field is internal to libavformat and access from outside is not allowed.
135  */
136  int64_t bytes_read;
137 
138  /**
139  * seek statistic
140  * This field is internal to libavformat and access from outside is not allowed.
141  */
143 
144  /**
145  * writeout statistic
146  * This field is internal to libavformat and access from outside is not allowed.
147  */
149 
150  /**
151  * Original buffer size
152  * used internally after probing and ensure seekback to reset the buffer size
153  * This field is internal to libavformat and access from outside is not allowed.
154  */
156 } AVIOContext;
157 
158 /* unbuffered I/O */
159 
160 /**
161  * Return the name of the protocol that will handle the passed URL.
162  *
163  * NULL is returned if no protocol could be found for the given URL.
164  *
165  * @return Name of the protocol or NULL.
166  */
167 const char *avio_find_protocol_name(const char *url);
168 
169 /**
170  * Return AVIO_FLAG_* access flags corresponding to the access permissions
171  * of the resource in url, or a negative value corresponding to an
172  * AVERROR code in case of failure. The returned access flags are
173  * masked by the value in flags.
174  *
175  * @note This function is intrinsically unsafe, in the sense that the
176  * checked resource may change its existence or permission status from
177  * one call to another. Thus you should not trust the returned value,
178  * unless you are sure that no other processes are accessing the
179  * checked resource.
180  */
181 int avio_check(const char *url, int flags);
182 
183 /**
184  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
185  * freed with av_free().
186  *
187  * @param buffer Memory block for input/output operations via AVIOContext.
188  * The buffer must be allocated with av_malloc() and friends.
189  * It may be freed and replaced with a new buffer by libavformat.
190  * AVIOContext.buffer holds the buffer currently in use,
191  * which must be later freed with av_free().
192  * @param buffer_size The buffer size is very important for performance.
193  * For protocols with fixed blocksize it should be set to this blocksize.
194  * For others a typical size is a cache page, e.g. 4kb.
195  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
196  * @param opaque An opaque pointer to user-specific data.
197  * @param read_packet A function for refilling the buffer, may be NULL.
198  * @param write_packet A function for writing the buffer contents, may be NULL.
199  * The function may not change the input buffers content.
200  * @param seek A function for seeking to specified byte position, may be NULL.
201  *
202  * @return Allocated AVIOContext or NULL on failure.
203  */
205  unsigned char *buffer,
206  int buffer_size,
207  int write_flag,
208  void *opaque,
209  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
210  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
211  int64_t (*seek)(void *opaque, int64_t offset, int whence));
212 
213 void avio_w8(AVIOContext *s, int b);
214 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
215 void avio_wl64(AVIOContext *s, uint64_t val);
216 void avio_wb64(AVIOContext *s, uint64_t val);
217 void avio_wl32(AVIOContext *s, unsigned int val);
218 void avio_wb32(AVIOContext *s, unsigned int val);
219 void avio_wl24(AVIOContext *s, unsigned int val);
220 void avio_wb24(AVIOContext *s, unsigned int val);
221 void avio_wl16(AVIOContext *s, unsigned int val);
222 void avio_wb16(AVIOContext *s, unsigned int val);
223 
224 /**
225  * Write a NULL-terminated string.
226  * @return number of bytes written.
227  */
228 int avio_put_str(AVIOContext *s, const char *str);
229 
230 /**
231  * Convert an UTF-8 string to UTF-16LE and write it.
232  * @return number of bytes written.
233  */
234 int avio_put_str16le(AVIOContext *s, const char *str);
235 
236 /**
237  * Convert an UTF-8 string to UTF-16BE and write it.
238  * @return number of bytes written.
239  */
240 int avio_put_str16be(AVIOContext *s, const char *str);
241 
242 /**
243  * Passing this as the "whence" parameter to a seek function causes it to
244  * return the filesize without seeking anywhere. Supporting this is optional.
245  * If it is not supported then the seek function will return <0.
246  */
247 #define AVSEEK_SIZE 0x10000
248 
249 /**
250  * Oring this flag as into the "whence" parameter to a seek function causes it to
251  * seek by any means (like reopening and linear reading) or other normally unreasonable
252  * means that can be extremely slow.
253  * This may be ignored by the seek code.
254  */
255 #define AVSEEK_FORCE 0x20000
256 
257 /**
258  * fseek() equivalent for AVIOContext.
259  * @return new position or AVERROR.
260  */
261 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
262 
263 /**
264  * Skip given number of bytes forward
265  * @return new position or AVERROR.
266  */
267 int64_t avio_skip(AVIOContext *s, int64_t offset);
268 
269 /**
270  * ftell() equivalent for AVIOContext.
271  * @return position or AVERROR.
272  */
274 {
275  return avio_seek(s, 0, SEEK_CUR);
276 }
277 
278 /**
279  * Get the filesize.
280  * @return filesize or AVERROR
281  */
282 int64_t avio_size(AVIOContext *s);
283 
284 /**
285  * feof() equivalent for AVIOContext.
286  * @return non zero if and only if end of file
287  */
288 int avio_feof(AVIOContext *s);
289 #if FF_API_URL_FEOF
290 /**
291  * @deprecated use avio_feof()
292  */
294 int url_feof(AVIOContext *s);
295 #endif
296 
297 /** @warning currently size is limited */
298 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
299 
300 /**
301  * Force flushing of buffered data.
302  *
303  * For write streams, force the buffered data to be immediately written to the output,
304  * without to wait to fill the internal buffer.
305  *
306  * For read streams, discard all currently buffered data, and advance the
307  * reported file position to that of the underlying stream. This does not
308  * read new data, and does not perform any seeks.
309  */
310 void avio_flush(AVIOContext *s);
311 
312 /**
313  * Read size bytes from AVIOContext into buf.
314  * @return number of bytes read or AVERROR
315  */
316 int avio_read(AVIOContext *s, unsigned char *buf, int size);
317 
318 /**
319  * @name Functions for reading from AVIOContext
320  * @{
321  *
322  * @note return 0 if EOF, so you cannot use it if EOF handling is
323  * necessary
324  */
325 int avio_r8 (AVIOContext *s);
326 unsigned int avio_rl16(AVIOContext *s);
327 unsigned int avio_rl24(AVIOContext *s);
328 unsigned int avio_rl32(AVIOContext *s);
329 uint64_t avio_rl64(AVIOContext *s);
330 unsigned int avio_rb16(AVIOContext *s);
331 unsigned int avio_rb24(AVIOContext *s);
332 unsigned int avio_rb32(AVIOContext *s);
333 uint64_t avio_rb64(AVIOContext *s);
334 /**
335  * @}
336  */
337 
338 /**
339  * Read a string from pb into buf. The reading will terminate when either
340  * a NULL character was encountered, maxlen bytes have been read, or nothing
341  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
342  * will be truncated if buf is too small.
343  * Note that the string is not interpreted or validated in any way, it
344  * might get truncated in the middle of a sequence for multi-byte encodings.
345  *
346  * @return number of bytes read (is always <= maxlen).
347  * If reading ends on EOF or error, the return value will be one more than
348  * bytes actually read.
349  */
350 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
351 
352 /**
353  * Read a UTF-16 string from pb and convert it to UTF-8.
354  * The reading will terminate when either a null or invalid character was
355  * encountered or maxlen bytes have been read.
356  * @return number of bytes read (is always <= maxlen)
357  */
358 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
359 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
360 
361 
362 /**
363  * @name URL open modes
364  * The flags argument to avio_open must be one of the following
365  * constants, optionally ORed with other flags.
366  * @{
367  */
368 #define AVIO_FLAG_READ 1 /**< read-only */
369 #define AVIO_FLAG_WRITE 2 /**< write-only */
370 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE) /**< read-write pseudo flag */
371 /**
372  * @}
373  */
374 
375 /**
376  * Use non-blocking mode.
377  * If this flag is set, operations on the context will return
378  * AVERROR(EAGAIN) if they can not be performed immediately.
379  * If this flag is not set, operations on the context will never return
380  * AVERROR(EAGAIN).
381  * Note that this flag does not affect the opening/connecting of the
382  * context. Connecting a protocol will always block if necessary (e.g. on
383  * network protocols) but never hang (e.g. on busy devices).
384  * Warning: non-blocking protocols is work-in-progress; this flag may be
385  * silently ignored.
386  */
387 #define AVIO_FLAG_NONBLOCK 8
388 
389 /**
390  * Use direct mode.
391  * avio_read and avio_write should if possible be satisfied directly
392  * instead of going through a buffer, and avio_seek will always
393  * call the underlying seek function directly.
394  */
395 #define AVIO_FLAG_DIRECT 0x8000
396 
397 /**
398  * Create and initialize a AVIOContext for accessing the
399  * resource indicated by url.
400  * @note When the resource indicated by url has been opened in
401  * read+write mode, the AVIOContext can be used only for writing.
402  *
403  * @param s Used to return the pointer to the created AVIOContext.
404  * In case of failure the pointed to value is set to NULL.
405  * @param url resource to access
406  * @param flags flags which control how the resource indicated by url
407  * is to be opened
408  * @return >= 0 in case of success, a negative value corresponding to an
409  * AVERROR code in case of failure
410  */
411 int avio_open(AVIOContext **s, const char *url, int flags);
412 
413 /**
414  * Create and initialize a AVIOContext for accessing the
415  * resource indicated by url.
416  * @note When the resource indicated by url has been opened in
417  * read+write mode, the AVIOContext can be used only for writing.
418  *
419  * @param s Used to return the pointer to the created AVIOContext.
420  * In case of failure the pointed to value is set to NULL.
421  * @param url resource to access
422  * @param flags flags which control how the resource indicated by url
423  * is to be opened
424  * @param int_cb an interrupt callback to be used at the protocols level
425  * @param options A dictionary filled with protocol-private options. On return
426  * this parameter will be destroyed and replaced with a dict containing options
427  * that were not found. May be NULL.
428  * @return >= 0 in case of success, a negative value corresponding to an
429  * AVERROR code in case of failure
430  */
431 int avio_open2(AVIOContext **s, const char *url, int flags,
433 
434 /**
435  * Close the resource accessed by the AVIOContext s and free it.
436  * This function can only be used if s was opened by avio_open().
437  *
438  * The internal buffer is automatically flushed before closing the
439  * resource.
440  *
441  * @return 0 on success, an AVERROR < 0 on error.
442  * @see avio_closep
443  */
444 int avio_close(AVIOContext *s);
445 
446 /**
447  * Close the resource accessed by the AVIOContext *s, free it
448  * and set the pointer pointing to it to NULL.
449  * This function can only be used if s was opened by avio_open().
450  *
451  * The internal buffer is automatically flushed before closing the
452  * resource.
453  *
454  * @return 0 on success, an AVERROR < 0 on error.
455  * @see avio_close
456  */
457 int avio_closep(AVIOContext **s);
458 
459 
460 /**
461  * Open a write only memory stream.
462  *
463  * @param s new IO context
464  * @return zero if no error.
465  */
467 
468 /**
469  * Return the written size and a pointer to the buffer. The buffer
470  * must be freed with av_free().
471  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
472  *
473  * @param s IO context
474  * @param pbuffer pointer to a byte buffer
475  * @return the length of the byte buffer
476  */
477 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
478 
479 /**
480  * Iterate through names of available protocols.
481  *
482  * @param opaque A private pointer representing current protocol.
483  * It must be a pointer to NULL on first iteration and will
484  * be updated by successive calls to avio_enum_protocols.
485  * @param output If set to 1, iterate over output protocols,
486  * otherwise over input protocols.
487  *
488  * @return A static string containing the name of current protocol or NULL
489  */
490 const char *avio_enum_protocols(void **opaque, int output);
491 
492 /**
493  * Pause and resume playing - only meaningful if using a network streaming
494  * protocol (e.g. MMS).
495  *
496  * @param h IO context from which to call the read_pause function pointer
497  * @param pause 1 for pause, 0 for resume
498  */
499 int avio_pause(AVIOContext *h, int pause);
500 
501 /**
502  * Seek to a given timestamp relative to some component stream.
503  * Only meaningful if using a network streaming protocol (e.g. MMS.).
504  *
505  * @param h IO context from which to call the seek function pointers
506  * @param stream_index The stream index that the timestamp is relative to.
507  * If stream_index is (-1) the timestamp should be in AV_TIME_BASE
508  * units from the beginning of the presentation.
509  * If a stream_index >= 0 is used and the protocol does not support
510  * seeking based on component streams, the call will fail.
511  * @param timestamp timestamp in AVStream.time_base units
512  * or if there is no stream specified then in AV_TIME_BASE units.
513  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
514  * and AVSEEK_FLAG_ANY. The protocol may silently ignore
515  * AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
516  * fail if used and not supported.
517  * @return >= 0 on success
518  * @see AVInputFormat::read_seek
519  */
520 int64_t avio_seek_time(AVIOContext *h, int stream_index,
521  int64_t timestamp, int flags);
522 
523 /* Avoid a warning. The header can not be included because it breaks c++. */
524 struct AVBPrint;
525 
526 /**
527  * Read contents of h into print buffer, up to max_size bytes, or up to EOF.
528  *
529  * @return 0 for success (max_size bytes read or EOF reached), negative error
530  * code otherwise
531  */
532 int avio_read_to_bprint(AVIOContext *h, struct AVBPrint *pb, size_t max_size);
533 
534 #endif /* AVFORMAT_AVIO_H */