Asterisk - The Open Source Telephony Project GIT-master-3dee037
Data Structures | Macros | Enumerations | Functions
rtp_engine.h File Reference

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_typeast_rtp_codecs_get_payload (struct ast_rtp_codecs *codecs, int payload)
 Retrieve rx payload mapped information by payload type. More...
 
struct ast_formatast_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_formatast_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_jsonast_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_typeast_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_glueast_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_instanceast_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_codecsast_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_dtlsast_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_engineast_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_glueast_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_iceast_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_srtpast_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_jsonast_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_instanceast_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_frameast_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_typeast_rtp_rtcp_received_type (void)
 Message type for an RTCP message received from some external source. More...
 
struct ast_rtp_rtcp_reportast_rtp_rtcp_report_alloc (unsigned int report_blocks)
 Allocate an ao2 ref counted instance of ast_rtp_rtcp_report. More...
 
struct stasis_message_typeast_rtp_rtcp_sent_type (void)
 Message type for an RTCP message sent from this Asterisk instance. More...
 
struct stasis_topicast_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
sublevelDebug output sublevel (>= 0)
...String format and any associated arguments

Definition at line 3133 of file rtp_engine.h.

◆ ast_debug_dtls_packet_is_allowed

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
sublevelDebug 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
sublevelDebug output sublevel (>= 0)
...String format and any associated arguments

Definition at line 3116 of file rtp_engine.h.

◆ ast_debug_rtcp_is_allowed

Definition at line 3120 of file rtp_engine.h.

◆ ast_debug_rtcp_packet_is_allowed

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
sublevelDebug output sublevel (>= 0)
...String format and any associated arguments

Definition at line 3099 of file rtp_engine.h.

◆ ast_debug_rtp_is_allowed

Definition at line 3103 of file rtp_engine.h.

◆ ast_debug_rtp_packet_is_allowed

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}
#define AST_RWLOCK_INIT_VALUE
Definition: lock.h:98
#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
instanceThe instance that we want to get the remote address for
addressAn initialized address that may be overwritten if the remote address is different
Return values
0address was not changed
1address was changed Example usage:
int ret;
char * address
Definition: f2c.h:59
#define ast_rtp_instance_get_and_cmp_remote_address(instance, address)
Get the address of the remote endpoint that we are sending RTP to, comparing its address to another.
Definition: rtp_engine.h:1286
Socket address structure.
Definition: netsock2.h:97

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
instanceThe instance that we want to get the remote address for
addressA structure to put the address into

Example usage:

#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
instanceThe RTP instance to change the address on
addressAddress to set it to
Return values
0success
-1failure

Example usage:

#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

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.

572 {
573 AST_RTP_DTLS_CONNECTION_NEW, /*!< Endpoint wants to use a new connection */
574 AST_RTP_DTLS_CONNECTION_EXISTING, /*!< Endpoint wishes to use existing connection */
575};
@ AST_RTP_DTLS_CONNECTION_NEW
Definition: rtp_engine.h:573
@ AST_RTP_DTLS_CONNECTION_EXISTING
Definition: rtp_engine.h:574

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

578 {
579 AST_RTP_DTLS_HASH_SHA256, /*!< SHA-256 fingerprint hash */
580 AST_RTP_DTLS_HASH_SHA1, /*!< SHA-1 fingerprint hash */
581};
@ AST_RTP_DTLS_HASH_SHA1
Definition: rtp_engine.h:580
@ AST_RTP_DTLS_HASH_SHA256
Definition: rtp_engine.h:579

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

564 {
565 AST_RTP_DTLS_SETUP_ACTIVE, /*!< Endpoint is willing to inititate connections */
566 AST_RTP_DTLS_SETUP_PASSIVE, /*!< Endpoint is willing to accept connections */
567 AST_RTP_DTLS_SETUP_ACTPASS, /*!< Endpoint is willing to both accept and initiate connections */
568 AST_RTP_DTLS_SETUP_HOLDCONN, /*!< Endpoint does not want the connection to be established right now */
569};
@ AST_RTP_DTLS_SETUP_PASSIVE
Definition: rtp_engine.h:566
@ AST_RTP_DTLS_SETUP_HOLDCONN
Definition: rtp_engine.h:568
@ AST_RTP_DTLS_SETUP_ACTPASS
Definition: rtp_engine.h:567
@ AST_RTP_DTLS_SETUP_ACTIVE
Definition: rtp_engine.h:565

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

584 {
585 AST_RTP_DTLS_VERIFY_NONE = 0, /*!< Don't verify anything */
586 AST_RTP_DTLS_VERIFY_FINGERPRINT = (1 << 0), /*!< Verify the fingerprint */
587 AST_RTP_DTLS_VERIFY_CERTIFICATE = (1 << 1), /*!< Verify the certificate */
588};
@ AST_RTP_DTLS_VERIFY_NONE
Definition: rtp_engine.h:585
@ AST_RTP_DTLS_VERIFY_FINGERPRINT
Definition: rtp_engine.h:586
@ AST_RTP_DTLS_VERIFY_CERTIFICATE
Definition: rtp_engine.h:587

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

151 {
152 /*! No DTMF is being carried over the RTP stream */
154 /*! DTMF is being carried out of band using RFC2833 */
156 /*! DTMF is being carried inband over the RTP stream */
158};
@ AST_RTP_DTMF_MODE_RFC2833
Definition: rtp_engine.h:155
@ AST_RTP_DTMF_MODE_INBAND
Definition: rtp_engine.h:157
@ AST_RTP_DTMF_MODE_NONE
Definition: rtp_engine.h:153

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

593 {
594 /*! Per the RFC 0 should not be used, so we treat it as an unsupported extension placeholder */
596 /*! abs-send-time from https://tools.ietf.org/html/draft-alvestrand-rmcat-remb-03 */
598 /*! transport-cc from https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01 */
600 /*! The maximum number of known RTP extensions */
602};
@ AST_RTP_EXTENSION_MAX
Definition: rtp_engine.h:601
@ AST_RTP_EXTENSION_TRANSPORT_WIDE_CC
Definition: rtp_engine.h:599
@ AST_RTP_EXTENSION_ABS_SEND_TIME
Definition: rtp_engine.h:597
@ AST_RTP_EXTENSION_UNSUPPORTED
Definition: rtp_engine.h:595

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

827 {
828 /*! The extension is not negotiated and is not flowing */
830 /*! Send and receive */
832 /*! Send only */
834 /*! Receive only */
836 /*! Negotiated but not sending or receiving */
838};
@ AST_RTP_EXTENSION_DIRECTION_SENDRECV
Definition: rtp_engine.h:831
@ AST_RTP_EXTENSION_DIRECTION_NONE
Definition: rtp_engine.h:829
@ AST_RTP_EXTENSION_DIRECTION_INACTIVE
Definition: rtp_engine.h:837
@ AST_RTP_EXTENSION_DIRECTION_RECVONLY
Definition: rtp_engine.h:835
@ AST_RTP_EXTENSION_DIRECTION_SENDONLY
Definition: rtp_engine.h:833

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

161 {
162 /*! No remote or local bridging is permitted */
164 /*! Move RTP stream to be remote between devices directly */
166 /*! Perform RTP engine level bridging if possible */
168};
@ AST_RTP_GLUE_RESULT_LOCAL
Definition: rtp_engine.h:167
@ AST_RTP_GLUE_RESULT_REMOTE
Definition: rtp_engine.h:165
@ AST_RTP_GLUE_RESULT_FORBID
Definition: rtp_engine.h:163

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

506 {
507 AST_RTP_ICE_CANDIDATE_TYPE_HOST, /*!< ICE host candidate. A host candidate represents the actual local transport address in the host. */
508 AST_RTP_ICE_CANDIDATE_TYPE_SRFLX, /*!< ICE server reflexive candidate, which represents the public mapped address of the local address. */
509 AST_RTP_ICE_CANDIDATE_TYPE_RELAYED, /*!< ICE relayed candidate, which represents the address allocated in TURN server. */
510};
@ AST_RTP_ICE_CANDIDATE_TYPE_RELAYED
Definition: rtp_engine.h:509
@ AST_RTP_ICE_CANDIDATE_TYPE_SRFLX
Definition: rtp_engine.h:508
@ AST_RTP_ICE_CANDIDATE_TYPE_HOST
Definition: rtp_engine.h:507

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

513 {
516};
@ AST_RTP_ICE_COMPONENT_RTCP
Definition: rtp_engine.h:515
@ AST_RTP_ICE_COMPONENT_RTP
Definition: rtp_engine.h:514

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

519 {
522};
@ AST_RTP_ICE_ROLE_CONTROLLING
Definition: rtp_engine.h:521
@ AST_RTP_ICE_ROLE_CONTROLLED
Definition: rtp_engine.h:520

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

283 {
284 /*! RTCP should not be sent/received */
286 /*! RTCP should be sent/received based on standard port rules */
288 /*! RTCP should be sent/received on the same port as RTP */
290};
@ AST_RTP_INSTANCE_RTCP_MUX
Definition: rtp_engine.h:289
@ AST_RTP_INSTANCE_RTCP_STANDARD
Definition: rtp_engine.h:287
@ AST_RTP_INSTANCE_RTCP_DISABLED
Definition: rtp_engine.h:285

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

185 {
186 /*! Retrieve all statistics */
188 /*! Retrieve number of packets transmitted */
190 /*! Retrieve number of packets received */
192 /*! Retrieve ALL statistics relating to packet loss */
194 /*! Retrieve number of packets lost for transmitting */
196 /*! Retrieve number of packets lost for receiving */
198 /*! Retrieve maximum number of packets lost on remote side */
200 /*! Retrieve minimum number of packets lost on remote side */
202 /*! Retrieve average number of packets lost on remote side */
204 /*! Retrieve standard deviation of packets lost on remote side */
206 /*! Retrieve maximum number of packets lost on local side */
208 /*! Retrieve minimum number of packets lost on local side */
210 /*! Retrieve average number of packets lost on local side */
212 /*! Retrieve standard deviation of packets lost on local side */
214 /*! Retrieve ALL statistics relating to jitter */
216 /*! Retrieve jitter on transmitted packets */
218 /*! Retrieve jitter on received packets */
220 /*! Retrieve maximum jitter on remote side */
222 /*! Retrieve minimum jitter on remote side */
224 /*! Retrieve average jitter on remote side */
226 /*! Retrieve standard deviation jitter on remote side */
228 /*! Retrieve maximum jitter on local side */
230 /*! Retrieve minimum jitter on local side */
232 /*! Retrieve average jitter on local side */
234 /*! Retrieve standard deviation jitter on local side */
236 /*! Retrieve ALL statistics relating to round trip time */
238 /*! Retrieve round trip time */
240 /*! Retrieve maximum round trip time */
242 /*! Retrieve minimum round trip time */
244 /*! Retrieve average round trip time */
246 /*! Retrieve standard deviation round trip time */
248 /*! Retrieve local SSRC */
250 /*! Retrieve remote SSRC */
252 /*! Retrieve channel unique ID */
254 /*! Retrieve number of octets transmitted */
256 /*! Retrieve number of octets received */
258
259 /*! Retrieve ALL statistics relating to Media Experience Score */
261 /*! Retrieve MES on transmitted packets */
263 /*! Retrieve MES on received packets */
265 /*! Retrieve maximum MES on remote side */
267 /*! Retrieve minimum MES on remote side */
269 /*! Retrieve average MES on remote side */
271 /*! Retrieve standard deviation MES on remote side */
273 /*! Retrieve maximum MES on local side */
275 /*! Retrieve minimum MES on local side */
277 /*! Retrieve average MES on local side */
279 /*! Retrieve standard deviation MES on local side */
281};
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXRXPLOSS
Definition: rtp_engine.h:207
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVRXPLOSS
Definition: rtp_engine.h:203
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXRXPLOSS
Definition: rtp_engine.h:199
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVMES
Definition: rtp_engine.h:270
@ AST_RTP_INSTANCE_STAT_REMOTE_MINJITTER
Definition: rtp_engine.h:223
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVMES
Definition: rtp_engine.h:278
@ AST_RTP_INSTANCE_STAT_MIN_RTT
Definition: rtp_engine.h:243
@ AST_RTP_INSTANCE_STAT_TXMES
Definition: rtp_engine.h:262
@ AST_RTP_INSTANCE_STAT_CHANNEL_UNIQUEID
Definition: rtp_engine.h:253
@ AST_RTP_INSTANCE_STAT_TXPLOSS
Definition: rtp_engine.h:195
@ AST_RTP_INSTANCE_STAT_MAX_RTT
Definition: rtp_engine.h:241
@ AST_RTP_INSTANCE_STAT_RXPLOSS
Definition: rtp_engine.h:197
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXJITTER
Definition: rtp_engine.h:221
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXJITTER
Definition: rtp_engine.h:229
@ AST_RTP_INSTANCE_STAT_REMOTE_MINMES
Definition: rtp_engine.h:268
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVJITTER
Definition: rtp_engine.h:227
@ AST_RTP_INSTANCE_STAT_REMOTE_MINRXPLOSS
Definition: rtp_engine.h:201
@ AST_RTP_INSTANCE_STAT_LOCAL_MINMES
Definition: rtp_engine.h:276
@ AST_RTP_INSTANCE_STAT_TXOCTETCOUNT
Definition: rtp_engine.h:255
@ AST_RTP_INSTANCE_STAT_RXMES
Definition: rtp_engine.h:264
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVMES
Definition: rtp_engine.h:272
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVRXPLOSS
Definition: rtp_engine.h:211
@ AST_RTP_INSTANCE_STAT_REMOTE_STDEVRXPLOSS
Definition: rtp_engine.h:205
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVRXPLOSS
Definition: rtp_engine.h:213
@ AST_RTP_INSTANCE_STAT_REMOTE_MAXMES
Definition: rtp_engine.h:266
@ AST_RTP_INSTANCE_STAT_TXCOUNT
Definition: rtp_engine.h:189
@ AST_RTP_INSTANCE_STAT_STDEVRTT
Definition: rtp_engine.h:247
@ AST_RTP_INSTANCE_STAT_COMBINED_MES
Definition: rtp_engine.h:260
@ AST_RTP_INSTANCE_STAT_LOCAL_MAXMES
Definition: rtp_engine.h:274
@ AST_RTP_INSTANCE_STAT_RXJITTER
Definition: rtp_engine.h:219
@ AST_RTP_INSTANCE_STAT_LOCAL_MINRXPLOSS
Definition: rtp_engine.h:209
@ AST_RTP_INSTANCE_STAT_LOCAL_SSRC
Definition: rtp_engine.h:249
@ AST_RTP_INSTANCE_STAT_REMOTE_NORMDEVJITTER
Definition: rtp_engine.h:225
@ AST_RTP_INSTANCE_STAT_COMBINED_JITTER
Definition: rtp_engine.h:215
@ AST_RTP_INSTANCE_STAT_TXJITTER
Definition: rtp_engine.h:217
@ AST_RTP_INSTANCE_STAT_LOCAL_MINJITTER
Definition: rtp_engine.h:231
@ AST_RTP_INSTANCE_STAT_COMBINED_LOSS
Definition: rtp_engine.h:193
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVJITTER
Definition: rtp_engine.h:235
@ AST_RTP_INSTANCE_STAT_COMBINED_RTT
Definition: rtp_engine.h:237
@ AST_RTP_INSTANCE_STAT_NORMDEVRTT
Definition: rtp_engine.h:245
@ AST_RTP_INSTANCE_STAT_RTT
Definition: rtp_engine.h:239
@ AST_RTP_INSTANCE_STAT_RXOCTETCOUNT
Definition: rtp_engine.h:257
@ AST_RTP_INSTANCE_STAT_LOCAL_STDEVMES
Definition: rtp_engine.h:280
@ AST_RTP_INSTANCE_STAT_LOCAL_NORMDEVJITTER
Definition: rtp_engine.h:233
@ AST_RTP_INSTANCE_STAT_ALL
Definition: rtp_engine.h:187
@ AST_RTP_INSTANCE_STAT_RXCOUNT
Definition: rtp_engine.h:191
@ AST_RTP_INSTANCE_STAT_REMOTE_SSRC
Definition: rtp_engine.h:251

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

171 {
172 /*! Retrieve quality information */
174 /*! Retrieve quality information about jitter */
176 /*! Retrieve quality information about packet loss */
178 /*! Retrieve quality information about round trip time */
180 /*! Retrieve quality information about Media Experience Score */
182};
@ AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS
Definition: rtp_engine.h:177
@ AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT
Definition: rtp_engine.h:179
@ AST_RTP_INSTANCE_STAT_FIELD_QUALITY
Definition: rtp_engine.h:173
@ AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER
Definition: rtp_engine.h:175
@ AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES
Definition: rtp_engine.h:181

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

145 {
146 /*! Remote side is using non-standard G.726 */
148};
@ AST_RTP_OPT_G726_NONSTANDARD
Definition: rtp_engine.h:147

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

116 {
117 /*! Enable symmetric RTP support */
119 /*! RTP instance will be carrying DTMF (using RFC2833) */
121 /*! Expect unreliable DTMF from remote party */
123 /*! Enable STUN support */
125 /*! Enable RTCP support */
127 /*! Enable Asymmetric RTP Codecs */
129 /*! Enable packet retransmission for received packets */
131 /*! Enable packet retransmission for sent packets */
133 /*! Enable REMB sending and receiving passthrough support */
135
136 /*!
137 * \brief Maximum number of RTP properties supported
138 *
139 * \note THIS MUST BE THE LAST ENTRY IN THIS ENUM.
140 */
142};
@ AST_RTP_PROPERTY_NAT
Definition: rtp_engine.h:118
@ AST_RTP_PROPERTY_MAX
Maximum number of RTP properties supported.
Definition: rtp_engine.h:141
@ AST_RTP_PROPERTY_RETRANS_RECV
Definition: rtp_engine.h:130
@ AST_RTP_PROPERTY_RETRANS_SEND
Definition: rtp_engine.h:132
@ AST_RTP_PROPERTY_RTCP
Definition: rtp_engine.h:126
@ AST_RTP_PROPERTY_ASYMMETRIC_CODEC
Definition: rtp_engine.h:128
@ AST_RTP_PROPERTY_STUN
Definition: rtp_engine.h:124
@ AST_RTP_PROPERTY_DTMF
Definition: rtp_engine.h:120
@ AST_RTP_PROPERTY_DTMF_COMPENSATE
Definition: rtp_engine.h:122
@ AST_RTP_PROPERTY_REMB
Definition: rtp_engine.h:134

Function Documentation

◆ ast_debug_category_dtls_id()

uintmax_t ast_debug_category_dtls_id ( void  )

Definition at line 3771 of file rtp_engine.c.

3772{
3774}
static uintmax_t debug_category_dtls_id
Definition: rtp_engine.c:3769

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.

3779{
3781}
static uintmax_t debug_category_dtls_packet_id
Definition: rtp_engine.c:3776

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.

3786{
3787 return debug_category_ice_id;
3788}
static uintmax_t debug_category_ice_id
Definition: rtp_engine.c:3783

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.

3758{
3760}
static uintmax_t debug_category_rtcp_id
Definition: rtp_engine.c:3755

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.

3765{
3767}
static uintmax_t debug_category_rtcp_packet_id
Definition: rtp_engine.c:3762

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.

3744{
3745 return debug_category_rtp_id;
3746}
static uintmax_t debug_category_rtp_id
Definition: rtp_engine.c:3741

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.

3751{
3753}
static uintmax_t debug_category_rtp_packet_id
Definition: rtp_engine.c:3748

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
codecsCodecs structure to look in
payloadThe payload type format to look for
Returns
Numerical payload type or -1 if unable to find payload in codecs

Example usage:

static struct ao2_container * codecs
Registered codecs.
Definition: codec.c:48
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.

2152{
2153 struct ast_rtp_payload_type *type;
2154 int res = -1;
2155
2156 ast_rwlock_rdlock(&codecs->codecs_lock);
2157 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
2158 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
2159 if (type) {
2160 res = payload;
2161 }
2162 }
2163 ast_rwlock_unlock(&codecs->codecs_lock);
2164
2165 return res;
2166}
static const char type[]
Definition: chan_ooh323.c:109
#define ast_rwlock_rdlock(a)
Definition: lock.h:235
#define ast_rwlock_unlock(a)
Definition: lock.h:234
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition: vector.h:609
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition: vector.h:680

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

1683{
1684 unsigned int framing;
1685
1686 ast_rwlock_rdlock(&codecs->codecs_lock);
1687 framing = codecs->framing;
1688 ast_rwlock_unlock(&codecs->codecs_lock);
1689
1690 return framing;
1691}

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
codecsCodecs structure to look in
payloadNumerical payload to look up
Returns
Payload information.
Return values
NULLif 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);
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.

1549{
1550 struct ast_rtp_payload_type *type = NULL;
1551
1552 if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1553 return NULL;
1554 }
1555
1556 ast_rwlock_rdlock(&codecs->codecs_lock);
1557 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx)) {
1558 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, payload);
1559 ao2_bump(type);
1560 }
1561 ast_rwlock_unlock(&codecs->codecs_lock);
1562
1563 if (!type && payload <= AST_RTP_PT_LAST_STATIC) {
1567 }
1568
1569 return type;
1570}
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
static struct ast_rtp_payload_type * static_RTP_PT[AST_RTP_MAX_PT]
Mapping between Asterisk codecs and rtp payload types.
Definition: rtp_engine.c:273
static ast_rwlock_t static_RTP_PT_lock
Definition: rtp_engine.c:274
#define AST_RTP_MAX_PT
Definition: rtp_engine.h:83
#define AST_RTP_PT_LAST_STATIC
Definition: rtp_engine.h:89

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
codecsCodecs structure to look in
payloadNumerical payload type to look up
Returns
pointer to format structure on success
Return values
NULLon 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.

1651{
1652 struct ast_rtp_payload_type *type;
1653 struct ast_format *format = NULL;
1654
1655 if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1656 return NULL;
1657 }
1658
1659 ast_rwlock_rdlock(&codecs->codecs_lock);
1660 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1661 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
1662 if (type && type->asterisk_format) {
1663 format = ao2_bump(type->format);
1664 }
1665 }
1666 ast_rwlock_unlock(&codecs->codecs_lock);
1667
1668 return format;
1669}
Definition of a media format.
Definition: format.c:43

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
codecsCodecs structure to look in
Returns
Payload type of preferred dtmf format.
Return values
-1if not set.

Example usage:

int payload;
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.

1590{
1591 int pt = -1;
1592 ast_rwlock_rdlock(&codecs->codecs_lock);
1593 pt = codecs->preferred_dtmf_pt;
1594 ast_rwlock_unlock(&codecs->codecs_lock);
1595 return pt;
1596}

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
codecsCodecs structure to look in
Returns
Sample rate of preferred dtmf format.
Return values
-1if not set.

Example usage:

int sample_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.

1599{
1600 int rate = -1;
1601 ast_rwlock_rdlock(&codecs->codecs_lock);
1602 rate = codecs->preferred_dtmf_rate;
1603 ast_rwlock_unlock(&codecs->codecs_lock);
1604 return rate;
1605}

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
codecsCodecs structure to look in
Returns
format information.
Return values
NULLif 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;
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.

1573{
1574 struct ast_format *format;
1575 ast_rwlock_rdlock(&codecs->codecs_lock);
1576 format = ao2_bump(codecs->preferred_format);
1577 ast_rwlock_unlock(&codecs->codecs_lock);
1578 return format;
1579}

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

1530{
1531 enum ast_media_type stream_type = AST_MEDIA_TYPE_UNKNOWN;
1532 int payload;
1533 struct ast_rtp_payload_type *type;
1534
1535 ast_rwlock_rdlock(&codecs->codecs_lock);
1536 for (payload = 0; payload < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++payload) {
1537 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, payload);
1538 if (type && type->asterisk_format) {
1539 stream_type = ast_format_get_type(type->format);
1540 break;
1541 }
1542 }
1543 ast_rwlock_unlock(&codecs->codecs_lock);
1544
1545 return stream_type;
1546}
ast_media_type
Types of media.
Definition: codec.h:30
@ AST_MEDIA_TYPE_UNKNOWN
Definition: codec.h:31
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition: format.c:354

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
codecsCodecs structure to look in
asterisk_formatNon-zero if the given Asterisk format is present
formatAsterisk format to look for
codeThe 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
-1if could not assign.

Example usage:

struct ast_format * ast_format_ulaw
Built-in cached ulaw format.
Definition: format_cache.c:86
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.

2020{
2021 return ast_rtp_codecs_payload_code_sample_rate(codecs, asterisk_format, format, code, 0);
2022}
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

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
codecsCodecs structure to look in
asterisk_formatNon-zero if the given Asterisk format is present
formatAsterisk format to look for
codeThe format to look for
sample_rateNon-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
-1if could not assign.

Example usage:

#define AST_RTP_DTMF
Definition: rtp_engine.h:294
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.

2025{
2026 struct ast_rtp_payload_type *type;
2027 int idx;
2028 int payload = -1;
2029
2031 if (!asterisk_format) {
2032 ast_rwlock_rdlock(&codecs->codecs_lock);
2033 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
2034 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
2035 if (!type) {
2036 continue;
2037 }
2038
2039 if (!type->asterisk_format
2040 && type->primary_mapping
2041 && type->rtp_code == code
2042 && (sample_rate == 0 || type->sample_rate == sample_rate)) {
2043 payload = idx;
2044 break;
2045 }
2046 }
2047 ast_rwlock_unlock(&codecs->codecs_lock);
2048 } else if (format) {
2049 ast_rwlock_rdlock(&codecs->codecs_lock);
2050 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
2051 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
2052 if (!type) {
2053 continue;
2054 }
2055
2056 if (type->asterisk_format
2057 && type->primary_mapping
2059 payload = idx;
2060 break;
2061 }
2062 }
2063 ast_rwlock_unlock(&codecs->codecs_lock);
2064 }
2065
2066 if (payload < 0) {
2068 code, 0, sample_rate);
2069 }
2071
2072 return payload;
2073}
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition: format.c:201
@ AST_FORMAT_CMP_EQUAL
Definition: format.h:36
static int rtp_codecs_assign_payload_code_rx(struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code, int explicit, unsigned int sample_rate)
Definition: rtp_engine.c:1928
unsigned int sample_rate
Definition: rtp_engine.h:318
struct ast_format * format
Definition: rtp_engine.h:306

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
codecsCodecs structure to look in
asterisk_formatNon-zero if the given Asterisk format is present
formatAsterisk format to look for
codeThe format to look for
Returns
Numerical payload type
Return values
-1if not found.

Definition at line 2146 of file rtp_engine.c.

2147{
2148 return ast_rtp_codecs_payload_code_tx_sample_rate(codecs, asterisk_format, format, code, 0);
2149}
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.
Definition: rtp_engine.c:2085

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(), 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
codecsCodecs structure to look in
asterisk_formatNon-zero if the given Asterisk format is present
formatAsterisk format to look for
codeThe format to look for
sample_rateThe sample rate to look for, zero if we don't care
Returns
Numerical payload type
Return values
-1if not found.

Definition at line 2085 of file rtp_engine.c.

2086{
2087 struct ast_rtp_payload_type *type;
2088 int idx;
2089 int payload = -1;
2090
2091 if (!asterisk_format) {
2092 ast_rwlock_rdlock(&codecs->codecs_lock);
2093 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
2094 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
2095 if (!type) {
2096 continue;
2097 }
2098
2099 if (!type->asterisk_format
2100 && type->rtp_code == code
2101 /* Multiple DTMF types share an rtp code but have different sample rates. To ensure we have the right
2102 type we therefore need the sample rate as well as the format and code. Other types have a fixed
2103 sample rate so this is not needed. For those pass in a sample rate of 0 or use ast_rtp_codecs_payload_code_tx. */
2104 && (sample_rate == 0 || type->sample_rate == sample_rate)) {
2105 payload = idx;
2106 break;
2107 }
2108 }
2109 ast_rwlock_unlock(&codecs->codecs_lock);
2110 } else if (format) {
2111 ast_rwlock_rdlock(&codecs->codecs_lock);
2112 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
2113 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
2114 if (!type) {
2115 continue;
2116 }
2117
2118 if (type->asterisk_format
2120 payload = idx;
2121 break;
2122 }
2123 }
2124 ast_rwlock_unlock(&codecs->codecs_lock);
2125 }
2126
2127 if (payload < 0) {
2131
2132 ast_rwlock_rdlock(&codecs->codecs_lock);
2133 if (payload >= 0 && payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)){
2134 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
2135 if (!type || (sample_rate != 0 && type->sample_rate != sample_rate)) {
2136 /* Don't use the type if we can't find it or it doesn't match the supplied sample_rate */
2137 payload = -1;
2138 }
2139 }
2140 ast_rwlock_unlock(&codecs->codecs_lock);
2141 }
2142
2143 return payload;
2144}
static int find_static_payload_type(int asterisk_format, const struct ast_format *format, int code)
Definition: rtp_engine.c:1737

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(), ast_rtp_dtmf_begin(), and bridge_p2p_rtp_write().

◆ 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
codecsCodecs structure to look in
astformatsA capabilities structure to put the Asterisk formats in.
nonastformatsAn 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);
void ast_rtp_codecs_payload_formats(struct ast_rtp_codecs *codecs, struct ast_format_cap *astformats, int *nonastformats)
Retrieve all formats that were found.
Definition: rtp_engine.c:1693
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54

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.

1694{
1695 int idx;
1696
1698 *nonastformats = 0;
1699
1700 ast_rwlock_rdlock(&codecs->codecs_lock);
1701
1702 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
1703 struct ast_rtp_payload_type *type;
1704
1705 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
1706 if (!type) {
1707 continue;
1708 }
1709
1710 if (type->asterisk_format) {
1711 ast_format_cap_append(astformats, type->format, 0);
1712 } else {
1713 *nonastformats |= type->rtp_code;
1714 }
1715 }
1716 if (codecs->framing) {
1717 ast_format_cap_set_framing(astformats, codecs->framing);
1718 }
1719
1720 ast_rwlock_unlock(&codecs->codecs_lock);
1721}
void ast_format_cap_remove_by_type(struct ast_format_cap *cap, enum ast_media_type type)
Remove all formats matching a specific format type.
Definition: format_cap.c:523
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition: format_cap.h:99
void ast_format_cap_set_framing(struct ast_format_cap *cap, unsigned int framing)
Set the global framing.
Definition: format_cap.c:136

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
codecsCodecs structure to operate on
payloadNumerical payload type to look up
formatThe format to replace the existing one
Return values
0success
-1failure
Since
13

Definition at line 1616 of file rtp_engine.c.

1617{
1618 struct ast_rtp_payload_type *type;
1619
1620 if (payload < 0 || payload >= AST_RTP_MAX_PT || !format) {
1621 return -1;
1622 }
1623
1625 if (!type) {
1626 return -1;
1627 }
1628 ao2_ref(format, +1);
1629 type->format = format;
1630 type->asterisk_format = 1;
1631 type->payload = payload;
1632 type->primary_mapping = 1;
1633
1634 ast_rwlock_wrlock(&codecs->codecs_lock);
1636 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1637 ao2_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload));
1638 }
1639 if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, type)) {
1640 ao2_ref(type, -1);
1641 }
1642 } else {
1643 ao2_ref(type, -1);
1644 }
1645 ast_rwlock_unlock(&codecs->codecs_lock);
1646
1647 return 0;
1648}
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ast_rwlock_wrlock(a)
Definition: lock.h:236
struct ast_rtp_payload_type * ast_rtp_engine_alloc_payload_type(void)
Allocation routine for ast_rtp_payload_type.
Definition: rtp_engine.c:325
static int payload_mapping_tx_is_present(const struct ast_rtp_codecs *codecs, const struct ast_rtp_payload_type *to_match)
Definition: rtp_engine.c:1182
#define AST_VECTOR_REPLACE(vec, idx, elem)
Replace an element at a specific position in a vector, growing the vector if needed.
Definition: vector.h:284

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
codecsCodecs structure to manipulate
codeThe payload code
formatAsterisk format
Return values
0Payload was set to the given format
-1Payload was in use or could not be set
Since
15.0.0

Definition at line 2075 of file rtp_engine.c.

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

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
codecsCodecs structure to manipulate
codeThe payload code
formatAsterisk format
sample_rateSample rate of the format, 0 to use the format's default
Return values
0Payload was set to the given format
-1Payload was in use or could not be set
Since
22.0.0

Definition at line 2080 of file rtp_engine.c.

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

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
codecsThe codecs structure that payloads will be cleared from
instanceOptionally the instance that the codecs structure belongs to

Example usage:

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

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

Since
1.8

Definition at line 1019 of file rtp_engine.c.

1020{
1023
1024 if (instance && instance->engine && instance->engine->payload_set) {
1025 int i;
1026
1027 ao2_lock(instance);
1028 for (i = 0; i < AST_RTP_MAX_PT; i++) {
1029 instance->engine->payload_set(instance, i, 0, NULL, 0);
1030 }
1031 ao2_unlock(instance);
1032 }
1033}
#define ao2_unlock(a)
Definition: astobj2.h:729
#define ao2_lock(a)
Definition: astobj2.h:717
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
int ast_rtp_codecs_payloads_initialize(struct ast_rtp_codecs *codecs)
Initialize an RTP codecs structure.
Definition: rtp_engine.c:980
void(* payload_set)(struct ast_rtp_instance *instance, int payload, int asterisk_format, struct ast_format *format, int code)
Definition: rtp_engine.h:694
struct ast_rtp_engine * engine
Definition: rtp_engine.c:190

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
srcThe source codecs structure
destThe destination codecs structure that the values from src will be copied to
instanceOptionally the instance that the dst codecs structure belongs to

Example usage:

ast_rtp_codecs_payloads_copy(&codecs0, &codecs1, NULL);
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.

1274{
1275 int idx;
1276 struct ast_rtp_payload_type *type;
1277
1279
1280 /* Deadlock avoidance because of held write lock. */
1281 while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
1283 sched_yield();
1285 }
1286
1287 /*
1288 * This represents a completely new mapping of what the remote party is
1289 * expecting for payloads, so we clear out the entire tx payload mapping
1290 * vector and replace it.
1291 */
1292 for (idx = 0; idx < AST_VECTOR_SIZE(&dest->payload_mapping_tx); ++idx) {
1293 type = AST_VECTOR_GET(&dest->payload_mapping_tx, idx);
1294 ao2_t_cleanup(type, "destroying ast_rtp_codec tx mapping");
1296 }
1297
1298 rtp_codecs_payloads_copy_rx(src, dest, instance);
1299 rtp_codecs_payloads_copy_tx(src, dest, instance);
1300 dest->framing = src->framing;
1304
1307}
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition: astobj2.h:501
#define ao2_t_cleanup(obj, tag)
Definition: astobj2.h:1935
#define ast_rwlock_tryrdlock(a)
Definition: lock.h:237
static void rtp_codecs_payloads_copy_tx(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
Definition: rtp_engine.c:1242
static void rtp_codecs_payloads_copy_rx(struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance)
Definition: rtp_engine.c:1146
struct ast_rtp_codecs::@277 payload_mapping_tx
int preferred_dtmf_pt
Definition: rtp_engine.h:770
ast_rwlock_t codecs_lock
Definition: rtp_engine.h:758
int preferred_dtmf_rate
Definition: rtp_engine.h:768
struct ast_format * preferred_format
Definition: rtp_engine.h:766
unsigned int framing
Definition: rtp_engine.h:764

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
codecsThe codecs structure to destroy the contents of

Example usage:

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.

997{
998 int idx;
1000
1001 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_rx); ++idx) {
1002 type = AST_VECTOR_GET(&codecs->payload_mapping_rx, idx);
1003 ao2_t_cleanup(type, "destroying ast_rtp_codec rx mapping");
1004 }
1005 AST_VECTOR_FREE(&codecs->payload_mapping_rx);
1006
1007 for (idx = 0; idx < AST_VECTOR_SIZE(&codecs->payload_mapping_tx); ++idx) {
1008 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, idx);
1009 ao2_t_cleanup(type, "destroying ast_rtp_codec tx mapping");
1010 }
1011 AST_VECTOR_FREE(&codecs->payload_mapping_tx);
1012
1013 ao2_t_cleanup(codecs->preferred_format, "destroying ast_rtp_codec preferred format");
1014 codecs->preferred_format = NULL;
1015
1016 ast_rwlock_destroy(&codecs->codecs_lock);
1017}
#define ast_rwlock_destroy(rwlock)
Definition: lock.h:233
#define AST_VECTOR_FREE(vec)
Deallocates this vector.
Definition: vector.h:174

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
codecsThe codecs structure to initialize
Return values
0success
-1failure

Example usage:

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.

981{
982 int res;
983
984 codecs->framing = 0;
985 ast_rwlock_init(&codecs->codecs_lock);
986 res = AST_VECTOR_INIT(&codecs->payload_mapping_rx, AST_RTP_MAX_PT);
987 res |= AST_VECTOR_INIT(&codecs->payload_mapping_tx, AST_RTP_MAX_PT);
988 if (res) {
989 AST_VECTOR_FREE(&codecs->payload_mapping_rx);
990 AST_VECTOR_FREE(&codecs->payload_mapping_tx);
991 }
992
993 return res;
994}
#define ast_rwlock_init(rwlock)
wrapper for rwlock with tracking enabled
Definition: lock.h:224
#define AST_VECTOR_INIT(vec, size)
Initialize a vector.
Definition: vector.h:113

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
codecsThe codecs structure to muck with
instanceOptionally the instance that the codecs structure belongs to
payloadNumerical payload that was seen in the m= SDP line

Example usage:

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.

1357{
1359
1360 if (payload < 0 || payload >= AST_RTP_MAX_PT || payload > AST_RTP_PT_LAST_STATIC) {
1361 return;
1362 }
1363
1367 if (!new_type) {
1368 ast_debug(1, "Don't have a default tx payload type %d format for m type on %p\n",
1369 payload, codecs);
1370 return;
1371 }
1372
1373 ast_debug(1, "Setting tx payload type %d based on m type on %p\n",
1374 payload, codecs);
1375
1376 ast_rwlock_wrlock(&codecs->codecs_lock);
1377
1379 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1380 ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, payload),
1381 "cleaning up replaced tx payload type");
1382 }
1383
1384 if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, new_type)) {
1385 ao2_ref(new_type, -1);
1386 } else if (instance && instance->engine && instance->engine->payload_set) {
1387 ao2_lock(instance);
1388 instance->engine->payload_set(instance, payload, new_type->asterisk_format, new_type->format, new_type->rtp_code);
1389 ao2_unlock(instance);
1390 }
1391 } else {
1392 ao2_ref(new_type, -1);
1393 }
1394
1395 ast_rwlock_unlock(&codecs->codecs_lock);
1396}
#define ast_debug(level,...)
Log a DEBUG message.

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
codecsThe codecs structure to muck with
instanceOptionally the instance that the codecs structure belongs to
payloadNumerical payload that was seen in the a=rtpmap: SDP line
mimetypeThe string mime type that was seen
mimesubtypeThe string mime sub type that was seen
optionsOptional options that may change the behavior of this specific payload
Return values
0success
-1failure, invalid payload numbe
-2failure, unknown mimetype

Example usage:

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.

1485{
1486 return ast_rtp_codecs_payloads_set_rtpmap_type_rate(codecs, instance, payload, mimetype, mimesubtype, options, 0);
1487}
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.
Definition: rtp_engine.c:1398
static struct test_options options

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
codecsRTP structure to modify
instanceOptionally the instance that the codecs structure belongs to
ptPayload type entry to modify
mimetypetop-level MIME type of media stream (typically "audio", "video", "text", etc.)
mimesubtypeMIME subtype of media stream (typically a codec name)
optionsZero or more flags from the ast_rtp_options enum
sample_rateThe 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
0on success
-1if the payload type is out of range
-2if the mimeType/mimeSubtype combination was not found
Since
1.8

Definition at line 1398 of file rtp_engine.c.

1402{
1403 unsigned int idx;
1404 int found = 0;
1405
1406 if (pt < 0 || pt >= AST_RTP_MAX_PT) {
1407 return -1; /* bogus payload type */
1408 }
1409
1411 ast_rwlock_wrlock(&codecs->codecs_lock);
1412
1413 for (idx = 0; idx < mime_types_len; ++idx) {
1414 const struct ast_rtp_mime_type *t = &ast_rtp_mime_types[idx];
1416
1417 if (strcasecmp(mimesubtype, t->subtype)) {
1418 continue;
1419 }
1420
1421 if (strcasecmp(mimetype, t->type)) {
1422 continue;
1423 }
1424
1425 /* if both sample rates have been supplied, and they don't match,
1426 * then this not a match; if one has not been supplied, then the
1427 * rates are not compared */
1428 if (sample_rate && t->sample_rate &&
1429 (sample_rate != t->sample_rate)) {
1430 continue;
1431 }
1432
1433 found = 1;
1434
1436 if (!new_type) {
1437 continue;
1438 }
1439
1440 new_type->asterisk_format = t->payload_type.asterisk_format;
1441 new_type->rtp_code = t->payload_type.rtp_code;
1442 new_type->payload = pt;
1443 new_type->primary_mapping = 1;
1444 new_type->sample_rate = sample_rate;
1449 } else {
1450 new_type->format = t->payload_type.format;
1451 }
1452
1453 if (new_type->format) {
1454 /* SDP parsing automatically increases the reference count */
1455 new_type->format = ast_format_parse_sdp_fmtp(new_type->format, "");
1456 }
1457
1459 if (pt < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1460 ao2_t_cleanup(AST_VECTOR_GET(&codecs->payload_mapping_tx, pt),
1461 "cleaning up replaced tx payload type");
1462 }
1463
1464 if (AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, pt, new_type)) {
1465 ao2_ref(new_type, -1);
1466 } else if (instance && instance->engine && instance->engine->payload_set) {
1467 ao2_lock(instance);
1468 instance->engine->payload_set(instance, pt, new_type->asterisk_format, new_type->format, new_type->rtp_code);
1469 ao2_unlock(instance);
1470 }
1471 } else {
1472 ao2_ref(new_type, -1);
1473 }
1474
1475 break;
1476 }
1477
1478 ast_rwlock_unlock(&codecs->codecs_lock);
1480
1481 return (found ? 0 : -2);
1482}
struct ast_format * ast_format_parse_sdp_fmtp(const struct ast_format *format, const char *attributes)
This function is used to have a media format aware module parse and interpret SDP attribute informati...
Definition: format.c:286
struct ast_format * ast_format_g726
Built-in cached g726 format.
Definition: format_cache.c:111
struct ast_format * ast_format_g726_aal2
Built-in cached g726 aal2 format.
Definition: format_cache.c:116
static struct ast_rtp_mime_type ast_rtp_mime_types[128]
static int mime_types_len
Definition: rtp_engine.c:261
static ast_rwlock_t mime_types_lock
Definition: rtp_engine.c:260
unsigned int sample_rate
Expected sample rate of the /c subtype.
Definition: rtp_engine.c:258
char subtype[64]
The format type.
Definition: rtp_engine.c:256
char type[16]
The media type.
Definition: rtp_engine.c:254
struct ast_rtp_payload_type payload_type
A mapping object between the Asterisk codec and this RTP payload.
Definition: rtp_engine.c:252

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
codecsThe codecs structure to muck with
instanceOptionally the instance that the codecs structure belongs to
payloadNumerical payload to unset

Example usage:

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.

1490{
1491 struct ast_rtp_payload_type *type;
1492
1493 if (payload < 0 || payload >= AST_RTP_MAX_PT) {
1494 return;
1495 }
1496
1497 ast_debug(2, "Unsetting payload %d on %p\n", payload, codecs);
1498
1499 ast_rwlock_wrlock(&codecs->codecs_lock);
1500
1501 if (payload < AST_VECTOR_SIZE(&codecs->payload_mapping_tx)) {
1502 type = AST_VECTOR_GET(&codecs->payload_mapping_tx, payload);
1503 /*
1504 * Remove the preferred format if we are unsetting its container.
1505 *
1506 * There can be empty slots in payload_mapping_tx corresponding to
1507 * dynamic payload types that haven't been seen before so we need
1508 * to check for NULL before attempting to use 'type' in the call to
1509 * ast_format_cmp.
1510 */
1511 if (type) {
1512 if (ast_format_cmp(type->format, codecs->preferred_format) == AST_FORMAT_CMP_EQUAL) {
1513 ao2_replace(codecs->preferred_format, NULL);
1514 }
1515 ao2_ref(type, -1);
1516 AST_VECTOR_REPLACE(&codecs->payload_mapping_tx, payload, NULL);
1517 }
1518 }
1519
1520 if (instance && instance->engine && instance->engine->payload_set) {
1521 ao2_lock(instance);
1522 instance->engine->payload_set(instance, payload, 0, NULL, 0);
1523 ao2_unlock(instance);
1524 }
1525
1526 ast_rwlock_unlock(&codecs->codecs_lock);
1527}

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
srcThe source codecs structure
destThe destination codecs structure that the values from src will be copied to
instanceOptionally the instance that the dst codecs structure belongs to

Definition at line 1309 of file rtp_engine.c.

1310{
1311 int idx;
1312 struct ast_rtp_payload_type *type;
1313
1315 if (src != dest) {
1316 /* Deadlock avoidance because of held write lock. */
1317 while (ast_rwlock_tryrdlock(&src->codecs_lock)) {
1319 sched_yield();
1321 }
1322 }
1323
1324 /* Crossover copy payload type tx mapping to rx mapping. */
1325 for (idx = 0; idx < AST_VECTOR_SIZE(&src->payload_mapping_tx); ++idx) {
1327 if (!type) {
1328 continue;
1329 }
1330
1331 /* All tx mapping elements should have the primary flag set. */
1332 ast_assert(type->primary_mapping);
1333
1334 ast_debug(2, "Crossover copying tx to rx payload mapping %d (%p) from %p to %p\n",
1335 idx, type, src, dest);
1337
1338 if (instance && instance->engine && instance->engine->payload_set) {
1339 ao2_lock(instance);
1340 instance->engine->payload_set(instance, idx, type->asterisk_format, type->format, type->rtp_code);
1341 ao2_unlock(instance);
1342 }
1343 }
1344
1345 dest->framing = src->framing;
1349
1350 if (src != dest) {
1352 }
1354}
static void rtp_codecs_payload_replace_rx(struct ast_rtp_codecs *codecs, int payload, struct ast_rtp_payload_type *new_type)
Definition: rtp_engine.c:1129
#define ast_assert(a)
Definition: utils.h:739

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
codecsCodecs structure to set framing on
framingThe framing value to set on the codecs
Since
13.0.0

Definition at line 1671 of file rtp_engine.c.

1672{
1673 if (!framing) {
1674 return;
1675 }
1676
1677 ast_rwlock_wrlock(&codecs->codecs_lock);
1678 codecs->framing = framing;
1679 ast_rwlock_unlock(&codecs->codecs_lock);
1680}

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
codecsCodecs structure to set the preferred format in
ptPreferred dtmf payload type to set.
ratePreferred 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;
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.
Definition: rtp_engine.c:1607

This sets the preferred dtmf_code and dtmf_rate on the codec.

Definition at line 1607 of file rtp_engine.c.

1608{
1609 ast_rwlock_wrlock(&codecs->codecs_lock);
1610 codecs->preferred_dtmf_pt = pt;
1611 codecs->preferred_dtmf_rate = rate;
1612 ast_rwlock_unlock(&codecs->codecs_lock);
1613 return 0;
1614}

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
codecsCodecs structure to set the preferred format in
formatPreferred 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);
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
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.

1582{
1583 ast_rwlock_wrlock(&codecs->codecs_lock);
1584 ao2_replace(codecs->preferred_format, format);
1585 ast_rwlock_unlock(&codecs->codecs_lock);
1586 return 0;
1587}

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.

4190{
4191 struct ast_json *j_res;
4192 int ret;
4193
4194 j_res = ast_json_object_create();
4195 if (!j_res) {
4196 return NULL;
4197 }
4198
4199 /* set mandatory items */
4200 ret = ast_json_object_set(j_res, "txcount", ast_json_integer_create(stats->txcount));
4201 ret |= ast_json_object_set(j_res, "rxcount", ast_json_integer_create(stats->rxcount));
4202
4203 ret |= ast_json_object_set(j_res, "txploss", ast_json_integer_create(stats->txploss));
4204 ret |= ast_json_object_set(j_res, "rxploss", ast_json_integer_create(stats->rxploss));
4205
4206 ret |= ast_json_object_set(j_res, "local_ssrc", ast_json_integer_create(stats->local_ssrc));
4207 ret |= ast_json_object_set(j_res, "remote_ssrc", ast_json_integer_create(stats->remote_ssrc));
4208
4209 ret |= ast_json_object_set(j_res, "txoctetcount", ast_json_integer_create(stats->txoctetcount));
4210 ret |= ast_json_object_set(j_res, "rxoctetcount", ast_json_integer_create(stats->rxoctetcount));
4211
4212 ret |= ast_json_object_set(j_res, "channel_uniqueid", ast_json_string_create(stats->channel_uniqueid));
4213 if (ret) {
4214 ast_log(LOG_WARNING, "Could not create rtp statistics info. channel: %s\n", stats->channel_uniqueid);
4215 ast_json_unref(j_res);
4216 return NULL;
4217 }
4218
4219 /* set other items */
4220 SET_AST_JSON_OBJ(j_res, "txjitter", ast_json_real_create(stats->txjitter));
4221 SET_AST_JSON_OBJ(j_res, "rxjitter", ast_json_real_create(stats->rxjitter));
4222
4223 SET_AST_JSON_OBJ(j_res, "remote_maxjitter", ast_json_real_create(stats->remote_maxjitter));
4224 SET_AST_JSON_OBJ(j_res, "remote_minjitter", ast_json_real_create(stats->remote_minjitter));
4225 SET_AST_JSON_OBJ(j_res, "remote_normdevjitter", ast_json_real_create(stats->remote_normdevjitter));
4226 SET_AST_JSON_OBJ(j_res, "remote_stdevjitter", ast_json_real_create(stats->remote_stdevjitter));
4227
4228 SET_AST_JSON_OBJ(j_res, "local_maxjitter", ast_json_real_create(stats->local_maxjitter));
4229 SET_AST_JSON_OBJ(j_res, "local_minjitter", ast_json_real_create(stats->local_minjitter));
4230 SET_AST_JSON_OBJ(j_res, "local_normdevjitter", ast_json_real_create(stats->local_normdevjitter));
4231 SET_AST_JSON_OBJ(j_res, "local_stdevjitter", ast_json_real_create(stats->local_stdevjitter));
4232
4233 SET_AST_JSON_OBJ(j_res, "remote_maxrxploss", ast_json_real_create(stats->remote_maxrxploss));
4234 SET_AST_JSON_OBJ(j_res, "remote_minrxploss", ast_json_real_create(stats->remote_minrxploss));
4235 SET_AST_JSON_OBJ(j_res, "remote_normdevrxploss", ast_json_real_create(stats->remote_normdevrxploss));
4236 SET_AST_JSON_OBJ(j_res, "remote_stdevrxploss", ast_json_real_create(stats->remote_stdevrxploss));
4237
4238 SET_AST_JSON_OBJ(j_res, "local_maxrxploss", ast_json_real_create(stats->local_maxrxploss));
4239 SET_AST_JSON_OBJ(j_res, "local_minrxploss", ast_json_real_create(stats->local_minrxploss));
4240 SET_AST_JSON_OBJ(j_res, "local_normdevrxploss", ast_json_real_create(stats->local_normdevrxploss));
4241 SET_AST_JSON_OBJ(j_res, "local_stdevrxploss", ast_json_real_create(stats->local_stdevrxploss));
4242
4243 SET_AST_JSON_OBJ(j_res, "rtt", ast_json_real_create(stats->rtt));
4244 SET_AST_JSON_OBJ(j_res, "maxrtt", ast_json_real_create(stats->maxrtt));
4245 SET_AST_JSON_OBJ(j_res, "minrtt", ast_json_real_create(stats->minrtt));
4246 SET_AST_JSON_OBJ(j_res, "normdevrtt", ast_json_real_create(stats->normdevrtt));
4247 SET_AST_JSON_OBJ(j_res, "stdevrtt", ast_json_real_create(stats->stdevrtt));
4248
4249 SET_AST_JSON_OBJ(j_res, "txmes", ast_json_integer_create(stats->txmes));
4250 SET_AST_JSON_OBJ(j_res, "rxmes", ast_json_integer_create(stats->rxmes));
4251
4252 SET_AST_JSON_OBJ(j_res, "remote_maxmes", ast_json_real_create(stats->remote_maxmes));
4253 SET_AST_JSON_OBJ(j_res, "remote_minmes", ast_json_real_create(stats->remote_minmes));
4254 SET_AST_JSON_OBJ(j_res, "remote_normdevmes", ast_json_real_create(stats->remote_normdevmes));
4255 SET_AST_JSON_OBJ(j_res, "remote_stdevmes", ast_json_real_create(stats->remote_stdevmes));
4256
4257 SET_AST_JSON_OBJ(j_res, "local_maxmes", ast_json_real_create(stats->local_maxmes));
4258 SET_AST_JSON_OBJ(j_res, "local_minmes", ast_json_real_create(stats->local_minmes));
4259 SET_AST_JSON_OBJ(j_res, "local_normdevmes", ast_json_real_create(stats->local_normdevmes));
4260 SET_AST_JSON_OBJ(j_res, "local_stdevmes", ast_json_real_create(stats->local_stdevmes));
4261
4262 return j_res;
4263}
#define ast_log
Definition: astobj2.c:42
#define LOG_WARNING
struct ast_json * ast_json_string_create(const char *value)
Construct a JSON string from value.
Definition: json.c:278
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
struct ast_json * ast_json_object_create(void)
Create a new JSON object.
Definition: json.c:399
struct ast_json * ast_json_integer_create(intmax_t value)
Create a JSON integer.
Definition: json.c:327
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition: json.c:414
struct ast_json * ast_json_real_create(double value)
Create a JSON real number.
Definition: json.c:342
#define SET_AST_JSON_OBJ(target, name, obj)
Set given json object into target with name.
Definition: rtp_engine.c:287
Abstract JSON element (object, array, string, int, ...).
unsigned int remote_ssrc
Definition: rtp_engine.h:454
unsigned int rxcount
Definition: rtp_engine.h:400
unsigned int local_ssrc
Definition: rtp_engine.h:452
unsigned int rxoctetcount
Definition: rtp_engine.h:460
unsigned int rxploss
Definition: rtp_engine.h:424
unsigned int txcount
Definition: rtp_engine.h:398
unsigned int txploss
Definition: rtp_engine.h:422
unsigned int txoctetcount
Definition: rtp_engine.h:458
char channel_uniqueid[MAX_CHANNEL_ID]
Definition: rtp_engine.h:456

References ast_json_integer_create(), ast_json_object_create(), ast_json_object_set(), ast_json_real_create(), ast_json_string_create(), ast_json_unref(), ast_log, ast_rtp_instance_stats::channel_uniqueid, ast_rtp_instance_stats::local_maxjitter, ast_rtp_instance_stats::local_maxmes, ast_rtp_instance_stats::local_maxrxploss, ast_rtp_instance_stats::local_minjitter, ast_rtp_instance_stats::local_minmes, ast_rtp_instance_stats::local_minrxploss, ast_rtp_instance_stats::local_normdevjitter, ast_rtp_instance_stats::local_normdevmes, ast_rtp_instance_stats::local_normdevrxploss, ast_rtp_instance_stats::local_ssrc, ast_rtp_instance_stats::local_stdevjitter, ast_rtp_instance_stats::local_stdevmes, ast_rtp_instance_stats::local_stdevrxploss, LOG_WARNING, ast_rtp_instance_stats::maxrtt, ast_rtp_instance_stats::minrtt, ast_rtp_instance_stats::normdevrtt, NULL, ast_rtp_instance_stats::remote_maxjitter, ast_rtp_instance_stats::remote_maxmes, ast_rtp_instance_stats::remote_maxrxploss, ast_rtp_instance_stats::remote_minjitter, ast_rtp_instance_stats::remote_minmes, ast_rtp_instance_stats::remote_minrxploss, ast_rtp_instance_stats::remote_normdevjitter, ast_rtp_instance_stats::remote_normdevmes, ast_rtp_instance_stats::remote_normdevrxploss, ast_rtp_instance_stats::remote_ssrc, ast_rtp_instance_stats::remote_stdevjitter, ast_rtp_instance_stats::remote_stdevmes, ast_rtp_instance_stats::remote_stdevrxploss, ast_rtp_instance_stats::rtt, ast_rtp_instance_stats::rxcount, ast_rtp_instance_stats::rxjitter, ast_rtp_instance_stats::rxmes, ast_rtp_instance_stats::rxoctetcount, ast_rtp_instance_stats::rxploss, SET_AST_JSON_OBJ, ast_rtp_instance_stats::stdevrtt, ast_rtp_instance_stats::txcount, ast_rtp_instance_stats::txjitter, ast_rtp_instance_stats::txmes, ast_rtp_instance_stats::txoctetcount, and ast_rtp_instance_stats::txploss.

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_cfgsource DTLS configuration structure
dst_cfgdestination DTLS configuration structure

Definition at line 3313 of file rtp_engine.c.

3314{
3315 ast_rtp_dtls_cfg_free(dst_cfg); /* Prevent a double-call leaking memory via ast_strdup */
3316
3317 dst_cfg->enabled = src_cfg->enabled;
3318 dst_cfg->verify = src_cfg->verify;
3319 dst_cfg->rekey = src_cfg->rekey;
3320 dst_cfg->suite = src_cfg->suite;
3321 dst_cfg->hash = src_cfg->hash;
3322 dst_cfg->ephemeral_cert = src_cfg->ephemeral_cert;
3323 dst_cfg->certfile = ast_strdup(src_cfg->certfile);
3324 dst_cfg->pvtfile = ast_strdup(src_cfg->pvtfile);
3325 dst_cfg->cipher = ast_strdup(src_cfg->cipher);
3326 dst_cfg->cafile = ast_strdup(src_cfg->cafile);
3327 dst_cfg->capath = ast_strdup(src_cfg->capath);
3328 dst_cfg->default_setup = src_cfg->default_setup;
3329}
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
void ast_rtp_dtls_cfg_free(struct ast_rtp_dtls_cfg *dtls_cfg)
Free contents of a DTLS configuration structure.
Definition: rtp_engine.c:3331
enum ast_rtp_dtls_setup default_setup
Definition: rtp_engine.h:608
enum ast_rtp_dtls_verify verify
Definition: rtp_engine.h:611
unsigned int rekey
Definition: rtp_engine.h:607
enum ast_rtp_dtls_hash hash
Definition: rtp_engine.h:610
unsigned int enabled
Definition: rtp_engine.h:606
unsigned int ephemeral_cert
Definition: rtp_engine.h:617
enum ast_srtp_suite suite
Definition: rtp_engine.h:609

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_cfga DTLS configuration structure

Definition at line 3331 of file rtp_engine.c.

3332{
3333 ast_free(dtls_cfg->certfile);
3334 dtls_cfg->certfile = NULL;
3335 ast_free(dtls_cfg->pvtfile);
3336 dtls_cfg->pvtfile = NULL;
3337 ast_free(dtls_cfg->cipher);
3338 dtls_cfg->cipher = NULL;
3339 ast_free(dtls_cfg->cafile);
3340 dtls_cfg->cafile = NULL;
3341 ast_free(dtls_cfg->capath);
3342 dtls_cfg->capath = NULL;
3343}
#define ast_free(a)
Definition: astmm.h:180

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_cfga DTLS configuration structure
namename of the configuration option
valuevalue of the configuration option
Return values
0if handled
-1if not handled

Definition at line 3220 of file rtp_engine.c.

3221{
3222 if (!strcasecmp(name, "dtlsenable")) {
3223 dtls_cfg->enabled = ast_true(value) ? 1 : 0;
3224 } else if (!strcasecmp(name, "dtlsverify")) {
3225 if (!strcasecmp(value, "yes")) {
3227 } else if (!strcasecmp(value, "fingerprint")) {
3229 } else if (!strcasecmp(value, "certificate")) {
3231 } else if (!strcasecmp(value, "no")) {
3232 dtls_cfg->verify = AST_RTP_DTLS_VERIFY_NONE;
3233 } else {
3234 return -1;
3235 }
3236 } else if (!strcasecmp(name, "dtlsrekey")) {
3237 if (sscanf(value, "%30u", &dtls_cfg->rekey) != 1) {
3238 return -1;
3239 }
3240 } else if (!strcasecmp(name, "dtlsautogeneratecert")) {
3241 dtls_cfg->ephemeral_cert = ast_true(value) ? 1 : 0;
3242 } else if (!strcasecmp(name, "dtlscertfile")) {
3244 ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
3245 return -1;
3246 }
3247 ast_free(dtls_cfg->certfile);
3248 dtls_cfg->certfile = ast_strdup(value);
3249 } else if (!strcasecmp(name, "dtlsprivatekey")) {
3251 ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
3252 return -1;
3253 }
3254 ast_free(dtls_cfg->pvtfile);
3255 dtls_cfg->pvtfile = ast_strdup(value);
3256 } else if (!strcasecmp(name, "dtlscipher")) {
3257 ast_free(dtls_cfg->cipher);
3258 dtls_cfg->cipher = ast_strdup(value);
3259 } else if (!strcasecmp(name, "dtlscafile")) {
3261 ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
3262 return -1;
3263 }
3264 ast_free(dtls_cfg->cafile);
3265 dtls_cfg->cafile = ast_strdup(value);
3266 } else if (!strcasecmp(name, "dtlscapath") || !strcasecmp(name, "dtlscadir")) {
3268 ast_log(LOG_ERROR, "%s file %s does not exist or is not readable\n", name, value);
3269 return -1;
3270 }
3271 ast_free(dtls_cfg->capath);
3272 dtls_cfg->capath = ast_strdup(value);
3273 } else if (!strcasecmp(name, "dtlssetup")) {
3274 if (!strcasecmp(value, "active")) {
3276 } else if (!strcasecmp(value, "passive")) {
3278 } else if (!strcasecmp(value, "actpass")) {
3280 }
3281 } else if (!strcasecmp(name, "dtlsfingerprint")) {
3282 if (!strcasecmp(value, "sha-256")) {
3283 dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA256;
3284 } else if (!strcasecmp(value, "sha-1")) {
3285 dtls_cfg->hash = AST_RTP_DTLS_HASH_SHA1;
3286 }
3287 } else {
3288 return -1;
3289 }
3290
3291 return 0;
3292}
static const char name[]
Definition: format_mp3.c:68
#define LOG_ERROR
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition: utils.c:2199
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
int value
Definition: syslog.c:37
int ast_file_is_readable(const char *filename)
Test that a file exists and is readable by the effective user.
Definition: utils.c:3107

References ast_file_is_readable(), ast_free, ast_log, AST_RTP_DTLS_HASH_SHA1, AST_RTP_DTLS_HASH_SHA256, AST_RTP_DTLS_SETUP_ACTIVE, AST_RTP_DTLS_SETUP_ACTPASS, AST_RTP_DTLS_SETUP_PASSIVE, AST_RTP_DTLS_VERIFY_CERTIFICATE, AST_RTP_DTLS_VERIFY_FINGERPRINT, AST_RTP_DTLS_VERIFY_NONE, ast_strdup, ast_strlen_zero(), ast_true(), 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, LOG_ERROR, name, ast_rtp_dtls_cfg::pvtfile, ast_rtp_dtls_cfg::rekey, value, and ast_rtp_dtls_cfg::verify.

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_cfga DTLS configuration structure
Return values
0if valid
-1if invalid

Definition at line 3294 of file rtp_engine.c.

3295{
3296 if (dtls_cfg->ephemeral_cert) {
3297 if (!ast_strlen_zero(dtls_cfg->certfile)) {
3298 ast_log(LOG_ERROR, "You cannot request automatically generated certificates"
3299 " (dtls_auto_generate_cert) and also specify a certificate file"
3300 " (dtls_cert_file) at the same time\n");
3301 return -1;
3302 } else if (!ast_strlen_zero(dtls_cfg->pvtfile)
3303 || !ast_strlen_zero(dtls_cfg->cafile)
3304 || !ast_strlen_zero(dtls_cfg->capath)) {
3305 ast_log(LOG_NOTICE, "dtls_pvt_file, dtls_cafile, and dtls_ca_path are"
3306 " ignored when dtls_auto_generate_cert is enabled\n");
3307 }
3308 }
3309
3310 return 0;
3311}
#define LOG_NOTICE

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

326{
327 return rtp_payload_type_alloc(NULL, 0, 0, 0, 0);
328}
static struct ast_rtp_payload_type * rtp_payload_type_alloc(struct ast_format *format, int payload, int rtp_code, int primary_mapping, unsigned int sample_rate)
Definition: rtp_engine.c:305

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.

3430{
3431 char *codec_name = ast_strdupa(ast_format_get_codec_name(format));
3432
3433 codec_name = ast_str_to_upper(codec_name);
3434
3435 set_next_mime_type(format,
3436 0,
3438 codec_name,
3440 add_static_payload(-1, format, 0);
3441
3442 return 0;
3443}
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
const char * ast_codec_media_type2str(enum ast_media_type type)
Conversion function to take a media type and turn it into a string.
Definition: codec.c:348
unsigned int ast_format_get_sample_rate(const struct ast_format *format)
Get the sample rate of a media format.
Definition: format.c:379
const char * ast_format_get_codec_name(const struct ast_format *format)
Get the codec name associated with a format.
Definition: format.c:339
static void add_static_payload(int payload, struct ast_format *format, int rtp_code)
Definition: rtp_engine.c:3383
static void set_next_mime_type(struct ast_format *format, int rtp_code, const char *type, const char *subtype, unsigned int sample_rate)
Definition: rtp_engine.c:3355
static force_inline char * ast_str_to_upper(char *str)
Convert a string to all upper-case.
Definition: strings.h:1342

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
engineStructure of the RTP engine to register
moduleModule that the RTP engine is part of
Return values
0success
-1failure

Example usage:

ast_rtp_engine_register2(&example_rtp_engine, NULL);
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.

331{
332 struct ast_rtp_engine *current_engine;
333
334 /* Perform a sanity check on the engine structure to make sure it has the basics */
335 if (ast_strlen_zero(engine->name) || !engine->new || !engine->destroy || !engine->write || !engine->read) {
336 ast_log(LOG_WARNING, "RTP Engine '%s' failed sanity check so it was not registered.\n", !ast_strlen_zero(engine->name) ? engine->name : "Unknown");
337 return -1;
338 }
339
340 /* Link owner module to the RTP engine for reference counting purposes */
341 engine->mod = module;
342
344
345 /* Ensure that no two modules with the same name are registered at the same time */
346 AST_RWLIST_TRAVERSE(&engines, current_engine, entry) {
347 if (!strcmp(current_engine->name, engine->name)) {
348 ast_log(LOG_WARNING, "An RTP engine with the name '%s' has already been registered.\n", engine->name);
350 return -1;
351 }
352 }
353
354 /* The engine survived our critique. Off to the list it goes to be used */
356
358
359 ast_verb(5, "Registered RTP engine '%s'\n", engine->name);
360
361 return 0;
362}
#define ast_verb(level,...)
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:494
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:741
int(* write)(struct ast_rtp_instance *instance, struct ast_frame *frame)
Definition: rtp_engine.h:675
int(* destroy)(struct ast_rtp_instance *instance)
Definition: rtp_engine.h:673
struct ast_module * mod
Definition: rtp_engine.h:669
int(* new)(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *sa, void *data)
Definition: rtp_engine.h:671
const char * name
Definition: rtp_engine.h:667
struct ast_frame *(* read)(struct ast_rtp_instance *instance, int rtcp)
Definition: rtp_engine.h:712
Definition: search.h:40

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.

2911{
2912 if (res_srtp || res_srtp_policy) {
2913 return -1;
2914 }
2915 if (!srtp_res || !policy_res) {
2916 return -1;
2917 }
2918
2921
2922 return 0;
2923}
static struct ast_srtp_res srtp_res
Definition: res_srtp.c:103
static struct ast_srtp_policy_res policy_res
Definition: res_srtp.c:115
struct ast_srtp_res * res_srtp
Definition: rtp_engine.c:176
struct ast_srtp_policy_res * res_srtp_policy
Definition: rtp_engine.c:177

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.

2932{
2933 return res_srtp && res_srtp_policy;
2934}

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.

3446{
3447 int x;
3448 int y = 0;
3449
3451 /* remove everything pertaining to this format id from the lists */
3452 for (x = 0; x < AST_RTP_MAX_PT; x++) {
3453 if (static_RTP_PT[x]
3454 && ast_format_cmp(static_RTP_PT[x]->format, format) == AST_FORMAT_CMP_EQUAL) {
3455 ao2_ref(static_RTP_PT[x], -1);
3456 static_RTP_PT[x] = NULL;
3457 }
3458 }
3460
3462 /* rebuild the list skipping the items matching this id */
3463 for (x = 0; x < mime_types_len; x++) {
3464 if (ast_format_cmp(ast_rtp_mime_types[x].payload_type.format, format) == AST_FORMAT_CMP_EQUAL) {
3466 continue;
3467 }
3468 if (x != y) {
3470 }
3471 y++;
3472 }
3473 mime_types_len = y;
3475 return 0;
3476}
static void rtp_engine_mime_type_cleanup(int i)
Definition: rtp_engine.c:3349

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
engineStructure of the RTP engine to unregister
Return values
0success
-1failure

Example usage:

ast_rtp_engine_unregister(&example_rtp_engine);
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.

365{
366 struct ast_rtp_engine *current_engine = NULL;
367
369
370 if ((current_engine = AST_RWLIST_REMOVE(&engines, engine, entry))) {
371 ast_verb(5, "Unregistered RTP engine '%s'\n", engine->name);
372 }
373
375
376 return current_engine ? 0 : -1;
377}
#define AST_RWLIST_REMOVE
Definition: linkedlists.h:885

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.

2926{
2927 res_srtp = NULL;
2929}

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
formatThe media format
Returns
The sample rate

Definition at line 4276 of file rtp_engine.c.

4277{
4278 /* For those wondering: due to a fluke in RFC publication, G.722 is advertised
4279 * as having a sample rate of 8kHz, while implementations must know that its
4280 * real rate is 16kHz. Seriously.
4281 */
4282 return (ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL) ? 8000 : (int)ast_format_get_sample_rate(format);
4283}
struct ast_format * ast_format_g722
Built-in cached g722 format.
Definition: format_cache.c:106

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
glueThe glue to register
moduleModule that the RTP glue is part of
Return values
0success
-1failure

Example usage:

ast_rtp_glue_register2(&example_rtp_glue, NULL);
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.

380{
381 struct ast_rtp_glue *current_glue = NULL;
382
383 if (ast_strlen_zero(glue->type)) {
384 return -1;
385 }
386
387 glue->mod = module;
388
390
391 AST_RWLIST_TRAVERSE(&glues, current_glue, entry) {
392 if (!strcasecmp(current_glue->type, glue->type)) {
393 ast_log(LOG_WARNING, "RTP glue with the name '%s' has already been registered.\n", glue->type);
395 return -1;
396 }
397 }
398
400
402
403 ast_verb(5, "Registered RTP glue '%s'\n", glue->type);
404
405 return 0;
406}
const char * type
Definition: rtp_engine.h:780
struct ast_module * mod
Definition: rtp_engine.h:782

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
glueThe glue to unregister
Return values
0success
-1failure

Example usage:

ast_rtp_glue_unregister(&example_rtp_glue);
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.

409{
410 struct ast_rtp_glue *current_glue = NULL;
411
413
414 if ((current_glue = AST_RWLIST_REMOVE(&glues, glue, entry))) {
415 ast_verb(5, "Unregistered RTP glue '%s'\n", glue->type);
416 }
417
419
420 return current_glue ? 0 : -1;
421}

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
instanceThe RTP instance
Return values
0success
-1failure

Example usage:

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.

2848{
2849 int res;
2850
2851 if (instance->engine->activate) {
2852 ao2_lock(instance);
2853 res = instance->engine->activate(instance);
2854 ao2_unlock(instance);
2855 } else {
2856 res = 0;
2857 }
2858 return res;
2859}
int(* activate)(struct ast_rtp_instance *instance)
Definition: rtp_engine.h:724

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
instancethe RTP instance
remote_policythe remote endpoint's policy
local_policyour policy for this RTP instance's remote endpoint
rtcp1 for dedicated RTCP policies
Return values
0Success
non-zeroFailure
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.

2937{
2938 int res = 0;
2939 struct ast_srtp **srtp;
2940
2941 if (!res_srtp) {
2942 return -1;
2943 }
2944
2945 ao2_lock(instance);
2946
2947 srtp = rtcp ? &instance->rtcp_srtp : &instance->srtp;
2948
2949 if (!*srtp) {
2950 res = res_srtp->create(srtp, instance, remote_policy);
2951 } else if (remote_policy) {
2952 res = res_srtp->replace(srtp, instance, remote_policy);
2953 }
2954 if (!res) {
2955 res = res_srtp->add_stream(*srtp, local_policy);
2956 }
2957
2958 ao2_unlock(instance);
2959
2960 return res;
2961}
struct ast_srtp * rtcp_srtp
Definition: rtp_engine.c:216
struct ast_srtp * srtp
Definition: rtp_engine.c:214
int(* replace)(struct ast_srtp **srtp, struct ast_rtp_instance *rtp, struct ast_srtp_policy *policy)
Definition: res_srtp.h:38
int(* add_stream)(struct ast_srtp *srtp, struct ast_srtp_policy *policy)
Definition: res_srtp.h:42
int(* create)(struct ast_srtp **srtp, struct ast_rtp_instance *rtp, struct ast_srtp_policy *policy)
Definition: res_srtp.h:36

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
instanceThe RTP instance
to_endpointFormats being sent/received towards the endpoint
to_asteriskFormats being sent/received towards Asterisk
resultcapabilities structure to store and return supported formats in.

Example usage:

ast_rtp_instance_available_formats(instance, to_capabilities, from_capabilities, result_capabilities);
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.

2834{
2835 if (instance->engine->available_formats) {
2836 ao2_lock(instance);
2837 instance->engine->available_formats(instance, to_endpoint, to_asterisk, result);
2838 ao2_unlock(instance);
2840 return;
2841 }
2842 }
2843
2844 ast_translate_available_formats(to_endpoint, to_asterisk, result);
2845}
static PGresult * result
Definition: cel_pgsql.c:84
size_t ast_format_cap_count(const struct ast_format_cap *cap)
Get the number of formats present within the capabilities structure.
Definition: format_cap.c:395
void(* available_formats)(struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result)
Definition: rtp_engine.h:728
void ast_translate_available_formats(struct ast_format_cap *dest, struct ast_format_cap *src, struct ast_format_cap *result)
Find available formats.
Definition: translate.c:1616

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
childThe child RTP instance
parentThe parent RTP instance the child should be bundled with
Return values
0success
-1failure

Definition at line 4037 of file rtp_engine.c.

4038{
4039 int res = -1;
4040
4041 if (parent && (child->engine != parent->engine)) {
4042 return -1;
4043 }
4044
4045 ao2_lock(child);
4046 if (child->engine->bundle) {
4047 res = child->engine->bundle(child, parent);
4048 }
4049 ao2_unlock(child);
4050
4051 return res;
4052}
int(* bundle)(struct ast_rtp_instance *child, struct ast_rtp_instance *parent)
Definition: rtp_engine.h:736

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
instanceInstance that the new media source is feeding into

Example usage:

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.

2337{
2338 if (instance->engine->change_source) {
2339 ao2_lock(instance);
2340 instance->engine->change_source(instance);
2341 ao2_unlock(instance);
2342 }
2343}
void(* change_source)(struct ast_rtp_instance *instance)
Definition: rtp_engine.h:686

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
instanceThe RTP instance to destroy
Return values
0success
-1failure

Example usage:

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.

459{
460 if (!instance) {
461 return 0;
462 }
464 char buffer[4][512];
465 ast_debug_rtp(1, "%s:\n"
466 " RTT: %s\n"
467 " Loss: %s\n"
468 " Jitter: %s\n"
469 " MES: %s\n",
470 instance->channel_uniqueid,
472 buffer[0], sizeof(buffer[0])),
474 buffer[1], sizeof(buffer[1])),
476 buffer[2], sizeof(buffer[2])),
478 buffer[3], sizeof(buffer[3]))
479 );
480 }
481
482 ao2_cleanup(instance);
483
484 return 0;
485}
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
#define ast_debug_rtp(sublevel,...)
Log debug level RTP information.
Definition: rtp_engine.h:3099
#define ast_debug_rtp_is_allowed
Definition: rtp_engine.h:3103
char channel_uniqueid[AST_MAX_UNIQUEID]
Definition: rtp_engine.c:218

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
instanceThe RTP instance to send the DTMF on
digitWhat DTMF digit to send
Return values
0success
-1failure

Example usage:

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.

2258{
2259 int res;
2260
2261 if (instance->engine->dtmf_begin) {
2262 ao2_lock(instance);
2263 res = instance->engine->dtmf_begin(instance, digit);
2264 ao2_unlock(instance);
2265 } else {
2266 res = -1;
2267 }
2268 return res;
2269}
char digit
int(* dtmf_begin)(struct ast_rtp_instance *instance, char digit)
Definition: rtp_engine.h:679

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
instanceThe RTP instance to stop the DTMF on
digitWhat DTMF digit to stop
Return values
0success
-1failure

Example usage:

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.

2272{
2273 int res;
2274
2275 if (instance->engine->dtmf_end) {
2276 ao2_lock(instance);
2277 res = instance->engine->dtmf_end(instance, digit);
2278 ao2_unlock(instance);
2279 } else {
2280 res = -1;
2281 }
2282 return res;
2283}
int(* dtmf_end)(struct ast_rtp_instance *instance, char digit)
Definition: rtp_engine.h:681

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.

2286{
2287 int res;
2288
2289 if (instance->engine->dtmf_end_with_duration) {
2290 ao2_lock(instance);
2291 res = instance->engine->dtmf_end_with_duration(instance, digit, duration);
2292 ao2_unlock(instance);
2293 } else {
2294 res = -1;
2295 }
2296 return res;
2297}
int(* dtmf_end_with_duration)(struct ast_rtp_instance *instance, char digit, unsigned int duration)
Definition: rtp_engine.h:682

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
instanceThe RTP instance to get the DTMF mode of
Returns
DTMF mode

Example usage:

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.

2314{
2315 int res;
2316
2317 if (instance->engine->dtmf_mode_get) {
2318 ao2_lock(instance);
2319 res = instance->engine->dtmf_mode_get(instance);
2320 ao2_unlock(instance);
2321 } else {
2322 res = 0;
2323 }
2324 return res;
2325}
enum ast_rtp_dtmf_mode(* dtmf_mode_get)(struct ast_rtp_instance *instance)
Definition: rtp_engine.h:700

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
instancethe RTP instance to set DTMF mode on
dtmf_modeThe DTMF mode that is in use
Return values
0success
-1failure

Example usage:

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.

2300{
2301 int res;
2302
2303 if (instance->engine->dtmf_mode_set) {
2304 ao2_lock(instance);
2305 res = instance->engine->dtmf_mode_set(instance, dtmf_mode);
2306 ao2_unlock(instance);
2307 } else {
2308 res = -1;
2309 }
2310 return res;
2311}
int(* dtmf_mode_set)(struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode)
Definition: rtp_engine.h:698

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
c0First channel part of the bridge
c1Second channel part of the bridge
Return values
0success
-1failure
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.

2514{
2515 struct ast_rtp_instance *instance0 = NULL, *instance1 = NULL,
2516 *vinstance0 = NULL, *vinstance1 = NULL,
2517 *tinstance0 = NULL, *tinstance1 = NULL;
2518 struct ast_rtp_glue *glue0, *glue1;
2519 enum ast_rtp_glue_result audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID, video_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
2520 enum ast_rtp_glue_result audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID, video_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
2523
2524 /* If there is no second channel just immediately bail out, we are of no use in that scenario */
2525 if (!c1 || !cap1 || !cap0) {
2526 ao2_cleanup(cap0);
2527 ao2_cleanup(cap1);
2528 return -1;
2529 }
2530
2531 /* Lock both channels so we can look for the glue that binds them together */
2532 ast_channel_lock_both(c0, c1);
2533
2534 /* Grab glue that binds each channel to something using the RTP engine */
2536 ast_log(LOG_WARNING, "Can't find native functions for channel '%s'\n", glue0 ? ast_channel_name(c1) : ast_channel_name(c0));
2537 goto done;
2538 }
2539
2540 audio_glue0_res = glue0->get_rtp_info(c0, &instance0);
2541 video_glue0_res = glue0->get_vrtp_info ? glue0->get_vrtp_info(c0, &vinstance0) : AST_RTP_GLUE_RESULT_FORBID;
2542
2543 audio_glue1_res = glue1->get_rtp_info(c1, &instance1);
2544 video_glue1_res = glue1->get_vrtp_info ? glue1->get_vrtp_info(c1, &vinstance1) : AST_RTP_GLUE_RESULT_FORBID;
2545
2546 /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
2547 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)) {
2548 audio_glue0_res = AST_RTP_GLUE_RESULT_FORBID;
2549 }
2550 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)) {
2551 audio_glue1_res = AST_RTP_GLUE_RESULT_FORBID;
2552 }
2553 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) {
2554 glue0->get_codec(c0, cap0);
2555 }
2556 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) {
2557 glue1->get_codec(c1, cap1);
2558 }
2559
2560 /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
2561 if (audio_glue0_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue1_res != AST_RTP_GLUE_RESULT_REMOTE) {
2562 goto done;
2563 }
2564
2565 /* Make sure we have matching codecs */
2566 if (!ast_format_cap_iscompatible(cap0, cap1)) {
2567 goto done;
2568 }
2569
2570 /* Bridge media early */
2571 if (glue0->update_peer(c0, instance1, vinstance1, tinstance1, cap1, 0)) {
2572 ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
2573 }
2574
2575done:
2578
2579 ao2_cleanup(cap0);
2580 ao2_cleanup(cap1);
2581
2582 unref_instance_cond(&instance0);
2583 unref_instance_cond(&instance1);
2584 unref_instance_cond(&vinstance0);
2585 unref_instance_cond(&vinstance1);
2586 unref_instance_cond(&tinstance0);
2587 unref_instance_cond(&tinstance1);
2588
2589 ast_debug(1, "Setting early bridge SDP of '%s' with that of '%s'\n", ast_channel_name(c0), c1 ? ast_channel_name(c1) : "<unspecified>");
2590
2591 return 0;
2592}
const char * ast_channel_name(const struct ast_channel *chan)
#define ast_channel_lock_both(chan1, chan2)
Lock two channels.
Definition: channel.h:2975
const struct ast_channel_tech * ast_channel_tech(const struct ast_channel *chan)
#define ast_channel_unlock(chan)
Definition: channel.h:2969
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38
int ast_format_cap_iscompatible(const struct ast_format_cap *cap1, const struct ast_format_cap *cap2)
Determine if any joint capabilities exist between two capabilities structures.
Definition: format_cap.c:653
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
static void unref_instance_cond(struct ast_rtp_instance **instance)
Conditionally unref an rtp instance.
Definition: rtp_engine.c:2402
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
ast_rtp_glue_result
Definition: rtp_engine.h:161
enum ast_rtp_glue_result(* get_rtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance)
Callback for retrieving the RTP instance carrying audio.
Definition: rtp_engine.h:787
void(* get_codec)(struct ast_channel *chan, struct ast_format_cap *result_cap)
Callback for retrieving codecs that the channel can do. Result returned in result_cap.
Definition: rtp_engine.h:819
int(* update_peer)(struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_rtp_instance *vinstance, struct ast_rtp_instance *tinstance, const struct ast_format_cap *cap, int nat_active)
Definition: rtp_engine.h:814
enum ast_rtp_glue_result(* get_vrtp_info)(struct ast_channel *chan, struct ast_rtp_instance **instance)
Callback for retrieving the RTP instance carrying video.
Definition: rtp_engine.h:799
int done
Definition: test_amihooks.c:48

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_dstDestination channel to copy to
c_srcSource channel to copy from
Since
1.8

Definition at line 2427 of file rtp_engine.c.

2428{
2429 struct ast_rtp_instance *instance_dst = NULL, *instance_src = NULL,
2430 *vinstance_dst = NULL, *vinstance_src = NULL,
2431 *tinstance_dst = NULL, *tinstance_src = NULL;
2432 struct ast_rtp_glue *glue_dst, *glue_src;
2433 enum ast_rtp_glue_result audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
2434 enum ast_rtp_glue_result audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID, video_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
2437
2438 /* Lock both channels so we can look for the glue that binds them together */
2439 ast_channel_lock_both(c_dst, c_src);
2440
2441 if (!cap_src || !cap_dst) {
2442 goto done;
2443 }
2444
2445 /* Grab glue that binds each channel to something using the RTP engine */
2446 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))) {
2447 ast_debug(1, "Can't find native functions for channel '%s'\n", glue_dst ? ast_channel_name(c_src) : ast_channel_name(c_dst));
2448 goto done;
2449 }
2450
2451 audio_glue_dst_res = glue_dst->get_rtp_info(c_dst, &instance_dst);
2452 video_glue_dst_res = glue_dst->get_vrtp_info ? glue_dst->get_vrtp_info(c_dst, &vinstance_dst) : AST_RTP_GLUE_RESULT_FORBID;
2453
2454 audio_glue_src_res = glue_src->get_rtp_info(c_src, &instance_src);
2455 video_glue_src_res = glue_src->get_vrtp_info ? glue_src->get_vrtp_info(c_src, &vinstance_src) : AST_RTP_GLUE_RESULT_FORBID;
2456
2457 /* If we are carrying video, and both sides are not going to remotely bridge... fail the native bridge */
2458 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)) {
2459 audio_glue_dst_res = AST_RTP_GLUE_RESULT_FORBID;
2460 }
2461 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)) {
2462 audio_glue_src_res = AST_RTP_GLUE_RESULT_FORBID;
2463 }
2464 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) {
2465 glue_dst->get_codec(c_dst, cap_dst);
2466 }
2467 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) {
2468 glue_src->get_codec(c_src, cap_src);
2469 }
2470
2471 /* If any sort of bridge is forbidden just completely bail out and go back to generic bridging */
2472 if (audio_glue_dst_res != AST_RTP_GLUE_RESULT_REMOTE || audio_glue_src_res != AST_RTP_GLUE_RESULT_REMOTE) {
2473 goto done;
2474 }
2475
2476 /* Make sure we have matching codecs */
2477 if (!ast_format_cap_iscompatible(cap_dst, cap_src)) {
2478 goto done;
2479 }
2480
2481 ast_rtp_codecs_payloads_xover(&instance_src->codecs, &instance_dst->codecs, instance_dst);
2482
2483 if (vinstance_dst && vinstance_src) {
2484 ast_rtp_codecs_payloads_xover(&vinstance_src->codecs, &vinstance_dst->codecs, vinstance_dst);
2485 }
2486 if (tinstance_dst && tinstance_src) {
2487 ast_rtp_codecs_payloads_xover(&tinstance_src->codecs, &tinstance_dst->codecs, tinstance_dst);
2488 }
2489
2490 if (glue_dst->update_peer(c_dst, instance_src, vinstance_src, tinstance_src, cap_src, 0)) {
2491 ast_log(LOG_WARNING, "Channel '%s' failed to setup early bridge to '%s'\n",
2492 ast_channel_name(c_dst), ast_channel_name(c_src));
2493 } else {
2494 ast_debug(1, "Seeded SDP of '%s' with that of '%s'\n",
2495 ast_channel_name(c_dst), ast_channel_name(c_src));
2496 }
2497
2498done:
2499 ast_channel_unlock(c_dst);
2500 ast_channel_unlock(c_src);
2501
2502 ao2_cleanup(cap_dst);
2503 ao2_cleanup(cap_src);
2504
2505 unref_instance_cond(&instance_dst);
2506 unref_instance_cond(&instance_src);
2507 unref_instance_cond(&vinstance_dst);
2508 unref_instance_cond(&vinstance_src);
2509 unref_instance_cond(&tinstance_dst);
2510 unref_instance_cond(&tinstance_src);
2511}
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.
Definition: rtp_engine.c:1309
struct ast_rtp_codecs codecs
Definition: rtp_engine.c:204

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
instanceThe RTP instance to clear negotiated extension information on

Definition at line 884 of file rtp_engine.c.

885{
886 static const struct rtp_extmap extmap_none = {
889 };
890 int idx;
891
892 ao2_lock(instance);
893
894 /* Clear both the known unique ids and the negotiated extensions as we are about to have
895 * new results set on us.
896 */
897 for (idx = 0; idx < AST_VECTOR_SIZE(&instance->extmap_unique_ids); ++idx) {
898 AST_VECTOR_REPLACE(&instance->extmap_unique_ids, idx, extmap_none);
899 }
900
901 for (idx = 0; idx < AST_VECTOR_SIZE(&instance->extmap_negotiated); ++idx) {
902 AST_VECTOR_REPLACE(&instance->extmap_negotiated, idx, -1);
903 }
904
905 ao2_unlock(instance);
906}
struct ast_rtp_instance::@383 extmap_negotiated
struct ast_rtp_instance::@384 extmap_unique_ids
enum ast_rtp_extension extension
Definition: rtp_engine.c:182

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

922{
923 size_t count;
924
925 ao2_lock(instance);
926 count = AST_VECTOR_SIZE(&instance->extmap_unique_ids);
927 ao2_unlock(instance);
928
929 return count;
930}

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
instanceThe RTP instance to enable the extension on
idThe unique local identifier to use for this extension (-1 to have one auto selected)
extensionThe RTP extension
directionThe initial direction that the RTP extension should be used in
Return values
0success
-1failure
Since
15.5.0

Definition at line 754 of file rtp_engine.c.

756{
757 struct rtp_extmap extmap = {
759 .direction = direction,
760 };
761
762 ao2_lock(instance);
763
764 if (!instance->engine->extension_enable || !instance->engine->extension_enable(instance, extension)) {
765 ao2_unlock(instance);
766 return 0;
767 }
768
769 /* We store enabled extensions separately so we can easily do negotiation */
771 ao2_unlock(instance);
772 return -1;
773 }
774
775 if (id <= 0) {
776 /* We find a free unique identifier for this extension by just appending it to the
777 * vector of unique ids. The size of the vector will become its unique identifier.
778 * As well when we are asking for information on the extensions it will be returned,
779 * allowing it to be added to the SDP offer.
780 */
781 if (AST_VECTOR_APPEND(&instance->extmap_unique_ids, extmap)) {
783 ao2_unlock(instance);
784 return -1;
785 }
786 id = AST_VECTOR_SIZE(&instance->extmap_unique_ids);
787 } else {
788 /* Otherwise we put it precisely where they want it */
789 if (AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap)) {
791 ao2_unlock(instance);
792 return -1;
793 }
794 }
795
796 /* Now that we have an id add the extension to here */
797 if (AST_VECTOR_REPLACE(&instance->extmap_negotiated, extension, id)) {
801 AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap);
802 ao2_unlock(instance);
803 return -1;
804 }
805
806 ao2_unlock(instance);
807
808 return 0;
809}
direction
int(* extension_enable)(struct ast_rtp_instance *instance, enum ast_rtp_extension extension)
Definition: rtp_engine.h:750
struct ast_rtp_instance::@382 extmap_enabled
structure to hold extensions
enum ast_rtp_extension_direction direction
Definition: rtp_engine.c:184
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition: vector.h:256

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
instanceThe RTP instance to retrieve the direction from
idThe 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.

953{
955
956 ao2_lock(instance);
957
958 if (0 < id && id <= AST_VECTOR_SIZE(&instance->extmap_unique_ids)) {
959 struct rtp_extmap *extmap = AST_VECTOR_GET_ADDR(&instance->extmap_unique_ids, id - 1);
960
961 direction = extmap->direction;
962 }
963 ao2_unlock(instance);
964
965 return direction;
966}
ast_rtp_extension_direction
Directions for RTP extensions.
Definition: rtp_engine.h:827
#define AST_VECTOR_GET_ADDR(vec, idx)
Get an address of element in a vector.
Definition: vector.h:668

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
instanceThe RTP instance to retrieve the extension from
idThe 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.

933{
935
936 ao2_lock(instance);
937
938 /* The local unique identifier starts at '1' so the highest unique identifier
939 * can be the actual size of the vector. We compensate (as it is 0 index based)
940 * by dropping it down to 1 to get the correct information.
941 */
942 if (0 < id && id <= AST_VECTOR_SIZE(&instance->extmap_unique_ids)) {
943 struct rtp_extmap *extmap = AST_VECTOR_GET_ADDR(&instance->extmap_unique_ids, id - 1);
944
945 extension = extmap->extension;
946 }
947 ao2_unlock(instance);
948
949 return extension;
950}
ast_rtp_extension
Known RTP extensions.
Definition: rtp_engine.h:593

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
instanceThe RTP instance to retrieve the id from
extensionThe RTP extension
Return values
-1not negotiated
idif negotiated
Since
15.5.0

Definition at line 908 of file rtp_engine.c.

909{
910 int id = -1;
911
912 ao2_lock(instance);
913 if (extension < AST_VECTOR_SIZE(&instance->extmap_negotiated)) {
915 }
916 ao2_unlock(instance);
917
918 return id;
919}
enum queue_result id
Definition: app_queue.c:1667

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
instanceThe RTP instance to retrieve the direction from
idThe negotiated RTP extension id
Returns
The URI for the RTP extension
Since
15.5.0

Definition at line 968 of file rtp_engine.c.

969{
971
973 (unsigned int)extension >= ARRAY_LEN(rtp_extension_uris)) {
974 return NULL;
975 }
976
978}
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.
Definition: rtp_engine.c:932
static const char *const rtp_extension_uris[AST_RTP_EXTENSION_MAX]
URIs for known RTP extensions.
Definition: rtp_engine.c:234
#define ARRAY_LEN(a)
Definition: utils.h:666

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
instanceThe RTP instance to set the extension on
idThe local identifier for the extension
directionThe direction that the extension should be used in
uriThe unique URI for the extension
attributesAttributes specific to this extension (if NULL or empty then no attributes)
Return values
0success
-1failure
Since
15.5.0

Definition at line 840 of file rtp_engine.c.

842{
843 /* 'attributes' is currently unused but exists in the API to ensure it does not need to be altered
844 * in the future in case we need to use it.
845 */
846 int idx;
848
849 /* Per the RFC the identifier has to be 1 or above */
850 if (id < 1) {
851 return -1;
852 }
853
854 /* Convert the provided URI to the internal representation */
855 for (idx = 0; idx < ARRAY_LEN(rtp_extension_uris); ++idx) {
856 if (!strcasecmp(rtp_extension_uris[idx], uri)) {
857 extension = idx;
858 break;
859 }
860 }
861
862 ao2_lock(instance);
863 /* We only accept the extension if it is enabled */
864 if (extension < AST_VECTOR_SIZE(&instance->extmap_enabled) &&
866 struct rtp_extmap extmap = {
869 };
870
871 /* If the direction negotiation failed then don't accept or use this extension */
875 }
876 AST_VECTOR_REPLACE(&instance->extmap_unique_ids, id - 1, extmap);
877 }
878 }
879 ao2_unlock(instance);
880
881 return 0;
882}
static enum ast_rtp_extension_direction rtp_extmap_negotiate_direction(enum ast_rtp_extension_direction ours, enum ast_rtp_extension_direction theirs)
Helper function which negotiates two RTP extension directions to get our current direction.
Definition: rtp_engine.c:812

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()

<