avio.h 13.2 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>

26 27
#include "libavutil/common.h"

Fabrice Bellard's avatar
Fabrice Bellard committed
28 29
/* unbuffered I/O */

30 31 32
/**
 * URL Context.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
33
 * Removal, reordering and changes to existing fields require a major
34
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
35
 * sizeof(URLContext) must not be used outside libav*.
36
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
37
struct URLContext {
38 39 40
#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
41
    struct URLProtocol *prot;
42
    int flags;
43 44
    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
45
    void *priv_data;
46
    char *filename; /**< specified filename */
Fabrice Bellard's avatar
Fabrice Bellard committed
47 48 49 50 51 52 53 54 55 56 57 58
};

typedef struct URLContext URLContext;

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

#define URL_RDONLY 0
#define URL_WRONLY 1
59 60
#define URL_RDWR   2

61 62
typedef int URLInterruptCB(void);

63 64
int url_open_protocol (URLContext **puc, struct URLProtocol *up,
                       const char *filename, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
65 66 67
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);
68
int64_t url_seek(URLContext *h, int64_t pos, int whence);
Fabrice Bellard's avatar
Fabrice Bellard committed
69 70
int url_close(URLContext *h);
int url_exist(const char *filename);
71
int64_t url_filesize(URLContext *h);
72

73
/**
74
 * Return the maximum packet size associated to packetized file
Diego Biurrun's avatar
Diego Biurrun committed
75
 * handle. If the file is not packetized (stream like HTTP or file on
76 77 78 79 80
 * disk), then 0 is returned.
 *
 * @param h file handle
 * @return maximum packet size in bytes
 */
81
int url_get_max_packet_size(URLContext *h);
82 83
void url_get_filename(URLContext *h, char *buf, int buf_size);

84
/**
Diego Biurrun's avatar
Diego Biurrun committed
85
 * The callback is called in blocking functions to test regulary if
86 87
 * 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
88
 * callback is given.
89
 */
90 91
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);

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

95 96 97 98 99 100
/**
 * 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
101

102 103
/**
 * Seek to a given timestamp relative to some component stream.
Diego Biurrun's avatar
Diego Biurrun committed
104
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
105 106 107 108 109
 * @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.
110
 * @param timestamp timestamp in AVStream.time_base units
111 112 113 114 115 116 117 118
 *        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
 */
Diego Biurrun's avatar
Diego Biurrun committed
119 120
int64_t av_url_read_seek(URLContext *h, int stream_index,
                         int64_t timestamp, int flags);
121

Michael Niedermayer's avatar
Michael Niedermayer committed
122
/**
Diego Biurrun's avatar
Diego Biurrun committed
123 124 125
 * 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
126
 */
127 128
#define AVSEEK_SIZE 0x10000

Fabrice Bellard's avatar
Fabrice Bellard committed
129 130 131 132 133
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);
134
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
Fabrice Bellard's avatar
Fabrice Bellard committed
135 136
    int (*url_close)(URLContext *h);
    struct URLProtocol *next;
137
    int (*url_read_pause)(URLContext *h, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
138 139
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
                             int64_t timestamp, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
140 141
} URLProtocol;

142
#if LIBAVFORMAT_VERSION_MAJOR < 53
Fabrice Bellard's avatar
Fabrice Bellard committed
143
extern URLProtocol *first_protocol;
144 145
#endif

146
extern URLInterruptCB *url_interrupt_cb;
Fabrice Bellard's avatar
Fabrice Bellard committed
147

148 149
/**
 * If protocol is NULL, returns the first registered protocol,
150
 * if protocol is non-NULL, returns the next registered protocol after protocol,
151 152
 * or NULL if protocol is the last one.
 */
153 154
URLProtocol *av_protocol_next(URLProtocol *p);

155 156 157 158 159 160 161 162
#if LIBAVFORMAT_VERSION_MAJOR < 53
/**
 * @deprecated Use av_register_protocol() instead.
 */
attribute_deprecated int register_protocol(URLProtocol *protocol);
#endif

int av_register_protocol(URLProtocol *protocol);
Fabrice Bellard's avatar
Fabrice Bellard committed
163

164 165 166
/**
 * Bytestream IO Context.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
167
 * Removal, reordering and changes to existing fields require a major
168
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
169
 * sizeof(ByteIOContext) must not be used outside libav*.
170
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
171 172 173 174 175
typedef struct {
    unsigned char *buffer;
    int buffer_size;
    unsigned char *buf_ptr, *buf_end;
    void *opaque;
176
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
177
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
178 179
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
    int64_t pos; /**< position in the file of the current buffer */
180 181 182
    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
183
    int is_streamed;
184
    int max_packet_size;
185 186 187
    unsigned long checksum;
    unsigned char *checksum_ptr;
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
188
    int error;         ///< contains the error code or 0 if no error happened
189
    int (*read_pause)(void *opaque, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
190 191
    int64_t (*read_seek)(void *opaque, int stream_index,
                         int64_t timestamp, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
192 193 194 195 196 197 198
} ByteIOContext;

int init_put_byte(ByteIOContext *s,
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
199 200
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
201
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
202 203 204 205 206
ByteIOContext *av_alloc_put_byte(
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
207
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
208
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
209
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
Fabrice Bellard's avatar
Fabrice Bellard committed
210 211

void put_byte(ByteIOContext *s, int b);
212
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
213 214
void put_le64(ByteIOContext *s, uint64_t val);
void put_be64(ByteIOContext *s, uint64_t val);
Fabrice Bellard's avatar
Fabrice Bellard committed
215 216
void put_le32(ByteIOContext *s, unsigned int val);
void put_be32(ByteIOContext *s, unsigned int val);
217
void put_le24(ByteIOContext *s, unsigned int val);
218
void put_be24(ByteIOContext *s, unsigned int val);
Fabrice Bellard's avatar
Fabrice Bellard committed
219 220
void put_le16(ByteIOContext *s, unsigned int val);
void put_be16(ByteIOContext *s, unsigned int val);
221
void put_tag(ByteIOContext *s, const char *tag);
Fabrice Bellard's avatar
Fabrice Bellard committed
222

223
void put_strz(ByteIOContext *s, const char *buf);
224

225 226 227 228
/**
 * fseek() equivalent for ByteIOContext.
 * @return new position or AVERROR.
 */
229
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
230 231 232 233 234

/**
 * Skip given number of bytes forward.
 * @param offset number of bytes
 */
235
void url_fskip(ByteIOContext *s, int64_t offset);
236 237 238 239 240

/**
 * ftell() equivalent for ByteIOContext.
 * @return position or AVERROR.
 */
241
int64_t url_ftell(ByteIOContext *s);
242 243 244 245 246

/**
 * Gets the filesize.
 * @return filesize or AVERROR
 */
247
int64_t url_fsize(ByteIOContext *s);
248 249 250 251 252

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

255
int url_ferror(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
256

257
int av_url_read_fpause(ByteIOContext *h, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
258 259
int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
                          int64_t timestamp, int flags);
260

261
#define URL_EOF (-1)
262
/** @note return URL_EOF (-1) if EOF */
263
int url_fgetc(ByteIOContext *s);
264

265
/** @warning currently size is limited */
266
#ifdef __GNUC__
267
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
268 269 270
#else
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
#endif
271

272
/** @note unlike fgets, the EOL character is not returned and a whole
Diego Biurrun's avatar
Diego Biurrun committed
273
    line is parsed. return NULL if first char read was EOF */
274 275
char *url_fgets(ByteIOContext *s, char *buf, int buf_size);

Fabrice Bellard's avatar
Fabrice Bellard committed
276 277
void put_flush_packet(ByteIOContext *s);

278 279 280 281 282

/**
 * Reads size bytes from ByteIOContext into buf.
 * @returns number of bytes read or AVERROR
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
283
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
284 285 286

/**
 * Reads size bytes from ByteIOContext into buf.
Diego Biurrun's avatar
Diego Biurrun committed
287
 * This reads at most 1 packet. If that is not enough fewer bytes will be
288 289 290
 * returned.
 * @returns number of bytes read or AVERROR
 */
291
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
292

293
/** @note return 0 if EOF, so you cannot use it if EOF handling is
Diego Biurrun's avatar
Diego Biurrun committed
294
    necessary */
Fabrice Bellard's avatar
Fabrice Bellard committed
295
int get_byte(ByteIOContext *s);
296
unsigned int get_le24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
297
unsigned int get_le32(ByteIOContext *s);
298
uint64_t get_le64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
299 300
unsigned int get_le16(ByteIOContext *s);

301
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
Fabrice Bellard's avatar
Fabrice Bellard committed
302
unsigned int get_be16(ByteIOContext *s);
303
unsigned int get_be24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
304
unsigned int get_be32(ByteIOContext *s);
305
uint64_t get_be64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
306

307
uint64_t ff_get_v(ByteIOContext *bc);
308

309
static inline int url_is_streamed(ByteIOContext *s)
Fabrice Bellard's avatar
Fabrice Bellard committed
310 311 312 313
{
    return s->is_streamed;
}

314
/** @note when opened as read/write, the buffers are only used for
Diego Biurrun's avatar
Diego Biurrun committed
315
    writing */
316
int url_fdopen(ByteIOContext **s, URLContext *h);
317

318
/** @warning must be called before any I/O */
Fabrice Bellard's avatar
Fabrice Bellard committed
319
int url_setbufsize(ByteIOContext *s, int buf_size);
320 321 322 323 324
/** 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);
325

326
/** @note when opened as read/write, the buffers are only used for
Diego Biurrun's avatar
Diego Biurrun committed
327
    writing */
328
int url_fopen(ByteIOContext **s, const char *filename, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
329 330
int url_fclose(ByteIOContext *s);
URLContext *url_fileno(ByteIOContext *s);
331

332
/**
333 334 335 336
 * 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.
 *
337
 * @param s buffered file handle
338 339
 * @return maximum packet size in bytes
 */
340
int url_fget_max_packet_size(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
341

342
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
343

344
/** return the written or read size */
Fabrice Bellard's avatar
Fabrice Bellard committed
345 346
int url_close_buf(ByteIOContext *s);

347
/**
348 349 350 351 352
 * Open a write only memory stream.
 *
 * @param s new IO context
 * @return zero if no error.
 */
353
int url_open_dyn_buf(ByteIOContext **s);
354

355
/**
356 357 358 359 360 361 362 363
 * 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.
 */
364
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
365

366
/**
367 368 369
 * Return the written size and a pointer to the buffer. The buffer
 *  must be freed with av_free().
 * @param s IO context
370
 * @param pbuffer pointer to a byte buffer
371 372
 * @return the length of the byte buffer
 */
373
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
374

Diego Biurrun's avatar
Diego Biurrun committed
375 376
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
                                    unsigned int len);
377
unsigned long get_checksum(ByteIOContext *s);
Diego Biurrun's avatar
Diego Biurrun committed
378 379 380
void init_checksum(ByteIOContext *s,
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
                   unsigned long checksum);
381

Fabrice Bellard's avatar
Fabrice Bellard committed
382
/* udp.c */
383 384 385 386
int udp_set_remote_url(URLContext *h, const char *uri);
int udp_get_local_port(URLContext *h);
int udp_get_file_handle(URLContext *h);

387
#endif /* AVFORMAT_AVIO_H */