9b9b65e21886f9ca3a6fb62f529e9ab0627e9af6
[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  * @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 {
52     int (*callback)(void*);
53     void *opaque;
54 } AVIOInterruptCB;
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 {
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 */
98     int max_packet_size;
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      */
142      int seek_count;
143 } AVIOContext;
144
145 /* unbuffered I/O */
146
147 /**
148  * Return AVIO_FLAG_* access flags corresponding to the access permissions
149  * of the resource in url, or a negative value corresponding to an
150  * AVERROR code in case of failure. The returned access flags are
151  * masked by the value in flags.
152  *
153  * @note This function is intrinsically unsafe, in the sense that the
154  * checked resource may change its existence or permission status from
155  * one call to another. Thus you should not trust the returned value,
156  * unless you are sure that no other processes are accessing the
157  * checked resource.
158  */
159 int avio_check(const char *url, int flags);
160
161 /**
162  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
163  * freed with av_free().
164  *
165  * @param buffer Memory block for input/output operations via AVIOContext.
166  *        The buffer must be allocated with av_malloc() and friends.
167  * @param buffer_size The buffer size is very important for performance.
168  *        For protocols with fixed blocksize it should be set to this blocksize.
169  *        For others a typical size is a cache page, e.g. 4kb.
170  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
171  * @param opaque An opaque pointer to user-specific data.
172  * @param read_packet  A function for refilling the buffer, may be NULL.
173  * @param write_packet A function for writing the buffer contents, may be NULL.
174  * @param seek A function for seeking to specified byte position, may be NULL.
175  *
176  * @return Allocated AVIOContext or NULL on failure.
177  */
178 AVIOContext *avio_alloc_context(
179                   unsigned char *buffer,
180                   int buffer_size,
181                   int write_flag,
182                   void *opaque,
183                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
184                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
185                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
186
187 void avio_w8(AVIOContext *s, int b);
188 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
189 void avio_wl64(AVIOContext *s, uint64_t val);
190 void avio_wb64(AVIOContext *s, uint64_t val);
191 void avio_wl32(AVIOContext *s, unsigned int val);
192 void avio_wb32(AVIOContext *s, unsigned int val);
193 void avio_wl24(AVIOContext *s, unsigned int val);
194 void avio_wb24(AVIOContext *s, unsigned int val);
195 void avio_wl16(AVIOContext *s, unsigned int val);
196 void avio_wb16(AVIOContext *s, unsigned int val);
197
198 /**
199  * Write a NULL-terminated string.
200  * @return number of bytes written.
201  */
202 int avio_put_str(AVIOContext *s, const char *str);
203
204 /**
205  * Convert an UTF-8 string to UTF-16LE and write it.
206  * @return number of bytes written.
207  */
208 int avio_put_str16le(AVIOContext *s, const char *str);
209
210 /**
211  * Passing this as the "whence" parameter to a seek function causes it to
212  * return the filesize without seeking anywhere. Supporting this is optional.
213  * If it is not supported then the seek function will return <0.
214  */
215 #define AVSEEK_SIZE 0x10000
216
217 /**
218  * Oring this flag as into the "whence" parameter to a seek function causes it to
219  * seek by any means (like reopening and linear reading) or other normally unreasonble
220  * means that can be extreemly slow.
221  * This may be ignored by the seek code.
222  */
223 #define AVSEEK_FORCE 0x20000
224
225 /**
226  * fseek() equivalent for AVIOContext.
227  * @return new position or AVERROR.
228  */
229 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
230
231 /**
232  * Skip given number of bytes forward
233  * @return new position or AVERROR.
234  */
235 int64_t avio_skip(AVIOContext *s, int64_t offset);
236
237 /**
238  * ftell() equivalent for AVIOContext.
239  * @return position or AVERROR.
240  */
241 static av_always_inline int64_t avio_tell(AVIOContext *s)
242 {
243     return avio_seek(s, 0, SEEK_CUR);
244 }
245
246 /**
247  * Get the filesize.
248  * @return filesize or AVERROR
249  */
250 int64_t avio_size(AVIOContext *s);
251
252 /**
253  * feof() equivalent for AVIOContext.
254  * @return non zero if and only if end of file
255  */
256 int url_feof(AVIOContext *s);
257
258 /** @warning currently size is limited */
259 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
260
261 void avio_flush(AVIOContext *s);
262
263
264 /**
265  * Read size bytes from AVIOContext into buf.
266  * @return number of bytes read or AVERROR
267  */
268 int avio_read(AVIOContext *s, unsigned char *buf, int size);
269
270 /**
271  * @name Functions for reading from AVIOContext
272  * @{
273  *
274  * @note return 0 if EOF, so you cannot use it if EOF handling is
275  *       necessary
276  */
277 int          avio_r8  (AVIOContext *s);
278 unsigned int avio_rl16(AVIOContext *s);
279 unsigned int avio_rl24(AVIOContext *s);
280 unsigned int avio_rl32(AVIOContext *s);
281 uint64_t     avio_rl64(AVIOContext *s);
282 unsigned int avio_rb16(AVIOContext *s);
283 unsigned int avio_rb24(AVIOContext *s);
284 unsigned int avio_rb32(AVIOContext *s);
285 uint64_t     avio_rb64(AVIOContext *s);
286 /**
287  * @}
288  */
289
290 /**
291  * Read a string from pb into buf. The reading will terminate when either
292  * a NULL character was encountered, maxlen bytes have been read, or nothing
293  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
294  * will be truncated if buf is too small.
295  * Note that the string is not interpreted or validated in any way, it
296  * might get truncated in the middle of a sequence for multi-byte encodings.
297  *
298  * @return number of bytes read (is always <= maxlen).
299  * If reading ends on EOF or error, the return value will be one more than
300  * bytes actually read.
301  */
302 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
303
304 /**
305  * Read a UTF-16 string from pb and convert it to UTF-8.
306  * The reading will terminate when either a null or invalid character was
307  * encountered or maxlen bytes have been read.
308  * @return number of bytes read (is always <= maxlen)
309  */
310 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
311 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
312
313
314 /**
315  * @name URL open modes
316  * The flags argument to avio_open must be one of the following
317  * constants, optionally ORed with other flags.
318  * @{
319  */
320 #define AVIO_FLAG_READ  1                                      /**< read-only */
321 #define AVIO_FLAG_WRITE 2                                      /**< write-only */
322 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE)  /**< read-write pseudo flag */
323 /**
324  * @}
325  */
326
327 /**
328  * Use non-blocking mode.
329  * If this flag is set, operations on the context will return
330  * AVERROR(EAGAIN) if they can not be performed immediately.
331  * If this flag is not set, operations on the context will never return
332  * AVERROR(EAGAIN).
333  * Note that this flag does not affect the opening/connecting of the
334  * context. Connecting a protocol will always block if necessary (e.g. on
335  * network protocols) but never hang (e.g. on busy devices).
336  * Warning: non-blocking protocols is work-in-progress; this flag may be
337  * silently ignored.
338  */
339 #define AVIO_FLAG_NONBLOCK 8
340
341 /**
342  * Use direct mode.
343  * avio_read and avio_write should if possible be satisfied directly
344  * instead of going through a buffer, and avio_seek will always
345  * call the underlying seek function directly.
346  */
347 #define AVIO_FLAG_DIRECT 0x8000
348
349 /**
350  * Create and initialize a AVIOContext for accessing the
351  * resource indicated by url.
352  * @note When the resource indicated by url has been opened in
353  * read+write mode, the AVIOContext can be used only for writing.
354  *
355  * @param s Used to return the pointer to the created AVIOContext.
356  * In case of failure the pointed to value is set to NULL.
357  * @param flags flags which control how the resource indicated by url
358  * is to be opened
359  * @return 0 in case of success, a negative value corresponding to an
360  * AVERROR code in case of failure
361  */
362 int avio_open(AVIOContext **s, const char *url, int flags);
363
364 /**
365  * Create and initialize a AVIOContext for accessing the
366  * resource indicated by url.
367  * @note When the resource indicated by url has been opened in
368  * read+write mode, the AVIOContext can be used only for writing.
369  *
370  * @param s Used to return the pointer to the created AVIOContext.
371  * In case of failure the pointed to value is set to NULL.
372  * @param flags flags which control how the resource indicated by url
373  * is to be opened
374  * @param int_cb an interrupt callback to be used at the protocols level
375  * @param options  A dictionary filled with protocol-private options. On return
376  * this parameter will be destroyed and replaced with a dict containing options
377  * that were not found. May be NULL.
378  * @return 0 in case of success, a negative value corresponding to an
379  * AVERROR code in case of failure
380  */
381 int avio_open2(AVIOContext **s, const char *url, int flags,
382                const AVIOInterruptCB *int_cb, AVDictionary **options);
383
384 /**
385  * Close the resource accessed by the AVIOContext s and free it.
386  * This function can only be used if s was opened by avio_open().
387  *
388  * @return 0 on success, an AVERROR < 0 on error.
389  */
390 int avio_close(AVIOContext *s);
391
392 /**
393  * Open a write only memory stream.
394  *
395  * @param s new IO context
396  * @return zero if no error.
397  */
398 int avio_open_dyn_buf(AVIOContext **s);
399
400 /**
401  * Return the written size and a pointer to the buffer. The buffer
402  * must be freed with av_free().
403  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
404  *
405  * @param s IO context
406  * @param pbuffer pointer to a byte buffer
407  * @return the length of the byte buffer
408  */
409 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
410
411 /**
412  * Iterate through names of available protocols.
413  *
414  * @param opaque A private pointer representing current protocol.
415  *        It must be a pointer to NULL on first iteration and will
416  *        be updated by successive calls to avio_enum_protocols.
417  * @param output If set to 1, iterate over output protocols,
418  *               otherwise over input protocols.
419  *
420  * @return A static string containing the name of current protocol or NULL
421  */
422 const char *avio_enum_protocols(void **opaque, int output);
423
424 /**
425  * Pause and resume playing - only meaningful if using a network streaming
426  * protocol (e.g. MMS).
427  * @param pause 1 for pause, 0 for resume
428  */
429 int     avio_pause(AVIOContext *h, int pause);
430
431 /**
432  * Seek to a given timestamp relative to some component stream.
433  * Only meaningful if using a network streaming protocol (e.g. MMS.).
434  * @param stream_index The stream index that the timestamp is relative to.
435  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
436  *        units from the beginning of the presentation.
437  *        If a stream_index >= 0 is used and the protocol does not support
438  *        seeking based on component streams, the call will fail.
439  * @param timestamp timestamp in AVStream.time_base units
440  *        or if there is no stream specified then in AV_TIME_BASE units.
441  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
442  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
443  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
444  *        fail if used and not supported.
445  * @return >= 0 on success
446  * @see AVInputFormat::read_seek
447  */
448 int64_t avio_seek_time(AVIOContext *h, int stream_index,
449                        int64_t timestamp, int flags);
450
451 #endif /* AVFORMAT_AVIO_H */