libavformat/avio.h

   1 /*
   2  * unbuffered io for ffmpeg system
   3  * copyright (c) 2001 Fabrice Bellard
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21 #ifndef FFMPEG_AVIO_H
  22 #define FFMPEG_AVIO_H
  23
  24 #include <stdint.h>
  25
  26 /* output byte stream handling */
  27
  28 typedef int64_t offset_t;
  29
  30 /* unbuffered I/O */
  31
  32 /**
  33  * URL Context.
  34  * New fields can be added to the end with minor version bumps.
  35  * Removal, reordering and changes to existing fields require a major
  36  * version bump.
  37  * sizeof(URLContext) must not be used outside libav*.
  38  */
  39 struct URLContext {
  40     struct URLProtocol *prot;
  41     int flags;
  42     int is_streamed;  /**< true if streamed (no seek possible), default = false */
  43     int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
  44     void *priv_data;
  45     char *filename; /**< specified filename */
  46 };
  47
  48 typedef struct URLContext URLContext;
  49
  50 typedef struct URLPollEntry {
  51     URLContext *handle;
  52     int events;
  53     int revents;
  54 } URLPollEntry;
  55
  56 #define URL_RDONLY 0
  57 #define URL_WRONLY 1
  58 #define URL_RDWR   2
  59
  60 typedef int URLInterruptCB(void);
  61
  62 int url_open(URLContext **h, const char *filename, int flags);
  63 int url_read(URLContext *h, unsigned char *buf, int size);
  64 int url_write(URLContext *h, unsigned char *buf, int size);
  65 offset_t url_seek(URLContext *h, offset_t pos, int whence);
  66 int url_close(URLContext *h);
  67 int url_exist(const char *filename);
  68 offset_t url_filesize(URLContext *h);
  69
  70 /**
  71  * Return the maximum packet size associated to packetized file
  72  * handle. If the file is not packetized (stream like HTTP or file on
  73  * disk), then 0 is returned.
  74  *
  75  * @param h file handle
  76  * @return maximum packet size in bytes
  77  */
  78 int url_get_max_packet_size(URLContext *h);
  79 void url_get_filename(URLContext *h, char *buf, int buf_size);
  80
  81 /**
  82  * The callback is called in blocking functions to test regulary if
  83  * asynchronous interruption is needed. AVERROR(EINTR) is returned
  84  * in this case by the interrupted function. 'NULL' means no interrupt
  85  * callback is given.
  86  */
  87 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
  88
  89 /* not implemented */
  90 int url_poll(URLPollEntry *poll_table, int n, int timeout);
  91
  92 /**
  93  * Pause and resume playing - only meaningful if using a network streaming
  94  * protocol (e.g. MMS).
  95  * @param pause 1 for pause, 0 for resume
  96  */
  97 int av_url_read_pause(URLContext *h, int pause);
  98
  99 /**
 100  * Seek to a given timestamp relative to some component stream.
 101  * Only meaningful if using a network streaming protocol (e.g. MMS.).
 102  * @param stream_index The stream index that the timestamp is relative to.
 103  *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
 104  *        units from the beginning of the presentation.
 105  *        If a stream_index >= 0 is used and the protocol does not support
 106  *        seeking based on component streams, the call will fail with ENOTSUP.
 107  * @param timestamp timestamp in AVStream.time_base units
 108  *        or if there is no stream specified then in AV_TIME_BASE units.
 109  * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
 110  *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
 111  *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
 112  *        fail with ENOTSUP if used and not supported.
 113  * @return >= 0 on success
 114  * @see AVInputFormat::read_seek
 115  */
 116 offset_t av_url_read_seek(URLContext *h,
 117                      int stream_index, int64_t timestamp, int flags);
 118
 119 /**
 120  * Passing this as the "whence" parameter to a seek function causes it to
 121  * return the filesize without seeking anywhere. Supporting this is optional.
 122  * If it is not supported then the seek function will return <0.
 123  */
 124 #define AVSEEK_SIZE 0x10000
 125
 126 typedef struct URLProtocol {
 127     const char *name;
 128     int (*url_open)(URLContext *h, const char *filename, int flags);
 129     int (*url_read)(URLContext *h, unsigned char *buf, int size);
 130     int (*url_write)(URLContext *h, unsigned char *buf, int size);
 131     offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
 132     int (*url_close)(URLContext *h);
 133     struct URLProtocol *next;
 134     int (*url_read_pause)(URLContext *h, int pause);
 135     offset_t (*url_read_seek)(URLContext *h,
 136                          int stream_index, int64_t timestamp, int flags);
 137 } URLProtocol;
 138
 139 extern URLProtocol *first_protocol;
 140 extern URLInterruptCB *url_interrupt_cb;
 141
 142 URLProtocol *av_protocol_next(URLProtocol *p);
 143
 144 int register_protocol(URLProtocol *protocol);
 145
 146 /**
 147  * Bytestream IO Context.
 148  * New fields can be added to the end with minor version bumps.
 149  * Removal, reordering and changes to existing fields require a major
 150  * version bump.
 151  * sizeof(ByteIOContext) must not be used outside libav*.
 152  */
 153 typedef struct {
 154     unsigned char *buffer;
 155     int buffer_size;
 156     unsigned char *buf_ptr, *buf_end;
 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     offset_t (*seek)(void *opaque, offset_t offset, int whence);
 161     offset_t pos; /**< position in the file of the current buffer */
 162     int must_flush; /**< true if the next seek should flush */
 163     int eof_reached; /**< true if eof reached */
 164     int write_flag;  /**< true if open for writing */
 165     int is_streamed;
 166     int max_packet_size;
 167     unsigned long checksum;
 168     unsigned char *checksum_ptr;
 169     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
 170     int error;         ///< contains the error code or 0 if no error happened
 171     int (*read_pause)(void *opaque, int pause);
 172     offset_t (*read_seek)(void *opaque,
 173                      int stream_index, int64_t timestamp, int flags);
 174 } ByteIOContext;
 175
 176 int init_put_byte(ByteIOContext *s,
 177                   unsigned char *buffer,
 178                   int buffer_size,
 179                   int write_flag,
 180                   void *opaque,
 181                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
 182                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
 183                   offset_t (*seek)(void *opaque, offset_t offset, int whence));
 184
 185 void put_byte(ByteIOContext *s, int b);
 186 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
 187 void put_le64(ByteIOContext *s, uint64_t val);
 188 void put_be64(ByteIOContext *s, uint64_t val);
 189 void put_le32(ByteIOContext *s, unsigned int val);
 190 void put_be32(ByteIOContext *s, unsigned int val);
 191 void put_le24(ByteIOContext *s, unsigned int val);
 192 void put_be24(ByteIOContext *s, unsigned int val);
 193 void put_le16(ByteIOContext *s, unsigned int val);
 194 void put_be16(ByteIOContext *s, unsigned int val);
 195 void put_tag(ByteIOContext *s, const char *tag);
 196
 197 void put_strz(ByteIOContext *s, const char *buf);
 198
 199 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
 200 void url_fskip(ByteIOContext *s, offset_t offset);
 201 offset_t url_ftell(ByteIOContext *s);
 202 offset_t url_fsize(ByteIOContext *s);
 203 int url_feof(ByteIOContext *s);
 204 int url_ferror(ByteIOContext *s);
 205
 206 int av_url_read_fpause(ByteIOContext *h, int pause);
 207 offset_t av_url_read_fseek(ByteIOContext *h,
 208                       int stream_index, int64_t timestamp, int flags);
 209
 210 #define URL_EOF (-1)
 211 /** @note return URL_EOF (-1) if EOF */
 212 int url_fgetc(ByteIOContext *s);
 213
 214 /** @warning currently size is limited */
 215 #ifdef __GNUC__
 216 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
 217 #else
 218 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
 219 #endif
 220
 221 /** @note unlike fgets, the EOL character is not returned and a whole
 222    line is parsed. return NULL if first char read was EOF */
 223 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
 224
 225 void put_flush_packet(ByteIOContext *s);
 226
 227 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
 228 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
 229
 230 /** @note return 0 if EOF, so you cannot use it if EOF handling is
 231    necessary */
 232 int get_byte(ByteIOContext *s);
 233 unsigned int get_le24(ByteIOContext *s);
 234 unsigned int get_le32(ByteIOContext *s);
 235 uint64_t get_le64(ByteIOContext *s);
 236 unsigned int get_le16(ByteIOContext *s);
 237
 238 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
 239 unsigned int get_be16(ByteIOContext *s);
 240 unsigned int get_be24(ByteIOContext *s);
 241 unsigned int get_be32(ByteIOContext *s);
 242 uint64_t get_be64(ByteIOContext *s);
 243
 244 uint64_t ff_get_v(ByteIOContext *bc);
 245
 246 static inline int url_is_streamed(ByteIOContext *s)
 247 {
 248     return s->is_streamed;
 249 }
 250
 251 /** @note when opened as read/write, the buffers are only used for
 252    writing */
 253 int url_fdopen(ByteIOContext **s, URLContext *h);
 254
 255 /** @warning must be called before any I/O */
 256 int url_setbufsize(ByteIOContext *s, int buf_size);
 257 /** Reset the buffer for reading or writing.
 258  * @note Will drop any data currently in the buffer without transmitting it.
 259  * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
 260  *        to set up the buffer for writing. */
 261 int url_resetbuf(ByteIOContext *s, int flags);
 262
 263 /** @note when opened as read/write, the buffers are only used for
 264    writing */
 265 int url_fopen(ByteIOContext **s, const char *filename, int flags);
 266 int url_fclose(ByteIOContext *s);
 267 URLContext *url_fileno(ByteIOContext *s);
 268
 269 /**
 270  * Return the maximum packet size associated to packetized buffered file
 271  * handle. If the file is not packetized (stream like http or file on
 272  * disk), then 0 is returned.
 273  *
 274  * @param s buffered file handle
 275  * @return maximum packet size in bytes
 276  */
 277 int url_fget_max_packet_size(ByteIOContext *s);
 278
 279 int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
 280
 281 /** return the written or read size */
 282 int url_close_buf(ByteIOContext *s);
 283
 284 /**
 285  * Open a write only memory stream.
 286  *
 287  * @param s new IO context
 288  * @return zero if no error.
 289  */
 290 int url_open_dyn_buf(ByteIOContext **s);
 291
 292 /**
 293  * Open a write only packetized memory stream with a maximum packet
 294  * size of 'max_packet_size'.  The stream is stored in a memory buffer
 295  * with a big endian 4 byte header giving the packet size in bytes.
 296  *
 297  * @param s new IO context
 298  * @param max_packet_size maximum packet size (must be > 0)
 299  * @return zero if no error.
 300  */
 301 int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
 302
 303 /**
 304  * Return the written size and a pointer to the buffer. The buffer
 305  *  must be freed with av_free().
 306  * @param s IO context
 307  * @param pbuffer pointer to a byte buffer
 308  * @return the length of the byte buffer
 309  */
 310 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
 311
 312 unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, unsigned int len);
 313 unsigned long get_checksum(ByteIOContext *s);
 314 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
 315
 316 /* udp.c */
 317 int udp_set_remote_url(URLContext *h, const char *uri);
 318 int udp_get_local_port(URLContext *h);
 319 int udp_get_file_handle(URLContext *h);
 320
 321 #endif /* FFMPEG_AVIO_H */