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