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