Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ a23c9c4a

History | View | Annotate | Download (11.8 KB)

1 04d7f601 Diego Biurrun
/*
2
 * unbuffered io for ffmpeg system
3
 * copyright (c) 2001 Fabrice Bellard
4
 *
5 b78e7197 Diego Biurrun
 * This file is part of FFmpeg.
6
 *
7
 * FFmpeg is free software; you can redistribute it and/or
8 04d7f601 Diego Biurrun
 * modify it under the terms of the GNU Lesser General Public
9
 * License as published by the Free Software Foundation; either
10 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
11 04d7f601 Diego Biurrun
 *
12 b78e7197 Diego Biurrun
 * FFmpeg is distributed in the hope that it will be useful,
13 04d7f601 Diego Biurrun
 * 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 b78e7197 Diego Biurrun
 * License along with FFmpeg; if not, write to the Free Software
19 04d7f601 Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
 */
21 5b21bdab Diego Biurrun
#ifndef FFMPEG_AVIO_H
22
#define FFMPEG_AVIO_H
23 f031df23 Fabrice Bellard
24 99545457 Måns Rullgård
#include <stdint.h>
25
26 de6d9b64 Fabrice Bellard
/* output byte stream handling */
27
28 0c1a9eda Zdenek Kabelac
typedef int64_t offset_t;
29 de6d9b64 Fabrice Bellard
30
/* unbuffered I/O */
31
32 1308f273 Michael Niedermayer
/**
33
 * URL Context.
34
 * New fields can be added to the end with minor version bumps.
35 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
36 1308f273 Michael Niedermayer
 * version bump.
37 8bfb108b Diego Biurrun
 * sizeof(URLContext) must not be used outside libav*.
38 1308f273 Michael Niedermayer
 */
39 de6d9b64 Fabrice Bellard
struct URLContext {
40
    struct URLProtocol *prot;
41 115329f1 Diego Biurrun
    int flags;
42 c3316802 Panagiotis Issaris
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
43
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
44 de6d9b64 Fabrice Bellard
    void *priv_data;
45 c3316802 Panagiotis Issaris
    char *filename; /**< specified filename */
46 de6d9b64 Fabrice Bellard
};
47
48
typedef struct URLContext URLContext;
49
50
typedef struct URLPollEntry {
51
    URLContext *handle;
52
    int events;
53
    int revents;
54
} URLPollEntry;
55
56
#define URL_RDONLY 0
57
#define URL_WRONLY 1
58 f031df23 Fabrice Bellard
#define URL_RDWR   2
59
60 019ac05a Fabrice Bellard
typedef int URLInterruptCB(void);
61
62 de6d9b64 Fabrice Bellard
int url_open(URLContext **h, const char *filename, int flags);
63
int url_read(URLContext *h, unsigned char *buf, int size);
64
int url_write(URLContext *h, unsigned char *buf, int size);
65
offset_t url_seek(URLContext *h, offset_t pos, int whence);
66
int url_close(URLContext *h);
67
int url_exist(const char *filename);
68
offset_t url_filesize(URLContext *h);
69 c306748c Panagiotis Issaris
70 c3316802 Panagiotis Issaris
/**
71 c306748c Panagiotis Issaris
 * Return the maximum packet size associated to packetized file
72 8bfb108b Diego Biurrun
 * handle. If the file is not packetized (stream like HTTP or file on
73 c306748c Panagiotis Issaris
 * disk), then 0 is returned.
74
 *
75
 * @param h file handle
76
 * @return maximum packet size in bytes
77
 */
78 f031df23 Fabrice Bellard
int url_get_max_packet_size(URLContext *h);
79 f746a046 Fabrice Bellard
void url_get_filename(URLContext *h, char *buf, int buf_size);
80
81 c3316802 Panagiotis Issaris
/**
82 8bfb108b Diego Biurrun
 * The callback is called in blocking functions to test regulary if
83 c3316802 Panagiotis Issaris
 * asynchronous interruption is needed. AVERROR(EINTR) is returned
84
 * in this case by the interrupted function. 'NULL' means no interrupt
85 8bfb108b Diego Biurrun
 * callback is given.
86 c3316802 Panagiotis Issaris
 */
87 019ac05a Fabrice Bellard
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
88
89 de6d9b64 Fabrice Bellard
/* not implemented */
90
int url_poll(URLPollEntry *poll_table, int n, int timeout);
91
92 502bdf68 Michael Niedermayer
/**
93
 * Pause and resume playing - only meaningful if using a network streaming
94
 * protocol (e.g. MMS).
95
 * @param pause 1 for pause, 0 for resume
96
 */
97
int av_url_read_pause(URLContext *h, int pause);
98 8bfb108b Diego Biurrun
99 536333a0 Björn Axelsson
/**
100
 * Seek to a given timestamp relative to some component stream.
101 8bfb108b Diego Biurrun
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
102 536333a0 Björn Axelsson
 * @param stream_index The stream index that the timestamp is relative to.
103
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
104
 *        units from the beginning of the presentation.
105
 *        If a stream_index >= 0 is used and the protocol does not support
106
 *        seeking based on component streams, the call will fail with ENOTSUP.
107 00ef4f58 Diego Biurrun
 * @param timestamp timestamp in AVStream.time_base units
108 536333a0 Björn Axelsson
 *        or if there is no stream specified then in AV_TIME_BASE units.
109
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
110
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
111
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
112
 *        fail with ENOTSUP if used and not supported.
113
 * @return >= 0 on success
114
 * @see AVInputFormat::read_seek
115
 */
116 b075e520 Michael Niedermayer
offset_t av_url_read_seek(URLContext *h,
117 536333a0 Björn Axelsson
                     int stream_index, int64_t timestamp, int flags);
118
119 aa38b097 Michael Niedermayer
/**
120 90b5b51e Diego Biurrun
 * Passing this as the "whence" parameter to a seek function causes it to
121
 * return the filesize without seeking anywhere. Supporting this is optional.
122
 * If it is not supported then the seek function will return <0.
123 aa38b097 Michael Niedermayer
 */
124 8e287af0 Michael Niedermayer
#define AVSEEK_SIZE 0x10000
125
126 de6d9b64 Fabrice Bellard
typedef struct URLProtocol {
127
    const char *name;
128
    int (*url_open)(URLContext *h, const char *filename, int flags);
129
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
130
    int (*url_write)(URLContext *h, unsigned char *buf, int size);
131
    offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
132
    int (*url_close)(URLContext *h);
133
    struct URLProtocol *next;
134 502bdf68 Michael Niedermayer
    int (*url_read_pause)(URLContext *h, int pause);
135 b075e520 Michael Niedermayer
    offset_t (*url_read_seek)(URLContext *h,
136 536333a0 Björn Axelsson
                         int stream_index, int64_t timestamp, int flags);
137 de6d9b64 Fabrice Bellard
} URLProtocol;
138
139
extern URLProtocol *first_protocol;
140 019ac05a Fabrice Bellard
extern URLInterruptCB *url_interrupt_cb;
141 de6d9b64 Fabrice Bellard
142 84be6e72 Michael Niedermayer
URLProtocol *av_protocol_next(URLProtocol *p);
143
144 de6d9b64 Fabrice Bellard
int register_protocol(URLProtocol *protocol);
145
146 1308f273 Michael Niedermayer
/**
147
 * Bytestream IO Context.
148
 * New fields can be added to the end with minor version bumps.
149 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
150 1308f273 Michael Niedermayer
 * version bump.
151 8bfb108b Diego Biurrun
 * sizeof(ByteIOContext) must not be used outside libav*.
152 1308f273 Michael Niedermayer
 */
153 de6d9b64 Fabrice Bellard
typedef struct {
154
    unsigned char *buffer;
155
    int buffer_size;
156
    unsigned char *buf_ptr, *buf_end;
157
    void *opaque;
158 0c1a9eda Zdenek Kabelac
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
159 576ae256 Michael Niedermayer
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
160 536ffa59 Wolfram Gloger
    offset_t (*seek)(void *opaque, offset_t offset, int whence);
161 c3316802 Panagiotis Issaris
    offset_t pos; /**< position in the file of the current buffer */
162
    int must_flush; /**< true if the next seek should flush */
163
    int eof_reached; /**< true if eof reached */
164
    int write_flag;  /**< true if open for writing */
165 de6d9b64 Fabrice Bellard
    int is_streamed;
166 f031df23 Fabrice Bellard
    int max_packet_size;
167 ee9f36a8 Michael Niedermayer
    unsigned long checksum;
168
    unsigned char *checksum_ptr;
169
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
170 576ae256 Michael Niedermayer
    int error;         ///< contains the error code or 0 if no error happened
171 502bdf68 Michael Niedermayer
    int (*read_pause)(void *opaque, int pause);
172 b075e520 Michael Niedermayer
    offset_t (*read_seek)(void *opaque,
173 e7e4810a Björn Axelsson
                     int stream_index, int64_t timestamp, int flags);
174 de6d9b64 Fabrice Bellard
} ByteIOContext;
175
176
int init_put_byte(ByteIOContext *s,
177
                  unsigned char *buffer,
178
                  int buffer_size,
179
                  int write_flag,
180
                  void *opaque,
181 1e0f3468 Reimar Döffinger
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
182
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
183
                  offset_t (*seek)(void *opaque, offset_t offset, int whence));
184
ByteIOContext *av_alloc_put_byte(
185
                  unsigned char *buffer,
186
                  int buffer_size,
187
                  int write_flag,
188
                  void *opaque,
189 0c1a9eda Zdenek Kabelac
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
190 576ae256 Michael Niedermayer
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
191 536ffa59 Wolfram Gloger
                  offset_t (*seek)(void *opaque, offset_t offset, int whence));
192 de6d9b64 Fabrice Bellard
193
void put_byte(ByteIOContext *s, int b);
194 75bdb984 Philip Gladstone
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
195 0c1a9eda Zdenek Kabelac
void put_le64(ByteIOContext *s, uint64_t val);
196
void put_be64(ByteIOContext *s, uint64_t val);
197 de6d9b64 Fabrice Bellard
void put_le32(ByteIOContext *s, unsigned int val);
198
void put_be32(ByteIOContext *s, unsigned int val);
199 ea395e8c Aurelien Jacobs
void put_le24(ByteIOContext *s, unsigned int val);
200 a254c574 Michael Niedermayer
void put_be24(ByteIOContext *s, unsigned int val);
201 de6d9b64 Fabrice Bellard
void put_le16(ByteIOContext *s, unsigned int val);
202
void put_be16(ByteIOContext *s, unsigned int val);
203 0570bf06 Zdenek Kabelac
void put_tag(ByteIOContext *s, const char *tag);
204 de6d9b64 Fabrice Bellard
205 3b4b29dc Fabrice Bellard
void put_strz(ByteIOContext *s, const char *buf);
206 75bdb984 Philip Gladstone
207 de6d9b64 Fabrice Bellard
offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
208
void url_fskip(ByteIOContext *s, offset_t offset);
209
offset_t url_ftell(ByteIOContext *s);
210 a965c478 Aurelien Jacobs
offset_t url_fsize(ByteIOContext *s);
211 de6d9b64 Fabrice Bellard
int url_feof(ByteIOContext *s);
212 576ae256 Michael Niedermayer
int url_ferror(ByteIOContext *s);
213 de6d9b64 Fabrice Bellard
214 502bdf68 Michael Niedermayer
int av_url_read_fpause(ByteIOContext *h, int pause);
215 b075e520 Michael Niedermayer
offset_t av_url_read_fseek(ByteIOContext *h,
216 e7e4810a Björn Axelsson
                      int stream_index, int64_t timestamp, int flags);
217
218 f031df23 Fabrice Bellard
#define URL_EOF (-1)
219 c3316802 Panagiotis Issaris
/** @note return URL_EOF (-1) if EOF */
220 f031df23 Fabrice Bellard
int url_fgetc(ByteIOContext *s);
221 a8c5ab27 Panagiotis Issaris
222 c3316802 Panagiotis Issaris
/** @warning currently size is limited */
223 572f992e Michael Niedermayer
#ifdef __GNUC__
224 08f29f82 Michael Niedermayer
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
225 572f992e Michael Niedermayer
#else
226
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
227
#endif
228 a8c5ab27 Panagiotis Issaris
229 c3316802 Panagiotis Issaris
/** @note unlike fgets, the EOL character is not returned and a whole
230 a8c5ab27 Panagiotis Issaris
   line is parsed. return NULL if first char read was EOF */
231 f031df23 Fabrice Bellard
char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
232
233 de6d9b64 Fabrice Bellard
void put_flush_packet(ByteIOContext *s);
234
235
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
236 e15dec10 Leon van Stuivenberg
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
237 a8c5ab27 Panagiotis Issaris
238 c3316802 Panagiotis Issaris
/** @note return 0 if EOF, so you cannot use it if EOF handling is
239 a8c5ab27 Panagiotis Issaris
   necessary */
240 de6d9b64 Fabrice Bellard
int get_byte(ByteIOContext *s);
241 ea395e8c Aurelien Jacobs
unsigned int get_le24(ByteIOContext *s);
242 de6d9b64 Fabrice Bellard
unsigned int get_le32(ByteIOContext *s);
243 0c1a9eda Zdenek Kabelac
uint64_t get_le64(ByteIOContext *s);
244 de6d9b64 Fabrice Bellard
unsigned int get_le16(ByteIOContext *s);
245
246 3b4b29dc Fabrice Bellard
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
247 de6d9b64 Fabrice Bellard
unsigned int get_be16(ByteIOContext *s);
248 a254c574 Michael Niedermayer
unsigned int get_be24(ByteIOContext *s);
249 de6d9b64 Fabrice Bellard
unsigned int get_be32(ByteIOContext *s);
250 0c1a9eda Zdenek Kabelac
uint64_t get_be64(ByteIOContext *s);
251 de6d9b64 Fabrice Bellard
252 7798b42d Kostya Shishkov
uint64_t ff_get_v(ByteIOContext *bc);
253 897d3eef Kostya Shishkov
254 7ac13f0c Philip Gladstone
static inline int url_is_streamed(ByteIOContext *s)
255 de6d9b64 Fabrice Bellard
{
256
    return s->is_streamed;
257
}
258
259 3576f9c6 Björn Axelsson
/** @note when opened as read/write, the buffers are only used for
260
   writing */
261 899681cd Björn Axelsson
int url_fdopen(ByteIOContext **s, URLContext *h);
262 a8c5ab27 Panagiotis Issaris
263 c3316802 Panagiotis Issaris
/** @warning must be called before any I/O */
264 de6d9b64 Fabrice Bellard
int url_setbufsize(ByteIOContext *s, int buf_size);
265 770d9daf Björn Axelsson
/** Reset the buffer for reading or writing.
266
 * @note Will drop any data currently in the buffer without transmitting it.
267
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
268
 *        to set up the buffer for writing. */
269
int url_resetbuf(ByteIOContext *s, int flags);
270 a8c5ab27 Panagiotis Issaris
271 c3316802 Panagiotis Issaris
/** @note when opened as read/write, the buffers are only used for
272 3576f9c6 Björn Axelsson
   writing */
273 899681cd Björn Axelsson
int url_fopen(ByteIOContext **s, const char *filename, int flags);
274 de6d9b64 Fabrice Bellard
int url_fclose(ByteIOContext *s);
275
URLContext *url_fileno(ByteIOContext *s);
276 a8c5ab27 Panagiotis Issaris
277 c3316802 Panagiotis Issaris
/**
278 a8c5ab27 Panagiotis Issaris
 * Return the maximum packet size associated to packetized buffered file
279
 * handle. If the file is not packetized (stream like http or file on
280
 * disk), then 0 is returned.
281
 *
282 abfe87d4 Panagiotis Issaris
 * @param s buffered file handle
283 a8c5ab27 Panagiotis Issaris
 * @return maximum packet size in bytes
284
 */
285 f031df23 Fabrice Bellard
int url_fget_max_packet_size(ByteIOContext *s);
286 de6d9b64 Fabrice Bellard
287 899681cd Björn Axelsson
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
288 a8c5ab27 Panagiotis Issaris
289 c3316802 Panagiotis Issaris
/** return the written or read size */
290 de6d9b64 Fabrice Bellard
int url_close_buf(ByteIOContext *s);
291
292 c3316802 Panagiotis Issaris
/**
293 a8c5ab27 Panagiotis Issaris
 * Open a write only memory stream.
294
 *
295
 * @param s new IO context
296
 * @return zero if no error.
297
 */
298 899681cd Björn Axelsson
int url_open_dyn_buf(ByteIOContext **s);
299 a8c5ab27 Panagiotis Issaris
300 c3316802 Panagiotis Issaris
/**
301 a8c5ab27 Panagiotis Issaris
 * Open a write only packetized memory stream with a maximum packet
302
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
303
 * with a big endian 4 byte header giving the packet size in bytes.
304
 *
305
 * @param s new IO context
306
 * @param max_packet_size maximum packet size (must be > 0)
307
 * @return zero if no error.
308
 */
309 899681cd Björn Axelsson
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
310 a8c5ab27 Panagiotis Issaris
311 c3316802 Panagiotis Issaris
/**
312 a8c5ab27 Panagiotis Issaris
 * Return the written size and a pointer to the buffer. The buffer
313
 *  must be freed with av_free().
314
 * @param s IO context
315 e8b7c70f Panagiotis Issaris
 * @param pbuffer pointer to a byte buffer
316 a8c5ab27 Panagiotis Issaris
 * @return the length of the byte buffer
317
 */
318 0c1a9eda Zdenek Kabelac
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
319 f031df23 Fabrice Bellard
320 992e78f5 Baptiste Coudurier
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf, unsigned int len);
321 ee9f36a8 Michael Niedermayer
unsigned long get_checksum(ByteIOContext *s);
322
void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
323
324 de6d9b64 Fabrice Bellard
/* udp.c */
325 f031df23 Fabrice Bellard
int udp_set_remote_url(URLContext *h, const char *uri);
326
int udp_get_local_port(URLContext *h);
327
int udp_get_file_handle(URLContext *h);
328
329 5b21bdab Diego Biurrun
#endif /* FFMPEG_AVIO_H */