Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 333146dd

History | View | Annotate | Download (15 KB)

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

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

    
31
#include <stdint.h>
32

    
33
#include "libavutil/common.h"
34

    
35
/* unbuffered I/O */
36

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

    
56
typedef struct URLPollEntry {
57
    URLContext *handle;
58
    int events;
59
    int revents;
60
} URLPollEntry;
61

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

    
66
typedef int URLInterruptCB(void);
67

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

    
82
int url_open(URLContext **h, const char *filename, int flags);
83

    
84
/**
85
 * Reads up to size bytes from the resource accessed by h, and stores
86
 * the read bytes in buf.
87
 *
88
 * @return The number of bytes actually read, or a negative value
89
 * corresponding to an AVERROR code in case of error. A value of zero
90
 * indicates that it is not possible to read more from the accessed
91
 * resource (except if the value of the size argument is also zero).
92
 */
93
int url_read(URLContext *h, unsigned char *buf, int size);
94

    
95
/**
96
 * Read as many bytes as possible (up to size), calling the
97
 * read function multiple times if necessary.
98
 * Will also retry if the read function returns AVERROR(EAGAIN).
99
 * This makes special short-read handling in applications
100
 * unnecessary, if the return value is < size then it is
101
 * certain there was either an error or the end of file was reached.
102
 */
103
int url_read_complete(URLContext *h, unsigned char *buf, int size);
104
int url_write(URLContext *h, unsigned char *buf, int size);
105
int64_t url_seek(URLContext *h, int64_t pos, int whence);
106
int url_close(URLContext *h);
107
int url_exist(const char *filename);
108
int64_t url_filesize(URLContext *h);
109

    
110
/**
111
 * Return the file descriptor associated with this URL. For RTP, this
112
 * will return only the RTP file descriptor, not the RTCP file descriptor.
113
 * To get both, use rtp_get_file_handles().
114
 *
115
 * @return the file descriptor associated with this URL, or <0 on error.
116
 */
117
int url_get_file_handle(URLContext *h);
118

    
119
/**
120
 * Return the maximum packet size associated to packetized file
121
 * handle. If the file is not packetized (stream like HTTP or file on
122
 * disk), then 0 is returned.
123
 *
124
 * @param h file handle
125
 * @return maximum packet size in bytes
126
 */
127
int url_get_max_packet_size(URLContext *h);
128
void url_get_filename(URLContext *h, char *buf, int buf_size);
129

    
130
/**
131
 * The callback is called in blocking functions to test regulary if
132
 * asynchronous interruption is needed. AVERROR(EINTR) is returned
133
 * in this case by the interrupted function. 'NULL' means no interrupt
134
 * callback is given.
135
 */
136
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
137

    
138
/* not implemented */
139
int url_poll(URLPollEntry *poll_table, int n, int timeout);
140

    
141
/**
142
 * Pause and resume playing - only meaningful if using a network streaming
143
 * protocol (e.g. MMS).
144
 * @param pause 1 for pause, 0 for resume
145
 */
146
int av_url_read_pause(URLContext *h, int pause);
147

    
148
/**
149
 * Seek to a given timestamp relative to some component stream.
150
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
151
 * @param stream_index The stream index that the timestamp is relative to.
152
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
153
 *        units from the beginning of the presentation.
154
 *        If a stream_index >= 0 is used and the protocol does not support
155
 *        seeking based on component streams, the call will fail with ENOTSUP.
156
 * @param timestamp timestamp in AVStream.time_base units
157
 *        or if there is no stream specified then in AV_TIME_BASE units.
158
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
159
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
160
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
161
 *        fail with ENOTSUP if used and not supported.
162
 * @return >= 0 on success
163
 * @see AVInputFormat::read_seek
164
 */
165
int64_t av_url_read_seek(URLContext *h, int stream_index,
166
                         int64_t timestamp, int flags);
167

    
168
/**
169
 * Passing this as the "whence" parameter to a seek function causes it to
170
 * return the filesize without seeking anywhere. Supporting this is optional.
171
 * If it is not supported then the seek function will return <0.
172
 */
173
#define AVSEEK_SIZE 0x10000
174

    
175
typedef struct URLProtocol {
176
    const char *name;
177
    int (*url_open)(URLContext *h, const char *filename, int flags);
178
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
179
    int (*url_write)(URLContext *h, unsigned char *buf, int size);
180
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
181
    int (*url_close)(URLContext *h);
182
    struct URLProtocol *next;
183
    int (*url_read_pause)(URLContext *h, int pause);
184
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
185
                             int64_t timestamp, int flags);
186
    int (*url_get_file_handle)(URLContext *h);
187
} URLProtocol;
188

    
189
#if LIBAVFORMAT_VERSION_MAJOR < 53
190
extern URLProtocol *first_protocol;
191
#endif
192

    
193
extern URLInterruptCB *url_interrupt_cb;
194

    
195
/**
196
 * If protocol is NULL, returns the first registered protocol,
197
 * if protocol is non-NULL, returns the next registered protocol after protocol,
198
 * or NULL if protocol is the last one.
199
 */
200
URLProtocol *av_protocol_next(URLProtocol *p);
201

    
202
#if LIBAVFORMAT_VERSION_MAJOR < 53
203
/**
204
 * @deprecated Use av_register_protocol() instead.
205
 */
206
attribute_deprecated int register_protocol(URLProtocol *protocol);
207
#endif
208

    
209
int av_register_protocol(URLProtocol *protocol);
210

    
211
/**
212
 * Bytestream IO Context.
213
 * New fields can be added to the end with minor version bumps.
214
 * Removal, reordering and changes to existing fields require a major
215
 * version bump.
216
 * sizeof(ByteIOContext) must not be used outside libav*.
217
 */
218
typedef struct {
219
    unsigned char *buffer;
220
    int buffer_size;
221
    unsigned char *buf_ptr, *buf_end;
222
    void *opaque;
223
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
224
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
225
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
226
    int64_t pos; /**< position in the file of the current buffer */
227
    int must_flush; /**< true if the next seek should flush */
228
    int eof_reached; /**< true if eof reached */
229
    int write_flag;  /**< true if open for writing */
230
    int is_streamed;
231
    int max_packet_size;
232
    unsigned long checksum;
233
    unsigned char *checksum_ptr;
234
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
235
    int error;         ///< contains the error code or 0 if no error happened
236
    int (*read_pause)(void *opaque, int pause);
237
    int64_t (*read_seek)(void *opaque, int stream_index,
238
                         int64_t timestamp, int flags);
239
} ByteIOContext;
240

    
241
int init_put_byte(ByteIOContext *s,
242
                  unsigned char *buffer,
243
                  int buffer_size,
244
                  int write_flag,
245
                  void *opaque,
246
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
247
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
248
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
249
ByteIOContext *av_alloc_put_byte(
250
                  unsigned char *buffer,
251
                  int buffer_size,
252
                  int write_flag,
253
                  void *opaque,
254
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
255
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
256
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
257

    
258
void put_byte(ByteIOContext *s, int b);
259
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
260
void put_le64(ByteIOContext *s, uint64_t val);
261
void put_be64(ByteIOContext *s, uint64_t val);
262
void put_le32(ByteIOContext *s, unsigned int val);
263
void put_be32(ByteIOContext *s, unsigned int val);
264
void put_le24(ByteIOContext *s, unsigned int val);
265
void put_be24(ByteIOContext *s, unsigned int val);
266
void put_le16(ByteIOContext *s, unsigned int val);
267
void put_be16(ByteIOContext *s, unsigned int val);
268
void put_tag(ByteIOContext *s, const char *tag);
269

    
270
void put_strz(ByteIOContext *s, const char *buf);
271

    
272
/**
273
 * fseek() equivalent for ByteIOContext.
274
 * @return new position or AVERROR.
275
 */
276
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
277

    
278
/**
279
 * Skip given number of bytes forward.
280
 * @param offset number of bytes
281
 */
282
void url_fskip(ByteIOContext *s, int64_t offset);
283

    
284
/**
285
 * ftell() equivalent for ByteIOContext.
286
 * @return position or AVERROR.
287
 */
288
int64_t url_ftell(ByteIOContext *s);
289

    
290
/**
291
 * Gets the filesize.
292
 * @return filesize or AVERROR
293
 */
294
int64_t url_fsize(ByteIOContext *s);
295

    
296
/**
297
 * feof() equivalent for ByteIOContext.
298
 * @return non zero if and only if end of file
299
 */
300
int url_feof(ByteIOContext *s);
301

    
302
int url_ferror(ByteIOContext *s);
303

    
304
int av_url_read_fpause(ByteIOContext *h, int pause);
305
int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
306
                          int64_t timestamp, int flags);
307

    
308
#define URL_EOF (-1)
309
/** @note return URL_EOF (-1) if EOF */
310
int url_fgetc(ByteIOContext *s);
311

    
312
/** @warning currently size is limited */
313
#ifdef __GNUC__
314
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
315
#else
316
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
317
#endif
318

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

    
323
void put_flush_packet(ByteIOContext *s);
324

    
325

    
326
/**
327
 * Reads size bytes from ByteIOContext into buf.
328
 * @returns number of bytes read or AVERROR
329
 */
330
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
331

    
332
/**
333
 * Reads size bytes from ByteIOContext into buf.
334
 * This reads at most 1 packet. If that is not enough fewer bytes will be
335
 * returned.
336
 * @returns number of bytes read or AVERROR
337
 */
338
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
339

    
340
/** @note return 0 if EOF, so you cannot use it if EOF handling is
341
    necessary */
342
int get_byte(ByteIOContext *s);
343
unsigned int get_le24(ByteIOContext *s);
344
unsigned int get_le32(ByteIOContext *s);
345
uint64_t get_le64(ByteIOContext *s);
346
unsigned int get_le16(ByteIOContext *s);
347

    
348
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
349
unsigned int get_be16(ByteIOContext *s);
350
unsigned int get_be24(ByteIOContext *s);
351
unsigned int get_be32(ByteIOContext *s);
352
uint64_t get_be64(ByteIOContext *s);
353

    
354
uint64_t ff_get_v(ByteIOContext *bc);
355

    
356
static inline int url_is_streamed(ByteIOContext *s)
357
{
358
    return s->is_streamed;
359
}
360

    
361
/** @note when opened as read/write, the buffers are only used for
362
    writing */
363
int url_fdopen(ByteIOContext **s, URLContext *h);
364

    
365
/** @warning must be called before any I/O */
366
int url_setbufsize(ByteIOContext *s, int buf_size);
367
#if LIBAVFORMAT_VERSION_MAJOR < 53
368
/** Reset the buffer for reading or writing.
369
 * @note Will drop any data currently in the buffer without transmitting it.
370
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
371
 *        to set up the buffer for writing. */
372
int url_resetbuf(ByteIOContext *s, int flags);
373
#endif
374

    
375
/** @note when opened as read/write, the buffers are only used for
376
    writing */
377
int url_fopen(ByteIOContext **s, const char *filename, int flags);
378
int url_fclose(ByteIOContext *s);
379
URLContext *url_fileno(ByteIOContext *s);
380

    
381
/**
382
 * Return the maximum packet size associated to packetized buffered file
383
 * handle. If the file is not packetized (stream like http or file on
384
 * disk), then 0 is returned.
385
 *
386
 * @param s buffered file handle
387
 * @return maximum packet size in bytes
388
 */
389
int url_fget_max_packet_size(ByteIOContext *s);
390

    
391
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
392

    
393
/** return the written or read size */
394
int url_close_buf(ByteIOContext *s);
395

    
396
/**
397
 * Open a write only memory stream.
398
 *
399
 * @param s new IO context
400
 * @return zero if no error.
401
 */
402
int url_open_dyn_buf(ByteIOContext **s);
403

    
404
/**
405
 * Open a write only packetized memory stream with a maximum packet
406
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
407
 * with a big endian 4 byte header giving the packet size in bytes.
408
 *
409
 * @param s new IO context
410
 * @param max_packet_size maximum packet size (must be > 0)
411
 * @return zero if no error.
412
 */
413
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
414

    
415
/**
416
 * Return the written size and a pointer to the buffer. The buffer
417
 *  must be freed with av_free().
418
 * @param s IO context
419
 * @param pbuffer pointer to a byte buffer
420
 * @return the length of the byte buffer
421
 */
422
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
423

    
424
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
425
                                    unsigned int len);
426
unsigned long get_checksum(ByteIOContext *s);
427
void init_checksum(ByteIOContext *s,
428
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
429
                   unsigned long checksum);
430

    
431
/* udp.c */
432
int udp_set_remote_url(URLContext *h, const char *uri);
433
int udp_get_local_port(URLContext *h);
434
#if (LIBAVFORMAT_VERSION_MAJOR <= 52)
435
int udp_get_file_handle(URLContext *h);
436
#endif
437

    
438
#endif /* AVFORMAT_AVIO_H */