Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 364cacc7

History | View | Annotate | Download (19.2 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
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
#include "libavutil/log.h"
35

    
36
/* unbuffered I/O */
37

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

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

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

    
68
typedef int URLInterruptCB(void);
69

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

    
84
/**
85
 * Create a URLContext for accessing to the resource indicated by
86
 * url, but do not initiate the connection yet.
87
 *
88
 * @param puc pointer to the location where, in case of success, the
89
 * function puts the pointer to the created URLContext
90
 * @param flags flags which control how the resource indicated by url
91
 * is to be opened
92
 * @return 0 in case of success, a negative value corresponding to an
93
 * AVERROR code in case of failure
94
 */
95
int url_alloc(URLContext **h, const char *url, int flags);
96

    
97
/**
98
 * Connect an URLContext that has been allocated by url_alloc
99
 */
100
int url_connect(URLContext *h);
101

    
102
/**
103
 * Create an URLContext for accessing to the resource indicated by
104
 * url, and open it.
105
 *
106
 * @param puc pointer to the location where, in case of success, the
107
 * function puts the pointer to the created URLContext
108
 * @param flags flags which control how the resource indicated by url
109
 * is to be opened
110
 * @return 0 in case of success, a negative value corresponding to an
111
 * AVERROR code in case of failure
112
 */
113
int url_open(URLContext **h, const char *url, int flags);
114

    
115
/**
116
 * Read up to size bytes from the resource accessed by h, and store
117
 * the read bytes in buf.
118
 *
119
 * @return The number of bytes actually read, or a negative value
120
 * corresponding to an AVERROR code in case of error. A value of zero
121
 * indicates that it is not possible to read more from the accessed
122
 * resource (except if the value of the size argument is also zero).
123
 */
124
int url_read(URLContext *h, unsigned char *buf, int size);
125

    
126
/**
127
 * Read as many bytes as possible (up to size), calling the
128
 * read function multiple times if necessary.
129
 * Will also retry if the read function returns AVERROR(EAGAIN).
130
 * This makes special short-read handling in applications
131
 * unnecessary, if the return value is < size then it is
132
 * certain there was either an error or the end of file was reached.
133
 */
134
int url_read_complete(URLContext *h, unsigned char *buf, int size);
135
int url_write(URLContext *h, const unsigned char *buf, int size);
136

    
137
/**
138
 * Change the position that will be used by the next read/write
139
 * operation on the resource accessed by h.
140
 *
141
 * @param pos specifies the new position to set
142
 * @param whence specifies how pos should be interpreted, it must be
143
 * one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
144
 * current position), SEEK_END (seek from the end), or AVSEEK_SIZE
145
 * (return the filesize of the requested resource, pos is ignored).
146
 * @return a negative value corresponding to an AVERROR code in case
147
 * of failure, or the resulting file position, measured in bytes from
148
 * the beginning of the file. You can use this feature together with
149
 * SEEK_CUR to read the current file position.
150
 */
151
int64_t url_seek(URLContext *h, int64_t pos, int whence);
152

    
153
/**
154
 * Close the resource accessed by the URLContext h, and free the
155
 * memory used by it.
156
 *
157
 * @return a negative value if an error condition occurred, 0
158
 * otherwise
159
 */
160
int url_close(URLContext *h);
161

    
162
/**
163
 * Return a non-zero value if the resource indicated by url
164
 * exists, 0 otherwise.
165
 */
166
int url_exist(const char *url);
167

    
168
int64_t url_filesize(URLContext *h);
169

    
170
/**
171
 * Return the file descriptor associated with this URL. For RTP, this
172
 * will return only the RTP file descriptor, not the RTCP file descriptor.
173
 * To get both, use rtp_get_file_handles().
174
 *
175
 * @return the file descriptor associated with this URL, or <0 on error.
176
 */
177
int url_get_file_handle(URLContext *h);
178

    
179
/**
180
 * Return the maximum packet size associated to packetized file
181
 * handle. If the file is not packetized (stream like HTTP or file on
182
 * disk), then 0 is returned.
183
 *
184
 * @param h file handle
185
 * @return maximum packet size in bytes
186
 */
187
int url_get_max_packet_size(URLContext *h);
188
void url_get_filename(URLContext *h, char *buf, int buf_size);
189

    
190
/**
191
 * The callback is called in blocking functions to test regulary if
192
 * asynchronous interruption is needed. AVERROR(EINTR) is returned
193
 * in this case by the interrupted function. 'NULL' means no interrupt
194
 * callback is given.
195
 */
196
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
197

    
198
/* not implemented */
199
int url_poll(URLPollEntry *poll_table, int n, int timeout);
200

    
201
/**
202
 * Pause and resume playing - only meaningful if using a network streaming
203
 * protocol (e.g. MMS).
204
 * @param pause 1 for pause, 0 for resume
205
 */
206
int av_url_read_pause(URLContext *h, int pause);
207

    
208
/**
209
 * Seek to a given timestamp relative to some component stream.
210
 * Only meaningful if using a network streaming protocol (e.g. MMS.).
211
 * @param stream_index The stream index that the timestamp is relative to.
212
 *        If stream_index is (-1) the timestamp should be in AV_TIME_BASE
213
 *        units from the beginning of the presentation.
214
 *        If a stream_index >= 0 is used and the protocol does not support
215
 *        seeking based on component streams, the call will fail with ENOTSUP.
216
 * @param timestamp timestamp in AVStream.time_base units
217
 *        or if there is no stream specified then in AV_TIME_BASE units.
218
 * @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
219
 *        and AVSEEK_FLAG_ANY. The protocol may silently ignore
220
 *        AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
221
 *        fail with ENOTSUP if used and not supported.
222
 * @return >= 0 on success
223
 * @see AVInputFormat::read_seek
224
 */
225
int64_t av_url_read_seek(URLContext *h, int stream_index,
226
                         int64_t timestamp, int flags);
227

    
228
/**
229
 * Passing this as the "whence" parameter to a seek function causes it to
230
 * return the filesize without seeking anywhere. Supporting this is optional.
231
 * If it is not supported then the seek function will return <0.
232
 */
233
#define AVSEEK_SIZE 0x10000
234

    
235
/**
236
 * Oring this flag as into the "whence" parameter to a seek function causes it to
237
 * seek by any means (like reopening and linear reading) or other normally unreasonble
238
 * means that can be extreemly slow.
239
 * This may be ignored by the seek code.
240
 */
241
#define AVSEEK_FORCE 0x20000
242

    
243
typedef struct URLProtocol {
244
    const char *name;
245
    int (*url_open)(URLContext *h, const char *url, int flags);
246
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
247
    int (*url_write)(URLContext *h, const unsigned char *buf, int size);
248
    int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
249
    int (*url_close)(URLContext *h);
250
    struct URLProtocol *next;
251
    int (*url_read_pause)(URLContext *h, int pause);
252
    int64_t (*url_read_seek)(URLContext *h, int stream_index,
253
                             int64_t timestamp, int flags);
254
    int (*url_get_file_handle)(URLContext *h);
255
    int priv_data_size;
256
    const AVClass *priv_data_class;
257
} URLProtocol;
258

    
259
#if FF_API_REGISTER_PROTOCOL
260
extern URLProtocol *first_protocol;
261
#endif
262

    
263
extern URLInterruptCB *url_interrupt_cb;
264

    
265
/**
266
 * If protocol is NULL, returns the first registered protocol,
267
 * if protocol is non-NULL, returns the next registered protocol after protocol,
268
 * or NULL if protocol is the last one.
269
 */
270
URLProtocol *av_protocol_next(URLProtocol *p);
271

    
272
#if FF_API_REGISTER_PROTOCOL
273
/**
274
 * @deprecated Use av_register_protocol() instead.
275
 */
276
attribute_deprecated int register_protocol(URLProtocol *protocol);
277

    
278
/**
279
 * @deprecated Use av_register_protocol2() instead.
280
 */
281
attribute_deprecated int av_register_protocol(URLProtocol *protocol);
282
#endif
283

    
284
/**
285
 * Register the URLProtocol protocol.
286
 *
287
 * @param size the size of the URLProtocol struct referenced
288
 */
289
int av_register_protocol2(URLProtocol *protocol, int size);
290

    
291
/**
292
 * Bytestream IO Context.
293
 * New fields can be added to the end with minor version bumps.
294
 * Removal, reordering and changes to existing fields require a major
295
 * version bump.
296
 * sizeof(ByteIOContext) must not be used outside libav*.
297
 */
298
typedef struct {
299
    unsigned char *buffer;
300
    int buffer_size;
301
    unsigned char *buf_ptr, *buf_end;
302
    void *opaque;
303
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
304
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
305
    int64_t (*seek)(void *opaque, int64_t offset, int whence);
306
    int64_t pos; /**< position in the file of the current buffer */
307
    int must_flush; /**< true if the next seek should flush */
308
    int eof_reached; /**< true if eof reached */
309
    int write_flag;  /**< true if open for writing */
310
    int is_streamed;
311
    int max_packet_size;
312
    unsigned long checksum;
313
    unsigned char *checksum_ptr;
314
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
315
    int error;         ///< contains the error code or 0 if no error happened
316
    int (*read_pause)(void *opaque, int pause);
317
    int64_t (*read_seek)(void *opaque, int stream_index,
318
                         int64_t timestamp, int flags);
319
} ByteIOContext;
320

    
321
int init_put_byte(ByteIOContext *s,
322
                  unsigned char *buffer,
323
                  int buffer_size,
324
                  int write_flag,
325
                  void *opaque,
326
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
327
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
328
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
329
ByteIOContext *av_alloc_put_byte(
330
                  unsigned char *buffer,
331
                  int buffer_size,
332
                  int write_flag,
333
                  void *opaque,
334
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
335
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
336
                  int64_t (*seek)(void *opaque, int64_t offset, int whence));
337

    
338
void put_byte(ByteIOContext *s, int b);
339
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
340
void put_le64(ByteIOContext *s, uint64_t val);
341
void put_be64(ByteIOContext *s, uint64_t val);
342
void put_le32(ByteIOContext *s, unsigned int val);
343
void put_be32(ByteIOContext *s, unsigned int val);
344
void put_le24(ByteIOContext *s, unsigned int val);
345
void put_be24(ByteIOContext *s, unsigned int val);
346
void put_le16(ByteIOContext *s, unsigned int val);
347
void put_be16(ByteIOContext *s, unsigned int val);
348
void put_tag(ByteIOContext *s, const char *tag);
349

    
350
void put_strz(ByteIOContext *s, const char *buf);
351

    
352
/**
353
 * fseek() equivalent for ByteIOContext.
354
 * @return new position or AVERROR.
355
 */
356
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
357

    
358
/**
359
 * Skip given number of bytes forward.
360
 * @param offset number of bytes
361
 * @return 0 on success, <0 on error
362
 */
363
int url_fskip(ByteIOContext *s, int64_t offset);
364

    
365
/**
366
 * ftell() equivalent for ByteIOContext.
367
 * @return position or AVERROR.
368
 */
369
int64_t url_ftell(ByteIOContext *s);
370

    
371
/**
372
 * Get the filesize.
373
 * @return filesize or AVERROR
374
 */
375
int64_t url_fsize(ByteIOContext *s);
376

    
377
/**
378
 * feof() equivalent for ByteIOContext.
379
 * @return non zero if and only if end of file
380
 */
381
int url_feof(ByteIOContext *s);
382

    
383
int url_ferror(ByteIOContext *s);
384

    
385
int av_url_read_fpause(ByteIOContext *h, int pause);
386
int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
387
                          int64_t timestamp, int flags);
388

    
389
#define URL_EOF (-1)
390
/** @note return URL_EOF (-1) if EOF */
391
int url_fgetc(ByteIOContext *s);
392

    
393
/** @warning currently size is limited */
394
#ifdef __GNUC__
395
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
396
#else
397
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
398
#endif
399

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

    
404
void put_flush_packet(ByteIOContext *s);
405

    
406

    
407
/**
408
 * Read size bytes from ByteIOContext into buf.
409
 * @return number of bytes read or AVERROR
410
 */
411
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
412

    
413
/**
414
 * Read size bytes from ByteIOContext into buf.
415
 * This reads at most 1 packet. If that is not enough fewer bytes will be
416
 * returned.
417
 * @return number of bytes read or AVERROR
418
 */
419
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
420

    
421
/** @note return 0 if EOF, so you cannot use it if EOF handling is
422
    necessary */
423
int get_byte(ByteIOContext *s);
424
unsigned int get_le24(ByteIOContext *s);
425
unsigned int get_le32(ByteIOContext *s);
426
uint64_t get_le64(ByteIOContext *s);
427
unsigned int get_le16(ByteIOContext *s);
428

    
429
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
430
unsigned int get_be16(ByteIOContext *s);
431
unsigned int get_be24(ByteIOContext *s);
432
unsigned int get_be32(ByteIOContext *s);
433
uint64_t get_be64(ByteIOContext *s);
434

    
435
uint64_t ff_get_v(ByteIOContext *bc);
436

    
437
static inline int url_is_streamed(ByteIOContext *s)
438
{
439
    return s->is_streamed;
440
}
441

    
442
/**
443
 * Create and initialize a ByteIOContext for accessing the
444
 * resource referenced by the URLContext h.
445
 * @note When the URLContext h has been opened in read+write mode, the
446
 * ByteIOContext can be used only for writing.
447
 *
448
 * @param s Used to return the pointer to the created ByteIOContext.
449
 * In case of failure the pointed to value is set to NULL.
450
 * @return 0 in case of success, a negative value corresponding to an
451
 * AVERROR code in case of failure
452
 */
453
int url_fdopen(ByteIOContext **s, URLContext *h);
454

    
455
/** @warning must be called before any I/O */
456
int url_setbufsize(ByteIOContext *s, int buf_size);
457
#if FF_API_URL_RESETBUF
458
/** Reset the buffer for reading or writing.
459
 * @note Will drop any data currently in the buffer without transmitting it.
460
 * @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
461
 *        to set up the buffer for writing. */
462
int url_resetbuf(ByteIOContext *s, int flags);
463
#endif
464

    
465
/**
466
 * Rewind the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
467
 * Used after probing to avoid seeking.
468
 * Joins buf and s->buffer, taking any overlap into consideration.
469
 * @note s->buffer must overlap with buf or they can't be joined and the function fails
470
 * @note This function is NOT part of the public API
471
 *
472
 * @param s The read-only ByteIOContext to rewind
473
 * @param buf The probe buffer containing the first buf_size bytes of the file
474
 * @param buf_size The size of buf
475
 * @return 0 in case of success, a negative value corresponding to an
476
 * AVERROR code in case of failure
477
 */
478
int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
479

    
480
/**
481
 * Create and initialize a ByteIOContext for accessing the
482
 * resource indicated by url.
483
 * @note When the resource indicated by url has been opened in
484
 * read+write mode, the ByteIOContext can be used only for writing.
485
 *
486
 * @param s Used to return the pointer to the created ByteIOContext.
487
 * In case of failure the pointed to value is set to NULL.
488
 * @param flags flags which control how the resource indicated by url
489
 * is to be opened
490
 * @return 0 in case of success, a negative value corresponding to an
491
 * AVERROR code in case of failure
492
 */
493
int url_fopen(ByteIOContext **s, const char *url, int flags);
494

    
495
int url_fclose(ByteIOContext *s);
496
URLContext *url_fileno(ByteIOContext *s);
497

    
498
/**
499
 * Return the maximum packet size associated to packetized buffered file
500
 * handle. If the file is not packetized (stream like http or file on
501
 * disk), then 0 is returned.
502
 *
503
 * @param s buffered file handle
504
 * @return maximum packet size in bytes
505
 */
506
int url_fget_max_packet_size(ByteIOContext *s);
507

    
508
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
509

    
510
/** return the written or read size */
511
int url_close_buf(ByteIOContext *s);
512

    
513
/**
514
 * Open a write only memory stream.
515
 *
516
 * @param s new IO context
517
 * @return zero if no error.
518
 */
519
int url_open_dyn_buf(ByteIOContext **s);
520

    
521
/**
522
 * Open a write only packetized memory stream with a maximum packet
523
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
524
 * with a big endian 4 byte header giving the packet size in bytes.
525
 *
526
 * @param s new IO context
527
 * @param max_packet_size maximum packet size (must be > 0)
528
 * @return zero if no error.
529
 */
530
int url_open_dyn_packet_buf(ByteIOContext **s, int max_packet_size);
531

    
532
/**
533
 * Return the written size and a pointer to the buffer. The buffer
534
 * must be freed with av_free(). If the buffer is opened with
535
 * url_open_dyn_buf, then padding of FF_INPUT_BUFFER_PADDING_SIZE is
536
 * added; if opened with url_open_dyn_packet_buf, no padding is added.
537
 *
538
 * @param s IO context
539
 * @param pbuffer pointer to a byte buffer
540
 * @return the length of the byte buffer
541
 */
542
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
543

    
544
unsigned long ff_crc04C11DB7_update(unsigned long checksum, const uint8_t *buf,
545
                                    unsigned int len);
546
unsigned long get_checksum(ByteIOContext *s);
547
void init_checksum(ByteIOContext *s,
548
                   unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
549
                   unsigned long checksum);
550

    
551
/* udp.c */
552
int udp_set_remote_url(URLContext *h, const char *uri);
553
int udp_get_local_port(URLContext *h);
554
#if (LIBAVFORMAT_VERSION_MAJOR <= 52)
555
int udp_get_file_handle(URLContext *h);
556
#endif
557

    
558
#endif /* AVFORMAT_AVIO_H */