Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 6cc7f139

History | View | Annotate | Download (24.3 KB)

1 04d7f601 Diego Biurrun
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4 2912e87a Mans Rullgard
 * This file is part of Libav.
5 b78e7197 Diego Biurrun
 *
6 2912e87a Mans Rullgard
 * Libav is free software; you can redistribute it and/or
7 04d7f601 Diego Biurrun
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9 b78e7197 Diego Biurrun
 * version 2.1 of the License, or (at your option) any later version.
10 04d7f601 Diego Biurrun
 *
11 2912e87a Mans Rullgard
 * Libav is distributed in the hope that it will be useful,
12 04d7f601 Diego Biurrun
 * 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 2912e87a Mans Rullgard
 * License along with Libav; if not, write to the Free Software
18 04d7f601 Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20 98790382 Stefano Sabatini
#ifndef AVFORMAT_AVIO_H
21
#define AVFORMAT_AVIO_H
22 f031df23 Fabrice Bellard
23 aafe9b63 Stefano Sabatini
/**
24 ba87f080 Diego Biurrun
 * @file
25 aafe9b63 Stefano Sabatini
 * unbuffered I/O operations
26 3f4c2bf9 Stefano Sabatini
 *
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 aafe9b63 Stefano Sabatini
 */
30
31 99545457 Måns Rullgård
#include <stdint.h>
32
33 30f68128 Diego Biurrun
#include "libavutil/common.h"
34 ed8d5766 Martin Storsjö
#include "libavutil/log.h"
35 30f68128 Diego Biurrun
36 50196a98 Anton Khirnov
#include "libavformat/version.h"
37
38 de6d9b64 Fabrice Bellard
/* unbuffered I/O */
39
40 1308f273 Michael Niedermayer
/**
41
 * URL Context.
42
 * New fields can be added to the end with minor version bumps.
43 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
44 1308f273 Michael Niedermayer
 * version bump.
45 8bfb108b Diego Biurrun
 * sizeof(URLContext) must not be used outside libav*.
46 1308f273 Michael Niedermayer
 */
47 597b4b3f Stefano Sabatini
typedef struct URLContext {
48 404eba44 Aurelien Jacobs
#if FF_API_URL_CLASS
49 5acef35f Björn Axelsson
    const AVClass *av_class; ///< information for av_log(). Set by url_open().
50
#endif
51 de6d9b64 Fabrice Bellard
    struct URLProtocol *prot;
52 115329f1 Diego Biurrun
    int flags;
53 c3316802 Panagiotis Issaris
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
54
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
55 de6d9b64 Fabrice Bellard
    void *priv_data;
56 725b3da9 Stefano Sabatini
    char *filename; /**< specified URL */
57 ffbb289a Martin Storsjö
    int is_connected;
58 597b4b3f Stefano Sabatini
} URLContext;
59 de6d9b64 Fabrice Bellard
60 e2307053 Anton Khirnov
#if FF_API_OLD_AVIO
61 de6d9b64 Fabrice Bellard
typedef struct URLPollEntry {
62
    URLContext *handle;
63
    int events;
64
    int revents;
65
} URLPollEntry;
66 e2307053 Anton Khirnov
#endif
67 de6d9b64 Fabrice Bellard
68 fe174fc8 Nicolas George
/**
69
 * @defgroup open_modes URL open modes
70
 * The flags argument to url_open and cosins must be one of the following
71
 * constants, optionally ORed with other flags.
72
 * @{
73
 */
74
#define URL_RDONLY 0  /**< read-only */
75
#define URL_WRONLY 1  /**< write-only */
76
#define URL_RDWR   2  /**< read-write */
77
/**
78
 * @}
79
 */
80
81
/**
82
 * Use non-blocking mode.
83
 * If this flag is set, operations on the context will return
84
 * AVERROR(EAGAIN) if they can not be performed immediately.
85
 * If this flag is not set, operations on the context will never return
86
 * AVERROR(EAGAIN).
87
 * Note that this flag does not affect the opening/connecting of the
88
 * context. Connecting a protocol will always block if necessary (e.g. on
89
 * network protocols) but never hang (e.g. on busy devices).
90
 * Warning: non-blocking protocols is work-in-progress; this flag may be
91
 * silently ignored.
92
 */
93
#define URL_FLAG_NONBLOCK 4
94 f031df23 Fabrice Bellard
95 019ac05a Fabrice Bellard
typedef int URLInterruptCB(void);
96
97 333e8943 Anton Khirnov
#if FF_API_OLD_AVIO
98 333146dd Stefano Sabatini
/**
99 333e8943 Anton Khirnov
 * @defgroup old_url_funcs Old url_* functions
100
 * @deprecated use the buffered API based on AVIOContext instead
101
 * @{
102 333146dd Stefano Sabatini
 */
103 333e8943 Anton Khirnov
attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
104
                                            const char *url, int flags);
105
#endif
106 333146dd Stefano Sabatini
107 b0634fd1 Stefano Sabatini
/**
108 49bd8e4b Måns Rullgård
 * Create a URLContext for accessing to the resource indicated by
109
 * url, but do not initiate the connection yet.
110 ffbb289a Martin Storsjö
 *
111
 * @param puc pointer to the location where, in case of success, the
112
 * function puts the pointer to the created URLContext
113
 * @param flags flags which control how the resource indicated by url
114
 * is to be opened
115
 * @return 0 in case of success, a negative value corresponding to an
116
 * AVERROR code in case of failure
117
 */
118
int url_alloc(URLContext **h, const char *url, int flags);
119
120
/**
121
 * Connect an URLContext that has been allocated by url_alloc
122
 */
123
int url_connect(URLContext *h);
124
125
/**
126 49bd8e4b Måns Rullgård
 * Create an URLContext for accessing to the resource indicated by
127
 * url, and open it.
128 b0634fd1 Stefano Sabatini
 *
129
 * @param puc pointer to the location where, in case of success, the
130
 * function puts the pointer to the created URLContext
131
 * @param flags flags which control how the resource indicated by url
132
 * is to be opened
133
 * @return 0 in case of success, a negative value corresponding to an
134
 * AVERROR code in case of failure
135
 */
136 725b3da9 Stefano Sabatini
int url_open(URLContext **h, const char *url, int flags);
137 1f8ad15a Stefano Sabatini
138
/**
139 49bd8e4b Måns Rullgård
 * Read up to size bytes from the resource accessed by h, and store
140 1f8ad15a Stefano Sabatini
 * the read bytes in buf.
141
 *
142
 * @return The number of bytes actually read, or a negative value
143
 * corresponding to an AVERROR code in case of error. A value of zero
144
 * indicates that it is not possible to read more from the accessed
145
 * resource (except if the value of the size argument is also zero).
146
 */
147 de6d9b64 Fabrice Bellard
int url_read(URLContext *h, unsigned char *buf, int size);
148 1f8ad15a Stefano Sabatini
149 ddb901b7 Reimar Döffinger
/**
150
 * Read as many bytes as possible (up to size), calling the
151
 * read function multiple times if necessary.
152
 * This makes special short-read handling in applications
153
 * unnecessary, if the return value is < size then it is
154
 * certain there was either an error or the end of file was reached.
155
 */
156 0e848977 Kostya Shishkov
int url_read_complete(URLContext *h, unsigned char *buf, int size);
157 267ff3ae Stefano Sabatini
158
/**
159
 * Write size bytes from buf to the resource accessed by h.
160
 *
161
 * @return the number of bytes actually written, or a negative value
162
 * corresponding to an AVERROR code in case of failure
163
 */
164 27241cbf Martin Storsjö
int url_write(URLContext *h, const unsigned char *buf, int size);
165 9bee2459 Stefano Sabatini
166
/**
167 85c15960 Stefano Sabatini
 * Passing this as the "whence" parameter to a seek function causes it to
168
 * return the filesize without seeking anywhere. Supporting this is optional.
169
 * If it is not supported then the seek function will return <0.
170
 */
171
#define AVSEEK_SIZE 0x10000
172
173
/**
174 49bd8e4b Måns Rullgård
 * Change the position that will be used by the next read/write
175 9bee2459 Stefano Sabatini
 * operation on the resource accessed by h.
176
 *
177
 * @param pos specifies the new position to set
178
 * @param whence specifies how pos should be interpreted, it must be
179
 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
180
 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
181
 * (return the filesize of the requested resource, pos is ignored).
182
 * @return a negative value corresponding to an AVERROR code in case
183
 * of failure, or the resulting file position, measured in bytes from
184
 * the beginning of the file. You can use this feature together with
185
 * SEEK_CUR to read the current file position.
186
 */
187 bc5c918e Diego Biurrun
int64_t url_seek(URLContext *h, int64_t pos, int whence);
188 f1f78a9d Stefano Sabatini
189
/**
190 49bd8e4b Måns Rullgård
 * Close the resource accessed by the URLContext h, and free the
191 f1f78a9d Stefano Sabatini
 * memory used by it.
192
 *
193
 * @return a negative value if an error condition occurred, 0
194
 * otherwise
195
 */
196 de6d9b64 Fabrice Bellard
int url_close(URLContext *h);
197 f1f78a9d Stefano Sabatini
198 8a36b59b Stefano Sabatini
/**
199 49bd8e4b Måns Rullgård
 * Return a non-zero value if the resource indicated by url
200 8a36b59b Stefano Sabatini
 * exists, 0 otherwise.
201
 */
202 725b3da9 Stefano Sabatini
int url_exist(const char *url);
203 8a36b59b Stefano Sabatini
204 f3f5eb6e Stefano Sabatini
/**
205
 * Return the filesize of the resource accessed by h, AVERROR(ENOSYS)
206
 * if the operation is not supported by h, or another negative value
207
 * corresponding to an AVERROR error code in case of failure.
208
 */
209 bc5c918e Diego Biurrun
int64_t url_filesize(URLContext *h);
210 c306748c Panagiotis Issaris
211 c3316802 Panagiotis Issaris
/**
212 f0a80394 Ronald S. Bultje
 * Return the file descriptor associated with this URL. For RTP, this
213
 * will return only the RTP file descriptor, not the RTCP file descriptor.
214
 *
215
 * @return the file descriptor associated with this URL, or <0 on error.
216
 */
217
int url_get_file_handle(URLContext *h);
218
219
/**
220 c306748c Panagiotis Issaris
 * Return the maximum packet size associated to packetized file
221 8bfb108b Diego Biurrun
 * handle. If the file is not packetized (stream like HTTP or file on
222 c306748c Panagiotis Issaris
 * disk), then 0 is returned.
223
 *
224
 * @param h file handle
225
 * @return maximum packet size in bytes
226
 */
227 f031df23 Fabrice Bellard
int url_get_max_packet_size(URLContext *h);
228 8bf256bc Stefano Sabatini
229
/**
230
 * Copy the filename of the resource accessed by h to buf.
231
 *
232
 * @param buf_size size in bytes of buf
233
 */
234 f746a046 Fabrice Bellard
void url_get_filename(URLContext *h, char *buf, int buf_size);
235
236 c3316802 Panagiotis Issaris
/**
237 8bfb108b Diego Biurrun
 * The callback is called in blocking functions to test regulary if
238 c76374c6 Nicolas George
 * asynchronous interruption is needed. AVERROR_EXIT is returned
239 c3316802 Panagiotis Issaris
 * in this case by the interrupted function. 'NULL' means no interrupt
240 8bfb108b Diego Biurrun
 * callback is given.
241 c3316802 Panagiotis Issaris
 */
242 019ac05a Fabrice Bellard
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
243
244 e2307053 Anton Khirnov
#if FF_API_OLD_AVIO
245 de6d9b64 Fabrice Bellard
/* not implemented */
246 e2307053 Anton Khirnov
attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
247
#endif
248 de6d9b64 Fabrice Bellard
249 502bdf68 Michael Niedermayer
/**
250
 * Pause and resume playing - only meaningful if using a network streaming
251
 * protocol (e.g. MMS).
252
 * @param pause 1 for pause, 0 for resume
253
 */
254
int av_url_read_pause(URLContext *h, int pause);
255 8bfb108b Diego Biurrun
256 536333a0 Björn Axelsson
/**
257
 * Seek to a given timestamp relative to some component stream.
258 8bfb108b Diego Biurrun
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
259 536333a0 Björn Axelsson
 * @param stream_index The stream index that the timestamp is relative to.
260
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
261
 *        units from the beginning of the presentation.
262
 *        If a stream_index >= 0 is used and the protocol does not support
263
 *        seeking based on component streams, the call will fail with ENOTSUP.
264 00ef4f58 Diego Biurrun
 * @param timestamp timestamp in AVStream.time_base units
265 536333a0 Björn Axelsson
 *        or if there is no stream specified then in AV_TIME_BASE units.
266
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
267
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
268
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
269
 *        fail with ENOTSUP if used and not supported.
270
 * @return >= 0 on success
271
 * @see AVInputFormat::read_seek
272
 */
273 7f37f568 Diego Biurrun
int64_t av_url_read_seek(URLContext *h, int stream_index,
274
                         int64_t timestamp, int flags);
275 536333a0 Björn Axelsson
276 aa38b097 Michael Niedermayer
/**
277 493f54ad Michael Niedermayer
 * Oring this flag as into the "whence" parameter to a seek function causes it to
278
 * seek by any means (like reopening and linear reading) or other normally unreasonble
279
 * means that can be extreemly slow.
280
 * This may be ignored by the seek code.
281
 */
282
#define AVSEEK_FORCE 0x20000
283
284 8f73c060 Martin Storsjö
#define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
285
286 de6d9b64 Fabrice Bellard
typedef struct URLProtocol {
287
    const char *name;
288 725b3da9 Stefano Sabatini
    int (*url_open)(URLContext *h, const char *url, int flags);
289 de6d9b64 Fabrice Bellard
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
290 27241cbf Martin Storsjö
    int (*url_write)(URLContext *h, const unsigned char *buf, int size);
291 bc5c918e Diego Biurrun
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
292 de6d9b64 Fabrice Bellard
    int (*url_close)(URLContext *h);
293
    struct URLProtocol *next;
294 502bdf68 Michael Niedermayer
    int (*url_read_pause)(URLContext *h, int pause);
295 7f37f568 Diego Biurrun
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
296
                             int64_t timestamp, int flags);
297 f0a80394 Ronald S. Bultje
    int (*url_get_file_handle)(URLContext *h);
298 735cf6b2 Martin Storsjö
    int priv_data_size;
299
    const AVClass *priv_data_class;
300 f3bea991 Martin Storsjö
    int flags;
301 de6d9b64 Fabrice Bellard
} URLProtocol;
302
303 838b27b4 Aurelien Jacobs
#if FF_API_REGISTER_PROTOCOL
304 de6d9b64 Fabrice Bellard
extern URLProtocol *first_protocol;
305 d1037c12 Stefano Sabatini
#endif
306
307 019ac05a Fabrice Bellard
extern URLInterruptCB *url_interrupt_cb;
308 de6d9b64 Fabrice Bellard
309 9075d1e0 Stefano Sabatini
/**
310
 * If protocol is NULL, returns the first registered protocol,
311 c1b02101 Stefano Sabatini
 * if protocol is non-NULL, returns the next registered protocol after protocol,
312 9075d1e0 Stefano Sabatini
 * or NULL if protocol is the last one.
313
 */
314 84be6e72 Michael Niedermayer
URLProtocol *av_protocol_next(URLProtocol *p);
315
316 838b27b4 Aurelien Jacobs
#if FF_API_REGISTER_PROTOCOL
317 65c40e4e Stefano Sabatini
/**
318
 * @deprecated Use av_register_protocol() instead.
319
 */
320
attribute_deprecated int register_protocol(URLProtocol *protocol);
321 9b07a2dc Martin Storsjö
322
/**
323
 * @deprecated Use av_register_protocol2() instead.
324
 */
325
attribute_deprecated int av_register_protocol(URLProtocol *protocol);
326 65c40e4e Stefano Sabatini
#endif
327
328 d19a046e Stefano Sabatini
/**
329 49bd8e4b Måns Rullgård
 * Register the URLProtocol protocol.
330 9b07a2dc Martin Storsjö
 *
331
 * @param size the size of the URLProtocol struct referenced
332 d19a046e Stefano Sabatini
 */
333 9b07a2dc Martin Storsjö
int av_register_protocol2(URLProtocol *protocol, int size);
334 de6d9b64 Fabrice Bellard
335 8978feda Anton Khirnov
#define AVIO_SEEKABLE_NORMAL 0x0001 /**< Seeking works like for a local file */
336
337 1308f273 Michael Niedermayer
/**
338 333e8943 Anton Khirnov
 * @}
339
 */
340
341
/**
342 1308f273 Michael Niedermayer
 * Bytestream IO Context.
343
 * New fields can be added to the end with minor version bumps.
344 8bfb108b Diego Biurrun
 * Removal, reordering and changes to existing fields require a major
345 1308f273 Michael Niedermayer
 * version bump.
346 ae628ec1 Anton Khirnov
 * sizeof(AVIOContext) must not be used outside libav*.
347 1308f273 Michael Niedermayer
 */
348 de6d9b64 Fabrice Bellard
typedef struct {
349
    unsigned char *buffer;
350
    int buffer_size;
351
    unsigned char *buf_ptr, *buf_end;
352
    void *opaque;
353 0c1a9eda Zdenek Kabelac
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
354 576ae256 Michael Niedermayer
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
355 bc5c918e Diego Biurrun
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
356
    int64_t pos; /**< position in the file of the current buffer */
357 c3316802 Panagiotis Issaris
    int must_flush; /**< true if the next seek should flush */
358
    int eof_reached; /**< true if eof reached */
359
    int write_flag;  /**< true if open for writing */
360 8978feda Anton Khirnov
#if FF_API_OLD_AVIO
361
    attribute_deprecated int is_streamed;
362
#endif
363 f031df23 Fabrice Bellard
    int max_packet_size;
364 ee9f36a8 Michael Niedermayer
    unsigned long checksum;
365
    unsigned char *checksum_ptr;
366
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
367 576ae256 Michael Niedermayer
    int error;         ///< contains the error code or 0 if no error happened
368 502bdf68 Michael Niedermayer
    int (*read_pause)(void *opaque, int pause);
369 7f37f568 Diego Biurrun
    int64_t (*read_seek)(void *opaque, int stream_index,
370
                         int64_t timestamp, int flags);
371 8978feda Anton Khirnov
    /**
372
     * A combination of AVIO_SEEKABLE_ flags or 0 when the stream is not seekable.
373
     */
374
    int seekable;
375 ae628ec1 Anton Khirnov
} AVIOContext;
376 de6d9b64 Fabrice Bellard
377 ae628ec1 Anton Khirnov
#if FF_API_OLD_AVIO
378
typedef attribute_deprecated AVIOContext ByteIOContext;
379
380 e731b8d8 Anton Khirnov
attribute_deprecated int init_put_byte(AVIOContext *s,
381 de6d9b64 Fabrice Bellard
                  unsigned char *buffer,
382
                  int buffer_size,
383
                  int write_flag,
384
                  void *opaque,
385 1e0f3468 Reimar Döffinger
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
386
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
387 bc5c918e Diego Biurrun
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
388 8d9ac969 Anton Khirnov
attribute_deprecated AVIOContext *av_alloc_put_byte(
389
                  unsigned char *buffer,
390
                  int buffer_size,
391
                  int write_flag,
392
                  void *opaque,
393
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
394
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
395
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
396 b7effd4e Anton Khirnov
397
/**
398
 * @defgroup old_avio_funcs Old put_/get_*() functions
399
 * @deprecated use the avio_ -prefixed functions instead.
400
 * @{
401
 */
402
attribute_deprecated int          get_buffer(AVIOContext *s, unsigned char *buf, int size);
403 b3db9cee Anton Khirnov
attribute_deprecated int          get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
404 b7effd4e Anton Khirnov
attribute_deprecated int          get_byte(AVIOContext *s);
405
attribute_deprecated unsigned int get_le16(AVIOContext *s);
406
attribute_deprecated unsigned int get_le24(AVIOContext *s);
407
attribute_deprecated unsigned int get_le32(AVIOContext *s);
408
attribute_deprecated uint64_t     get_le64(AVIOContext *s);
409
attribute_deprecated unsigned int get_be16(AVIOContext *s);
410
attribute_deprecated unsigned int get_be24(AVIOContext *s);
411
attribute_deprecated unsigned int get_be32(AVIOContext *s);
412
attribute_deprecated uint64_t     get_be64(AVIOContext *s);
413 77eb5504 Anton Khirnov
414
attribute_deprecated void         put_byte(AVIOContext *s, int b);
415 0ac8e2bf Anton Khirnov
attribute_deprecated void         put_nbyte(AVIOContext *s, int b, int count);
416 77eb5504 Anton Khirnov
attribute_deprecated void         put_buffer(AVIOContext *s, const unsigned char *buf, int size);
417
attribute_deprecated void         put_le64(AVIOContext *s, uint64_t val);
418
attribute_deprecated void         put_be64(AVIOContext *s, uint64_t val);
419
attribute_deprecated void         put_le32(AVIOContext *s, unsigned int val);
420
attribute_deprecated void         put_be32(AVIOContext *s, unsigned int val);
421
attribute_deprecated void         put_le24(AVIOContext *s, unsigned int val);
422
attribute_deprecated void         put_be24(AVIOContext *s, unsigned int val);
423
attribute_deprecated void         put_le16(AVIOContext *s, unsigned int val);
424
attribute_deprecated void         put_be16(AVIOContext *s, unsigned int val);
425 61840b43 Anton Khirnov
attribute_deprecated void         put_tag(AVIOContext *s, const char *tag);
426 b7effd4e Anton Khirnov
/**
427
 * @}
428
 */
429 22a3212e Anton Khirnov
430 933e90a6 Anton Khirnov
attribute_deprecated int     av_url_read_fpause(AVIOContext *h,    int pause);
431 491653ed Anton Khirnov
attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h,    int stream_index,
432 933e90a6 Anton Khirnov
                                                int64_t timestamp, int flags);
433 22a3212e Anton Khirnov
434
/**
435
 * @defgroup old_url_f_funcs Old url_f* functions
436
 * @deprecated use the avio_ -prefixed functions instead.
437
 * @{
438
 */
439
attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
440
attribute_deprecated int url_fclose(AVIOContext *s);
441 6b4aa5da Anton Khirnov
attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
442 0300db8a Anton Khirnov
attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
443 a2704c97 Anton Khirnov
attribute_deprecated int64_t url_ftell(AVIOContext *s);
444 76aa876e Anton Khirnov
attribute_deprecated int64_t url_fsize(AVIOContext *s);
445 e5197539 Anton Khirnov
#define URL_EOF (-1)
446
attribute_deprecated int url_fgetc(AVIOContext *s);
447 59f65d95 Anton Khirnov
attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
448 d9d86e00 Anton Khirnov
#ifdef __GNUC__
449
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
450
#else
451
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
452
#endif
453 b7f2fdde Anton Khirnov
attribute_deprecated void put_flush_packet(AVIOContext *s);
454 b92c5452 Anton Khirnov
attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
455 403ee835 Anton Khirnov
attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
456 6dc7d80d Anton Khirnov
attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
457 724f6a0f Anton Khirnov
attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
458 22a3212e Anton Khirnov
/**
459
 * @}
460
 */
461 66e5b1df Anton Khirnov
462
/**
463
 * @deprecated use AVIOContext.eof_reached
464
 */
465
attribute_deprecated int url_feof(AVIOContext *s);
466 3e68b3ba Anton Khirnov
attribute_deprecated int url_ferror(AVIOContext *s);
467 4ec153bb Anton Khirnov
468
attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
469
attribute_deprecated int udp_get_local_port(URLContext *h);
470 4c4427a7 Anton Khirnov
471
attribute_deprecated void init_checksum(AVIOContext *s,
472
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
473
                   unsigned long checksum);
474 b64030f2 Anton Khirnov
attribute_deprecated unsigned long get_checksum(AVIOContext *s);
475 e731b8d8 Anton Khirnov
#endif
476 8d9ac969 Anton Khirnov
477 3c96c648 Anton Khirnov
/**
478
 * Allocate and initialize an AVIOContext for buffered I/O. It must be later
479
 * freed with av_free().
480
 *
481
 * @param buffer Memory block for input/output operations via AVIOContext.
482
 * @param buffer_size The buffer size is very important for performance.
483
 *        For protocols with fixed blocksize it should be set to this blocksize.
484
 *        For others a typical size is a cache page, e.g. 4kb.
485
 * @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
486
 * @param opaque An opaque pointer to user-specific data.
487
 * @param read_packet  A function for refilling the buffer, may be NULL.
488
 * @param write_packet A function for writing the buffer contents, may be NULL.
489
 * @param seek A function for seeking to specified byte position, may be NULL.
490
 *
491
 * @return Allocated AVIOContext or NULL on failure.
492
 */
493 8d9ac969 Anton Khirnov
AVIOContext *avio_alloc_context(
494 1e0f3468 Reimar Döffinger
                  unsigned char *buffer,
495
                  int buffer_size,
496
                  int write_flag,
497
                  void *opaque,
498 0c1a9eda Zdenek Kabelac
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
499 576ae256 Michael Niedermayer
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
500 bc5c918e Diego Biurrun
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
501 de6d9b64 Fabrice Bellard
502 77eb5504 Anton Khirnov
void avio_w8(AVIOContext *s, int b);
503
void avio_write(AVIOContext *s, const unsigned char *buf, int size);
504
void avio_wl64(AVIOContext *s, uint64_t val);
505
void avio_wb64(AVIOContext *s, uint64_t val);
506
void avio_wl32(AVIOContext *s, unsigned int val);
507
void avio_wb32(AVIOContext *s, unsigned int val);
508
void avio_wl24(AVIOContext *s, unsigned int val);
509
void avio_wb24(AVIOContext *s, unsigned int val);
510
void avio_wl16(AVIOContext *s, unsigned int val);
511
void avio_wb16(AVIOContext *s, unsigned int val);
512 de6d9b64 Fabrice Bellard
513 4efd5cf3 Anton Khirnov
#if FF_API_OLD_AVIO
514 ae628ec1 Anton Khirnov
attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
515 4efd5cf3 Anton Khirnov
#endif
516
517
/**
518
 * Write a NULL-terminated string.
519
 * @return number of bytes written.
520
 */
521 ae628ec1 Anton Khirnov
int avio_put_str(AVIOContext *s, const char *str);
522 75bdb984 Philip Gladstone
523 67e21020 Michael Niedermayer
/**
524 dccbd97d Anton Khirnov
 * Convert an UTF-8 string to UTF-16LE and write it.
525
 * @return number of bytes written.
526
 */
527 ae628ec1 Anton Khirnov
int avio_put_str16le(AVIOContext *s, const char *str);
528 dccbd97d Anton Khirnov
529
/**
530 ae628ec1 Anton Khirnov
 * fseek() equivalent for AVIOContext.
531 67e21020 Michael Niedermayer
 * @return new position or AVERROR.
532
 */
533 6b4aa5da Anton Khirnov
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
534 67e21020 Michael Niedermayer
535
/**
536 2af07d36 Peter Ross
 * Skip given number of bytes forward
537
 * @return new position or AVERROR.
538
 */
539 af020732 Anton Khirnov
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
540
{
541
    return avio_seek(s, offset, SEEK_CUR);
542
}
543 2af07d36 Peter Ross
544
/**
545 ae628ec1 Anton Khirnov
 * ftell() equivalent for AVIOContext.
546 67e21020 Michael Niedermayer
 * @return position or AVERROR.
547
 */
548 af020732 Anton Khirnov
static av_always_inline int64_t avio_tell(AVIOContext *s)
549
{
550
    return avio_seek(s, 0, SEEK_CUR);
551
}
552 67e21020 Michael Niedermayer
553
/**
554 49bd8e4b Måns Rullgård
 * Get the filesize.
555 67e21020 Michael Niedermayer
 * @return filesize or AVERROR
556
 */
557 76aa876e Anton Khirnov
int64_t avio_size(AVIOContext *s);
558 67e21020 Michael Niedermayer
559 c3316802 Panagiotis Issaris
/** @warning currently size is limited */
560 572f992e Michael Niedermayer
#ifdef __GNUC__
561 d9d86e00 Anton Khirnov
int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
562 572f992e Michael Niedermayer
#else
563 d9d86e00 Anton Khirnov
int avio_printf(AVIOContext *s, const char *fmt, ...);
564 572f992e Michael Niedermayer
#endif
565 a8c5ab27 Panagiotis Issaris
566 655e45e7 Anton Khirnov
#if FF_API_OLD_AVIO
567 c3316802 Panagiotis Issaris
/** @note unlike fgets, the EOL character is not returned and a whole
568 7f37f568 Diego Biurrun
    line is parsed. return NULL if first char read was EOF */
569 655e45e7 Anton Khirnov
attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
570
#endif
571 f031df23 Fabrice Bellard
572 b7f2fdde Anton Khirnov
void avio_flush(AVIOContext *s);
573 de6d9b64 Fabrice Bellard
574 4edfcecc Michael Niedermayer
575
/**
576 ae628ec1 Anton Khirnov
 * Read size bytes from AVIOContext into buf.
577 32e543f8 Benoit Fouet
 * @return number of bytes read or AVERROR
578 4edfcecc Michael Niedermayer
 */
579 b7effd4e Anton Khirnov
int avio_read(AVIOContext *s, unsigned char *buf, int size);
580 4edfcecc Michael Niedermayer
581 c3316802 Panagiotis Issaris
/** @note return 0 if EOF, so you cannot use it if EOF handling is
582 7f37f568 Diego Biurrun
    necessary */
583 b7effd4e Anton Khirnov
int          avio_r8  (AVIOContext *s);
584
unsigned int avio_rl16(AVIOContext *s);
585
unsigned int avio_rl24(AVIOContext *s);
586
unsigned int avio_rl32(AVIOContext *s);
587
uint64_t     avio_rl64(AVIOContext *s);
588 de6d9b64 Fabrice Bellard
589 93b78d12 Anton Khirnov
/**
590 41d8555f Reimar Döffinger
 * Read a string from pb into buf. The reading will terminate when either
591
 * a NULL character was encountered, maxlen bytes have been read, or nothing
592
 * more can be read from pb. The result is guaranteed to be NULL-terminated, it
593
 * will be truncated if buf is too small.
594
 * Note that the string is not interpreted or validated in any way, it
595
 * might get truncated in the middle of a sequence for multi-byte encodings.
596
 *
597
 * @return number of bytes read (is always <= maxlen).
598
 * If reading ends on EOF or error, the return value will be one more than
599
 * bytes actually read.
600
 */
601
int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
602
603
/**
604 93b78d12 Anton Khirnov
 * Read a UTF-16 string from pb and convert it to UTF-8.
605
 * The reading will terminate when either a null or invalid character was
606
 * encountered or maxlen bytes have been read.
607
 * @return number of bytes read (is always <= maxlen)
608
 */
609 ae628ec1 Anton Khirnov
int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
610
int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
611 93b78d12 Anton Khirnov
612 e16ead07 Anton Khirnov
#if FF_API_OLD_AVIO
613
/**
614
 * @deprecated use avio_get_str instead
615
 */
616
attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
617
#endif
618 b7effd4e Anton Khirnov
unsigned int avio_rb16(AVIOContext *s);
619
unsigned int avio_rb24(AVIOContext *s);
620
unsigned int avio_rb32(AVIOContext *s);
621
uint64_t     avio_rb64(AVIOContext *s);
622 de6d9b64 Fabrice Bellard
623 8978feda Anton Khirnov
#if FF_API_OLD_AVIO
624
/**
625
 * @deprecated Use AVIOContext.seekable field directly.
626
 */
627
attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
628 de6d9b64 Fabrice Bellard
{
629 8978feda Anton Khirnov
    return !s->seekable;
630 de6d9b64 Fabrice Bellard
}
631 8978feda Anton Khirnov
#endif
632 de6d9b64 Fabrice Bellard
633 364cacc7 Aurelien Jacobs
#if FF_API_URL_RESETBUF
634 770d9daf Björn Axelsson
/** Reset the buffer for reading or writing.
635
 * @note Will drop any data currently in the buffer without transmitting it.
636
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
637
 *        to set up the buffer for writing. */
638 ae628ec1 Anton Khirnov
int url_resetbuf(AVIOContext *s, int flags);
639 08580cb0 Benoit Fouet
#endif
640 a8c5ab27 Panagiotis Issaris
641 fe4fbb58 Stefano Sabatini
/**
642 ae628ec1 Anton Khirnov
 * Create and initialize a AVIOContext for accessing the
643 fe4fbb58 Stefano Sabatini
 * resource indicated by url.
644
 * @note When the resource indicated by url has been opened in
645 ae628ec1 Anton Khirnov
 * read+write mode, the AVIOContext can be used only for writing.
646 fe4fbb58 Stefano Sabatini
 *
647 ae628ec1 Anton Khirnov
 * @param s Used to return the pointer to the created AVIOContext.
648 fe4fbb58 Stefano Sabatini
 * In case of failure the pointed to value is set to NULL.
649
 * @param flags flags which control how the resource indicated by url
650
 * is to be opened
651
 * @return 0 in case of success, a negative value corresponding to an
652
 * AVERROR code in case of failure
653
 */
654 22a3212e Anton Khirnov
int avio_open(AVIOContext **s, const char *url, int flags);
655 fe4fbb58 Stefano Sabatini
656 22a3212e Anton Khirnov
int avio_close(AVIOContext *s);
657 a8c5ab27 Panagiotis Issaris
658 e8bb2e24 Anton Khirnov
#if FF_API_OLD_AVIO
659 8d9769a7 Anton Khirnov
attribute_deprecated URLContext *url_fileno(AVIOContext *s);
660
661 c3316802 Panagiotis Issaris
/**
662 e8bb2e24 Anton Khirnov
 * @deprecated use AVIOContext.max_packet_size directly.
663 a8c5ab27 Panagiotis Issaris
 */
664 e8bb2e24 Anton Khirnov
attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
665 de6d9b64 Fabrice Bellard
666 83fddaeb Anton Khirnov
attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
667 a8c5ab27 Panagiotis Issaris
668 c3316802 Panagiotis Issaris
/** return the written or read size */
669 35f10235 Anton Khirnov
attribute_deprecated int url_close_buf(AVIOContext *s);
670
#endif
671 de6d9b64 Fabrice Bellard
672 c3316802 Panagiotis Issaris
/**
673 a8c5ab27 Panagiotis Issaris
 * Open a write only memory stream.
674
 *
675
 * @param s new IO context
676
 * @return zero if no error.
677
 */
678 b92c5452 Anton Khirnov
int avio_open_dyn_buf(AVIOContext **s);
679 a8c5ab27 Panagiotis Issaris
680 c3316802 Panagiotis Issaris
/**
681 a8c5ab27 Panagiotis Issaris
 * Return the written size and a pointer to the buffer. The buffer
682 403ee835 Anton Khirnov
 * must be freed with av_free().
683
 * Padding of FF_INPUT_BUFFER_PADDING_SIZE is added to the buffer.
684 de1807bb Josh Allmann
 *
685 a8c5ab27 Panagiotis Issaris
 * @param s IO context
686 e8b7c70f Panagiotis Issaris
 * @param pbuffer pointer to a byte buffer
687 a8c5ab27 Panagiotis Issaris
 * @return the length of the byte buffer
688
 */
689 6dc7d80d Anton Khirnov
int avio_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
690 f031df23 Fabrice Bellard
691 8ef30ac1 Aurelien Jacobs
#if FF_API_UDP_GET_FILE
692 f031df23 Fabrice Bellard
int udp_get_file_handle(URLContext *h);
693 f0a80394 Ronald S. Bultje
#endif
694 f031df23 Fabrice Bellard
695 98790382 Stefano Sabatini
#endif /* AVFORMAT_AVIO_H */