Pluggable RTP Architecture. More...

#include "asterisk/astobj2.h"
#include "asterisk/frame.h"
#include "asterisk/format_cap.h"
#include "asterisk/netsock2.h"
#include "asterisk/sched.h"
#include "asterisk/res_srtp.h"
#include "asterisk/stasis.h"
#include "asterisk/vector.h"
#include "asterisk/logger_category.h"

Include dependency graph for rtp_engine.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_rtp_codecs

struct	ast_rtp_dtls_cfg
	DTLS configuration structure. More...

struct	ast_rtp_engine

struct	ast_rtp_engine_dtls
	Structure that represents the optional DTLS SRTP support within an RTP engine. More...

struct	ast_rtp_engine_ice
	Structure that represents the optional ICE support within an RTP engine. More...

struct	ast_rtp_engine_ice_candidate
	Structure for an ICE candidate. More...

struct	ast_rtp_glue

struct	ast_rtp_instance_stats

struct	ast_rtp_payload_type

struct	ast_rtp_rtcp_feedback
	An object that represents data received in a feedback report. More...

struct	ast_rtp_rtcp_feedback_remb
	A REMB feedback message (see draft-alvestrand-rmcat-remb-03 for details) More...

struct	ast_rtp_rtcp_report
	An object that represents data sent during a SR/RR RTCP report. More...

struct	ast_rtp_rtcp_report_block
	A report block within a SR/RR report. More...

Macros
#define	AST_DEBUG_CATEGORY_DTLS ast_debug_category_dtls_id() /* DTLS debug logging category id */

#define	AST_DEBUG_CATEGORY_DTLS_PACKET ast_debug_category_dtls_packet_id() /* DTLS packet debug logging category id */

#define	AST_DEBUG_CATEGORY_ICE ast_debug_category_ice_id() /* ICE debug logging category id */

#define	AST_DEBUG_CATEGORY_RTCP ast_debug_category_rtcp_id() /* RTCP debug logging category id */

#define	AST_DEBUG_CATEGORY_RTCP_PACKET ast_debug_category_rtcp_packet_id() /* RTCP packet debug logging category id */

#define	AST_DEBUG_CATEGORY_RTP ast_debug_category_rtp_id() /* RTP debug logging category id */

#define	AST_DEBUG_CATEGORY_RTP_PACKET ast_debug_category_rtp_packet_id() /* RTP packet debug logging category id */

#define	ast_debug_dtls(sublevel, ...) ast_debug_category(sublevel, AST_DEBUG_CATEGORY_DTLS, __VA_ARGS__)
	Log debug level DTLS information. More...

#define	ast_debug_dtls_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_DTLS_PACKET)

#define	ast_debug_ice(sublevel, ...) ast_debug_category(sublevel, AST_DEBUG_CATEGORY_ICE, __VA_ARGS__)
	Log debug level ICE information. More...

#define	ast_debug_rtcp(sublevel, ...) ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTCP, __VA_ARGS__)
	Log debug level RTCP information. More...

#define	ast_debug_rtcp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP)

#define	ast_debug_rtcp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP_PACKET)

#define	ast_debug_rtp(sublevel, ...) ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTP, __VA_ARGS__)
	Log debug level RTP information. More...

#define	ast_debug_rtp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP)

#define	ast_debug_rtp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP_PACKET)

#define	AST_LOG_CATEGORY_DTLS "dtls"

#define	AST_LOG_CATEGORY_DTLS_PACKET "dtls_packet"

#define	AST_LOG_CATEGORY_ICE "ice"

#define	AST_LOG_CATEGORY_RTCP "rtcp"

#define	AST_LOG_CATEGORY_RTCP_PACKET "rtcp_packet"

#define	AST_LOG_CATEGORY_RTP "rtp"

#define	AST_LOG_CATEGORY_RTP_PACKET "rtp_packet"

#define	AST_RED_MAX_GENERATION 5

#define	AST_RTP_CISCO_DTMF (1 << 2)

#define	AST_RTP_CN (1 << 1)

#define	AST_RTP_CODECS_NULL_INIT

#define	AST_RTP_DTMF (1 << 0)

#define	ast_rtp_engine_register(engine) ast_rtp_engine_register2(engine, AST_MODULE_SELF)

#define	ast_rtp_glue_register(glue) ast_rtp_glue_register2(glue, AST_MODULE_SELF)

#define	ast_rtp_instance_get_and_cmp_remote_address(instance, address) ast_rtp_instance_get_and_cmp_requested_target_address((instance), (address))
	Get the address of the remote endpoint that we are sending RTP to, comparing its address to another. More...

#define	ast_rtp_instance_get_remote_address(instance, address) ast_rtp_instance_get_incoming_source_address((instance), (address))
	Get the address of the remote endpoint that we are sending RTP to. More...

#define	ast_rtp_instance_set_remote_address(instance, address) ast_rtp_instance_set_requested_target_address((instance), (address))
	Set the address of the remote endpoint that we are sending RTP to. More...

#define	AST_RTP_MAX AST_RTP_CISCO_DTMF

#define	AST_RTP_MAX_PT 128

#define	AST_RTP_PT_FIRST_DYNAMIC 96

#define	AST_RTP_PT_LAST_REASSIGN 63

#define	AST_RTP_PT_LAST_STATIC 34

#define	AST_RTP_RTCP_FMT_FIR 4

#define	AST_RTP_RTCP_FMT_NACK 1

#define	AST_RTP_RTCP_FMT_PLI 1

#define	AST_RTP_RTCP_FMT_REMB 15

#define	AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC 15

#define	AST_RTP_RTCP_PSFB 206

#define	AST_RTP_RTCP_RR 201

#define	AST_RTP_RTCP_RTPFB 205

#define	AST_RTP_RTCP_SR 200

#define	AST_RTP_STAT_SET(current_stat, combined, placement, value)

#define	AST_RTP_STAT_STRCPY(current_stat, combined, placement, value)

#define	AST_RTP_STAT_TERMINATOR(combined)

#define	DEFAULT_DTMF_SAMPLE_RATE_MS 8000

#define	MAX_CHANNEL_ID 152

Enumerations
enum	ast_rtp_dtls_connection { AST_RTP_DTLS_CONNECTION_NEW , AST_RTP_DTLS_CONNECTION_EXISTING }
	DTLS connection states. More...

enum	ast_rtp_dtls_hash { AST_RTP_DTLS_HASH_SHA256 , AST_RTP_DTLS_HASH_SHA1 }
	DTLS fingerprint hashes. More...

enum	ast_rtp_dtls_setup { AST_RTP_DTLS_SETUP_ACTIVE , AST_RTP_DTLS_SETUP_PASSIVE , AST_RTP_DTLS_SETUP_ACTPASS , AST_RTP_DTLS_SETUP_HOLDCONN }
	DTLS setup types. More...

enum	ast_rtp_dtls_verify { AST_RTP_DTLS_VERIFY_NONE = 0 , AST_RTP_DTLS_VERIFY_FINGERPRINT = (1 << 0) , AST_RTP_DTLS_VERIFY_CERTIFICATE = (1 << 1) }
	DTLS verification settings. More...

enum	ast_rtp_dtmf_mode { AST_RTP_DTMF_MODE_NONE = 0 , AST_RTP_DTMF_MODE_RFC2833 , AST_RTP_DTMF_MODE_INBAND }

enum	ast_rtp_extension { AST_RTP_EXTENSION_UNSUPPORTED = 0 , AST_RTP_EXTENSION_ABS_SEND_TIME , AST_RTP_EXTENSION_TRANSPORT_WIDE_CC , AST_RTP_EXTENSION_MAX }
	Known RTP extensions. More...

enum	ast_rtp_extension_direction { AST_RTP_EXTENSION_DIRECTION_NONE , AST_RTP_EXTENSION_DIRECTION_SENDRECV , AST_RTP_EXTENSION_DIRECTION_SENDONLY , AST_RTP_EXTENSION_DIRECTION_RECVONLY , AST_RTP_EXTENSION_DIRECTION_INACTIVE }
	Directions for RTP extensions. More...

enum	ast_rtp_glue_result { AST_RTP_GLUE_RESULT_FORBID = 0 , AST_RTP_GLUE_RESULT_REMOTE , AST_RTP_GLUE_RESULT_LOCAL }

enum	ast_rtp_ice_candidate_type { AST_RTP_ICE_CANDIDATE_TYPE_HOST , AST_RTP_ICE_CANDIDATE_TYPE_SRFLX , AST_RTP_ICE_CANDIDATE_TYPE_RELAYED }
	ICE candidate types. More...

enum	ast_rtp_ice_component_type { AST_RTP_ICE_COMPONENT_RTP = 1 , AST_RTP_ICE_COMPONENT_RTCP = 2 }
	ICE component types. More...

enum	ast_rtp_ice_role { AST_RTP_ICE_ROLE_CONTROLLED , AST_RTP_ICE_ROLE_CONTROLLING }
	ICE role during negotiation. More...

enum	ast_rtp_instance_rtcp { AST_RTP_INSTANCE_RTCP_DISABLED = 0 , AST_RTP_INSTANCE_RTCP_STANDARD , AST_RTP_INSTANCE_RTCP_MUX }

enum	ast_rtp_instance_stat { AST_RTP_INSTANCE_STAT_ALL = 0 , AST_RTP_INSTANCE_STAT_TXCOUNT , AST_RTP_INSTANCE_STAT_RXCOUNT , AST_RTP_INSTANCE_STAT_COMBINED_LOSS , AST_RTP_INSTANCE_STAT_TXPLOSS , AST_RTP_INSTANCE_STAT_RXPLOSS , AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS , AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS , AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS , AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS , AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS , AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS , AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS , AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS , AST_RTP_INSTANCE_STAT_COMBINED_JITTER , AST_RTP_INSTANCE_STAT_TXJITTER , AST_RTP_INSTANCE_STAT_RXJITTER , AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER , AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER , AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER , AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER , AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER , AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER , AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER , AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER , AST_RTP_INSTANCE_STAT_COMBINED_RTT , AST_RTP_INSTANCE_STAT_RTT , AST_RTP_INSTANCE_STAT_MAX_RTT , AST_RTP_INSTANCE_STAT_MIN_RTT , AST_RTP_INSTANCE_STAT_NORMDEVRTT , AST_RTP_INSTANCE_STAT_STDEVRTT , AST_RTP_INSTANCE_STAT_LOCAL_SSRC , AST_RTP_INSTANCE_STAT_REMOTE_SSRC , AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID , AST_RTP_INSTANCE_STAT_TXOCTETCOUNT , AST_RTP_INSTANCE_STAT_RXOCTETCOUNT , AST_RTP_INSTANCE_STAT_COMBINED_MES , AST_RTP_INSTANCE_STAT_TXMES , AST_RTP_INSTANCE_STAT_RXMES , AST_RTP_INSTANCE_STAT_REMOTE_MAXMES , AST_RTP_INSTANCE_STAT_REMOTE_MINMES , AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVMES , AST_RTP_INSTANCE_STAT_REMOTE_STDEVMES , AST_RTP_INSTANCE_STAT_LOCAL_MAXMES , AST_RTP_INSTANCE_STAT_LOCAL_MINMES , AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVMES , AST_RTP_INSTANCE_STAT_LOCAL_STDEVMES }

enum	ast_rtp_instance_stat_field { AST_RTP_INSTANCE_STAT_FIELD_QUALITY = 0 , AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER , AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS , AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT , AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES }

enum	ast_rtp_options { AST_RTP_OPT_G726_NONSTANDARD = (1 << 0) }

enum	ast_rtp_property { AST_RTP_PROPERTY_NAT = 0 , AST_RTP_PROPERTY_DTMF , AST_RTP_PROPERTY_DTMF_COMPENSATE , AST_RTP_PROPERTY_STUN , AST_RTP_PROPERTY_RTCP , AST_RTP_PROPERTY_ASYMMETRIC_CODEC , AST_RTP_PROPERTY_RETRANS_RECV , AST_RTP_PROPERTY_RETRANS_SEND , AST_RTP_PROPERTY_REMB , AST_RTP_PROPERTY_MAX }

Functions
uintmax_t	ast_debug_category_dtls_id (void)

uintmax_t	ast_debug_category_dtls_packet_id (void)

uintmax_t	ast_debug_category_ice_id (void)

uintmax_t	ast_debug_category_rtcp_id (void)

uintmax_t	ast_debug_category_rtcp_packet_id (void)

uintmax_t	ast_debug_category_rtp_id (void)

uintmax_t	ast_debug_category_rtp_packet_id (void)

int	ast_rtp_codecs_find_payload_code (struct ast_rtp_codecs *codecs, int payload)
	Search for the tx payload type in the ast_rtp_codecs structure. More...

unsigned int	ast_rtp_codecs_get_framing (struct ast_rtp_codecs *codecs)
	Get the framing used for a set of codecs. More...

struct ast_rtp_payload_type *	ast_rtp_codecs_get_payload (struct ast_rtp_codecs *codecs, int payload)
	Retrieve rx payload mapped information by payload type. More...

struct ast_format *	ast_rtp_codecs_get_payload_format (struct ast_rtp_codecs *codecs, int payload)
	Retrieve the actual ast_format stored on the codecs structure for a specific tx payload type. More...

int	ast_rtp_codecs_get_preferred_dtmf_format_pt (struct ast_rtp_codecs *codecs)
	Retrieve rx preferred dtmf format payload type. More...

int	ast_rtp_codecs_get_preferred_dtmf_format_rate (struct ast_rtp_codecs *codecs)
	Retrieve rx preferred dtmf format sample rate. More...

struct ast_format *	ast_rtp_codecs_get_preferred_format (struct ast_rtp_codecs *codecs)
	Retrieve rx preferred format. More...

enum ast_media_type	ast_rtp_codecs_get_stream_type (struct ast_rtp_codecs *codecs)
	Determine the type of RTP stream media from the codecs mapped. More...

int	ast_rtp_codecs_payload_code (struct ast_rtp_codecs codecs, int asterisk_format, struct ast_format format, int code)
	Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code. More...

int	ast_rtp_codecs_payload_code_sample_rate (struct ast_rtp_codecs codecs, int asterisk_format, struct ast_format format, int code, unsigned int sample_rate)
	Retrieve a rx mapped payload type based on whether it is an Asterisk format, the code and the sample rate. More...

int	ast_rtp_codecs_payload_code_tx (struct ast_rtp_codecs codecs, int asterisk_format, const struct ast_format format, int code)
	Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code. More...

int	ast_rtp_codecs_payload_code_tx_sample_rate (struct ast_rtp_codecs codecs, int asterisk_format, const struct ast_format format, int code, unsigned int sample_rate)
	Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code. More...

void	ast_rtp_codecs_payload_formats (struct ast_rtp_codecs codecs, struct ast_format_cap astformats, int *nonastformats)
	Retrieve all formats that were found. More...

int	ast_rtp_codecs_payload_replace_format (struct ast_rtp_codecs codecs, int payload, struct ast_format format)
	Update the format associated with a tx payload type in a codecs structure. More...

int	ast_rtp_codecs_payload_set_rx (struct ast_rtp_codecs codecs, int code, struct ast_format format)
	Set a payload code for use with a specific Asterisk format. More...

int	ast_rtp_codecs_payload_set_rx_sample_rate (struct ast_rtp_codecs codecs, int code, struct ast_format format, unsigned int sample_rate)
	Set a payload code with sample rate for use with a specific Asterisk format. More...

void	ast_rtp_codecs_payloads_clear (struct ast_rtp_codecs codecs, struct ast_rtp_instance instance)
	Clear rx and tx payload mapping information from an RTP instance. More...

void	ast_rtp_codecs_payloads_copy (struct ast_rtp_codecs src, struct ast_rtp_codecs dest, struct ast_rtp_instance *instance)
	Copy payload information from one RTP instance to another. More...

void	ast_rtp_codecs_payloads_destroy (struct ast_rtp_codecs *codecs)
	Destroy the contents of an RTP codecs structure (but not the structure itself) More...

int	ast_rtp_codecs_payloads_initialize (struct ast_rtp_codecs *codecs)
	Initialize an RTP codecs structure. More...

void	ast_rtp_codecs_payloads_set_m_type (struct ast_rtp_codecs codecs, struct ast_rtp_instance instance, int payload)
	Record tx payload type information that was seen in an m= SDP line. More...

int	ast_rtp_codecs_payloads_set_rtpmap_type (struct ast_rtp_codecs codecs, struct ast_rtp_instance instance, int payload, char mimetype, char mimesubtype, enum ast_rtp_options options)
	Record tx payload type information that was seen in an a=rtpmap: SDP line. More...

int	ast_rtp_codecs_payloads_set_rtpmap_type_rate (struct ast_rtp_codecs codecs, struct ast_rtp_instance instance, int pt, char mimetype, char mimesubtype, enum ast_rtp_options options, unsigned int sample_rate)
	Set tx payload type to a known MIME media type for a codec with a specific sample rate. More...

void	ast_rtp_codecs_payloads_unset (struct ast_rtp_codecs codecs, struct ast_rtp_instance instance, int payload)
	Remove tx payload type mapped information. More...

void	ast_rtp_codecs_payloads_xover (struct ast_rtp_codecs src, struct ast_rtp_codecs dest, struct ast_rtp_instance *instance)
	Crossover copy the tx payload mapping of src to the rx payload mapping of dest. More...

void	ast_rtp_codecs_set_framing (struct ast_rtp_codecs *codecs, unsigned int framing)
	Set the framing used for a set of codecs. More...

int	ast_rtp_codecs_set_preferred_dtmf_format (struct ast_rtp_codecs *codecs, int pt, int rate)
	Set the preferred dtmf format pt and sample rate. More...

int	ast_rtp_codecs_set_preferred_format (struct ast_rtp_codecs codecs, struct ast_format format)
	Set the preferred format. More...

struct ast_json *	ast_rtp_convert_stats_json (const struct ast_rtp_instance_stats *stats)
	Convert given stat instance into json format. More...

void	ast_rtp_dtls_cfg_copy (const struct ast_rtp_dtls_cfg src_cfg, struct ast_rtp_dtls_cfg dst_cfg)
	Copy contents of a DTLS configuration structure. More...

void	ast_rtp_dtls_cfg_free (struct ast_rtp_dtls_cfg *dtls_cfg)
	Free contents of a DTLS configuration structure. More...

int	ast_rtp_dtls_cfg_parse (struct ast_rtp_dtls_cfg dtls_cfg, const char name, const char *value)
	Parse DTLS related configuration options. More...

int	ast_rtp_dtls_cfg_validate (struct ast_rtp_dtls_cfg *dtls_cfg)
	Validates DTLS related configuration options. More...

struct ast_rtp_payload_type *	ast_rtp_engine_alloc_payload_type (void)
	Allocation routine for ast_rtp_payload_type. More...

int	ast_rtp_engine_load_format (struct ast_format *format)
	Custom formats declared in codecs.conf at startup must be communicated to the rtp_engine so their mime type can payload number can be initialized. More...

int	ast_rtp_engine_register2 (struct ast_rtp_engine engine, struct ast_module module)
	Register an RTP engine. More...

int	ast_rtp_engine_register_srtp (struct ast_srtp_res srtp_res, struct ast_srtp_policy_res policy_res)

int	ast_rtp_engine_srtp_is_registered (void)

int	ast_rtp_engine_unload_format (struct ast_format *format)
	Formats requiring the use of a format attribute interface must have that interface registered in order for the rtp engine to handle it correctly. If an attribute interface is unloaded, this function must be called to notify the rtp_engine. More...

int	ast_rtp_engine_unregister (struct ast_rtp_engine *engine)
	Unregister an RTP engine. More...

void	ast_rtp_engine_unregister_srtp (void)

int	ast_rtp_get_rate (const struct ast_format *format)
	Retrieve the sample rate of a format according to RTP specifications. More...

int	ast_rtp_glue_register2 (struct ast_rtp_glue glue, struct ast_module module)
	Register RTP glue. More...

int	ast_rtp_glue_unregister (struct ast_rtp_glue *glue)
	Unregister RTP glue. More...

int	ast_rtp_instance_activate (struct ast_rtp_instance *instance)
	Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance. More...

int	ast_rtp_instance_add_srtp_policy (struct ast_rtp_instance instance, struct ast_srtp_policy remote_policy, struct ast_srtp_policy *local_policy, int rtcp)
	Add or replace the SRTP policies for the given RTP instance. More...

void	ast_rtp_instance_available_formats (struct ast_rtp_instance instance, struct ast_format_cap to_endpoint, struct ast_format_cap to_asterisk, struct ast_format_cap result)
	Request the formats that can be transcoded. More...

int	ast_rtp_instance_bundle (struct ast_rtp_instance child, struct ast_rtp_instance parent)
	Request that an RTP instance be bundled with another. More...

void	ast_rtp_instance_change_source (struct ast_rtp_instance *instance)
	Indicate a new source of audio has dropped in and the ssrc should change. More...

int	ast_rtp_instance_destroy (struct ast_rtp_instance *instance)
	Destroy an RTP instance. More...

int	ast_rtp_instance_dtmf_begin (struct ast_rtp_instance *instance, char digit)
	Begin sending a DTMF digit. More...

int	ast_rtp_instance_dtmf_end (struct ast_rtp_instance *instance, char digit)
	Stop sending a DTMF digit. More...

int	ast_rtp_instance_dtmf_end_with_duration (struct ast_rtp_instance *instance, char digit, unsigned int duration)

enum ast_rtp_dtmf_mode	ast_rtp_instance_dtmf_mode_get (struct ast_rtp_instance *instance)
	Get the DTMF mode of an RTP instance. More...

int	ast_rtp_instance_dtmf_mode_set (struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
	Set the DTMF mode that should be used. More...

int	ast_rtp_instance_early_bridge (struct ast_channel c0, struct ast_channel c1)
	Early bridge two channels that use RTP instances. More...

void	ast_rtp_instance_early_bridge_make_compatible (struct ast_channel c_dst, struct ast_channel c_src)
	Make two channels compatible for early bridging. More...

void	ast_rtp_instance_extmap_clear (struct ast_rtp_instance *instance)
	Clear negotiated RTP extension information. More...

size_t	ast_rtp_instance_extmap_count (struct ast_rtp_instance *instance)
	Get the number of known unique identifiers. More...

int	ast_rtp_instance_extmap_enable (struct ast_rtp_instance *instance, int id, enum ast_rtp_extension extension, enum ast_rtp_extension_direction direction)
	Enable support for an RTP extension on an instance. More...

enum ast_rtp_extension_direction	ast_rtp_instance_extmap_get_direction (struct ast_rtp_instance *instance, int id)
	Retrieve the negotiated direction for an RTP extension id. More...

enum ast_rtp_extension	ast_rtp_instance_extmap_get_extension (struct ast_rtp_instance *instance, int id)
	Retrieve the extension for an RTP extension id. More...

int	ast_rtp_instance_extmap_get_id (struct ast_rtp_instance *instance, enum ast_rtp_extension extension)
	Retrieve the id for an RTP extension. More...

const char *	ast_rtp_instance_extmap_get_uri (struct ast_rtp_instance *instance, int id)
	Retrieve the URI for an RTP extension id. More...

int	ast_rtp_instance_extmap_negotiate (struct ast_rtp_instance instance, int id, enum ast_rtp_extension_direction direction, const char uri, const char *attributes)
	Negotiate received RTP extension information. More...

int	ast_rtp_instance_fd (struct ast_rtp_instance *instance, int rtcp)
	Get the file descriptor for an RTP session (or RTCP) More...

struct ast_rtp_glue *	ast_rtp_instance_get_active_glue (struct ast_rtp_instance *instance)
	Get the RTP glue in use on an RTP instance. More...

int	ast_rtp_instance_get_and_cmp_local_address (struct ast_rtp_instance instance, struct ast_sockaddr address)
	Get the address of the local endpoint that we are sending RTP to, comparing its address to another. More...

int	ast_rtp_instance_get_and_cmp_requested_target_address (struct ast_rtp_instance instance, struct ast_sockaddr address)
	Get the requested target address of the remote endpoint and compare it to the given address. More...

struct ast_rtp_instance *	ast_rtp_instance_get_bridged (struct ast_rtp_instance *instance)
	Get the other RTP instance that an instance is bridged to. More...

const char *	ast_rtp_instance_get_channel_id (struct ast_rtp_instance *instance)
	Get the unique ID of the channel that owns this RTP instance. More...

const char *	ast_rtp_instance_get_cname (struct ast_rtp_instance *rtp)
	Retrieve the CNAME used in RTCP SDES items. More...

struct ast_rtp_codecs *	ast_rtp_instance_get_codecs (struct ast_rtp_instance *instance)
	Get the codecs structure of an RTP instance. More...

void *	ast_rtp_instance_get_data (struct ast_rtp_instance *instance)
	Get the data portion of an RTP instance. More...

struct ast_rtp_engine_dtls *	ast_rtp_instance_get_dtls (struct ast_rtp_instance *instance)
	Obtain a pointer to the DTLS support present on an RTP instance. More...

struct ast_rtp_engine *	ast_rtp_instance_get_engine (struct ast_rtp_instance *instance)
	Get the RTP engine in use on an RTP instance. More...

void *	ast_rtp_instance_get_extended_prop (struct ast_rtp_instance *instance, int property)
	Get the value of an RTP instance extended property. More...

struct ast_rtp_glue *	ast_rtp_instance_get_glue (const char *type)
	Get the RTP glue that binds a channel to the RTP engine. More...

int	ast_rtp_instance_get_hold_timeout (struct ast_rtp_instance *instance)
	Get the RTP timeout value for when an RTP instance is on hold. More...

struct ast_rtp_engine_ice *	ast_rtp_instance_get_ice (struct ast_rtp_instance *instance)
	Obtain a pointer to the ICE support present on an RTP instance. More...

void	ast_rtp_instance_get_incoming_source_address (struct ast_rtp_instance instance, struct ast_sockaddr address)
	Get the incoming source address of the remote endpoint. More...

int	ast_rtp_instance_get_keepalive (struct ast_rtp_instance *instance)
	Get the RTP keepalive interval. More...

time_t	ast_rtp_instance_get_last_rx (const struct ast_rtp_instance *rtp)
	Get the last RTP reception time. More...

time_t	ast_rtp_instance_get_last_tx (const struct ast_rtp_instance *rtp)
	Get the last RTP transmission time. More...

void	ast_rtp_instance_get_local_address (struct ast_rtp_instance instance, struct ast_sockaddr address)
	Get the local address that we are expecting RTP on. More...

int	ast_rtp_instance_get_prop (struct ast_rtp_instance *instance, enum ast_rtp_property property)
	Get the value of an RTP instance property. More...

char *	ast_rtp_instance_get_quality (struct ast_rtp_instance instance, enum ast_rtp_instance_stat_field field, char buf, size_t size)
	Retrieve quality statistics about an RTP instance. More...

void	ast_rtp_instance_get_requested_target_address (struct ast_rtp_instance instance, struct ast_sockaddr address)
	Get the requested target address of the remote endpoint. More...

struct ast_srtp *	ast_rtp_instance_get_srtp (struct ast_rtp_instance *instance, int rtcp)
	Obtain the SRTP instance associated with an RTP instance. More...

unsigned int	ast_rtp_instance_get_ssrc (struct ast_rtp_instance *rtp)
	Retrieve the local SSRC value that we will be using. More...

int	ast_rtp_instance_get_stats (struct ast_rtp_instance instance, struct ast_rtp_instance_stats stats, enum ast_rtp_instance_stat stat)
	Retrieve statistics about an RTP instance. More...

struct ast_json *	ast_rtp_instance_get_stats_all_json (struct ast_rtp_instance *instance)
	Retrieve statistics about an RTP instance in json format. More...

int	ast_rtp_instance_get_timeout (struct ast_rtp_instance *instance)
	Get the RTP timeout value. More...

int	ast_rtp_instance_make_compatible (struct ast_channel chan, struct ast_rtp_instance instance, struct ast_channel *peer)
	Request that the underlying RTP engine make two RTP instances compatible with eachother. More...

struct ast_rtp_instance *	ast_rtp_instance_new (const char engine_name, struct ast_sched_context sched, const struct ast_sockaddr sa, void data)
	Create a new RTP instance. More...

struct ast_frame *	ast_rtp_instance_read (struct ast_rtp_instance *instance, int rtcp)
	Receive a frame over RTP. More...

int	ast_rtp_instance_sendcng (struct ast_rtp_instance *instance, int level)
	Send a comfort noise packet to the RTP instance. More...

void	ast_rtp_instance_set_bridged (struct ast_rtp_instance instance, struct ast_rtp_instance bridged)
	Set the other RTP instance that an instance is bridged to. More...

void	ast_rtp_instance_set_channel_id (struct ast_rtp_instance instance, const char uniqueid)
	Set the channel that owns this RTP instance. More...

void	ast_rtp_instance_set_data (struct ast_rtp_instance instance, void data)
	Set the data portion of an RTP instance. More...

void	ast_rtp_instance_set_extended_prop (struct ast_rtp_instance instance, int property, void value)
	Set the value of an RTP instance extended property. More...

void	ast_rtp_instance_set_hold_timeout (struct ast_rtp_instance *instance, int timeout)
	Set the RTP timeout value for when the instance is on hold. More...

int	ast_rtp_instance_set_incoming_source_address (struct ast_rtp_instance instance, const struct ast_sockaddr address)
	Set the incoming source address of the remote endpoint that we are sending RTP to. More...

void	ast_rtp_instance_set_keepalive (struct ast_rtp_instance *instance, int timeout)
	Set the RTP keepalive interval. More...

void	ast_rtp_instance_set_last_rx (struct ast_rtp_instance *rtp, time_t time)
	Set the last RTP reception time. More...

void	ast_rtp_instance_set_last_tx (struct ast_rtp_instance *rtp, time_t time)
	Set the last RTP transmission time. More...

int	ast_rtp_instance_set_local_address (struct ast_rtp_instance instance, const struct ast_sockaddr address)
	Set the address that we are expecting to receive RTP on. More...

void	ast_rtp_instance_set_prop (struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)
	Set the value of an RTP instance property. More...

int	ast_rtp_instance_set_qos (struct ast_rtp_instance instance, int tos, int cos, const char desc)
	Set QoS parameters on an RTP session. More...

int	ast_rtp_instance_set_read_format (struct ast_rtp_instance instance, struct ast_format format)
	Request that the underlying RTP engine provide audio frames in a specific format. More...

void	ast_rtp_instance_set_remote_ssrc (struct ast_rtp_instance *rtp, unsigned int ssrc)
	Set the remote SSRC for an RTP instance. More...

int	ast_rtp_instance_set_requested_target_address (struct ast_rtp_instance instance, const struct ast_sockaddr address)
	Set the requested target address of the remote endpoint. More...

void	ast_rtp_instance_set_stats_vars (struct ast_channel chan, struct ast_rtp_instance instance)
	Set standard statistics from an RTP instance on a channel. More...

void	ast_rtp_instance_set_stream_num (struct ast_rtp_instance *instance, int stream_num)
	Set the stream number for an RTP instance. More...

void	ast_rtp_instance_set_timeout (struct ast_rtp_instance *instance, int timeout)
	Set the RTP timeout value. More...

int	ast_rtp_instance_set_write_format (struct ast_rtp_instance instance, struct ast_format format)
	Tell underlying RTP engine that audio frames will be provided in a specific format. More...

void	ast_rtp_instance_stop (struct ast_rtp_instance *instance)
	Stop an RTP instance. More...

void	ast_rtp_instance_stun_request (struct ast_rtp_instance instance, struct ast_sockaddr suggestion, const char *username)
	Request that the underlying RTP engine send a STUN BIND request. More...

void	ast_rtp_instance_update_source (struct ast_rtp_instance *instance)
	Indicate that the RTP marker bit should be set on an RTP stream. More...

int	ast_rtp_instance_write (struct ast_rtp_instance instance, struct ast_frame frame)
	Send a frame out over RTP. More...

char *	ast_rtp_lookup_mime_multiple2 (struct ast_str buf, struct ast_format_cap ast_format_capability, int rtp_capability, const int asterisk_format, enum ast_rtp_options options)
	Convert formats into a string and put them into a buffer. More...

const char *	ast_rtp_lookup_mime_subtype2 (const int asterisk_format, const struct ast_format *format, int code, enum ast_rtp_options options)
	Retrieve mime subtype information on a payload. More...

unsigned int	ast_rtp_lookup_sample_rate2 (int asterisk_format, const struct ast_format *format, int code)
	Get the sample rate associated with known RTP payload types. More...

int	ast_rtp_payload_mapping_tx_is_present (struct ast_rtp_codecs codecs, const struct ast_rtp_payload_type to_match)
	Determine if a type of payload is already present in mappings. More...

void	ast_rtp_publish_rtcp_message (struct ast_rtp_instance rtp, struct stasis_message_type message_type, struct ast_rtp_rtcp_report report, struct ast_json blob)
	Publish an RTCP message to Stasis Message Bus API. More...

int	ast_rtp_red_buffer (struct ast_rtp_instance instance, struct ast_frame frame)
	Buffer a frame in an RTP instance for RED. More...

int	ast_rtp_red_init (struct ast_rtp_instance instance, int buffer_time, int payloads, int generations)
	Initialize RED support on an RTP instance. More...

struct stasis_message_type *	ast_rtp_rtcp_received_type (void)
	Message type for an RTCP message received from some external source. More...

struct ast_rtp_rtcp_report *	ast_rtp_rtcp_report_alloc (unsigned int report_blocks)
	Allocate an ao2 ref counted instance of ast_rtp_rtcp_report. More...

struct stasis_message_type *	ast_rtp_rtcp_sent_type (void)
	Message type for an RTCP message sent from this Asterisk instance. More...

struct stasis_topic *	ast_rtp_topic (void)
	Stasis Message Bus API topic for RTP and RTCP related messages More...

Detailed Description

Pluggable RTP Architecture.

Author: Joshua Colp jcolp.nosp@m.@dig.nosp@m.ium.c.nosp@m.om Asterisk RTP Engine API

Definition in file rtp_engine.h.

Macro Definition Documentation

◆ AST_DEBUG_CATEGORY_DTLS

#define AST_DEBUG_CATEGORY_DTLS ast_debug_category_dtls_id() /* DTLS debug logging category id */

Definition at line 3089 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_DTLS_PACKET

#define AST_DEBUG_CATEGORY_DTLS_PACKET ast_debug_category_dtls_packet_id() /* DTLS packet debug logging category id */

Definition at line 3090 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_ICE

#define AST_DEBUG_CATEGORY_ICE ast_debug_category_ice_id() /* ICE debug logging category id */

Definition at line 3091 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_RTCP

#define AST_DEBUG_CATEGORY_RTCP ast_debug_category_rtcp_id() /* RTCP debug logging category id */

Definition at line 3087 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_RTCP_PACKET

#define AST_DEBUG_CATEGORY_RTCP_PACKET ast_debug_category_rtcp_packet_id() /* RTCP packet debug logging category id */

Definition at line 3088 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_RTP

#define AST_DEBUG_CATEGORY_RTP ast_debug_category_rtp_id() /* RTP debug logging category id */

Definition at line 3085 of file rtp_engine.h.

◆ AST_DEBUG_CATEGORY_RTP_PACKET

#define AST_DEBUG_CATEGORY_RTP_PACKET ast_debug_category_rtp_packet_id() /* RTP packet debug logging category id */

Definition at line 3086 of file rtp_engine.h.

◆ ast_debug_dtls

#define ast_debug_dtls	(	sublevel,
		...
	)	ast_debug_category(sublevel, AST_DEBUG_CATEGORY_DTLS, __VA_ARGS__)

Log debug level DTLS information.

Parameters

sublevel	Debug output sublevel (>= 0)
...	String format and any associated arguments

Definition at line 3133 of file rtp_engine.h.

◆ ast_debug_dtls_packet_is_allowed

#define ast_debug_dtls_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_DTLS_PACKET)

Definition at line 3137 of file rtp_engine.h.

◆ ast_debug_ice

#define ast_debug_ice	(	sublevel,
		...
	)	ast_debug_category(sublevel, AST_DEBUG_CATEGORY_ICE, __VA_ARGS__)

Log debug level ICE information.

Parameters

sublevel	Debug output sublevel (>= 0)
...	String format and any associated arguments

Definition at line 3145 of file rtp_engine.h.

◆ ast_debug_rtcp

#define ast_debug_rtcp	(	sublevel,
		...
	)	ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTCP, __VA_ARGS__)

Log debug level RTCP information.

Parameters

sublevel	Debug output sublevel (>= 0)
...	String format and any associated arguments

Definition at line 3116 of file rtp_engine.h.

◆ ast_debug_rtcp_is_allowed

#define ast_debug_rtcp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP)

Definition at line 3120 of file rtp_engine.h.

◆ ast_debug_rtcp_packet_is_allowed

#define ast_debug_rtcp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP_PACKET)

Definition at line 3124 of file rtp_engine.h.

◆ ast_debug_rtp

#define ast_debug_rtp	(	sublevel,
		...
	)	ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTP, __VA_ARGS__)

Log debug level RTP information.

Parameters

sublevel	Debug output sublevel (>= 0)
...	String format and any associated arguments

Definition at line 3099 of file rtp_engine.h.

◆ ast_debug_rtp_is_allowed

#define ast_debug_rtp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP)

Definition at line 3103 of file rtp_engine.h.

◆ ast_debug_rtp_packet_is_allowed

#define ast_debug_rtp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP_PACKET)

Definition at line 3107 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_DTLS

#define AST_LOG_CATEGORY_DTLS "dtls"

Definition at line 3071 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_DTLS_PACKET

#define AST_LOG_CATEGORY_DTLS_PACKET "dtls_packet"

Definition at line 3073 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_ICE

#define AST_LOG_CATEGORY_ICE "ice"

Definition at line 3075 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_RTCP

#define AST_LOG_CATEGORY_RTCP "rtcp"

Definition at line 3067 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_RTCP_PACKET

#define AST_LOG_CATEGORY_RTCP_PACKET "rtcp_packet"

Definition at line 3069 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_RTP

#define AST_LOG_CATEGORY_RTP "rtp"

Definition at line 3063 of file rtp_engine.h.

◆ AST_LOG_CATEGORY_RTP_PACKET

#define AST_LOG_CATEGORY_RTP_PACKET "rtp_packet"

Definition at line 3065 of file rtp_engine.h.

◆ AST_RED_MAX_GENERATION

#define AST_RED_MAX_GENERATION 5

Maximum number of generations

Definition at line 98 of file rtp_engine.h.

◆ AST_RTP_CISCO_DTMF

#define AST_RTP_CISCO_DTMF (1 << 2)

DTMF (Cisco Proprietary)

Definition at line 298 of file rtp_engine.h.

◆ AST_RTP_CN

#define AST_RTP_CN (1 << 1)

'Comfort Noise' (RFC3389)

Definition at line 296 of file rtp_engine.h.

◆ AST_RTP_CODECS_NULL_INIT

#define AST_RTP_CODECS_NULL_INIT

Value:

{ .codecs_lock = AST_RWLOCK_INIT_VALUE, .payload_mapping_rx = { 0, }, .payload_mapping_tx = { 0, }, .framing = 0, .preferred_format = NULL, \

.preferred_dtmf_rate = -1, .preferred_dtmf_pt = -1}

AST_RWLOCK_INIT_VALUE

#define AST_RWLOCK_INIT_VALUE

Definition: lock.h:98

NULL

#define NULL

Definition: resample.c:96

Definition at line 773 of file rtp_engine.h.

◆ AST_RTP_DTMF

#define AST_RTP_DTMF (1 << 0)

DTMF (RFC2833)

Definition at line 294 of file rtp_engine.h.

◆ ast_rtp_engine_register

#define ast_rtp_engine_register ( engine ) ast_rtp_engine_register2(engine, AST_MODULE_SELF)

Definition at line 852 of file rtp_engine.h.

◆ ast_rtp_glue_register

#define ast_rtp_glue_register ( glue ) ast_rtp_glue_register2(glue, AST_MODULE_SELF)

Definition at line 905 of file rtp_engine.h.

◆ ast_rtp_instance_get_and_cmp_remote_address

#define ast_rtp_instance_get_and_cmp_remote_address	(	instance,
		address
	)	ast_rtp_instance_get_and_cmp_requested_target_address((instance), (address))

Get the address of the remote endpoint that we are sending RTP to, comparing its address to another.

Parameters

instance	The instance that we want to get the remote address for
address	An initialized address that may be overwritten if the remote address is different

Return values

0	address was not changed
1	address was changed Example usage:

struct ast_sockaddr address;
int ret;
ret = ast_rtp_instance_get_and_cmp_remote_address(instance, &address);

This retrieves the current remote address set on the instance pointed to by instance and puts the value into the address structure.

Since: 1.8

Definition at line 1286 of file rtp_engine.h.

◆ ast_rtp_instance_get_remote_address

#define ast_rtp_instance_get_remote_address	(	instance,
		address
	)	ast_rtp_instance_get_incoming_source_address((instance), (address))

Get the address of the remote endpoint that we are sending RTP to.

Parameters

instance	The instance that we want to get the remote address for
address	A structure to put the address into

Example usage:

struct ast_sockaddr address;

ast_rtp_instance_get_remote_address(instance, &address);

ast_rtp_instance_get_remote_address

#define ast_rtp_instance_get_remote_address(instance, address)

Get the address of the remote endpoint that we are sending RTP to.

Definition: rtp_engine.h:1250

This retrieves the current remote address set on the instance pointed to by instance and puts the value into the address structure.

Since: 1.8

Definition at line 1250 of file rtp_engine.h.

◆ ast_rtp_instance_set_remote_address

#define ast_rtp_instance_set_remote_address	(	instance,
		address
	)	ast_rtp_instance_set_requested_target_address((instance), (address))

Set the address of the remote endpoint that we are sending RTP to.

Parameters

instance	The RTP instance to change the address on
address	Address to set it to

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_set_remote_address(instance, &sin);

ast_rtp_instance_set_remote_address

#define ast_rtp_instance_set_remote_address(instance, address)

Set the address of the remote endpoint that we are sending RTP to.

Definition: rtp_engine.h:1138

This changes the remote address that RTP will be sent to on instance to the address given in the sin structure.

Since: 1.8

Definition at line 1138 of file rtp_engine.h.

◆ AST_RTP_MAX

#define AST_RTP_MAX AST_RTP_CISCO_DTMF

Maximum RTP-specific code

Definition at line 300 of file rtp_engine.h.

◆ AST_RTP_MAX_PT

#define AST_RTP_MAX_PT 128

Maximum number of payload types RTP can support.

Definition at line 83 of file rtp_engine.h.

◆ AST_RTP_PT_FIRST_DYNAMIC

#define AST_RTP_PT_FIRST_DYNAMIC 96

First dynamic RTP payload type

Definition at line 92 of file rtp_engine.h.

◆ AST_RTP_PT_LAST_REASSIGN

#define AST_RTP_PT_LAST_REASSIGN 63

Last reassignable RTP payload type

Definition at line 95 of file rtp_engine.h.

◆ AST_RTP_PT_LAST_STATIC

#define AST_RTP_PT_LAST_STATIC 34

Last RTP payload type statically assigned, see http://www.iana.org/assignments/rtp-parameters

Definition at line 89 of file rtp_engine.h.

◆ AST_RTP_RTCP_FMT_FIR

#define AST_RTP_RTCP_FMT_FIR 4

Full INTRA-frame Request (From RFC5104)

Definition at line 337 of file rtp_engine.h.

◆ AST_RTP_RTCP_FMT_NACK

#define AST_RTP_RTCP_FMT_NACK 1

Generic NACK (From RFC4585 also RFC5104)

Definition at line 333 of file rtp_engine.h.

◆ AST_RTP_RTCP_FMT_PLI

#define AST_RTP_RTCP_FMT_PLI 1

Picture loss indication (From RFC4585)

Definition at line 335 of file rtp_engine.h.

◆ AST_RTP_RTCP_FMT_REMB

#define AST_RTP_RTCP_FMT_REMB 15

REMB Information (From draft-alvestrand-rmcat-remb-03)

Definition at line 339 of file rtp_engine.h.

◆ AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC

#define AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC 15

Transport-wide congestion control feedback (From draft-holmer-rmcat-transport-wide-cc-extensions-01)

Definition at line 341 of file rtp_engine.h.

◆ AST_RTP_RTCP_PSFB

#define AST_RTP_RTCP_PSFB 206

Payload Specific Feed Back (From RFC4585 also RFC5104)

Definition at line 329 of file rtp_engine.h.

◆ AST_RTP_RTCP_RR

#define AST_RTP_RTCP_RR 201

Receiver Report

Definition at line 325 of file rtp_engine.h.

◆ AST_RTP_RTCP_RTPFB

#define AST_RTP_RTCP_RTPFB 205

Transport Layer Feed Back (From RFC4585 also RFC5104)

Definition at line 327 of file rtp_engine.h.

◆ AST_RTP_RTCP_SR

#define AST_RTP_RTCP_SR 200

Sender Report

Definition at line 323 of file rtp_engine.h.

◆ AST_RTP_STAT_SET

#define AST_RTP_STAT_SET	(	current_stat,
		combined,
		placement,
		value
	)

Definition at line 484 of file rtp_engine.h.

◆ AST_RTP_STAT_STRCPY

#define AST_RTP_STAT_STRCPY	(	current_stat,
		combined,
		placement,
		value
	)

Definition at line 492 of file rtp_engine.h.

◆ AST_RTP_STAT_TERMINATOR

#define AST_RTP_STAT_TERMINATOR ( combined )

Value:

if (stat == combined) { \
return 0; \
}

Definition at line 500 of file rtp_engine.h.

◆ DEFAULT_DTMF_SAMPLE_RATE_MS

#define DEFAULT_DTMF_SAMPLE_RATE_MS 8000

Definition at line 110 of file rtp_engine.h.

◆ MAX_CHANNEL_ID

#define MAX_CHANNEL_ID 152

Maximum size of an internal Asterisk channel unique ID.

Note: Must match the AST_MAX_UNIQUEID(AST_MAX_PUBLIC_UNIQUEID) value. We don't use that defined value directly here to avoid a hard dependency on channel.h. DTMF samples per second

Definition at line 109 of file rtp_engine.h.

Enumeration Type Documentation

◆ ast_rtp_dtls_connection

enum ast_rtp_dtls_connection

DTLS connection states.

Enumerator
AST_RTP_DTLS_CONNECTION_NEW	Endpoint wants to use a new connection
AST_RTP_DTLS_CONNECTION_EXISTING	Endpoint wishes to use existing connection

Definition at line 572 of file rtp_engine.h.

                             {
    AST_RTP_DTLS_CONNECTION_NEW,      /*!< Endpoint wants to use a new connection */
    AST_RTP_DTLS_CONNECTION_EXISTING, /*!< Endpoint wishes to use existing connection */
};

◆ ast_rtp_dtls_hash

enum ast_rtp_dtls_hash

DTLS fingerprint hashes.

Enumerator
AST_RTP_DTLS_HASH_SHA256	SHA-256 fingerprint hash
AST_RTP_DTLS_HASH_SHA1	SHA-1 fingerprint hash

Definition at line 578 of file rtp_engine.h.

                       {
    AST_RTP_DTLS_HASH_SHA256, /*!< SHA-256 fingerprint hash */
    AST_RTP_DTLS_HASH_SHA1,   /*!< SHA-1 fingerprint hash */
};

◆ ast_rtp_dtls_setup

enum ast_rtp_dtls_setup

DTLS setup types.

Enumerator
AST_RTP_DTLS_SETUP_ACTIVE	Endpoint is willing to inititate connections
AST_RTP_DTLS_SETUP_PASSIVE	Endpoint is willing to accept connections
AST_RTP_DTLS_SETUP_ACTPASS	Endpoint is willing to both accept and initiate connections
AST_RTP_DTLS_SETUP_HOLDCONN	Endpoint does not want the connection to be established right now

Definition at line 564 of file rtp_engine.h.

                        {
    AST_RTP_DTLS_SETUP_ACTIVE,   /*!< Endpoint is willing to inititate connections */
    AST_RTP_DTLS_SETUP_PASSIVE,  /*!< Endpoint is willing to accept connections */
    AST_RTP_DTLS_SETUP_ACTPASS,  /*!< Endpoint is willing to both accept and initiate connections */
    AST_RTP_DTLS_SETUP_HOLDCONN, /*!< Endpoint does not want the connection to be established right now */
};

◆ ast_rtp_dtls_verify

enum ast_rtp_dtls_verify

DTLS verification settings.

Enumerator
AST_RTP_DTLS_VERIFY_NONE	Don't verify anything
AST_RTP_DTLS_VERIFY_FINGERPRINT	Verify the fingerprint
AST_RTP_DTLS_VERIFY_CERTIFICATE	Verify the certificate

Definition at line 584 of file rtp_engine.h.

                         {
    AST_RTP_DTLS_VERIFY_NONE = 0,               /*!< Don't verify anything */
    AST_RTP_DTLS_VERIFY_FINGERPRINT = (1 << 0), /*!< Verify the fingerprint */
    AST_RTP_DTLS_VERIFY_CERTIFICATE = (1 << 1), /*!< Verify the certificate */
};

◆ ast_rtp_dtmf_mode

enum ast_rtp_dtmf_mode

RTP DTMF Modes

Enumerator
AST_RTP_DTMF_MODE_NONE	No DTMF is being carried over the RTP stream
AST_RTP_DTMF_MODE_RFC2833	DTMF is being carried out of band using RFC2833
AST_RTP_DTMF_MODE_INBAND	DTMF is being carried inband over the RTP stream

Definition at line 151 of file rtp_engine.h.

                       {
    /*! No DTMF is being carried over the RTP stream */
    AST_RTP_DTMF_MODE_NONE = 0,
    /*! DTMF is being carried out of band using RFC2833 */
    AST_RTP_DTMF_MODE_RFC2833,
    /*! DTMF is being carried inband over the RTP stream */
    AST_RTP_DTMF_MODE_INBAND,
};

◆ ast_rtp_extension

enum ast_rtp_extension

Known RTP extensions.

Enumerator
AST_RTP_EXTENSION_UNSUPPORTED	Per the RFC 0 should not be used, so we treat it as an unsupported extension placeholder
AST_RTP_EXTENSION_ABS_SEND_TIME	abs-send-time from https://tools.ietf.org/html/draft-alvestrand-rmcat-remb-03
AST_RTP_EXTENSION_TRANSPORT_WIDE_CC	transport-cc from https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01
AST_RTP_EXTENSION_MAX	The maximum number of known RTP extensions

Definition at line 593 of file rtp_engine.h.

                       {
    /*! Per the RFC 0 should not be used, so we treat it as an unsupported extension placeholder */
    AST_RTP_EXTENSION_UNSUPPORTED = 0,
    /*! abs-send-time from https://tools.ietf.org/html/draft-alvestrand-rmcat-remb-03 */
    AST_RTP_EXTENSION_ABS_SEND_TIME,
    /*! transport-cc from https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01 */
    AST_RTP_EXTENSION_TRANSPORT_WIDE_CC,
    /*! The maximum number of known RTP extensions */
    AST_RTP_EXTENSION_MAX,
};

◆ ast_rtp_extension_direction

enum ast_rtp_extension_direction

Directions for RTP extensions.

Enumerator
AST_RTP_EXTENSION_DIRECTION_NONE	The extension is not negotiated and is not flowing
AST_RTP_EXTENSION_DIRECTION_SENDRECV	Send and receive
AST_RTP_EXTENSION_DIRECTION_SENDONLY	Send only
AST_RTP_EXTENSION_DIRECTION_RECVONLY	Receive only
AST_RTP_EXTENSION_DIRECTION_INACTIVE	Negotiated but not sending or receiving

Definition at line 827 of file rtp_engine.h.

                                 {
    /*! The extension is not negotiated and is not flowing */
    AST_RTP_EXTENSION_DIRECTION_NONE,
    /*! Send and receive */
    AST_RTP_EXTENSION_DIRECTION_SENDRECV,
    /*! Send only */
    AST_RTP_EXTENSION_DIRECTION_SENDONLY,
    /*! Receive only */
    AST_RTP_EXTENSION_DIRECTION_RECVONLY,
    /*! Negotiated but not sending or receiving */
    AST_RTP_EXTENSION_DIRECTION_INACTIVE,
};

◆ ast_rtp_glue_result

enum ast_rtp_glue_result

Result codes when RTP glue is queried for information

Enumerator
AST_RTP_GLUE_RESULT_FORBID	No remote or local bridging is permitted
AST_RTP_GLUE_RESULT_REMOTE	Move RTP stream to be remote between devices directly
AST_RTP_GLUE_RESULT_LOCAL	Perform RTP engine level bridging if possible

Definition at line 161 of file rtp_engine.h.

                         {
    /*! No remote or local bridging is permitted */
    AST_RTP_GLUE_RESULT_FORBID = 0,
    /*! Move RTP stream to be remote between devices directly */
    AST_RTP_GLUE_RESULT_REMOTE,
    /*! Perform RTP engine level bridging if possible */
    AST_RTP_GLUE_RESULT_LOCAL,
};

◆ ast_rtp_ice_candidate_type

enum ast_rtp_ice_candidate_type

ICE candidate types.

Enumerator
AST_RTP_ICE_CANDIDATE_TYPE_HOST	ICE host candidate. A host candidate represents the actual local transport address in the host.
AST_RTP_ICE_CANDIDATE_TYPE_SRFLX	ICE server reflexive candidate, which represents the public mapped address of the local address.
AST_RTP_ICE_CANDIDATE_TYPE_RELAYED	ICE relayed candidate, which represents the address allocated in TURN server.

Definition at line 506 of file rtp_engine.h.

                                {
    AST_RTP_ICE_CANDIDATE_TYPE_HOST,    /*!< ICE host candidate. A host candidate represents the actual local transport address in the host. */
    AST_RTP_ICE_CANDIDATE_TYPE_SRFLX,   /*!< ICE server reflexive candidate, which represents the public mapped address of the local address. */
    AST_RTP_ICE_CANDIDATE_TYPE_RELAYED, /*!< ICE relayed candidate, which represents the address allocated in TURN server. */
};

◆ ast_rtp_ice_component_type

enum ast_rtp_ice_component_type

ICE component types.

Enumerator
AST_RTP_ICE_COMPONENT_RTP
AST_RTP_ICE_COMPONENT_RTCP

Definition at line 513 of file rtp_engine.h.

                                {
    AST_RTP_ICE_COMPONENT_RTP = 1,
    AST_RTP_ICE_COMPONENT_RTCP = 2,
};

◆ ast_rtp_ice_role

enum ast_rtp_ice_role

ICE role during negotiation.

Enumerator
AST_RTP_ICE_ROLE_CONTROLLED
AST_RTP_ICE_ROLE_CONTROLLING

Definition at line 519 of file rtp_engine.h.

                      {
    AST_RTP_ICE_ROLE_CONTROLLED,
    AST_RTP_ICE_ROLE_CONTROLLING,
};

◆ ast_rtp_instance_rtcp

enum ast_rtp_instance_rtcp

Enumerator
AST_RTP_INSTANCE_RTCP_DISABLED	RTCP should not be sent/received
AST_RTP_INSTANCE_RTCP_STANDARD	RTCP should be sent/received based on standard port rules
AST_RTP_INSTANCE_RTCP_MUX	RTCP should be sent/received on the same port as RTP

Definition at line 283 of file rtp_engine.h.

                           {
    /*! RTCP should not be sent/received */
    AST_RTP_INSTANCE_RTCP_DISABLED = 0,
    /*! RTCP should be sent/received based on standard port rules */
    AST_RTP_INSTANCE_RTCP_STANDARD,
    /*! RTCP should be sent/received on the same port as RTP */
    AST_RTP_INSTANCE_RTCP_MUX,
};

◆ ast_rtp_instance_stat

enum ast_rtp_instance_stat

Statistics that can be retrieved from an RTP instance

Enumerator
AST_RTP_INSTANCE_STAT_ALL	Retrieve all statistics
AST_RTP_INSTANCE_STAT_TXCOUNT	Retrieve number of packets transmitted
AST_RTP_INSTANCE_STAT_RXCOUNT	Retrieve number of packets received
AST_RTP_INSTANCE_STAT_COMBINED_LOSS	Retrieve ALL statistics relating to packet loss
AST_RTP_INSTANCE_STAT_TXPLOSS	Retrieve number of packets lost for transmitting
AST_RTP_INSTANCE_STAT_RXPLOSS	Retrieve number of packets lost for receiving
AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS	Retrieve maximum number of packets lost on remote side
AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS	Retrieve minimum number of packets lost on remote side
AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS	Retrieve average number of packets lost on remote side
AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS	Retrieve standard deviation of packets lost on remote side
AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS	Retrieve maximum number of packets lost on local side
AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS	Retrieve minimum number of packets lost on local side
AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS	Retrieve average number of packets lost on local side
AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS	Retrieve standard deviation of packets lost on local side
AST_RTP_INSTANCE_STAT_COMBINED_JITTER	Retrieve ALL statistics relating to jitter
AST_RTP_INSTANCE_STAT_TXJITTER	Retrieve jitter on transmitted packets
AST_RTP_INSTANCE_STAT_RXJITTER	Retrieve jitter on received packets
AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER	Retrieve maximum jitter on remote side
AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER	Retrieve minimum jitter on remote side
AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER	Retrieve average jitter on remote side
AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER	Retrieve standard deviation jitter on remote side
AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER	Retrieve maximum jitter on local side
AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER	Retrieve minimum jitter on local side
AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER	Retrieve average jitter on local side
AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER	Retrieve standard deviation jitter on local side
AST_RTP_INSTANCE_STAT_COMBINED_RTT	Retrieve ALL statistics relating to round trip time
AST_RTP_INSTANCE_STAT_RTT	Retrieve round trip time
AST_RTP_INSTANCE_STAT_MAX_RTT	Retrieve maximum round trip time
AST_RTP_INSTANCE_STAT_MIN_RTT	Retrieve minimum round trip time
AST_RTP_INSTANCE_STAT_NORMDEVRTT	Retrieve average round trip time
AST_RTP_INSTANCE_STAT_STDEVRTT	Retrieve standard deviation round trip time
AST_RTP_INSTANCE_STAT_LOCAL_SSRC	Retrieve local SSRC
AST_RTP_INSTANCE_STAT_REMOTE_SSRC	Retrieve remote SSRC
AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID	Retrieve channel unique ID
AST_RTP_INSTANCE_STAT_TXOCTETCOUNT	Retrieve number of octets transmitted
AST_RTP_INSTANCE_STAT_RXOCTETCOUNT	Retrieve number of octets received
AST_RTP_INSTANCE_STAT_COMBINED_MES	Retrieve ALL statistics relating to Media Experience Score
AST_RTP_INSTANCE_STAT_TXMES	Retrieve MES on transmitted packets
AST_RTP_INSTANCE_STAT_RXMES	Retrieve MES on received packets
AST_RTP_INSTANCE_STAT_REMOTE_MAXMES	Retrieve maximum MES on remote side
AST_RTP_INSTANCE_STAT_REMOTE_MINMES	Retrieve minimum MES on remote side
AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVMES	Retrieve average MES on remote side
AST_RTP_INSTANCE_STAT_REMOTE_STDEVMES	Retrieve standard deviation MES on remote side
AST_RTP_INSTANCE_STAT_LOCAL_MAXMES	Retrieve maximum MES on local side
AST_RTP_INSTANCE_STAT_LOCAL_MINMES	Retrieve minimum MES on local side
AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVMES	Retrieve average MES on local side
AST_RTP_INSTANCE_STAT_LOCAL_STDEVMES	Retrieve standard deviation MES on local side

Definition at line 185 of file rtp_engine.h.

                           {
    /*! Retrieve all statistics */
    AST_RTP_INSTANCE_STAT_ALL = 0,
    /*! Retrieve number of packets transmitted */
    AST_RTP_INSTANCE_STAT_TXCOUNT,
    /*! Retrieve number of packets received */
    AST_RTP_INSTANCE_STAT_RXCOUNT,
    /*! Retrieve ALL statistics relating to packet loss */
    AST_RTP_INSTANCE_STAT_COMBINED_LOSS,
    /*! Retrieve number of packets lost for transmitting */
    AST_RTP_INSTANCE_STAT_TXPLOSS,
    /*! Retrieve number of packets lost for receiving */
    AST_RTP_INSTANCE_STAT_RXPLOSS,
    /*! Retrieve maximum number of packets lost on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS,
    /*! Retrieve minimum number of packets lost on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS,
    /*! Retrieve average number of packets lost on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS,
    /*! Retrieve standard deviation of packets lost on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS,
    /*! Retrieve maximum number of packets lost on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS,
    /*! Retrieve minimum number of packets lost on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS,
    /*! Retrieve average number of packets lost on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS,
    /*! Retrieve standard deviation of packets lost on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS,
    /*! Retrieve ALL statistics relating to jitter */
    AST_RTP_INSTANCE_STAT_COMBINED_JITTER,
    /*! Retrieve jitter on transmitted packets */
    AST_RTP_INSTANCE_STAT_TXJITTER,
    /*! Retrieve jitter on received packets */
    AST_RTP_INSTANCE_STAT_RXJITTER,
    /*! Retrieve maximum jitter on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER,
    /*! Retrieve minimum jitter on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER,
    /*! Retrieve average jitter on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER,
    /*! Retrieve standard deviation jitter on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER,
    /*! Retrieve maximum jitter on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER,
    /*! Retrieve minimum jitter on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER,
    /*! Retrieve average jitter on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER,
    /*! Retrieve standard deviation jitter on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER,
    /*! Retrieve ALL statistics relating to round trip time */
    AST_RTP_INSTANCE_STAT_COMBINED_RTT,
    /*! Retrieve round trip time */
    AST_RTP_INSTANCE_STAT_RTT,
    /*! Retrieve maximum round trip time */
    AST_RTP_INSTANCE_STAT_MAX_RTT,
    /*! Retrieve minimum round trip time */
    AST_RTP_INSTANCE_STAT_MIN_RTT,
    /*! Retrieve average round trip time */
    AST_RTP_INSTANCE_STAT_NORMDEVRTT,
    /*! Retrieve standard deviation round trip time */
    AST_RTP_INSTANCE_STAT_STDEVRTT,
    /*! Retrieve local SSRC */
    AST_RTP_INSTANCE_STAT_LOCAL_SSRC,
    /*! Retrieve remote SSRC */
    AST_RTP_INSTANCE_STAT_REMOTE_SSRC,
    /*! Retrieve channel unique ID */
    AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID,
    /*! Retrieve number of octets transmitted */
    AST_RTP_INSTANCE_STAT_TXOCTETCOUNT,
    /*! Retrieve number of octets received */
    AST_RTP_INSTANCE_STAT_RXOCTETCOUNT,
 
    /*! Retrieve ALL statistics relating to Media Experience Score */
    AST_RTP_INSTANCE_STAT_COMBINED_MES,
    /*! Retrieve MES on transmitted packets */
    AST_RTP_INSTANCE_STAT_TXMES,
    /*! Retrieve MES on received packets */
    AST_RTP_INSTANCE_STAT_RXMES,
    /*! Retrieve maximum MES on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MAXMES,
    /*! Retrieve minimum MES on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_MINMES,
    /*! Retrieve average MES on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVMES,
    /*! Retrieve standard deviation MES on remote side */
    AST_RTP_INSTANCE_STAT_REMOTE_STDEVMES,
    /*! Retrieve maximum MES on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MAXMES,
    /*! Retrieve minimum MES on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_MINMES,
    /*! Retrieve average MES on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVMES,
    /*! Retrieve standard deviation MES on local side */
    AST_RTP_INSTANCE_STAT_LOCAL_STDEVMES,
};

◆ ast_rtp_instance_stat_field

enum ast_rtp_instance_stat_field

Field statistics that can be retrieved from an RTP instance

Enumerator
AST_RTP_INSTANCE_STAT_FIELD_QUALITY	Retrieve quality information
AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER	Retrieve quality information about jitter
AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS	Retrieve quality information about packet loss
AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT	Retrieve quality information about round trip time
AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES	Retrieve quality information about Media Experience Score

Definition at line 171 of file rtp_engine.h.

                                 {
    /*! Retrieve quality information */
    AST_RTP_INSTANCE_STAT_FIELD_QUALITY = 0,
    /*! Retrieve quality information about jitter */
    AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER,
    /*! Retrieve quality information about packet loss */
    AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS,
    /*! Retrieve quality information about round trip time */
    AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT,
    /*! Retrieve quality information about Media Experience Score */
    AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES,
};

◆ ast_rtp_options

enum ast_rtp_options

Additional RTP options

Enumerator
AST_RTP_OPT_G726_NONSTANDARD	Remote side is using non-standard G.726

Definition at line 145 of file rtp_engine.h.

                     {
    /*! Remote side is using non-standard G.726 */
    AST_RTP_OPT_G726_NONSTANDARD = (1 << 0),
};

◆ ast_rtp_property

enum ast_rtp_property

RTP Properties that can be set on an RTP instance

Enumerator
AST_RTP_PROPERTY_NAT	Enable symmetric RTP support
AST_RTP_PROPERTY_DTMF	RTP instance will be carrying DTMF (using RFC2833)
AST_RTP_PROPERTY_DTMF_COMPENSATE	Expect unreliable DTMF from remote party
AST_RTP_PROPERTY_STUN	Enable STUN support
AST_RTP_PROPERTY_RTCP	Enable RTCP support
AST_RTP_PROPERTY_ASYMMETRIC_CODEC	Enable Asymmetric RTP Codecs
AST_RTP_PROPERTY_RETRANS_RECV	Enable packet retransmission for received packets
AST_RTP_PROPERTY_RETRANS_SEND	Enable packet retransmission for sent packets
AST_RTP_PROPERTY_REMB	Enable REMB sending and receiving passthrough support
AST_RTP_PROPERTY_MAX	Maximum number of RTP properties supported. Note THIS MUST BE THE LAST ENTRY IN THIS ENUM.

Definition at line 116 of file rtp_engine.h.

                      {
    /*! Enable symmetric RTP support */
    AST_RTP_PROPERTY_NAT = 0,
    /*! RTP instance will be carrying DTMF (using RFC2833) */
    AST_RTP_PROPERTY_DTMF,
    /*! Expect unreliable DTMF from remote party */
    AST_RTP_PROPERTY_DTMF_COMPENSATE,
    /*! Enable STUN support */
    AST_RTP_PROPERTY_STUN,
    /*! Enable RTCP support */
    AST_RTP_PROPERTY_RTCP,
    /*! Enable Asymmetric RTP Codecs */
    AST_RTP_PROPERTY_ASYMMETRIC_CODEC,
    /*! Enable packet retransmission for received packets */
    AST_RTP_PROPERTY_RETRANS_RECV,
    /*! Enable packet retransmission for sent packets */
    AST_RTP_PROPERTY_RETRANS_SEND,
    /*! Enable REMB sending and receiving passthrough support */
    AST_RTP_PROPERTY_REMB,
 
    /*!
     * \brief Maximum number of RTP properties supported
     *
     * \note THIS MUST BE THE LAST ENTRY IN THIS ENUM.
     */
    AST_RTP_PROPERTY_MAX,
};

Function Documentation

◆ ast_debug_category_dtls_id()

uintmax_t ast_debug_category_dtls_id ( void )

Definition at line 3771 of file rtp_engine.c.

{
    return debug_category_dtls_id;
}

References debug_category_dtls_id.

◆ ast_debug_category_dtls_packet_id()

uintmax_t ast_debug_category_dtls_packet_id ( void )

Definition at line 3778 of file rtp_engine.c.

{
    return debug_category_dtls_packet_id;
}

References debug_category_dtls_packet_id.

◆ ast_debug_category_ice_id()

uintmax_t ast_debug_category_ice_id ( void )

Definition at line 3785 of file rtp_engine.c.

{
    return debug_category_ice_id;
}

References debug_category_ice_id.

◆ ast_debug_category_rtcp_id()

uintmax_t ast_debug_category_rtcp_id ( void )

Definition at line 3757 of file rtp_engine.c.

{
    return debug_category_rtcp_id;
}

References debug_category_rtcp_id.

◆ ast_debug_category_rtcp_packet_id()

uintmax_t ast_debug_category_rtcp_packet_id ( void )

Definition at line 3764 of file rtp_engine.c.

{
    return debug_category_rtcp_packet_id;
}

References debug_category_rtcp_packet_id.

◆ ast_debug_category_rtp_id()

uintmax_t ast_debug_category_rtp_id ( void )

Definition at line 3743 of file rtp_engine.c.

{
    return debug_category_rtp_id;
}

References debug_category_rtp_id.

◆ ast_debug_category_rtp_packet_id()

uintmax_t ast_debug_category_rtp_packet_id ( void )

Definition at line 3750 of file rtp_engine.c.

{
    return debug_category_rtp_packet_id;
}

References debug_category_rtp_packet_id.

◆ ast_rtp_codecs_find_payload_code()

int ast_rtp_codecs_find_payload_code	(	struct ast_rtp_codecs *	codecs,
		int	payload
	)

Search for the tx payload type in the ast_rtp_codecs structure.

Parameters

codecs	Codecs structure to look in
payload	The payload type format to look for

Returns: Numerical payload type or -1 if unable to find payload in codecs

Example usage:

int payload = ast_rtp_codecs_find_payload_code(&codecs, 0);

codecs

static struct ao2_container * codecs

Registered codecs.

Definition: codec.c:48

ast_rtp_codecs_find_payload_code

int ast_rtp_codecs_find_payload_code(struct ast_rtp_codecs *codecs, int payload)

Search for the tx payload type in the ast_rtp_codecs structure.

Definition: rtp_engine.c:2151

This looks for the numerical payload for ULAW in the codecs structure.

Definition at line 2151 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
    int res = -1;
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
    if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
        if (type) {
            res = payload;
        }
    }
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::payload, and type.

Referenced by bridge_p2p_rtp_write().

◆ ast_rtp_codecs_get_framing()

unsigned int ast_rtp_codecs_get_framing ( struct ast_rtp_codecs * codecs )

Get the framing used for a set of codecs.

Parameters

codecs Codecs structure to get the framing from

Returns: The framing to be used for the media stream associated with these codecs

Since: 13.0.0

Definition at line 1682 of file rtp_engine.c.

{
    unsigned int framing;
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
    framing = codecs->framing;
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    return framing;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.

Referenced by ast_rtp_write(), create_outgoing_sdp_stream(), multicast_rtp_write(), and native_rtp_bridge_compatible_check().

◆ ast_rtp_codecs_get_payload()

struct ast_rtp_payload_type * ast_rtp_codecs_get_payload	(	struct ast_rtp_codecs *	codecs,
		int	payload
	)

Retrieve rx payload mapped information by payload type.

Parameters

codecs	Codecs structure to look in
payload	Numerical payload to look up

Returns: Payload information.

Return values

NULL	if payload does not exist.

Note: The payload returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.

Example usage:

struct ast_rtp_payload_type *payload_type;

payload_type = ast_rtp_codecs_get_payload(&codecs, 0);

ast_rtp_codecs_get_payload

struct ast_rtp_payload_type * ast_rtp_codecs_get_payload(struct ast_rtp_codecs *codecs, int payload)

Retrieve rx payload mapped information by payload type.

Definition: rtp_engine.c:1548

This looks up the information for payload '0' from the codecs structure.

Definition at line 1548 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type = NULL;
 
    if (payload < 0 || payload >= AST_RTP_MAX_PT) {
        return NULL;
    }
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
    if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx)) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_rx, payload);
        ao2_bump(type);
    }
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    if (!type && payload <= AST_RTP_PT_LAST_STATIC) {
        ast_rwlock_rdlock(&static_RTP_PT_lock);
        type = ao2_bump(static_RTP_PT[payload]);
        ast_rwlock_unlock(&static_RTP_PT_lock);
    }
 
    return type;
}

References ao2_bump, AST_RTP_MAX_PT, AST_RTP_PT_LAST_STATIC, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, ast_rtp_payload_type::payload, static_RTP_PT, static_RTP_PT_lock, and type.

Referenced by ast_rtp_dtmf_begin(), ast_rtp_interpret(), and bridge_p2p_rtp_write().

◆ ast_rtp_codecs_get_payload_format()

struct ast_format * ast_rtp_codecs_get_payload_format	(	struct ast_rtp_codecs *	codecs,
		int	payload
	)

Retrieve the actual ast_format stored on the codecs structure for a specific tx payload type.

Parameters

codecs	Codecs structure to look in
payload	Numerical payload type to look up

Returns: pointer to format structure on success

Return values

NULL	on failure

Note: The format returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.

Since: 10.0

Definition at line 1650 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
    struct ast_format *format = NULL;
 
    if (payload < 0 || payload >= AST_RTP_MAX_PT) {
        return NULL;
    }
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
    if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
        if (type && type->asterisk_format) {
            format = ao2_bump(type->format);
        }
    }
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    return format;
}

References ao2_bump, AST_RTP_MAX_PT, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, and type.

Referenced by get_codecs().

◆ ast_rtp_codecs_get_preferred_dtmf_format_pt()

int ast_rtp_codecs_get_preferred_dtmf_format_pt ( struct ast_rtp_codecs * codecs )

Retrieve rx preferred dtmf format payload type.

Parameters

codecs Codecs structure to look in

Returns: Payload type of preferred dtmf format.

Return values

-1	if not set.

Example usage:

int payload;

payload = ast_rtp_codecs_get_preferred_dtmf_format_pt(codec);

ast_rtp_codecs_get_preferred_dtmf_format_pt

int ast_rtp_codecs_get_preferred_dtmf_format_pt(struct ast_rtp_codecs *codecs)

Retrieve rx preferred dtmf format payload type.

Definition: rtp_engine.c:1589

This looks up the preferred dtmf format pt on the codec

Definition at line 1589 of file rtp_engine.c.

{
    int pt = -1;
    ast_rwlock_rdlock(&codecs->codecs_lock);
    pt = codecs->preferred_dtmf_pt;
    ast_rwlock_unlock(&codecs->codecs_lock);
    return pt;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.

Referenced by ast_rtp_dtmf_begin().

◆ ast_rtp_codecs_get_preferred_dtmf_format_rate()

int ast_rtp_codecs_get_preferred_dtmf_format_rate ( struct ast_rtp_codecs * codecs )

Retrieve rx preferred dtmf format sample rate.

Parameters

codecs Codecs structure to look in

Returns: Sample rate of preferred dtmf format.

Return values

-1	if not set.

Example usage:

int sample_rate;

sample_rate = ast_rtp_codecs_get_preferred_dtmf_format_rate(codec);

ast_rtp_codecs_get_preferred_dtmf_format_rate

int ast_rtp_codecs_get_preferred_dtmf_format_rate(struct ast_rtp_codecs *codecs)

Retrieve rx preferred dtmf format sample rate.

Definition: rtp_engine.c:1598

This looks up the preferred dtmf format sample rate on the codec

Definition at line 1598 of file rtp_engine.c.

{
    int rate = -1;
    ast_rwlock_rdlock(&codecs->codecs_lock);
    rate = codecs->preferred_dtmf_rate;
    ast_rwlock_unlock(&codecs->codecs_lock);
    return rate;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.

Referenced by ast_rtp_dtmf_begin().

◆ ast_rtp_codecs_get_preferred_format()

struct ast_format * ast_rtp_codecs_get_preferred_format ( struct ast_rtp_codecs * codecs )

Retrieve rx preferred format.

Parameters

codecs Codecs structure to look in

Returns: format information.

Return values

NULL	if format does not exist.

Note: The format returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.

Example usage:

struct ast_format *payload_format;

payload_format = ast_rtp_codecs_get_preferred_format(&codecs);

ast_rtp_codecs_get_preferred_format

struct ast_format * ast_rtp_codecs_get_preferred_format(struct ast_rtp_codecs *codecs)

Retrieve rx preferred format.

Definition: rtp_engine.c:1572

This looks up the preferred format on the codec

Definition at line 1572 of file rtp_engine.c.

{
    struct ast_format *format;
    ast_rwlock_rdlock(&codecs->codecs_lock);
    format = ao2_bump(codecs->preferred_format);
    ast_rwlock_unlock(&codecs->codecs_lock);
    return format;
}

References ao2_bump, ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.

Referenced by ast_rtp_dtmf_begin().

◆ ast_rtp_codecs_get_stream_type()

enum ast_media_type ast_rtp_codecs_get_stream_type ( struct ast_rtp_codecs * codecs )

Determine the type of RTP stream media from the codecs mapped.

Since: 13.19.0

Parameters

codecs Codecs structure to look in

Returns: Media type or AST_MEDIA_TYPE_UNKNOWN if no codecs mapped.

Definition at line 1529 of file rtp_engine.c.

{
    enum ast_media_type stream_type = AST_MEDIA_TYPE_UNKNOWN;
    int payload;
    struct ast_rtp_payload_type *type;
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
    for (payload = 0; payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++payload) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_rx, payload);
        if (type && type->asterisk_format) {
            stream_type = ast_format_get_type(type->format);
            break;
        }
    }
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    return stream_type;
}

References ast_format_get_type(), AST_MEDIA_TYPE_UNKNOWN, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::payload, and type.

Referenced by ast_rtp_read().

◆ ast_rtp_codecs_payload_code()

int ast_rtp_codecs_payload_code	(	struct ast_rtp_codecs *	codecs,
		int	asterisk_format,
		struct ast_format *	format,
		int	code
	)

Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code.

Parameters

codecs	Codecs structure to look in
asterisk_format	Non-zero if the given Asterisk format is present
format	Asterisk format to look for
code	The format to look for

Find the currently assigned rx mapped payload type based on whether it is an Asterisk format or non-format code. If one is currently not assigned then create a rx payload type mapping.

Returns: Numerical payload type

Return values

-1	if could not assign.

Example usage:

int payload = ast_rtp_codecs_payload_code(&codecs, 1, ast_format_ulaw, 0);

ast_format_ulaw

struct ast_format * ast_format_ulaw

Built-in cached ulaw format.

Definition: format_cache.c:86

ast_rtp_codecs_payload_code

int ast_rtp_codecs_payload_code(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code)

Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code.

Definition: rtp_engine.c:2019

This looks for the numerical payload for ULAW in the codecs structure.

Since: 1.8

Definition at line 2019 of file rtp_engine.c.

{
    return ast_rtp_codecs_payload_code_sample_rate(codecs, asterisk_format, format, code, 0);
}

References ast_rtp_codecs_payload_code_sample_rate(), ast_rtp_payload_type::asterisk_format, codecs, and ast_rtp_payload_type::format.

Referenced by apply_cap_to_bundled(), create_outgoing_sdp_stream(), and jingle_add_payloads_to_description().

◆ ast_rtp_codecs_payload_code_sample_rate()

int ast_rtp_codecs_payload_code_sample_rate	(	struct ast_rtp_codecs *	codecs,
		int	asterisk_format,
		struct ast_format *	format,
		int	code,
		unsigned int	sample_rate
	)

Retrieve a rx mapped payload type based on whether it is an Asterisk format, the code and the sample rate.

Parameters

codecs	Codecs structure to look in
asterisk_format	Non-zero if the given Asterisk format is present
format	Asterisk format to look for
code	The format to look for
sample_rate	Non-zero if we want to also match on sample rate.

Find the currently assigned rx mapped payload type based on whether it is an Asterisk format or non-format code. If one is currently not assigned then create a rx payload type mapping.

Returns: Numerical payload type

Return values

-1	if could not assign.

Example usage:

int payload = ast_rtp_codecs_payload_code_sample_rate(&codecs, 0, NULL, AST_RTP_DTMF, 8000);

AST_RTP_DTMF

#define AST_RTP_DTMF

Definition: rtp_engine.h:294

ast_rtp_codecs_payload_code_sample_rate

int ast_rtp_codecs_payload_code_sample_rate(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code, unsigned int sample_rate)

Retrieve a rx mapped payload type based on whether it is an Asterisk format, the code and the sample ...

Definition: rtp_engine.c:2024

This looks for the numerical payload for a DTMF type with a sample rate of 8kHz in the codecs structure.

Since: 22.0.0

Definition at line 2024 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
    int idx;
    int payload = -1;
 
    ast_rwlock_rdlock(&static_RTP_PT_lock);
    if (!asterisk_format) {
        ast_rwlock_rdlock(&codecs->codecs_lock);
        for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
            type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
            if (!type) {
                continue;
            }
 
            if (!type->asterisk_format
                && type->primary_mapping
                && type->rtp_code == code
                && (sample_rate == 0 || type->sample_rate == sample_rate)) {
                payload = idx;
                break;
            }
        }
        ast_rwlock_unlock(&codecs->codecs_lock);
    } else if (format) {
        ast_rwlock_rdlock(&codecs->codecs_lock);
        for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
            type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
            if (!type) {
                continue;
            }
 
            if (type->asterisk_format
                && type->primary_mapping
                && ast_format_cmp(format, type->format) == AST_FORMAT_CMP_EQUAL) {
                payload = idx;
                break;
            }
        }
        ast_rwlock_unlock(&codecs->codecs_lock);
    }
 
    if (payload < 0) {
        payload = rtp_codecs_assign_payload_code_rx(codecs, asterisk_format, format,
            code, 0, sample_rate);
    }
    ast_rwlock_unlock(&static_RTP_PT_lock);
 
    return payload;
}

References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_payload_type::asterisk_format, codecs, ast_rtp_payload_type::format, ast_rtp_payload_type::payload, rtp_codecs_assign_payload_code_rx(), ast_rtp_payload_type::sample_rate, static_RTP_PT_lock, and type.

Referenced by ast_rtp_codecs_payload_code(), and create_outgoing_sdp_stream().

◆ ast_rtp_codecs_payload_code_tx()

int ast_rtp_codecs_payload_code_tx	(	struct ast_rtp_codecs *	codecs,
		int	asterisk_format,
		const struct ast_format *	format,
		int	code
	)

Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code.

Since: 14.0.0

Parameters

codecs	Codecs structure to look in
asterisk_format	Non-zero if the given Asterisk format is present
format	Asterisk format to look for
code	The format to look for

Returns: Numerical payload type

Return values

-1	if not found.

Definition at line 2146 of file rtp_engine.c.

{
    return ast_rtp_codecs_payload_code_tx_sample_rate(codecs, asterisk_format, format, code, 0);
}

References ast_rtp_codecs_payload_code_tx_sample_rate(), ast_rtp_payload_type::asterisk_format, codecs, and ast_rtp_payload_type::format.

Referenced by ast_rtp_dtmf_begin(), ast_rtp_sendcng(), ast_rtp_write(), bridge_p2p_rtp_write(), multicast_rtp_write(), and send_start_rtp().

◆ ast_rtp_codecs_payload_code_tx_sample_rate()

int ast_rtp_codecs_payload_code_tx_sample_rate	(	struct ast_rtp_codecs *	codecs,
		int	asterisk_format,
		const struct ast_format *	format,
		int	code,
		unsigned int	sample_rate
	)

Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code.

Since: 22.0.0

Parameters

codecs	Codecs structure to look in
asterisk_format	Non-zero if the given Asterisk format is present
format	Asterisk format to look for
code	The format to look for
sample_rate	The sample rate to look for, zero if we don't care

Returns: Numerical payload type

Return values

-1	if not found.

Definition at line 2085 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
    int idx;
    int payload = -1;
 
    if (!asterisk_format) {
        ast_rwlock_rdlock(&codecs->codecs_lock);
        for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
            type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
            if (!type) {
                continue;
            }
 
            if (!type->asterisk_format
                && type->rtp_code == code
                /* Multiple DTMF types share an rtp code but have different sample rates.  To ensure we have the right
                   type we therefore need the sample rate as well as the format and code.  Other types have a fixed
                   sample rate so this is not needed. For those pass in a sample rate of 0 or use ast_rtp_codecs_payload_code_tx. */
                && (sample_rate == 0 || type->sample_rate == sample_rate)) {
                payload = idx;
                break;
            }
        }
        ast_rwlock_unlock(&codecs->codecs_lock);
    } else if (format) {
        ast_rwlock_rdlock(&codecs->codecs_lock);
        for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
            type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
            if (!type) {
                continue;
            }
 
            if (type->asterisk_format
                && ast_format_cmp(format, type->format) == AST_FORMAT_CMP_EQUAL) {
                payload = idx;
                break;
            }
        }
        ast_rwlock_unlock(&codecs->codecs_lock);
    }
 
    if (payload < 0) {
        ast_rwlock_rdlock(&static_RTP_PT_lock);
        payload = find_static_payload_type(asterisk_format, format, code);
        ast_rwlock_unlock(&static_RTP_PT_lock);
 
        ast_rwlock_rdlock(&codecs->codecs_lock);
        if (payload >= 0 && payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)){
            type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
            if (!type || (sample_rate != 0 && type->sample_rate != sample_rate)) {
                /* Don't use the type if we can't find it or it doesn't match the supplied sample_rate */
                payload = -1;
            }
        }
        ast_rwlock_unlock(&codecs->codecs_lock);
    }
 
    return payload;
}

References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_payload_type::asterisk_format, codecs, find_static_payload_type(), ast_rtp_payload_type::format, ast_rtp_payload_type::payload, ast_rtp_payload_type::sample_rate, static_RTP_PT_lock, and type.

Referenced by ast_rtp_codecs_payload_code_tx(), and ast_rtp_dtmf_begin().

◆ ast_rtp_codecs_payload_formats()

void ast_rtp_codecs_payload_formats	(	struct ast_rtp_codecs *	codecs,
		struct ast_format_cap *	astformats,
		int *	nonastformats
	)

Retrieve all formats that were found.

Parameters

codecs	Codecs structure to look in
astformats	A capabilities structure to put the Asterisk formats in.
nonastformats	An integer to put the non-Asterisk formats in

Example usage:

struct ast_format_cap *astformats = ast_format_cap_alloc_nolock()
int nonastformats;
ast_rtp_codecs_payload_formats(&codecs, astformats, &nonastformats);

This retrieves all the formats known about in the codecs structure and puts the Asterisk ones in the integer pointed to by astformats and the non-Asterisk ones in the integer pointed to by nonastformats.

Since: 1.8

Definition at line 1693 of file rtp_engine.c.

{
    int idx;
 
    ast_format_cap_remove_by_type(astformats, AST_MEDIA_TYPE_UNKNOWN);
    *nonastformats = 0;
 
    ast_rwlock_rdlock(&codecs->codecs_lock);
 
    for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
        struct ast_rtp_payload_type *type;
 
        type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
        if (!type) {
            continue;
        }
 
        if (type->asterisk_format) {
            ast_format_cap_append(astformats, type->format, 0);
        } else {
            *nonastformats |= type->rtp_code;
        }
    }
    if (codecs->framing) {
        ast_format_cap_set_framing(astformats, codecs->framing);
    }
 
    ast_rwlock_unlock(&codecs->codecs_lock);
}

References ast_format_cap_append, ast_format_cap_remove_by_type(), ast_format_cap_set_framing(), AST_MEDIA_TYPE_UNKNOWN, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, and type.

Referenced by jingle_interpret_description().

◆ ast_rtp_codecs_payload_replace_format()

int ast_rtp_codecs_payload_replace_format	(	struct ast_rtp_codecs *	codecs,
		int	payload,
		struct ast_format *	format
	)

Update the format associated with a tx payload type in a codecs structure.

Parameters

codecs	Codecs structure to operate on
payload	Numerical payload type to look up
format	The format to replace the existing one

Return values

0	success
-1	failure

Since: 13

Definition at line 1616 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
 
    if (payload < 0 || payload >= AST_RTP_MAX_PT || !format) {
        return -1;
    }
 
    type = ast_rtp_engine_alloc_payload_type();
    if (!type) {
        return -1;
    }
    ao2_ref(format, +1);
    type->format = format;
    type->asterisk_format = 1;
    type->payload = payload;
    type->primary_mapping = 1;
 
    ast_rwlock_wrlock(&codecs->codecs_lock);
    if (!payload_mapping_tx_is_present(codecs, type)) {
        if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
            ao2_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload));
        }
        if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, type)) {
            ao2_ref(type, -1);
        }
    } else {
        ao2_ref(type, -1);
    }
    ast_rwlock_unlock(&codecs->codecs_lock);
 
    return 0;
}

References ao2_cleanup, ao2_ref, ast_rtp_engine_alloc_payload_type(), AST_RTP_MAX_PT, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::format, ast_rtp_payload_type::payload, payload_mapping_tx_is_present(), and type.

Referenced by get_codecs().

◆ ast_rtp_codecs_payload_set_rx()

int ast_rtp_codecs_payload_set_rx	(	struct ast_rtp_codecs *	codecs,
		int	code,
		struct ast_format *	format
	)

Set a payload code for use with a specific Asterisk format.

Parameters

codecs	Codecs structure to manipulate
code	The payload code
format	Asterisk format

Return values

0	Payload was set to the given format
-1	Payload was in use or could not be set

Since: 15.0.0

Definition at line 2075 of file rtp_engine.c.

{
    return rtp_codecs_assign_payload_code_rx(codecs, 1, format, code, 1, 0);
}

References codecs, ast_rtp_payload_type::format, and rtp_codecs_assign_payload_code_rx().

Referenced by apply_cap_to_bundled(), and create_outgoing_sdp_stream().

◆ ast_rtp_codecs_payload_set_rx_sample_rate()

int ast_rtp_codecs_payload_set_rx_sample_rate	(	struct ast_rtp_codecs *	codecs,
		int	code,
		struct ast_format *	format,
		unsigned int	sample_rate
	)

Set a payload code with sample rate for use with a specific Asterisk format.

Parameters

codecs	Codecs structure to manipulate
code	The payload code
format	Asterisk format
sample_rate	Sample rate of the format, 0 to use the format's default

Return values

0	Payload was set to the given format
-1	Payload was in use or could not be set

Since: 22.0.0

Definition at line 2080 of file rtp_engine.c.

{
    return rtp_codecs_assign_payload_code_rx(codecs, 1, format, code, 0, sample_rate);
}

References codecs, ast_rtp_payload_type::format, rtp_codecs_assign_payload_code_rx(), and ast_rtp_payload_type::sample_rate.

◆ ast_rtp_codecs_payloads_clear()

void ast_rtp_codecs_payloads_clear	(	struct ast_rtp_codecs *	codecs,
		struct ast_rtp_instance *	instance
	)

Clear rx and tx payload mapping information from an RTP instance.

Parameters

codecs	The codecs structure that payloads will be cleared from
instance	Optionally the instance that the codecs structure belongs to

Example usage:

struct ast_rtp_codecs codecs;

ast_rtp_codecs_payloads_clear(&codecs, NULL);

ast_rtp_codecs_payloads_clear

void ast_rtp_codecs_payloads_clear(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance)

Clear rx and tx payload mapping information from an RTP instance.

Definition: rtp_engine.c:1019

ast_rtp_codecs

Definition: rtp_engine.h:756

This clears the codecs structure and puts it into a pristine state.

Since: 1.8

Definition at line 1019 of file rtp_engine.c.

{
    ast_rtp_codecs_payloads_destroy(codecs);
    ast_rtp_codecs_payloads_initialize(codecs);
 
    if (instance && instance->engine && instance->engine->payload_set) {
        int i;
 
        ao2_lock(instance);
        for (i = 0; i < AST_RTP_MAX_PT; i++) {
            instance->engine->payload_set(instance, i, 0, NULL, 0);
        }
        ao2_unlock(instance);
    }
}

References ao2_lock, ao2_unlock, ast_rtp_codecs_payloads_destroy(), ast_rtp_codecs_payloads_initialize(), AST_RTP_MAX_PT, codecs, ast_rtp_instance::engine, NULL, and ast_rtp_engine::payload_set.

◆ ast_rtp_codecs_payloads_copy()

void ast_rtp_codecs_payloads_copy	(	struct ast_rtp_codecs *	src,
		struct ast_rtp_codecs *	dest,
		struct ast_rtp_instance *	instance
	)

Copy payload information from one RTP instance to another.

Parameters

src	The source codecs structure
dest	The destination codecs structure that the values from src will be copied to
instance	Optionally the instance that the dst codecs structure belongs to

Example usage:

ast_rtp_codecs_payloads_copy(&codecs0, &codecs1, NULL);

ast_rtp_codecs_payloads_copy

void ast_rtp_codecs_payloads_copy(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)

Copy payload information from one RTP instance to another.

Definition: rtp_engine.c:1273

This copies the payloads from the codecs0 structure to the codecs1 structure, overwriting any current values.

Since: 1.8

Definition at line 1273 of file rtp_engine.c.

{
    int idx;
    struct ast_rtp_payload_type *type;
 
    ast_rwlock_wrlock(&dest->codecs_lock);
 
    /* Deadlock avoidance because of held write lock. */
    while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
        ast_rwlock_unlock(&dest->codecs_lock);
        sched_yield();
        ast_rwlock_wrlock(&dest->codecs_lock);
    }
 
    /*
     * This represents a completely new mapping of what the remote party is
     * expecting for payloads, so we clear out the entire tx payload mapping
     * vector and replace it.
     */
    for (idx = 0; idx < AST_VECTOR_SIZE(&dest->payload_mapping_tx); ++idx) {
        type = AST_VECTOR_GET(&dest->payload_mapping_tx, idx);
        ao2_t_cleanup(type, "destroying ast_rtp_codec tx mapping");
        AST_VECTOR_REPLACE(&dest->payload_mapping_tx, idx, NULL);
    }
 
    rtp_codecs_payloads_copy_rx(src, dest, instance);
    rtp_codecs_payloads_copy_tx(src, dest, instance);
    dest->framing = src->framing;
    ao2_replace(dest->preferred_format, src->preferred_format);
    dest->preferred_dtmf_rate = src->preferred_dtmf_rate;
    dest->preferred_dtmf_pt = src->preferred_dtmf_pt;
 
    ast_rwlock_unlock(&src->codecs_lock);
    ast_rwlock_unlock(&dest->codecs_lock);
}

References ao2_replace, ao2_t_cleanup, ast_rwlock_tryrdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, ast_rtp_codecs::codecs_lock, ast_rtp_codecs::framing, NULL, ast_rtp_codecs::payload_mapping_tx, ast_rtp_codecs::preferred_dtmf_pt, ast_rtp_codecs::preferred_dtmf_rate, ast_rtp_codecs::preferred_format, rtp_codecs_payloads_copy_rx(), rtp_codecs_payloads_copy_tx(), and type.

Referenced by jingle_interpret_description(), set_caps(), and set_incoming_call_offer_cap().

◆ ast_rtp_codecs_payloads_destroy()

void ast_rtp_codecs_payloads_destroy ( struct ast_rtp_codecs * codecs )

Destroy the contents of an RTP codecs structure (but not the structure itself)

Parameters

codecs The codecs structure to destroy the contents of

Example usage:

struct ast_rtp_codecs codecs;

ast_rtp_codecs_payloads_destroy(&codecs);

ast_rtp_codecs_payloads_destroy

void ast_rtp_codecs_payloads_destroy(struct ast_rtp_codecs *codecs)

Destroy the contents of an RTP codecs structure (but not the structure itself)

Definition: rtp_engine.c:996

Since: 11

Definition at line 996 of file rtp_engine.c.

{
    int idx;
    struct ast_rtp_payload_type *type;
 
    for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
        ao2_t_cleanup(type, "destroying ast_rtp_codec rx mapping");
    }
    AST_VECTOR_FREE(&codecs->payload_mapping_rx);
 
    for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
        ao2_t_cleanup(type, "destroying ast_rtp_codec tx mapping");
    }
    AST_VECTOR_FREE(&codecs->payload_mapping_tx);
 
    ao2_t_cleanup(codecs->preferred_format, "destroying ast_rtp_codec preferred format");
    codecs->preferred_format = NULL;
 
    ast_rwlock_destroy(&codecs->codecs_lock);
}

References ao2_t_cleanup, ast_rwlock_destroy, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, and type.

Referenced by ast_rtp_codecs_payloads_clear(), ast_stream_free(), ast_stream_set_rtp_codecs(), instance_destructor(), jingle_interpret_description(), set_caps(), and set_incoming_call_offer_cap().

◆ ast_rtp_codecs_payloads_initialize()

int ast_rtp_codecs_payloads_initialize ( struct ast_rtp_codecs * codecs )

Initialize an RTP codecs structure.

Parameters

codecs The codecs structure to initialize

Return values

0	success
-1	failure

Example usage:

struct ast_rtp_codecs codecs;

ast_rtp_codecs_payloads_initialize(&codecs);

ast_rtp_codecs_payloads_initialize

int ast_rtp_codecs_payloads_initialize(struct ast_rtp_codecs *codecs)

Initialize an RTP codecs structure.

Definition: rtp_engine.c:980

Since: 11

Definition at line 980 of file rtp_engine.c.

{
    int res;
 
    codecs->framing = 0;
    ast_rwlock_init(&codecs->codecs_lock);
    res = AST_VECTOR_INIT(&codecs->payload_mapping_rx, AST_RTP_MAX_PT);
    res |= AST_VECTOR_INIT(&codecs->payload_mapping_tx, AST_RTP_MAX_PT);
    if (res) {
        AST_VECTOR_FREE(&codecs->payload_mapping_rx);
        AST_VECTOR_FREE(&codecs->payload_mapping_tx);
    }
 
    return res;
}

References AST_RTP_MAX_PT, ast_rwlock_init, AST_VECTOR_FREE, AST_VECTOR_INIT, and codecs.

Referenced by ast_rtp_codecs_payloads_clear(), ast_rtp_instance_new(), get_codecs(), and jingle_interpret_description().

◆ ast_rtp_codecs_payloads_set_m_type()

void ast_rtp_codecs_payloads_set_m_type	(	struct ast_rtp_codecs *	codecs,
		struct ast_rtp_instance *	instance,
		int	payload
	)

Record tx payload type information that was seen in an m= SDP line.

Parameters

codecs	The codecs structure to muck with
instance	Optionally the instance that the codecs structure belongs to
payload	Numerical payload that was seen in the m= SDP line

Example usage:

ast_rtp_codecs_payloads_set_m_type(&codecs, NULL, 0);

ast_rtp_codecs_payloads_set_m_type

void ast_rtp_codecs_payloads_set_m_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload)

Record tx payload type information that was seen in an m= SDP line.

Definition: rtp_engine.c:1356

This records that the numerical payload '0' was seen in the codecs structure.

Since: 1.8

Definition at line 1356 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *new_type;
 
    if (payload < 0 || payload >= AST_RTP_MAX_PT || payload > AST_RTP_PT_LAST_STATIC) {
        return;
    }
 
    ast_rwlock_rdlock(&static_RTP_PT_lock);
    new_type = ao2_bump(static_RTP_PT[payload]);
    ast_rwlock_unlock(&static_RTP_PT_lock);
    if (!new_type) {
        ast_debug(1, "Don't have a default tx payload type %d format for m type on %p\n",
            payload, codecs);
        return;
    }
 
    ast_debug(1, "Setting tx payload type %d based on m type on %p\n",
        payload, codecs);
 
    ast_rwlock_wrlock(&codecs->codecs_lock);
 
    if (!payload_mapping_tx_is_present(codecs, new_type)) {
        if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
            ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload),
                "cleaning up replaced tx payload type");
        }
 
        if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, new_type)) {
            ao2_ref(new_type, -1);
        } else if (instance && instance->engine && instance->engine->payload_set) {
            ao2_lock(instance);
            instance->engine->payload_set(instance, payload, new_type->asterisk_format, new_type->format, new_type->rtp_code);
            ao2_unlock(instance);
        }
    } else {
        ao2_ref(new_type, -1);
    }
 
    ast_rwlock_unlock(&codecs->codecs_lock);
}

References ao2_bump, ao2_lock, ao2_ref, ao2_t_cleanup, ao2_unlock, ast_debug, AST_RTP_MAX_PT, AST_RTP_PT_LAST_STATIC, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_instance::engine, 10aedae86a32_add_outgoing_enum_va::new_type, ast_rtp_payload_type::payload, payload_mapping_tx_is_present(), ast_rtp_engine::payload_set, static_RTP_PT, and static_RTP_PT_lock.

Referenced by get_codecs().

◆ ast_rtp_codecs_payloads_set_rtpmap_type()

int ast_rtp_codecs_payloads_set_rtpmap_type	(	struct ast_rtp_codecs *	codecs,
		struct ast_rtp_instance *	instance,
		int	payload,
		char *	mimetype,
		char *	mimesubtype,
		enum ast_rtp_options	options
	)

Record tx payload type information that was seen in an a=rtpmap: SDP line.

Parameters

codecs	The codecs structure to muck with
instance	Optionally the instance that the codecs structure belongs to
payload	Numerical payload that was seen in the a=rtpmap: SDP line
mimetype	The string mime type that was seen
mimesubtype	The string mime sub type that was seen
options	Optional options that may change the behavior of this specific payload

Return values

0	success
-1	failure, invalid payload numbe
-2	failure, unknown mimetype

Example usage:

ast_rtp_codecs_payloads_set_rtpmap_type(&codecs, NULL, 0, "audio", "PCMU", 0);

ast_rtp_codecs_payloads_set_rtpmap_type

int ast_rtp_codecs_payloads_set_rtpmap_type(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload, char *mimetype, char *mimesubtype, enum ast_rtp_options options)

Record tx payload type information that was seen in an a=rtpmap: SDP line.

Definition: rtp_engine.c:1484

This records that the numerical payload '0' was seen with mime type 'audio' and sub mime type 'PCMU' in the codecs structure.

Since: 1.8

Definition at line 1484 of file rtp_engine.c.

{
    return ast_rtp_codecs_payloads_set_rtpmap_type_rate(codecs, instance, payload, mimetype, mimesubtype, options, 0);
}

References ast_rtp_codecs_payloads_set_rtpmap_type_rate(), codecs, options, and ast_rtp_payload_type::payload.

Referenced by configure_local_rtp(), jingle_interpret_description(), ooh323_set_write_format(), and setup_rtp_connection().

◆ ast_rtp_codecs_payloads_set_rtpmap_type_rate()

int ast_rtp_codecs_payloads_set_rtpmap_type_rate	(	struct ast_rtp_codecs *	codecs,
		struct ast_rtp_instance *	instance,
		int	pt,
		char *	mimetype,
		char *	mimesubtype,
		enum ast_rtp_options	options,
		unsigned int	sample_rate
	)

Set tx payload type to a known MIME media type for a codec with a specific sample rate.

Parameters

codecs	RTP structure to modify
instance	Optionally the instance that the codecs structure belongs to
pt	Payload type entry to modify
mimetype	top-level MIME type of media stream (typically "audio", "video", "text", etc.)
mimesubtype	MIME subtype of media stream (typically a codec name)
options	Zero or more flags from the ast_rtp_options enum
sample_rate	The sample rate of the media stream

This function 'fills in' an entry in the list of possible formats for a media stream associated with an RTP structure.

Return values

0	on success
-1	if the payload type is out of range
-2	if the mimeType/mimeSubtype combination was not found

Since: 1.8

Definition at line 1398 of file rtp_engine.c.

{
    unsigned int idx;
    int found = 0;
 
    if (pt < 0 || pt >= AST_RTP_MAX_PT) {
        return -1; /* bogus payload type */
    }
 
    ast_rwlock_rdlock(&mime_types_lock);
    ast_rwlock_wrlock(&codecs->codecs_lock);
 
    for (idx = 0; idx < mime_types_len; ++idx) {
        const struct ast_rtp_mime_type *t = &ast_rtp_mime_types[idx];
        struct ast_rtp_payload_type *new_type;
 
        if (strcasecmp(mimesubtype, t->subtype)) {
            continue;
        }
 
        if (strcasecmp(mimetype, t->type)) {
            continue;
        }
 
        /* if both sample rates have been supplied, and they don't match,
         * then this not a match; if one has not been supplied, then the
         * rates are not compared */
        if (sample_rate && t->sample_rate &&
            (sample_rate != t->sample_rate)) {
            continue;
        }
 
        found = 1;
 
        new_type = ast_rtp_engine_alloc_payload_type();
        if (!new_type) {
            continue;
        }
 
        new_type->asterisk_format = t->payload_type.asterisk_format;
        new_type->rtp_code = t->payload_type.rtp_code;
        new_type->payload = pt;
        new_type->primary_mapping = 1;
        new_type->sample_rate = sample_rate;
        if (t->payload_type.asterisk_format
            && ast_format_cmp(t->payload_type.format, ast_format_g726) == AST_FORMAT_CMP_EQUAL
            && (options & AST_RTP_OPT_G726_NONSTANDARD)) {
            new_type->format = ast_format_g726_aal2;
        } else {
            new_type->format = t->payload_type.format;
        }
 
        if (new_type->format) {
            /* SDP parsing automatically increases the reference count */
            new_type->format = ast_format_parse_sdp_fmtp(new_type->format, "");
        }
 
        if (!payload_mapping_tx_is_present(codecs, new_type)) {
            if (pt < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
                ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, pt),
                    "cleaning up replaced tx payload type");
            }
 
            if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, pt, new_type)) {
                ao2_ref(new_type, -1);
            } else if (instance && instance->engine && instance->engine->payload_set) {
                ao2_lock(instance);
                instance->engine->payload_set(instance, pt, new_type->asterisk_format, new_type->format, new_type->rtp_code);
                ao2_unlock(instance);
            }
        } else {
            ao2_ref(new_type, -1);
        }
 
        break;
    }
 
    ast_rwlock_unlock(&codecs->codecs_lock);
    ast_rwlock_unlock(&mime_types_lock);
 
    return (found ? 0 : -2);
}

References ao2_lock, ao2_ref, ao2_t_cleanup, ao2_unlock, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_g726, ast_format_g726_aal2, ast_format_parse_sdp_fmtp(), ast_rtp_engine_alloc_payload_type(), AST_RTP_MAX_PT, ast_rtp_mime_types, AST_RTP_OPT_G726_NONSTANDARD, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, ast_rtp_payload_type::asterisk_format, codecs, ast_rtp_instance::engine, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, 10aedae86a32_add_outgoing_enum_va::new_type, options, payload_mapping_tx_is_present(), ast_rtp_engine::payload_set, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, ast_rtp_payload_type::sample_rate, ast_rtp_mime_type::sample_rate, ast_rtp_mime_type::subtype, and ast_rtp_mime_type::type.

Referenced by ast_rtp_codecs_payloads_set_rtpmap_type(), get_codecs(), and jingle_interpret_description().

◆ ast_rtp_codecs_payloads_unset()

void ast_rtp_codecs_payloads_unset	(	struct ast_rtp_codecs *	codecs,
		struct ast_rtp_instance *	instance,
		int	payload
	)

Remove tx payload type mapped information.

Parameters

codecs	The codecs structure to muck with
instance	Optionally the instance that the codecs structure belongs to
payload	Numerical payload to unset

Example usage:

ast_rtp_codecs_payloads_unset(&codecs, NULL, 0);

ast_rtp_codecs_payloads_unset

void ast_rtp_codecs_payloads_unset(struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload)

Remove tx payload type mapped information.

Definition: rtp_engine.c:1489

This clears the payload '0' from the codecs structure. It will be as if it was never set.

Since: 1.8

Definition at line 1489 of file rtp_engine.c.

{
    struct ast_rtp_payload_type *type;
 
    if (payload < 0 || payload >= AST_RTP_MAX_PT) {
        return;
    }
 
    ast_debug(2, "Unsetting payload %d on %p\n", payload, codecs);
 
    ast_rwlock_wrlock(&codecs->codecs_lock);
 
    if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
        type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
        /*
         * Remove the preferred format if we are unsetting its container.
         *
         * There can be empty slots in payload_mapping_tx corresponding to
         * dynamic payload types that haven't been seen before so we need
         * to check for NULL before attempting to use 'type' in the call to
         * ast_format_cmp.
         */
        if (type) {
            if (ast_format_cmp(type->format, codecs->preferred_format) == AST_FORMAT_CMP_EQUAL) {
                ao2_replace(codecs->preferred_format, NULL);
            }
            ao2_ref(type, -1);
            AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, NULL);
        }
    }
 
    if (instance && instance->engine && instance->engine->payload_set) {
        ao2_lock(instance);
        instance->engine->payload_set(instance, payload, 0, NULL, 0);
        ao2_unlock(instance);
    }
 
    ast_rwlock_unlock(&codecs->codecs_lock);
}

References ao2_lock, ao2_ref, ao2_replace, ao2_unlock, ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_RTP_MAX_PT, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_instance::engine, NULL, ast_rtp_payload_type::payload, ast_rtp_engine::payload_set, and type.

◆ ast_rtp_codecs_payloads_xover()

void ast_rtp_codecs_payloads_xover	(	struct ast_rtp_codecs *	src,
		struct ast_rtp_codecs *	dest,
		struct ast_rtp_instance *	instance
	)

Crossover copy the tx payload mapping of src to the rx payload mapping of dest.

Since: 14.0.0

Parameters

src	The source codecs structure
dest	The destination codecs structure that the values from src will be copied to
instance	Optionally the instance that the dst codecs structure belongs to

Definition at line 1309 of file rtp_engine.c.

{
    int idx;
    struct ast_rtp_payload_type *type;
 
    ast_rwlock_wrlock(&dest->codecs_lock);
    if (src != dest) {
        /* Deadlock avoidance because of held write lock. */
        while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
            ast_rwlock_unlock(&dest->codecs_lock);
            sched_yield();
            ast_rwlock_wrlock(&dest->codecs_lock);
        }
    }
 
    /* Crossover copy payload type tx mapping to rx mapping. */
    for (idx = 0; idx < AST_VECTOR_SIZE(&src->payload_mapping_tx); ++idx) {
        type = AST_VECTOR_GET(&src->payload_mapping_tx, idx);
        if (!type) {
            continue;
        }
 
        /* All tx mapping elements should have the primary flag set. */
        ast_assert(type->primary_mapping);
 
        ast_debug(2, "Crossover copying tx to rx payload mapping %d (%p) from %p to %p\n",
            idx, type, src, dest);
        rtp_codecs_payload_replace_rx(dest, idx, type);
 
        if (instance && instance->engine && instance->engine->payload_set) {
            ao2_lock(instance);
            instance->engine->payload_set(instance, idx, type->asterisk_format, type->format, type->rtp_code);
            ao2_unlock(instance);
        }
    }
 
    dest->framing = src->framing;
    ao2_replace(dest->preferred_format, src->preferred_format);
    dest->preferred_dtmf_rate = src->preferred_dtmf_rate;
    dest->preferred_dtmf_pt = src->preferred_dtmf_pt;
 
    if (src != dest) {
        ast_rwlock_unlock(&src->codecs_lock);
    }
    ast_rwlock_unlock(&dest->codecs_lock);
}

References ao2_lock, ao2_replace, ao2_unlock, ast_assert, ast_debug, ast_rwlock_tryrdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_codecs::codecs_lock, ast_rtp_instance::engine, ast_rtp_codecs::framing, ast_rtp_codecs::payload_mapping_tx, ast_rtp_engine::payload_set, ast_rtp_codecs::preferred_dtmf_pt, ast_rtp_codecs::preferred_dtmf_rate, ast_rtp_codecs::preferred_format, rtp_codecs_payload_replace_rx(), and type.

Referenced by ast_rtp_instance_early_bridge_make_compatible(), set_caps(), and set_incoming_call_offer_cap().

◆ ast_rtp_codecs_set_framing()

void ast_rtp_codecs_set_framing	(	struct ast_rtp_codecs *	codecs,
		unsigned int	framing
	)

Set the framing used for a set of codecs.

Parameters

codecs	Codecs structure to set framing on
framing	The framing value to set on the codecs

Since: 13.0.0

Definition at line 1671 of file rtp_engine.c.

{
    if (!framing) {
        return;
    }
 
    ast_rwlock_wrlock(&codecs->codecs_lock);
    codecs->framing = framing;
    ast_rwlock_unlock(&codecs->codecs_lock);
}

References ast_rwlock_unlock, ast_rwlock_wrlock, and codecs.

Referenced by configure_local_rtp(), get_codecs(), jingle_enable_video(), and jingle_new().

◆ ast_rtp_codecs_set_preferred_dtmf_format()

int ast_rtp_codecs_set_preferred_dtmf_format	(	struct ast_rtp_codecs *	codecs,
		int	pt,
		int	rate
	)

Set the preferred dtmf format pt and sample rate.

Parameters

codecs	Codecs structure to set the preferred format in
pt	Preferred dtmf payload type to set.
rate	Preferred dtmf payload rate to set.

Returns: 0

Note: The format passed this function has its reference count increased. If an existing format is set, that format is replaced.

Example usage:

int dtmf_code = atoi(dtmf_pt);
int dtmf_rate = clock_rate;
ast_rtp_codecs_set_preferred_dtmf_format(codecs, dtmf_code, dtmf_rate);

This sets the preferred dtmf_code and dtmf_rate on the codec.

Definition at line 1607 of file rtp_engine.c.

{
    ast_rwlock_wrlock(&codecs->codecs_lock);
    codecs->preferred_dtmf_pt = pt;
    codecs->preferred_dtmf_rate = rate;
    ast_rwlock_unlock(&codecs->codecs_lock);
    return 0;
}

References ast_rwlock_unlock, ast_rwlock_wrlock, and codecs.

Referenced by get_codecs().

◆ ast_rtp_codecs_set_preferred_format()

int ast_rtp_codecs_set_preferred_format	(	struct ast_rtp_codecs *	codecs,
		struct ast_format *	format
	)

Set the preferred format.

Parameters

codecs	Codecs structure to set the preferred format in
format	Preferred format to set.

Returns: 0

Note: The format passed this function has its reference count increased. If an existing format is set, that format is replaced.

Example usage:

struct ast_format *preferred_format = ast_format_cap_get_format(joint, 0);

ast_rtp_codecs_set_preferred_format(&codecs, preferred_format));

ast_format_cap_get_format

struct ast_format * ast_format_cap_get_format(const struct ast_format_cap *cap, int position)

Get the format at a specific index.

Definition: format_cap.c:400

ast_rtp_codecs_set_preferred_format

int ast_rtp_codecs_set_preferred_format(struct ast_rtp_codecs *codecs, struct ast_format *format)

Set the preferred format.

Definition: rtp_engine.c:1581

This sets the first joint format as the preferred format.

Definition at line 1581 of file rtp_engine.c.

{
    ast_rwlock_wrlock(&codecs->codecs_lock);
    ao2_replace(codecs->preferred_format, format);
    ast_rwlock_unlock(&codecs->codecs_lock);
    return 0;
}

References ao2_replace, ast_rwlock_unlock, ast_rwlock_wrlock, and codecs.

Referenced by set_caps().

◆ ast_rtp_convert_stats_json()

struct ast_json * ast_rtp_convert_stats_json ( const struct ast_rtp_instance_stats * stats )

Convert given stat instance into json format.

Parameters

stats

Returns: A json format stat

Definition at line 4189 of file rtp_engine.c.

{
    struct ast_json *j_res;
    int ret;
 
    j_res = ast_json_object_create();
    if (!j_res) {
        return NULL;
    }
 
    /* set mandatory items */
    ret = ast_json_object_set(j_res, "txcount", ast_json_integer_create(stats->txcount));
    ret |= ast_json_object_set(j_res, "rxcount", ast_json_integer_create(stats->rxcount));
 
    ret |= ast_json_object_set(j_res, "txploss", ast_json_integer_create(stats->txploss));
    ret |= ast_json_object_set(j_res, "rxploss", ast_json_integer_create(stats->rxploss));
 
    ret |= ast_json_object_set(j_res, "local_ssrc", ast_json_integer_create(stats->local_ssrc));
    ret |= ast_json_object_set(j_res, "remote_ssrc", ast_json_integer_create(stats->remote_ssrc));
 
    ret |= ast_json_object_set(j_res, "txoctetcount", ast_json_integer_create(stats->txoctetcount));
    ret |= ast_json_object_set(j_res, "rxoctetcount", ast_json_integer_create(stats->rxoctetcount));
 
    ret |= ast_json_object_set(j_res, "channel_uniqueid", ast_json_string_create(stats->channel_uniqueid));
    if (ret) {
        ast_log(LOG_WARNING, "Could not create rtp statistics info. channel: %s\n", stats->channel_uniqueid);
        ast_json_unref(j_res);
        return NULL;
    }
 
    /* set other items */
    SET_AST_JSON_OBJ(j_res, "txjitter", ast_json_real_create(stats->txjitter));
    SET_AST_JSON_OBJ(j_res, "rxjitter", ast_json_real_create(stats->rxjitter));
 
    SET_AST_JSON_OBJ(j_res, "remote_maxjitter", ast_json_real_create(stats->remote_maxjitter));
    SET_AST_JSON_OBJ(j_res, "remote_minjitter", ast_json_real_create(stats->remote_minjitter));
    SET_AST_JSON_OBJ(j_res, "remote_normdevjitter", ast_json_real_create(stats->remote_normdevjitter));
    SET_AST_JSON_OBJ(j_res, "remote_stdevjitter", ast_json_real_create(stats->remote_stdevjitter));
 
    SET_AST_JSON_OBJ(j_res, "local_maxjitter", ast_json_real_create(stats->local_maxjitter));
    SET_AST_JSON_OBJ(j_res, "local_minjitter", ast_json_real_create(stats->local_minjitter));
    SET_AST_JSON_OBJ(j_res, "local_normdevjitter", ast_json_real_create(stats->local_normdevjitter));
    SET_AST_JSON_OBJ(j_res, "local_stdevjitter", ast_json_real_create(stats->local_stdevjitter));
 
    SET_AST_JSON_OBJ(j_res, "remote_maxrxploss", ast_json_real_create(stats->remote_maxrxploss));
    SET_AST_JSON_OBJ(j_res, "remote_minrxploss", ast_json_real_create(stats->remote_minrxploss));
    SET_AST_JSON_OBJ(j_res, "remote_normdevrxploss", ast_json_real_create(stats->remote_normdevrxploss));
    SET_AST_JSON_OBJ(j_res, "remote_stdevrxploss", ast_json_real_create(stats->remote_stdevrxploss));
 
    SET_AST_JSON_OBJ(j_res, "local_maxrxploss", ast_json_real_create(stats->local_maxrxploss));
    SET_AST_JSON_OBJ(j_res, "local_minrxploss", ast_json_real_create(stats->local_minrxploss));
    SET_AST_JSON_OBJ(j_res, "local_normdevrxploss", ast_json_real_create(stats->local_normdevrxploss));
    SET_AST_JSON_OBJ(j_res, "local_stdevrxploss", ast_json_real_create(stats->local_stdevrxploss));
 
    SET_AST_JSON_OBJ(j_res, "rtt", ast_json_real_create(stats->rtt));
    SET_AST_JSON_OBJ(j_res, "maxrtt", ast_json_real_create(stats->maxrtt));
    SET_AST_JSON_OBJ(j_res, "minrtt", ast_json_real_create(stats->minrtt));
    SET_AST_JSON_OBJ(j_res, "normdevrtt", ast_json_real_create(stats->normdevrtt));
    SET_AST_JSON_OBJ(j_res, "stdevrtt", ast_json_real_create(stats->stdevrtt));
 
    SET_AST_JSON_OBJ(j_res, "txmes", ast_json_integer_create(stats->txmes));
    SET_AST_JSON_OBJ(j_res, "rxmes", ast_json_integer_create(stats->rxmes));
 
    SET_AST_JSON_OBJ(j_res, "remote_maxmes", ast_json_real_create(stats->remote_maxmes));
    SET_AST_JSON_OBJ(j_res, "remote_minmes", ast_json_real_create(stats->remote_minmes));
    SET_AST_JSON_OBJ(j_res, "remote_normdevmes", ast_json_real_create(stats->remote_normdevmes));
    SET_AST_JSON_OBJ(j_res, "remote_stdevmes", ast_json_real_create(stats->remote_stdevmes));
 
    SET_AST_JSON_OBJ(j_res, "local_maxmes", ast_json_real_create(stats->local_maxmes));
    SET_AST_JSON_OBJ(j_res, "local_minmes", ast_json_real_create(stats->local_minmes));
    SET_AST_JSON_OBJ(j_res, "local_normdevmes", ast_json_real_create(stats->local_normdevmes));
    SET_AST_JSON_OBJ(j_res, "local_stdevmes", ast_json_real_create(stats->local_stdevmes));
 
    return j_res;
}

Referenced by ast_rtp_instance_get_stats_all_json().

◆ ast_rtp_dtls_cfg_copy()

void ast_rtp_dtls_cfg_copy	(	const struct ast_rtp_dtls_cfg *	src_cfg,
		struct ast_rtp_dtls_cfg *	dst_cfg
	)

Copy contents of a DTLS configuration structure.

Parameters

src_cfg	source DTLS configuration structure
dst_cfg	destination DTLS configuration structure

Definition at line 3313 of file rtp_engine.c.

{
    ast_rtp_dtls_cfg_free(dst_cfg);         /* Prevent a double-call leaking memory via ast_strdup */
 
    dst_cfg->enabled = src_cfg->enabled;
    dst_cfg->verify = src_cfg->verify;
    dst_cfg->rekey = src_cfg->rekey;
    dst_cfg->suite = src_cfg->suite;
    dst_cfg->hash = src_cfg->hash;
    dst_cfg->ephemeral_cert = src_cfg->ephemeral_cert;
    dst_cfg->certfile = ast_strdup(src_cfg->certfile);
    dst_cfg->pvtfile = ast_strdup(src_cfg->pvtfile);
    dst_cfg->cipher = ast_strdup(src_cfg->cipher);
    dst_cfg->cafile = ast_strdup(src_cfg->cafile);
    dst_cfg->capath = ast_strdup(src_cfg->capath);
    dst_cfg->default_setup = src_cfg->default_setup;
}

References ast_rtp_dtls_cfg_free(), ast_strdup, ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::cipher, ast_rtp_dtls_cfg::default_setup, ast_rtp_dtls_cfg::enabled, ast_rtp_dtls_cfg::ephemeral_cert, ast_rtp_dtls_cfg::hash, ast_rtp_dtls_cfg::pvtfile, ast_rtp_dtls_cfg::rekey, ast_rtp_dtls_cfg::suite, and ast_rtp_dtls_cfg::verify.

◆ ast_rtp_dtls_cfg_free()

void ast_rtp_dtls_cfg_free ( struct ast_rtp_dtls_cfg * dtls_cfg )

Free contents of a DTLS configuration structure.

Parameters

dtls_cfg a DTLS configuration structure

Definition at line 3331 of file rtp_engine.c.

{
    ast_free(dtls_cfg->certfile);
    dtls_cfg->certfile = NULL;
    ast_free(dtls_cfg->pvtfile);
    dtls_cfg->pvtfile = NULL;
    ast_free(dtls_cfg->cipher);
    dtls_cfg->cipher = NULL;
    ast_free(dtls_cfg->cafile);
    dtls_cfg->cafile = NULL;
    ast_free(dtls_cfg->capath);
    dtls_cfg->capath = NULL;
}

References ast_free, ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::cipher, NULL, and ast_rtp_dtls_cfg::pvtfile.

Referenced by ast_rtp_dtls_cfg_copy(), and media_configuration_destroy().

◆ ast_rtp_dtls_cfg_parse()

int ast_rtp_dtls_cfg_parse	(	struct ast_rtp_dtls_cfg *	dtls_cfg,
		const char *	name,
		const char *	value
	)

Parse DTLS related configuration options.

Parameters

dtls_cfg	a DTLS configuration structure
name	name of the configuration option
value	value of the configuration option

Return values

0	if handled
-1	if not handled

Definition at line 3220 of file rtp_engine.c.

{
    if (!strcasecmp(name, "dtlsenable")) {
        dtls_cfg->enabled = ast_true(value) ? 1 : 0;
    } else if (!strcasecmp(name, "dtlsverify")) {
        if (!strcasecmp(value, "yes")) {
            dtls_cfg->verify = AST_RTP_DTLS_VERIFY_FINGERPRINT | AST_RTP_DTLS_VERIFY_CERTIFICATE;
        } else if (!strcasecmp(value, "fingerprint")) {
            dtls_cfg->verify = AST_RTP_DTLS_VERIFY_FINGERPRINT;
        } else if (!strcasecmp(value, "certificate")) {
            dtls_cfg->verify = AST_RTP_DTLS_VERIFY_CERTIFICATE;
        } else if (!strcasecmp(value, "no")) {
            dtls_cfg->verify = AST_RTP_DTLS_VERIFY_NONE;
        } else {
            return -1;
        }
    } else if (!strcasecmp(name, "dtlsrekey")) {
        if (sscanf(value, "%30u", &dtls_cfg->rekey) != 1) {
            return -1;
        }
    } else if (!strcasecmp(name, "dtlsautogeneratecert")) {
        dtls_cfg->ephemeral_cert = ast_true(value) ? 1 : 0;
    } else if (!strcasecmp(name, "dtlscertfile")) {
        if (!ast_strlen_zero(value) && !ast_file_is_readable(value)) {
            ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
            return -1;
        }
        ast_free(dtls_cfg->certfile);
        dtls_cfg->certfile = ast_strdup(value);
    } else if (!strcasecmp(name, "dtlsprivatekey")) {
        if (!ast_strlen_zero(value) && !ast_file_is_readable(value)) {
            ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
            return -1;
        }
        ast_free(dtls_cfg->pvtfile);
        dtls_cfg->pvtfile = ast_strdup(value);
    } else if (!strcasecmp(name, "dtlscipher")) {
        ast_free(dtls_cfg->cipher);
        dtls_cfg->cipher = ast_strdup(value);
    } else if (!strcasecmp(name, "dtlscafile")) {
        if (!ast_strlen_zero(value) && !ast_file_is_readable(value)) {
            ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
            return -1;
        }
        ast_free(dtls_cfg->cafile);
        dtls_cfg->cafile = ast_strdup(value);
    } else if (!strcasecmp(name, "dtlscapath") || !strcasecmp(name, "dtlscadir")) {
        if (!ast_strlen_zero(value) && !ast_file_is_readable(value)) {
            ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
            return -1;
        }
        ast_free(dtls_cfg->capath);
        dtls_cfg->capath = ast_strdup(value);
    } else if (!strcasecmp(name, "dtlssetup")) {
        if (!strcasecmp(value, "active")) {
            dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_ACTIVE;
        } else if (!strcasecmp(value, "passive")) {
            dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_PASSIVE;
        } else if (!strcasecmp(value, "actpass")) {
            dtls_cfg->default_setup = AST_RTP_DTLS_SETUP_ACTPASS;
        }
    } else if (!strcasecmp(name, "dtlsfingerprint")) {
        if (!strcasecmp(value, "sha-256")) {
            dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA256;
        } else if (!strcasecmp(value, "sha-1")) {
            dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA1;
        }
    } else {
        return -1;
    }
 
    return 0;
}

Referenced by dtls_handler(), and media_encryption_handler().

◆ ast_rtp_dtls_cfg_validate()

int ast_rtp_dtls_cfg_validate ( struct ast_rtp_dtls_cfg * dtls_cfg )

Validates DTLS related configuration options.

Parameters

dtls_cfg a DTLS configuration structure

Return values

0	if valid
-1	if invalid

Definition at line 3294 of file rtp_engine.c.

{
    if (dtls_cfg->ephemeral_cert) {
        if (!ast_strlen_zero(dtls_cfg->certfile)) {
            ast_log(LOG_ERROR, "You cannot request automatically generated certificates"
                " (dtls_auto_generate_cert) and also specify a certificate file"
                " (dtls_cert_file) at the same time\n");
            return -1;
        } else if (!ast_strlen_zero(dtls_cfg->pvtfile)
                  || !ast_strlen_zero(dtls_cfg->cafile)
                  || !ast_strlen_zero(dtls_cfg->capath)) {
            ast_log(LOG_NOTICE, "dtls_pvt_file, dtls_cafile, and dtls_ca_path are"
                " ignored when dtls_auto_generate_cert is enabled\n");
        }
    }
 
    return 0;
}

References ast_log, ast_strlen_zero(), ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::ephemeral_cert, LOG_ERROR, LOG_NOTICE, and ast_rtp_dtls_cfg::pvtfile.

Referenced by sip_endpoint_apply_handler().

◆ ast_rtp_engine_alloc_payload_type()

struct ast_rtp_payload_type * ast_rtp_engine_alloc_payload_type ( void )

Allocation routine for ast_rtp_payload_type.

Return values

NULL on error

Returns: An ao2 ref counted ast_rtp_payload_type on success.

Note: The ast_rtp_payload_type returned by this function is an ao2 ref counted object.

Definition at line 325 of file rtp_engine.c.

{
    return rtp_payload_type_alloc(NULL, 0, 0, 0, 0);
}

References NULL, and rtp_payload_type_alloc().

Referenced by ast_rtp_codecs_payload_replace_format(), ast_rtp_codecs_payloads_set_rtpmap_type_rate(), and payload_mapping_rx_clear_primary().

◆ ast_rtp_engine_load_format()

int ast_rtp_engine_load_format ( struct ast_format * format )

Custom formats declared in codecs.conf at startup must be communicated to the rtp_engine so their mime type can payload number can be initialized.

Definition at line 3429 of file rtp_engine.c.

{
    char *codec_name = ast_strdupa(ast_format_get_codec_name(format));
 
    codec_name = ast_str_to_upper(codec_name);
 
    set_next_mime_type(format,
        0,
        ast_codec_media_type2str(ast_format_get_type(format)),
        codec_name,
        ast_format_get_sample_rate(format));
    add_static_payload(-1, format, 0);
 
    return 0;
}

References add_static_payload(), ast_codec_media_type2str(), ast_format_get_codec_name(), ast_format_get_sample_rate(), ast_format_get_type(), ast_str_to_upper(), ast_strdupa, ast_rtp_payload_type::format, and set_next_mime_type().

Referenced by load_module().

◆ ast_rtp_engine_register2()

int ast_rtp_engine_register2	(	struct ast_rtp_engine *	engine,
		struct ast_module *	module
	)

Register an RTP engine.

Parameters

engine	Structure of the RTP engine to register
module	Module that the RTP engine is part of

Return values

0	success
-1	failure

Example usage:

ast_rtp_engine_register2(&example_rtp_engine, NULL);

ast_rtp_engine_register2

int ast_rtp_engine_register2(struct ast_rtp_engine *engine, struct ast_module *module)

Register an RTP engine.

Definition: rtp_engine.c:330

This registers the RTP engine declared as example_rtp_engine with the RTP engine core, but does not associate a module with it.

Note: It is recommended that you use the ast_rtp_engine_register macro so that the module is associated with the RTP engine and use counting is performed.

Since: 1.8

Definition at line 330 of file rtp_engine.c.

{
    struct ast_rtp_engine *current_engine;
 
    /* Perform a sanity check on the engine structure to make sure it has the basics */
    if (ast_strlen_zero(engine->name) || !engine->new || !engine->destroy || !engine->write || !engine->read) {
        ast_log(LOG_WARNING, "RTP Engine '%s' failed sanity check so it was not registered.\n", !ast_strlen_zero(engine->name) ? engine->name : "Unknown");
        return -1;
    }
 
    /* Link owner module to the RTP engine for reference counting purposes */
    engine->mod = module;
 
    AST_RWLIST_WRLOCK(&engines);
 
    /* Ensure that no two modules with the same name are registered at the same time */
    AST_RWLIST_TRAVERSE(&engines, current_engine, entry) {
        if (!strcmp(current_engine->name, engine->name)) {
            ast_log(LOG_WARNING, "An RTP engine with the name '%s' has already been registered.\n", engine->name);
            AST_RWLIST_UNLOCK(&engines);
            return -1;
        }
    }
 
    /* The engine survived our critique. Off to the list it goes to be used */
    AST_RWLIST_INSERT_TAIL(&engines, engine, entry);
 
    AST_RWLIST_UNLOCK(&engines);
 
    ast_verb(5, "Registered RTP engine '%s'\n", engine->name);
 
    return 0;
}

References ast_log, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), ast_verb, ast_rtp_engine::destroy, LOG_WARNING, ast_rtp_engine::mod, ast_rtp_engine::name, ast_rtp_engine::new, ast_rtp_engine::read, and ast_rtp_engine::write.

◆ ast_rtp_engine_register_srtp()

int ast_rtp_engine_register_srtp	(	struct ast_srtp_res *	srtp_res,
		struct ast_srtp_policy_res *	policy_res
	)

Definition at line 2910 of file rtp_engine.c.

{
    if (res_srtp || res_srtp_policy) {
        return -1;
    }
    if (!srtp_res || !policy_res) {
        return -1;
    }
 
    res_srtp = srtp_res;
    res_srtp_policy = policy_res;
 
    return 0;
}

References policy_res, res_srtp, res_srtp_policy, and srtp_res.

Referenced by res_srtp_init().

◆ ast_rtp_engine_srtp_is_registered()

int ast_rtp_engine_srtp_is_registered ( void )

Definition at line 2931 of file rtp_engine.c.

{
    return res_srtp && res_srtp_policy;
}

References res_srtp, and res_srtp_policy.

Referenced by ast_sdp_srtp_alloc().

◆ ast_rtp_engine_unload_format()

int ast_rtp_engine_unload_format ( struct ast_format * format )

Formats requiring the use of a format attribute interface must have that interface registered in order for the rtp engine to handle it correctly. If an attribute interface is unloaded, this function must be called to notify the rtp_engine.

Definition at line 3445 of file rtp_engine.c.

{
    int x;
    int y = 0;
 
    ast_rwlock_wrlock(&static_RTP_PT_lock);
    /* remove everything pertaining to this format id from the lists */
    for (x = 0; x < AST_RTP_MAX_PT; x++) {
        if (static_RTP_PT[x]
            && ast_format_cmp(static_RTP_PT[x]->format, format) == AST_FORMAT_CMP_EQUAL) {
            ao2_ref(static_RTP_PT[x], -1);
            static_RTP_PT[x] = NULL;
        }
    }
    ast_rwlock_unlock(&static_RTP_PT_lock);
 
    ast_rwlock_wrlock(&mime_types_lock);
    /* rebuild the list skipping the items matching this id */
    for (x = 0; x < mime_types_len; x++) {
        if (ast_format_cmp(ast_rtp_mime_types[x].payload_type.format, format) == AST_FORMAT_CMP_EQUAL) {
            rtp_engine_mime_type_cleanup(x);
            continue;
        }
        if (x != y) {
            ast_rtp_mime_types[y] = ast_rtp_mime_types[x];
        }
        y++;
    }
    mime_types_len = y;
    ast_rwlock_unlock(&mime_types_lock);
    return 0;
}

References ao2_ref, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_RTP_MAX_PT, ast_rtp_mime_types, ast_rwlock_unlock, ast_rwlock_wrlock, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, NULL, rtp_engine_mime_type_cleanup(), static_RTP_PT, and static_RTP_PT_lock.

Referenced by unload_module().

◆ ast_rtp_engine_unregister()

int ast_rtp_engine_unregister ( struct ast_rtp_engine * engine )

Unregister an RTP engine.

Parameters

engine Structure of the RTP engine to unregister

Return values

0	success
-1	failure

Example usage:

ast_rtp_engine_unregister(&example_rtp_engine);

ast_rtp_engine_unregister

int ast_rtp_engine_unregister(struct ast_rtp_engine *engine)

Unregister an RTP engine.

Definition: rtp_engine.c:364

This unregisters the RTP engine declared as example_rtp_engine from the RTP engine core. If a module reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.

Since: 1.8

Definition at line 364 of file rtp_engine.c.

{
    struct ast_rtp_engine *current_engine = NULL;
 
    AST_RWLIST_WRLOCK(&engines);
 
    if ((current_engine = AST_RWLIST_REMOVE(&engines, engine, entry))) {
        ast_verb(5, "Unregistered RTP engine '%s'\n", engine->name);
    }
 
    AST_RWLIST_UNLOCK(&engines);
 
    return current_engine ? 0 : -1;
}

References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, ast_rtp_engine::name, and NULL.

Referenced by load_module(), and unload_module().

◆ ast_rtp_engine_unregister_srtp()

void ast_rtp_engine_unregister_srtp ( void )

Definition at line 2925 of file rtp_engine.c.

{
    res_srtp = NULL;
    res_srtp_policy = NULL;
}

References NULL, res_srtp, and res_srtp_policy.

Referenced by res_srtp_shutdown().

◆ ast_rtp_get_rate()

int ast_rtp_get_rate ( const struct ast_format * format )

Retrieve the sample rate of a format according to RTP specifications.

Since: 16.7.0; 17.1.0

Parameters

format The media format

Returns: The sample rate

Definition at line 4276 of file rtp_engine.c.

{
    /* For those wondering: due to a fluke in RFC publication, G.722 is advertised
     * as having a sample rate of 8kHz, while implementations must know that its
     * real rate is 16kHz. Seriously.
     */
        return (ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL) ? 8000 : (int)ast_format_get_sample_rate(format);
}

References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_g722, and ast_format_get_sample_rate().

Referenced by ast_rtcp_calculate_sr_rr_statistics(), ast_rtcp_interpret(), ast_rtp_dtmf_end_with_duration(), ast_rtp_interpret(), calc_rxstamp_and_jitter(), jitterbuffer_frame_get_ntp_timestamp(), process_dtmf_cisco(), process_dtmf_rfc2833(), rtp_raw_write(), and update_jitter_stats().

◆ ast_rtp_glue_register2()

int ast_rtp_glue_register2	(	struct ast_rtp_glue *	glue,
		struct ast_module *	module
	)

Register RTP glue.

Parameters

glue	The glue to register
module	Module that the RTP glue is part of

Return values

0	success
-1	failure

Example usage:

ast_rtp_glue_register2(&example_rtp_glue, NULL);

ast_rtp_glue_register2

int ast_rtp_glue_register2(struct ast_rtp_glue *glue, struct ast_module *module)

Register RTP glue.

Definition: rtp_engine.c:379

This registers the RTP glue declared as example_rtp_glue with the RTP engine core, but does not associate a module with it.

Note: It is recommended that you use the ast_rtp_glue_register macro so that the module is associated with the RTP glue and use counting is performed.

Since: 1.8

Definition at line 379 of file rtp_engine.c.

{
    struct ast_rtp_glue *current_glue = NULL;
 
    if (ast_strlen_zero(glue->type)) {
        return -1;
    }
 
    glue->mod = module;
 
    AST_RWLIST_WRLOCK(&glues);
 
    AST_RWLIST_TRAVERSE(&glues, current_glue, entry) {
        if (!strcasecmp(current_glue->type, glue->type)) {
            ast_log(LOG_WARNING, "RTP glue with the name '%s' has already been registered.\n", glue->type);
            AST_RWLIST_UNLOCK(&glues);
            return -1;
        }
    }
 
    AST_RWLIST_INSERT_TAIL(&glues, glue, entry);
 
    AST_RWLIST_UNLOCK(&glues);
 
    ast_verb(5, "Registered RTP glue '%s'\n", glue->type);
 
    return 0;
}

References ast_log, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), ast_verb, LOG_WARNING, ast_rtp_glue::mod, NULL, and ast_rtp_glue::type.

◆ ast_rtp_glue_unregister()

int ast_rtp_glue_unregister ( struct ast_rtp_glue * glue )

Unregister RTP glue.

Parameters

glue	The glue to unregister

Return values

0	success
-1	failure

Example usage:

ast_rtp_glue_unregister(&example_rtp_glue);

ast_rtp_glue_unregister

int ast_rtp_glue_unregister(struct ast_rtp_glue *glue)

Unregister RTP glue.

Definition: rtp_engine.c:408

This unregisters the RTP glue declared as example_rtp_gkue from the RTP engine core. If a module reference was provided when it was registered then this will only be called once the RTP engine is no longer in use.

Since: 1.8

Definition at line 408 of file rtp_engine.c.

{
    struct ast_rtp_glue *current_glue = NULL;
 
    AST_RWLIST_WRLOCK(&glues);
 
    if ((current_glue = AST_RWLIST_REMOVE(&glues, glue, entry))) {
        ast_verb(5, "Unregistered RTP glue '%s'\n", glue->type);
    }
 
    AST_RWLIST_UNLOCK(&glues);
 
    return current_glue ? 0 : -1;
}

References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, NULL, and ast_rtp_glue::type.

Referenced by load_module(), and unload_module().

◆ ast_rtp_instance_activate()

int ast_rtp_instance_activate ( struct ast_rtp_instance * instance )

Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance.

Parameters

instance The RTP instance

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_activate(instance);

ast_rtp_instance_activate

int ast_rtp_instance_activate(struct ast_rtp_instance *instance)

Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance.

Definition: rtp_engine.c:2847

This tells the underlying RTP engine of instance that packets will now flow.

Since: 1.8

Definition at line 2847 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->activate) {
        ao2_lock(instance);
        res = instance->engine->activate(instance);
        ao2_unlock(instance);
    } else {
        res = 0;
    }
    return res;
}

References ast_rtp_engine::activate, ao2_lock, ao2_unlock, and ast_rtp_instance::engine.

Referenced by apply_negotiated_sdp_stream(), rtp_call(), and test_init_rtp_instances().

◆ ast_rtp_instance_add_srtp_policy()

int ast_rtp_instance_add_srtp_policy	(	struct ast_rtp_instance *	instance,
		struct ast_srtp_policy *	remote_policy,
		struct ast_srtp_policy *	local_policy,
		int	rtcp
	)

Add or replace the SRTP policies for the given RTP instance.

Parameters

instance	the RTP instance
remote_policy	the remote endpoint's policy
local_policy	our policy for this RTP instance's remote endpoint
rtcp	1 for dedicated RTCP policies

Return values

0	Success
non-zero	Failure

Note: If no remote policy is provided any existing SRTP policies are left and the new local policy is added

Definition at line 2936 of file rtp_engine.c.

{
    int res = 0;
    struct ast_srtp **srtp;
 
    if (!res_srtp) {
        return -1;
    }
 
    ao2_lock(instance);
 
    srtp = rtcp ? &instance->rtcp_srtp : &instance->srtp;
 
    if (!*srtp) {
        res = res_srtp->create(srtp, instance, remote_policy);
    } else if (remote_policy) {
        res = res_srtp->replace(srtp, instance, remote_policy);
    }
    if (!res) {
        res = res_srtp->add_stream(*srtp, local_policy);
    }
 
    ao2_unlock(instance);
 
    return res;
}

References ast_srtp_res::add_stream, ao2_lock, ao2_unlock, ast_srtp_res::create, ast_srtp_res::replace, res_srtp, ast_rtp_instance::rtcp_srtp, and ast_rtp_instance::srtp.

Referenced by crypto_activate().

◆ ast_rtp_instance_available_formats()

void ast_rtp_instance_available_formats	(	struct ast_rtp_instance *	instance,
		struct ast_format_cap *	to_endpoint,
		struct ast_format_cap *	to_asterisk,
		struct ast_format_cap *	result
	)

Request the formats that can be transcoded.

Parameters

instance	The RTP instance
to_endpoint	Formats being sent/received towards the endpoint
to_asterisk	Formats being sent/received towards Asterisk
result	capabilities structure to store and return supported formats in.

Example usage:

ast_rtp_instance_available_formats(instance, to_capabilities, from_capabilities, result_capabilities);

ast_rtp_instance_available_formats

void ast_rtp_instance_available_formats(struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result)

Request the formats that can be transcoded.

Definition: rtp_engine.c:2833

This sees if it is possible to have ulaw communicated to the endpoint but signed linear received into Asterisk.

Since: 1.8

Definition at line 2833 of file rtp_engine.c.

{
    if (instance->engine->available_formats) {
        ao2_lock(instance);
        instance->engine->available_formats(instance, to_endpoint, to_asterisk, result);
        ao2_unlock(instance);
        if (ast_format_cap_count(result)) {
            return;
        }
    }
 
    ast_translate_available_formats(to_endpoint, to_asterisk, result);
}

References ao2_lock, ao2_unlock, ast_format_cap_count(), ast_translate_available_formats(), ast_rtp_engine::available_formats, ast_rtp_instance::engine, and result.

◆ ast_rtp_instance_bundle()

int ast_rtp_instance_bundle	(	struct ast_rtp_instance *	child,
		struct ast_rtp_instance *	parent
	)

Request that an RTP instance be bundled with another.

Since: 15.0.0

Parameters

child	The child RTP instance
parent	The parent RTP instance the child should be bundled with

Return values

0	success
-1	failure

Definition at line 4037 of file rtp_engine.c.

{
    int res = -1;
 
    if (parent && (child->engine != parent->engine)) {
        return -1;
    }
 
    ao2_lock(child);
    if (child->engine->bundle) {
        res = child->engine->bundle(child, parent);
    }
    ao2_unlock(child);
 
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_engine::bundle, and ast_rtp_instance::engine.

Referenced by apply_negotiated_sdp_stream(), and negotiate_incoming_sdp_stream().

◆ ast_rtp_instance_change_source()

void ast_rtp_instance_change_source ( struct ast_rtp_instance * instance )

Indicate a new source of audio has dropped in and the ssrc should change.

Parameters

instance Instance that the new media source is feeding into

Example usage:

ast_rtp_instance_change_source(instance);

ast_rtp_instance_change_source

void ast_rtp_instance_change_source(struct ast_rtp_instance *instance)

Indicate a new source of audio has dropped in and the ssrc should change.

Definition: rtp_engine.c:2336

This indicates that the source of media that is feeding the instance pointed to by instance has changed and that the marker bit should be set and the SSRC updated.

Since: 1.8

Definition at line 2336 of file rtp_engine.c.

{
    if (instance->engine->change_source) {
        ao2_lock(instance);
        instance->engine->change_source(instance);
        ao2_unlock(instance);
    }
}

References ao2_lock, ao2_unlock, ast_rtp_engine::change_source, and ast_rtp_instance::engine.

Referenced by create_outgoing_sdp_stream(), jingle_indicate(), ooh323_indicate(), and unistim_indicate().

◆ ast_rtp_instance_destroy()

int ast_rtp_instance_destroy ( struct ast_rtp_instance * instance )

Destroy an RTP instance.

Parameters

instance The RTP instance to destroy

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_destroy(instance);

ast_rtp_instance_destroy

int ast_rtp_instance_destroy(struct ast_rtp_instance *instance)

Destroy an RTP instance.

Definition: rtp_engine.c:458

This destroys the RTP instance pointed to by instance. Once this function returns instance no longer points to valid memory and may not be used again.

Since: 1.8

Definition at line 458 of file rtp_engine.c.

{
    if (!instance) {
        return 0;
    }
    if (ast_debug_rtp_is_allowed) {
        char buffer[4][512];
        ast_debug_rtp(1, "%s:\n"
            "  RTT:    %s\n"
            "  Loss:   %s\n"
            "  Jitter: %s\n"
            "  MES:    %s\n",
            instance->channel_uniqueid,
            ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT,
                buffer[0], sizeof(buffer[0])),
            ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS,
                buffer[1], sizeof(buffer[1])),
            ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER,
                buffer[2], sizeof(buffer[2])),
            ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES,
                buffer[3], sizeof(buffer[3]))
        );
    }
 
    ao2_cleanup(instance);
 
    return 0;
}

References ao2_cleanup, ast_debug_rtp, ast_debug_rtp_is_allowed, ast_rtp_instance_get_quality(), AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, and ast_rtp_instance::channel_uniqueid.

Referenced by AST_TEST_DEFINE(), jingle_session_destructor(), multicast_rtp_request(), ooh323_destroy(), rtp_hangup(), stream_destroy(), unicast_rtp_request(), and unistim_hangup_clean().

◆ ast_rtp_instance_dtmf_begin()

int ast_rtp_instance_dtmf_begin	(	struct ast_rtp_instance *	instance,
		char	digit
	)

Begin sending a DTMF digit.

Parameters

instance	The RTP instance to send the DTMF on
digit	What DTMF digit to send

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_dtmf_begin(instance, '1');

ast_rtp_instance_dtmf_begin

int ast_rtp_instance_dtmf_begin(struct ast_rtp_instance *instance, char digit)

Begin sending a DTMF digit.

Definition: rtp_engine.c:2257

This starts sending the DTMF '1' on the RTP instance pointed to by instance. It will continue being sent until it is ended.

Since: 1.8

Definition at line 2257 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->dtmf_begin) {
        ao2_lock(instance);
        res = instance->engine->dtmf_begin(instance, digit);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, digit, ast_rtp_engine::dtmf_begin, and ast_rtp_instance::engine.

Referenced by chan_pjsip_digit_begin(), jingle_digit_begin(), and ooh323_digit_begin().

◆ ast_rtp_instance_dtmf_end()

int ast_rtp_instance_dtmf_end	(	struct ast_rtp_instance *	instance,
		char	digit
	)

Stop sending a DTMF digit.

Parameters

instance	The RTP instance to stop the DTMF on
digit	What DTMF digit to stop

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_dtmf_end(instance, '1');

ast_rtp_instance_dtmf_end

int ast_rtp_instance_dtmf_end(struct ast_rtp_instance *instance, char digit)

Stop sending a DTMF digit.

Definition: rtp_engine.c:2271

This stops sending the DTMF '1' on the RTP instance pointed to by instance.

Since: 1.8

Definition at line 2271 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->dtmf_end) {
        ao2_lock(instance);
        res = instance->engine->dtmf_end(instance, digit);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, digit, ast_rtp_engine::dtmf_end, and ast_rtp_instance::engine.

Referenced by ooh323_digit_end().

◆ ast_rtp_instance_dtmf_end_with_duration()

int ast_rtp_instance_dtmf_end_with_duration	(	struct ast_rtp_instance *	instance,
		char	digit,
		unsigned int	duration
	)

Definition at line 2285 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->dtmf_end_with_duration) {
        ao2_lock(instance);
        res = instance->engine->dtmf_end_with_duration(instance, digit, duration);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, digit, ast_rtp_engine::dtmf_end_with_duration, and ast_rtp_instance::engine.

Referenced by chan_pjsip_digit_end(), and jingle_digit_end().

◆ ast_rtp_instance_dtmf_mode_get()

enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get ( struct ast_rtp_instance * instance )

Get the DTMF mode of an RTP instance.

Parameters

instance The RTP instance to get the DTMF mode of

Returns: DTMF mode

Example usage:

enum ast_rtp_dtmf_mode dtmf_mode = ast_rtp_instance_dtmf_mode_get(instance);

ast_rtp_instance_dtmf_mode_get

enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get(struct ast_rtp_instance *instance)

Get the DTMF mode of an RTP instance.

Definition: rtp_engine.c:2313

ast_rtp_dtmf_mode

Definition: rtp_engine.h:151

This gets the DTMF mode set on the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2313 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->dtmf_mode_get) {
        ao2_lock(instance);
        res = instance->engine->dtmf_mode_get(instance);
        ao2_unlock(instance);
    } else {
        res = 0;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_engine::dtmf_mode_get, and ast_rtp_instance::engine.

Referenced by chan_pjsip_digit_begin(), chan_pjsip_digit_end(), native_rtp_bridge_compatible_check(), pjsip_acf_dtmf_mode_write(), and set_caps().

◆ ast_rtp_instance_dtmf_mode_set()

int ast_rtp_instance_dtmf_mode_set	(	struct ast_rtp_instance *	instance,
		enum ast_rtp_dtmf_mode	dtmf_mode
	)

Set the DTMF mode that should be used.

Parameters

instance	the RTP instance to set DTMF mode on
dtmf_mode	The DTMF mode that is in use

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_dtmf_mode_set(instance, AST_RTP_DTMF_MODE_RFC2833);

ast_rtp_instance_dtmf_mode_set

int ast_rtp_instance_dtmf_mode_set(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)

Set the DTMF mode that should be used.

Definition: rtp_engine.c:2299

This sets the RTP instance to use RFC2833 for DTMF transmission and receiving.

Since: 1.8

Definition at line 2299 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->dtmf_mode_set) {
        ao2_lock(instance);
        res = instance->engine->dtmf_mode_set(instance, dtmf_mode);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_engine::dtmf_mode_set, and ast_rtp_instance::engine.

Referenced by create_rtp(), get_codecs(), and pjsip_acf_dtmf_mode_write().

◆ ast_rtp_instance_early_bridge()

int ast_rtp_instance_early_bridge	(	struct ast_channel *	c0,
		struct ast_channel *	c1
	)

Early bridge two channels that use RTP instances.

Parameters

c0	First channel part of the bridge
c1	Second channel part of the bridge

Return values

0	success
-1	failure

Note: This should only be used by channel drivers in their technology declaration.

Since: 1.8

Definition at line 2513 of file rtp_engine.c.

{
    struct ast_rtp_instance *instance0 = NULL, *instance1 = NULL,
            *vinstance0 = NULL, *vinstance1 = NULL,
            *tinstance0 = NULL, *tinstance1 = NULL;
    struct ast_rtp_glue *glue0, *glue1;
    enum ast_rtp_glue_result audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID, video_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
    enum ast_rtp_glue_result audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID, video_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
    struct ast_format_cap *cap0 = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    struct ast_format_cap *cap1 = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
 
    /* If there is no second channel just immediately bail out, we are of no use in that scenario */
    if (!c1 || !cap1 || !cap0) {
        ao2_cleanup(cap0);
        ao2_cleanup(cap1);
        return -1;
    }
 
    /* Lock both channels so we can look for the glue that binds them together */
    ast_channel_lock_both(c0, c1);
 
    /* Grab glue that binds each channel to something using the RTP engine */
    if (!(glue0 = ast_rtp_instance_get_glue(ast_channel_tech(c0)->type)) || !(glue1 = ast_rtp_instance_get_glue(ast_channel_tech(c1)->type))) {
        ast_log(LOG_WARNING, "Can't find native functions for channel '%s'\n", glue0 ? ast_channel_name(c1) : ast_channel_name(c0));
        goto done;
    }
 
    audio_glue0_res = glue0->get_rtp_info(c0, &instance0);
    video_glue0_res = glue0->get_vrtp_info ? glue0->get_vrtp_info(c0, &vinstance0) : AST_RTP_GLUE_RESULT_FORBID;
 
    audio_glue1_res = glue1->get_rtp_info(c1, &instance1);
    video_glue1_res = glue1->get_vrtp_info ? glue1->get_vrtp_info(c1, &vinstance1) : AST_RTP_GLUE_RESULT_FORBID;
 
    /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
    if (video_glue0_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue0_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue0_res != AST_RTP_GLUE_RESULT_REMOTE)) {
        audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
    }
    if (video_glue1_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue1_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue1_res != AST_RTP_GLUE_RESULT_REMOTE)) {
        audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
    }
    if (audio_glue0_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue0_res == AST_RTP_GLUE_RESULT_FORBID || video_glue0_res == AST_RTP_GLUE_RESULT_REMOTE) && glue0->get_codec) {
        glue0->get_codec(c0, cap0);
    }
    if (audio_glue1_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue1_res == AST_RTP_GLUE_RESULT_FORBID || video_glue1_res == AST_RTP_GLUE_RESULT_REMOTE) && glue1->get_codec) {
        glue1->get_codec(c1, cap1);
    }
 
    /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
    if (audio_glue0_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue1_res != AST_RTP_GLUE_RESULT_REMOTE) {
        goto done;
    }
 
    /* Make sure we have matching codecs */
    if (!ast_format_cap_iscompatible(cap0, cap1)) {
        goto done;
    }
 
    /* Bridge media early */
    if (glue0->update_peer(c0, instance1, vinstance1, tinstance1, cap1, 0)) {
        ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
    }
 
done:
    ast_channel_unlock(c0);
    ast_channel_unlock(c1);
 
    ao2_cleanup(cap0);
    ao2_cleanup(cap1);
 
    unref_instance_cond(&instance0);
    unref_instance_cond(&instance1);
    unref_instance_cond(&vinstance0);
    unref_instance_cond(&vinstance1);
    unref_instance_cond(&tinstance0);
    unref_instance_cond(&tinstance1);
 
    ast_debug(1, "Setting early bridge SDP of '%s' with that of '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
 
    return 0;
}

References ao2_cleanup, ast_channel_lock_both, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, ast_debug, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_iscompatible(), ast_log, AST_RTP_GLUE_RESULT_FORBID, AST_RTP_GLUE_RESULT_REMOTE, ast_rtp_instance_get_glue(), done, ast_rtp_glue::get_codec, ast_rtp_glue::get_rtp_info, ast_rtp_glue::get_vrtp_info, LOG_WARNING, NULL, type, unref_instance_cond(), and ast_rtp_glue::update_peer.

◆ ast_rtp_instance_early_bridge_make_compatible()

void ast_rtp_instance_early_bridge_make_compatible	(	struct ast_channel *	c_dst,
		struct ast_channel *	c_src
	)

Make two channels compatible for early bridging.

Parameters

c_dst	Destination channel to copy to
c_src	Source channel to copy from

Since: 1.8

Definition at line 2427 of file rtp_engine.c.

{
    struct ast_rtp_instance *instance_dst = NULL, *instance_src = NULL,
        *vinstance_dst = NULL, *vinstance_src = NULL,
        *tinstance_dst = NULL, *tinstance_src = NULL;
    struct ast_rtp_glue *glue_dst, *glue_src;
    enum ast_rtp_glue_result audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
    enum ast_rtp_glue_result audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
    struct ast_format_cap *cap_dst = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    struct ast_format_cap *cap_src = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
 
    /* Lock both channels so we can look for the glue that binds them together */
    ast_channel_lock_both(c_dst, c_src);
 
    if (!cap_src || !cap_dst) {
        goto done;
    }
 
    /* Grab glue that binds each channel to something using the RTP engine */
    if (!(glue_dst = ast_rtp_instance_get_glue(ast_channel_tech(c_dst)->type)) || !(glue_src = ast_rtp_instance_get_glue(ast_channel_tech(c_src)->type))) {
        ast_debug(1, "Can't find native functions for channel '%s'\n", glue_dst ? ast_channel_name(c_src) : ast_channel_name(c_dst));
        goto done;
    }
 
    audio_glue_dst_res = glue_dst->get_rtp_info(c_dst, &instance_dst);
    video_glue_dst_res = glue_dst->get_vrtp_info ? glue_dst->get_vrtp_info(c_dst, &vinstance_dst) : AST_RTP_GLUE_RESULT_FORBID;
 
    audio_glue_src_res = glue_src->get_rtp_info(c_src, &instance_src);
    video_glue_src_res = glue_src->get_vrtp_info ? glue_src->get_vrtp_info(c_src, &vinstance_src) : AST_RTP_GLUE_RESULT_FORBID;
 
    /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
    if (video_glue_dst_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE)) {
        audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
    }
    if (video_glue_src_res != AST_RTP_GLUE_RESULT_FORBID && (audio_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE || video_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE)) {
        audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
    }
    if (audio_glue_dst_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue_dst_res == AST_RTP_GLUE_RESULT_FORBID || video_glue_dst_res == AST_RTP_GLUE_RESULT_REMOTE) && glue_dst->get_codec) {
        glue_dst->get_codec(c_dst, cap_dst);
    }
    if (audio_glue_src_res == AST_RTP_GLUE_RESULT_REMOTE && (video_glue_src_res == AST_RTP_GLUE_RESULT_FORBID || video_glue_src_res == AST_RTP_GLUE_RESULT_REMOTE) && glue_src->get_codec) {
        glue_src->get_codec(c_src, cap_src);
    }
 
    /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
    if (audio_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE) {
        goto done;
    }
 
    /* Make sure we have matching codecs */
    if (!ast_format_cap_iscompatible(cap_dst, cap_src)) {
        goto done;
    }
 
    ast_rtp_codecs_payloads_xover(&instance_src->codecs, &instance_dst->codecs, instance_dst);
 
    if (vinstance_dst && vinstance_src) {
        ast_rtp_codecs_payloads_xover(&vinstance_src->codecs, &vinstance_dst->codecs, vinstance_dst);
    }
    if (tinstance_dst && tinstance_src) {
        ast_rtp_codecs_payloads_xover(&tinstance_src->codecs, &tinstance_dst->codecs, tinstance_dst);
    }
 
    if (glue_dst->update_peer(c_dst, instance_src, vinstance_src, tinstance_src, cap_src, 0)) {
        ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n",
            ast_channel_name(c_dst), ast_channel_name(c_src));
    } else {
        ast_debug(1, "Seeded SDP of '%s' with that of '%s'\n",
            ast_channel_name(c_dst), ast_channel_name(c_src));
    }
 
done:
    ast_channel_unlock(c_dst);
    ast_channel_unlock(c_src);
 
    ao2_cleanup(cap_dst);
    ao2_cleanup(cap_src);
 
    unref_instance_cond(&instance_dst);
    unref_instance_cond(&instance_src);
    unref_instance_cond(&vinstance_dst);
    unref_instance_cond(&vinstance_src);
    unref_instance_cond(&tinstance_dst);
    unref_instance_cond(&tinstance_src);
}

References ao2_cleanup, ast_channel_lock_both, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, ast_debug, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_iscompatible(), ast_log, ast_rtp_codecs_payloads_xover(), AST_RTP_GLUE_RESULT_FORBID, AST_RTP_GLUE_RESULT_REMOTE, ast_rtp_instance_get_glue(), ast_rtp_instance::codecs, done, ast_rtp_glue::get_codec, ast_rtp_glue::get_rtp_info, ast_rtp_glue::get_vrtp_info, LOG_WARNING, NULL, type, unref_instance_cond(), and ast_rtp_glue::update_peer.

Referenced by dial_exec_full(), and do_forward().

◆ ast_rtp_instance_extmap_clear()

void ast_rtp_instance_extmap_clear ( struct ast_rtp_instance * instance )

Clear negotiated RTP extension information.

Parameters

instance The RTP instance to clear negotiated extension information on

Definition at line 884 of file rtp_engine.c.

{
    static const struct rtp_extmap extmap_none = {
        .extension = AST_RTP_EXTENSION_UNSUPPORTED,
        .direction = AST_RTP_EXTENSION_DIRECTION_NONE,
    };
    int idx;
 
    ao2_lock(instance);
 
    /* Clear both the known unique ids and the negotiated extensions as we are about to have
     * new results set on us.
     */
    for (idx = 0; idx < AST_VECTOR_SIZE(&instance->extmap_unique_ids); ++idx) {
        AST_VECTOR_REPLACE(&instance->extmap_unique_ids, idx, extmap_none);
    }
 
    for (idx = 0; idx < AST_VECTOR_SIZE(&instance->extmap_negotiated); ++idx) {
        AST_VECTOR_REPLACE(&instance->extmap_negotiated, idx, -1);
    }
 
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::extension, ast_rtp_instance::extmap_negotiated, and ast_rtp_instance::extmap_unique_ids.

Referenced by process_extmap_attributes().

◆ ast_rtp_instance_extmap_count()

size_t ast_rtp_instance_extmap_count ( struct ast_rtp_instance * instance )

Get the number of known unique identifiers.

Parameters

instance The RTP instance to retrieve the count from

Returns: the number of known unique identifiers

Since: 15.5.0

Definition at line 921 of file rtp_engine.c.

{
    size_t count;
 
    ao2_lock(instance);
    count = AST_VECTOR_SIZE(&instance->extmap_unique_ids);
    ao2_unlock(instance);
 
    return count;
}

References ao2_lock, ao2_unlock, AST_VECTOR_SIZE, and ast_rtp_instance::extmap_unique_ids.

Referenced by add_extmap_to_stream(), and enable_rtp_extension().

◆ ast_rtp_instance_extmap_enable()

int ast_rtp_instance_extmap_enable	(	struct ast_rtp_instance *	instance,
		int	id,
		enum ast_rtp_extension	extension,
		enum ast_rtp_extension_direction	direction
	)

Enable support for an RTP extension on an instance.

Parameters

instance	The RTP instance to enable the extension on
id	The unique local identifier to use for this extension (-1 to have one auto selected)
extension	The RTP extension
direction	The initial direction that the RTP extension should be used in

Return values

0	success
-1	failure

Since: 15.5.0

Definition at line 754 of file rtp_engine.c.

{
    struct rtp_extmap extmap = {
        .extension = extension,
        .direction = direction,
    };
 
    ao2_lock(instance);
 
    if (!instance->engine->extension_enable || !instance->engine->extension_enable(instance, extension)) {
        ao2_unlock(instance);
        return 0;
    }
 
    /* We store enabled extensions separately so we can easily do negotiation */
    if (AST_VECTOR_REPLACE(&instance->extmap_enabled, extension, direction)) {
        ao2_unlock(instance);
        return -1;
    }
 
    if (id <= 0) {
        /* We find a free unique identifier for this extension by just appending it to the
         * vector of unique ids. The size of the vector will become its unique identifier.
         * As well when we are asking for information on the extensions it will be returned,
         * allowing it to be added to the SDP offer.
         */
        if (AST_VECTOR_APPEND(&instance->extmap_unique_ids, extmap)) {
            AST_VECTOR_REPLACE(&instance->extmap_enabled, extension, AST_RTP_EXTENSION_DIRECTION_NONE);
            ao2_unlock(instance);
            return -1;
        }
        id = AST_VECTOR_SIZE(&instance->extmap_unique_ids);
    } else {
        /* Otherwise we put it precisely where they want it */
        if (AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap)) {
            AST_VECTOR_REPLACE(&instance->extmap_enabled, extension, AST_RTP_EXTENSION_DIRECTION_NONE);
            ao2_unlock(instance);
            return -1;
        }
    }
 
    /* Now that we have an id add the extension to here */
    if (AST_VECTOR_REPLACE(&instance->extmap_negotiated, extension, id)) {
        extmap.extension = AST_RTP_EXTENSION_UNSUPPORTED;
        extmap.direction = AST_RTP_EXTENSION_DIRECTION_NONE;
        AST_VECTOR_REPLACE(&instance->extmap_enabled, extension, AST_RTP_EXTENSION_DIRECTION_NONE);
        AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap);
        ao2_unlock(instance);
        return -1;
    }
 
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_APPEND, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::direction, ast_rtp_instance::engine, rtp_extmap::extension, ast_rtp_engine::extension_enable, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, and ast_rtp_instance::extmap_unique_ids.

Referenced by enable_rtp_extension().

◆ ast_rtp_instance_extmap_get_direction()

enum ast_rtp_extension_direction ast_rtp_instance_extmap_get_direction	(	struct ast_rtp_instance *	instance,
		int	id
	)

Retrieve the negotiated direction for an RTP extension id.

Parameters

instance	The RTP instance to retrieve the direction from
id	The negotiated RTP extension id

Returns: direction the direction that has been negotiated

Since: 15.5.0

Definition at line 952 of file rtp_engine.c.

{
    enum ast_rtp_extension_direction direction = AST_RTP_EXTENSION_DIRECTION_NONE;
 
    ao2_lock(instance);
 
    if (0 < id && id <= AST_VECTOR_SIZE(&instance->extmap_unique_ids)) {
        struct rtp_extmap *extmap = AST_VECTOR_GET_ADDR(&instance->extmap_unique_ids, id - 1);
 
        direction = extmap->direction;
    }
    ao2_unlock(instance);
 
    return direction;
}

References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, rtp_extmap::direction, and ast_rtp_instance::extmap_unique_ids.

Referenced by add_extmap_to_stream().

◆ ast_rtp_instance_extmap_get_extension()

enum ast_rtp_extension ast_rtp_instance_extmap_get_extension	(	struct ast_rtp_instance *	instance,
		int	id
	)

Retrieve the extension for an RTP extension id.

Parameters

instance	The RTP instance to retrieve the extension from
id	The negotiated RTP extension id

Returns: extension the extension that maps to the id

Since: 15.5.0

Note: This will return AST_RTP_EXTENSION_UNSUPPORTED if an extension was proposed for this unique identifier but it is not supported or if the unique identifier is unused.

Definition at line 932 of file rtp_engine.c.

{
    enum ast_rtp_extension extension = AST_RTP_EXTENSION_UNSUPPORTED;
 
    ao2_lock(instance);
 
    /* The local unique identifier starts at '1' so the highest unique identifier
     * can be the actual size of the vector. We compensate (as it is 0 index based)
     * by dropping it down to 1 to get the correct information.
     */
    if (0 < id && id <= AST_VECTOR_SIZE(&instance->extmap_unique_ids)) {
        struct rtp_extmap *extmap = AST_VECTOR_GET_ADDR(&instance->extmap_unique_ids, id - 1);
 
        extension = extmap->extension;
    }
    ao2_unlock(instance);
 
    return extension;
}

References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, rtp_extmap::extension, and ast_rtp_instance::extmap_unique_ids.

Referenced by add_extmap_to_stream(), and ast_rtp_instance_extmap_get_uri().

◆ ast_rtp_instance_extmap_get_id()

int ast_rtp_instance_extmap_get_id	(	struct ast_rtp_instance *	instance,
		enum ast_rtp_extension	extension
	)

Retrieve the id for an RTP extension.

Parameters

instance	The RTP instance to retrieve the id from
extension	The RTP extension

Return values

-1	not negotiated
id	if negotiated

Since: 15.5.0

Definition at line 908 of file rtp_engine.c.

{
    int id = -1;
 
    ao2_lock(instance);
    if (extension < AST_VECTOR_SIZE(&instance->extmap_negotiated)) {
        id = AST_VECTOR_GET(&instance->extmap_negotiated, extension);
    }
    ao2_unlock(instance);
 
    return id;
}

References ao2_lock, ao2_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_instance::extmap_negotiated, and id.

Referenced by ast_rtp_rtcp_handle_nack(), enable_rtp_extension(), rtp_instance_parse_extmap_extensions(), and rtp_raw_write().

◆ ast_rtp_instance_extmap_get_uri()

const char * ast_rtp_instance_extmap_get_uri	(	struct ast_rtp_instance *	instance,
		int	id
	)

Retrieve the URI for an RTP extension id.

Parameters

instance	The RTP instance to retrieve the direction from
id	The negotiated RTP extension id

Returns: The URI for the RTP extension

Since: 15.5.0

Definition at line 968 of file rtp_engine.c.

{
    enum ast_rtp_extension extension = ast_rtp_instance_extmap_get_extension(instance, id);
 
    if (extension == AST_RTP_EXTENSION_UNSUPPORTED ||
        (unsigned int)extension >= ARRAY_LEN(rtp_extension_uris)) {
        return NULL;
    }
 
    return rtp_extension_uris[extension];
}

References ARRAY_LEN, AST_RTP_EXTENSION_UNSUPPORTED, ast_rtp_instance_extmap_get_extension(), rtp_extmap::extension, NULL, and rtp_extension_uris.

Referenced by add_extmap_to_stream().

◆ ast_rtp_instance_extmap_negotiate()

int ast_rtp_instance_extmap_negotiate	(	struct ast_rtp_instance *	instance,
		int	id,
		enum ast_rtp_extension_direction	direction,
		const char *	uri,
		const char *	attributes
	)

Negotiate received RTP extension information.

Parameters

instance	The RTP instance to set the extension on
id	The local identifier for the extension
direction	The direction that the extension should be used in
uri	The unique URI for the extension
attributes	Attributes specific to this extension (if NULL or empty then no attributes)

Return values

0	success
-1	failure

Since: 15.5.0

Definition at line 840 of file rtp_engine.c.

{
    /* 'attributes' is currently unused but exists in the API to ensure it does not need to be altered
     * in the future in case we need to use it.
     */
    int idx;
    enum ast_rtp_extension extension = AST_RTP_EXTENSION_UNSUPPORTED;
 
    /* Per the RFC the identifier has to be 1 or above */
    if (id < 1) {
        return -1;
    }
 
    /* Convert the provided URI to the internal representation */
    for (idx = 0; idx < ARRAY_LEN(rtp_extension_uris); ++idx) {
        if (!strcasecmp(rtp_extension_uris[idx], uri)) {
            extension = idx;
            break;
        }
    }
 
    ao2_lock(instance);
    /* We only accept the extension if it is enabled */
    if (extension < AST_VECTOR_SIZE(&instance->extmap_enabled) &&
        AST_VECTOR_GET(&instance->extmap_enabled, extension) != AST_RTP_EXTENSION_DIRECTION_NONE) {
        struct rtp_extmap extmap = {
            .extension = extension,
            .direction = rtp_extmap_negotiate_direction(AST_VECTOR_GET(&instance->extmap_enabled, extension), direction),
        };
 
        /* If the direction negotiation failed then don't accept or use this extension */
        if (extmap.direction != AST_RTP_EXTENSION_DIRECTION_NONE) {
            if (extension != AST_RTP_EXTENSION_UNSUPPORTED) {
                AST_VECTOR_REPLACE(&instance->extmap_negotiated, extension, id);
            }
            AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap);
        }
    }
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, ARRAY_LEN, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::direction, rtp_extmap::extension, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, ast_rtp_instance::extmap_unique_ids, rtp_extension_uris, and rtp_extmap_negotiate_direction().

Referenced by process_extmap_attributes().

◆ ast_rtp_instance_fd()

int ast_rtp_instance_fd	(	struct ast_rtp_instance *	instance,
		int	rtcp
	)

Get the file descriptor for an RTP session (or RTCP)

Parameters

instance	Instance to get the file descriptor for
rtcp	Whether to retrieve the file descriptor for RTCP or not

Return values

fd	success
-1	failure

Example usage:

int rtp_fd = ast_rtp_instance_fd(instance, 0);

ast_rtp_instance_fd

int ast_rtp_instance_fd(struct ast_rtp_instance *instance, int rtcp)

Get the file descriptor for an RTP session (or RTCP)

Definition: rtp_engine.c:2368

This retrieves the file descriptor for the socket carrying media on the instance pointed to by instance.

Since: 1.8

Definition at line 2368 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->fd) {
        ao2_lock(instance);
        res = instance->engine->fd(instance, rtcp);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::fd.

Referenced by apply_negotiated_sdp_stream(), check_for_rtp_changes(), configure_local_rtp(), jingle_enable_video(), jingle_new(), rtp_find_rtcp_fd_position(), start_rtp(), unicast_rtp_request(), and unistim_new().

◆ ast_rtp_instance_get_active_glue()

struct ast_rtp_glue * ast_rtp_instance_get_active_glue ( struct ast_rtp_instance * instance )

Get the RTP glue in use on an RTP instance.

Parameters

instance The RTP instance

Returns: pointer to the glue

Example:

struct ast_rtp_glue *glue = ast_rtp_instance_get_active_glue(instance);

ast_rtp_instance_get_active_glue

struct ast_rtp_glue * ast_rtp_instance_get_active_glue(struct ast_rtp_instance *instance)

Get the RTP glue in use on an RTP instance.

Definition: rtp_engine.c:2905

This gets the RTP glue currently in use on the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2905 of file rtp_engine.c.

{
    return instance->glue;
}

References ast_rtp_instance::glue.

◆ ast_rtp_instance_get_and_cmp_local_address()

int ast_rtp_instance_get_and_cmp_local_address	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	address
	)

Get the address of the local endpoint that we are sending RTP to, comparing its address to another.

Parameters

instance	The instance that we want to get the local address for
address	An initialized address that may be overwritten if the local address is different

Return values

0	address was not changed
1	address was changed Example usage:

struct ast_sockaddr address;
int ret;
ret = ast_rtp_instance_get_and_cmp_local_address(instance, &address);

This retrieves the current local address set on the instance pointed to by instance and puts the value into the address structure.

Since: 1.8

Definition at line 651 of file rtp_engine.c.

{
    ao2_lock(instance);
    if (ast_sockaddr_cmp(address, &instance->local_address) != 0) {
        ast_sockaddr_copy(address, &instance->local_address);
        ao2_unlock(instance);
        return 1;
    }
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_sockaddr_cmp(), ast_sockaddr_copy(), and ast_rtp_instance::local_address.

◆ ast_rtp_instance_get_and_cmp_requested_target_address()

int ast_rtp_instance_get_and_cmp_requested_target_address	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	address
	)

Get the requested target address of the remote endpoint and compare it to the given address.

Parameters

instance	The instance that we want to get the remote address for
address	An initialized address that may be overwritten addresses differ

Return values

0	address was not changed
1	address was changed

Definition at line 673 of file rtp_engine.c.

{
    ao2_lock(instance);
    if (ast_sockaddr_cmp(address, &instance->requested_target_address) != 0) {
        ast_sockaddr_copy(address, &instance->requested_target_address);
        ao2_unlock(instance);
        return 1;
    }
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_sockaddr_cmp(), ast_sockaddr_copy(), and ast_rtp_instance::requested_target_address.

◆ ast_rtp_instance_get_bridged()

struct ast_rtp_instance * ast_rtp_instance_get_bridged ( struct ast_rtp_instance * instance )

Get the other RTP instance that an instance is bridged to.

Parameters

instance The RTP instance that we want

Return values

non-NULL	success
NULL	failure

Example usage:

struct ast_rtp_instance *bridged = ast_rtp_instance_get_bridged(instance0);

ast_rtp_instance_get_bridged

struct ast_rtp_instance * ast_rtp_instance_get_bridged(struct ast_rtp_instance *instance)

Get the other RTP instance that an instance is bridged to.

Definition: rtp_engine.c:2410

ast_rtp_instance::bridged

struct ast_rtp_instance * bridged

Definition: rtp_engine.c:202

This gets the RTP instance that instance0 is bridged to.

Since: 1.8

Definition at line 2410 of file rtp_engine.c.

{
    struct ast_rtp_instance *bridged;
 
    ao2_lock(instance);
    bridged = instance->bridged;
    ao2_unlock(instance);
    return bridged;
}

References ao2_lock, ao2_unlock, and ast_rtp_instance::bridged.

Referenced by ast_rtp_interpret().

◆ ast_rtp_instance_get_channel_id()

const char * ast_rtp_instance_get_channel_id ( struct ast_rtp_instance * instance )

Get the unique ID of the channel that owns this RTP instance.

Note that this should remain valid for the lifetime of the RTP instance.

Parameters

instance The RTP instance

Returns: The unique ID of the channel

Return values

Empty string if no channel owns this RTP instance

Since: 12

Definition at line 570 of file rtp_engine.c.

{
    return instance->channel_uniqueid;
}

References ast_rtp_instance::channel_uniqueid.

Referenced by __rtp_recvfrom(), ast_rtcp_interpret(), ast_rtp_get_stat(), ast_rtp_prop_set(), ast_rtp_stop(), ast_rtp_write(), calc_rxstamp_and_jitter(), rtp_check_timeout(), rtp_raw_write(), rtp_transport_wide_cc_feedback_produce(), update_local_mes_stats(), and update_reported_mes_stats().

◆ ast_rtp_instance_get_cname()

const char * ast_rtp_instance_get_cname ( struct ast_rtp_instance * rtp )

Retrieve the CNAME used in RTCP SDES items.

This is a pointer directly into the RTP struct, not a copy.

Parameters

rtp	The RTP instance

Returns: the CNAME

Definition at line 4024 of file rtp_engine.c.

{
    const char *cname = "";
 
    ao2_lock(rtp);
    if (rtp->engine->cname_get) {
        cname = rtp->engine->cname_get(rtp);
    }
    ao2_unlock(rtp);
 
    return cname;
}

References ao2_lock, ao2_unlock, ast_rtp_engine::cname_get, and ast_rtp_instance::engine.

Referenced by add_ssrc_to_stream().

◆ ast_rtp_instance_get_codecs()

struct ast_rtp_codecs * ast_rtp_instance_get_codecs ( struct ast_rtp_instance * instance )

Get the codecs structure of an RTP instance.

Parameters

instance The RTP instance to get the codecs structure from

Example usage:

struct ast_rtp_codecs *codecs = ast_rtp_instance_get_codecs(instance);

ast_rtp_instance_get_codecs

struct ast_rtp_codecs * ast_rtp_instance_get_codecs(struct ast_rtp_instance *instance)

Get the codecs structure of an RTP instance.

Definition: rtp_engine.c:749

This gets the codecs structure on the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 749 of file rtp_engine.c.

{
    return &instance->codecs;
}

References ast_rtp_instance::codecs.

Referenced by apply_cap_to_bundled(), ast_rtp_dtmf_begin(), ast_rtp_interpret(), ast_rtp_read(), ast_rtp_sendcng(), ast_rtp_write(), bridge_p2p_rtp_write(), configure_local_rtp(), create_outgoing_sdp_stream(), jingle_add_payloads_to_description(), jingle_enable_video(), jingle_interpret_description(), jingle_new(), multicast_rtp_write(), native_rtp_bridge_compatible_check(), ooh323_set_write_format(), send_start_rtp(), set_caps(), set_incoming_call_offer_cap(), and setup_rtp_connection().

◆ ast_rtp_instance_get_data()

void * ast_rtp_instance_get_data ( struct ast_rtp_instance * instance )

Get the data portion of an RTP instance.

Parameters

instance The RTP instance we want the data portion from

Example usage:

struct *blob = ast_rtp_instance_get_data(instance);

(

ast_rtp_instance_get_data

void * ast_rtp_instance_get_data(struct ast_rtp_instance *instance)

Get the data portion of an RTP instance.

Definition: rtp_engine.c:585

This gets the data pointer on the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 585 of file rtp_engine.c.

{
    return instance->data;
}

References ast_rtp_instance::data.

Referenced by __rtp_recvfrom(), __rtp_sendto(), ast_rtcp_calculate_sr_rr_statistics(), ast_rtcp_generate_nack(), ast_rtcp_generate_report(), ast_rtcp_generate_sdes(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtcp_write(), ast_rtp_bundle(), ast_rtp_change_source(), ast_rtp_destroy(), ast_rtp_dtmf_begin(), ast_rtp_dtmf_continuation(), ast_rtp_dtmf_end_with_duration(), ast_rtp_dtmf_mode_get(), ast_rtp_dtmf_mode_set(), ast_rtp_fd(), ast_rtp_get_cname(), ast_rtp_get_ssrc(), ast_rtp_get_stat(), ast_rtp_interpret(), ast_rtp_local_bridge(), ast_rtp_prop_set(), ast_rtp_qos_set(), ast_rtp_read(), ast_rtp_remote_address_set(), ast_rtp_rtcp_handle_nack(), ast_rtp_sendcng(), ast_rtp_set_remote_ssrc(), ast_rtp_set_stream_num(), ast_rtp_stop(), ast_rtp_stun_request(), ast_rtp_update_source(), ast_rtp_write(), bridge_p2p_rtp_write(), create_dtmf_frame(), multicast_rtp_activate(), multicast_rtp_destroy(), multicast_rtp_write(), process_cn_rfc3389(), process_dtmf_cisco(), process_dtmf_rfc2833(), red_write(), rtp_instance_parse_transport_wide_cc(), rtp_raw_write(), rtp_red_buffer(), rtp_red_init(), rtp_sendto(), and rtp_transport_wide_cc_feedback_produce().

◆ ast_rtp_instance_get_dtls()

struct ast_rtp_engine_dtls * ast_rtp_instance_get_dtls ( struct ast_rtp_instance * instance )

Obtain a pointer to the DTLS support present on an RTP instance.

Parameters

instance the RTP instance

Returns: DTLS support if present

Return values

NULL	if no DTLS support available

Definition at line 3211 of file rtp_engine.c.

{
    if (instance->engine->dtls) {
        return &rtp_dtls_wrappers;
    }
    /* DTLS not available */
    return NULL;
}

References ast_rtp_engine::dtls, ast_rtp_instance::engine, NULL, and rtp_dtls_wrappers.

Referenced by add_crypto_to_stream(), add_fingerprints_if_present(), apply_dtls_attrib(), ast_sdp_get_rtp_profile(), and setup_dtls_srtp().

◆ ast_rtp_instance_get_engine()

struct ast_rtp_engine * ast_rtp_instance_get_engine ( struct ast_rtp_instance * instance )

Get the RTP engine in use on an RTP instance.

Parameters

instance The RTP instance

Returns: pointer to the engine

Example usage:

struct ast_rtp_engine *engine = ast_rtp_instance_get_engine(instance);

ast_rtp_instance_get_engine

struct ast_rtp_engine * ast_rtp_instance_get_engine(struct ast_rtp_instance *instance)

Get the RTP engine in use on an RTP instance.

Definition: rtp_engine.c:2900

This gets the RTP engine currently in use on the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2900 of file rtp_engine.c.

{
    return instance->engine;
}

References ast_rtp_instance::engine.

Referenced by native_rtp_bridge_compatible_check(), native_rtp_bridge_start(), and native_rtp_bridge_stop().

◆ ast_rtp_instance_get_extended_prop()

void * ast_rtp_instance_get_extended_prop	(	struct ast_rtp_instance *	instance,
		int	property
	)

Get the value of an RTP instance extended property.

Parameters

instance	The RTP instance to get the extended property on
property	The extended property to get

Since: 1.8

Definition at line 712 of file rtp_engine.c.

{
    void *prop;
 
    if (instance->engine->extended_prop_get) {
        ao2_lock(instance);
        prop = instance->engine->extended_prop_get(instance, property);
        ao2_unlock(instance);
    } else {
        prop = NULL;
    }
 
    return prop;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::extended_prop_get, and NULL.

◆ ast_rtp_instance_get_glue()

struct ast_rtp_glue * ast_rtp_instance_get_glue ( const char * type )

Get the RTP glue that binds a channel to the RTP engine.

Parameters

type	Name of the glue we want

Return values

non-NULL	success
NULL	failure

Example usage:

struct ast_rtp_glue *glue = ast_rtp_instance_get_glue("Example");

ast_rtp_instance_get_glue

struct ast_rtp_glue * ast_rtp_instance_get_glue(const char *type)

Get the RTP glue that binds a channel to the RTP engine.

Definition: rtp_engine.c:2382

This retrieves the RTP glue that has the name 'Example'.

Since: 1.8

Definition at line 2382 of file rtp_engine.c.

{
    struct ast_rtp_glue *glue = NULL;
 
    AST_RWLIST_RDLOCK(&glues);
 
    AST_RWLIST_TRAVERSE(&glues, glue, entry) {
        if (!strcasecmp(glue->type, type)) {
            break;
        }
    }
 
    AST_RWLIST_UNLOCK(&glues);
 
    return glue;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, NULL, type, and ast_rtp_glue::type.

Referenced by ast_ari_channels_rtpstatistics(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_rtp_instance_make_compatible(), and rtp_glue_data_get().

◆ ast_rtp_instance_get_hold_timeout()

int ast_rtp_instance_get_hold_timeout ( struct ast_rtp_instance * instance )

Get the RTP timeout value for when an RTP instance is on hold.

Parameters

instance The RTP instance

Returns: timeout value

Example usage:

int timeout = ast_rtp_instance_get_hold_timeout(instance);

ast_rtp_instance_get_hold_timeout

int ast_rtp_instance_get_hold_timeout(struct ast_rtp_instance *instance)

Get the RTP timeout value for when an RTP instance is on hold.

Definition: rtp_engine.c:2890

This gets the RTP hold timeout value for the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2890 of file rtp_engine.c.

{
    return instance->holdtimeout;
}

References ast_rtp_instance::holdtimeout.

◆ ast_rtp_instance_get_ice()

struct ast_rtp_engine_ice * ast_rtp_instance_get_ice ( struct ast_rtp_instance * instance )

Obtain a pointer to the ICE support present on an RTP instance.

Parameters

instance the RTP instance

Returns: ICE support if present

Return values

NULL	if no ICE support available

Definition at line 3091 of file rtp_engine.c.

{
    if (instance->engine->ice) {
        return &rtp_ice_wrappers;
    }
    /* ICE not available */
    return NULL;
}

References ast_rtp_instance::engine, ast_rtp_engine::ice, NULL, and rtp_ice_wrappers.

Referenced by add_ice_to_stream(), check_ice_support(), create_rtp(), jingle_add_google_candidates_to_transport(), jingle_add_ice_udp_candidates_to_transport(), jingle_enable_video(), jingle_interpret_google_transport(), jingle_interpret_ice_udp_transport(), jingle_new(), jingle_outgoing_hook(), jingle_request(), process_ice_attributes(), process_ice_auth_attrb(), and set_ice_components().

◆ ast_rtp_instance_get_incoming_source_address()

void ast_rtp_instance_get_incoming_source_address	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	address
	)

Get the incoming source address of the remote endpoint.

This returns the remote address the engine is sending RTP to. Usually this will be the same as the requested target address, however in the case where the engine "learns" the address (for instance, symmetric RTP enabled) this will then contain the learned address.

Parameters

instance	The instance that we want to get the incoming source address for
address	A structure to put the address into

Definition at line 687 of file rtp_engine.c.

{
    ao2_lock(instance);
    ast_sockaddr_copy(address, &instance->incoming_source_address);
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::incoming_source_address.

◆ ast_rtp_instance_get_keepalive()

int ast_rtp_instance_get_keepalive ( struct ast_rtp_instance * instance )

Get the RTP keepalive interval.

Parameters

instance The RTP instance

Returns: period Keepalive interval value

Example usage:

int interval = ast_rtp_instance_get_keepalive(instance);

ast_rtp_instance_get_keepalive

int ast_rtp_instance_get_keepalive(struct ast_rtp_instance *instance)

Get the RTP keepalive interval.

Definition: rtp_engine.c:2895

This gets the RTP keepalive interval value for the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2895 of file rtp_engine.c.

{
    return instance->keepalive;
}

References ast_rtp_instance::keepalive.

Referenced by send_keepalive().

◆ ast_rtp_instance_get_last_rx()

time_t ast_rtp_instance_get_last_rx ( const struct ast_rtp_instance * rtp )

Get the last RTP reception time.

Parameters

rtp	The instance from which to get the last reception time

Returns: The last RTP reception time

Definition at line 4001 of file rtp_engine.c.

{
    return rtp->last_rx;
}

References ast_rtp_instance::last_rx.

Referenced by rtp_check_timeout().

◆ ast_rtp_instance_get_last_tx()

time_t ast_rtp_instance_get_last_tx ( const struct ast_rtp_instance * rtp )

Get the last RTP transmission time.

Parameters

rtp	The instance from which to get the last transmission time

Returns: The last RTP transmission time

Definition at line 3991 of file rtp_engine.c.

{
    return rtp->last_tx;
}

References ast_rtp_instance::last_tx.

Referenced by send_keepalive().

◆ ast_rtp_instance_get_local_address()

void ast_rtp_instance_get_local_address	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	address
	)

Get the local address that we are expecting RTP on.

Parameters

instance	The RTP instance to get the address from
address	The variable to store the address in

Example usage:

struct ast_sockaddr address;

ast_rtp_instance_get_local_address(instance, &address);

ast_rtp_instance_get_local_address

void ast_rtp_instance_get_local_address(struct ast_rtp_instance *instance, struct ast_sockaddr *address)

Get the local address that we are expecting RTP on.

Definition: rtp_engine.c:665

This gets the local address that we are expecting RTP on and stores it in the 'address' structure.

Since: 1.8

Definition at line 665 of file rtp_engine.c.

{
    ao2_lock(instance);
    ast_sockaddr_copy(address, &instance->local_address);
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::local_address.

Referenced by ast_rtp_prop_set(), ast_rtp_remote_address_set(), channel_read_rtp(), configure_local_rtp(), create_outgoing_sdp_stream(), multicast_send_control_packet(), send_start_rtp(), test_init_rtp_instances(), unicast_rtp_request(), and unistim_set_rtp_peer().

◆ ast_rtp_instance_get_prop()

int ast_rtp_instance_get_prop	(	struct ast_rtp_instance *	instance,
		enum ast_rtp_property	property
	)

Get the value of an RTP instance property.

Parameters

instance	The RTP instance to get the property from
property	The property to get

Returns: Current value of the property

Example usage:

ast_rtp_instance_get_prop(instance, AST_RTP_PROPERTY_NAT);

ast_rtp_instance_get_prop

int ast_rtp_instance_get_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property)

Get the value of an RTP instance property.

Definition: rtp_engine.c:738

This returns the current value of the NAT property on the instance pointed to by instance.

Since: 1.8

Definition at line 738 of file rtp_engine.c.

{
    int prop;
 
    ao2_lock(instance);
    prop = instance->properties[property];
    ao2_unlock(instance);
 
    return prop;
}

References ao2_lock, ao2_unlock, and ast_rtp_instance::properties.

Referenced by ast_rtcp_interpret(), ast_rtp_dtmf_compatible(), ast_rtp_read(), bridge_p2p_rtp_write(), process_dtmf_cisco(), process_dtmf_rfc2833(), rtp_raw_write(), and rtp_write_rtcp_psfb().

◆ ast_rtp_instance_get_quality()

char * ast_rtp_instance_get_quality	(	struct ast_rtp_instance *	instance,
		enum ast_rtp_instance_stat_field	field,
		char *	buf,
		size_t	size
	)

Retrieve quality statistics about an RTP instance.

Parameters

instance	Instance to get statistics on
field	What quality statistic to retrieve
buf	What buffer to put the result into
size	Size of the above buffer

Return values

non-NULL	success
NULL	failure

Example usage:

char quality[AST_MAX_USER_FIELD];

ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY, &buf, sizeof(buf));

AST_MAX_USER_FIELD

#define AST_MAX_USER_FIELD

Definition: channel.h:176

quality

static int quality

Definition: codec_speex.c:62

buf

char buf[BUFSIZE]

Definition: eagi_proxy.c:66

ast_rtp_instance_get_quality

char * ast_rtp_instance_get_quality(struct ast_rtp_instance *instance, enum ast_rtp_instance_stat_field field, char *buf, size_t size)

Retrieve quality statistics about an RTP instance.

Definition: rtp_engine.c:2640

This retrieves general quality statistics and places a text representation into the buf pointed to by buf.

Since: 1.8

Definition at line 2640 of file rtp_engine.c.

{
    struct ast_rtp_instance_stats stats = { 0, };
    enum ast_rtp_instance_stat stat;
 
    /* Determine what statistics we will need to retrieve based on field passed in */
    if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY) {
        stat = AST_RTP_INSTANCE_STAT_ALL;
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER) {
        stat = AST_RTP_INSTANCE_STAT_COMBINED_JITTER;
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS) {
        stat = AST_RTP_INSTANCE_STAT_COMBINED_LOSS;
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT) {
        stat = AST_RTP_INSTANCE_STAT_COMBINED_RTT;
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES) {
        stat = AST_RTP_INSTANCE_STAT_COMBINED_MES;
    } else {
        return NULL;
    }
 
    /* Attempt to actually retrieve the statistics we need to generate the quality string */
    if (ast_rtp_instance_get_stats(instance, &stats, stat)) {
        return NULL;
    }
 
    /* Now actually fill the buffer with the good information */
    if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY) {
        snprintf(buf, size, "ssrc=%u;themssrc=%u;lp=%u;rxjitter=%f;rxcount=%u;"
            "txjitter=%f;txcount=%u;rlp=%u;rtt=%f;rxmes=%f;txmes=%f",
             stats.local_ssrc, stats.remote_ssrc, stats.rxploss, stats.rxjitter,
             stats.rxcount, stats.txjitter, stats.txcount, stats.txploss, stats.rtt,
             stats.rxmes, stats.txmes);
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER) {
        snprintf(buf, size, "minrxjitter=%010.6f;maxrxjitter=%010.6f;avgrxjitter=%010.6f;stdevrxjitter=%010.6f;mintxjitter=%010.6f;maxtxjitter=%010.6f;avgtxjitter=%010.6f;stdevtxjitter=%010.6f;",
             stats.local_minjitter, stats.local_maxjitter, stats.local_normdevjitter, stats.local_stdevjitter, stats.remote_minjitter, stats.remote_maxjitter, stats.remote_normdevjitter, stats.remote_stdevjitter);
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS) {
        snprintf(buf, size, "  minrxlost=%010.6f;  maxrxlost=%010.6f;  avgrxlost=%010.6f;  stdevrxlost=%010.6f;  mintxlost=%010.6f;  maxtxlost=%010.6f;  avgtxlost=%010.6f;  stdevtxlost=%010.6f;",
             stats.local_minrxploss, stats.local_maxrxploss, stats.local_normdevrxploss, stats.local_stdevrxploss, stats.remote_minrxploss, stats.remote_maxrxploss, stats.remote_normdevrxploss, stats.remote_stdevrxploss);
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT) {
        snprintf(buf, size, "     minrtt=%010.6f;     maxrtt=%010.6f;     avgrtt=%010.6f;     stdevrtt=%010.6f;", stats.minrtt, stats.maxrtt, stats.normdevrtt, stats.stdevrtt);
    } else if (field == AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES) {
        snprintf(buf, size, "   minrxmes=%010.6f;   maxrxmes=%010.6f;   avgrxmes=%010.6f;   stdevrxmes=%010.6f;   mintxmes=%010.6f;   maxtxmes=%010.6f;   avgtxmes=%010.6f;   stdevtxmes=%010.6f;",
             stats.local_minmes, stats.local_maxmes,
             stats.local_normdevmes, stats.local_stdevmes,
             stats.remote_minmes, stats.remote_maxmes,
             stats.remote_normdevmes, stats.remote_stdevmes);
    }
 
    return buf;
}

Referenced by ast_rtp_instance_destroy(), ast_rtp_instance_set_stats_vars(), and channel_read_rtcp().

◆ ast_rtp_instance_get_requested_target_address()

void ast_rtp_instance_get_requested_target_address	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	address
	)

Get the requested target address of the remote endpoint.

This returns the explicitly set address of a remote endpoint. Meaning this won't change unless specifically told to change. In most cases this should be the same as the incoming source address, except in cases where the engine "learns" the address in which case this and the incoming source address might differ.

Parameters

instance	The instance that we want to get the requested target address for
address	A structure to put the address into

Definition at line 695 of file rtp_engine.c.

{
    ao2_lock(instance);
    ast_sockaddr_copy(address, &instance->requested_target_address);
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::requested_target_address.

Referenced by ast_rtp_read().

◆ ast_rtp_instance_get_srtp()

struct ast_srtp * ast_rtp_instance_get_srtp	(	struct ast_rtp_instance *	instance,
		int	rtcp
	)

Obtain the SRTP instance associated with an RTP instance.

Parameters

instance	the RTP instance
rtcp	1 to request instance for RTCP

Returns: the SRTP instance on success

Return values

NULL	if no SRTP instance exists

Definition at line 2963 of file rtp_engine.c.

{
    if (rtcp && instance->rtcp_srtp) {
        return instance->rtcp_srtp;
    } else {
        return instance->srtp;
    }
}

References ast_rtp_instance::rtcp_srtp, and ast_rtp_instance::srtp.

Referenced by __rtp_sendto(), ast_rtcp_read(), ast_rtp_change_source(), and ast_rtp_read().

◆ ast_rtp_instance_get_ssrc()

unsigned int ast_rtp_instance_get_ssrc ( struct ast_rtp_instance * rtp )

Retrieve the local SSRC value that we will be using.

Parameters

rtp	The RTP instance

Returns: The SSRC value

Definition at line 4011 of file rtp_engine.c.

{
    unsigned int ssrc = 0;
 
    ao2_lock(rtp);
    if (rtp->engine->ssrc_get) {
        ssrc = rtp->engine->ssrc_get(rtp);
    }
    ao2_unlock(rtp);
 
    return ssrc;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::ssrc_get.

Referenced by add_ssrc_to_stream(), ast_srtp_unprotect(), and create_outgoing_sdp_stream().

◆ ast_rtp_instance_get_stats()

int ast_rtp_instance_get_stats	(	struct ast_rtp_instance *	instance,
		struct ast_rtp_instance_stats *	stats,
		enum ast_rtp_instance_stat	stat
	)

Retrieve statistics about an RTP instance.

Parameters

instance	Instance to get statistics on
stats	Structure to put results into
stat	What statistic(s) to retrieve

Return values

0	success
-1	failure

Example usage:

struct ast_rtp_instance_stats stats;

ast_rtp_instance_get_stats(instance, &stats, AST_RTP_INSTANCE_STAT_ALL);

ast_rtp_instance_get_stats

int ast_rtp_instance_get_stats(struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat)

Retrieve statistics about an RTP instance.

Definition: rtp_engine.c:2622

This retrieves all statistics the underlying RTP engine supports and puts the values into the stats structure.

Since: 1.8

Definition at line 2622 of file rtp_engine.c.

{
    int res;
 
    if (!instance || !instance->engine || !stats) {
        return -1;
    }
 
    if (instance->engine->get_stat) {
        ao2_lock(instance);
        res = instance->engine->get_stat(instance, stats, stat);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::get_stat.

Referenced by ast_rtp_instance_get_quality(), ast_rtp_instance_get_stats_all_json(), ast_sip_session_media_stats_save(), ast_srtp_unprotect(), AST_TEST_DEFINE(), channel_read_rtcp(), cli_channelstats_print_body(), crypto_activate(), and process_ssrc_attributes().

◆ ast_rtp_instance_get_stats_all_json()

struct ast_json * ast_rtp_instance_get_stats_all_json ( struct ast_rtp_instance * instance )

Retrieve statistics about an RTP instance in json format.

Parameters

instance

Returns: json object of stats

Definition at line 4265 of file rtp_engine.c.

{
    struct ast_rtp_instance_stats stats = {0,};
 
    if(ast_rtp_instance_get_stats(instance, &stats, AST_RTP_INSTANCE_STAT_ALL)) {
        return NULL;
    }
 
    return ast_rtp_convert_stats_json(&stats);
}

References ast_rtp_convert_stats_json(), ast_rtp_instance_get_stats(), AST_RTP_INSTANCE_STAT_ALL, and NULL.

Referenced by ast_ari_channels_rtpstatistics().

◆ ast_rtp_instance_get_timeout()

int ast_rtp_instance_get_timeout ( struct ast_rtp_instance * instance )

Get the RTP timeout value.

Parameters

instance The RTP instance

Returns: timeout value

Example usage:

int timeout = ast_rtp_instance_get_timeout(instance);

ast_rtp_instance_get_timeout

int ast_rtp_instance_get_timeout(struct ast_rtp_instance *instance)

Get the RTP timeout value.

Definition: rtp_engine.c:2885

This gets the RTP timeout value for the RTP instance pointed to by 'instance'.

Since: 1.8

Definition at line 2885 of file rtp_engine.c.

{
    return instance->timeout;
}

References ast_rtp_instance::timeout.

Referenced by apply_negotiated_sdp_stream(), and rtp_check_timeout().

◆ ast_rtp_instance_make_compatible()

int ast_rtp_instance_make_compatible	(	struct ast_channel *	chan,
		struct ast_rtp_instance *	instance,
		struct ast_channel *	peer
	)

Request that the underlying RTP engine make two RTP instances compatible with eachother.

Parameters

chan	Our own Asterisk channel
instance	The first RTP instance
peer	The peer Asterisk channel

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_make_compatible(instance, peer);

ast_rtp_instance_make_compatible

int ast_rtp_instance_make_compatible(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_channel *peer)

Request that the underlying RTP engine make two RTP instances compatible with eachother.

Definition: rtp_engine.c:2789

This makes the RTP instance for 'peer' compatible with 'instance' and vice versa.

Since: 1.8

Definition at line 2789 of file rtp_engine.c.

{
    struct ast_rtp_glue *glue;
    struct ast_rtp_instance *peer_instance = NULL;
    int res = -1;
 
    if (!instance->engine->make_compatible) {
        return -1;
    }
 
    ast_channel_lock(peer);
 
    if (!(glue = ast_rtp_instance_get_glue(ast_channel_tech(peer)->type))) {
        ast_channel_unlock(peer);
        return -1;
    }
 
    glue->get_rtp_info(peer, &peer_instance);
    if (!peer_instance) {
        ast_log(LOG_ERROR, "Unable to get_rtp_info for peer type %s\n", glue->type);
        ast_channel_unlock(peer);
        return -1;
    }
    if (peer_instance->engine != instance->engine) {
        ast_log(LOG_ERROR, "Peer engine mismatch for type %s\n", glue->type);
        ast_channel_unlock(peer);
        ao2_ref(peer_instance, -1);
        return -1;
    }
 
    /*
     * XXX Good thing nothing calls this function because we would need
     * deadlock avoidance to get the two instance locks.
     */
    res = instance->engine->make_compatible(chan, instance, peer, peer_instance);
 
    ast_channel_unlock(peer);
 
    ao2_ref(peer_instance, -1);
    peer_instance = NULL;
 
    return res;
}

References ao2_ref, ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_log, ast_rtp_instance_get_glue(), ast_rtp_instance::engine, ast_rtp_glue::get_rtp_info, ast_rtp_instance::glue, LOG_ERROR, ast_rtp_engine::make_compatible, NULL, type, and ast_rtp_glue::type.

◆ ast_rtp_instance_new()

struct ast_rtp_instance * ast_rtp_instance_new	(	const char *	engine_name,
		struct ast_sched_context *	sched,
		const struct ast_sockaddr *	sa,
		void *	data
	)

Create a new RTP instance.

Parameters

engine_name	Name of the engine to use for the RTP instance
sched	Scheduler context that the RTP engine may want to use
sa	Address we want to bind to
data	Unique data for the engine

Return values

non-NULL	success
NULL	failure

Example usage:

struct ast_rtp_instance *instance = NULL;

instance = ast_rtp_instance_new(NULL, sched, &sin, NULL);

ast_rtp_instance_new

struct ast_rtp_instance * ast_rtp_instance_new(const char *engine_name, struct ast_sched_context *sched, const struct ast_sockaddr *sa, void *data)

Create a new RTP instance.

Definition: rtp_engine.c:487

sched

Definition: sched.c:76

This creates a new RTP instance using the default engine and asks the RTP engine to bind to the address given in the address structure.

Note: The RTP engine does not have to use the address provided when creating an RTP instance. It may choose to use another depending on it's own configuration.

Since: 1.8

Definition at line 487 of file rtp_engine.c.

{
    struct ast_sockaddr address = {{0,}};
    struct ast_rtp_instance *instance = NULL;
    struct ast_rtp_engine *engine = NULL;
    struct ast_module *mod_ref;
 
    AST_RWLIST_RDLOCK(&engines);
 
    /* If an engine name was specified try to use it or otherwise use the first one registered */
    if (!ast_strlen_zero(engine_name)) {
        AST_RWLIST_TRAVERSE(&engines, engine, entry) {
            if (!strcmp(engine->name, engine_name)) {
                break;
            }
        }
    } else {
        engine = AST_RWLIST_FIRST(&engines);
    }
 
    /* If no engine was actually found bail out now */
    if (!engine) {
        ast_log(LOG_ERROR, "No RTP engine was found. Do you have one loaded?\n");
        AST_RWLIST_UNLOCK(&engines);
        return NULL;
    }
 
    /* Bump up the reference count before we return so the module can not be unloaded */
    mod_ref = ast_module_running_ref(engine->mod);
 
    AST_RWLIST_UNLOCK(&engines);
 
    if (!mod_ref) {
        /* BUGBUG: improve handling of this situation. */
        return NULL;
    }
 
    /* Allocate a new RTP instance */
    if (!(instance = ao2_alloc(sizeof(*instance), instance_destructor))) {
        ast_module_unref(engine->mod);
        return NULL;
    }
    instance->engine = engine;
    ast_sockaddr_copy(&instance->local_address, sa);
    ast_sockaddr_copy(&address, sa);
 
    if (ast_rtp_codecs_payloads_initialize(&instance->codecs)) {
        ao2_ref(instance, -1);
        return NULL;
    }
 
    /* Initialize RTP extension support */
    if (AST_VECTOR_INIT(&instance->extmap_enabled, 0) ||
        AST_VECTOR_INIT(&instance->extmap_negotiated, 0) ||
        AST_VECTOR_INIT(&instance->extmap_unique_ids, 0)) {
        ao2_ref(instance, -1);
        return NULL;
    }
 
    ast_debug(1, "Using engine '%s' for RTP instance '%p'\n", engine->name, instance);
 
    /*
     * And pass it off to the engine to setup
     *
     * Lock in case the RTP engine has other threads that
     * need synchronization with the construction.
     */
    ao2_lock(instance);
    if (instance->engine->new(instance, sched, &address, data)) {
        ast_debug(1, "Engine '%s' failed to setup RTP instance '%p'\n", engine->name, instance);
        ao2_unlock(instance);
        ao2_ref(instance, -1);
        return NULL;
    }
    ao2_unlock(instance);
 
    ast_debug(1, "RTP instance '%p' is setup and ready to go\n", instance);
 
    return instance;
}

References ao2_alloc, ao2_lock, ao2_ref, ao2_unlock, ast_debug, ast_log, ast_module_running_ref, ast_module_unref, ast_rtp_codecs_payloads_initialize(), AST_RWLIST_FIRST, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sockaddr_copy(), ast_strlen_zero(), AST_VECTOR_INIT, ast_rtp_instance::codecs, ast_rtp_instance::engine, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, ast_rtp_instance::extmap_unique_ids, instance_destructor(), ast_rtp_instance::local_address, LOG_ERROR, ast_rtp_engine::mod, ast_rtp_engine::name, ast_rtp_engine::new, and NULL.

Referenced by configure_local_rtp(), create_rtp(), jingle_alloc(), jingle_enable_video(), multicast_rtp_request(), start_rtp(), test_init_rtp_instances(), and unicast_rtp_request().

◆ ast_rtp_instance_read()

struct ast_frame * ast_rtp_instance_read	(	struct ast_rtp_instance *	instance,
		int	rtcp
	)

Receive a frame over RTP.

Parameters

instance	The RTP instance to receive frame on
rtcp	Whether to read in RTCP or not

Return values

non-NULL	success
NULL	failure

Example usage:

struct ast_frame *frame;

frame = ast_rtp_instance_read(instance, 0);

ast_rtp_instance_read

struct ast_frame * ast_rtp_instance_read(struct ast_rtp_instance *instance, int rtcp)

Receive a frame over RTP.

Definition: rtp_engine.c:600

ast_frame

Data structure associated with a single frame of data.

Definition: include/asterisk/frame.h:165

This asks the RTP engine to read in RTP from the instance and return it as an Asterisk frame.

Since: 1.8

Definition at line 600 of file rtp_engine.c.

{
    struct ast_frame *frame;
 
    ao2_lock(instance);
    frame = instance->engine->read(instance, rtcp);
    ao2_unlock(instance);
    return frame;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::read.

Referenced by AST_TEST_DEFINE(), jingle_read(), media_session_rtcp_read_callback(), media_session_rtp_read_callback(), ooh323_rtp_read(), rtp_read(), test_read_frames(), test_write_and_read_interleaved_frames(), and unistim_rtp_read().

◆ ast_rtp_instance_sendcng()

int ast_rtp_instance_sendcng	(	struct ast_rtp_instance *	instance,
		int	level
	)

Send a comfort noise packet to the RTP instance.

Parameters

instance	The RTP instance
level	Magnitude of the noise level

Return values

0	Success
non-zero	Failure

Definition at line 2972 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->sendcng) {
        ao2_lock(instance);
        res = instance->engine->sendcng(instance, level);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::sendcng.

Referenced by do_monitor(), and send_keepalive().

◆ ast_rtp_instance_set_bridged()

void ast_rtp_instance_set_bridged	(	struct ast_rtp_instance *	instance,
		struct ast_rtp_instance *	bridged
	)

Set the other RTP instance that an instance is bridged to.

Parameters

instance	The RTP instance that we want to set the bridged value on
bridged	The RTP instance they are bridged to

Since: 12

Definition at line 2420 of file rtp_engine.c.

{
    ao2_lock(instance);
    instance->bridged = bridged;
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, and ast_rtp_instance::bridged.

Referenced by native_rtp_bridge_start(), and native_rtp_bridge_stop().

◆ ast_rtp_instance_set_channel_id()

void ast_rtp_instance_set_channel_id	(	struct ast_rtp_instance *	instance,
		const char *	uniqueid
	)

Set the channel that owns this RTP instance.

Parameters

instance	The RTP instance
uniqueid	The uniqueid of the channel

Since: 12

Definition at line 575 of file rtp_engine.c.

{
    ast_copy_string(instance->channel_uniqueid, uniqueid, sizeof(instance->channel_uniqueid));
}

References ast_copy_string(), and ast_rtp_instance::channel_uniqueid.

Referenced by apply_negotiated_sdp_stream(), jingle_enable_video(), jingle_set_owner(), multicast_rtp_request(), set_channel_on_rtp_instance(), start_rtp(), test_init_rtp_instances(), unicast_rtp_request(), and unistim_set_owner().

◆ ast_rtp_instance_set_data()

void ast_rtp_instance_set_data	(	struct ast_rtp_instance *	instance,
		void *	data
	)

Set the data portion of an RTP instance.

Parameters

instance	The RTP instance to manipulate
data	Pointer to data

Example usage:

ast_rtp_instance_set_data(instance, blob);

ast_rtp_instance_set_data

void ast_rtp_instance_set_data(struct ast_rtp_instance *instance, void *data)

Set the data portion of an RTP instance.

Definition: rtp_engine.c:580

This sets the data pointer on the RTP instance pointed to by 'instance' to blob.

Since: 1.8

Definition at line 580 of file rtp_engine.c.

{
    instance->data = data;
}

References ast_rtp_instance::data.

Referenced by ast_rtp_new(), and multicast_rtp_new().

◆ ast_rtp_instance_set_extended_prop()

void ast_rtp_instance_set_extended_prop	(	struct ast_rtp_instance *	instance,
		int	property,
		void *	value
	)

Set the value of an RTP instance extended property.

Parameters

instance	The RTP instance to set the extended property on
property	The extended property to set
value	The value to set the extended property to

Since: 1.8

Definition at line 703 of file rtp_engine.c.

{
    if (instance->engine->extended_prop_set) {
        ao2_lock(instance);
        instance->engine->extended_prop_set(instance, property, value);
        ao2_unlock(instance);
    }
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::extended_prop_set, and value.

◆ ast_rtp_instance_set_hold_timeout()

void ast_rtp_instance_set_hold_timeout	(	struct ast_rtp_instance *	instance,
		int	timeout
	)

Set the RTP timeout value for when the instance is on hold.

Parameters

instance	The RTP instance
timeout	Value to set the timeout to

Example usage:

ast_rtp_instance_set_hold_timeout(instance, 5000);

ast_rtp_instance_set_hold_timeout

void ast_rtp_instance_set_hold_timeout(struct ast_rtp_instance *instance, int timeout)

Set the RTP timeout value for when the instance is on hold.

Definition: rtp_engine.c:2875

This sets the RTP hold timeout value on 'instance' to be 5000.

Since: 1.8

Definition at line 2875 of file rtp_engine.c.

{
    instance->holdtimeout = timeout;
}

References ast_rtp_instance::holdtimeout, and ast_rtp_instance::timeout.

◆ ast_rtp_instance_set_incoming_source_address()

int ast_rtp_instance_set_incoming_source_address	(	struct ast_rtp_instance *	instance,
		const struct ast_sockaddr *	address
	)

Set the incoming source address of the remote endpoint that we are sending RTP to.

This sets the incoming source address the engine is sending RTP to. Usually this will be the same as the requested target address, however in the case where the engine "learns" the address (for instance, symmetric RTP enabled) this will then contain the learned address.

Parameters

instance	The RTP instance to change the address on
address	Address to set it to

Return values

0	success
-1	failure

Definition at line 628 of file rtp_engine.c.

{
    ao2_lock(instance);
    rtp_instance_set_incoming_source_address_nolock(instance, address);
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, and rtp_instance_set_incoming_source_address_nolock().

Referenced by ast_rtp_read().

◆ ast_rtp_instance_set_keepalive()

void ast_rtp_instance_set_keepalive	(	struct ast_rtp_instance *	instance,
		int	timeout
	)

Set the RTP keepalive interval.

Parameters

instance	The RTP instance
timeout	Value to set the keepalive interval to

Example usage:

ast_rtp_instance_set_keepalive(instance, 5000);

ast_rtp_instance_set_keepalive

void ast_rtp_instance_set_keepalive(struct ast_rtp_instance *instance, int timeout)

Set the RTP keepalive interval.

Definition: rtp_engine.c:2880

This sets the RTP keepalive interval on 'instance' to be 5000.

Since: 1.8

Definition at line 2880 of file rtp_engine.c.

{
    instance->keepalive = interval;
}

References ast_rtp_instance::keepalive.

Referenced by apply_negotiated_sdp_stream().

◆ ast_rtp_instance_set_last_rx()

void ast_rtp_instance_set_last_rx	(	struct ast_rtp_instance *	rtp,
		time_t	time
	)

Set the last RTP reception time.

Parameters

rtp	The instance on which to set the last reception time
time	The last reception time

Definition at line 4006 of file rtp_engine.c.

{
    rtp->last_rx = time;
}

References ast_rtp_instance::last_rx.

Referenced by create_rtp(), media_session_rtcp_read_callback(), media_session_rtp_read_callback(), and rtp_check_timeout().

◆ ast_rtp_instance_set_last_tx()

void ast_rtp_instance_set_last_tx	(	struct ast_rtp_instance *	rtp,
		time_t	time
	)

Set the last RTP transmission time.

Parameters

rtp	The instance on which to set the last transmission time
time	The last transmission time

Definition at line 3996 of file rtp_engine.c.

{
    rtp->last_tx = time;
}

References ast_rtp_instance::last_tx.

Referenced by __rtp_sendto().

◆ ast_rtp_instance_set_local_address()

int ast_rtp_instance_set_local_address	(	struct ast_rtp_instance *	instance,
		const struct ast_sockaddr *	address
	)

Set the address that we are expecting to receive RTP on.

Parameters

instance	The RTP instance to change the address on
address	Address to set it to

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_set_local_address(instance, &sin);

ast_rtp_instance_set_local_address

int ast_rtp_instance_set_local_address(struct ast_rtp_instance *instance, const struct ast_sockaddr *address)

Set the address that we are expecting to receive RTP on.

Definition: rtp_engine.c:610

This changes the local address that RTP is expected on to the address given in the sin structure.

Since: 1.8

Definition at line 610 of file rtp_engine.c.

{
    ao2_lock(instance);
    ast_sockaddr_copy(&instance->local_address, address);
    ao2_unlock(instance);
    return 0;
}

References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::local_address.

Referenced by ast_rtp_remote_address_set(), and rtp_allocate_transport().

◆ ast_rtp_instance_set_prop()

void ast_rtp_instance_set_prop	(	struct ast_rtp_instance *	instance,
		enum ast_rtp_property	property,
		int	value
	)

Set the value of an RTP instance property.

Parameters

instance	The RTP instance to set the property on
property	The property to modify
value	The value to set the property to

Example usage:

ast_rtp_instance_set_prop(instance, AST_RTP_PROPERTY_NAT, 1);

ast_rtp_instance_set_prop

void ast_rtp_instance_set_prop(struct ast_rtp_instance *instance, enum ast_rtp_property property, int value)

Set the value of an RTP instance property.

Definition: rtp_engine.c:727

This enables the AST_RTP_PROPERTY_NAT property on the instance pointed to by instance.

Since: 1.8

Definition at line 727 of file rtp_engine.c.

{
    ao2_lock(instance);
    instance->properties[property] = value;
 
    if (instance->engine->prop_set) {
        instance->engine->prop_set(instance, property, value);
    }
    ao2_unlock(instance);
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::prop_set, ast_rtp_instance::properties, and value.

Referenced by check_for_rtp_changes(), configure_local_rtp(), create_rtp(), enable_rtcp(), get_codecs(), jingle_alloc(), jingle_enable_video(), pjsip_acf_dtmf_mode_write(), start_rtp(), and test_init_rtp_instances().

◆ ast_rtp_instance_set_qos()

int ast_rtp_instance_set_qos	(	struct ast_rtp_instance *	instance,
		int	tos,
		int	cos,
		const char *	desc
	)

Set QoS parameters on an RTP session.

Parameters

instance	Instance to set the QoS parameters on
tos	Terms of service value
cos	Class of service value
desc	What is setting the QoS values

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_set_qos(instance, 0, 0, "Example");

ast_rtp_instance_set_qos

int ast_rtp_instance_set_qos(struct ast_rtp_instance *instance, int tos, int cos, const char *desc)

Set QoS parameters on an RTP session.

Definition: rtp_engine.c:2345

This sets the TOS and COS values to 0 on the instance pointed to by instance.

Since: 1.8

Definition at line 2345 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->qos) {
        ao2_lock(instance);
        res = instance->engine->qos(instance, tos, cos, desc);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, cos, desc, ast_rtp_instance::engine, ast_rtp_engine::qos, and tos.

Referenced by configure_local_rtp(), create_rtp(), and start_rtp().

◆ ast_rtp_instance_set_read_format()

int ast_rtp_instance_set_read_format	(	struct ast_rtp_instance *	instance,
		struct ast_format *	format
	)

Request that the underlying RTP engine provide audio frames in a specific format.

Parameters

instance	The RTP instance to change read format on
format	Format that frames are wanted in

Return values

0	success
-1	failure

Example usage:

struct ast_format tmp_fmt;

ast_rtp_instance_set_read_format(instance, ast_format_ulaw);

ast_rtp_instance_set_read_format

int ast_rtp_instance_set_read_format(struct ast_rtp_instance *instance, struct ast_format *format)

Request that the underlying RTP engine provide audio frames in a specific format.

Definition: rtp_engine.c:2760

This requests that the RTP engine provide audio frames in the ULAW format.

Since: 1.8

Definition at line 2760 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->set_read_format) {
        ao2_lock(instance);
        res = instance->engine->set_read_format(instance, format);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_read_format.

◆ ast_rtp_instance_set_remote_ssrc()

void ast_rtp_instance_set_remote_ssrc	(	struct ast_rtp_instance *	rtp,
		unsigned int	ssrc
	)

Set the remote SSRC for an RTP instance.

Since: 15.0.0

Parameters

rtp	The RTP instance
ssrc	The remote SSRC

Definition at line 4054 of file rtp_engine.c.

{
    ao2_lock(rtp);
    if (rtp->engine->set_remote_ssrc) {
        rtp->engine->set_remote_ssrc(rtp, ssrc);
    }
    ao2_unlock(rtp);
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_remote_ssrc.

Referenced by process_ssrc_attributes().

◆ ast_rtp_instance_set_requested_target_address()

int ast_rtp_instance_set_requested_target_address	(	struct ast_rtp_instance *	instance,
		const struct ast_sockaddr *	address
	)

Set the requested target address of the remote endpoint.

This should always be the address of the remote endpoint. Consequently, this can differ from the address the engine is sending RTP to. However, usually they will be the same except in some circumstances (for instance when the engine "learns" the address if symmetric RTP is enabled).

Parameters

instance	The RTP instance to change the address on
address	Address to set it to

Return values

0	success
-1	failure

Definition at line 638 of file rtp_engine.c.

{
    ao2_lock(instance);
 
    ast_sockaddr_copy(&instance->requested_target_address, address);
    rtp_instance_set_incoming_source_address_nolock(instance, address);
 
    ao2_unlock(instance);
 
    return 0;
}

References ao2_lock, ao2_unlock, ast_sockaddr_copy(), ast_rtp_instance::requested_target_address, and rtp_instance_set_incoming_source_address_nolock().

◆ ast_rtp_instance_set_stats_vars()

void ast_rtp_instance_set_stats_vars	(	struct ast_channel *	chan,
		struct ast_rtp_instance *	instance
	)

Set standard statistics from an RTP instance on a channel.

Parameters

chan	Channel to set the statistics on
instance	The RTP instance that statistics will be retrieved from

Note: Absolutely NO channel locks should be held before calling this function.

Example usage:

ast_rtp_instance_set_stats_vars(chan, rtp);

ast_rtp_instance_set_stats_vars

void ast_rtp_instance_set_stats_vars(struct ast_channel *chan, struct ast_rtp_instance *instance)

Set standard statistics from an RTP instance on a channel.

Definition: rtp_engine.c:2691

This retrieves standard statistics from the RTP instance rtp and sets it on the channel pointed to by chan.

Since: 1.8

Definition at line 2691 of file rtp_engine.c.

{
    char quality_buf[AST_MAX_USER_FIELD];
    char *quality;
    struct ast_channel *bridge;
 
    bridge = ast_channel_bridge_peer(chan);
    if (bridge) {
        ast_channel_lock_both(chan, bridge);
        ast_channel_stage_snapshot(bridge);
    } else {
        ast_channel_lock(chan);
    }
    ast_channel_stage_snapshot(chan);
 
    quality = ast_rtp_instance_get_quality(instance, AST_RTP_INSTANCE_STAT_FIELD_QUALITY,
        quality_buf, sizeof(quality_buf));
    if (quality) {
        pbx_builtin_setvar_helper(chan, "RTPAUDIOQOS", quality);
        if (bridge) {
            pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSBRIDGED", quality);
        }
    }
 
    quality = ast_rtp_instance_get_quality(instance,
        AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, quality_buf, sizeof(quality_buf));
    if (quality) {
        pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSJITTER", quality);
        if (bridge) {
            pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSJITTERBRIDGED", quality);
        }
    }
 
    quality = ast_rtp_instance_get_quality(instance,
        AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, quality_buf, sizeof(quality_buf));
    if (quality) {
        pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSLOSS", quality);
        if (bridge) {
            pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSLOSSBRIDGED", quality);
        }
    }
 
    quality = ast_rtp_instance_get_quality(instance,
        AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, quality_buf, sizeof(quality_buf));
    if (quality) {
        pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSRTT", quality);
        if (bridge) {
            pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSRTTBRIDGED", quality);
        }
    }
 
    quality = ast_rtp_instance_get_quality(instance,
        AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, quality_buf, sizeof(quality_buf));
    if (quality) {
        pbx_builtin_setvar_helper(chan, "RTPAUDIOQOSMES", quality);
        if (bridge) {
            pbx_builtin_setvar_helper(bridge, "RTPAUDIOQOSMESBRIDGED", quality);
        }
    }
 
    ast_channel_stage_snapshot_done(chan);
    ast_channel_unlock(chan);
    if (bridge) {
        ast_channel_stage_snapshot_done(bridge);
        ast_channel_unlock(bridge);
        ast_channel_unref(bridge);
    }
}

References ast_channel_bridge_peer(), ast_channel_lock, ast_channel_lock_both, ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_unlock, ast_channel_unref, AST_MAX_USER_FIELD, ast_rtp_instance_get_quality(), AST_RTP_INSTANCE_STAT_FIELD_QUALITY, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, ast_channel::bridge, pbx_builtin_setvar_helper(), and quality.

Referenced by chan_pjsip_session_end(), and hangup().

◆ ast_rtp_instance_set_stream_num()

void ast_rtp_instance_set_stream_num	(	struct ast_rtp_instance *	instance,
		int	stream_num
	)

Set the stream number for an RTP instance.

Since: 15.0.0

Parameters

instance	The RTP instance
stream_num	The stream identifier number

Definition at line 4063 of file rtp_engine.c.

{
    ao2_lock(rtp);
    if (rtp->engine->set_stream_num) {
        rtp->engine->set_stream_num(rtp, stream_num);
    }
    ao2_unlock(rtp);
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_stream_num.

Referenced by apply_negotiated_sdp_stream().

◆ ast_rtp_instance_set_timeout()

void ast_rtp_instance_set_timeout	(	struct ast_rtp_instance *	instance,
		int	timeout
	)

Set the RTP timeout value.

Parameters

instance	The RTP instance
timeout	Value to set the timeout to

Example usage:

ast_rtp_instance_set_timeout(instance, 5000);

ast_rtp_instance_set_timeout

void ast_rtp_instance_set_timeout(struct ast_rtp_instance *instance, int timeout)

Set the RTP timeout value.

Definition: rtp_engine.c:2870

This sets the RTP timeout value on 'instance' to be 5000.

Since: 1.8

Definition at line 2870 of file rtp_engine.c.

{
    instance->timeout = timeout;
}

References ast_rtp_instance::timeout.

Referenced by apply_negotiated_sdp_stream(), and configure_local_rtp().

◆ ast_rtp_instance_set_write_format()

int ast_rtp_instance_set_write_format	(	struct ast_rtp_instance *	instance,
		struct ast_format *	format
	)

Tell underlying RTP engine that audio frames will be provided in a specific format.

Parameters

instance	The RTP instance to change write format on
format	Format that frames will be provided in

Return values

0	success
-1	failure

Example usage:

struct ast_format tmp_fmt;

ast_rtp_instance_set_write_format(instance, ast_format_ulaw);

ast_rtp_instance_set_write_format

int ast_rtp_instance_set_write_format(struct ast_rtp_instance *instance, struct ast_format *format)

Tell underlying RTP engine that audio frames will be provided in a specific format.

Definition: rtp_engine.c:2774

This tells the underlying RTP engine that audio frames will be provided to it in ULAW format.

Since: 1.8

Definition at line 2774 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->set_read_format) {
        ao2_lock(instance);
        res = instance->engine->set_write_format(instance, format);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::set_read_format, and ast_rtp_engine::set_write_format.

◆ ast_rtp_instance_stop()

void ast_rtp_instance_stop ( struct ast_rtp_instance * instance )

Stop an RTP instance.

Parameters

instance Instance that media is no longer going to at this time

Example usage:

ast_rtp_instance_stop(instance);

ast_rtp_instance_stop

void ast_rtp_instance_stop(struct ast_rtp_instance *instance)

Stop an RTP instance.

Definition: rtp_engine.c:2359

This tells the RTP engine being used for the instance pointed to by instance that media is no longer going to it at this time, but may in the future.

Since: 1.8

Definition at line 2359 of file rtp_engine.c.

{
    if (instance->engine->stop) {
        ao2_lock(instance);
        instance->engine->stop(instance);
        ao2_unlock(instance);
    }
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::stop.

Referenced by apply_negotiated_sdp_stream(), close_rtp_connection(), jingle_session_destructor(), ooh323_destroy(), stream_stop(), and unistim_hangup_clean().

◆ ast_rtp_instance_stun_request()

void ast_rtp_instance_stun_request	(	struct ast_rtp_instance *	instance,
		struct ast_sockaddr *	suggestion,
		const char *	username
	)

Request that the underlying RTP engine send a STUN BIND request.

Parameters

instance	The RTP instance
suggestion	The suggested destination
username	Optionally a username for the request

Example usage:

ast_rtp_instance_stun_request(instance, NULL, NULL);

ast_rtp_instance_stun_request

void ast_rtp_instance_stun_request(struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username)

Request that the underlying RTP engine send a STUN BIND request.

Definition: rtp_engine.c:2861

This requests that the RTP engine send a STUN BIND request on the session pointed to by 'instance'.

Since: 1.8

Definition at line 2861 of file rtp_engine.c.

{
    if (instance->engine->stun_request) {
        instance->engine->stun_request(instance, suggestion, username);
    }
}

References ast_rtp_instance::engine, and ast_rtp_engine::stun_request.

Referenced by jingle_interpret_google_transport().

◆ ast_rtp_instance_update_source()

void ast_rtp_instance_update_source ( struct ast_rtp_instance * instance )

Indicate that the RTP marker bit should be set on an RTP stream.

Parameters

instance Instance that the new media source is feeding into

Example usage:

ast_rtp_instance_update_source(instance);

ast_rtp_instance_update_source

void ast_rtp_instance_update_source(struct ast_rtp_instance *instance)

Indicate that the RTP marker bit should be set on an RTP stream.

Definition: rtp_engine.c:2327

This indicates that the source of media that is feeding the instance pointed to by instance has been updated and that the marker bit should be set.

Since: 1.8

Definition at line 2327 of file rtp_engine.c.

{
    if (instance->engine->update_source) {
        ao2_lock(instance);
        instance->engine->update_source(instance);
        ao2_unlock(instance);
    }
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::update_source.

Referenced by jingle_indicate(), and ooh323_indicate().

◆ ast_rtp_instance_write()

int ast_rtp_instance_write	(	struct ast_rtp_instance *	instance,
		struct ast_frame *	frame
	)

Send a frame out over RTP.

Parameters

instance	The RTP instance to send frame out on
frame	the frame to send out

Return values

0	success
-1	failure

Example usage:

ast_rtp_instance_write(instance, frame);

ast_rtp_instance_write

int ast_rtp_instance_write(struct ast_rtp_instance *instance, struct ast_frame *frame)

Send a frame out over RTP.

Definition: rtp_engine.c:590

This gives the frame pointed to by frame to the RTP engine being used for the instance and asks that it be transmitted to the current remote address set on the RTP instance.

Since: 1.8

Definition at line 590 of file rtp_engine.c.

{
    int res;
 
    ao2_lock(instance);
    res = instance->engine->write(instance, frame);
    ao2_unlock(instance);
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::write.

Referenced by AST_TEST_DEFINE(), chan_pjsip_indicate(), jingle_write(), media_session_rtp_write_callback(), ooh323_write(), rtp_write(), test_write_and_read_interleaved_frames(), test_write_frames(), and unistim_write().

◆ ast_rtp_lookup_mime_multiple2()

char * ast_rtp_lookup_mime_multiple2	(	struct ast_str *	buf,
		struct ast_format_cap *	ast_format_capability,
		int	rtp_capability,
		const int	asterisk_format,
		enum ast_rtp_options	options
	)

Convert formats into a string and put them into a buffer.

Parameters

buf	Buffer to put the mime output into
ast_format_capability	Asterisk Formats we are looking up.
rtp_capability	RTP codes that we are looking up
asterisk_format	Non-zero if the ast_format_capability structure is to be used, 0 if rtp_capability is to be used
options	Additional options that may change the result

Return values

non-NULL	success
NULL	failure

Example usage:

char buf[256] = "";
struct ast_format tmp_fmt;
struct ast_format_cap *cap = ast_format_cap_alloc_nolock();
ast_format_cap_append(cap, ast_format_ulaw, 0);
ast_format_cap_append(cap, ast_format_ulaw, 0);
char *mime = ast_rtp_lookup_mime_multiple2(&buf, sizeof(buf), cap, 0, 1, 0);
ast_format_cap_destroy(cap);

This returns the mime values for ULAW and ALAW in the buffer pointed to by buf.

Since: 1.8

Definition at line 2221 of file rtp_engine.c.

{
    int found = 0;
    const char *name;
    if (!buf) {
        return NULL;
    }
 
 
    if (asterisk_format) {
        int x;
        struct ast_format *tmp_fmt;
        for (x = 0; x < ast_format_cap_count(ast_format_capability); x++) {
            tmp_fmt = ast_format_cap_get_format(ast_format_capability, x);
            name = ast_rtp_lookup_mime_subtype2(asterisk_format, tmp_fmt, 0, options);
            ao2_ref(tmp_fmt, -1);
            ast_str_append(&buf, 0, "%s|", name);
            found = 1;
        }
    } else {
        int x;
        ast_str_append(&buf, 0, "0x%x (", (unsigned int) rtp_capability);
        for (x = 1; x <= AST_RTP_MAX; x <<= 1) {
            if (rtp_capability & x) {
                name = ast_rtp_lookup_mime_subtype2(asterisk_format, NULL, x, options);
                ast_str_append(&buf, 0, "%s|", name);
                found = 1;
            }
        }
    }
 
    ast_str_append(&buf, 0, "%s", found ? ")" : "nothing)");
 
    return ast_str_buffer(buf);
}

References ao2_ref, ast_format_cap_count(), ast_format_cap_get_format(), ast_rtp_lookup_mime_subtype2(), AST_RTP_MAX, ast_str_append(), ast_str_buffer(), ast_rtp_payload_type::asterisk_format, buf, name, NULL, and options.

◆ ast_rtp_lookup_mime_subtype2()

const char * ast_rtp_lookup_mime_subtype2	(	const int	asterisk_format,
		const struct ast_format *	format,
		int	code,
		enum ast_rtp_options	options
	)

Retrieve mime subtype information on a payload.

Parameters

asterisk_format	Non-zero to look up using Asterisk format
format	Asterisk format to look up
code	RTP code to look up
options	Additional options that may change the result

Returns: Mime subtype success

Return values

NULL failure

Example usage:

const char *subtype = ast_rtp_lookup_mime_subtype2(1, ast_format_ulaw, 0, 0);

ast_rtp_lookup_mime_subtype2

const char * ast_rtp_lookup_mime_subtype2(const int asterisk_format, const struct ast_format *format, int code, enum ast_rtp_options options)

Retrieve mime subtype information on a payload.

Definition: rtp_engine.c:2168

This looks up the mime subtype for the ULAW format.

Since: 1.8

Definition at line 2168 of file rtp_engine.c.

{
    int i;
    const char *res = "";
 
    ast_rwlock_rdlock(&mime_types_lock);
    for (i = 0; i < mime_types_len; i++) {
        if (ast_rtp_mime_types[i].payload_type.asterisk_format && asterisk_format && format &&
            (ast_format_cmp(format, ast_rtp_mime_types[i].payload_type.format) != AST_FORMAT_CMP_NOT_EQUAL)) {
            if ((ast_format_cmp(format, ast_format_g726_aal2) == AST_FORMAT_CMP_EQUAL) &&
                    (options & AST_RTP_OPT_G726_NONSTANDARD)) {
                res = "G726-32";
                break;
            } else {
                res = ast_rtp_mime_types[i].subtype;
                break;
            }
        } else if (!ast_rtp_mime_types[i].payload_type.asterisk_format && !asterisk_format &&
            ast_rtp_mime_types[i].payload_type.rtp_code == code) {
 
            res = ast_rtp_mime_types[i].subtype;
            break;
        }
    }
    ast_rwlock_unlock(&mime_types_lock);
 
    return res;
}

References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_g726_aal2, ast_rtp_mime_types, AST_RTP_OPT_G726_NONSTANDARD, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rtp_payload_type::asterisk_format, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, options, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, and ast_rtp_mime_type::subtype.

Referenced by ast_rtp_lookup_mime_multiple2(), generate_rtpmap_attr(), generate_rtpmap_attr2(), and jingle_add_payloads_to_description().

◆ ast_rtp_lookup_sample_rate2()

unsigned int ast_rtp_lookup_sample_rate2	(	int	asterisk_format,
		const struct ast_format *	format,
		int	code
	)

Get the sample rate associated with known RTP payload types.

Parameters

asterisk_format	True if the value in format is to be used.
format	An asterisk format
code	from AST_RTP list

Returns: the sample rate if the format was found, zero if it was not found

Since: 1.8

Definition at line 2198 of file rtp_engine.c.

{
    unsigned int i;
    unsigned int res = 0;
 
    ast_rwlock_rdlock(&mime_types_lock);
    for (i = 0; i < mime_types_len; ++i) {
        if (ast_rtp_mime_types[i].payload_type.asterisk_format && asterisk_format && format &&
            (ast_format_cmp(format, ast_rtp_mime_types[i].payload_type.format) != AST_FORMAT_CMP_NOT_EQUAL)) {
            res = ast_rtp_mime_types[i].sample_rate;
            break;
        } else if (!ast_rtp_mime_types[i].payload_type.asterisk_format && !asterisk_format &&
            ast_rtp_mime_types[i].payload_type.rtp_code == code) {
            res = ast_rtp_mime_types[i].sample_rate;
            break;
        }
    }
    ast_rwlock_unlock(&mime_types_lock);
 
    return res;
}

References ast_format_cmp(), AST_FORMAT_CMP_NOT_EQUAL, ast_rtp_mime_types, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rtp_payload_type::asterisk_format, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, and ast_rtp_mime_type::sample_rate.

Referenced by create_outgoing_sdp_stream(), generate_rtpmap_attr(), and jingle_add_payloads_to_description().

◆ ast_rtp_payload_mapping_tx_is_present()

int ast_rtp_payload_mapping_tx_is_present	(	struct ast_rtp_codecs *	codecs,
		const struct ast_rtp_payload_type *	to_match
	)

Determine if a type of payload is already present in mappings.

Since: 18

Parameters

codecs	Codecs to be checked for mappings.
to_match	Payload type object to compare against.

Note: It is assumed that codecs is not locked before calling.

Return values

0	not found
1	found

Definition at line 1220 of file rtp_engine.c.

                                                                                                                      {
    int ret = 0;
    if (codecs && to_match) {
        ast_rwlock_rdlock(&codecs->codecs_lock);
        ret = payload_mapping_tx_is_present(codecs, to_match);
        ast_rwlock_unlock(&codecs->codecs_lock);
    }
    return ret;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, codecs, and payload_mapping_tx_is_present().

Referenced by ast_rtp_dtmf_begin().

◆ ast_rtp_publish_rtcp_message()

void ast_rtp_publish_rtcp_message	(	struct ast_rtp_instance *	rtp,
		struct stasis_message_type *	message_type,
		struct ast_rtp_rtcp_report *	report,
		struct ast_json *	blob
	)

Publish an RTCP message to Stasis Message Bus API.

Since: 12

Parameters

rtp	The rtp instance object
message_type	The RTP message type to publish
report	The RTCP report object to publish. This should be an ao2 ref counted object. This routine will increase the reference count of the object.
blob	Additional JSON objects to publish along with the RTCP information

Definition at line 3690 of file rtp_engine.c.

{
    RAII_VAR(struct rtcp_message_payload *, payload, NULL, ao2_cleanup);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
 
    if (!message_type) {
        return;
    }
 
    payload = ao2_alloc(sizeof(*payload), rtcp_message_payload_dtor);
    if (!payload || !report) {
        return;
    }
 
    if (!ast_strlen_zero(rtp->channel_uniqueid)) {
        payload->snapshot = ast_channel_snapshot_get_latest(rtp->channel_uniqueid);
    }
    if (blob) {
        payload->blob = blob;
        ast_json_ref(blob);
    }
    ao2_ref(report, +1);
    payload->report = report;
 
    message = stasis_message_create(message_type, payload);
    if (!message) {
        return;
    }
 
    stasis_publish(ast_rtp_topic(), message);
}

References ao2_alloc, ao2_cleanup, ao2_ref, ast_channel_snapshot_get_latest(), ast_json_ref(), ast_rtp_topic(), ast_strlen_zero(), ast_rtp_instance::channel_uniqueid, NULL, RAII_VAR, rtcp_message_payload_dtor(), stasis_message_create(), and stasis_publish().

Referenced by ast_rtcp_calculate_sr_rr_statistics(), and ast_rtcp_interpret().

◆ ast_rtp_red_buffer()

int ast_rtp_red_buffer	(	struct ast_rtp_instance *	instance,
		struct ast_frame *	frame
	)

Buffer a frame in an RTP instance for RED.

Parameters

instance	The instance to buffer the frame on
frame	Frame that we want to buffer

Return values

0	success
-1	failure

Since: 1.8

Definition at line 2608 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->red_buffer) {
        ao2_lock(instance);
        res = instance->engine->red_buffer(instance, frame);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::red_buffer.

◆ ast_rtp_red_init()

int ast_rtp_red_init	(	struct ast_rtp_instance *	instance,
		int	buffer_time,
		int *	payloads,
		int	generations
	)

Initialize RED support on an RTP instance.

Parameters

instance	The instance to initialize RED support on
buffer_time	How long to buffer before sending
payloads	Payload values
generations	Number of generations

Return values

0	success
-1	failure

Since: 1.8

Definition at line 2594 of file rtp_engine.c.

{
    int res;
 
    if (instance->engine->red_init) {
        ao2_lock(instance);
        res = instance->engine->red_init(instance, buffer_time, payloads, generations);
        ao2_unlock(instance);
    } else {
        res = -1;
    }
    return res;
}

References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::red_init.

◆ ast_rtp_rtcp_report_alloc()

struct ast_rtp_rtcp_report * ast_rtp_rtcp_report_alloc ( unsigned int report_blocks )

Allocate an ao2 ref counted instance of ast_rtp_rtcp_report.

Parameters

report_blocks The number of report blocks to allocate

Returns: An ao2 ref counted ast_rtp_rtcp_report object on success

Return values

NULL on error

Definition at line 3679 of file rtp_engine.c.

{
    struct ast_rtp_rtcp_report *rtcp_report;
 
    /* Size of object is sizeof the report + the number of report_blocks * sizeof pointer */
    rtcp_report = ao2_alloc((sizeof(*rtcp_report) + report_blocks * sizeof(struct ast_rtp_rtcp_report_block *)),
        rtp_rtcp_report_dtor);
 
    return rtcp_report;
}

References ao2_alloc, and rtp_rtcp_report_dtor().

Referenced by ast_rtcp_interpret(), ast_rtcp_write(), ast_rtp_read(), rtp_write_rtcp_fir(), and rtp_write_rtcp_psfb().

◆ ast_rtp_topic()

struct stasis_topic * ast_rtp_topic ( void )

Stasis Message Bus API topic for RTP and RTCP related messages

Since: 12

Returns: A Stasis Message Bus API topic

Definition at line 3736 of file rtp_engine.c.

{
    return rtp_topic;
}

References rtp_topic.

Referenced by ast_rtp_publish_rtcp_message(), load_module(), and manager_subscriptions_init().

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AST_DEBUG_CATEGORY_DTLS

◆ AST_DEBUG_CATEGORY_DTLS_PACKET

◆ AST_DEBUG_CATEGORY_ICE

◆ AST_DEBUG_CATEGORY_RTCP

◆ AST_DEBUG_CATEGORY_RTCP_PACKET

◆ AST_DEBUG_CATEGORY_RTP

◆ AST_DEBUG_CATEGORY_RTP_PACKET

◆ ast_debug_dtls

◆ ast_debug_dtls_packet_is_allowed

◆ ast_debug_ice

◆ ast_debug_rtcp

◆ ast_debug_rtcp_is_allowed

◆ ast_debug_rtcp_packet_is_allowed

◆ ast_debug_rtp

◆ ast_debug_rtp_is_allowed

◆ ast_debug_rtp_packet_is_allowed

◆ AST_LOG_CATEGORY_DTLS

◆ AST_LOG_CATEGORY_DTLS_PACKET

◆ AST_LOG_CATEGORY_ICE

◆ AST_LOG_CATEGORY_RTCP

◆ AST_LOG_CATEGORY_RTCP_PACKET

◆ AST_LOG_CATEGORY_RTP

◆ AST_LOG_CATEGORY_RTP_PACKET

◆ AST_RED_MAX_GENERATION

◆ AST_RTP_CISCO_DTMF

◆ AST_RTP_CN

◆ AST_RTP_CODECS_NULL_INIT

◆ AST_RTP_DTMF

◆ ast_rtp_engine_register

◆ ast_rtp_glue_register

◆ ast_rtp_instance_get_and_cmp_remote_address

◆ ast_rtp_instance_get_remote_address

◆ ast_rtp_instance_set_remote_address

◆ AST_RTP_MAX

◆ AST_RTP_MAX_PT

◆ AST_RTP_PT_FIRST_DYNAMIC

◆ AST_RTP_PT_LAST_REASSIGN

◆ AST_RTP_PT_LAST_STATIC

◆ AST_RTP_RTCP_FMT_FIR

◆ AST_RTP_RTCP_FMT_NACK

◆ AST_RTP_RTCP_FMT_PLI

◆ AST_RTP_RTCP_FMT_REMB

◆ AST_RTP_RTCP_FMT_TRANSPORT_WIDE_CC

◆ AST_RTP_RTCP_PSFB

◆ AST_RTP_RTCP_RR

◆ AST_RTP_RTCP_RTPFB

◆ AST_RTP_RTCP_SR

◆ AST_RTP_STAT_SET

◆ AST_RTP_STAT_STRCPY

◆ AST_RTP_STAT_TERMINATOR

◆ DEFAULT_DTMF_SAMPLE_RATE_MS

◆ MAX_CHANNEL_ID

Enumeration Type Documentation

◆ ast_rtp_dtls_connection

◆ ast_rtp_dtls_hash

◆ ast_rtp_dtls_setup

◆ ast_rtp_dtls_verify

◆ ast_rtp_dtmf_mode

◆ ast_rtp_extension

◆ ast_rtp_extension_direction

◆ ast_rtp_glue_result

◆ ast_rtp_ice_candidate_type

◆ ast_rtp_ice_component_type

◆ ast_rtp_ice_role

◆ ast_rtp_instance_rtcp

◆ ast_rtp_instance_stat

◆ ast_rtp_instance_stat_field

◆ ast_rtp_options

◆ ast_rtp_property

Function Documentation

◆ ast_debug_category_dtls_id()

◆ ast_debug_category_dtls_packet_id()

◆ ast_debug_category_ice_id()

◆ ast_debug_category_rtcp_id()