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