Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 831ec935

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