Statistics
| Branch: | Revision:

ffmpeg / libavformat / avio.h @ 0ab1ebea

History | View | Annotate | Download (8.71 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 f031df23 Fabrice Bellard
#ifndef AVIO_H
22
#define AVIO_H
23
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
struct URLContext {
33
    struct URLProtocol *prot;
34 115329f1 Diego Biurrun
    int flags;
35 c3316802 Panagiotis Issaris
    int is_streamed;  /**< true if streamed (no seek possible), default = false */
36
    int max_packet_size;  /**< if non zero, the stream is packetized with this max packet size */
37 de6d9b64 Fabrice Bellard
    void *priv_data;
38 62181004 Ronald S. Bultje
#if LIBAVFORMAT_VERSION_INT >= (52<<16)
39 c3316802 Panagiotis Issaris
    char *filename; /**< specified filename */
40 62181004 Ronald S. Bultje
#else
41 c3316802 Panagiotis Issaris
    char filename[1]; /**< specified filename */
42 62181004 Ronald S. Bultje
#endif
43 de6d9b64 Fabrice Bellard
};
44
45
typedef struct URLContext URLContext;
46
47
typedef struct URLPollEntry {
48
    URLContext *handle;
49
    int events;
50
    int revents;
51
} URLPollEntry;
52
53
#define URL_RDONLY 0
54
#define URL_WRONLY 1
55 f031df23 Fabrice Bellard
#define URL_RDWR   2
56
57 019ac05a Fabrice Bellard
typedef int URLInterruptCB(void);
58
59 de6d9b64 Fabrice Bellard
int url_open(URLContext **h, const char *filename, int flags);
60
int url_read(URLContext *h, unsigned char *buf, int size);
61
int url_write(URLContext *h, unsigned char *buf, int size);
62
offset_t url_seek(URLContext *h, offset_t pos, int whence);
63
int url_close(URLContext *h);
64
int url_exist(const char *filename);
65
offset_t url_filesize(URLContext *h);
66 c306748c Panagiotis Issaris
67 c3316802 Panagiotis Issaris
/**
68 c306748c Panagiotis Issaris
 * Return the maximum packet size associated to packetized file
69
 * handle. If the file is not packetized (stream like http or file on
70
 * disk), then 0 is returned.
71
 *
72
 * @param h file handle
73
 * @return maximum packet size in bytes
74
 */
75 f031df23 Fabrice Bellard
int url_get_max_packet_size(URLContext *h);
76 f746a046 Fabrice Bellard
void url_get_filename(URLContext *h, char *buf, int buf_size);
77
78 c3316802 Panagiotis Issaris
/**
79
 * the callback is called in blocking functions to test regulary if
80
 * asynchronous interruption is needed. AVERROR(EINTR) is returned
81
 * in this case by the interrupted function. 'NULL' means no interrupt
82
 * callback is given. i
83
 */
84 019ac05a Fabrice Bellard
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
85
86 de6d9b64 Fabrice Bellard
/* not implemented */
87
int url_poll(URLPollEntry *poll_table, int n, int timeout);
88
89 aa38b097 Michael Niedermayer
/**
90 90b5b51e Diego Biurrun
 * Passing this as the "whence" parameter to a seek function causes it to
91
 * return the filesize without seeking anywhere. Supporting this is optional.
92
 * If it is not supported then the seek function will return <0.
93 aa38b097 Michael Niedermayer
 */
94 8e287af0 Michael Niedermayer
#define AVSEEK_SIZE 0x10000
95
96 de6d9b64 Fabrice Bellard
typedef struct URLProtocol {
97
    const char *name;
98
    int (*url_open)(URLContext *h, const char *filename, int flags);
99
    int (*url_read)(URLContext *h, unsigned char *buf, int size);
100
    int (*url_write)(URLContext *h, unsigned char *buf, int size);
101
    offset_t (*url_seek)(URLContext *h, offset_t pos, int whence);
102
    int (*url_close)(URLContext *h);
103
    struct URLProtocol *next;
104
} URLProtocol;
105
106
extern URLProtocol *first_protocol;
107 019ac05a Fabrice Bellard
extern URLInterruptCB *url_interrupt_cb;
108 de6d9b64 Fabrice Bellard
109
int register_protocol(URLProtocol *protocol);
110
111
typedef struct {
112
    unsigned char *buffer;
113
    int buffer_size;
114
    unsigned char *buf_ptr, *buf_end;
115
    void *opaque;
116 0c1a9eda Zdenek Kabelac
    int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
117 576ae256 Michael Niedermayer
    int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
118 536ffa59 Wolfram Gloger
    offset_t (*seek)(void *opaque, offset_t offset, int whence);
119 c3316802 Panagiotis Issaris
    offset_t pos; /**< position in the file of the current buffer */
120
    int must_flush; /**< true if the next seek should flush */
121
    int eof_reached; /**< true if eof reached */
122
    int write_flag;  /**< true if open for writing */
123 de6d9b64 Fabrice Bellard
    int is_streamed;
124 f031df23 Fabrice Bellard
    int max_packet_size;
125 ee9f36a8 Michael Niedermayer
    unsigned long checksum;
126
    unsigned char *checksum_ptr;
127
    unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
128 576ae256 Michael Niedermayer
    int error;         ///< contains the error code or 0 if no error happened
129 de6d9b64 Fabrice Bellard
} ByteIOContext;
130
131
int init_put_byte(ByteIOContext *s,
132
                  unsigned char *buffer,
133
                  int buffer_size,
134
                  int write_flag,
135
                  void *opaque,
136 0c1a9eda Zdenek Kabelac
                  int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
137 576ae256 Michael Niedermayer
                  int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
138 536ffa59 Wolfram Gloger
                  offset_t (*seek)(void *opaque, offset_t offset, int whence));
139 de6d9b64 Fabrice Bellard
140
void put_byte(ByteIOContext *s, int b);
141 75bdb984 Philip Gladstone
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
142 0c1a9eda Zdenek Kabelac
void put_le64(ByteIOContext *s, uint64_t val);
143
void put_be64(ByteIOContext *s, uint64_t val);
144 de6d9b64 Fabrice Bellard
void put_le32(ByteIOContext *s, unsigned int val);
145
void put_be32(ByteIOContext *s, unsigned int val);
146 ea395e8c Aurelien Jacobs
void put_le24(ByteIOContext *s, unsigned int val);
147 a254c574 Michael Niedermayer
void put_be24(ByteIOContext *s, unsigned int val);
148 de6d9b64 Fabrice Bellard
void put_le16(ByteIOContext *s, unsigned int val);
149
void put_be16(ByteIOContext *s, unsigned int val);
150 0570bf06 Zdenek Kabelac
void put_tag(ByteIOContext *s, const char *tag);
151 de6d9b64 Fabrice Bellard
152 3b4b29dc Fabrice Bellard
void put_strz(ByteIOContext *s, const char *buf);
153 75bdb984 Philip Gladstone
154 de6d9b64 Fabrice Bellard
offset_t url_fseek(ByteIOContext *s, offset_t offset, int whence);
155
void url_fskip(ByteIOContext *s, offset_t offset);
156
offset_t url_ftell(ByteIOContext *s);
157 a965c478 Aurelien Jacobs
offset_t url_fsize(ByteIOContext *s);
158 de6d9b64 Fabrice Bellard
int url_feof(ByteIOContext *s);
159 576ae256 Michael Niedermayer
int url_ferror(ByteIOContext *s);
160 de6d9b64 Fabrice Bellard
161 f031df23 Fabrice Bellard
#define URL_EOF (-1)
162 c3316802 Panagiotis Issaris
/** @note return URL_EOF (-1) if EOF */
163 f031df23 Fabrice Bellard
int url_fgetc(ByteIOContext *s);
164 a8c5ab27 Panagiotis Issaris
165 c3316802 Panagiotis Issaris
/** @warning currently size is limited */
166 572f992e Michael Niedermayer
#ifdef __GNUC__
167 08f29f82 Michael Niedermayer
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
168 572f992e Michael Niedermayer
#else
169
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
170
#endif
171 a8c5ab27 Panagiotis Issaris
172 c3316802 Panagiotis Issaris
/** @note unlike fgets, the EOL character is not returned and a whole
173 a8c5ab27 Panagiotis Issaris
   line is parsed. return NULL if first char read was EOF */
174 f031df23 Fabrice Bellard
char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
175
176 de6d9b64 Fabrice Bellard
void put_flush_packet(ByteIOContext *s);
177
178
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
179 e15dec10 Leon van Stuivenberg
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
180 a8c5ab27 Panagiotis Issaris
181 c3316802 Panagiotis Issaris
/** @note return 0 if EOF, so you cannot use it if EOF handling is
182 a8c5ab27 Panagiotis Issaris
   necessary */
183 de6d9b64 Fabrice Bellard
int get_byte(ByteIOContext *s);
184 ea395e8c Aurelien Jacobs
unsigned int get_le24(ByteIOContext *s);
185 de6d9b64 Fabrice Bellard
unsigned int get_le32(ByteIOContext *s);
186 0c1a9eda Zdenek Kabelac
uint64_t get_le64(ByteIOContext *s);
187 de6d9b64 Fabrice Bellard
unsigned int get_le16(ByteIOContext *s);
188
189 3b4b29dc Fabrice Bellard
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
190 de6d9b64 Fabrice Bellard
unsigned int get_be16(ByteIOContext *s);
191 a254c574 Michael Niedermayer
unsigned int get_be24(ByteIOContext *s);
192 de6d9b64 Fabrice Bellard
unsigned int get_be32(ByteIOContext *s);
193 0c1a9eda Zdenek Kabelac
uint64_t get_be64(ByteIOContext *s);
194 de6d9b64 Fabrice Bellard
195 7ac13f0c Philip Gladstone
static inline int url_is_streamed(ByteIOContext *s)
196 de6d9b64 Fabrice Bellard
{
197
    return s->is_streamed;
198
}
199
200
int url_fdopen(ByteIOContext *s, URLContext *h);
201 a8c5ab27 Panagiotis Issaris
202 c3316802 Panagiotis Issaris
/** @warning must be called before any I/O */
203 de6d9b64 Fabrice Bellard
int url_setbufsize(ByteIOContext *s, int buf_size);
204 a8c5ab27 Panagiotis Issaris
205 c3316802 Panagiotis Issaris
/** @note when opened as read/write, the buffers are only used for
206 a8c5ab27 Panagiotis Issaris
   reading */
207 de6d9b64 Fabrice Bellard
int url_fopen(ByteIOContext *s, const char *filename, int flags);
208
int url_fclose(ByteIOContext *s);
209
URLContext *url_fileno(ByteIOContext *s);
210 a8c5ab27 Panagiotis Issaris
211 c3316802 Panagiotis Issaris
/**
212 a8c5ab27 Panagiotis Issaris
 * Return the maximum packet size associated to packetized buffered file
213
 * handle. If the file is not packetized (stream like http or file on
214
 * disk), then 0 is returned.
215
 *
216
 * @param h buffered file handle
217
 * @return maximum packet size in bytes
218
 */
219 f031df23 Fabrice Bellard
int url_fget_max_packet_size(ByteIOContext *s);
220 de6d9b64 Fabrice Bellard
221 0c1a9eda Zdenek Kabelac
int url_open_buf(ByteIOContext *s, uint8_t *buf, int buf_size, int flags);
222 a8c5ab27 Panagiotis Issaris
223 c3316802 Panagiotis Issaris
/** return the written or read size */
224 de6d9b64 Fabrice Bellard
int url_close_buf(ByteIOContext *s);
225
226 c3316802 Panagiotis Issaris
/**
227 a8c5ab27 Panagiotis Issaris
 * Open a write only memory stream.
228
 *
229
 * @param s new IO context
230
 * @return zero if no error.
231
 */
232 f031df23 Fabrice Bellard
int url_open_dyn_buf(ByteIOContext *s);
233 a8c5ab27 Panagiotis Issaris
234 c3316802 Panagiotis Issaris
/**
235 a8c5ab27 Panagiotis Issaris
 * Open a write only packetized memory stream with a maximum packet
236
 * size of 'max_packet_size'.  The stream is stored in a memory buffer
237
 * with a big endian 4 byte header giving the packet size in bytes.
238
 *
239
 * @param s new IO context
240
 * @param max_packet_size maximum packet size (must be > 0)
241
 * @return zero if no error.
242
 */
243 f031df23 Fabrice Bellard
int url_open_dyn_packet_buf(ByteIOContext *s, int max_packet_size);
244 a8c5ab27 Panagiotis Issaris
245 c3316802 Panagiotis Issaris
/**
246 a8c5ab27 Panagiotis Issaris
 * Return the written size and a pointer to the buffer. The buffer
247
 *  must be freed with av_free().
248
 * @param s IO context
249
 * @param pointer to a byte buffer
250
 * @return the length of the byte buffer
251
 */
252 0c1a9eda Zdenek Kabelac
int url_close_dyn_buf(ByteIOContext *s, uint8_t **pbuffer);
253 f031df23 Fabrice Bellard
254 ee9f36a8 Michael Niedermayer
unsigned long get_checksum(ByteIOContext *s);
255
void init_checksum(ByteIOContext *s, unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len), unsigned long checksum);
256
257 de6d9b64 Fabrice Bellard
/* udp.c */
258 f031df23 Fabrice Bellard
int udp_set_remote_url(URLContext *h, const char *uri);
259
int udp_get_local_port(URLContext *h);
260
int udp_get_file_handle(URLContext *h);
261
262
#endif