unbuffered private I/O API More...

#include "avio.h"
#include "libavformat/version.h"
#include "libavutil/dict.h"
#include "libavutil/log.h"

Data Structures
struct	URLContext

struct	URLProtocol

Macros
#define	URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /< The protocol name can be the first part of a nested protocol scheme /

#define	URL_PROTOCOL_FLAG_NETWORK 2 /< The protocol uses network /

Functions
int	ffurl_alloc (URLContext *puc, const char filename, int flags, const AVIOInterruptCB *int_cb)
	Create a URLContext for accessing to the resource indicated by url, but do not initiate the connection yet.

int	ffurl_connect (URLContext uc, AVDictionary *options)
	Connect an URLContext that has been allocated by ffurl_alloc.

int	ffurl_open (URLContext *puc, const char filename, int flags, const AVIOInterruptCB int_cb, AVDictionary *options)
	Create an URLContext for accessing to the resource indicated by url, and open it.

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.

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.

int	ffurl_write (URLContext h, const unsigned char buf, int size)
	Write size bytes from buf to the resource accessed by h.

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.

int	ffurl_closep (URLContext **h)
	Close the resource accessed by the URLContext h, and free the memory used by it.

int	ffurl_close (URLContext *h)

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.

int	ffurl_get_file_handle (URLContext *h)
	Return the file descriptor associated with this URL.

int	ffurl_get_multi_file_handle (URLContext h, int handles, int numhandles)
	Return the file descriptors associated with this URL.

int	ffurl_shutdown (URLContext *h, int flags)
	Signal the URLContext that we are done reading or writing the stream.

int	ffurl_register_protocol (URLProtocol *protocol, int size)
	Register the URLProtocol protocol.

int	ff_check_interrupt (AVIOInterruptCB *cb)
	Check if the user has requested to interrup a blocking function associated with cb.

URLProtocol *	ffurl_protocol_next (URLProtocol *prev)
	Iterate over all available protocols.

int	ff_udp_set_remote_url (URLContext h, const char uri)
	If no filename is given to av_open_input_file because you want to get the local port first, then you must call this function to set the remote server address.

int	ff_udp_get_local_port (URLContext *h)
	Return the local port used by the UDP connection.

Variables
int(*	url_interrupt_cb )(void)

const AVClass	ffurl_context_class

Detailed Description

unbuffered private I/O API

Definition in file url.h.

Macro Definition Documentation

#define URL_PROTOCOL_FLAG_NESTED_SCHEME 1 /*< The protocol name can be the first part of a nested protocol scheme */

Definition at line 34 of file url.h.

Referenced by ffurl_alloc().

#define URL_PROTOCOL_FLAG_NETWORK 2 /*< The protocol uses network */

Definition at line 35 of file url.h.

Referenced by ffurl_closep(), and url_alloc_for_protocol().

Function Documentation

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

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

Parameters

puc	pointer to the location where, in case of success, the function puts the pointer to the created URLContext
flags	flags which control how the resource indicated by url is to be opened
int_cb	interrupt callback to use for the URLContext, may be NULL

Returns: 0 in case of success, a negative value corresponding to an AVERROR code in case of failure

Definition at line 201 of file avio.c.

Referenced by avio_check(), ffurl_open(), mmsh_open_internal(), open_input(), and rtmp_http_open().

int ffurl_connect	(	URLContext *	uc,
		AVDictionary **	options
	)

Connect an URLContext that has been allocated by ffurl_alloc.

Parameters

options A 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 180 of file avio.c.

Referenced by avio_check(), ffurl_open(), mmsh_open_internal(), open_input(), and rtmp_http_open().

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

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

Parameters

puc	pointer to the location where, in case of success, the function puts the pointer to the created URLContext
flags	flags which control how the resource indicated by url is to be opened
int_cb	interrupt callback to use for the URLContext, may be NULL
options	A 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.

Returns: 0 in case of success, a negative value corresponding to an AVERROR code in case of failure

Definition at line 237 of file avio.c.

Referenced by avio_open2(), cache_open(), concat_open(), crypto_open2(), gopher_open(), hls_read(), http_open_cnx(), ism_flush(), ism_seek(), md5_close(), mms_open(), open_input(), rtmp_calc_swfhash(), rtmp_open(), rtmpe_open(), rtp_new_av_stream(), rtp_open(), rtsp_listen(), rtsp_read_setup(), sap_read_header(), sap_write_header(), and tls_open().

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 293 of file avio.c.

Referenced by cache_read(), concat_read(), crypto_read(), ff_rtmp_packet_read(), ffio_fdopen(), gopher_read(), hls_read(), http_buf_read(), http_getc(), read_data(), rtmp_http_open(), rtmp_http_read(), rtmp_http_send_cmd(), rtmp_write(), rtmpe_read(), sap_fetch_packet(), and sap_read_header().

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 300 of file avio.c.

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

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

Write size bytes from buf to the resource accessed by h.

Returns: the number of bytes actually written, or a negative value corresponding to an AVERROR code in case of failure

Definition at line 307 of file avio.c.

Referenced by ff_rtmp_packet_write(), ff_rtp_check_and_send_back_rr(), ff_rtp_send_punch_packets(), ffio_fdopen(), gopher_write(), http_connect(), http_send_data(), http_shutdown(), http_write(), ism_write(), md5_close(), rtmp_handshake(), rtmp_send_hs_packet(), rtmp_server_handshake(), rtmpe_write(), rtp_write(), rtsp_send_reply(), sap_write_close(), sap_write_packet(), send_command_packet(), and tcp_write_packet().

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

pos	specifies the new position to set
whence	specifies 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 318 of file avio.c.

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

int ffurl_closep ( URLContext ** h )

Close the resource accessed by the URLContext h, and free the memory used by it.

Also set the URLContext pointer to NULL.

Returns: a negative value if an error condition occurred, 0 otherwise

Definition at line 328 of file avio.c.

Referenced by ffurl_close(), http_close(), and http_open_cnx().

int ffurl_close ( URLContext * h )

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 374 of file avio.c.

Referenced by concat_open().

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 389 of file avio.c.

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

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 396 of file avio.c.

int ffurl_shutdown	(	URLContext *	h,
		int	flags
	)

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

Parameters

h	pointer to the resource
flags	flags 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 411 of file avio.c.

int ffurl_register_protocol	(	URLProtocol *	protocol,
		int	size
	)

Register the URLProtocol protocol.

Parameters

size	the size of the URLProtocol struct referenced

Definition at line 96 of file avio.c.

int ff_check_interrupt ( AVIOInterruptCB * cb )

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

Definition at line 418 of file avio.c.

Referenced by avformat_find_stream_info(), do_tls_poll(), ff_network_wait_fd_timeout(), hls_read(), read_data(), retry_transfer_wrapper(), rtp_read(), and tcp_open().

URLProtocol* ffurl_protocol_next ( URLProtocol * prev )

Iterate over all available protocols.

Parameters

prev	result of the previous call to this functions or NULL.

Definition at line 35 of file avio.c.

Referenced by avio_enum_protocols(), ffurl_alloc(), and urlcontext_child_class_next().

int ff_udp_set_remote_url	(	URLContext *	h,
		const char *	uri
	)

If no filename is given to av_open_input_file because you want to get the local port first, then you must call this function to set the remote server address.

url syntax: udp://host:port[?option=val...] option: 'ttl=n' : set the ttl value (for multicast only) 'localport=n' : set the local port 'pkt_size=n' : set max packet size 'reuse=1' : enable reusing the socket 'overrun_nonfatal=1': survive in case of circular buffer overrun

Parameters