#include "libavutil/avstring.h"
#include "libavutil/dict.h"
#include "libavutil/opt.h"
#include "libavutil/time.h"
#include "libavutil/avassert.h"
#include "os_support.h"
#include "internal.h"
#include "url.h"

Data Structures
struct	AVIODirContext

Logging context.
#define	OFFSET(x) offsetof(URLContext,x)

#define	E AV_OPT_FLAG_ENCODING_PARAM

#define	D AV_OPT_FLAG_DECODING_PARAM

#define	URL_SCHEME_CHARS

static const AVOption	options []

const AVClass	ffurl_context_class

static const char *	urlcontext_to_name (void *ptr)

static void *	urlcontext_child_next (void obj, void prev)

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

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

int	ffurl_accept (URLContext s, URLContext *c)
	Accept an URLContext c on an URLContext s. More...

int	ffurl_handshake (URLContext *c)
	Perform one step of the protocol handshake to accept a new client. More...

static const struct URLProtocol *	url_find_protocol (const char *filename)

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. More...

int	ffurl_open_whitelist (URLContext *puc, const char filename, int flags, const AVIOInterruptCB int_cb, AVDictionary options, const char whitelist, const char blacklist, 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, const uint8_t *cbuf, int size, int size_min, int read)

int	ffurl_read2 (void urlcontext, uint8_t buf, int size)

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_write2 (void urlcontext, const uint8_t buf, int size)

int64_t	ffurl_seek2 (void *urlcontext, int64_t pos, int whence)

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

int	ffurl_close (URLContext *h)

const char *	avio_find_protocol_name (const char *url)
	Return the name of the protocol that will handle the passed URL. 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...

int	ffurl_move (const char url_src, const char url_dst)
	Move or rename a resource. More...

int	ffurl_delete (const char *url)
	Delete a resource. More...

int	avio_open_dir (AVIODirContext *s, const char url, AVDictionary **options)
	Open directory for reading. More...

int	avio_read_dir (AVIODirContext s, AVIODirEntry *next)
	Get next directory entry. More...

int	avio_close_dir (AVIODirContext **s)
	Close directory. More...

void	avio_free_directory_entry (AVIODirEntry **entry)
	Free entry allocated by avio_read_dir(). 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_get_short_seek (void *urlcontext)
	Return the current short seek threshold value for 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...

int	ff_rename (const char url_src, const char url_dst, void *logctx)
	Wrap ffurl_move() and log if error happens. More...

Macro Definition Documentation

◆ OFFSET

#define OFFSET ( x ) offsetof(URLContext,x)

Definition at line 53 of file avio.c.

◆ E

#define E AV_OPT_FLAG_ENCODING_PARAM

Definition at line 54 of file avio.c.

◆ D

#define D AV_OPT_FLAG_DECODING_PARAM

Definition at line 55 of file avio.c.

◆ URL_SCHEME_CHARS

#define URL_SCHEME_CHARS

Value:

    "abcdefghijklmnopqrstuvwxyz"                \
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"                \
    "0123456789+-."

Definition at line 240 of file avio.c.

Function Documentation

◆ urlcontext_to_name()

static const char* urlcontext_to_name ( void * ptr )

static

Definition at line 36 of file avio.c.

◆ urlcontext_child_next()

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

static

Definition at line 45 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
	)

static

Definition at line 73 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

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

Referenced by avio_check(), ffurl_open_whitelist(), mmsh_open_internal(), and rtmp_http_open().

◆ ffurl_accept()

int ffurl_accept	(	URLContext *	s,
		URLContext **	c
	)

Accept an URLContext c on an URLContext s.

Parameters

s	server context
c	client context, must be unallocated.

Returns: >= 0 on success, ff_neterrno() on failure.

Definition at line 220 of file avio.c.

Referenced by avio_accept(), and http_accept().

◆ ffurl_handshake()

int ffurl_handshake ( URLContext * c )

Perform one step of the protocol handshake to accept a new client.

See avio_handshake() for details. Implementations should try to return decreasing values. If the protocol uses an underlying protocol, the underlying handshake is usually the first step, and the return value can be: (largest value for this protocol) + (return value from other protocol)

Parameters

c	the client context

Returns: >= 0 on success or a negative value corresponding to an AVERROR code on failure

Definition at line 228 of file avio.c.

Referenced by avio_handshake(), and http_handshake().

◆ url_find_protocol()

static const struct URLProtocol* url_find_protocol ( const char * filename )

static

Definition at line 245 of file avio.c.

Referenced by avio_find_protocol_name(), and ffurl_alloc().

◆ ffurl_alloc()

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

Referenced by avio_check(), avio_open_dir(), ffurl_delete(), ffurl_move(), ffurl_open_whitelist(), http_accept(), mmsh_open_internal(), rtmp_http_open(), and tcp_accept().

◆ ffurl_open_whitelist()

int ffurl_open_whitelist	(	URLContext **	puc,
		const char *	filename,
		int	flags,
		const AVIOInterruptCB *	int_cb,
		AVDictionary **	options,
		const char *	whitelist,
		const char *	blacklist,
		URLContext *	parent
	)

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

Referenced by async_open(), cache_open(), crypto_open2(), ff_tls_open_underlying(), ffio_open_whitelist(), ftp_connect_control_connection(), ftp_connect_data_connection(), gopher_open(), hls_read(), http_listen(), http_open_cnx_internal(), icecast_open(), ism_flush(), ism_seek(), md5_close(), mms_open(), prompeg_open(), rtmp_calc_swfhash(), rtmp_open(), rtmpe_open(), rtp_open(), rtsp_listen(), rtsp_read_setup(), sap_read_header(), sap_write_header(), srtp_open(), subfile_open(), tee_open(), and translate_ipfs_to_http().

◆ retry_transfer_wrapper()

static int retry_transfer_wrapper	(	URLContext *	h,
		uint8_t *	buf,
		const uint8_t *	cbuf,
		int	size,
		int	size_min,
		int	read
	)

inlinestatic

Definition at line 350 of file avio.c.

Referenced by ffurl_read2(), ffurl_read_complete(), and ffurl_write2().

◆ ffurl_read2()

int ffurl_read2	(	void *	urlcontext,
		uint8_t *	buf,
		int	size
	)

Definition at line 395 of file avio.c.

Referenced by ffio_fdopen(), ffio_geturlcontext(), and ffurl_read().

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

Referenced by 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_write2()

int ffurl_write2	(	void *	urlcontext,
		const uint8_t *	buf,
		int	size
	)

Definition at line 414 of file avio.c.

Referenced by ffio_fdopen(), and ffurl_write().

◆ ffurl_seek2()

int64_t ffurl_seek2	(	void *	urlcontext,
		int64_t	pos,
		int	whence
	)

Definition at line 428 of file avio.c.

Referenced by ffio_fdopen(), and ffurl_seek().

◆ ffurl_closep()

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

Referenced by async_close(), async_open(), cache_close(), concat_close(), crypto_close(), ff_rtsp_undo_setup(), ff_tls_close(), ffurl_close(), ffurl_open_whitelist(), ftp_abort(), ftp_close_both_connections(), ftp_close_data_connection(), ftp_close_dir(), ftp_open_dir(), gopher_close(), hls_close(), hls_read(), http_accept(), http_buf_read(), http_close(), http_open_cnx(), icecast_close(), ipfs_close(), ism_flush(), ism_free(), ism_seek(), mms_close(), mmsh_close(), mmsh_open_internal(), prompeg_close(), prompeg_open(), rtmp_close(), rtmp_http_close(), rtmp_open(), rtmpe_close(), rtp_close(), rtp_open(), rtsp_read_setup(), sap_read_close(), sap_write_close(), srtp_close(), subfile_close(), subfile_open(), tcp_accept(), tee_close(), and tls_close().

◆ ffurl_close()

int ffurl_close ( URLContext * h )

Definition at line 462 of file avio.c.

Referenced by avio_check(), avio_close(), avio_close_dir(), avio_open_dir(), ff_rtp_chain_mux_open(), ffio_open_whitelist(), ffurl_delete(), ffurl_move(), http_seek_internal(), md5_close(), and rtmp_calc_swfhash().

◆ avio_find_protocol_name()

const char* avio_find_protocol_name ( const char * url )

Return the name of the protocol that will handle the passed URL.

NULL is returned if no protocol could be found for the given URL.

Returns: Name of the protocol or NULL.

Definition at line 468 of file avio.c.

Referenced by add_file(), assert_file_overwrite(), create_master_playlist(), dash_flush(), dash_write_packet(), ff_configure_buffers_for_index(), ff_is_http_proto(), format_name(), hls_delete_old_segments(), hls_start(), hls_window(), hls_write_packet(), hls_write_trailer(), ishttp(), open_url(), seg_init(), sls_flag_check_duration_size(), write_hls_media_playlist(), and write_manifest().

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

Referenced by assert_file_overwrite(), and find_image_range().

◆ ffurl_move()

int ffurl_move	(	const char *	url_src,
		const char *	url_dst
	)

Move or rename a resource.

Note: url_src and url_dst should share the same protocol and authority.

Parameters

url_src	url to resource to be moved
url_dst	new url to resource if the operation succeeded

Returns: >=0 on success or negative on error.

Definition at line 494 of file avio.c.

Referenced by ff_rename().

◆ ffurl_delete()

int ffurl_delete ( const char * url )

Delete a resource.

Parameters

url	resource to be deleted.

Returns: >=0 on success or negative on error.

Definition at line 516 of file avio.c.

Referenced by dashenc_delete_file().

◆ avio_open_dir()

int avio_open_dir	(	AVIODirContext **	s,
		const char *	url,
		AVDictionary **	options
	)

Open directory for reading.

Parameters

s	directory read context. Pointer to a NULL pointer must be passed.
url	directory to be listed.
options	A dictionary filled with protocol-private options. On return this parameter will be destroyed and replaced with a dictionary containing options that were not found. May be NULL.

Returns: >=0 on success or negative on error.

Examples: avio_list_dir.c.

Definition at line 538 of file avio.c.

Referenced by list_op().

◆ avio_read_dir()

int avio_read_dir	(	AVIODirContext *	s,
		AVIODirEntry **	next
	)

Get next directory entry.

Returned entry must be freed with avio_free_directory_entry(). In particular it may outlive AVIODirContext.

Parameters

	s	directory read context.
[out]	next	next entry or NULL when no more entries.

Returns: >=0 on success or negative on error. End of list is not considered an error.

Examples: avio_list_dir.c.

Definition at line 576 of file avio.c.

Referenced by list_op().

◆ avio_close_dir()

int avio_close_dir ( AVIODirContext ** s )

Close directory.

Note: Entries created using avio_read_dir() are not deleted and must be freeded with avio_free_directory_entry().

Parameters

s	directory read context.

Returns: >=0 on success or negative on error.

Examples: avio_list_dir.c.

Definition at line 589 of file avio.c.

Referenced by list_op().

◆ avio_free_directory_entry()

void avio_free_directory_entry ( AVIODirEntry ** entry )

Free entry allocated by avio_read_dir().

Parameters

entry entry to be freed.

Examples: avio_list_dir.c.

Definition at line 604 of file avio.c.

Referenced by avio_read_dir(), ftp_read_dir(), and list_op().

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

Referenced by async_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 627 of file avio.c.

Referenced by ftp_get_file_handle(), http_get_file_handle(), rtp_open(), rtsp_write_packet(), sap_fetch_packet(), sap_write_header(), srtp_get_file_handle(), and tls_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 634 of file avio.c.

Referenced by srtp_get_multi_file_handle().

◆ ffurl_get_short_seek()

int ffurl_get_short_seek ( void * urlcontext )

Return the current short seek threshold value for this URL.

Returns: threshold (>0) on success or <=0 on error.

Definition at line 651 of file avio.c.

Referenced by ffio_fdopen(), http_get_short_seek(), and tls_get_short_seek().

◆ ffurl_shutdown()

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

Referenced by dashenc_io_close(), ftp_shutdown(), and hlsenc_io_close().

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

Referenced by async_check_interrupt(), avformat_find_stream_info(), dash_read_packet(), failing_write_packet(), ff_listen_connect(), ff_network_sleep_interruptible(), ff_network_wait_fd_timeout(), ff_poll_interrupt(), get_current_fragment(), hls_read(), libsrt_network_wait_fd_timeout(), read_data(), reopen_demux_for_component(), retry_transfer_wrapper(), rtp_read(), start_connect_attempt(), tls_open(), and zmq_proto_wait_timeout().

◆ ff_rename()

int ff_rename	(	const char *	url_src,
		const char *	url_dst,
		void *	logctx
	)

Wrap ffurl_move() and log if error happens.

Parameters

url_src	source path
url_dst	destination path

Returns: 0 or AVERROR on failure

Definition at line 674 of file avio.c.

Referenced by create_master_playlist(), dash_flush(), hds_flush(), hls_rename_temp_file(), hls_window(), ism_flush(), segment_end(), sls_flag_file_rename(), write_abst(), write_hls_media_playlist(), write_manifest(), and write_packet().

Variable Documentation

◆ options

const AVOption options[]

static

Initial value:

= {
    {"protocol_whitelist", "List of protocols that are allowed to be used", OFFSET(protocol_whitelist), AV_OPT_TYPE_STRING, { .str = NULL },  0, 0, D },
    {"protocol_blacklist", "List of protocols that are not allowed to be used", OFFSET(protocol_blacklist), AV_OPT_TYPE_STRING, { .str = NULL },  0, 0, D },
    {"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 }
}

Definition at line 56 of file avio.c.

Referenced by avio_open_dir(), ffurl_connect(), and ffurl_open_whitelist().

◆ ffurl_context_class

const AVClass ffurl_context_class

Initial value:

= {
    .class_name       = "URLContext",
    .item_name        = urlcontext_to_name,
    .option           = options,
    .version          = LIBAVUTIL_VERSION_INT,
    .child_next       = urlcontext_child_next,
    .child_class_iterate = ff_urlcontext_child_class_iterate,
}

Definition at line 63 of file avio.c.

Referenced by child_class_iterate(), and url_alloc_for_protocol().

Data Structures

Logging context.

Macro Definition Documentation

◆ OFFSET

◆ E

◆ D

◆ URL_SCHEME_CHARS

Function Documentation

◆ urlcontext_to_name()

◆ urlcontext_child_next()

◆ url_alloc_for_protocol()

◆ ffurl_connect()

◆ ffurl_accept()

◆ ffurl_handshake()

◆ url_find_protocol()

◆ ffurl_alloc()

◆ ffurl_open_whitelist()

◆ retry_transfer_wrapper()

◆ ffurl_read2()

◆ ffurl_read_complete()

◆ ffurl_write2()

◆ ffurl_seek2()

◆ ffurl_closep()

◆ ffurl_close()

◆ avio_find_protocol_name()

◆ avio_check()

◆ ffurl_move()

◆ ffurl_delete()

◆ avio_open_dir()

◆ avio_read_dir()

◆ avio_close_dir()

◆ avio_free_directory_entry()

◆ ffurl_size()

◆ ffurl_get_file_handle()

◆ ffurl_get_multi_file_handle()

◆ ffurl_get_short_seek()

◆ ffurl_shutdown()

◆ ff_check_interrupt()

◆ ff_rename()

Variable Documentation

◆ options

◆ ffurl_context_class