avio.h 15.5 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12 13 14 15 16
 * 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
17
 * License along with FFmpeg; if not, write to the Free Software
18 19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
20 21
#ifndef AVFORMAT_AVIO_H
#define AVFORMAT_AVIO_H
22

23 24 25
/**
 * @file libavformat/avio.h
 * unbuffered I/O operations
26 27 28
 *
 * @warning This file has to be considered an internal but installed
 * header, so it should not be directly included in your projects.
29 30
 */

31 32
#include <stdint.h>

33 34
#include "libavutil/common.h"

Fabrice Bellard's avatar
Fabrice Bellard committed
35 36
/* unbuffered I/O */

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

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

#define URL_RDONLY 0
#define URL_WRONLY 1
64 65
#define URL_RDWR   2

66 67
typedef int URLInterruptCB(void);

68 69
/**
 * Creates an URLContext for accessing to the resource indicated by
70
 * url, and opens it using the URLProtocol up.
71 72 73
 *
 * @param puc pointer to the location where, in case of success, the
 * function puts the pointer to the created URLContext
74
 * @param flags flags which control how the resource indicated by url
75 76 77 78
 * is to be opened
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR code in case of failure
 */
79
int url_open_protocol (URLContext **puc, struct URLProtocol *up,
80
                       const char *url, int flags);
81

Stefano Sabatini's avatar
Stefano Sabatini committed
82 83 84 85 86 87 88 89 90 91 92
/**
 * Creates an URLContext for accessing to the resource indicated by
 * url, and opens it.
 *
 * @param puc pointer to the location where, in case of success, the
 * function puts the pointer to the created URLContext
 * @param flags flags which control how the resource indicated by url
 * is to be opened
 * @return 0 in case of success, a negative value corresponding to an
 * AVERROR code in case of failure
 */
93
int url_open(URLContext **h, const char *url, int flags);
Stefano Sabatini's avatar
Stefano Sabatini committed
94 95 96 97 98 99 100 101 102 103

/**
 * Reads up to size bytes from the resource accessed by h, and stores
 * the read bytes in buf.
 *
 * @return The number of bytes actually read, or a negative value
 * corresponding to an AVERROR code in case of error. A value of zero
 * indicates that it is not possible to read more from the accessed
 * resource (except if the value of the size argument is also zero).
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
104
int url_read(URLContext *h, unsigned char *buf, int size);
Stefano Sabatini's avatar
Stefano Sabatini committed
105

106 107 108 109 110 111 112 113
/**
 * Read as many bytes as possible (up to size), calling the
 * read function multiple times if necessary.
 * Will also retry if the read function returns AVERROR(EAGAIN).
 * This makes special short-read handling in applications
 * unnecessary, if the return value is < size then it is
 * certain there was either an error or the end of file was reached.
 */
114
int url_read_complete(URLContext *h, unsigned char *buf, int size);
Fabrice Bellard's avatar
Fabrice Bellard committed
115
int url_write(URLContext *h, unsigned char *buf, int size);
116
int64_t url_seek(URLContext *h, int64_t pos, int whence);
Stefano Sabatini's avatar
Stefano Sabatini committed
117 118 119 120 121 122 123 124

/**
 * Closes the resource accessed by the URLContext h, and frees the
 * memory used by it.
 *
 * @return a negative value if an error condition occurred, 0
 * otherwise
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
125
int url_close(URLContext *h);
Stefano Sabatini's avatar
Stefano Sabatini committed
126

127
int url_exist(const char *url);
128
int64_t url_filesize(URLContext *h);
129

130 131 132 133 134 135 136 137 138
/**
 * Return the file descriptor associated with this URL. For RTP, this
 * will return only the RTP file descriptor, not the RTCP file descriptor.
 * To get both, use rtp_get_file_handles().
 *
 * @return the file descriptor associated with this URL, or <0 on error.
 */
int url_get_file_handle(URLContext *h);

139
/**
140
 * Return the maximum packet size associated to packetized file
Diego Biurrun's avatar
Diego Biurrun committed
141
 * handle. If the file is not packetized (stream like HTTP or file on
142 143 144 145 146
 * disk), then 0 is returned.
 *
 * @param h file handle
 * @return maximum packet size in bytes
 */
147
int url_get_max_packet_size(URLContext *h);
Fabrice Bellard's avatar
Fabrice Bellard committed
148 149
void url_get_filename(URLContext *h, char *buf, int buf_size);

150
/**
Diego Biurrun's avatar
Diego Biurrun committed
151
 * The callback is called in blocking functions to test regulary if
152 153
 * 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
154
 * callback is given.
155
 */
156 157
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);

Fabrice Bellard's avatar
Fabrice Bellard committed
158 159 160
/* not implemented */
int url_poll(URLPollEntry *poll_table, int n, int timeout);

161 162 163 164 165 166
/**
 * 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
167

168 169
/**
 * Seek to a given timestamp relative to some component stream.
Diego Biurrun's avatar
Diego Biurrun committed
170
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
171 172 173 174 175
 * @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.
176
 * @param timestamp timestamp in AVStream.time_base units
177 178 179 180 181 182 183 184
 *        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
185 186
int64_t av_url_read_seek(URLContext *h, int stream_index,
                         int64_t timestamp, int flags);
187

Michael Niedermayer's avatar
Michael Niedermayer committed
188
/**
Diego Biurrun's avatar
Diego Biurrun committed
189 190 191
 * 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
192
 */
193 194
#define AVSEEK_SIZE 0x10000

Fabrice Bellard's avatar
Fabrice Bellard committed
195 196
typedef struct URLProtocol {
    const char *name;
197
    int (*url_open)(URLContext *h, const char *url, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
198 199
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
    int (*url_write)(URLContext *h, unsigned char *buf, int size);
200
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
Fabrice Bellard's avatar
Fabrice Bellard committed
201 202
    int (*url_close)(URLContext *h);
    struct URLProtocol *next;
203
    int (*url_read_pause)(URLContext *h, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
204 205
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
                             int64_t timestamp, int flags);
206
    int (*url_get_file_handle)(URLContext *h);
Fabrice Bellard's avatar
Fabrice Bellard committed
207 208
} URLProtocol;

209
#if LIBAVFORMAT_VERSION_MAJOR < 53
Fabrice Bellard's avatar
Fabrice Bellard committed
210
extern URLProtocol *first_protocol;
211 212
#endif

213
extern URLInterruptCB *url_interrupt_cb;
Fabrice Bellard's avatar
Fabrice Bellard committed
214

215 216
/**
 * If protocol is NULL, returns the first registered protocol,
217
 * if protocol is non-NULL, returns the next registered protocol after protocol,
218 219
 * or NULL if protocol is the last one.
 */
220 221
URLProtocol *av_protocol_next(URLProtocol *p);

222 223 224 225 226 227 228 229
#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
230

231 232 233
/**
 * Bytestream IO Context.
 * New fields can be added to the end with minor version bumps.
Diego Biurrun's avatar
Diego Biurrun committed
234
 * Removal, reordering and changes to existing fields require a major
235
 * version bump.
Diego Biurrun's avatar
Diego Biurrun committed
236
 * sizeof(ByteIOContext) must not be used outside libav*.
237
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
238 239 240 241 242
typedef struct {
    unsigned char *buffer;
    int buffer_size;
    unsigned char *buf_ptr, *buf_end;
    void *opaque;
243
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
Michael Niedermayer's avatar
Michael Niedermayer committed
244
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
245 246
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
    int64_t pos; /**< position in the file of the current buffer */
247 248 249
    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
250
    int is_streamed;
251
    int max_packet_size;
252 253 254
    unsigned long checksum;
    unsigned char *checksum_ptr;
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
Michael Niedermayer's avatar
Michael Niedermayer committed
255
    int error;         ///< contains the error code or 0 if no error happened
256
    int (*read_pause)(void *opaque, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
257 258
    int64_t (*read_seek)(void *opaque, int stream_index,
                         int64_t timestamp, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
259 260 261 262 263 264 265
} ByteIOContext;

int init_put_byte(ByteIOContext *s,
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
266 267
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
268
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
269 270 271 272 273
ByteIOContext *av_alloc_put_byte(
                  unsigned char *buffer,
                  int buffer_size,
                  int write_flag,
                  void *opaque,
274
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
Michael Niedermayer's avatar
Michael Niedermayer committed
275
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
276
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
Fabrice Bellard's avatar
Fabrice Bellard committed
277 278

void put_byte(ByteIOContext *s, int b);
279
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
280 281
void put_le64(ByteIOContext *s, uint64_t val);
void put_be64(ByteIOContext *s, uint64_t val);
Fabrice Bellard's avatar
Fabrice Bellard committed
282 283
void put_le32(ByteIOContext *s, unsigned int val);
void put_be32(ByteIOContext *s, unsigned int val);
Aurelien Jacobs's avatar
Aurelien Jacobs committed
284
void put_le24(ByteIOContext *s, unsigned int val);
285
void put_be24(ByteIOContext *s, unsigned int val);
Fabrice Bellard's avatar
Fabrice Bellard committed
286 287
void put_le16(ByteIOContext *s, unsigned int val);
void put_be16(ByteIOContext *s, unsigned int val);
Zdenek Kabelac's avatar
Zdenek Kabelac committed
288
void put_tag(ByteIOContext *s, const char *tag);
Fabrice Bellard's avatar
Fabrice Bellard committed
289

290
void put_strz(ByteIOContext *s, const char *buf);
291

292 293 294 295
/**
 * fseek() equivalent for ByteIOContext.
 * @return new position or AVERROR.
 */
296
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
297 298 299 300 301

/**
 * Skip given number of bytes forward.
 * @param offset number of bytes
 */
302
void url_fskip(ByteIOContext *s, int64_t offset);
303 304 305 306 307

/**
 * ftell() equivalent for ByteIOContext.
 * @return position or AVERROR.
 */
308
int64_t url_ftell(ByteIOContext *s);
309 310 311 312 313

/**
 * Gets the filesize.
 * @return filesize or AVERROR
 */
314
int64_t url_fsize(ByteIOContext *s);
315 316 317 318 319

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

Michael Niedermayer's avatar
Michael Niedermayer committed
322
int url_ferror(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
323

324
int av_url_read_fpause(ByteIOContext *h, int pause);
Diego Biurrun's avatar
Diego Biurrun committed
325 326
int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
                          int64_t timestamp, int flags);
327

328
#define URL_EOF (-1)
329
/** @note return URL_EOF (-1) if EOF */
330
int url_fgetc(ByteIOContext *s);
331

332
/** @warning currently size is limited */
333
#ifdef __GNUC__
334
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
335 336 337
#else
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
#endif
338

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

Fabrice Bellard's avatar
Fabrice Bellard committed
343 344
void put_flush_packet(ByteIOContext *s);

Michael Niedermayer's avatar
Michael Niedermayer committed
345 346 347 348 349

/**
 * Reads size bytes from ByteIOContext into buf.
 * @returns number of bytes read or AVERROR
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
350
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
Michael Niedermayer's avatar
Michael Niedermayer committed
351 352 353

/**
 * Reads size bytes from ByteIOContext into buf.
Diego Biurrun's avatar
Diego Biurrun committed
354
 * This reads at most 1 packet. If that is not enough fewer bytes will be
Michael Niedermayer's avatar
Michael Niedermayer committed
355 356 357
 * returned.
 * @returns number of bytes read or AVERROR
 */
358
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
359

360
/** @note return 0 if EOF, so you cannot use it if EOF handling is
Diego Biurrun's avatar
Diego Biurrun committed
361
    necessary */
Fabrice Bellard's avatar
Fabrice Bellard committed
362
int get_byte(ByteIOContext *s);
Aurelien Jacobs's avatar
Aurelien Jacobs committed
363
unsigned int get_le24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
364
unsigned int get_le32(ByteIOContext *s);
365
uint64_t get_le64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
366 367
unsigned int get_le16(ByteIOContext *s);

368
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
Fabrice Bellard's avatar
Fabrice Bellard committed
369
unsigned int get_be16(ByteIOContext *s);
370
unsigned int get_be24(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
371
unsigned int get_be32(ByteIOContext *s);
372
uint64_t get_be64(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
373

Kostya Shishkov's avatar
Kostya Shishkov committed
374
uint64_t ff_get_v(ByteIOContext *bc);
375

376
static inline int url_is_streamed(ByteIOContext *s)
Fabrice Bellard's avatar
Fabrice Bellard committed
377 378 379 380
{
    return s->is_streamed;
}

381
/** @note when opened as read/write, the buffers are only used for
Diego Biurrun's avatar
Diego Biurrun committed
382
    writing */
383
int url_fdopen(ByteIOContext **s, URLContext *h);
384

385
/** @warning must be called before any I/O */
Fabrice Bellard's avatar
Fabrice Bellard committed
386
int url_setbufsize(ByteIOContext *s, int buf_size);
387
#if LIBAVFORMAT_VERSION_MAJOR < 53
388 389 390 391 392
/** 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);
393
#endif
394

395
/** @note when opened as read/write, the buffers are only used for
Diego Biurrun's avatar
Diego Biurrun committed
396
    writing */
397
int url_fopen(ByteIOContext **s, const char *url, int flags);
Fabrice Bellard's avatar
Fabrice Bellard committed
398 399
int url_fclose(ByteIOContext *s);
URLContext *url_fileno(ByteIOContext *s);
400

401
/**
402 403 404 405
 * 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.
 *
406
 * @param s buffered file handle
407 408
 * @return maximum packet size in bytes
 */
409
int url_fget_max_packet_size(ByteIOContext *s);
Fabrice Bellard's avatar
Fabrice Bellard committed
410

411
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
412

413
/** return the written or read size */
Fabrice Bellard's avatar
Fabrice Bellard committed
414 415
int url_close_buf(ByteIOContext *s);

416
/**
417 418 419 420 421
 * Open a write only memory stream.
 *
 * @param s new IO context
 * @return zero if no error.
 */
422
int url_open_dyn_buf(ByteIOContext **s);
423

424
/**
425 426 427 428 429 430 431 432
 * 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.
 */
433
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
434

435
/**
436 437 438
 * Return the written size and a pointer to the buffer. The buffer
 *  must be freed with av_free().
 * @param s IO context
439
 * @param pbuffer pointer to a byte buffer
440 441
 * @return the length of the byte buffer
 */
442
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
443

Diego Biurrun's avatar
Diego Biurrun committed
444 445
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
                                    unsigned int len);
446
unsigned long get_checksum(ByteIOContext *s);
Diego Biurrun's avatar
Diego Biurrun committed
447 448 449
void init_checksum(ByteIOContext *s,
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
                   unsigned long checksum);
450

Fabrice Bellard's avatar
Fabrice Bellard committed
451
/* udp.c */
452 453
int udp_set_remote_url(URLContext *h, const char *uri);
int udp_get_local_port(URLContext *h);
454
#if (LIBAVFORMAT_VERSION_MAJOR <= 52)
455
int udp_get_file_handle(URLContext *h);
456
#endif
457

458
#endif /* AVFORMAT_AVIO_H */