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