avio: Keep track of the amount of data written
[libav.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 * Seeking by timestamp with avio_seek_time() is possible.
44 */
45 #define AVIO_SEEKABLE_TIME (1 << 1)
46
47 /**
48 * Callback for checking whether to abort blocking functions.
49 * AVERROR_EXIT is returned in this case by the interrupted
50 * function. During blocking operations, callback is called with
51 * opaque as parameter. If the callback returns 1, the
52 * blocking operation will be aborted.
53 *
54 * No members can be added to this struct without a major bump, if
55 * new elements have been added after this struct in AVFormatContext
56 * or AVIOContext.
57 */
58 typedef struct AVIOInterruptCB {
59 int (*callback)(void*);
60 void *opaque;
61 } AVIOInterruptCB;
62
63 /**
64 * Different data types that can be returned via the AVIO
65 * write_data_type callback.
66 */
67 enum AVIODataMarkerType {
68 /**
69 * Header data; this needs to be present for the stream to be decodeable.
70 */
71 AVIO_DATA_MARKER_HEADER,
72 /**
73 * A point in the output bytestream where a decoder can start decoding
74 * (i.e. a keyframe). A demuxer/decoder given the data flagged with
75 * AVIO_DATA_MARKER_HEADER, followed by any AVIO_DATA_MARKER_SYNC_POINT,
76 * should give decodeable results.
77 */
78 AVIO_DATA_MARKER_SYNC_POINT,
79 /**
80 * A point in the output bytestream where a demuxer can start parsing
81 * (for non self synchronizing bytestream formats). That is, any
82 * non-keyframe packet start point.
83 */
84 AVIO_DATA_MARKER_BOUNDARY_POINT,
85 /**
86 * This is any, unlabelled data. It can either be a muxer not marking
87 * any positions at all, it can be an actual boundary/sync point
88 * that the muxer chooses not to mark, or a later part of a packet/fragment
89 * that is cut into multiple write callbacks due to limited IO buffer size.
90 */
91 AVIO_DATA_MARKER_UNKNOWN,
92 /**
93 * Trailer data, which doesn't contain actual content, but only for
94 * finalizing the output file.
95 */
96 AVIO_DATA_MARKER_TRAILER
97 };
98
99 /**
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
103 * version bump.
104 * sizeof(AVIOContext) must not be used outside libav*.
105 *
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()
110 */
111 typedef struct AVIOContext {
112 /**
113 * A class for private options.
114 *
115 * If this AVIOContext is created by avio_open2(), av_class is set and
116 * passes the options down to protocols.
117 *
118 * If this AVIOContext is manually allocated, then av_class may be set by
119 * the caller.
120 *
121 * warning -- this field can be NULL, be sure to not pass this AVIOContext
122 * to any av_opt_* functions in that case.
123 */
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/...
133 functions. */
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 */
141 int max_packet_size;
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 */
146 /**
147 * Pause or resume playback for network streaming protocols - e.g. MMS.
148 */
149 int (*read_pause)(void *opaque, int pause);
150 /**
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
153 * to byte position.
154 */
155 int64_t (*read_seek)(void *opaque, int stream_index,
156 int64_t timestamp, int flags);
157 /**
158 * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
159 */
160 int seekable;
161
162 /**
163 * A callback that is used instead of write_packet.
164 */
165 int (*write_data_type)(void *opaque, uint8_t *buf, int buf_size,
166 enum AVIODataMarkerType type, int64_t time);
167 /**
168 * If set, don't call write_data_type separately for AVIO_DATA_MARKER_BOUNDARY_POINT,
169 * but ignore them and treat them as AVIO_DATA_MARKER_UNKNOWN (to avoid needlessly
170 * small chunks of data returned from the callback).
171 */
172 int ignore_boundary_point;
173
174 /**
175 * Internal, not meant to be used from outside of AVIOContext.
176 */
177 enum AVIODataMarkerType current_type;
178 int64_t last_time;
179 int64_t written;
180 } AVIOContext;
181
182 /**
183 * Return AVIO_FLAG_* access flags corresponding to the access permissions
184 * of the resource in url, or a negative value corresponding to an
185 * AVERROR code in case of failure. The returned access flags are
186 * masked by the value in flags.
187 *
188 * @note This function is intrinsically unsafe, in the sense that the
189 * checked resource may change its existence or permission status from
190 * one call to another. Thus you should not trust the returned value,
191 * unless you are sure that no other processes are accessing the
192 * checked resource.
193 */
194 int avio_check(const char *url, int flags);
195
196 /**
197 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
198 * freed with av_free().
199 *
200 * @param buffer Memory block for input/output operations via AVIOContext.
201 * The buffer must be allocated with av_malloc() and friends.
202 * @param buffer_size The buffer size is very important for performance.
203 * For protocols with fixed blocksize it should be set to this blocksize.
204 * For others a typical size is a cache page, e.g. 4kb.
205 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
206 * @param opaque An opaque pointer to user-specific data.
207 * @param read_packet A function for refilling the buffer, may be NULL.
208 * @param write_packet A function for writing the buffer contents, may be NULL.
209 * @param seek A function for seeking to specified byte position, may be NULL.
210 *
211 * @return Allocated AVIOContext or NULL on failure.
212 */
213 AVIOContext *avio_alloc_context(
214 unsigned char *buffer,
215 int buffer_size,
216 int write_flag,
217 void *opaque,
218 int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
219 int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
220 int64_t (*seek)(void *opaque, int64_t offset, int whence));
221
222 void avio_w8(AVIOContext *s, int b);
223 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
224 void avio_wl64(AVIOContext *s, uint64_t val);
225 void avio_wb64(AVIOContext *s, uint64_t val);
226 void avio_wl32(AVIOContext *s, unsigned int val);
227 void avio_wb32(AVIOContext *s, unsigned int val);
228 void avio_wl24(AVIOContext *s, unsigned int val);
229 void avio_wb24(AVIOContext *s, unsigned int val);
230 void avio_wl16(AVIOContext *s, unsigned int val);
231 void avio_wb16(AVIOContext *s, unsigned int val);
232
233 /**
234 * Write a NULL-terminated string.
235 * @return number of bytes written.
236 */
237 int avio_put_str(AVIOContext *s, const char *str);
238
239 /**
240 * Convert an UTF-8 string to UTF-16LE and write it.
241 * @param s the AVIOContext
242 * @param str NULL-terminated UTF-8 string
243 *
244 * @return number of bytes written.
245 */
246 int avio_put_str16le(AVIOContext *s, const char *str);
247
248 /**
249 * Convert an UTF-8 string to UTF-16BE and write it.
250 * @param s the AVIOContext
251 * @param str NULL-terminated UTF-8 string
252 *
253 * @return number of bytes written.
254 */
255 int avio_put_str16be(AVIOContext *s, const char *str);
256
257 /**
258 * Mark the written bytestream as a specific type.
259 *
260 * Zero-length ranges are omitted from the output.
261 *
262 * @param time the stream time the current bytestream pos corresponds to
263 * (in AV_TIME_BASE units), or AV_NOPTS_VALUE if unknown or not
264 * applicable
265 * @param type the kind of data written starting at the current pos
266 */
267 void avio_write_marker(AVIOContext *s, int64_t time, enum AVIODataMarkerType type);
268
269 /**
270 * ORing this as the "whence" parameter to a seek function causes it to
271 * return the filesize without seeking anywhere. Supporting this is optional.
272 * If it is not supported then the seek function will return <0.
273 */
274 #define AVSEEK_SIZE 0x10000
275
276 /**
277 * Passing this flag as the "whence" parameter to a seek function causes it to
278 * seek by any means (like reopening and linear reading) or other normally unreasonable
279 * means that can be extremely slow.
280 * This may be ignored by the seek code.
281 */
282 #define AVSEEK_FORCE 0x20000
283
284 /**
285 * fseek() equivalent for AVIOContext.
286 * @return new position or AVERROR.
287 */
288 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
289
290 /**
291 * Skip given number of bytes forward
292 * @return new position or AVERROR.
293 */
294 static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
295 {
296 return avio_seek(s, offset, SEEK_CUR);
297 }
298
299 /**
300 * ftell() equivalent for AVIOContext.
301 * @return position or AVERROR.
302 */
303 static av_always_inline int64_t avio_tell(AVIOContext *s)
304 {
305 return avio_seek(s, 0, SEEK_CUR);
306 }
307
308 /**
309 * Get the filesize.
310 * @return filesize or AVERROR
311 */
312 int64_t avio_size(AVIOContext *s);
313
314 /** @warning currently size is limited */
315 int avio_printf(AVIOContext *s, const char *fmt, ...) av_printf_format(2, 3);
316
317 void avio_flush(AVIOContext *s);
318
319
320 /**
321 * Read size bytes from AVIOContext into buf.
322 * @return number of bytes read or AVERROR
323 */
324 int avio_read(AVIOContext *s, unsigned char *buf, int size);
325
326 /**
327 * @name Functions for reading from AVIOContext
328 * @{
329 *
330 * @note return 0 if EOF, so you cannot use it if EOF handling is
331 * necessary
332 */
333 int avio_r8 (AVIOContext *s);
334 unsigned int avio_rl16(AVIOContext *s);
335 unsigned int avio_rl24(AVIOContext *s);
336 unsigned int avio_rl32(AVIOContext *s);
337 uint64_t avio_rl64(AVIOContext *s);
338 unsigned int avio_rb16(AVIOContext *s);
339 unsigned int avio_rb24(AVIOContext *s);
340 unsigned int avio_rb32(AVIOContext *s);
341 uint64_t avio_rb64(AVIOContext *s);
342 /**
343 * @}
344 */
345
346 /**
347 * Read a string from pb into buf. The reading will terminate when either
348 * a NULL character was encountered, maxlen bytes have been read, or nothing
349 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
350 * will be truncated if buf is too small.
351 * Note that the string is not interpreted or validated in any way, it
352 * might get truncated in the middle of a sequence for multi-byte encodings.
353 *
354 * @return number of bytes read (is always <= maxlen).
355 * If reading ends on EOF or error, the return value will be one more than
356 * bytes actually read.
357 */
358 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
359
360 /**
361 * Read a UTF-16 string from pb and convert it to UTF-8.
362 * The reading will terminate when either a null or invalid character was
363 * encountered or maxlen bytes have been read.
364 * @return number of bytes read (is always <= maxlen)
365 */
366 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
367 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
368
369
370 /**
371 * @name URL open modes
372 * The flags argument to avio_open must be one of the following
373 * constants, optionally ORed with other flags.
374 * @{
375 */
376 #define AVIO_FLAG_READ 1 /**< read-only */
377 #define AVIO_FLAG_WRITE 2 /**< write-only */
378 #define AVIO_FLAG_READ_WRITE (AVIO_FLAG_READ|AVIO_FLAG_WRITE) /**< read-write pseudo flag */
379 /**
380 * @}
381 */
382
383 /**
384 * Use non-blocking mode.
385 * If this flag is set, operations on the context will return
386 * AVERROR(EAGAIN) if they can not be performed immediately.
387 * If this flag is not set, operations on the context will never return
388 * AVERROR(EAGAIN).
389 * Note that this flag does not affect the opening/connecting of the
390 * context. Connecting a protocol will always block if necessary (e.g. on
391 * network protocols) but never hang (e.g. on busy devices).
392 * Warning: non-blocking protocols is work-in-progress; this flag may be
393 * silently ignored.
394 */
395 #define AVIO_FLAG_NONBLOCK 8
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,
432 const AVIOInterruptCB *int_cb, AVDictionary **options);
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 */
466 int avio_open_dyn_buf(AVIOContext **s);
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 AV_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 with ENOTSUP.
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 with ENOTSUP 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 #endif /* AVFORMAT_AVIO_H */