avio.h 12.7 KB
Newer Older
1 2 3 4
/*
 * unbuffered io for ffmpeg system
 * copyright (c) 2001 Fabrice Bellard
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * 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 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
21 22
#ifndef AVFORMAT_AVIO_H
#define AVFORMAT_AVIO_H
23

24 25
#include <stdint.h>

Fabrice Bellard's avatar
Fabrice Bellard committed
26 27
/* unbuffered I/O */

28 29 30
/**
 * URL Context.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
31
 * Removal, reordering and changes to existing fields require a major
32
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
33
 * sizeof(URLContext) must not be used outside libav*.
34
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
35
struct URLContext {
36 37 38
#if LIBAVFORMAT_VERSION_MAJOR >= 53
    const AVClass *av_class; ///< information for av_log(). Set by url_open().
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
39
    struct URLProtocol *prot;
40
    int flags;
41 42
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
Fabrice Bellard's avatar
Fabrice Bellard committed
43
    void *priv_data;
44
    char *filename; /**< specified filename */
Fabrice Bellard's avatar
Fabrice Bellard committed
45 46 47 48 49 50 51 52 53 54 55 56
};

typedef struct URLContext URLContext;

typedef struct URLPollEntry {
    URLContext *handle;
    int events;
    int revents;
} URLPollEntry;

#define URL_RDONLY 0
#define URL_WRONLY 1
57 58
#define URL_RDWR   2

59 60
typedef int URLInterruptCB(void);

61 62
int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                       const char *filename, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
63 64 65
int url_open(URLContext **h, const char *filename, int flags);
int url_read(URLContext *h, unsigned char *buf, int size);
int url_write(URLContext *h, unsigned char *buf, int size);
66
int64_t url_seek(URLContext *h, int64_t pos, int whence);
Fabrice Bellard's avatar
Fabrice Bellard committed
67 68
int url_close(URLContext *h);
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
Diego Biurrun's avatar
Diego Biurrun committed
73
 * handle. If the file is not packetized (stream like HTTP or file on
74 75 76 77 78
 * disk), then 0 is returned.
 *
 * @param h file handle
 * @return maximum packet size in bytes
 */
79
int url_get_max_packet_size(URLContext *h);
80 81
void url_get_filename(URLContext *h, char *buf, int buf_size);

82
/**
Diego Biurrun's avatar
Diego Biurrun committed
83
 * The callback is called in blocking functions to test regulary if
84 85
 * asynchronous interruption is needed. AVERROR(EINTR) is returned
 * in this case by the interrupted function. 'NULL' means no interrupt
Diego Biurrun's avatar
Diego Biurrun committed
86
 * callback is given.
87
 */
88 89
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);

Fabrice Bellard's avatar
Fabrice Bellard committed
90 91 92
/* not implemented */
int url_poll(URLPollEntry *poll_table, int n, int timeout);

93 94 95 96 97 98
/**
 * Pause and resume playing - only meaningful if using a network streaming
 * protocol (e.g. MMS).
 * @param pause 1 for pause, 0 for resume
 */
int av_url_read_pause(URLContext *h, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
99

100 101
/**
 * Seek to a given timestamp relative to some component stream.
Diego Biurrun's avatar
Diego Biurrun committed
102
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
103 104 105 106 107
 * @param stream_index The stream index that the timestamp is relative to.
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
 *        units from the beginning of the presentation.
 *        If a stream_index >= 0 is used and the protocol does not support
 *        seeking based on component streams, the call will fail with ENOTSUP.
108
 * @param timestamp timestamp in AVStream.time_base units
109 110 111 112 113 114 115 116
 *        or if there is no stream specified then in AV_TIME_BASE units.
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
 *        fail with ENOTSUP if used and not supported.
 * @return >= 0 on success
 * @see AVInputFormat::read_seek
 */
117
int64_t av_url_read_seek(URLContext *h,
118 119
                     int stream_index, int64_t timestamp, int flags);

Michael Niedermayer's avatar
Michael Niedermayer committed
120
/**
Diego Biurrun's avatar
Diego Biurrun committed
121 122 123
 * Passing this as the "whence" parameter to a seek function causes it to
 * return the filesize without seeking anywhere. Supporting this is optional.
 * If it is not supported then the seek function will return <0.
Michael Niedermayer's avatar
Michael Niedermayer committed
124
 */
125 126
#define AVSEEK_SIZE 0x10000

Fabrice Bellard's avatar
Fabrice Bellard committed
127 128 129 130 131
typedef struct URLProtocol {
    const char *name;
    int (*url_open)(URLContext *h, const char *filename, int flags);
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
    int (*url_write)(URLContext *h, unsigned char *buf, int size);
132
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
Fabrice Bellard's avatar
Fabrice Bellard committed
133 134
    int (*url_close)(URLContext *h);
    struct URLProtocol *next;
135
    int (*url_read_pause)(URLContext *h, int pause);
136
    int64_t (*url_read_seek)(URLContext *h,
137
                         int stream_index, int64_t timestamp, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
138 139 140
} URLProtocol;

extern URLProtocol *first_protocol;
141
extern URLInterruptCB *url_interrupt_cb;
Fabrice Bellard's avatar
Fabrice Bellard committed
142

143 144
URLProtocol *av_protocol_next(URLProtocol *p);

Fabrice Bellard's avatar
Fabrice Bellard committed
145 146
int register_protocol(URLProtocol *protocol);

147 148 149
/**
 * Bytestream IO Context.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
150
 * Removal, reordering and changes to existing fields require a major
151
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
152
 * sizeof(ByteIOContext) must not be used outside libav*.
153
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
154 155 156 157 158
typedef struct {
    unsigned char *buffer;
    int buffer_size;
    unsigned char *buf_ptr, *buf_end;
    void *opaque;
159
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
160
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
161 162
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
    int64_t pos; /**< position in the file of the current buffer */
163 164 165
    int must_flush; /**< true if the next seek should flush */
    int eof_reached; /**< true if eof reached */
    int write_flag;  /**< true if open for writing */
Fabrice Bellard's avatar
Fabrice Bellard committed
166
    int is_streamed;
167
    int max_packet_size;
168 169 170
    unsigned long checksum;
    unsigned char *checksum_ptr;
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
171
    int error;         ///< contains the error code or 0 if no error happened
172
    int (*read_pause)(void *opaque, int pause);
173
    int64_t (*read_seek)(void *opaque,
174
                     int stream_index, int64_t timestamp, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
175 176 177 178 179 180 181
} ByteIOContext;

int init_put_byte(ByteIOContext *s,
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
182 183
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
184
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
185 186 187 188 189
ByteIOContext *av_alloc_put_byte(
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
190
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
191
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
192
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
Fabrice Bellard's avatar
Fabrice Bellard committed
193 194

void put_byte(ByteIOContext *s, int b);
195
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
196 197
void put_le64(ByteIOContext *s, uint64_t val);
void put_be64(ByteIOContext *s, uint64_t val);
Fabrice Bellard's avatar
Fabrice Bellard committed
198 199
void put_le32(ByteIOContext *s, unsigned int val);
void put_be32(ByteIOContext *s, unsigned int val);
200
void put_le24(ByteIOContext *s, unsigned int val);
201
void put_be24(ByteIOContext *s, unsigned int val);
Fabrice Bellard's avatar
Fabrice Bellard committed
202 203
void put_le16(ByteIOContext *s, unsigned int val);
void put_be16(ByteIOContext *s, unsigned int val);
204
void put_tag(ByteIOContext *s, const char *tag);
Fabrice Bellard's avatar
Fabrice Bellard committed
205

206
void put_strz(ByteIOContext *s, const char *buf);
207

208 209 210 211
/**
 * fseek() equivalent for ByteIOContext.
 * @return new position or AVERROR.
 */
212
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
213 214 215 216 217

/**
 * Skip given number of bytes forward.
 * @param offset number of bytes
 */
218
void url_fskip(ByteIOContext *s, int64_t offset);
219 220 221 222 223

/**
 * ftell() equivalent for ByteIOContext.
 * @return position or AVERROR.
 */
224
int64_t url_ftell(ByteIOContext *s);
225 226 227 228 229

/**
 * Gets the filesize.
 * @return filesize or AVERROR
 */
230
int64_t url_fsize(ByteIOContext *s);
231 232 233 234 235

/**
 * feof() equivalent for ByteIOContext.
 * @return non zero if and only if end of file
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
236
int url_feof(ByteIOContext *s);
237

238
int url_ferror(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
239

240
int av_url_read_fpause(ByteIOContext *h, int pause);
241
int64_t av_url_read_fseek(ByteIOContext *h,
242 243
                      int stream_index, int64_t timestamp, int flags);

244
#define URL_EOF (-1)
245
/** @note return URL_EOF (-1) if EOF */
246
int url_fgetc(ByteIOContext *s);
247

248
/** @warning currently size is limited */
249
#ifdef __GNUC__
250
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
251 252 253
#else
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
#endif
254

255
/** @note unlike fgets, the EOL character is not returned and a whole
256
   line is parsed. return NULL if first char read was EOF */
257 258
char *url_fgets(ByteIOContext *s, char *buf, int buf_size);

Fabrice Bellard's avatar
Fabrice Bellard committed
259 260
void put_flush_packet(ByteIOContext *s);

261 262 263 264 265

/**
 * Reads size bytes from ByteIOContext into buf.
 * @returns number of bytes read or AVERROR
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
266
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
267 268 269

/**
 * Reads size bytes from ByteIOContext into buf.
Diego Biurrun's avatar
Diego Biurrun committed
270
 * This reads at most 1 packet. If that is not enough fewer bytes will be
271 272 273
 * returned.
 * @returns number of bytes read or AVERROR
 */
274
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
275

276
/** @note return 0 if EOF, so you cannot use it if EOF handling is
277
   necessary */
Fabrice Bellard's avatar
Fabrice Bellard committed
278
int get_byte(ByteIOContext *s);
279
unsigned int get_le24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
280
unsigned int get_le32(ByteIOContext *s);
281
uint64_t get_le64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
282 283
unsigned int get_le16(ByteIOContext *s);

284
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
Fabrice Bellard's avatar
Fabrice Bellard committed
285
unsigned int get_be16(ByteIOContext *s);
286
unsigned int get_be24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
287
unsigned int get_be32(ByteIOContext *s);
288
uint64_t get_be64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
289

290
uint64_t ff_get_v(ByteIOContext *bc);
291

292
static inline int url_is_streamed(ByteIOContext *s)
Fabrice Bellard's avatar
Fabrice Bellard committed
293 294 295 296
{
    return s->is_streamed;
}

297 298
/** @note when opened as read/write, the buffers are only used for
   writing */
299
int url_fdopen(ByteIOContext **s, URLContext *h);
300

301
/** @warning must be called before any I/O */
Fabrice Bellard's avatar
Fabrice Bellard committed
302
int url_setbufsize(ByteIOContext *s, int buf_size);
303 304 305 306 307
/** Reset the buffer for reading or writing.
 * @note Will drop any data currently in the buffer without transmitting it.
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
 *        to set up the buffer for writing. */
int url_resetbuf(ByteIOContext *s, int flags);
308

309
/** @note when opened as read/write, the buffers are only used for
310
   writing */
311
int url_fopen(ByteIOContext **s, const char *filename, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
312 313
int url_fclose(ByteIOContext *s);
URLContext *url_fileno(ByteIOContext *s);
314

315
/**
316 317 318 319
 * Return the maximum packet size associated to packetized buffered file
 * handle. If the file is not packetized (stream like http or file on
 * disk), then 0 is returned.
 *
320
 * @param s buffered file handle
321 322
 * @return maximum packet size in bytes
 */
323
int url_fget_max_packet_size(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
324

325
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
326

327
/** return the written or read size */
Fabrice Bellard's avatar
Fabrice Bellard committed
328 329
int url_close_buf(ByteIOContext *s);

330
/**
331 332 333 334 335
 * Open a write only memory stream.
 *
 * @param s new IO context
 * @return zero if no error.
 */
336
int url_open_dyn_buf(ByteIOContext **s);
337

338
/**
339 340 341 342 343 344 345 346
 * Open a write only packetized memory stream with a maximum packet
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
 * with a big endian 4 byte header giving the packet size in bytes.
 *
 * @param s new IO context
 * @param max_packet_size maximum packet size (must be > 0)
 * @return zero if no error.
 */
347
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
348

349
/**
350 351 352
 * Return the written size and a pointer to the buffer. The buffer
 *  must be freed with av_free().
 * @param s IO context
353
 * @param pbuffer pointer to a byte buffer
354 355
 * @return the length of the byte buffer
 */
356
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
357

358
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, unsigned int len);
359 360 361
unsigned long get_checksum(ByteIOContext *s);
void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);

Fabrice Bellard's avatar
Fabrice Bellard committed
362
/* udp.c */
363 364 365 366
int udp_set_remote_url(URLContext *h, const char *uri);
int udp_get_local_port(URLContext *h);
int udp_get_file_handle(URLContext *h);

367
#endif /* AVFORMAT_AVIO_H */