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 AVIO_H
  22 #define AVIO_H
  23
  24 /* output byte stream handling */
  25
  26 typedef int64_t offset_t;
  27
  28 /* unbuffered I/O */
  29
  30 struct URLContext {
  31     struct URLProtocol *prot;
  32     int flags;
  33     int is_streamed;  /* true if streamed (no seek possible), default = false */
  34     int max_packet_size;  /* if non zero, the stream is packetized with this max packet size */
  35     void *priv_data;
  36     char filename[1]; /* specified filename */
  37 };
  38
  39 typedef struct URLContext URLContext;
  40
  41 typedef struct URLPollEntry {
  42     URLContext *handle;
  43     int events;
  44     int revents;
  45 } URLPollEntry;
  46
  47 #define URL_RDONLY 0
  48 #define URL_WRONLY 1
  49 #define URL_RDWR   2
  50
  51 typedef int URLInterruptCB(void);
  52
  53 int url_open(URLContext **h, const char *filename, int flags);
  54 int url_read(URLContext *h, unsigned char *buf, int size);
  55 int url_write(URLContext *h, unsigned char *buf, int size);
  56 offset_t url_seek(URLContext *h, offset_t pos, int whence);
  57 int url_close(URLContext *h);
  58 int url_exist(const char *filename);
  59 offset_t url_filesize(URLContext *h);
  60 int url_get_max_packet_size(URLContext *h);
  61 void url_get_filename(URLContext *h, char *buf, int buf_size);
  62
  63 /* the callback is called in blocking functions to test regulary if
  64    asynchronous interruption is needed. -EINTR is returned in this
  65    case by the interrupted function. 'NULL' means no interrupt
  66    callback is given. */
  67 void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
  68
  69 /* not implemented */
  70 int url_poll(URLPollEntry *poll_table, int n, int timeout);
  71
  72 /**
  73  * passing this as the "whence" parameter to a seek function causes it to
  74  * return the filesize without seeking anywhere, supporting this is optional
  75  * if its not supprted then the seek function will return <0
  76  */
  77 #define AVSEEK_SIZE 0x10000
  78
  79 typedef struct URLProtocol {
  80     const char *name;
  81     int (*url_open)(URLContext *h, const char *filename, int flags);
  82     int (*url_read)(URLContext *h, unsigned char *buf, int size);
  83     int (*url_write)(URLContext *h, unsigned char *buf, int size);
  84     offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
  85     int (*url_close)(URLContext *h);
  86     struct URLProtocol *next;
  87 } URLProtocol;
  88
  89 extern URLProtocol *first_protocol;
  90 extern URLInterruptCB *url_interrupt_cb;
  91
  92 int register_protocol(URLProtocol *protocol);
  93
  94 typedef struct {
  95     unsigned char *buffer;
  96     int buffer_size;
  97     unsigned char *buf_ptr, *buf_end;
  98     void *opaque;
  99     int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
 100     int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
 101     offset_t (*seek)(void *opaque, offset_t offset, int whence);
 102     offset_t pos; /* position in the file of the current buffer */
 103     int must_flush; /* true if the next seek should flush */
 104     int eof_reached; /* true if eof reached */
 105     int write_flag;  /* true if open for writing */
 106     int is_streamed;
 107     int max_packet_size;
 108     unsigned long checksum;
 109     unsigned char *checksum_ptr;
 110     unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
 111     int error;         ///< contains the error code or 0 if no error happened
 112 } ByteIOContext;
 113
 114 int init_put_byte(ByteIOContext *s,
 115                   unsigned char *buffer,
 116                   int buffer_size,
 117                   int write_flag,
 118                   void *opaque,
 119                   int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
 120                   int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
 121                   offset_t (*seek)(void *opaque, offset_t offset, int whence));
 122
 123 void put_byte(ByteIOContext *s, int b);
 124 void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
 125 void put_le64(ByteIOContext *s, uint64_t val);
 126 void put_be64(ByteIOContext *s, uint64_t val);
 127 void put_le32(ByteIOContext *s, unsigned int val);
 128 void put_be32(ByteIOContext *s, unsigned int val);
 129 void put_le24(ByteIOContext *s, unsigned int val);
 130 void put_be24(ByteIOContext *s, unsigned int val);
 131 void put_le16(ByteIOContext *s, unsigned int val);
 132 void put_be16(ByteIOContext *s, unsigned int val);
 133 void put_tag(ByteIOContext *s, const char *tag);
 134
 135 void put_strz(ByteIOContext *s, const char *buf);
 136
 137 offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
 138 void url_fskip(ByteIOContext *s, offset_t offset);
 139 offset_t url_ftell(ByteIOContext *s);
 140 offset_t url_fsize(ByteIOContext *s);
 141 int url_feof(ByteIOContext *s);
 142 int url_ferror(ByteIOContext *s);
 143
 144 #define URL_EOF (-1)
 145 int url_fgetc(ByteIOContext *s);
 146 #ifdef __GNUC__
 147 int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
 148 #else
 149 int url_fprintf(ByteIOContext *s, const char *fmt, ...);
 150 #endif
 151 char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
 152
 153 void put_flush_packet(ByteIOContext *s);
 154
 155 int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
 156 int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
 157 int get_byte(ByteIOContext *s);
 158 unsigned int get_le24(ByteIOContext *s);
 159 unsigned int get_le32(ByteIOContext *s);
 160 uint64_t get_le64(ByteIOContext *s);
 161 unsigned int get_le16(ByteIOContext *s);
 162
 163 char *get_strz(ByteIOContext *s, char *buf, int maxlen);
 164 unsigned int get_be16(ByteIOContext *s);
 165 unsigned int get_be24(ByteIOContext *s);
 166 unsigned int get_be32(ByteIOContext *s);
 167 uint64_t get_be64(ByteIOContext *s);
 168
 169 static inline int url_is_streamed(ByteIOContext *s)
 170 {
 171     return s->is_streamed;
 172 }
 173
 174 int url_fdopen(ByteIOContext *s, URLContext *h);
 175 int url_setbufsize(ByteIOContext *s, int buf_size);
 176 int url_fopen(ByteIOContext *s, const char *filename, int flags);
 177 int url_fclose(ByteIOContext *s);
 178 URLContext *url_fileno(ByteIOContext *s);
 179 int url_fget_max_packet_size(ByteIOContext *s);
 180
 181 int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
 182 int url_close_buf(ByteIOContext *s);
 183
 184 int url_open_dyn_buf(ByteIOContext *s);
 185 int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
 186 int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
 187
 188 unsigned long get_checksum(ByteIOContext *s);
 189 void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
 190
 191 /* file.c */
 192 extern URLProtocol file_protocol;
 193 extern URLProtocol pipe_protocol;
 194
 195 /* udp.c */
 196 extern URLProtocol udp_protocol;
 197 int udp_set_remote_url(URLContext *h, const char *uri);
 198 int udp_get_local_port(URLContext *h);
 199 int udp_get_file_handle(URLContext *h);
 200
 201 /* tcp.c  */
 202 extern URLProtocol tcp_protocol;
 203
 204 /* http.c */
 205 extern URLProtocol http_protocol;
 206
 207 #endif
 208