avio: deprecate av_url_read_seek
[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  * unbuffered I/O operations
26  *
27  * @warning This file has to be considered an internal but installed
28  * header, so it should not be directly included in your projects.
29  */
30
31 #include <stdint.h>
32
33 #include "libavutil/common.h"
34 #include "libavutil/log.h"
35
36 #include "libavformat/version.h"
37
38 /* unbuffered I/O */
39
40 /**
41  * URL Context.
42  * New fields can be added to the end with minor version bumps.
43  * Removal, reordering and changes to existing fields require a major
44  * version bump.
45  * sizeof(URLContext) must not be used outside libav*.
46  */
47 typedef struct URLContext {
48 #if FF_API_URL_CLASS
49     const AVClass *av_class; ///< information for av_log(). Set by url_open().
50 #endif
51     struct URLProtocol *prot;
52     int flags;
53     int is_streamed;  /**< true if streamed (no seek possible), default = false */
54     int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
55     void *priv_data;
56     char *filename; /**< specified URL */
57     int is_connected;
58 } URLContext;
59
60 #if FF_API_OLD_AVIO
61 typedef struct URLPollEntry {
62     URLContext *handle;
63     int events;
64     int revents;
65 } URLPollEntry;
66 #endif
67
68 /**
69  * @defgroup open_modes URL open modes
70  * The flags argument to url_open and cosins must be one of the following
71  * constants, optionally ORed with other flags.
72  * @{
73  */
74 #define URL_RDONLY 0  /**< read-only */
75 #define URL_WRONLY 1  /**< write-only */
76 #define URL_RDWR   2  /**< read-write */
77 /**
78  * @}
79  */
80
81 /**
82  * Use non-blocking mode.
83  * If this flag is set, operations on the context will return
84  * AVERROR(EAGAIN) if they can not be performed immediately.
85  * If this flag is not set, operations on the context will never return
86  * AVERROR(EAGAIN).
87  * Note that this flag does not affect the opening/connecting of the
88  * context. Connecting a protocol will always block if necessary (e.g. on
89  * network protocols) but never hang (e.g. on busy devices).
90  * Warning: non-blocking protocols is work-in-progress; this flag may be
91  * silently ignored.
92  */
93 #define URL_FLAG_NONBLOCK 4
94
95 typedef int URLInterruptCB(void);
96
97 #if FF_API_OLD_AVIO
98 /**
99  * @defgroup old_url_funcs Old url_* functions
100  * @deprecated use the buffered API based on AVIOContext instead
101  * @{
102  */
103 attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
104                                             const char *url, int flags);
105 attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
106 attribute_deprecated int url_connect(URLContext *h);
107 attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
108 attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
109 attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
110 attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
111 attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
112 attribute_deprecated int url_close(URLContext *h);
113 attribute_deprecated int64_t url_filesize(URLContext *h);
114 attribute_deprecated int url_get_file_handle(URLContext *h);
115 attribute_deprecated int url_get_max_packet_size(URLContext *h);
116 attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
117 attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
118 attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
119                                               int64_t timestamp, int flags);
120 #endif
121
122 /**
123  * Return a non-zero value if the resource indicated by url
124  * exists, 0 otherwise.
125  */
126 int url_exist(const char *url);
127
128 /**
129  * The callback is called in blocking functions to test regulary if
130  * asynchronous interruption is needed. AVERROR_EXIT is returned
131  * in this case by the interrupted function. 'NULL' means no interrupt
132  * callback is given.
133  */
134 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
135
136 #if FF_API_OLD_AVIO
137 /* not implemented */
138 attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
139 #endif
140
141
142 #define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
143
144 typedef struct URLProtocol {
145     const char *name;
146     int (*url_open)(URLContext *h, const char *url, int flags);
147     int (*url_read)(URLContext *h, unsigned char *buf, int size);
148     int (*url_write)(URLContext *h, const unsigned char *buf, int size);
149     int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
150     int (*url_close)(URLContext *h);
151     struct URLProtocol *next;
152     int (*url_read_pause)(URLContext *h, int pause);
153     int64_t (*url_read_seek)(URLContext *h, int stream_index,
154                              int64_t timestamp, int flags);
155     int (*url_get_file_handle)(URLContext *h);
156     int priv_data_size;
157     const AVClass *priv_data_class;
158     int flags;
159 } URLProtocol;
160
161 #if FF_API_REGISTER_PROTOCOL
162 extern URLProtocol *first_protocol;
163 #endif
164
165 extern URLInterruptCB *url_interrupt_cb;
166
167 /**
168  * If protocol is NULL, returns the first registered protocol,
169  * if protocol is non-NULL, returns the next registered protocol after protocol,
170  * or NULL if protocol is the last one.
171  */
172 URLProtocol *av_protocol_next(URLProtocol *p);
173
174 #if FF_API_REGISTER_PROTOCOL
175 /**
176  * @deprecated Use av_register_protocol() instead.
177  */
178 attribute_deprecated int register_protocol(URLProtocol *protocol);
179
180 /**
181  * @deprecated Use av_register_protocol2() instead.
182  */
183 attribute_deprecated int av_register_protocol(URLProtocol *protocol);
184 #endif
185
186 /**
187  * Register the URLProtocol protocol.
188  *
189  * @param size the size of the URLProtocol struct referenced
190  */
191 int av_register_protocol2(URLProtocol *protocol, int size);
192
193 #define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
194
195 /**
196  * @}
197  */
198
199 /**
200  * Bytestream IO Context.
201  * New fields can be added to the end with minor version bumps.
202  * Removal, reordering and changes to existing fields require a major
203  * version bump.
204  * sizeof(AVIOContext) must not be used outside libav*.
205  */
206 typedef struct {
207     unsigned char *buffer;
208     int buffer_size;
209     unsigned char *buf_ptr, *buf_end;
210     void *opaque;
211     int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
212     int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
213     int64_t (*seek)(void *opaque, int64_t offset, int whence);
214     int64_t pos; /**< position in the file of the current buffer */
215     int must_flush; /**< true if the next seek should flush */
216     int eof_reached; /**< true if eof reached */
217     int write_flag;  /**< true if open for writing */
218 #if FF_API_OLD_AVIO
219     attribute_deprecated int is_streamed;
220 #endif
221     int max_packet_size;
222     unsigned long checksum;
223     unsigned char *checksum_ptr;
224     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
225     int error;         ///< contains the error code or 0 if no error happened
226     int (*read_pause)(void *opaque, int pause);
227     int64_t (*read_seek)(void *opaque, int stream_index,
228                          int64_t timestamp, int flags);
229     /**
230      * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
231      */
232     int seekable;
233 } AVIOContext;
234
235 #if FF_API_OLD_AVIO
236 typedef attribute_deprecated AVIOContext ByteIOContext;
237
238 attribute_deprecated int init_put_byte(AVIOContext *s,
239                   unsigned char *buffer,
240                   int buffer_size,
241                   int write_flag,
242                   void *opaque,
243                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
244                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
245                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
246 attribute_deprecated AVIOContext *av_alloc_put_byte(
247                   unsigned char *buffer,
248                   int buffer_size,
249                   int write_flag,
250                   void *opaque,
251                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
252                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
253                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
254
255 /**
256  * @defgroup old_avio_funcs Old put_/get_*() functions
257  * @deprecated use the avio_ -prefixed functions instead.
258  * @{
259  */
260 attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
261 attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
262 attribute_deprecated int          get_byte(AVIOContext *s);
263 attribute_deprecated unsigned int get_le16(AVIOContext *s);
264 attribute_deprecated unsigned int get_le24(AVIOContext *s);
265 attribute_deprecated unsigned int get_le32(AVIOContext *s);
266 attribute_deprecated uint64_t     get_le64(AVIOContext *s);
267 attribute_deprecated unsigned int get_be16(AVIOContext *s);
268 attribute_deprecated unsigned int get_be24(AVIOContext *s);
269 attribute_deprecated unsigned int get_be32(AVIOContext *s);
270 attribute_deprecated uint64_t     get_be64(AVIOContext *s);
271
272 attribute_deprecated void         put_byte(AVIOContext *s, int b);
273 attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
274 attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
275 attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
276 attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
277 attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
278 attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
279 attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
280 attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
281 attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
282 attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
283 attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
284 /**
285  * @}
286  */
287
288 attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
289 attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
290                                                 int64_t timestamp, int flags);
291
292 /**
293  * @defgroup old_url_f_funcs Old url_f* functions
294  * @deprecated use the avio_ -prefixed functions instead.
295  * @{
296  */
297 attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
298 attribute_deprecated int url_fclose(AVIOContext *s);
299 attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
300 attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
301 attribute_deprecated int64_t url_ftell(AVIOContext *s);
302 attribute_deprecated int64_t url_fsize(AVIOContext *s);
303 #define URL_EOF (-1)
304 attribute_deprecated int url_fgetc(AVIOContext *s);
305 attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
306 #ifdef __GNUC__
307 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
308 #else
309 attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
310 #endif
311 attribute_deprecated void put_flush_packet(AVIOContext *s);
312 attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
313 attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
314 attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
315 attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
316 /**
317  * @}
318  */
319
320 /**
321  * @deprecated use AVIOContext.eof_reached
322  */
323 attribute_deprecated int url_feof(AVIOContext *s);
324 attribute_deprecated int url_ferror(AVIOContext *s);
325
326 attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
327 attribute_deprecated int udp_get_local_port(URLContext *h);
328
329 attribute_deprecated void init_checksum(AVIOContext *s,
330                    unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
331                    unsigned long checksum);
332 attribute_deprecated unsigned long get_checksum(AVIOContext *s);
333 #endif
334
335 /**
336  * Allocate and initialize an AVIOContext for buffered I/O. It must be later
337  * freed with av_free().
338  *
339  * @param buffer Memory block for input/output operations via AVIOContext.
340  * @param buffer_size The buffer size is very important for performance.
341  *        For protocols with fixed blocksize it should be set to this blocksize.
342  *        For others a typical size is a cache page, e.g. 4kb.
343  * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
344  * @param opaque An opaque pointer to user-specific data.
345  * @param read_packet  A function for refilling the buffer, may be NULL.
346  * @param write_packet A function for writing the buffer contents, may be NULL.
347  * @param seek A function for seeking to specified byte position, may be NULL.
348  *
349  * @return Allocated AVIOContext or NULL on failure.
350  */
351 AVIOContext *avio_alloc_context(
352                   unsigned char *buffer,
353                   int buffer_size,
354                   int write_flag,
355                   void *opaque,
356                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
357                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
358                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
359
360 void avio_w8(AVIOContext *s, int b);
361 void avio_write(AVIOContext *s, const unsigned char *buf, int size);
362 void avio_wl64(AVIOContext *s, uint64_t val);
363 void avio_wb64(AVIOContext *s, uint64_t val);
364 void avio_wl32(AVIOContext *s, unsigned int val);
365 void avio_wb32(AVIOContext *s, unsigned int val);
366 void avio_wl24(AVIOContext *s, unsigned int val);
367 void avio_wb24(AVIOContext *s, unsigned int val);
368 void avio_wl16(AVIOContext *s, unsigned int val);
369 void avio_wb16(AVIOContext *s, unsigned int val);
370
371 #if FF_API_OLD_AVIO
372 attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
373 #endif
374
375 /**
376  * Write a NULL-terminated string.
377  * @return number of bytes written.
378  */
379 int avio_put_str(AVIOContext *s, const char *str);
380
381 /**
382  * Convert an UTF-8 string to UTF-16LE and write it.
383  * @return number of bytes written.
384  */
385 int avio_put_str16le(AVIOContext *s, const char *str);
386
387 /**
388  * Passing this as the "whence" parameter to a seek function causes it to
389  * return the filesize without seeking anywhere. Supporting this is optional.
390  * If it is not supported then the seek function will return <0.
391  */
392 #define AVSEEK_SIZE 0x10000
393
394 /**
395  * Oring this flag as into the "whence" parameter to a seek function causes it to
396  * seek by any means (like reopening and linear reading) or other normally unreasonble
397  * means that can be extreemly slow.
398  * This may be ignored by the seek code.
399  */
400 #define AVSEEK_FORCE 0x20000
401
402 /**
403  * fseek() equivalent for AVIOContext.
404  * @return new position or AVERROR.
405  */
406 int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
407
408 /**
409  * Skip given number of bytes forward
410  * @return new position or AVERROR.
411  */
412 static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
413 {
414     return avio_seek(s, offset, SEEK_CUR);
415 }
416
417 /**
418  * ftell() equivalent for AVIOContext.
419  * @return position or AVERROR.
420  */
421 static av_always_inline int64_t avio_tell(AVIOContext *s)
422 {
423     return avio_seek(s, 0, SEEK_CUR);
424 }
425
426 /**
427  * Get the filesize.
428  * @return filesize or AVERROR
429  */
430 int64_t avio_size(AVIOContext *s);
431
432 /** @warning currently size is limited */
433 #ifdef __GNUC__
434 int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
435 #else
436 int avio_printf(AVIOContext *s, const char *fmt, ...);
437 #endif
438
439 #if FF_API_OLD_AVIO
440 /** @note unlike fgets, the EOL character is not returned and a whole
441     line is parsed. return NULL if first char read was EOF */
442 attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
443 #endif
444
445 void avio_flush(AVIOContext *s);
446
447
448 /**
449  * Read size bytes from AVIOContext into buf.
450  * @return number of bytes read or AVERROR
451  */
452 int avio_read(AVIOContext *s, unsigned char *buf, int size);
453
454 /** @note return 0 if EOF, so you cannot use it if EOF handling is
455     necessary */
456 int          avio_r8  (AVIOContext *s);
457 unsigned int avio_rl16(AVIOContext *s);
458 unsigned int avio_rl24(AVIOContext *s);
459 unsigned int avio_rl32(AVIOContext *s);
460 uint64_t     avio_rl64(AVIOContext *s);
461
462 /**
463  * Read a string from pb into buf. The reading will terminate when either
464  * a NULL character was encountered, maxlen bytes have been read, or nothing
465  * more can be read from pb. The result is guaranteed to be NULL-terminated, it
466  * will be truncated if buf is too small.
467  * Note that the string is not interpreted or validated in any way, it
468  * might get truncated in the middle of a sequence for multi-byte encodings.
469  *
470  * @return number of bytes read (is always <= maxlen).
471  * If reading ends on EOF or error, the return value will be one more than
472  * bytes actually read.
473  */
474 int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
475
476 /**
477  * Read a UTF-16 string from pb and convert it to UTF-8.
478  * The reading will terminate when either a null or invalid character was
479  * encountered or maxlen bytes have been read.
480  * @return number of bytes read (is always <= maxlen)
481  */
482 int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
483 int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
484
485 #if FF_API_OLD_AVIO
486 /**
487  * @deprecated use avio_get_str instead
488  */
489 attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
490 #endif
491 unsigned int avio_rb16(AVIOContext *s);
492 unsigned int avio_rb24(AVIOContext *s);
493 unsigned int avio_rb32(AVIOContext *s);
494 uint64_t     avio_rb64(AVIOContext *s);
495
496 #if FF_API_OLD_AVIO
497 /**
498  * @deprecated Use AVIOContext.seekable field directly.
499  */
500 attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
501 {
502     return !s->seekable;
503 }
504 #endif
505
506 #if FF_API_URL_RESETBUF
507 /** Reset the buffer for reading or writing.
508  * @note Will drop any data currently in the buffer without transmitting it.
509  * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
510  *        to set up the buffer for writing. */
511 int url_resetbuf(AVIOContext *s, int flags);
512 #endif
513
514 /**
515  * Create and initialize a AVIOContext for accessing the
516  * resource indicated by url.
517  * @note When the resource indicated by url has been opened in
518  * read+write mode, the AVIOContext can be used only for writing.
519  *
520  * @param s Used to return the pointer to the created AVIOContext.
521  * In case of failure the pointed to value is set to NULL.
522  * @param flags flags which control how the resource indicated by url
523  * is to be opened
524  * @return 0 in case of success, a negative value corresponding to an
525  * AVERROR code in case of failure
526  */
527 int avio_open(AVIOContext **s, const char *url, int flags);
528
529 int avio_close(AVIOContext *s);
530
531 #if FF_API_OLD_AVIO
532 attribute_deprecated URLContext *url_fileno(AVIOContext *s);
533
534 /**
535  * @deprecated use AVIOContext.max_packet_size directly.
536  */
537 attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
538
539 attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
540
541 /** return the written or read size */
542 attribute_deprecated int url_close_buf(AVIOContext *s);
543 #endif
544
545 /**
546  * Open a write only memory stream.
547  *
548  * @param s new IO context
549  * @return zero if no error.
550  */
551 int avio_open_dyn_buf(AVIOContext **s);
552
553 /**
554  * Return the written size and a pointer to the buffer. The buffer
555  * must be freed with av_free().
556  * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
557  *
558  * @param s IO context
559  * @param pbuffer pointer to a byte buffer
560  * @return the length of the byte buffer
561  */
562 int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
563
564 #if FF_API_UDP_GET_FILE
565 int udp_get_file_handle(URLContext *h);
566 #endif
567
568 #endif /* AVFORMAT_AVIO_H */