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