Non-blocking protocol: core wrapper functions
[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  * 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 typedef struct URLPollEntry {
61     URLContext *handle;
62     int events;
63     int revents;
64 } URLPollEntry;
65
66 /**
67  * @defgroup open_modes URL open modes
68  * The flags argument to url_open and cosins must be one of the following
69  * constants, optionally ORed with other flags.
70  * @{
71  */
72 #define URL_RDONLY 0  /**< read-only */
73 #define URL_WRONLY 1  /**< write-only */
74 #define URL_RDWR   2  /**< read-write */
75 /**
76  * @}
77  */
78
79 /**
80  * Use non-blocking mode.
81  * If this flag is set, operations on the context will return
82  * AVERROR(EAGAIN) if they can not be performed immediately.
83  * If this flag is not set, operations on the context will never return
84  * AVERROR(EAGAIN).
85  * Note that this flag does not affect the opening/connecting of the
86  * context. Connecting a protocol will always block if necessary (e.g. on
87  * network protocols) but never hang (e.g. on busy devices).
88  * Warning: non-blocking protocols is work-in-progress; this flag may be
89  * silently ignored.
90  */
91 #define URL_FLAG_NONBLOCK 4
92
93 typedef int URLInterruptCB(void);
94
95 /**
96  * Create a URLContext for accessing to the resource indicated by
97  * url, and open it using the URLProtocol up.
98  *
99  * @param puc pointer to the location where, in case of success, the
100  * function puts the pointer to the created URLContext
101  * @param flags flags which control how the resource indicated by url
102  * is to be opened
103  * @return 0 in case of success, a negative value corresponding to an
104  * AVERROR code in case of failure
105  */
106 int url_open_protocol (URLContext **puc, struct URLProtocol *up,
107                        const char *url, int flags);
108
109 /**
110  * Create a URLContext for accessing to the resource indicated by
111  * url, but do not initiate the connection yet.
112  *
113  * @param puc pointer to the location where, in case of success, the
114  * function puts the pointer to the created URLContext
115  * @param flags flags which control how the resource indicated by url
116  * is to be opened
117  * @return 0 in case of success, a negative value corresponding to an
118  * AVERROR code in case of failure
119  */
120 int url_alloc(URLContext **h, const char *url, int flags);
121
122 /**
123  * Connect an URLContext that has been allocated by url_alloc
124  */
125 int url_connect(URLContext *h);
126
127 /**
128  * Create an URLContext for accessing to the resource indicated by
129  * url, and open it.
130  *
131  * @param puc pointer to the location where, in case of success, the
132  * function puts the pointer to the created URLContext
133  * @param flags flags which control how the resource indicated by url
134  * is to be opened
135  * @return 0 in case of success, a negative value corresponding to an
136  * AVERROR code in case of failure
137  */
138 int url_open(URLContext **h, const char *url, int flags);
139
140 /**
141  * Read up to size bytes from the resource accessed by h, and store
142  * the read bytes in buf.
143  *
144  * @return The number of bytes actually read, or a negative value
145  * corresponding to an AVERROR code in case of error. A value of zero
146  * indicates that it is not possible to read more from the accessed
147  * resource (except if the value of the size argument is also zero).
148  */
149 int url_read(URLContext *h, unsigned char *buf, int size);
150
151 /**
152  * Read as many bytes as possible (up to size), calling the
153  * read function multiple times if necessary.
154  * This makes special short-read handling in applications
155  * unnecessary, if the return value is < size then it is
156  * certain there was either an error or the end of file was reached.
157  */
158 int url_read_complete(URLContext *h, unsigned char *buf, int size);
159
160 /**
161  * Write size bytes from buf to the resource accessed by h.
162  *
163  * @return the number of bytes actually written, or a negative value
164  * corresponding to an AVERROR code in case of failure
165  */
166 int url_write(URLContext *h, const unsigned char *buf, int size);
167
168 /**
169  * Passing this as the "whence" parameter to a seek function causes it to
170  * return the filesize without seeking anywhere. Supporting this is optional.
171  * If it is not supported then the seek function will return <0.
172  */
173 #define AVSEEK_SIZE 0x10000
174
175 /**
176  * Change the position that will be used by the next read/write
177  * operation on the resource accessed by h.
178  *
179  * @param pos specifies the new position to set
180  * @param whence specifies how pos should be interpreted, it must be
181  * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
182  * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
183  * (return the filesize of the requested resource, pos is ignored).
184  * @return a negative value corresponding to an AVERROR code in case
185  * of failure, or the resulting file position, measured in bytes from
186  * the beginning of the file. You can use this feature together with
187  * SEEK_CUR to read the current file position.
188  */
189 int64_t url_seek(URLContext *h, int64_t pos, int whence);
190
191 /**
192  * Close the resource accessed by the URLContext h, and free the
193  * memory used by it.
194  *
195  * @return a negative value if an error condition occurred, 0
196  * otherwise
197  */
198 int url_close(URLContext *h);
199
200 /**
201  * Return a non-zero value if the resource indicated by url
202  * exists, 0 otherwise.
203  */
204 int url_exist(const char *url);
205
206 /**
207  * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
208  * if the operation is not supported by h, or another negative value
209  * corresponding to an AVERROR error code in case of failure.
210  */
211 int64_t url_filesize(URLContext *h);
212
213 /**
214  * Return the file descriptor associated with this URL. For RTP, this
215  * will return only the RTP file descriptor, not the RTCP file descriptor.
216  *
217  * @return the file descriptor associated with this URL, or <0 on error.
218  */
219 int url_get_file_handle(URLContext *h);
220
221 /**
222  * Return the maximum packet size associated to packetized file
223  * handle. If the file is not packetized (stream like HTTP or file on
224  * disk), then 0 is returned.
225  *
226  * @param h file handle
227  * @return maximum packet size in bytes
228  */
229 int url_get_max_packet_size(URLContext *h);
230
231 /**
232  * Copy the filename of the resource accessed by h to buf.
233  *
234  * @param buf_size size in bytes of buf
235  */
236 void url_get_filename(URLContext *h, char *buf, int buf_size);
237
238 /**
239  * The callback is called in blocking functions to test regulary if
240  * asynchronous interruption is needed. AVERROR(EINTR) is returned
241  * in this case by the interrupted function. 'NULL' means no interrupt
242  * callback is given.
243  */
244 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
245
246 /* not implemented */
247 int url_poll(URLPollEntry *poll_table, int n, int timeout);
248
249 /**
250  * Pause and resume playing - only meaningful if using a network streaming
251  * protocol (e.g. MMS).
252  * @param pause 1 for pause, 0 for resume
253  */
254 int av_url_read_pause(URLContext *h, int pause);
255
256 /**
257  * Seek to a given timestamp relative to some component stream.
258  * Only meaningful if using a network streaming protocol (e.g. MMS.).
259  * @param stream_index The stream index that the timestamp is relative to.
260  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
261  *        units from the beginning of the presentation.
262  *        If a stream_index >= 0 is used and the protocol does not support
263  *        seeking based on component streams, the call will fail with ENOTSUP.
264  * @param timestamp timestamp in AVStream.time_base units
265  *        or if there is no stream specified then in AV_TIME_BASE units.
266  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
267  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
268  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
269  *        fail with ENOTSUP if used and not supported.
270  * @return >= 0 on success
271  * @see AVInputFormat::read_seek
272  */
273 int64_t av_url_read_seek(URLContext *h, int stream_index,
274                          int64_t timestamp, int flags);
275
276 /**
277  * Oring this flag as into the "whence" parameter to a seek function causes it to
278  * seek by any means (like reopening and linear reading) or other normally unreasonble
279  * means that can be extreemly slow.
280  * This may be ignored by the seek code.
281  */
282 #define AVSEEK_FORCE 0x20000
283
284 typedef struct URLProtocol {
285     const char *name;
286     int (*url_open)(URLContext *h, const char *url, int flags);
287     int (*url_read)(URLContext *h, unsigned char *buf, int size);
288     int (*url_write)(URLContext *h, const unsigned char *buf, int size);
289     int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
290     int (*url_close)(URLContext *h);
291     struct URLProtocol *next;
292     int (*url_read_pause)(URLContext *h, int pause);
293     int64_t (*url_read_seek)(URLContext *h, int stream_index,
294                              int64_t timestamp, int flags);
295     int (*url_get_file_handle)(URLContext *h);
296     int priv_data_size;
297     const AVClass *priv_data_class;
298 } URLProtocol;
299
300 #if FF_API_REGISTER_PROTOCOL
301 extern URLProtocol *first_protocol;
302 #endif
303
304 extern URLInterruptCB *url_interrupt_cb;
305
306 /**
307  * If protocol is NULL, returns the first registered protocol,
308  * if protocol is non-NULL, returns the next registered protocol after protocol,
309  * or NULL if protocol is the last one.
310  */
311 URLProtocol *av_protocol_next(URLProtocol *p);
312
313 #if FF_API_REGISTER_PROTOCOL
314 /**
315  * @deprecated Use av_register_protocol() instead.
316  */
317 attribute_deprecated int register_protocol(URLProtocol *protocol);
318
319 /**
320  * @deprecated Use av_register_protocol2() instead.
321  */
322 attribute_deprecated int av_register_protocol(URLProtocol *protocol);
323 #endif
324
325 /**
326  * Register the URLProtocol protocol.
327  *
328  * @param size the size of the URLProtocol struct referenced
329  */
330 int av_register_protocol2(URLProtocol *protocol, int size);
331
332 /**
333  * Bytestream IO Context.
334  * New fields can be added to the end with minor version bumps.
335  * Removal, reordering and changes to existing fields require a major
336  * version bump.
337  * sizeof(ByteIOContext) must not be used outside libav*.
338  */
339 typedef struct {
340     unsigned char *buffer;
341     int buffer_size;
342     unsigned char *buf_ptr, *buf_end;
343     void *opaque;
344     int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
345     int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
346     int64_t (*seek)(void *opaque, int64_t offset, int whence);
347     int64_t pos; /**< position in the file of the current buffer */
348     int must_flush; /**< true if the next seek should flush */
349     int eof_reached; /**< true if eof reached */
350     int write_flag;  /**< true if open for writing */
351     int is_streamed;
352     int max_packet_size;
353     unsigned long checksum;
354     unsigned char *checksum_ptr;
355     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
356     int error;         ///< contains the error code or 0 if no error happened
357     int (*read_pause)(void *opaque, int pause);
358     int64_t (*read_seek)(void *opaque, int stream_index,
359                          int64_t timestamp, int flags);
360 } ByteIOContext;
361
362 int init_put_byte(ByteIOContext *s,
363                   unsigned char *buffer,
364                   int buffer_size,
365                   int write_flag,
366                   void *opaque,
367                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
368                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
369                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
370 ByteIOContext *av_alloc_put_byte(
371                   unsigned char *buffer,
372                   int buffer_size,
373                   int write_flag,
374                   void *opaque,
375                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
376                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
377                   int64_t (*seek)(void *opaque, int64_t offset, int whence));
378
379 void put_byte(ByteIOContext *s, int b);
380 void put_nbyte(ByteIOContext *s, int b, int count);
381 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
382 void put_le64(ByteIOContext *s, uint64_t val);
383 void put_be64(ByteIOContext *s, uint64_t val);
384 void put_le32(ByteIOContext *s, unsigned int val);
385 void put_be32(ByteIOContext *s, unsigned int val);
386 void put_le24(ByteIOContext *s, unsigned int val);
387 void put_be24(ByteIOContext *s, unsigned int val);
388 void put_le16(ByteIOContext *s, unsigned int val);
389 void put_be16(ByteIOContext *s, unsigned int val);
390 void put_tag(ByteIOContext *s, const char *tag);
391
392 #if FF_API_OLD_AVIO
393 attribute_deprecated void put_strz(ByteIOContext *s, const char *buf);
394 #endif
395
396 /**
397  * Write a NULL-terminated string.
398  * @return number of bytes written.
399  */
400 int avio_put_str(ByteIOContext *s, const char *str);
401
402 /**
403  * Convert an UTF-8 string to UTF-16LE and write it.
404  * @return number of bytes written.
405  */
406 int avio_put_str16le(ByteIOContext *s, const char *str);
407
408 /**
409  * fseek() equivalent for ByteIOContext.
410  * @return new position or AVERROR.
411  */
412 int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
413
414 /**
415  * Skip given number of bytes forward.
416  * @param offset number of bytes
417  * @return 0 on success, <0 on error
418  */
419 int url_fskip(ByteIOContext *s, int64_t offset);
420
421 /**
422  * ftell() equivalent for ByteIOContext.
423  * @return position or AVERROR.
424  */
425 int64_t url_ftell(ByteIOContext *s);
426
427 /**
428  * Get the filesize.
429  * @return filesize or AVERROR
430  */
431 int64_t url_fsize(ByteIOContext *s);
432
433 /**
434  * feof() equivalent for ByteIOContext.
435  * @return non zero if and only if end of file
436  */
437 int url_feof(ByteIOContext *s);
438
439 int url_ferror(ByteIOContext *s);
440
441 int av_url_read_fpause(ByteIOContext *h, int pause);
442 int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
443                           int64_t timestamp, int flags);
444
445 #define URL_EOF (-1)
446 /** @note return URL_EOF (-1) if EOF */
447 int url_fgetc(ByteIOContext *s);
448
449 /** @warning currently size is limited */
450 #ifdef __GNUC__
451 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
452 #else
453 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
454 #endif
455
456 /** @note unlike fgets, the EOL character is not returned and a whole
457     line is parsed. return NULL if first char read was EOF */
458 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
459
460 void put_flush_packet(ByteIOContext *s);
461
462
463 /**
464  * Read size bytes from ByteIOContext into buf.
465  * @return number of bytes read or AVERROR
466  */
467 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
468
469 /**
470  * Read size bytes from ByteIOContext into buf.
471  * This reads at most 1 packet. If that is not enough fewer bytes will be
472  * returned.
473  * @return number of bytes read or AVERROR
474  */
475 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
476
477 /** @note return 0 if EOF, so you cannot use it if EOF handling is
478     necessary */
479 int get_byte(ByteIOContext *s);
480 unsigned int get_le24(ByteIOContext *s);
481 unsigned int get_le32(ByteIOContext *s);
482 uint64_t get_le64(ByteIOContext *s);
483 unsigned int get_le16(ByteIOContext *s);
484
485 /**
486  * Read a UTF-16 string from pb and convert it to UTF-8.
487  * The reading will terminate when either a null or invalid character was
488  * encountered or maxlen bytes have been read.
489  * @return number of bytes read (is always <= maxlen)
490  */
491 int avio_get_str16le(ByteIOContext *pb, int maxlen, char *buf, int buflen);
492 int avio_get_str16be(ByteIOContext *pb, int maxlen, char *buf, int buflen);
493
494 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
495 unsigned int get_be16(ByteIOContext *s);
496 unsigned int get_be24(ByteIOContext *s);
497 unsigned int get_be32(ByteIOContext *s);
498 uint64_t get_be64(ByteIOContext *s);
499
500 uint64_t ff_get_v(ByteIOContext *bc);
501
502 static inline int url_is_streamed(ByteIOContext *s)
503 {
504     return s->is_streamed;
505 }
506
507 /**
508  * Create and initialize a ByteIOContext for accessing the
509  * resource referenced by the URLContext h.
510  * @note When the URLContext h has been opened in read+write mode, the
511  * ByteIOContext can be used only for writing.
512  *
513  * @param s Used to return the pointer to the created ByteIOContext.
514  * In case of failure the pointed to value is set to NULL.
515  * @return 0 in case of success, a negative value corresponding to an
516  * AVERROR code in case of failure
517  */
518 int url_fdopen(ByteIOContext **s, URLContext *h);
519
520 /** @warning must be called before any I/O */
521 int url_setbufsize(ByteIOContext *s, int buf_size);
522 #if FF_API_URL_RESETBUF
523 /** Reset the buffer for reading or writing.
524  * @note Will drop any data currently in the buffer without transmitting it.
525  * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
526  *        to set up the buffer for writing. */
527 int url_resetbuf(ByteIOContext *s, int flags);
528 #endif
529
530 /**
531  * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
532  * Used after probing to avoid seeking.
533  * Joins buf and s->buffer, taking any overlap into consideration.
534  * @note s->buffer must overlap with buf or they can't be joined and the function fails
535  * @note This function is NOT part of the public API
536  *
537  * @param s The read-only ByteIOContext to rewind
538  * @param buf The probe buffer containing the first buf_size bytes of the file
539  * @param buf_size The size of buf
540  * @return 0 in case of success, a negative value corresponding to an
541  * AVERROR code in case of failure
542  */
543 int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
544
545 /**
546  * Create and initialize a ByteIOContext for accessing the
547  * resource indicated by url.
548  * @note When the resource indicated by url has been opened in
549  * read+write mode, the ByteIOContext can be used only for writing.
550  *
551  * @param s Used to return the pointer to the created ByteIOContext.
552  * In case of failure the pointed to value is set to NULL.
553  * @param flags flags which control how the resource indicated by url
554  * is to be opened
555  * @return 0 in case of success, a negative value corresponding to an
556  * AVERROR code in case of failure
557  */
558 int url_fopen(ByteIOContext **s, const char *url, int flags);
559
560 int url_fclose(ByteIOContext *s);
561 URLContext *url_fileno(ByteIOContext *s);
562
563 /**
564  * Return the maximum packet size associated to packetized buffered file
565  * handle. If the file is not packetized (stream like http or file on
566  * disk), then 0 is returned.
567  *
568  * @param s buffered file handle
569  * @return maximum packet size in bytes
570  */
571 int url_fget_max_packet_size(ByteIOContext *s);
572
573 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
574
575 /** return the written or read size */
576 int url_close_buf(ByteIOContext *s);
577
578 /**
579  * Open a write only memory stream.
580  *
581  * @param s new IO context
582  * @return zero if no error.
583  */
584 int url_open_dyn_buf(ByteIOContext **s);
585
586 /**
587  * Open a write only packetized memory stream with a maximum packet
588  * size of 'max_packet_size'.  The stream is stored in a memory buffer
589  * with a big endian 4 byte header giving the packet size in bytes.
590  *
591  * @param s new IO context
592  * @param max_packet_size maximum packet size (must be > 0)
593  * @return zero if no error.
594  */
595 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
596
597 /**
598  * Return the written size and a pointer to the buffer. The buffer
599  * must be freed with av_free(). If the buffer is opened with
600  * url_open_dyn_buf, then padding of FF_INPUT_BUFFER_PADDING_SIZE is
601  * added; if opened with url_open_dyn_packet_buf, no padding is added.
602  *
603  * @param s IO context
604  * @param pbuffer pointer to a byte buffer
605  * @return the length of the byte buffer
606  */
607 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
608
609 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
610                                     unsigned int len);
611 unsigned long get_checksum(ByteIOContext *s);
612 void init_checksum(ByteIOContext *s,
613                    unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
614                    unsigned long checksum);
615
616 /* udp.c */
617 int udp_set_remote_url(URLContext *h, const char *uri);
618 int udp_get_local_port(URLContext *h);
619 #if FF_API_UDP_GET_FILE
620 int udp_get_file_handle(URLContext *h);
621 #endif
622
623 #endif /* AVFORMAT_AVIO_H */