FFmpeg
|
unbuffered private I/O API More...
#include "avio.h"
#include "libavformat/version.h"
#include "libavutil/dict.h"
#include "libavutil/log.h"
Go to the source code of this file.
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. | |
int | ff_url_join (char *str, int size, const char *proto, const char *authorization, const char *hostname, int port, const char *fmt,...) av_printf_format(7 |
Assemble a URL string from components. | |
int void | ff_make_absolute_url (char *buf, int size, const char *base, const char *rel) |
Convert a relative url into an absolute url, given a base url. | |
Variables | |
int(* | url_interrupt_cb )(void) |
const AVClass | ffurl_context_class |
unbuffered private I/O API
Definition in file url.h.
#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().
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.
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 |
Definition at line 211 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.
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 190 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.
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. |
Definition at line 247 of file avio.c.
Referenced by avio_open2(), cache_open(), concat_open(), crypto_open2(), ftp_connect_control_connection(), ftp_connect_data_connection(), 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(), srtp_open(), 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.
Definition at line 303 of file avio.c.
Referenced by cache_read(), concat_read(), crypto_read(), ff_rtmp_packet_read(), ffio_fdopen(), ftp_getc(), ftp_read(), 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(), sap_read_header(), and srtp_read().
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 310 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.
Definition at line 317 of file avio.c.
Referenced by ff_rtmp_packet_write(), ff_rtp_check_and_send_back_rr(), ff_rtp_send_punch_packets(), ff_rtp_send_rtcp_feedback(), ffio_fdopen(), ftp_send_command(), ftp_write(), 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(), srtp_write(), 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.
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). |
Definition at line 328 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.
Definition at line 338 of file avio.c.
Referenced by ffurl_close(), ftp_abort(), ftp_close_both_connections(), ftp_close_data_connection(), ftp_open(), http_close(), http_open_cnx(), and mmsh_close().
int ffurl_close | ( | URLContext * | h | ) |
Definition at line 359 of file avio.c.
Referenced by avio_check(), avio_close(), avio_open2(), cache_close(), close_connection(), concat_close(), concat_open(), crypto_close(), ff_rtp_chain_mux_open(), ff_rtsp_undo_setup(), ffurl_open(), free_variant_list(), gopher_close(), hls_close(), hls_read(), hls_read_seek(), http_seek(), ism_flush(), ism_free(), ism_seek(), md5_close(), mms_close(), mmsh_open_internal(), open_input(), read_data(), recheck_discard_flags(), rtmp_calc_swfhash(), rtmp_close(), rtmp_http_close(), rtmp_open(), rtmpe_close(), rtp_close(), rtp_new_av_stream(), rtp_open(), rtsp_listen(), sap_read_close(), sap_write_close(), srtp_close(), tls_close(), and tls_open().
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 384 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.
Definition at line 399 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_open().
int ffurl_get_multi_file_handle | ( | URLContext * | h, |
int ** | handles, | ||
int * | numhandles | ||
) |
Return the file descriptors associated with this URL.
Definition at line 406 of file avio.c.
Referenced by srtp_get_multi_file_handle().
int ffurl_shutdown | ( | URLContext * | h, |
int | flags | ||
) |
Signal the URLContext that we are done reading or writing the stream.
h | pointer to the resource |
flags | flags which control how the resource indicated by url is to be shutdown |
Definition at line 421 of file avio.c.
Referenced by ftp_shutdown().
int ffurl_register_protocol | ( | URLProtocol * | protocol, |
int | size | ||
) |
Register the URLProtocol protocol.
size | the size of the URLProtocol struct referenced |
int ff_check_interrupt | ( | AVIOInterruptCB * | cb | ) |
Check if the user has requested to interrup a blocking function associated with cb.
Definition at line 428 of file avio.c.
Referenced by avformat_find_stream_info(), do_tls_poll(), ff_listen_connect(), ff_network_wait_fd_timeout(), ff_poll_interrupt(), hls_read(), read_data(), retry_transfer_wrapper(), and rtp_read().
URLProtocol* ffurl_protocol_next | ( | URLProtocol * | prev | ) |
Iterate over all available protocols.
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
h | media file context |
uri | of the remote server |
Definition at line 382 of file udp.c.
Referenced by ff_rtp_set_remote_url(), and udp_open().
int ff_udp_get_local_port | ( | URLContext * | h | ) |
Return the local port used by the UDP connection.
h | media file context |
Definition at line 421 of file udp.c.
Referenced by ff_rtp_get_local_rtcp_port(), ff_rtp_get_local_rtp_port(), and rtp_open().
int ff_url_join | ( | char * | str, |
int | size, | ||
const char * | proto, | ||
const char * | authorization, | ||
const char * | hostname, | ||
int | port, | ||
const char * | fmt, | ||
... | |||
) |
Assemble a URL string from components.
This is the reverse operation of av_url_split.
Note, this requires networking to be initialized, so the caller must ensure ff_network_init has been called.
str | the buffer to fill with the url |
size | the size of the str buffer |
proto | the protocol identifier, if null, the separator after the identifier is left out, too |
authorization | an optional authorization string, may be null. An empty string is treated the same as a null string. |
hostname | the host name string |
port | the port number, left out from the string if negative |
fmt | a generic format string for everything to add after the host/port, may be null |
int void ff_make_absolute_url | ( | char * | buf, |
int | size, | ||
const char * | base, | ||
const char * | rel | ||
) |
Convert a relative url into an absolute url, given a base url.
buf | the buffer where output absolute url is written |
size | the size of buf |
base | the base url, may be equal to buf. |
rel | the new url, which is interpreted relative to base |
Definition at line 80 of file url.c.
Referenced by add_file(), new_variant(), parse_playlist(), process_line(), and test().
int(* url_interrupt_cb)(void) |
const AVClass ffurl_context_class |
Definition at line 75 of file avio.c.
Referenced by ffio_url_child_class_next(), and url_alloc_for_protocol().