51
110
int max_packet_size; /**< if non zero, the stream is packetized with this max packet size */
53
112
char *filename; /**< specified URL */
116
#define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */
119
* @deprecated This struct is to be made private. Use the higher-level
120
* AVIOContext-based API instead.
122
typedef struct URLProtocol {
124
int (*url_open)(URLContext *h, const char *url, int flags);
125
int (*url_read)(URLContext *h, unsigned char *buf, int size);
126
int (*url_write)(URLContext *h, const unsigned char *buf, int size);
127
int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
128
int (*url_close)(URLContext *h);
129
struct URLProtocol *next;
130
int (*url_read_pause)(URLContext *h, int pause);
131
int64_t (*url_read_seek)(URLContext *h, int stream_index,
132
int64_t timestamp, int flags);
133
int (*url_get_file_handle)(URLContext *h);
135
const AVClass *priv_data_class;
137
int (*url_check)(URLContext *h, int mask);
56
140
typedef struct URLPollEntry {
57
141
URLContext *handle;
146
/* not implemented */
147
attribute_deprecated int url_poll(URLPollEntry *poll_table, int n, int timeout);
150
* @defgroup open_modes URL open modes
151
* The flags argument to url_open and cosins must be one of the following
152
* constants, optionally ORed with other flags.
155
#define URL_RDONLY 0 /**< read-only */
156
#define URL_WRONLY 1 /**< write-only */
157
#define URL_RDWR 2 /**< read-write */
163
* Use non-blocking mode.
164
* If this flag is set, operations on the context will return
165
* AVERROR(EAGAIN) if they can not be performed immediately.
166
* If this flag is not set, operations on the context will never return
168
* Note that this flag does not affect the opening/connecting of the
169
* context. Connecting a protocol will always block if necessary (e.g. on
170
* network protocols) but never hang (e.g. on busy devices).
171
* Warning: non-blocking protocols is work-in-progress; this flag may be
174
#define URL_FLAG_NONBLOCK 4
66
176
typedef int URLInterruptCB(void);
69
* Creates an URLContext for accessing to the resource indicated by
70
* url, and opens it using the URLProtocol up.
72
* @param puc pointer to the location where, in case of success, the
73
* function puts the pointer to the created URLContext
74
* @param flags flags which control how the resource indicated by url
76
* @return 0 in case of success, a negative value corresponding to an
77
* AVERROR code in case of failure
79
int url_open_protocol (URLContext **puc, struct URLProtocol *up,
80
const char *url, int flags);
83
* Creates an URLContext for accessing to the resource indicated by
86
* @param puc pointer to the location where, in case of success, the
87
* function puts the pointer to the created URLContext
88
* @param flags flags which control how the resource indicated by url
90
* @return 0 in case of success, a negative value corresponding to an
91
* AVERROR code in case of failure
93
int url_open(URLContext **h, const char *url, int flags);
96
* Reads up to size bytes from the resource accessed by h, and stores
97
* the read bytes in buf.
99
* @return The number of bytes actually read, or a negative value
100
* corresponding to an AVERROR code in case of error. A value of zero
101
* indicates that it is not possible to read more from the accessed
102
* resource (except if the value of the size argument is also zero).
104
int url_read(URLContext *h, unsigned char *buf, int size);
107
* Read as many bytes as possible (up to size), calling the
108
* read function multiple times if necessary.
109
* Will also retry if the read function returns AVERROR(EAGAIN).
110
* This makes special short-read handling in applications
111
* unnecessary, if the return value is < size then it is
112
* certain there was either an error or the end of file was reached.
114
int url_read_complete(URLContext *h, unsigned char *buf, int size);
115
int url_write(URLContext *h, unsigned char *buf, int size);
118
* Changes the position that will be used by the next read/write
119
* operation on the resource accessed by h.
121
* @param pos specifies the new position to set
122
* @param whence specifies how pos should be interpreted, it must be
123
* one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the
124
* current position), SEEK_END (seek from the end), or AVSEEK_SIZE
125
* (return the filesize of the requested resource, pos is ignored).
126
* @return a negative value corresponding to an AVERROR code in case
127
* of failure, or the resulting file position, measured in bytes from
128
* the beginning of the file. You can use this feature together with
129
* SEEK_CUR to read the current file position.
131
int64_t url_seek(URLContext *h, int64_t pos, int whence);
134
* Closes the resource accessed by the URLContext h, and frees the
137
* @return a negative value if an error condition occurred, 0
140
int url_close(URLContext *h);
143
* Returns a non-zero value if the resource indicated by url
177
extern URLInterruptCB *url_interrupt_cb;
180
* @defgroup old_url_funcs Old url_* functions
181
* @deprecated use the buffered API based on AVIOContext instead
184
attribute_deprecated int url_open_protocol (URLContext **puc, struct URLProtocol *up,
185
const char *url, int flags);
186
attribute_deprecated int url_alloc(URLContext **h, const char *url, int flags);
187
attribute_deprecated int url_connect(URLContext *h);
188
attribute_deprecated int url_open(URLContext **h, const char *url, int flags);
189
attribute_deprecated int url_read(URLContext *h, unsigned char *buf, int size);
190
attribute_deprecated int url_read_complete(URLContext *h, unsigned char *buf, int size);
191
attribute_deprecated int url_write(URLContext *h, const unsigned char *buf, int size);
192
attribute_deprecated int64_t url_seek(URLContext *h, int64_t pos, int whence);
193
attribute_deprecated int url_close(URLContext *h);
194
attribute_deprecated int64_t url_filesize(URLContext *h);
195
attribute_deprecated int url_get_file_handle(URLContext *h);
196
attribute_deprecated int url_get_max_packet_size(URLContext *h);
197
attribute_deprecated void url_get_filename(URLContext *h, char *buf, int buf_size);
198
attribute_deprecated int av_url_read_pause(URLContext *h, int pause);
199
attribute_deprecated int64_t av_url_read_seek(URLContext *h, int stream_index,
200
int64_t timestamp, int flags);
201
attribute_deprecated void url_set_interrupt_cb(int (*interrupt_cb)(void));
203
* If protocol is NULL, returns the first registered protocol,
204
* if protocol is non-NULL, returns the next registered protocol after protocol,
205
* or NULL if protocol is the last one.
207
attribute_deprecated URLProtocol *av_protocol_next(URLProtocol *p);
209
* Register the URLProtocol protocol.
211
* @param size the size of the URLProtocol struct referenced
213
attribute_deprecated int av_register_protocol2(URLProtocol *protocol, int size);
219
typedef attribute_deprecated AVIOContext ByteIOContext;
221
attribute_deprecated int init_put_byte(AVIOContext *s,
222
unsigned char *buffer,
226
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
227
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
228
int64_t (*seek)(void *opaque, int64_t offset, int whence));
229
attribute_deprecated AVIOContext *av_alloc_put_byte(
230
unsigned char *buffer,
234
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
235
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
236
int64_t (*seek)(void *opaque, int64_t offset, int whence));
239
* @defgroup old_avio_funcs Old put_/get_*() functions
240
* @deprecated use the avio_ -prefixed functions instead.
243
attribute_deprecated int get_buffer(AVIOContext *s, unsigned char *buf, int size);
244
attribute_deprecated int get_partial_buffer(AVIOContext *s, unsigned char *buf, int size);
245
attribute_deprecated int get_byte(AVIOContext *s);
246
attribute_deprecated unsigned int get_le16(AVIOContext *s);
247
attribute_deprecated unsigned int get_le24(AVIOContext *s);
248
attribute_deprecated unsigned int get_le32(AVIOContext *s);
249
attribute_deprecated uint64_t get_le64(AVIOContext *s);
250
attribute_deprecated unsigned int get_be16(AVIOContext *s);
251
attribute_deprecated unsigned int get_be24(AVIOContext *s);
252
attribute_deprecated unsigned int get_be32(AVIOContext *s);
253
attribute_deprecated uint64_t get_be64(AVIOContext *s);
255
attribute_deprecated void put_byte(AVIOContext *s, int b);
256
attribute_deprecated void put_nbyte(AVIOContext *s, int b, int count);
257
attribute_deprecated void put_buffer(AVIOContext *s, const unsigned char *buf, int size);
258
attribute_deprecated void put_le64(AVIOContext *s, uint64_t val);
259
attribute_deprecated void put_be64(AVIOContext *s, uint64_t val);
260
attribute_deprecated void put_le32(AVIOContext *s, unsigned int val);
261
attribute_deprecated void put_be32(AVIOContext *s, unsigned int val);
262
attribute_deprecated void put_le24(AVIOContext *s, unsigned int val);
263
attribute_deprecated void put_be24(AVIOContext *s, unsigned int val);
264
attribute_deprecated void put_le16(AVIOContext *s, unsigned int val);
265
attribute_deprecated void put_be16(AVIOContext *s, unsigned int val);
266
attribute_deprecated void put_tag(AVIOContext *s, const char *tag);
271
attribute_deprecated int av_url_read_fpause(AVIOContext *h, int pause);
272
attribute_deprecated int64_t av_url_read_fseek (AVIOContext *h, int stream_index,
273
int64_t timestamp, int flags);
276
* @defgroup old_url_f_funcs Old url_f* functions
277
* @deprecated use the avio_ -prefixed functions instead.
280
attribute_deprecated int url_fopen( AVIOContext **s, const char *url, int flags);
281
attribute_deprecated int url_fclose(AVIOContext *s);
282
attribute_deprecated int64_t url_fseek(AVIOContext *s, int64_t offset, int whence);
283
attribute_deprecated int url_fskip(AVIOContext *s, int64_t offset);
284
attribute_deprecated int64_t url_ftell(AVIOContext *s);
285
attribute_deprecated int64_t url_fsize(AVIOContext *s);
287
attribute_deprecated int url_fgetc(AVIOContext *s);
288
attribute_deprecated int url_setbufsize(AVIOContext *s, int buf_size);
290
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
292
attribute_deprecated int url_fprintf(AVIOContext *s, const char *fmt, ...);
294
attribute_deprecated void put_flush_packet(AVIOContext *s);
295
attribute_deprecated int url_open_dyn_buf(AVIOContext **s);
296
attribute_deprecated int url_open_dyn_packet_buf(AVIOContext **s, int max_packet_size);
297
attribute_deprecated int url_close_dyn_buf(AVIOContext *s, uint8_t **pbuffer);
298
attribute_deprecated int url_fdopen(AVIOContext **s, URLContext *h);
304
* @deprecated use AVIOContext.eof_reached
306
attribute_deprecated int url_feof(AVIOContext *s);
307
attribute_deprecated int url_ferror(AVIOContext *s);
309
attribute_deprecated int udp_set_remote_url(URLContext *h, const char *uri);
310
attribute_deprecated int udp_get_local_port(URLContext *h);
312
attribute_deprecated void init_checksum(AVIOContext *s,
313
unsigned long (*update_checksum)(unsigned long c, const uint8_t *p, unsigned int len),
314
unsigned long checksum);
315
attribute_deprecated unsigned long get_checksum(AVIOContext *s);
316
attribute_deprecated void put_strz(AVIOContext *s, const char *buf);
317
/** @note unlike fgets, the EOL character is not returned and a whole
318
line is parsed. return NULL if first char read was EOF */
319
attribute_deprecated char *url_fgets(AVIOContext *s, char *buf, int buf_size);
321
* @deprecated use avio_get_str instead
323
attribute_deprecated char *get_strz(AVIOContext *s, char *buf, int maxlen);
325
* @deprecated Use AVIOContext.seekable field directly.
327
attribute_deprecated static inline int url_is_streamed(AVIOContext *s)
331
attribute_deprecated URLContext *url_fileno(AVIOContext *s);
334
* @deprecated use AVIOContext.max_packet_size directly.
336
attribute_deprecated int url_fget_max_packet_size(AVIOContext *s);
338
attribute_deprecated int url_open_buf(AVIOContext **s, uint8_t *buf, int buf_size, int flags);
340
/** return the written or read size */
341
attribute_deprecated int url_close_buf(AVIOContext *s);
344
* Return a non-zero value if the resource indicated by url
144
345
* exists, 0 otherwise.
146
int url_exist(const char *url);
148
int64_t url_filesize(URLContext *h);
151
* Return the file descriptor associated with this URL. For RTP, this
152
* will return only the RTP file descriptor, not the RTCP file descriptor.
153
* To get both, use rtp_get_file_handles().
155
* @return the file descriptor associated with this URL, or <0 on error.
157
int url_get_file_handle(URLContext *h);
160
* Return the maximum packet size associated to packetized file
161
* handle. If the file is not packetized (stream like HTTP or file on
162
* disk), then 0 is returned.
164
* @param h file handle
165
* @return maximum packet size in bytes
167
int url_get_max_packet_size(URLContext *h);
168
void url_get_filename(URLContext *h, char *buf, int buf_size);
346
* @deprecated Use avio_check instead.
348
attribute_deprecated int url_exist(const char *url);
349
#endif // FF_API_OLD_AVIO
352
* Return AVIO_* access flags corresponding to the access permissions
353
* of the resource in url, or a negative value corresponding to an
354
* AVERROR code in case of failure. The returned access flags are
355
* masked by the value in flags.
357
* @note This function is intrinsically unsafe, in the sense that the
358
* checked resource may change its existence or permission status from
359
* one call to another. Thus you should not trust the returned value,
360
* unless you are sure that no other processes are accessing the
363
* @note This function is slightly broken until next major bump
364
* because of AVIO_RDONLY == 0. Don't use it until then.
366
int avio_check(const char *url, int flags);
171
369
* The callback is called in blocking functions to test regulary if
172
* asynchronous interruption is needed. AVERROR(EINTR) is returned
370
* asynchronous interruption is needed. AVERROR_EXIT is returned
173
371
* in this case by the interrupted function. 'NULL' means no interrupt
174
372
* callback is given.
176
void url_set_interrupt_cb(URLInterruptCB *interrupt_cb);
178
/* not implemented */
179
int url_poll(URLPollEntry *poll_table, int n, int timeout);
182
* Pause and resume playing - only meaningful if using a network streaming
183
* protocol (e.g. MMS).
184
* @param pause 1 for pause, 0 for resume
186
int av_url_read_pause(URLContext *h, int pause);
189
* Seek to a given timestamp relative to some component stream.
190
* Only meaningful if using a network streaming protocol (e.g. MMS.).
191
* @param stream_index The stream index that the timestamp is relative to.
192
* If stream_index is (-1) the timestamp should be in AV_TIME_BASE
193
* units from the beginning of the presentation.
194
* If a stream_index >= 0 is used and the protocol does not support
195
* seeking based on component streams, the call will fail with ENOTSUP.
196
* @param timestamp timestamp in AVStream.time_base units
197
* or if there is no stream specified then in AV_TIME_BASE units.
198
* @param flags Optional combination of AVSEEK_FLAG_BACKWARD, AVSEEK_FLAG_BYTE
199
* and AVSEEK_FLAG_ANY. The protocol may silently ignore
200
* AVSEEK_FLAG_BACKWARD and AVSEEK_FLAG_ANY, but AVSEEK_FLAG_BYTE will
201
* fail with ENOTSUP if used and not supported.
202
* @return >= 0 on success
203
* @see AVInputFormat::read_seek
205
int64_t av_url_read_seek(URLContext *h, int stream_index,
206
int64_t timestamp, int flags);
374
void avio_set_interrupt_cb(int (*interrupt_cb)(void));
376
#if FF_API_REGISTER_PROTOCOL
377
extern URLProtocol *first_protocol;
380
#if FF_API_REGISTER_PROTOCOL
382
* @deprecated Use av_register_protocol() instead.
384
attribute_deprecated int register_protocol(URLProtocol *protocol);
387
* @deprecated Use av_register_protocol2() instead.
389
attribute_deprecated int av_register_protocol(URLProtocol *protocol);
393
* Allocate and initialize an AVIOContext for buffered I/O. It must be later
394
* freed with av_free().
396
* @param buffer Memory block for input/output operations via AVIOContext.
397
* @param buffer_size The buffer size is very important for performance.
398
* For protocols with fixed blocksize it should be set to this blocksize.
399
* For others a typical size is a cache page, e.g. 4kb.
400
* @param write_flag Set to 1 if the buffer should be writable, 0 otherwise.
401
* @param opaque An opaque pointer to user-specific data.
402
* @param read_packet A function for refilling the buffer, may be NULL.
403
* @param write_packet A function for writing the buffer contents, may be NULL.
404
* @param seek A function for seeking to specified byte position, may be NULL.
406
* @return Allocated AVIOContext or NULL on failure.
408
AVIOContext *avio_alloc_context(
409
unsigned char *buffer,
413
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
414
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
415
int64_t (*seek)(void *opaque, int64_t offset, int whence));
417
void avio_w8(AVIOContext *s, int b);
418
void avio_write(AVIOContext *s, const unsigned char *buf, int size);
419
void avio_wl64(AVIOContext *s, uint64_t val);
420
void avio_wb64(AVIOContext *s, uint64_t val);
421
void avio_wl32(AVIOContext *s, unsigned int val);
422
void avio_wb32(AVIOContext *s, unsigned int val);
423
void avio_wl24(AVIOContext *s, unsigned int val);
424
void avio_wb24(AVIOContext *s, unsigned int val);
425
void avio_wl16(AVIOContext *s, unsigned int val);
426
void avio_wb16(AVIOContext *s, unsigned int val);
429
* Write a NULL-terminated string.
430
* @return number of bytes written.
432
int avio_put_str(AVIOContext *s, const char *str);
435
* Convert an UTF-8 string to UTF-16LE and write it.
436
* @return number of bytes written.
438
int avio_put_str16le(AVIOContext *s, const char *str);
209
441
* Passing this as the "whence" parameter to a seek function causes it to
221
453
#define AVSEEK_FORCE 0x20000
223
typedef struct URLProtocol {
225
int (*url_open)(URLContext *h, const char *url, int flags);
226
int (*url_read)(URLContext *h, unsigned char *buf, int size);
227
int (*url_write)(URLContext *h, unsigned char *buf, int size);
228
int64_t (*url_seek)(URLContext *h, int64_t pos, int whence);
229
int (*url_close)(URLContext *h);
230
struct URLProtocol *next;
231
int (*url_read_pause)(URLContext *h, int pause);
232
int64_t (*url_read_seek)(URLContext *h, int stream_index,
233
int64_t timestamp, int flags);
234
int (*url_get_file_handle)(URLContext *h);
237
#if LIBAVFORMAT_VERSION_MAJOR < 53
238
extern URLProtocol *first_protocol;
241
extern URLInterruptCB *url_interrupt_cb;
244
* If protocol is NULL, returns the first registered protocol,
245
* if protocol is non-NULL, returns the next registered protocol after protocol,
246
* or NULL if protocol is the last one.
248
URLProtocol *av_protocol_next(URLProtocol *p);
250
#if LIBAVFORMAT_VERSION_MAJOR < 53
252
* @deprecated Use av_register_protocol() instead.
254
attribute_deprecated int register_protocol(URLProtocol *protocol);
258
* Registers the URLProtocol protocol.
260
int av_register_protocol(URLProtocol *protocol);
263
* Bytestream IO Context.
264
* New fields can be added to the end with minor version bumps.
265
* Removal, reordering and changes to existing fields require a major
267
* sizeof(ByteIOContext) must not be used outside libav*.
270
unsigned char *buffer;
272
unsigned char *buf_ptr, *buf_end;
274
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size);
275
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size);
276
int64_t (*seek)(void *opaque, int64_t offset, int whence);
277
int64_t pos; /**< position in the file of the current buffer */
278
int must_flush; /**< true if the next seek should flush */
279
int eof_reached; /**< true if eof reached */
280
int write_flag; /**< true if open for writing */
283
unsigned long checksum;
284
unsigned char *checksum_ptr;
285
unsigned long (*update_checksum)(unsigned long checksum, const uint8_t *buf, unsigned int size);
286
int error; ///< contains the error code or 0 if no error happened
287
int (*read_pause)(void *opaque, int pause);
288
int64_t (*read_seek)(void *opaque, int stream_index,
289
int64_t timestamp, int flags);
292
int init_put_byte(ByteIOContext *s,
293
unsigned char *buffer,
297
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
298
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
299
int64_t (*seek)(void *opaque, int64_t offset, int whence));
300
ByteIOContext *av_alloc_put_byte(
301
unsigned char *buffer,
305
int (*read_packet)(void *opaque, uint8_t *buf, int buf_size),
306
int (*write_packet)(void *opaque, uint8_t *buf, int buf_size),
307
int64_t (*seek)(void *opaque, int64_t offset, int whence));
309
void put_byte(ByteIOContext *s, int b);
310
void put_buffer(ByteIOContext *s, const unsigned char *buf, int size);
311
void put_le64(ByteIOContext *s, uint64_t val);
312
void put_be64(ByteIOContext *s, uint64_t val);
313
void put_le32(ByteIOContext *s, unsigned int val);
314
void put_be32(ByteIOContext *s, unsigned int val);
315
void put_le24(ByteIOContext *s, unsigned int val);
316
void put_be24(ByteIOContext *s, unsigned int val);
317
void put_le16(ByteIOContext *s, unsigned int val);
318
void put_be16(ByteIOContext *s, unsigned int val);
319
void put_tag(ByteIOContext *s, const char *tag);
321
void put_strz(ByteIOContext *s, const char *buf);
324
* fseek() equivalent for ByteIOContext.
325
* @return new position or AVERROR.
327
int64_t url_fseek(ByteIOContext *s, int64_t offset, int whence);
330
* Skip given number of bytes forward.
331
* @param offset number of bytes
333
void url_fskip(ByteIOContext *s, int64_t offset);
336
* ftell() equivalent for ByteIOContext.
456
* fseek() equivalent for AVIOContext.
457
* @return new position or AVERROR.
459
int64_t avio_seek(AVIOContext *s, int64_t offset, int whence);
462
* Skip given number of bytes forward
463
* @return new position or AVERROR.
465
static av_always_inline int64_t avio_skip(AVIOContext *s, int64_t offset)
467
return avio_seek(s, offset, SEEK_CUR);
471
* ftell() equivalent for AVIOContext.
337
472
* @return position or AVERROR.
339
int64_t url_ftell(ByteIOContext *s);
474
static av_always_inline int64_t avio_tell(AVIOContext *s)
476
return avio_seek(s, 0, SEEK_CUR);
343
481
* @return filesize or AVERROR
345
int64_t url_fsize(ByteIOContext *s);
348
* feof() equivalent for ByteIOContext.
349
* @return non zero if and only if end of file
351
int url_feof(ByteIOContext *s);
353
int url_ferror(ByteIOContext *s);
355
int av_url_read_fpause(ByteIOContext *h, int pause);
356
int64_t av_url_read_fseek(ByteIOContext *h, int stream_index,
357
int64_t timestamp, int flags);
360
/** @note return URL_EOF (-1) if EOF */
361
int url_fgetc(ByteIOContext *s);
483
int64_t avio_size(AVIOContext *s);
363
485
/** @warning currently size is limited */
365
int url_fprintf(ByteIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
487
int avio_printf(AVIOContext *s, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 2, 3)));
367
int url_fprintf(ByteIOContext *s, const char *fmt, ...);
489
int avio_printf(AVIOContext *s, const char *fmt, ...);
370
/** @note unlike fgets, the EOL character is not returned and a whole
371
line is parsed. return NULL if first char read was EOF */
372
char *url_fgets(ByteIOContext *s, char *buf, int buf_size);
374
void put_flush_packet(ByteIOContext *s);
378
* Reads size bytes from ByteIOContext into buf.
379
* @return number of bytes read or AVERROR
381
int get_buffer(ByteIOContext *s, unsigned char *buf, int size);
384
* Reads size bytes from ByteIOContext into buf.
385
* This reads at most 1 packet. If that is not enough fewer bytes will be
387
* @return number of bytes read or AVERROR
389
int get_partial_buffer(ByteIOContext *s, unsigned char *buf, int size);
391
/** @note return 0 if EOF, so you cannot use it if EOF handling is
393
int get_byte(ByteIOContext *s);
394
unsigned int get_le24(ByteIOContext *s);
395
unsigned int get_le32(ByteIOContext *s);
396
uint64_t get_le64(ByteIOContext *s);
397
unsigned int get_le16(ByteIOContext *s);
399
char *get_strz(ByteIOContext *s, char *buf, int maxlen);
400
unsigned int get_be16(ByteIOContext *s);
401
unsigned int get_be24(ByteIOContext *s);
402
unsigned int get_be32(ByteIOContext *s);
403
uint64_t get_be64(ByteIOContext *s);
405
uint64_t ff_get_v(ByteIOContext *bc);
407
static inline int url_is_streamed(ByteIOContext *s)
409
return s->is_streamed;
413
* Creates and initializes a ByteIOContext for accessing the
414
* resource referenced by the URLContext h.
415
* @note When the URLContext h has been opened in read+write mode, the
416
* ByteIOContext can be used only for writing.
418
* @param s Used to return the pointer to the created ByteIOContext.
419
* In case of failure the pointed to value is set to NULL.
420
* @return 0 in case of success, a negative value corresponding to an
421
* AVERROR code in case of failure
423
int url_fdopen(ByteIOContext **s, URLContext *h);
425
/** @warning must be called before any I/O */
426
int url_setbufsize(ByteIOContext *s, int buf_size);
427
#if LIBAVFORMAT_VERSION_MAJOR < 53
492
void avio_flush(AVIOContext *s);
496
* Read size bytes from AVIOContext into buf.
497
* @return number of bytes read or AVERROR
499
int avio_read(AVIOContext *s, unsigned char *buf, int size);
502
* @defgroup avio_read Functions for reading from AVIOContext.
505
* @note return 0 if EOF, so you cannot use it if EOF handling is
508
int avio_r8 (AVIOContext *s);
509
unsigned int avio_rl16(AVIOContext *s);
510
unsigned int avio_rl24(AVIOContext *s);
511
unsigned int avio_rl32(AVIOContext *s);
512
uint64_t avio_rl64(AVIOContext *s);
513
unsigned int avio_rb16(AVIOContext *s);
514
unsigned int avio_rb24(AVIOContext *s);
515
unsigned int avio_rb32(AVIOContext *s);
516
uint64_t avio_rb64(AVIOContext *s);
522
* Read a string from pb into buf. The reading will terminate when either
523
* a NULL character was encountered, maxlen bytes have been read, or nothing
524
* more can be read from pb. The result is guaranteed to be NULL-terminated, it
525
* will be truncated if buf is too small.
526
* Note that the string is not interpreted or validated in any way, it
527
* might get truncated in the middle of a sequence for multi-byte encodings.
529
* @return number of bytes read (is always <= maxlen).
530
* If reading ends on EOF or error, the return value will be one more than
531
* bytes actually read.
533
int avio_get_str(AVIOContext *pb, int maxlen, char *buf, int buflen);
536
* Read a UTF-16 string from pb and convert it to UTF-8.
537
* The reading will terminate when either a null or invalid character was
538
* encountered or maxlen bytes have been read.
539
* @return number of bytes read (is always <= maxlen)
541
int avio_get_str16le(AVIOContext *pb, int maxlen, char *buf, int buflen);
542
int avio_get_str16be(AVIOContext *pb, int maxlen, char *buf, int buflen);
545
#if FF_API_URL_RESETBUF
428
546
/** Reset the buffer for reading or writing.
429
547
* @note Will drop any data currently in the buffer without transmitting it.
430
548
* @param flags URL_RDONLY to set up the buffer for reading, or URL_WRONLY
431
549
* to set up the buffer for writing. */
432
int url_resetbuf(ByteIOContext *s, int flags);
436
* Rewinds the ByteIOContext using the specified buffer containing the first buf_size bytes of the file.
437
* Used after probing to avoid seeking.
438
* Joins buf and s->buffer, taking any overlap into consideration.
439
* @note s->buffer must overlap with buf or they can't be joined and the function fails
440
* @note This function is NOT part of the public API
442
* @param s The read-only ByteIOContext to rewind
443
* @param buf The probe buffer containing the first buf_size bytes of the file
444
* @param buf_size The size of buf
445
* @return 0 in case of success, a negative value corresponding to an
446
* AVERROR code in case of failure
448
int ff_rewind_with_probe_data(ByteIOContext *s, unsigned char *buf, int buf_size);
451
* Creates and initializes a ByteIOContext for accessing the
550
int url_resetbuf(AVIOContext *s, int flags);
554
* @defgroup open_modes URL open modes
555
* The flags argument to avio_open must be one of the following
556
* constants, optionally ORed with other flags.
559
#if LIBAVFORMAT_VERSION_MAJOR < 53
560
#define AVIO_RDONLY 0 /**< read-only */
561
#define AVIO_WRONLY 1 /**< write-only */
562
#define AVIO_RDWR 2 /**< read-write */
564
#define AVIO_RDONLY 1 /**< read-only */
565
#define AVIO_WRONLY 2 /**< write-only */
566
#define AVIO_RDWR 4 /**< read-write */
573
* Use non-blocking mode.
574
* If this flag is set, operations on the context will return
575
* AVERROR(EAGAIN) if they can not be performed immediately.
576
* If this flag is not set, operations on the context will never return
578
* Note that this flag does not affect the opening/connecting of the
579
* context. Connecting a protocol will always block if necessary (e.g. on
580
* network protocols) but never hang (e.g. on busy devices).
581
* Warning: non-blocking protocols is work-in-progress; this flag may be
584
#if LIBAVFORMAT_VERSION_MAJOR < 53
585
#define AVIO_FLAG_NONBLOCK 4
587
#define AVIO_FLAG_NONBLOCK 8
591
* Create and initialize a AVIOContext for accessing the
452
592
* resource indicated by url.
453
593
* @note When the resource indicated by url has been opened in
454
* read+write mode, the ByteIOContext can be used only for writing.
594
* read+write mode, the AVIOContext can be used only for writing.
456
* @param s Used to return the pointer to the created ByteIOContext.
596
* @param s Used to return the pointer to the created AVIOContext.
457
597
* In case of failure the pointed to value is set to NULL.
458
598
* @param flags flags which control how the resource indicated by url
459
599
* is to be opened
460
600
* @return 0 in case of success, a negative value corresponding to an
461
601
* AVERROR code in case of failure
463
int url_fopen(ByteIOContext **s, const char *url, int flags);
465
int url_fclose(ByteIOContext *s);
466
URLContext *url_fileno(ByteIOContext *s);
603
int avio_open(AVIOContext **s, const char *url, int flags);
469
* Return the maximum packet size associated to packetized buffered file
470
* handle. If the file is not packetized (stream like http or file on
471
* disk), then 0 is returned.
606
* Close the resource accessed by the AVIOContext s and free it.
607
* This function can only be used if s was opened by avio_open().
473
* @param s buffered file handle
474
* @return maximum packet size in bytes
609
* @return 0 on success, an AVERROR < 0 on error.
476
int url_fget_max_packet_size(ByteIOContext *s);
478
int url_open_buf(ByteIOContext **s, uint8_t *buf, int buf_size, int flags);
480
/** return the written or read size */
481
int url_close_buf(ByteIOContext *s);
611
int avio_close(AVIOContext *s);
484
614
* Open a write only memory stream.