Libav
Macros | Functions
avio.c File Reference
#include "libavutil/avstring.h"
#include "libavutil/dict.h"
#include "libavutil/opt.h"
#include "libavutil/time.h"
#include "os_support.h"
#include "avformat.h"
#include "url.h"

Go to the source code of this file.

Macros

#define URL_SCHEME_CHARS
 

Functions

static int url_alloc_for_protocol (URLContext **puc, const URLProtocol *up, const char *filename, int flags, const AVIOInterruptCB *int_cb, const URLProtocol **protocols)
 
int ffurl_connect (URLContext *uc, AVDictionary **options)
 Connect an URLContext that has been allocated by ffurl_alloc. More...
 
int ffurl_alloc (URLContext **puc, const char *filename, int flags, const AVIOInterruptCB *int_cb, const URLProtocol **protocols)
 Create a URLContext for accessing to the resource indicated by url, but do not initiate the connection yet. More...
 
int ffurl_open (URLContext **puc, const char *filename, int flags, const AVIOInterruptCB *int_cb, AVDictionary **options, const URLProtocol **protocols, URLContext *parent)
 Create an URLContext for accessing to the resource indicated by url, and open it. More...
 
static int retry_transfer_wrapper (URLContext *h, uint8_t *buf, int size, int size_min, int(*transfer_func)(URLContext *h, uint8_t *buf, int size))
 
int ffurl_read (URLContext *h, unsigned char *buf, int size)
 Read up to size bytes from the resource accessed by h, and store the read bytes in buf. More...
 
int ffurl_read_complete (URLContext *h, unsigned char *buf, int size)
 Read as many bytes as possible (up to size), calling the read function multiple times if necessary. More...
 
int ffurl_write (URLContext *h, const unsigned char *buf, int size)
 Write size bytes from buf to the resource accessed by h. More...
 
int64_t ffurl_seek (URLContext *h, int64_t pos, int whence)
 Change the position that will be used by the next read/write operation on the resource accessed by h. More...
 
int ffurl_close (URLContext *h)
 Close the resource accessed by the URLContext h, and free the memory used by it. More...
 
int avio_check (const char *url, int flags)
 Return AVIO_FLAG_* access flags corresponding to the access permissions of the resource in url, or a negative value corresponding to an AVERROR code in case of failure. More...
 
int64_t ffurl_size (URLContext *h)
 Return the filesize of the resource accessed by h, AVERROR(ENOSYS) if the operation is not supported by h, or another negative value corresponding to an AVERROR error code in case of failure. More...
 
int ffurl_get_file_handle (URLContext *h)
 Return the file descriptor associated with this URL. More...
 
int ffurl_get_multi_file_handle (URLContext *h, int **handles, int *numhandles)
 Return the file descriptors associated with this URL. More...
 
int ffurl_shutdown (URLContext *h, int flags)
 Signal the URLContext that we are done reading or writing the stream. More...
 
int ff_check_interrupt (AVIOInterruptCB *cb)
 Check if the user has requested to interrupt a blocking function associated with cb. More...
 

Logging context.

static const AVOption options []
 
const AVClass ffurl_context_class
 
static const char * urlcontext_to_name (void *ptr)
 
static voidurlcontext_child_next (void *obj, void *prev)
 

Macro Definition Documentation

◆ URL_SCHEME_CHARS

#define URL_SCHEME_CHARS
Value:
"abcdefghijklmnopqrstuvwxyz" \
"ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
"0123456789+-."

Definition at line 138 of file avio.c.

Referenced by ffurl_alloc().

Function Documentation

◆ urlcontext_to_name()

static const char* urlcontext_to_name ( void ptr)
static

Definition at line 35 of file avio.c.

◆ urlcontext_child_next()

static void* urlcontext_child_next ( void obj,
void prev 
)
static

Definition at line 44 of file avio.c.

◆ url_alloc_for_protocol()

static int url_alloc_for_protocol ( URLContext **  puc,
const URLProtocol up,
const char *  filename,
int  flags,
const AVIOInterruptCB int_cb,
const URLProtocol **  protocols 
)
static

Definition at line 66 of file avio.c.

Referenced by ffurl_alloc().

◆ ffurl_connect()

int ffurl_connect ( URLContext uc,
AVDictionary **  options 
)

Connect an URLContext that has been allocated by ffurl_alloc.

Parameters
optionsA dictionary filled with options for nested protocols, i.e. it will be passed to url_open2() for protocols implementing it. This parameter will be destroyed and replaced with a dict containing options that were not found. May be NULL.

Definition at line 119 of file avio.c.

Referenced by avio_check(), ff_rtsp_open_transport_ctx(), ffurl_open(), mmsh_open(), and rtmp_http_open().

◆ ffurl_alloc()

int ffurl_alloc ( URLContext **  puc,
const char *  filename,
int  flags,
const AVIOInterruptCB int_cb,
const URLProtocol **  protocols 
)

Create a URLContext for accessing to the resource indicated by url, but do not initiate the connection yet.

Parameters
pucpointer to the location where, in case of success, the function puts the pointer to the created URLContext
flagsflags which control how the resource indicated by url is to be opened
int_cbinterrupt callback to use for the URLContext, may be NULL
protocolsa NULL-terminate list of protocols available for use by this context and its children. The caller must ensure this list remains valid until the context is closed.
Returns
0 in case of success, a negative value corresponding to an AVERROR code in case of failure

Definition at line 143 of file avio.c.

Referenced by avio_check(), ff_rtsp_open_transport_ctx(), ffurl_open(), mmsh_open(), and rtmp_http_open().

◆ ffurl_open()

int ffurl_open ( URLContext **  puc,
const char *  filename,
int  flags,
const AVIOInterruptCB int_cb,
AVDictionary **  options,
const URLProtocol **  protocols,
URLContext parent 
)

Create an URLContext for accessing to the resource indicated by url, and open it.

Parameters
pucpointer to the location where, in case of success, the function puts the pointer to the created URLContext
flagsflags which control how the resource indicated by url is to be opened
int_cbinterrupt callback to use for the URLContext, may be NULL
optionsA dictionary filled with protocol-private options. On return this parameter will be destroyed and replaced with a dict containing options that were not found. May be NULL.
protocolsa NULL-terminate list of protocols available for use by this context and its children. The caller must ensure this list remains valid until the context is closed.
parentAn enclosing URLContext, whose generic options should be applied to this URLContext as well.
Returns
0 in case of success, a negative value corresponding to an AVERROR code in case of failure

Definition at line 175 of file avio.c.

Referenced by avio_open2(), concat_open(), crypto_open(), ff_rtsp_open_transport_ctx(), ff_tls_open_underlying(), gopher_open(), hls_read(), http_open_cnx_internal(), icecast_open(), ism_flush(), ism_seek(), md5_close(), mms_open(), rtmp_calc_swfhash(), rtmp_open(), rtmpe_open(), rtp_open(), rtsp_listen(), rtsp_read_setup(), sap_read_header(), sap_write_header(), and srtp_open().

◆ retry_transfer_wrapper()

static int retry_transfer_wrapper ( URLContext h,
uint8_t buf,
int  size,
int  size_min,
int(*)(URLContext *h, uint8_t *buf, int size transfer_func 
)
inlinestatic

Definition at line 200 of file avio.c.

Referenced by ffurl_read(), ffurl_read_complete(), and ffurl_write().

◆ ffurl_read()

int ffurl_read ( URLContext h,
unsigned char *  buf,
int  size 
)

Read up to size bytes from the resource accessed by h, and store the read bytes in buf.

Returns
The number of bytes actually read, or a negative value corresponding to an AVERROR code in case of error. A value of zero indicates that it is not possible to read more from the accessed resource (except if the value of the size argument is also zero).

Definition at line 243 of file avio.c.

Referenced by concat_read(), crypto_read(), ff_rtmp_packet_read(), ff_rtmp_packet_read_internal(), ff_rtsp_open_transport_ctx(), gnutls_url_pull(), gopher_read(), hls_read(), http_buf_read(), http_getc(), io_read_packet(), rtmp_http_open(), rtmp_http_read(), rtmp_http_send_cmd(), rtmp_write(), rtmpe_read(), sap_fetch_packet(), sap_read_header(), srtp_read(), and url_bio_bread().

◆ ffurl_read_complete()

int ffurl_read_complete ( URLContext h,
unsigned char *  buf,
int  size 
)

Read as many bytes as possible (up to size), calling the read function multiple times if necessary.

This makes special short-read handling in applications unnecessary, if the return value is < size then it is certain there was either an error or the end of file was reached.

Definition at line 250 of file avio.c.

Referenced by ff_rtsp_open_transport_ctx(), ff_rtsp_tcp_read_packet(), get_chunk_header(), get_http_header_data(), get_tcp_server_response(), read_data_packet(), read_line(), rtmp_calc_swfhash(), rtmp_handshake(), rtmp_packet_read_one_chunk(), rtmp_receive_hs_packet(), rtmp_server_handshake(), and rtsp_read_announce().

◆ ffurl_write()

int ffurl_write ( URLContext h,
const unsigned char *  buf,
int  size 
)

◆ ffurl_seek()

int64_t ffurl_seek ( URLContext h,
int64_t  pos,
int  whence 
)

Change the position that will be used by the next read/write operation on the resource accessed by h.

Parameters
posspecifies the new position to set
whencespecifies how pos should be interpreted, it must be one of SEEK_SET (seek from the beginning), SEEK_CUR (seek from the current position), SEEK_END (seek from the end), or AVSEEK_SIZE (return the filesize of the requested resource, pos is ignored).
Returns
a negative value corresponding to an AVERROR code in case of failure, or the resulting file position, measured in bytes from the beginning of the file. You can use this feature together with SEEK_CUR to read the current file position.

Definition at line 270 of file avio.c.

Referenced by concat_read(), concat_seek(), ffurl_connect(), ffurl_size(), io_seek(), ism_seek(), and rtmp_calc_swfhash().

◆ ffurl_close()

int ffurl_close ( URLContext h)

◆ avio_check()

int avio_check ( const char *  url,
int  flags 
)

Return AVIO_FLAG_* access flags corresponding to the access permissions of the resource in url, or a negative value corresponding to an AVERROR code in case of failure.

The returned access flags are masked by the value in flags.

Note
This function is intrinsically unsafe, in the sense that the checked resource may change its existence or permission status from one call to another. Thus you should not trust the returned value, unless you are sure that no other processes are accessing the checked resource.

Definition at line 301 of file avio.c.

Referenced by assert_file_overwrite(), and find_image_range().

◆ ffurl_size()

int64_t ffurl_size ( URLContext h)

Return the filesize of the resource accessed by h, AVERROR(ENOSYS) if the operation is not supported by h, or another negative value corresponding to an AVERROR error code in case of failure.

Definition at line 330 of file avio.c.

Referenced by concat_open().

◆ ffurl_get_file_handle()

int ffurl_get_file_handle ( URLContext h)

Return the file descriptor associated with this URL.

For RTP, this will return only the RTP file descriptor, not the RTCP file descriptor.

Returns
the file descriptor associated with this URL, or <0 on error.

Definition at line 345 of file avio.c.

Referenced by ff_rtsp_open_transport_ctx(), http_get_file_handle(), rtp_open(), rtsp_write_packet(), sap_fetch_packet(), sap_write_header(), and srtp_get_file_handle().

◆ ffurl_get_multi_file_handle()

int ffurl_get_multi_file_handle ( URLContext h,
int **  handles,
int *  numhandles 
)

Return the file descriptors associated with this URL.

Returns
0 on success or <0 on error.

Definition at line 352 of file avio.c.

Referenced by ff_rtsp_open_transport_ctx(), and srtp_get_multi_file_handle().

◆ ffurl_shutdown()

int ffurl_shutdown ( URLContext h,
int  flags 
)

Signal the URLContext that we are done reading or writing the stream.

Parameters
hpointer to the resource
flagsflags which control how the resource indicated by url is to be shutdown
Returns
a negative value if an error condition occurred, 0 otherwise

Definition at line 367 of file avio.c.

◆ ff_check_interrupt()

int ff_check_interrupt ( AVIOInterruptCB cb)

Check if the user has requested to interrupt a blocking function associated with cb.

Definition at line 374 of file avio.c.

Referenced by avformat_find_stream_info(), ff_listen_connect(), ff_poll_interrupt(), ff_rtsp_open_transport_ctx(), hls_read(), read_data(), retry_transfer_wrapper(), and rtp_read().

Variable Documentation

◆ options

const AVOption options[]
static
Initial value:
= {
{ "rw_timeout", "Timeout for IO operations (in microseconds)", 0x42, AV_OPT_TYPE_INT64, { .i64 = 0 }, 0, INT64_MAX, AV_OPT_FLAG_ENCODING_PARAM | AV_OPT_FLAG_DECODING_PARAM },
{ NULL }
}
#define AV_OPT_FLAG_ENCODING_PARAM
a generic parameter which can be set by the user for muxing or encoding
Definition: opt.h:264
NULL
Definition: eval.c:55
#define AV_OPT_FLAG_DECODING_PARAM
a generic parameter which can be set by the user for demuxing or decoding
Definition: opt.h:265

Definition at line 52 of file avio.c.

◆ ffurl_context_class

const AVClass ffurl_context_class
Initial value:
= {
.class_name = "URLContext",
.item_name = urlcontext_to_name,
.option = options,
.child_next = urlcontext_child_next,
.child_class_next = ff_urlcontext_child_class_next,
}
static void * urlcontext_child_next(void *obj, void *prev)
Definition: avio.c:44
const AVClass * ff_urlcontext_child_class_next(const AVClass *prev)
Definition: protocols.c:63
static const char * urlcontext_to_name(void *ptr)
Definition: avio.c:35
static const AVOption options[]
Definition: avio.c:52
LIBAVUTIL_VERSION_INT
Definition: eval.c:55

Definition at line 56 of file avio.c.

Referenced by io_priv_child_class_next(), and url_alloc_for_protocol().