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"
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... | |
Functions | |
| uintmax_t | ast_debug_category_dtls_id (void) |
| uintmax_t | ast_debug_category_dtls_packet_id (void) |
| uintmax_t | ast_debug_category_ice_id (void) |
| uintmax_t | ast_debug_category_rtcp_id (void) |
| uintmax_t | ast_debug_category_rtcp_packet_id (void) |
| uintmax_t | ast_debug_category_rtp_id (void) |
| uintmax_t | ast_debug_category_rtp_packet_id (void) |
| int | ast_rtp_codecs_find_payload_code (struct ast_rtp_codecs *codecs, int payload) |
| Search for the tx payload type in the ast_rtp_codecs structure. More... | |
| unsigned int | ast_rtp_codecs_get_framing (struct ast_rtp_codecs *codecs) |
| Get the framing used for a set of codecs. More... | |
| struct ast_rtp_payload_type * | ast_rtp_codecs_get_payload (struct ast_rtp_codecs *codecs, int payload) |
| Retrieve rx payload mapped information by payload type. More... | |
| struct ast_format * | ast_rtp_codecs_get_payload_format (struct ast_rtp_codecs *codecs, int payload) |
| Retrieve the actual ast_format stored on the codecs structure for a specific tx payload type. More... | |
| int | ast_rtp_codecs_get_preferred_dtmf_format_pt (struct ast_rtp_codecs *codecs) |
| Retrieve rx preferred dtmf format payload type. More... | |
| int | ast_rtp_codecs_get_preferred_dtmf_format_rate (struct ast_rtp_codecs *codecs) |
| Retrieve rx preferred dtmf format sample rate. More... | |
| struct ast_format * | ast_rtp_codecs_get_preferred_format (struct ast_rtp_codecs *codecs) |
| Retrieve rx preferred format. More... | |
| enum ast_media_type | ast_rtp_codecs_get_stream_type (struct ast_rtp_codecs *codecs) |
| Determine the type of RTP stream media from the codecs mapped. More... | |
| int | ast_rtp_codecs_payload_code (struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code) |
| Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code. More... | |
| int | ast_rtp_codecs_payload_code_sample_rate (struct ast_rtp_codecs *codecs, int asterisk_format, struct ast_format *format, int code, unsigned int sample_rate) |
| Retrieve a rx mapped payload type based on whether it is an Asterisk format, the code and the sample rate. More... | |
| int | ast_rtp_codecs_payload_code_tx (struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code) |
| Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code. More... | |
| int | ast_rtp_codecs_payload_code_tx_sample_rate (struct ast_rtp_codecs *codecs, int asterisk_format, const struct ast_format *format, int code, unsigned int sample_rate) |
| Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code. More... | |
| void | ast_rtp_codecs_payload_formats (struct ast_rtp_codecs *codecs, struct ast_format_cap *astformats, int *nonastformats) |
| Retrieve all formats that were found. More... | |
| int | ast_rtp_codecs_payload_replace_format (struct ast_rtp_codecs *codecs, int payload, struct ast_format *format) |
| Update the format associated with a tx payload type in a codecs structure. More... | |
| int | ast_rtp_codecs_payload_set_rx (struct ast_rtp_codecs *codecs, int code, struct ast_format *format) |
| Set a payload code for use with a specific Asterisk format. More... | |
| int | ast_rtp_codecs_payload_set_rx_sample_rate (struct ast_rtp_codecs *codecs, int code, struct ast_format *format, unsigned int sample_rate) |
| Set a payload code with sample rate for use with a specific Asterisk format. More... | |
| void | ast_rtp_codecs_payloads_clear (struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance) |
| Clear rx and tx payload mapping information from an RTP instance. More... | |
| void | ast_rtp_codecs_payloads_copy (struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance) |
| Copy payload information from one RTP instance to another. More... | |
| void | ast_rtp_codecs_payloads_destroy (struct ast_rtp_codecs *codecs) |
| Destroy the contents of an RTP codecs structure (but not the structure itself) More... | |
| int | ast_rtp_codecs_payloads_initialize (struct ast_rtp_codecs *codecs) |
| Initialize an RTP codecs structure. More... | |
| void | ast_rtp_codecs_payloads_set_m_type (struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload) |
| Record tx payload type information that was seen in an m= SDP line. More... | |
| int | ast_rtp_codecs_payloads_set_rtpmap_type (struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload, char *mimetype, char *mimesubtype, enum ast_rtp_options options) |
| Record tx payload type information that was seen in an a=rtpmap: SDP line. More... | |
| int | ast_rtp_codecs_payloads_set_rtpmap_type_rate (struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int pt, char *mimetype, char *mimesubtype, enum ast_rtp_options options, unsigned int sample_rate) |
| Set tx payload type to a known MIME media type for a codec with a specific sample rate. More... | |
| void | ast_rtp_codecs_payloads_unset (struct ast_rtp_codecs *codecs, struct ast_rtp_instance *instance, int payload) |
| Remove tx payload type mapped information. More... | |
| void | ast_rtp_codecs_payloads_xover (struct ast_rtp_codecs *src, struct ast_rtp_codecs *dest, struct ast_rtp_instance *instance) |
| Crossover copy the tx payload mapping of src to the rx payload mapping of dest. More... | |
| void | ast_rtp_codecs_set_framing (struct ast_rtp_codecs *codecs, unsigned int framing) |
| Set the framing used for a set of codecs. More... | |
| int | ast_rtp_codecs_set_preferred_dtmf_format (struct ast_rtp_codecs *codecs, int pt, int rate) |
| Set the preferred dtmf format pt and sample rate. More... | |
| int | ast_rtp_codecs_set_preferred_format (struct ast_rtp_codecs *codecs, struct ast_format *format) |
| Set the preferred format. More... | |
| struct ast_json * | ast_rtp_convert_stats_json (const struct ast_rtp_instance_stats *stats) |
| Convert given stat instance into json format. More... | |
| void | ast_rtp_dtls_cfg_copy (const struct ast_rtp_dtls_cfg *src_cfg, struct ast_rtp_dtls_cfg *dst_cfg) |
| Copy contents of a DTLS configuration structure. More... | |
| void | ast_rtp_dtls_cfg_free (struct ast_rtp_dtls_cfg *dtls_cfg) |
| Free contents of a DTLS configuration structure. More... | |
| int | ast_rtp_dtls_cfg_parse (struct ast_rtp_dtls_cfg *dtls_cfg, const char *name, const char *value) |
| Parse DTLS related configuration options. More... | |
| int | ast_rtp_dtls_cfg_validate (struct ast_rtp_dtls_cfg *dtls_cfg) |
| Validates DTLS related configuration options. More... | |
| struct ast_rtp_payload_type * | ast_rtp_engine_alloc_payload_type (void) |
| Allocation routine for ast_rtp_payload_type. More... | |
| int | ast_rtp_engine_load_format (struct ast_format *format) |
| Custom formats declared in codecs.conf at startup must be communicated to the rtp_engine so their mime type can payload number can be initialized. More... | |
| int | ast_rtp_engine_register2 (struct ast_rtp_engine *engine, struct ast_module *module) |
| Register an RTP engine. More... | |
| int | ast_rtp_engine_register_srtp (struct ast_srtp_res *srtp_res, struct ast_srtp_policy_res *policy_res) |
| int | ast_rtp_engine_srtp_is_registered (void) |
| int | ast_rtp_engine_unload_format (struct ast_format *format) |
| Formats requiring the use of a format attribute interface must have that interface registered in order for the rtp engine to handle it correctly. If an attribute interface is unloaded, this function must be called to notify the rtp_engine. More... | |
| int | ast_rtp_engine_unregister (struct ast_rtp_engine *engine) |
| Unregister an RTP engine. More... | |
| void | ast_rtp_engine_unregister_srtp (void) |
| int | ast_rtp_get_rate (const struct ast_format *format) |
| Retrieve the sample rate of a format according to RTP specifications. More... | |
| int | ast_rtp_glue_register2 (struct ast_rtp_glue *glue, struct ast_module *module) |
| Register RTP glue. More... | |
| int | ast_rtp_glue_unregister (struct ast_rtp_glue *glue) |
| Unregister RTP glue. More... | |
| int | ast_rtp_instance_activate (struct ast_rtp_instance *instance) |
| Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance. More... | |
| int | ast_rtp_instance_add_srtp_policy (struct ast_rtp_instance *instance, struct ast_srtp_policy *remote_policy, struct ast_srtp_policy *local_policy, int rtcp) |
| Add or replace the SRTP policies for the given RTP instance. More... | |
| void | ast_rtp_instance_available_formats (struct ast_rtp_instance *instance, struct ast_format_cap *to_endpoint, struct ast_format_cap *to_asterisk, struct ast_format_cap *result) |
| Request the formats that can be transcoded. More... | |
| int | ast_rtp_instance_bundle (struct ast_rtp_instance *child, struct ast_rtp_instance *parent) |
| Request that an RTP instance be bundled with another. More... | |
| void | ast_rtp_instance_change_source (struct ast_rtp_instance *instance) |
| Indicate a new source of audio has dropped in and the ssrc should change. More... | |
| int | ast_rtp_instance_destroy (struct ast_rtp_instance *instance) |
| Destroy an RTP instance. More... | |
| int | ast_rtp_instance_dtmf_begin (struct ast_rtp_instance *instance, char digit) |
| Begin sending a DTMF digit. More... | |
| int | ast_rtp_instance_dtmf_end (struct ast_rtp_instance *instance, char digit) |
| Stop sending a DTMF digit. More... | |
| int | ast_rtp_instance_dtmf_end_with_duration (struct ast_rtp_instance *instance, char digit, unsigned int duration) |
| enum ast_rtp_dtmf_mode | ast_rtp_instance_dtmf_mode_get (struct ast_rtp_instance *instance) |
| Get the DTMF mode of an RTP instance. More... | |
| int | ast_rtp_instance_dtmf_mode_set (struct ast_rtp_instance *instance, enum ast_rtp_dtmf_mode dtmf_mode) |
| Set the DTMF mode that should be used. More... | |
| int | ast_rtp_instance_early_bridge (struct ast_channel *c0, struct ast_channel *c1) |
| Early bridge two channels that use RTP instances. More... | |
| void | ast_rtp_instance_early_bridge_make_compatible (struct ast_channel *c_dst, struct ast_channel *c_src) |
| Make two channels compatible for early bridging. More... | |
| void | ast_rtp_instance_extmap_clear (struct ast_rtp_instance *instance) |
| Clear negotiated RTP extension information. More... | |
| size_t | ast_rtp_instance_extmap_count (struct ast_rtp_instance *instance) |
| Get the number of known unique identifiers. More... | |
| int | ast_rtp_instance_extmap_enable (struct ast_rtp_instance *instance, int id, enum ast_rtp_extension extension, enum ast_rtp_extension_direction direction) |
| Enable support for an RTP extension on an instance. More... | |
| enum ast_rtp_extension_direction | ast_rtp_instance_extmap_get_direction (struct ast_rtp_instance *instance, int id) |
| Retrieve the negotiated direction for an RTP extension id. More... | |
| enum ast_rtp_extension | ast_rtp_instance_extmap_get_extension (struct ast_rtp_instance *instance, int id) |
| Retrieve the extension for an RTP extension id. More... | |
| int | ast_rtp_instance_extmap_get_id (struct ast_rtp_instance *instance, enum ast_rtp_extension extension) |
| Retrieve the id for an RTP extension. More... | |
| const char * | ast_rtp_instance_extmap_get_uri (struct ast_rtp_instance *instance, int id) |
| Retrieve the URI for an RTP extension id. More... | |
| int | ast_rtp_instance_extmap_negotiate (struct ast_rtp_instance *instance, int id, enum ast_rtp_extension_direction direction, const char *uri, const char *attributes) |
| Negotiate received RTP extension information. More... | |
| int | ast_rtp_instance_fd (struct ast_rtp_instance *instance, int rtcp) |
| Get the file descriptor for an RTP session (or RTCP) More... | |
| struct ast_rtp_glue * | ast_rtp_instance_get_active_glue (struct ast_rtp_instance *instance) |
| Get the RTP glue in use on an RTP instance. More... | |
| int | ast_rtp_instance_get_and_cmp_local_address (struct ast_rtp_instance *instance, struct ast_sockaddr *address) |
| Get the address of the local endpoint that we are sending RTP to, comparing its address to another. More... | |
| int | ast_rtp_instance_get_and_cmp_requested_target_address (struct ast_rtp_instance *instance, struct ast_sockaddr *address) |
| Get the requested target address of the remote endpoint and compare it to the given address. More... | |
| struct ast_rtp_instance * | ast_rtp_instance_get_bridged (struct ast_rtp_instance *instance) |
| Get the other RTP instance that an instance is bridged to. More... | |
| const char * | ast_rtp_instance_get_channel_id (struct ast_rtp_instance *instance) |
| Get the unique ID of the channel that owns this RTP instance. More... | |
| const char * | ast_rtp_instance_get_cname (struct ast_rtp_instance *rtp) |
| Retrieve the CNAME used in RTCP SDES items. More... | |
| struct ast_rtp_codecs * | ast_rtp_instance_get_codecs (struct ast_rtp_instance *instance) |
| Get the codecs structure of an RTP instance. More... | |
| void * | ast_rtp_instance_get_data (struct ast_rtp_instance *instance) |
| Get the data portion of an RTP instance. More... | |
| struct ast_rtp_engine_dtls * | ast_rtp_instance_get_dtls (struct ast_rtp_instance *instance) |
| Obtain a pointer to the DTLS support present on an RTP instance. More... | |
| struct ast_rtp_engine * | ast_rtp_instance_get_engine (struct ast_rtp_instance *instance) |
| Get the RTP engine in use on an RTP instance. More... | |
| void * | ast_rtp_instance_get_extended_prop (struct ast_rtp_instance *instance, int property) |
| Get the value of an RTP instance extended property. More... | |
| struct ast_rtp_glue * | ast_rtp_instance_get_glue (const char *type) |
| Get the RTP glue that binds a channel to the RTP engine. More... | |
| int | ast_rtp_instance_get_hold_timeout (struct ast_rtp_instance *instance) |
| Get the RTP timeout value for when an RTP instance is on hold. More... | |
| struct ast_rtp_engine_ice * | ast_rtp_instance_get_ice (struct ast_rtp_instance *instance) |
| Obtain a pointer to the ICE support present on an RTP instance. More... | |
| void | ast_rtp_instance_get_incoming_source_address (struct ast_rtp_instance *instance, struct ast_sockaddr *address) |
| Get the incoming source address of the remote endpoint. More... | |
| int | ast_rtp_instance_get_keepalive (struct ast_rtp_instance *instance) |
| Get the RTP keepalive interval. More... | |
| time_t | ast_rtp_instance_get_last_rx (const struct ast_rtp_instance *rtp) |
| Get the last RTP reception time. More... | |
| time_t | ast_rtp_instance_get_last_tx (const struct ast_rtp_instance *rtp) |
| Get the last RTP transmission time. More... | |
| void | ast_rtp_instance_get_local_address (struct ast_rtp_instance *instance, struct ast_sockaddr *address) |
| Get the local address that we are expecting RTP on. More... | |
| int | ast_rtp_instance_get_prop (struct ast_rtp_instance *instance, enum ast_rtp_property property) |
| Get the value of an RTP instance property. More... | |
| char * | ast_rtp_instance_get_quality (struct ast_rtp_instance *instance, enum ast_rtp_instance_stat_field field, char *buf, size_t size) |
| Retrieve quality statistics about an RTP instance. More... | |
| void | ast_rtp_instance_get_requested_target_address (struct ast_rtp_instance *instance, struct ast_sockaddr *address) |
| Get the requested target address of the remote endpoint. More... | |
| struct ast_srtp * | ast_rtp_instance_get_srtp (struct ast_rtp_instance *instance, int rtcp) |
| Obtain the SRTP instance associated with an RTP instance. More... | |
| unsigned int | ast_rtp_instance_get_ssrc (struct ast_rtp_instance *rtp) |
| Retrieve the local SSRC value that we will be using. More... | |
| int | ast_rtp_instance_get_stats (struct ast_rtp_instance *instance, struct ast_rtp_instance_stats *stats, enum ast_rtp_instance_stat stat) |
| Retrieve statistics about an RTP instance. More... | |
| struct ast_json * | ast_rtp_instance_get_stats_all_json (struct ast_rtp_instance *instance) |
| Retrieve statistics about an RTP instance in json format. More... | |
| int | ast_rtp_instance_get_timeout (struct ast_rtp_instance *instance) |
| Get the RTP timeout value. More... | |
| int | ast_rtp_instance_make_compatible (struct ast_channel *chan, struct ast_rtp_instance *instance, struct ast_channel *peer) |
| Request that the underlying RTP engine make two RTP instances compatible with eachother. More... | |
| struct ast_rtp_instance * | ast_rtp_instance_new (const char *engine_name, struct ast_sched_context *sched, const struct ast_sockaddr *sa, void *data) |
| Create a new RTP instance. More... | |
| struct ast_frame * | ast_rtp_instance_read (struct ast_rtp_instance *instance, int rtcp) |
| Receive a frame over RTP. More... | |
| int | ast_rtp_instance_sendcng (struct ast_rtp_instance *instance, int level) |
| Send a comfort noise packet to the RTP instance. More... | |
| void | ast_rtp_instance_set_bridged (struct ast_rtp_instance *instance, struct ast_rtp_instance *bridged) |
| Set the other RTP instance that an instance is bridged to. More... | |
| void | ast_rtp_instance_set_channel_id (struct ast_rtp_instance *instance, const char *uniqueid) |
| Set the channel that owns this RTP instance. More... | |
| void | ast_rtp_instance_set_data (struct ast_rtp_instance *instance, void *data) |
| Set the data portion of an RTP instance. More... | |
| void | ast_rtp_instance_set_extended_prop (struct ast_rtp_instance *instance, int property, void *value) |
| Set the value of an RTP instance extended property. More... | |
| void | ast_rtp_instance_set_hold_timeout (struct ast_rtp_instance *instance, int timeout) |
| Set the RTP timeout value for when the instance is on hold. More... | |
| int | ast_rtp_instance_set_incoming_source_address (struct ast_rtp_instance *instance, const struct ast_sockaddr *address) |
| Set the incoming source address of the remote endpoint that we are sending RTP to. More... | |
| void | ast_rtp_instance_set_keepalive (struct ast_rtp_instance *instance, int timeout) |
| Set the RTP keepalive interval. More... | |
| void | ast_rtp_instance_set_last_rx (struct ast_rtp_instance *rtp, time_t time) |
| Set the last RTP reception time. More... | |
| void | ast_rtp_instance_set_last_tx (struct ast_rtp_instance *rtp, time_t time) |
| Set the last RTP transmission time. More... | |
| int | ast_rtp_instance_set_local_address (struct ast_rtp_instance *instance, const struct ast_sockaddr *address) |
| Set the address that we are expecting to receive RTP on. More... | |
| void | ast_rtp_instance_set_prop (struct ast_rtp_instance *instance, enum ast_rtp_property property, int value) |
| Set the value of an RTP instance property. More... | |
| int | ast_rtp_instance_set_qos (struct ast_rtp_instance *instance, int tos, int cos, const char *desc) |
| Set QoS parameters on an RTP session. More... | |
| int | ast_rtp_instance_set_read_format (struct ast_rtp_instance *instance, struct ast_format *format) |
| Request that the underlying RTP engine provide audio frames in a specific format. More... | |
| void | ast_rtp_instance_set_remote_ssrc (struct ast_rtp_instance *rtp, unsigned int ssrc) |
| Set the remote SSRC for an RTP instance. More... | |
| int | ast_rtp_instance_set_requested_target_address (struct ast_rtp_instance *instance, const struct ast_sockaddr *address) |
| Set the requested target address of the remote endpoint. More... | |
| void | ast_rtp_instance_set_stats_vars (struct ast_channel *chan, struct ast_rtp_instance *instance) |
| Set standard statistics from an RTP instance on a channel. More... | |
| void | ast_rtp_instance_set_stream_num (struct ast_rtp_instance *instance, int stream_num) |
| Set the stream number for an RTP instance. More... | |
| void | ast_rtp_instance_set_timeout (struct ast_rtp_instance *instance, int timeout) |
| Set the RTP timeout value. More... | |
| int | ast_rtp_instance_set_write_format (struct ast_rtp_instance *instance, struct ast_format *format) |
| Tell underlying RTP engine that audio frames will be provided in a specific format. More... | |
| void | ast_rtp_instance_stop (struct ast_rtp_instance *instance) |
| Stop an RTP instance. More... | |
| void | ast_rtp_instance_stun_request (struct ast_rtp_instance *instance, struct ast_sockaddr *suggestion, const char *username) |
| Request that the underlying RTP engine send a STUN BIND request. More... | |
| void | ast_rtp_instance_update_source (struct ast_rtp_instance *instance) |
| Indicate that the RTP marker bit should be set on an RTP stream. More... | |
| int | ast_rtp_instance_write (struct ast_rtp_instance *instance, struct ast_frame *frame) |
| Send a frame out over RTP. More... | |
| char * | ast_rtp_lookup_mime_multiple2 (struct ast_str *buf, struct ast_format_cap *ast_format_capability, int rtp_capability, const int asterisk_format, enum ast_rtp_options options) |
| Convert formats into a string and put them into a buffer. More... | |
| const char * | ast_rtp_lookup_mime_subtype2 (const int asterisk_format, const struct ast_format *format, int code, enum ast_rtp_options options) |
| Retrieve mime subtype information on a payload. More... | |
| unsigned int | ast_rtp_lookup_sample_rate2 (int asterisk_format, const struct ast_format *format, int code) |
| Get the sample rate associated with known RTP payload types. More... | |
| int | ast_rtp_payload_mapping_tx_is_present (struct ast_rtp_codecs *codecs, const struct ast_rtp_payload_type *to_match) |
| Determine if a type of payload is already present in mappings. More... | |
| void | ast_rtp_publish_rtcp_message (struct ast_rtp_instance *rtp, struct stasis_message_type *message_type, struct ast_rtp_rtcp_report *report, struct ast_json *blob) |
| Publish an RTCP message to Stasis Message Bus API. More... | |
| int | ast_rtp_red_buffer (struct ast_rtp_instance *instance, struct ast_frame *frame) |
| Buffer a frame in an RTP instance for RED. More... | |
| int | ast_rtp_red_init (struct ast_rtp_instance *instance, int buffer_time, int *payloads, int generations) |
| Initialize RED support on an RTP instance. More... | |
| struct stasis_message_type * | ast_rtp_rtcp_received_type (void) |
| Message type for an RTCP message received from some external source. More... | |
| struct ast_rtp_rtcp_report * | ast_rtp_rtcp_report_alloc (unsigned int report_blocks) |
| Allocate an ao2 ref counted instance of ast_rtp_rtcp_report. More... | |
| struct stasis_message_type * | ast_rtp_rtcp_sent_type (void) |
| Message type for an RTCP message sent from this Asterisk instance. More... | |
| struct stasis_topic * | ast_rtp_topic (void) |
| Stasis Message Bus API topic for RTP and RTCP related messages More... | |
Detailed Description
Pluggable RTP Architecture.
Definition in file rtp_engine.h.
Macro Definition Documentation
◆ AST_DEBUG_CATEGORY_DTLS
| #define AST_DEBUG_CATEGORY_DTLS ast_debug_category_dtls_id() /* DTLS debug logging category id */ |
Definition at line 3089 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_DTLS_PACKET
| #define AST_DEBUG_CATEGORY_DTLS_PACKET ast_debug_category_dtls_packet_id() /* DTLS packet debug logging category id */ |
Definition at line 3090 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_ICE
| #define AST_DEBUG_CATEGORY_ICE ast_debug_category_ice_id() /* ICE debug logging category id */ |
Definition at line 3091 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_RTCP
| #define AST_DEBUG_CATEGORY_RTCP ast_debug_category_rtcp_id() /* RTCP debug logging category id */ |
Definition at line 3087 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_RTCP_PACKET
| #define AST_DEBUG_CATEGORY_RTCP_PACKET ast_debug_category_rtcp_packet_id() /* RTCP packet debug logging category id */ |
Definition at line 3088 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_RTP
| #define AST_DEBUG_CATEGORY_RTP ast_debug_category_rtp_id() /* RTP debug logging category id */ |
Definition at line 3085 of file rtp_engine.h.
◆ AST_DEBUG_CATEGORY_RTP_PACKET
| #define AST_DEBUG_CATEGORY_RTP_PACKET ast_debug_category_rtp_packet_id() /* RTP packet debug logging category id */ |
Definition at line 3086 of file rtp_engine.h.
◆ ast_debug_dtls
| #define ast_debug_dtls | ( | sublevel, | |
| ... | |||
| ) | ast_debug_category(sublevel, AST_DEBUG_CATEGORY_DTLS, __VA_ARGS__) |
Log debug level DTLS information.
- Parameters
-
sublevel Debug output sublevel (>= 0) ... String format and any associated arguments
Definition at line 3133 of file rtp_engine.h.
◆ ast_debug_dtls_packet_is_allowed
| #define ast_debug_dtls_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_DTLS_PACKET) |
Definition at line 3137 of file rtp_engine.h.
◆ ast_debug_ice
| #define ast_debug_ice | ( | sublevel, | |
| ... | |||
| ) | ast_debug_category(sublevel, AST_DEBUG_CATEGORY_ICE, __VA_ARGS__) |
Log debug level ICE information.
- Parameters
-
sublevel Debug output sublevel (>= 0) ... String format and any associated arguments
Definition at line 3145 of file rtp_engine.h.
◆ ast_debug_rtcp
| #define ast_debug_rtcp | ( | sublevel, | |
| ... | |||
| ) | ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTCP, __VA_ARGS__) |
Log debug level RTCP information.
- Parameters
-
sublevel Debug output sublevel (>= 0) ... String format and any associated arguments
Definition at line 3116 of file rtp_engine.h.
◆ ast_debug_rtcp_is_allowed
| #define ast_debug_rtcp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP) |
Definition at line 3120 of file rtp_engine.h.
◆ ast_debug_rtcp_packet_is_allowed
| #define ast_debug_rtcp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTCP_PACKET) |
Definition at line 3124 of file rtp_engine.h.
◆ ast_debug_rtp
| #define ast_debug_rtp | ( | sublevel, | |
| ... | |||
| ) | ast_debug_category(sublevel, AST_DEBUG_CATEGORY_RTP, __VA_ARGS__) |
Log debug level RTP information.
- Parameters
-
sublevel Debug output sublevel (>= 0) ... String format and any associated arguments
Definition at line 3099 of file rtp_engine.h.
◆ ast_debug_rtp_is_allowed
| #define ast_debug_rtp_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP) |
Definition at line 3103 of file rtp_engine.h.
◆ ast_debug_rtp_packet_is_allowed
| #define ast_debug_rtp_packet_is_allowed ast_debug_category_is_allowed(AST_LOG_CATEGORY_ENABLED, AST_DEBUG_CATEGORY_RTP_PACKET) |
Definition at line 3107 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_DTLS
| #define AST_LOG_CATEGORY_DTLS "dtls" |
Definition at line 3071 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_DTLS_PACKET
| #define AST_LOG_CATEGORY_DTLS_PACKET "dtls_packet" |
Definition at line 3073 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_ICE
| #define AST_LOG_CATEGORY_ICE "ice" |
Definition at line 3075 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_RTCP
| #define AST_LOG_CATEGORY_RTCP "rtcp" |
Definition at line 3067 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_RTCP_PACKET
| #define AST_LOG_CATEGORY_RTCP_PACKET "rtcp_packet" |
Definition at line 3069 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_RTP
| #define AST_LOG_CATEGORY_RTP "rtp" |
Definition at line 3063 of file rtp_engine.h.
◆ AST_LOG_CATEGORY_RTP_PACKET
| #define AST_LOG_CATEGORY_RTP_PACKET "rtp_packet" |
Definition at line 3065 of file rtp_engine.h.
◆ AST_RED_MAX_GENERATION
| #define AST_RED_MAX_GENERATION 5 |
Maximum number of generations
Definition at line 98 of file rtp_engine.h.
◆ AST_RTP_CISCO_DTMF
| #define AST_RTP_CISCO_DTMF (1 << 2) |
DTMF (Cisco Proprietary)
Definition at line 298 of file rtp_engine.h.
◆ AST_RTP_CN
| #define AST_RTP_CN (1 << 1) |
'Comfort Noise' (RFC3389)
Definition at line 296 of file rtp_engine.h.
◆ AST_RTP_CODECS_NULL_INIT
| #define AST_RTP_CODECS_NULL_INIT |
Definition at line 773 of file rtp_engine.h.
◆ AST_RTP_DTMF
| #define AST_RTP_DTMF (1 << 0) |
DTMF (RFC2833)
Definition at line 294 of file rtp_engine.h.
◆ ast_rtp_engine_register
| #define ast_rtp_engine_register | ( | engine | ) | ast_rtp_engine_register2(engine, AST_MODULE_SELF) |
Definition at line 852 of file rtp_engine.h.
◆ ast_rtp_glue_register
| #define ast_rtp_glue_register | ( | glue | ) | ast_rtp_glue_register2(glue, AST_MODULE_SELF) |
Definition at line 905 of file rtp_engine.h.
◆ ast_rtp_instance_get_and_cmp_remote_address
| #define ast_rtp_instance_get_and_cmp_remote_address | ( | instance, | |
| address | |||
| ) | ast_rtp_instance_get_and_cmp_requested_target_address((instance), (address)) |
Get the address of the remote endpoint that we are sending RTP to, comparing its address to another.
- Parameters
-
instance The instance that we want to get the remote address for address An initialized address that may be overwritten if the remote address is different
- Return values
-
0 address was not changed 1 address was changed Example usage:
This retrieves the current remote address set on the instance pointed to by instance and puts the value into the address structure.
- Since
- 1.8
Definition at line 1286 of file rtp_engine.h.
◆ ast_rtp_instance_get_remote_address
| #define ast_rtp_instance_get_remote_address | ( | instance, | |
| address | |||
| ) | ast_rtp_instance_get_incoming_source_address((instance), (address)) |
Get the address of the remote endpoint that we are sending RTP to.
- Parameters
-
instance The instance that we want to get the remote address for address A structure to put the address into
Example usage:
This retrieves the current remote address set on the instance pointed to by instance and puts the value into the address structure.
- Since
- 1.8
Definition at line 1250 of file rtp_engine.h.
◆ ast_rtp_instance_set_remote_address
| #define ast_rtp_instance_set_remote_address | ( | instance, | |
| address | |||
| ) | ast_rtp_instance_set_requested_target_address((instance), (address)) |
Set the address of the remote endpoint that we are sending RTP to.
- Parameters
-
instance The RTP instance to change the address on address Address to set it to
- Return values
-
0 success -1 failure
Example usage:
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 | ) |
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.
◆ ast_rtp_dtls_hash
| enum ast_rtp_dtls_hash |
DTLS fingerprint hashes.
| Enumerator | |
|---|---|
| AST_RTP_DTLS_HASH_SHA256 | SHA-256 fingerprint hash |
| AST_RTP_DTLS_HASH_SHA1 | SHA-1 fingerprint hash |
Definition at line 578 of file rtp_engine.h.
◆ ast_rtp_dtls_setup
| enum ast_rtp_dtls_setup |
DTLS setup types.
Definition at line 564 of file rtp_engine.h.
◆ ast_rtp_dtls_verify
| enum ast_rtp_dtls_verify |
DTLS verification settings.
| Enumerator | |
|---|---|
| AST_RTP_DTLS_VERIFY_NONE | Don't verify anything |
| AST_RTP_DTLS_VERIFY_FINGERPRINT | Verify the fingerprint |
| AST_RTP_DTLS_VERIFY_CERTIFICATE | Verify the certificate |
Definition at line 584 of file rtp_engine.h.
◆ ast_rtp_dtmf_mode
| enum ast_rtp_dtmf_mode |
RTP DTMF Modes
Definition at line 151 of file rtp_engine.h.
◆ ast_rtp_extension
| enum ast_rtp_extension |
Known RTP extensions.
| Enumerator | |
|---|---|
| AST_RTP_EXTENSION_UNSUPPORTED | Per the RFC 0 should not be used, so we treat it as an unsupported extension placeholder |
| AST_RTP_EXTENSION_ABS_SEND_TIME | abs-send-time from https://tools.ietf.org/html/draft-alvestrand-rmcat-remb-03 |
| AST_RTP_EXTENSION_TRANSPORT_WIDE_CC | transport-cc from https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01 |
| AST_RTP_EXTENSION_MAX | The maximum number of known RTP extensions |
Definition at line 593 of file rtp_engine.h.
◆ ast_rtp_extension_direction
Directions for RTP extensions.
Definition at line 827 of file rtp_engine.h.
◆ ast_rtp_glue_result
| enum ast_rtp_glue_result |
Result codes when RTP glue is queried for information
Definition at line 161 of file rtp_engine.h.
◆ ast_rtp_ice_candidate_type
ICE candidate types.
Definition at line 506 of file rtp_engine.h.
◆ ast_rtp_ice_component_type
ICE component types.
| Enumerator | |
|---|---|
| AST_RTP_ICE_COMPONENT_RTP | |
| AST_RTP_ICE_COMPONENT_RTCP | |
Definition at line 513 of file rtp_engine.h.
◆ ast_rtp_ice_role
| enum ast_rtp_ice_role |
ICE role during negotiation.
| Enumerator | |
|---|---|
| AST_RTP_ICE_ROLE_CONTROLLED | |
| AST_RTP_ICE_ROLE_CONTROLLING | |
Definition at line 519 of file rtp_engine.h.
◆ ast_rtp_instance_rtcp
Definition at line 283 of file rtp_engine.h.
◆ ast_rtp_instance_stat
Statistics that can be retrieved from an RTP instance
Definition at line 185 of file rtp_engine.h.
◆ ast_rtp_instance_stat_field
Field statistics that can be retrieved from an RTP instance
Definition at line 171 of file rtp_engine.h.
◆ ast_rtp_options
| enum ast_rtp_options |
Additional RTP options
| Enumerator | |
|---|---|
| AST_RTP_OPT_G726_NONSTANDARD | Remote side is using non-standard G.726 |
Definition at line 145 of file rtp_engine.h.
◆ ast_rtp_property
| enum ast_rtp_property |
RTP Properties that can be set on an RTP instance
Definition at line 116 of file rtp_engine.h.
Function Documentation
◆ ast_debug_category_dtls_id()
| uintmax_t ast_debug_category_dtls_id | ( | void | ) |
◆ ast_debug_category_dtls_packet_id()
| uintmax_t ast_debug_category_dtls_packet_id | ( | void | ) |
Definition at line 3784 of file rtp_engine.c.
References debug_category_dtls_packet_id.
◆ ast_debug_category_ice_id()
| uintmax_t ast_debug_category_ice_id | ( | void | ) |
◆ ast_debug_category_rtcp_id()
| uintmax_t ast_debug_category_rtcp_id | ( | void | ) |
◆ ast_debug_category_rtcp_packet_id()
| uintmax_t ast_debug_category_rtcp_packet_id | ( | void | ) |
Definition at line 3770 of file rtp_engine.c.
References debug_category_rtcp_packet_id.
◆ ast_debug_category_rtp_id()
| uintmax_t ast_debug_category_rtp_id | ( | void | ) |
◆ ast_debug_category_rtp_packet_id()
| uintmax_t ast_debug_category_rtp_packet_id | ( | void | ) |
Definition at line 3756 of file rtp_engine.c.
References debug_category_rtp_packet_id.
◆ ast_rtp_codecs_find_payload_code()
| int ast_rtp_codecs_find_payload_code | ( | struct ast_rtp_codecs * | codecs, |
| int | payload | ||
| ) |
Search for the tx payload type in the ast_rtp_codecs structure.
- Parameters
-
codecs Codecs structure to look in payload The payload type format to look for
- Returns
- Numerical payload type or -1 if unable to find payload in codecs
Example usage:
This looks for the numerical payload for ULAW in the codecs structure.
Definition at line 2157 of file rtp_engine.c.
References ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::payload, and type.
Referenced by bridge_p2p_rtp_write().
◆ ast_rtp_codecs_get_framing()
| unsigned int ast_rtp_codecs_get_framing | ( | struct ast_rtp_codecs * | codecs | ) |
Get the framing used for a set of codecs.
- Parameters
-
codecs Codecs structure to get the framing from
- Returns
- The framing to be used for the media stream associated with these codecs
- Since
- 13.0.0
Definition at line 1688 of file rtp_engine.c.
References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.
Referenced by ast_rtp_write(), create_outgoing_sdp_stream(), multicast_rtp_write(), and native_rtp_bridge_compatible_check().
◆ ast_rtp_codecs_get_payload()
| struct ast_rtp_payload_type * ast_rtp_codecs_get_payload | ( | struct ast_rtp_codecs * | codecs, |
| int | payload | ||
| ) |
Retrieve rx payload mapped information by payload type.
- Parameters
-
codecs Codecs structure to look in payload Numerical payload to look up
- Returns
- Payload information.
- Return values
-
NULL if payload does not exist.
- Note
- The payload returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.
Example usage:
This looks up the information for payload '0' from the codecs structure.
Definition at line 1554 of file rtp_engine.c.
References ao2_bump, AST_RTP_MAX_PT, AST_RTP_PT_LAST_STATIC, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, ast_rtp_payload_type::payload, static_RTP_PT, static_RTP_PT_lock, and type.
Referenced by ast_rtp_dtmf_begin(), ast_rtp_interpret(), and bridge_p2p_rtp_write().
◆ ast_rtp_codecs_get_payload_format()
| struct ast_format * ast_rtp_codecs_get_payload_format | ( | struct ast_rtp_codecs * | codecs, |
| int | payload | ||
| ) |
Retrieve the actual ast_format stored on the codecs structure for a specific tx payload type.
- Parameters
-
codecs Codecs structure to look in payload Numerical payload type to look up
- Returns
- pointer to format structure on success
- Return values
-
NULL on failure
- Note
- The format returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.
- Since
- 10.0
Definition at line 1656 of file rtp_engine.c.
References ao2_bump, AST_RTP_MAX_PT, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, and type.
Referenced by get_codecs().
◆ ast_rtp_codecs_get_preferred_dtmf_format_pt()
| int ast_rtp_codecs_get_preferred_dtmf_format_pt | ( | struct ast_rtp_codecs * | codecs | ) |
Retrieve rx preferred dtmf format payload type.
- Parameters
-
codecs Codecs structure to look in
- Returns
- Payload type of preferred dtmf format.
- Return values
-
-1 if not set.
Example usage:
This looks up the preferred dtmf format pt on the codec
Definition at line 1595 of file rtp_engine.c.
References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.
Referenced by ast_rtp_dtmf_begin().
◆ ast_rtp_codecs_get_preferred_dtmf_format_rate()
| int ast_rtp_codecs_get_preferred_dtmf_format_rate | ( | struct ast_rtp_codecs * | codecs | ) |
Retrieve rx preferred dtmf format sample rate.
- Parameters
-
codecs Codecs structure to look in
- Returns
- Sample rate of preferred dtmf format.
- Return values
-
-1 if not set.
Example usage:
This looks up the preferred dtmf format sample rate on the codec
Definition at line 1604 of file rtp_engine.c.
References ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.
Referenced by ast_rtp_dtmf_begin().
◆ ast_rtp_codecs_get_preferred_format()
| struct ast_format * ast_rtp_codecs_get_preferred_format | ( | struct ast_rtp_codecs * | codecs | ) |
Retrieve rx preferred format.
- Parameters
-
codecs Codecs structure to look in
- Returns
- format information.
- Return values
-
NULL if format does not exist.
- Note
- The format returned by this function has its reference count increased. Callers are responsible for decrementing the reference count.
Example usage:
This looks up the preferred format on the codec
Definition at line 1578 of file rtp_engine.c.
References ao2_bump, ast_rwlock_rdlock, ast_rwlock_unlock, and codecs.
Referenced by ast_rtp_dtmf_begin().
◆ ast_rtp_codecs_get_stream_type()
| enum ast_media_type ast_rtp_codecs_get_stream_type | ( | struct ast_rtp_codecs * | codecs | ) |
Determine the type of RTP stream media from the codecs mapped.
- Since
- 13.19.0
- Parameters
-
codecs Codecs structure to look in
- Returns
- Media type or AST_MEDIA_TYPE_UNKNOWN if no codecs mapped.
Definition at line 1535 of file rtp_engine.c.
References ast_format_get_type(), AST_MEDIA_TYPE_UNKNOWN, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::payload, and type.
Referenced by ast_rtp_read().
◆ ast_rtp_codecs_payload_code()
| int ast_rtp_codecs_payload_code | ( | struct ast_rtp_codecs * | codecs, |
| int | asterisk_format, | ||
| struct ast_format * | format, | ||
| int | code | ||
| ) |
Retrieve a rx mapped payload type based on whether it is an Asterisk format and the code.
- Parameters
-
codecs Codecs structure to look in asterisk_format Non-zero if the given Asterisk format is present format Asterisk format to look for code The format to look for
Find the currently assigned rx mapped payload type based on whether it is an Asterisk format or non-format code. If one is currently not assigned then create a rx payload type mapping.
- Returns
- Numerical payload type
- Return values
-
-1 if could not assign.
Example usage:
This looks for the numerical payload for ULAW in the codecs structure.
- Since
- 1.8
Definition at line 2025 of file rtp_engine.c.
References ast_rtp_codecs_payload_code_sample_rate(), ast_rtp_payload_type::asterisk_format, codecs, and ast_rtp_payload_type::format.
Referenced by apply_cap_to_bundled(), create_outgoing_sdp_stream(), and jingle_add_payloads_to_description().
◆ ast_rtp_codecs_payload_code_sample_rate()
| int ast_rtp_codecs_payload_code_sample_rate | ( | struct ast_rtp_codecs * | codecs, |
| int | asterisk_format, | ||
| struct ast_format * | format, | ||
| int | code, | ||
| unsigned int | sample_rate | ||
| ) |
Retrieve a rx mapped payload type based on whether it is an Asterisk format, the code and the sample rate.
- Parameters
-
codecs Codecs structure to look in asterisk_format Non-zero if the given Asterisk format is present format Asterisk format to look for code The format to look for sample_rate Non-zero if we want to also match on sample rate.
Find the currently assigned rx mapped payload type based on whether it is an Asterisk format or non-format code. If one is currently not assigned then create a rx payload type mapping.
- Returns
- Numerical payload type
- Return values
-
-1 if could not assign.
Example usage:
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 2030 of file rtp_engine.c.
References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_payload_type::asterisk_format, codecs, ast_rtp_payload_type::format, ast_rtp_payload_type::payload, rtp_codecs_assign_payload_code_rx(), ast_rtp_payload_type::sample_rate, static_RTP_PT_lock, and type.
Referenced by ast_rtp_codecs_payload_code(), and create_outgoing_sdp_stream().
◆ ast_rtp_codecs_payload_code_tx()
| int ast_rtp_codecs_payload_code_tx | ( | struct ast_rtp_codecs * | codecs, |
| int | asterisk_format, | ||
| const struct ast_format * | format, | ||
| int | code | ||
| ) |
Retrieve a tx mapped payload type based on whether it is an Asterisk format and the code.
- Since
- 14.0.0
- Parameters
-
codecs Codecs structure to look in asterisk_format Non-zero if the given Asterisk format is present format Asterisk format to look for code The format to look for
- Returns
- Numerical payload type
- Return values
-
-1 if not found.
Definition at line 2152 of file rtp_engine.c.
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
-
codecs Codecs structure to look in asterisk_format Non-zero if the given Asterisk format is present format Asterisk format to look for code The format to look for sample_rate The sample rate to look for, zero if we don't care
- Returns
- Numerical payload type
- Return values
-
-1 if not found.
Definition at line 2091 of file rtp_engine.c.
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
-
codecs Codecs structure to look in astformats A capabilities structure to put the Asterisk formats in. nonastformats An integer to put the non-Asterisk formats in
Example usage:
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 1699 of file rtp_engine.c.
References ast_format_cap_append, ast_format_cap_remove_by_type(), ast_format_cap_set_framing(), AST_MEDIA_TYPE_UNKNOWN, ast_rwlock_rdlock, ast_rwlock_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, and type.
Referenced by jingle_interpret_description().
◆ ast_rtp_codecs_payload_replace_format()
| int ast_rtp_codecs_payload_replace_format | ( | struct ast_rtp_codecs * | codecs, |
| int | payload, | ||
| struct ast_format * | format | ||
| ) |
Update the format associated with a tx payload type in a codecs structure.
- Parameters
-
codecs Codecs structure to operate on payload Numerical payload type to look up format The format to replace the existing one
- Return values
-
0 success -1 failure
- Since
- 13
Definition at line 1622 of file rtp_engine.c.
References ao2_cleanup, ao2_ref, ast_rtp_engine_alloc_payload_type(), AST_RTP_MAX_PT, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_payload_type::format, ast_rtp_payload_type::payload, payload_mapping_tx_is_present(), and type.
Referenced by get_codecs().
◆ ast_rtp_codecs_payload_set_rx()
| int ast_rtp_codecs_payload_set_rx | ( | struct ast_rtp_codecs * | codecs, |
| int | code, | ||
| struct ast_format * | format | ||
| ) |
Set a payload code for use with a specific Asterisk format.
- Parameters
-
codecs Codecs structure to manipulate code The payload code format Asterisk format
- Return values
-
0 Payload was set to the given format -1 Payload was in use or could not be set
- Since
- 15.0.0
Definition at line 2081 of file rtp_engine.c.
References codecs, ast_rtp_payload_type::format, and rtp_codecs_assign_payload_code_rx().
Referenced by apply_cap_to_bundled(), and create_outgoing_sdp_stream().
◆ ast_rtp_codecs_payload_set_rx_sample_rate()
| int ast_rtp_codecs_payload_set_rx_sample_rate | ( | struct ast_rtp_codecs * | codecs, |
| int | code, | ||
| struct ast_format * | format, | ||
| unsigned int | sample_rate | ||
| ) |
Set a payload code with sample rate for use with a specific Asterisk format.
- Parameters
-
codecs Codecs structure to manipulate code The payload code format Asterisk format sample_rate Sample rate of the format, 0 to use the format's default
- Return values
-
0 Payload was set to the given format -1 Payload was in use or could not be set
- Since
- 22.0.0
Definition at line 2086 of file rtp_engine.c.
References codecs, ast_rtp_payload_type::format, rtp_codecs_assign_payload_code_rx(), and ast_rtp_payload_type::sample_rate.
◆ ast_rtp_codecs_payloads_clear()
| void ast_rtp_codecs_payloads_clear | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_rtp_instance * | instance | ||
| ) |
Clear rx and tx payload mapping information from an RTP instance.
- Parameters
-
codecs The codecs structure that payloads will be cleared from instance Optionally the instance that the codecs structure belongs to
Example usage:
This clears the codecs structure and puts it into a pristine state.
- Since
- 1.8
Definition at line 1025 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_codecs_payloads_destroy(), ast_rtp_codecs_payloads_initialize(), AST_RTP_MAX_PT, codecs, ast_rtp_instance::engine, NULL, and ast_rtp_engine::payload_set.
◆ ast_rtp_codecs_payloads_copy()
| void ast_rtp_codecs_payloads_copy | ( | struct ast_rtp_codecs * | src, |
| struct ast_rtp_codecs * | dest, | ||
| struct ast_rtp_instance * | instance | ||
| ) |
Copy payload information from one RTP instance to another.
- Parameters
-
src The source codecs structure dest The destination codecs structure that the values from src will be copied to instance Optionally the instance that the dst codecs structure belongs to
Example usage:
This copies the payloads from the codecs0 structure to the codecs1 structure, overwriting any current values.
- Since
- 1.8
Definition at line 1279 of file rtp_engine.c.
References ao2_replace, ao2_t_cleanup, ast_rwlock_tryrdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, ast_rtp_codecs::codecs_lock, ast_rtp_codecs::framing, NULL, ast_rtp_codecs::payload_mapping_tx, ast_rtp_codecs::preferred_dtmf_pt, ast_rtp_codecs::preferred_dtmf_rate, ast_rtp_codecs::preferred_format, rtp_codecs_payloads_copy_rx(), rtp_codecs_payloads_copy_tx(), and type.
Referenced by jingle_interpret_description(), set_caps(), and set_incoming_call_offer_cap().
◆ ast_rtp_codecs_payloads_destroy()
| void ast_rtp_codecs_payloads_destroy | ( | struct ast_rtp_codecs * | codecs | ) |
Destroy the contents of an RTP codecs structure (but not the structure itself)
- Parameters
-
codecs The codecs structure to destroy the contents of
Example usage:
- Since
- 11
Definition at line 1002 of file rtp_engine.c.
References ao2_t_cleanup, ast_rwlock_destroy, AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, codecs, NULL, and type.
Referenced by ast_rtp_codecs_payloads_clear(), ast_stream_free(), ast_stream_set_rtp_codecs(), instance_destructor(), jingle_interpret_description(), set_caps(), and set_incoming_call_offer_cap().
◆ ast_rtp_codecs_payloads_initialize()
| int ast_rtp_codecs_payloads_initialize | ( | struct ast_rtp_codecs * | codecs | ) |
Initialize an RTP codecs structure.
- Parameters
-
codecs The codecs structure to initialize
- Return values
-
0 success -1 failure
Example usage:
- Since
- 11
Definition at line 986 of file rtp_engine.c.
References AST_RTP_MAX_PT, ast_rwlock_init, AST_VECTOR_FREE, AST_VECTOR_INIT, and codecs.
Referenced by ast_rtp_codecs_payloads_clear(), ast_rtp_instance_new(), get_codecs(), and jingle_interpret_description().
◆ ast_rtp_codecs_payloads_set_m_type()
| void ast_rtp_codecs_payloads_set_m_type | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_rtp_instance * | instance, | ||
| int | payload | ||
| ) |
Record tx payload type information that was seen in an m= SDP line.
- Parameters
-
codecs The codecs structure to muck with instance Optionally the instance that the codecs structure belongs to payload Numerical payload that was seen in the m= SDP line
Example usage:
This records that the numerical payload '0' was seen in the codecs structure.
- Since
- 1.8
Definition at line 1362 of file rtp_engine.c.
References ao2_bump, ao2_lock, ao2_ref, ao2_t_cleanup, ao2_unlock, ast_debug, AST_RTP_MAX_PT, AST_RTP_PT_LAST_STATIC, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_instance::engine, 10aedae86a32_add_outgoing_enum_va::new_type, ast_rtp_payload_type::payload, payload_mapping_tx_is_present(), ast_rtp_engine::payload_set, static_RTP_PT, and static_RTP_PT_lock.
Referenced by get_codecs().
◆ ast_rtp_codecs_payloads_set_rtpmap_type()
| int ast_rtp_codecs_payloads_set_rtpmap_type | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_rtp_instance * | instance, | ||
| int | payload, | ||
| char * | mimetype, | ||
| char * | mimesubtype, | ||
| enum ast_rtp_options | options | ||
| ) |
Record tx payload type information that was seen in an a=rtpmap: SDP line.
- Parameters
-
codecs The codecs structure to muck with instance Optionally the instance that the codecs structure belongs to payload Numerical payload that was seen in the a=rtpmap: SDP line mimetype The string mime type that was seen mimesubtype The string mime sub type that was seen options Optional options that may change the behavior of this specific payload
- Return values
-
0 success -1 failure, invalid payload numbe -2 failure, unknown mimetype
Example usage:
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 1490 of file rtp_engine.c.
References ast_rtp_codecs_payloads_set_rtpmap_type_rate(), codecs, options, and ast_rtp_payload_type::payload.
Referenced by configure_local_rtp(), jingle_interpret_description(), ooh323_set_write_format(), and setup_rtp_connection().
◆ ast_rtp_codecs_payloads_set_rtpmap_type_rate()
| int ast_rtp_codecs_payloads_set_rtpmap_type_rate | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_rtp_instance * | instance, | ||
| int | pt, | ||
| char * | mimetype, | ||
| char * | mimesubtype, | ||
| enum ast_rtp_options | options, | ||
| unsigned int | sample_rate | ||
| ) |
Set tx payload type to a known MIME media type for a codec with a specific sample rate.
- Parameters
-
codecs RTP structure to modify instance Optionally the instance that the codecs structure belongs to pt Payload type entry to modify mimetype top-level MIME type of media stream (typically "audio", "video", "text", etc.) mimesubtype MIME subtype of media stream (typically a codec name) options Zero or more flags from the ast_rtp_options enum sample_rate The sample rate of the media stream
This function 'fills in' an entry in the list of possible formats for a media stream associated with an RTP structure.
- Return values
-
0 on success -1 if the payload type is out of range -2 if the mimeType/mimeSubtype combination was not found
- Since
- 1.8
Definition at line 1404 of file rtp_engine.c.
References ao2_lock, ao2_ref, ao2_t_cleanup, ao2_unlock, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_g726, ast_format_g726_aal2, ast_format_parse_sdp_fmtp(), ast_rtp_engine_alloc_payload_type(), AST_RTP_MAX_PT, ast_rtp_mime_types, AST_RTP_OPT_G726_NONSTANDARD, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, ast_rtp_payload_type::asterisk_format, codecs, ast_rtp_instance::engine, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, 10aedae86a32_add_outgoing_enum_va::new_type, options, payload_mapping_tx_is_present(), ast_rtp_engine::payload_set, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, ast_rtp_payload_type::sample_rate, ast_rtp_mime_type::sample_rate, ast_rtp_mime_type::subtype, and ast_rtp_mime_type::type.
Referenced by ast_rtp_codecs_payloads_set_rtpmap_type(), get_codecs(), and jingle_interpret_description().
◆ ast_rtp_codecs_payloads_unset()
| void ast_rtp_codecs_payloads_unset | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_rtp_instance * | instance, | ||
| int | payload | ||
| ) |
Remove tx payload type mapped information.
- Parameters
-
codecs The codecs structure to muck with instance Optionally the instance that the codecs structure belongs to payload Numerical payload to unset
Example usage:
This clears the payload '0' from the codecs structure. It will be as if it was never set.
- Since
- 1.8
Definition at line 1495 of file rtp_engine.c.
References ao2_lock, ao2_ref, ao2_replace, ao2_unlock, ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_RTP_MAX_PT, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, codecs, ast_rtp_instance::engine, NULL, ast_rtp_payload_type::payload, ast_rtp_engine::payload_set, and type.
◆ ast_rtp_codecs_payloads_xover()
| void ast_rtp_codecs_payloads_xover | ( | struct ast_rtp_codecs * | src, |
| struct ast_rtp_codecs * | dest, | ||
| struct ast_rtp_instance * | instance | ||
| ) |
Crossover copy the tx payload mapping of src to the rx payload mapping of dest.
- Since
- 14.0.0
- Parameters
-
src The source codecs structure dest The destination codecs structure that the values from src will be copied to instance Optionally the instance that the dst codecs structure belongs to
Definition at line 1315 of file rtp_engine.c.
References ao2_lock, ao2_replace, ao2_unlock, ast_assert, ast_debug, ast_rwlock_tryrdlock, ast_rwlock_unlock, ast_rwlock_wrlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_codecs::codecs_lock, ast_rtp_instance::engine, ast_rtp_codecs::framing, ast_rtp_codecs::payload_mapping_tx, ast_rtp_engine::payload_set, ast_rtp_codecs::preferred_dtmf_pt, ast_rtp_codecs::preferred_dtmf_rate, ast_rtp_codecs::preferred_format, rtp_codecs_payload_replace_rx(), and type.
Referenced by ast_rtp_instance_early_bridge_make_compatible(), set_caps(), and set_incoming_call_offer_cap().
◆ ast_rtp_codecs_set_framing()
| void ast_rtp_codecs_set_framing | ( | struct ast_rtp_codecs * | codecs, |
| unsigned int | framing | ||
| ) |
Set the framing used for a set of codecs.
- Parameters
-
codecs Codecs structure to set framing on framing The framing value to set on the codecs
- Since
- 13.0.0
Definition at line 1677 of file rtp_engine.c.
References ast_rwlock_unlock, ast_rwlock_wrlock, and codecs.
Referenced by configure_local_rtp(), get_codecs(), jingle_enable_video(), and jingle_new().
◆ ast_rtp_codecs_set_preferred_dtmf_format()
| int ast_rtp_codecs_set_preferred_dtmf_format | ( | struct ast_rtp_codecs * | codecs, |
| int | pt, | ||
| int | rate | ||
| ) |
Set the preferred dtmf format pt and sample rate.
- Parameters
-
codecs Codecs structure to set the preferred format in pt Preferred dtmf payload type to set. rate Preferred dtmf payload rate to set.
- Returns
- 0
- Note
- The format passed this function has its reference count increased. If an existing format is set, that format is replaced.
Example usage:
This sets the preferred dtmf_code and dtmf_rate on the codec.
Definition at line 1613 of file rtp_engine.c.
References ast_rwlock_unlock, ast_rwlock_wrlock, and codecs.
Referenced by get_codecs().
◆ ast_rtp_codecs_set_preferred_format()
| int ast_rtp_codecs_set_preferred_format | ( | struct ast_rtp_codecs * | codecs, |
| struct ast_format * | format | ||
| ) |
Set the preferred format.
- Parameters
-
codecs Codecs structure to set the preferred format in format Preferred format to set.
- Returns
- 0
- Note
- The format passed this function has its reference count increased. If an existing format is set, that format is replaced.
Example usage:
This sets the first joint format as the preferred format.
Definition at line 1587 of file rtp_engine.c.
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 4195 of file rtp_engine.c.
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_cfg source DTLS configuration structure dst_cfg destination DTLS configuration structure
Definition at line 3319 of file rtp_engine.c.
References ast_rtp_dtls_cfg_free(), ast_strdup, ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::cipher, ast_rtp_dtls_cfg::default_setup, ast_rtp_dtls_cfg::enabled, ast_rtp_dtls_cfg::ephemeral_cert, ast_rtp_dtls_cfg::hash, ast_rtp_dtls_cfg::pvtfile, ast_rtp_dtls_cfg::rekey, ast_rtp_dtls_cfg::suite, and ast_rtp_dtls_cfg::verify.
◆ ast_rtp_dtls_cfg_free()
| void ast_rtp_dtls_cfg_free | ( | struct ast_rtp_dtls_cfg * | dtls_cfg | ) |
Free contents of a DTLS configuration structure.
- Parameters
-
dtls_cfg a DTLS configuration structure
Definition at line 3337 of file rtp_engine.c.
References ast_free, ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::cipher, NULL, and ast_rtp_dtls_cfg::pvtfile.
Referenced by ast_rtp_dtls_cfg_copy(), and media_configuration_destroy().
◆ ast_rtp_dtls_cfg_parse()
| int ast_rtp_dtls_cfg_parse | ( | struct ast_rtp_dtls_cfg * | dtls_cfg, |
| const char * | name, | ||
| const char * | value | ||
| ) |
Parse DTLS related configuration options.
- Parameters
-
dtls_cfg a DTLS configuration structure name name of the configuration option value value of the configuration option
- Return values
-
0 if handled -1 if not handled
Definition at line 3226 of file rtp_engine.c.
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_cfg a DTLS configuration structure
- Return values
-
0 if valid -1 if invalid
Definition at line 3300 of file rtp_engine.c.
References ast_log, ast_strlen_zero(), ast_rtp_dtls_cfg::cafile, ast_rtp_dtls_cfg::capath, ast_rtp_dtls_cfg::certfile, ast_rtp_dtls_cfg::ephemeral_cert, LOG_ERROR, LOG_NOTICE, and ast_rtp_dtls_cfg::pvtfile.
Referenced by sip_endpoint_apply_handler().
◆ ast_rtp_engine_alloc_payload_type()
| struct ast_rtp_payload_type * ast_rtp_engine_alloc_payload_type | ( | void | ) |
Allocation routine for ast_rtp_payload_type.
- Return values
-
NULL on error
- Returns
- An ao2 ref counted
ast_rtp_payload_typeon success.
- Note
- The
ast_rtp_payload_typereturned by this function is an ao2 ref counted object.
Definition at line 331 of file rtp_engine.c.
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 3435 of file rtp_engine.c.
References add_static_payload(), ast_codec_media_type2str(), ast_format_get_codec_name(), ast_format_get_sample_rate(), ast_format_get_type(), ast_str_to_upper(), ast_strdupa, ast_rtp_payload_type::format, and set_next_mime_type().
Referenced by load_module().
◆ ast_rtp_engine_register2()
| int ast_rtp_engine_register2 | ( | struct ast_rtp_engine * | engine, |
| struct ast_module * | module | ||
| ) |
Register an RTP engine.
- Parameters
-
engine Structure of the RTP engine to register module Module that the RTP engine is part of
- Return values
-
0 success -1 failure
Example usage:
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 336 of file rtp_engine.c.
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 2916 of file rtp_engine.c.
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 2937 of file rtp_engine.c.
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 3451 of file rtp_engine.c.
References ao2_ref, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_RTP_MAX_PT, ast_rtp_mime_types, ast_rwlock_unlock, ast_rwlock_wrlock, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, NULL, rtp_engine_mime_type_cleanup(), static_RTP_PT, and static_RTP_PT_lock.
Referenced by unload_module().
◆ ast_rtp_engine_unregister()
| int ast_rtp_engine_unregister | ( | struct ast_rtp_engine * | engine | ) |
Unregister an RTP engine.
- Parameters
-
engine Structure of the RTP engine to unregister
- Return values
-
0 success -1 failure
Example usage:
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 370 of file rtp_engine.c.
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 2931 of file rtp_engine.c.
References NULL, res_srtp, and res_srtp_policy.
Referenced by res_srtp_shutdown().
◆ ast_rtp_get_rate()
| int ast_rtp_get_rate | ( | const struct ast_format * | format | ) |
Retrieve the sample rate of a format according to RTP specifications.
- Since
- 16.7.0
- 17.1.0
- Parameters
-
format The media format
- Returns
- The sample rate
Definition at line 4282 of file rtp_engine.c.
References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_g722, and ast_format_get_sample_rate().
Referenced by ast_rtcp_calculate_sr_rr_statistics(), ast_rtcp_interpret(), ast_rtp_dtmf_end_with_duration(), ast_rtp_interpret(), calc_rxstamp_and_jitter(), jitterbuffer_frame_get_ntp_timestamp(), process_dtmf_cisco(), process_dtmf_rfc2833(), rtp_raw_write(), and update_jitter_stats().
◆ ast_rtp_glue_register2()
| int ast_rtp_glue_register2 | ( | struct ast_rtp_glue * | glue, |
| struct ast_module * | module | ||
| ) |
Register RTP glue.
- Parameters
-
glue The glue to register module Module that the RTP glue is part of
- Return values
-
0 success -1 failure
Example usage:
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 385 of file rtp_engine.c.
References ast_log, AST_RWLIST_INSERT_TAIL, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), ast_verb, LOG_WARNING, ast_rtp_glue::mod, NULL, and ast_rtp_glue::type.
◆ ast_rtp_glue_unregister()
| int ast_rtp_glue_unregister | ( | struct ast_rtp_glue * | glue | ) |
Unregister RTP glue.
- Parameters
-
glue The glue to unregister
- Return values
-
0 success -1 failure
Example usage:
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 414 of file rtp_engine.c.
References AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, NULL, and ast_rtp_glue::type.
Referenced by load_module(), and unload_module().
◆ ast_rtp_instance_activate()
| int ast_rtp_instance_activate | ( | struct ast_rtp_instance * | instance | ) |
Indicate to the RTP engine that packets are now expected to be sent/received on the RTP instance.
- Parameters
-
instance The RTP instance
- Return values
-
0 success -1 failure
Example usage:
This tells the underlying RTP engine of instance that packets will now flow.
- Since
- 1.8
Definition at line 2853 of file rtp_engine.c.
References ast_rtp_engine::activate, ao2_lock, ao2_unlock, and ast_rtp_instance::engine.
Referenced by apply_negotiated_sdp_stream(), rtp_call(), and test_init_rtp_instances().
◆ ast_rtp_instance_add_srtp_policy()
| int ast_rtp_instance_add_srtp_policy | ( | struct ast_rtp_instance * | instance, |
| struct ast_srtp_policy * | remote_policy, | ||
| struct ast_srtp_policy * | local_policy, | ||
| int | rtcp | ||
| ) |
Add or replace the SRTP policies for the given RTP instance.
- Parameters
-
instance the RTP instance remote_policy the remote endpoint's policy local_policy our policy for this RTP instance's remote endpoint rtcp 1 for dedicated RTCP policies
- Return values
-
0 Success non-zero Failure
- Note
- If no remote policy is provided any existing SRTP policies are left and the new local policy is added
Definition at line 2942 of file rtp_engine.c.
References ast_srtp_res::add_stream, ao2_lock, ao2_unlock, ast_srtp_res::create, ast_srtp_res::replace, res_srtp, ast_rtp_instance::rtcp_srtp, and ast_rtp_instance::srtp.
Referenced by crypto_activate().
◆ ast_rtp_instance_available_formats()
| void ast_rtp_instance_available_formats | ( | struct ast_rtp_instance * | instance, |
| struct ast_format_cap * | to_endpoint, | ||
| struct ast_format_cap * | to_asterisk, | ||
| struct ast_format_cap * | result | ||
| ) |
Request the formats that can be transcoded.
- Parameters
-
instance The RTP instance to_endpoint Formats being sent/received towards the endpoint to_asterisk Formats being sent/received towards Asterisk result capabilities structure to store and return supported formats in.
Example usage:
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 2839 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_format_cap_count(), ast_translate_available_formats(), ast_rtp_engine::available_formats, ast_rtp_instance::engine, and result.
◆ ast_rtp_instance_bundle()
| int ast_rtp_instance_bundle | ( | struct ast_rtp_instance * | child, |
| struct ast_rtp_instance * | parent | ||
| ) |
Request that an RTP instance be bundled with another.
- Since
- 15.0.0
- Parameters
-
child The child RTP instance parent The parent RTP instance the child should be bundled with
- Return values
-
0 success -1 failure
Definition at line 4043 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_engine::bundle, and ast_rtp_instance::engine.
Referenced by apply_negotiated_sdp_stream(), and negotiate_incoming_sdp_stream().
◆ ast_rtp_instance_change_source()
| void ast_rtp_instance_change_source | ( | struct ast_rtp_instance * | instance | ) |
Indicate a new source of audio has dropped in and the ssrc should change.
- Parameters
-
instance Instance that the new media source is feeding into
Example usage:
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 2342 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_engine::change_source, and ast_rtp_instance::engine.
Referenced by chan_pjsip_indicate(), create_outgoing_sdp_stream(), jingle_indicate(), ooh323_indicate(), and unistim_indicate().
◆ ast_rtp_instance_destroy()
| int ast_rtp_instance_destroy | ( | struct ast_rtp_instance * | instance | ) |
Destroy an RTP instance.
- Parameters
-
instance The RTP instance to destroy
- Return values
-
0 success -1 failure
Example usage:
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 464 of file rtp_engine.c.
References ao2_cleanup, ast_debug_rtp, ast_debug_rtp_is_allowed, ast_rtp_instance_get_quality(), AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, and ast_rtp_instance::channel_uniqueid.
Referenced by AST_TEST_DEFINE(), jingle_session_destructor(), multicast_rtp_request(), ooh323_destroy(), rtp_hangup(), stream_destroy(), unicast_rtp_request(), and unistim_hangup_clean().
◆ ast_rtp_instance_dtmf_begin()
| int ast_rtp_instance_dtmf_begin | ( | struct ast_rtp_instance * | instance, |
| char | digit | ||
| ) |
Begin sending a DTMF digit.
- Parameters
-
instance The RTP instance to send the DTMF on digit What DTMF digit to send
- Return values
-
0 success -1 failure
Example usage:
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 2263 of file rtp_engine.c.
References ao2_lock, ao2_unlock, digit, ast_rtp_engine::dtmf_begin, and ast_rtp_instance::engine.
Referenced by chan_pjsip_digit_begin(), jingle_digit_begin(), and ooh323_digit_begin().
◆ ast_rtp_instance_dtmf_end()
| int ast_rtp_instance_dtmf_end | ( | struct ast_rtp_instance * | instance, |
| char | digit | ||
| ) |
Stop sending a DTMF digit.
- Parameters
-
instance The RTP instance to stop the DTMF on digit What DTMF digit to stop
- Return values
-
0 success -1 failure
Example usage:
This stops sending the DTMF '1' on the RTP instance pointed to by instance.
- Since
- 1.8
Definition at line 2277 of file rtp_engine.c.
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 2291 of file rtp_engine.c.
References ao2_lock, ao2_unlock, digit, ast_rtp_engine::dtmf_end_with_duration, and ast_rtp_instance::engine.
Referenced by chan_pjsip_digit_end(), and jingle_digit_end().
◆ ast_rtp_instance_dtmf_mode_get()
| enum ast_rtp_dtmf_mode ast_rtp_instance_dtmf_mode_get | ( | struct ast_rtp_instance * | instance | ) |
Get the DTMF mode of an RTP instance.
- Parameters
-
instance The RTP instance to get the DTMF mode of
- Returns
- DTMF mode
Example usage:
This gets the DTMF mode set on the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2319 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_engine::dtmf_mode_get, and ast_rtp_instance::engine.
Referenced by chan_pjsip_digit_begin(), chan_pjsip_digit_end(), native_rtp_bridge_compatible_check(), pjsip_acf_dtmf_mode_write(), and set_caps().
◆ ast_rtp_instance_dtmf_mode_set()
| int ast_rtp_instance_dtmf_mode_set | ( | struct ast_rtp_instance * | instance, |
| enum ast_rtp_dtmf_mode | dtmf_mode | ||
| ) |
Set the DTMF mode that should be used.
- Parameters
-
instance the RTP instance to set DTMF mode on dtmf_mode The DTMF mode that is in use
- Return values
-
0 success -1 failure
Example usage:
This sets the RTP instance to use RFC2833 for DTMF transmission and receiving.
- Since
- 1.8
Definition at line 2305 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_engine::dtmf_mode_set, and ast_rtp_instance::engine.
Referenced by create_rtp(), get_codecs(), and pjsip_acf_dtmf_mode_write().
◆ ast_rtp_instance_early_bridge()
| int ast_rtp_instance_early_bridge | ( | struct ast_channel * | c0, |
| struct ast_channel * | c1 | ||
| ) |
Early bridge two channels that use RTP instances.
- Parameters
-
c0 First channel part of the bridge c1 Second channel part of the bridge
- Return values
-
0 success -1 failure
- Note
- This should only be used by channel drivers in their technology declaration.
- Since
- 1.8
Definition at line 2519 of file rtp_engine.c.
References ao2_cleanup, ast_channel_lock_both, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, ast_debug, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_iscompatible(), ast_log, AST_RTP_GLUE_RESULT_FORBID, AST_RTP_GLUE_RESULT_REMOTE, ast_rtp_instance_get_glue(), done, ast_rtp_glue::get_codec, ast_rtp_glue::get_rtp_info, ast_rtp_glue::get_vrtp_info, LOG_WARNING, NULL, type, unref_instance_cond(), and ast_rtp_glue::update_peer.
◆ ast_rtp_instance_early_bridge_make_compatible()
| void ast_rtp_instance_early_bridge_make_compatible | ( | struct ast_channel * | c_dst, |
| struct ast_channel * | c_src | ||
| ) |
Make two channels compatible for early bridging.
- Parameters
-
c_dst Destination channel to copy to c_src Source channel to copy from
- Since
- 1.8
Definition at line 2433 of file rtp_engine.c.
References ao2_cleanup, ast_channel_lock_both, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, ast_debug, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_iscompatible(), ast_log, ast_rtp_codecs_payloads_xover(), AST_RTP_GLUE_RESULT_FORBID, AST_RTP_GLUE_RESULT_REMOTE, ast_rtp_instance_get_glue(), ast_rtp_instance::codecs, done, ast_rtp_glue::get_codec, ast_rtp_glue::get_rtp_info, ast_rtp_glue::get_vrtp_info, LOG_WARNING, NULL, type, unref_instance_cond(), and ast_rtp_glue::update_peer.
Referenced by dial_exec_full(), and do_forward().
◆ ast_rtp_instance_extmap_clear()
| void ast_rtp_instance_extmap_clear | ( | struct ast_rtp_instance * | instance | ) |
Clear negotiated RTP extension information.
- Parameters
-
instance The RTP instance to clear negotiated extension information on
Definition at line 890 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::extension, ast_rtp_instance::extmap_negotiated, and ast_rtp_instance::extmap_unique_ids.
Referenced by process_extmap_attributes().
◆ ast_rtp_instance_extmap_count()
| size_t ast_rtp_instance_extmap_count | ( | struct ast_rtp_instance * | instance | ) |
Get the number of known unique identifiers.
- Parameters
-
instance The RTP instance to retrieve the count from
- Returns
- the number of known unique identifiers
- Since
- 15.5.0
Definition at line 927 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_VECTOR_SIZE, and ast_rtp_instance::extmap_unique_ids.
Referenced by add_extmap_to_stream(), and enable_rtp_extension().
◆ ast_rtp_instance_extmap_enable()
| int ast_rtp_instance_extmap_enable | ( | struct ast_rtp_instance * | instance, |
| int | id, | ||
| enum ast_rtp_extension | extension, | ||
| enum ast_rtp_extension_direction | direction | ||
| ) |
Enable support for an RTP extension on an instance.
- Parameters
-
instance The RTP instance to enable the extension on id The unique local identifier to use for this extension (-1 to have one auto selected) extension The RTP extension direction The initial direction that the RTP extension should be used in
- Return values
-
0 success -1 failure
- Since
- 15.5.0
Definition at line 760 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_APPEND, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::direction, ast_rtp_instance::engine, rtp_extmap::extension, ast_rtp_engine::extension_enable, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, and ast_rtp_instance::extmap_unique_ids.
Referenced by enable_rtp_extension().
◆ ast_rtp_instance_extmap_get_direction()
| enum ast_rtp_extension_direction ast_rtp_instance_extmap_get_direction | ( | struct ast_rtp_instance * | instance, |
| int | id | ||
| ) |
Retrieve the negotiated direction for an RTP extension id.
- Parameters
-
instance The RTP instance to retrieve the direction from id The negotiated RTP extension id
- Returns
- direction the direction that has been negotiated
- Since
- 15.5.0
Definition at line 958 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_DIRECTION_NONE, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, rtp_extmap::direction, and ast_rtp_instance::extmap_unique_ids.
Referenced by add_extmap_to_stream().
◆ ast_rtp_instance_extmap_get_extension()
| enum ast_rtp_extension ast_rtp_instance_extmap_get_extension | ( | struct ast_rtp_instance * | instance, |
| int | id | ||
| ) |
Retrieve the extension for an RTP extension id.
- Parameters
-
instance The RTP instance to retrieve the extension from id The negotiated RTP extension id
- Returns
- extension the extension that maps to the id
- Since
- 15.5.0
- Note
- This will return AST_RTP_EXTENSION_UNSUPPORTED if an extension was proposed for this unique identifier but it is not supported or if the unique identifier is unused.
Definition at line 938 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_GET_ADDR, AST_VECTOR_SIZE, rtp_extmap::extension, and ast_rtp_instance::extmap_unique_ids.
Referenced by add_extmap_to_stream(), and ast_rtp_instance_extmap_get_uri().
◆ ast_rtp_instance_extmap_get_id()
| int ast_rtp_instance_extmap_get_id | ( | struct ast_rtp_instance * | instance, |
| enum ast_rtp_extension | extension | ||
| ) |
Retrieve the id for an RTP extension.
- Parameters
-
instance The RTP instance to retrieve the id from extension The RTP extension
- Return values
-
-1 not negotiated id if negotiated
- Since
- 15.5.0
Definition at line 914 of file rtp_engine.c.
References ao2_lock, ao2_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_rtp_instance::extmap_negotiated, and id.
Referenced by ast_rtp_rtcp_handle_nack(), enable_rtp_extension(), rtp_instance_parse_extmap_extensions(), and rtp_raw_write().
◆ ast_rtp_instance_extmap_get_uri()
| const char * ast_rtp_instance_extmap_get_uri | ( | struct ast_rtp_instance * | instance, |
| int | id | ||
| ) |
Retrieve the URI for an RTP extension id.
- Parameters
-
instance The RTP instance to retrieve the direction from id The negotiated RTP extension id
- Returns
- The URI for the RTP extension
- Since
- 15.5.0
Definition at line 974 of file rtp_engine.c.
References ARRAY_LEN, AST_RTP_EXTENSION_UNSUPPORTED, ast_rtp_instance_extmap_get_extension(), rtp_extmap::extension, NULL, and rtp_extension_uris.
Referenced by add_extmap_to_stream().
◆ ast_rtp_instance_extmap_negotiate()
| int ast_rtp_instance_extmap_negotiate | ( | struct ast_rtp_instance * | instance, |
| int | id, | ||
| enum ast_rtp_extension_direction | direction, | ||
| const char * | uri, | ||
| const char * | attributes | ||
| ) |
Negotiate received RTP extension information.
- Parameters
-
instance The RTP instance to set the extension on id The local identifier for the extension direction The direction that the extension should be used in uri The unique URI for the extension attributes Attributes specific to this extension (if NULL or empty then no attributes)
- Return values
-
0 success -1 failure
- Since
- 15.5.0
Definition at line 846 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ARRAY_LEN, AST_RTP_EXTENSION_DIRECTION_NONE, AST_RTP_EXTENSION_UNSUPPORTED, AST_VECTOR_GET, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, rtp_extmap::direction, rtp_extmap::extension, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, ast_rtp_instance::extmap_unique_ids, rtp_extension_uris, and rtp_extmap_negotiate_direction().
Referenced by process_extmap_attributes().
◆ ast_rtp_instance_fd()
| int ast_rtp_instance_fd | ( | struct ast_rtp_instance * | instance, |
| int | rtcp | ||
| ) |
Get the file descriptor for an RTP session (or RTCP)
- Parameters
-
instance Instance to get the file descriptor for rtcp Whether to retrieve the file descriptor for RTCP or not
- Return values
-
fd success -1 failure
Example usage:
This retrieves the file descriptor for the socket carrying media on the instance pointed to by instance.
- Since
- 1.8
Definition at line 2374 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::fd.
Referenced by apply_negotiated_sdp_stream(), check_for_rtp_changes(), configure_local_rtp(), jingle_enable_video(), jingle_new(), rtp_find_rtcp_fd_position(), start_rtp(), unicast_rtp_request(), and unistim_new().
◆ ast_rtp_instance_get_active_glue()
| struct ast_rtp_glue * ast_rtp_instance_get_active_glue | ( | struct ast_rtp_instance * | instance | ) |
Get the RTP glue in use on an RTP instance.
- Parameters
-
instance The RTP instance
- Returns
- pointer to the glue
Example:
This gets the RTP glue currently in use on the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2911 of file rtp_engine.c.
References ast_rtp_instance::glue.
◆ ast_rtp_instance_get_and_cmp_local_address()
| int ast_rtp_instance_get_and_cmp_local_address | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | address | ||
| ) |
Get the address of the local endpoint that we are sending RTP to, comparing its address to another.
- Parameters
-
instance The instance that we want to get the local address for address An initialized address that may be overwritten if the local address is different
- Return values
-
0 address was not changed 1 address was changed Example usage:
This retrieves the current local address set on the instance pointed to by instance and puts the value into the address structure.
- Since
- 1.8
Definition at line 657 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_cmp(), ast_sockaddr_copy(), and ast_rtp_instance::local_address.
◆ ast_rtp_instance_get_and_cmp_requested_target_address()
| int ast_rtp_instance_get_and_cmp_requested_target_address | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | address | ||
| ) |
Get the requested target address of the remote endpoint and compare it to the given address.
- Parameters
-
instance The instance that we want to get the remote address for address An initialized address that may be overwritten addresses differ
- Return values
-
0 address was not changed 1 address was changed
Definition at line 679 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_cmp(), ast_sockaddr_copy(), and ast_rtp_instance::requested_target_address.
◆ ast_rtp_instance_get_bridged()
| struct ast_rtp_instance * ast_rtp_instance_get_bridged | ( | struct ast_rtp_instance * | instance | ) |
Get the other RTP instance that an instance is bridged to.
- Parameters
-
instance The RTP instance that we want
- Return values
-
non-NULL success NULL failure
Example usage:
This gets the RTP instance that instance0 is bridged to.
- Since
- 1.8
Definition at line 2416 of file rtp_engine.c.
References ao2_lock, ao2_unlock, and ast_rtp_instance::bridged.
Referenced by ast_rtp_interpret().
◆ ast_rtp_instance_get_channel_id()
| const char * ast_rtp_instance_get_channel_id | ( | struct ast_rtp_instance * | instance | ) |
Get the unique ID of the channel that owns this RTP instance.
Note that this should remain valid for the lifetime of the RTP instance.
- Parameters
-
instance The RTP instance
- Returns
- The unique ID of the channel
- Return values
-
Empty string if no channel owns this RTP instance
- Since
- 12
Definition at line 576 of file rtp_engine.c.
References ast_rtp_instance::channel_uniqueid.
Referenced by __rtp_recvfrom(), ast_rtcp_interpret(), ast_rtp_get_stat(), ast_rtp_prop_set(), ast_rtp_stop(), ast_rtp_write(), calc_rxstamp_and_jitter(), rtp_check_timeout(), rtp_raw_write(), rtp_transport_wide_cc_feedback_produce(), update_local_mes_stats(), and update_reported_mes_stats().
◆ ast_rtp_instance_get_cname()
| const char * ast_rtp_instance_get_cname | ( | struct ast_rtp_instance * | rtp | ) |
Retrieve the CNAME used in RTCP SDES items.
This is a pointer directly into the RTP struct, not a copy.
- Parameters
-
rtp The RTP instance
- Returns
- the CNAME
Definition at line 4030 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_engine::cname_get, and ast_rtp_instance::engine.
Referenced by add_ssrc_to_stream().
◆ ast_rtp_instance_get_codecs()
| struct ast_rtp_codecs * ast_rtp_instance_get_codecs | ( | struct ast_rtp_instance * | instance | ) |
Get the codecs structure of an RTP instance.
- Parameters
-
instance The RTP instance to get the codecs structure from
Example usage:
This gets the codecs structure on the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 755 of file rtp_engine.c.
References ast_rtp_instance::codecs.
Referenced by apply_cap_to_bundled(), ast_rtp_dtmf_begin(), ast_rtp_interpret(), ast_rtp_read(), ast_rtp_sendcng(), ast_rtp_write(), bridge_p2p_rtp_write(), configure_local_rtp(), create_outgoing_sdp_stream(), jingle_add_payloads_to_description(), jingle_enable_video(), jingle_interpret_description(), jingle_new(), multicast_rtp_write(), native_rtp_bridge_compatible_check(), ooh323_set_write_format(), send_start_rtp(), set_caps(), set_incoming_call_offer_cap(), and setup_rtp_connection().
◆ ast_rtp_instance_get_data()
| void * ast_rtp_instance_get_data | ( | struct ast_rtp_instance * | instance | ) |
Get the data portion of an RTP instance.
- Parameters
-
instance The RTP instance we want the data portion from
Example usage:
This gets the data pointer on the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 591 of file rtp_engine.c.
References ast_rtp_instance::data.
Referenced by __rtp_recvfrom(), __rtp_sendto(), ast_rtcp_calculate_sr_rr_statistics(), ast_rtcp_generate_nack(), ast_rtcp_generate_report(), ast_rtcp_generate_sdes(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtcp_write(), ast_rtp_bundle(), ast_rtp_change_source(), ast_rtp_destroy(), ast_rtp_dtmf_begin(), ast_rtp_dtmf_continuation(), ast_rtp_dtmf_end_with_duration(), ast_rtp_dtmf_mode_get(), ast_rtp_dtmf_mode_set(), ast_rtp_fd(), ast_rtp_get_cname(), ast_rtp_get_ssrc(), ast_rtp_get_stat(), ast_rtp_interpret(), ast_rtp_local_bridge(), ast_rtp_prop_set(), ast_rtp_qos_set(), ast_rtp_read(), ast_rtp_remote_address_set(), ast_rtp_rtcp_handle_nack(), ast_rtp_sendcng(), ast_rtp_set_remote_ssrc(), ast_rtp_set_stream_num(), ast_rtp_stop(), ast_rtp_stun_request(), ast_rtp_update_source(), ast_rtp_write(), bridge_p2p_rtp_write(), create_dtmf_frame(), multicast_rtp_activate(), multicast_rtp_destroy(), multicast_rtp_write(), process_cn_rfc3389(), process_dtmf_cisco(), process_dtmf_rfc2833(), red_write(), rtp_instance_parse_transport_wide_cc(), rtp_raw_write(), rtp_red_buffer(), rtp_red_init(), rtp_sendto(), and rtp_transport_wide_cc_feedback_produce().
◆ ast_rtp_instance_get_dtls()
| struct ast_rtp_engine_dtls * ast_rtp_instance_get_dtls | ( | struct ast_rtp_instance * | instance | ) |
Obtain a pointer to the DTLS support present on an RTP instance.
- Parameters
-
instance the RTP instance
- Returns
- DTLS support if present
- Return values
-
NULL if no DTLS support available
Definition at line 3217 of file rtp_engine.c.
References ast_rtp_engine::dtls, ast_rtp_instance::engine, NULL, and rtp_dtls_wrappers.
Referenced by add_crypto_to_stream(), add_fingerprints_if_present(), apply_dtls_attrib(), ast_sdp_get_rtp_profile(), and setup_dtls_srtp().
◆ ast_rtp_instance_get_engine()
| struct ast_rtp_engine * ast_rtp_instance_get_engine | ( | struct ast_rtp_instance * | instance | ) |
Get the RTP engine in use on an RTP instance.
- Parameters
-
instance The RTP instance
- Returns
- pointer to the engine
Example usage:
This gets the RTP engine currently in use on the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2906 of file rtp_engine.c.
References ast_rtp_instance::engine.
Referenced by native_rtp_bridge_compatible_check(), native_rtp_bridge_start(), and native_rtp_bridge_stop().
◆ ast_rtp_instance_get_extended_prop()
| void * ast_rtp_instance_get_extended_prop | ( | struct ast_rtp_instance * | instance, |
| int | property | ||
| ) |
Get the value of an RTP instance extended property.
- Parameters
-
instance The RTP instance to get the extended property on property The extended property to get
- Since
- 1.8
Definition at line 718 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::extended_prop_get, and NULL.
◆ ast_rtp_instance_get_glue()
| struct ast_rtp_glue * ast_rtp_instance_get_glue | ( | const char * | type | ) |
Get the RTP glue that binds a channel to the RTP engine.
- Parameters
-
type Name of the glue we want
- Return values
-
non-NULL success NULL failure
Example usage:
This retrieves the RTP glue that has the name 'Example'.
- Since
- 1.8
Definition at line 2388 of file rtp_engine.c.
References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, NULL, type, and ast_rtp_glue::type.
Referenced by ast_ari_channels_rtpstatistics(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_rtp_instance_make_compatible(), and rtp_glue_data_get().
◆ ast_rtp_instance_get_hold_timeout()
| int ast_rtp_instance_get_hold_timeout | ( | struct ast_rtp_instance * | instance | ) |
Get the RTP timeout value for when an RTP instance is on hold.
- Parameters
-
instance The RTP instance
- Returns
- timeout value
Example usage:
This gets the RTP hold timeout value for the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2896 of file rtp_engine.c.
References ast_rtp_instance::holdtimeout.
◆ ast_rtp_instance_get_ice()
| struct ast_rtp_engine_ice * ast_rtp_instance_get_ice | ( | struct ast_rtp_instance * | instance | ) |
Obtain a pointer to the ICE support present on an RTP instance.
- Parameters
-
instance the RTP instance
- Returns
- ICE support if present
- Return values
-
NULL if no ICE support available
Definition at line 3097 of file rtp_engine.c.
References ast_rtp_instance::engine, ast_rtp_engine::ice, NULL, and rtp_ice_wrappers.
Referenced by add_ice_to_stream(), check_ice_support(), create_rtp(), jingle_add_google_candidates_to_transport(), jingle_add_ice_udp_candidates_to_transport(), jingle_enable_video(), jingle_interpret_google_transport(), jingle_interpret_ice_udp_transport(), jingle_new(), jingle_outgoing_hook(), jingle_request(), process_ice_attributes(), process_ice_auth_attrb(), and set_ice_components().
◆ ast_rtp_instance_get_incoming_source_address()
| void ast_rtp_instance_get_incoming_source_address | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | address | ||
| ) |
Get the incoming source address of the remote endpoint.
This returns the remote address the engine is sending RTP to. Usually this will be the same as the requested target address, however in the case where the engine "learns" the address (for instance, symmetric RTP enabled) this will then contain the learned address.
- Parameters
-
instance The instance that we want to get the incoming source address for address A structure to put the address into
Definition at line 693 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::incoming_source_address.
◆ ast_rtp_instance_get_keepalive()
| int ast_rtp_instance_get_keepalive | ( | struct ast_rtp_instance * | instance | ) |
Get the RTP keepalive interval.
- Parameters
-
instance The RTP instance
- Returns
- period Keepalive interval value
Example usage:
This gets the RTP keepalive interval value for the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2901 of file rtp_engine.c.
References ast_rtp_instance::keepalive.
Referenced by send_keepalive().
◆ ast_rtp_instance_get_last_rx()
| time_t ast_rtp_instance_get_last_rx | ( | const struct ast_rtp_instance * | rtp | ) |
Get the last RTP reception time.
- Parameters
-
rtp The instance from which to get the last reception time
- Returns
- The last RTP reception time
Definition at line 4007 of file rtp_engine.c.
References ast_rtp_instance::last_rx.
Referenced by rtp_check_timeout().
◆ ast_rtp_instance_get_last_tx()
| time_t ast_rtp_instance_get_last_tx | ( | const struct ast_rtp_instance * | rtp | ) |
Get the last RTP transmission time.
- Parameters
-
rtp The instance from which to get the last transmission time
- Returns
- The last RTP transmission time
Definition at line 3997 of file rtp_engine.c.
References ast_rtp_instance::last_tx.
Referenced by send_keepalive().
◆ ast_rtp_instance_get_local_address()
| void ast_rtp_instance_get_local_address | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | address | ||
| ) |
Get the local address that we are expecting RTP on.
- Parameters
-
instance The RTP instance to get the address from address The variable to store the address in
Example usage:
This gets the local address that we are expecting RTP on and stores it in the 'address' structure.
- Since
- 1.8
Definition at line 671 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::local_address.
Referenced by ast_rtp_prop_set(), ast_rtp_remote_address_set(), channel_read_rtp(), configure_local_rtp(), create_outgoing_sdp_stream(), multicast_send_control_packet(), send_start_rtp(), test_init_rtp_instances(), unicast_rtp_request(), and unistim_set_rtp_peer().
◆ ast_rtp_instance_get_prop()
| int ast_rtp_instance_get_prop | ( | struct ast_rtp_instance * | instance, |
| enum ast_rtp_property | property | ||
| ) |
Get the value of an RTP instance property.
- Parameters
-
instance The RTP instance to get the property from property The property to get
- Returns
- Current value of the property
Example usage:
This returns the current value of the NAT property on the instance pointed to by instance.
- Since
- 1.8
Definition at line 744 of file rtp_engine.c.
References ao2_lock, ao2_unlock, and ast_rtp_instance::properties.
Referenced by ast_rtcp_interpret(), ast_rtp_dtmf_compatible(), ast_rtp_read(), bridge_p2p_rtp_write(), process_dtmf_cisco(), process_dtmf_rfc2833(), rtp_raw_write(), and rtp_write_rtcp_psfb().
◆ ast_rtp_instance_get_quality()
| char * ast_rtp_instance_get_quality | ( | struct ast_rtp_instance * | instance, |
| enum ast_rtp_instance_stat_field | field, | ||
| char * | buf, | ||
| size_t | size | ||
| ) |
Retrieve quality statistics about an RTP instance.
- Parameters
-
instance Instance to get statistics on field What quality statistic to retrieve buf What buffer to put the result into size Size of the above buffer
- Return values
-
non-NULL success NULL failure
Example usage:
This retrieves general quality statistics and places a text representation into the buf pointed to by buf.
- Since
- 1.8
Definition at line 2646 of file rtp_engine.c.
References ast_rtp_instance_get_stats(), AST_RTP_INSTANCE_STAT_ALL, AST_RTP_INSTANCE_STAT_COMBINED_JITTER, AST_RTP_INSTANCE_STAT_COMBINED_LOSS, AST_RTP_INSTANCE_STAT_COMBINED_MES, AST_RTP_INSTANCE_STAT_COMBINED_RTT, AST_RTP_INSTANCE_STAT_FIELD_QUALITY, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, buf, 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, 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::rxploss, ast_rtp_instance_stats::stdevrtt, ast_rtp_instance_stats::txcount, ast_rtp_instance_stats::txjitter, ast_rtp_instance_stats::txmes, and ast_rtp_instance_stats::txploss.
Referenced by ast_rtp_instance_destroy(), ast_rtp_instance_set_stats_vars(), and channel_read_rtcp().
◆ ast_rtp_instance_get_requested_target_address()
| void ast_rtp_instance_get_requested_target_address | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | address | ||
| ) |
Get the requested target address of the remote endpoint.
This returns the explicitly set address of a remote endpoint. Meaning this won't change unless specifically told to change. In most cases this should be the same as the incoming source address, except in cases where the engine "learns" the address in which case this and the incoming source address might differ.
- Parameters
-
instance The instance that we want to get the requested target address for address A structure to put the address into
Definition at line 701 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::requested_target_address.
Referenced by ast_rtp_read().
◆ ast_rtp_instance_get_srtp()
| struct ast_srtp * ast_rtp_instance_get_srtp | ( | struct ast_rtp_instance * | instance, |
| int | rtcp | ||
| ) |
Obtain the SRTP instance associated with an RTP instance.
- Parameters
-
instance the RTP instance rtcp 1 to request instance for RTCP
- Returns
- the SRTP instance on success
- Return values
-
NULL if no SRTP instance exists
Definition at line 2969 of file rtp_engine.c.
References ast_rtp_instance::rtcp_srtp, and ast_rtp_instance::srtp.
Referenced by __rtp_sendto(), ast_rtcp_read(), ast_rtp_change_source(), and ast_rtp_read().
◆ ast_rtp_instance_get_ssrc()
| unsigned int ast_rtp_instance_get_ssrc | ( | struct ast_rtp_instance * | rtp | ) |
Retrieve the local SSRC value that we will be using.
- Parameters
-
rtp The RTP instance
- Returns
- The SSRC value
Definition at line 4017 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::ssrc_get.
Referenced by add_ssrc_to_stream(), ast_srtp_unprotect(), and create_outgoing_sdp_stream().
◆ ast_rtp_instance_get_stats()
| int ast_rtp_instance_get_stats | ( | struct ast_rtp_instance * | instance, |
| struct ast_rtp_instance_stats * | stats, | ||
| enum ast_rtp_instance_stat | stat | ||
| ) |
Retrieve statistics about an RTP instance.
- Parameters
-
instance Instance to get statistics on stats Structure to put results into stat What statistic(s) to retrieve
- Return values
-
0 success -1 failure
Example usage:
This retrieves all statistics the underlying RTP engine supports and puts the values into the stats structure.
- Since
- 1.8
Definition at line 2628 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::get_stat.
Referenced by ast_rtp_instance_get_quality(), ast_rtp_instance_get_stats_all_json(), ast_sip_session_media_stats_save(), ast_srtp_unprotect(), AST_TEST_DEFINE(), channel_read_rtcp(), cli_channelstats_print_body(), crypto_activate(), and process_ssrc_attributes().
◆ ast_rtp_instance_get_stats_all_json()
| struct ast_json * ast_rtp_instance_get_stats_all_json | ( | struct ast_rtp_instance * | instance | ) |
Retrieve statistics about an RTP instance in json format.
- Parameters
-
instance
- Returns
- json object of stats
Definition at line 4271 of file rtp_engine.c.
References ast_rtp_convert_stats_json(), ast_rtp_instance_get_stats(), AST_RTP_INSTANCE_STAT_ALL, and NULL.
Referenced by ast_ari_channels_rtpstatistics().
◆ ast_rtp_instance_get_timeout()
| int ast_rtp_instance_get_timeout | ( | struct ast_rtp_instance * | instance | ) |
Get the RTP timeout value.
- Parameters
-
instance The RTP instance
- Returns
- timeout value
Example usage:
This gets the RTP timeout value for the RTP instance pointed to by 'instance'.
- Since
- 1.8
Definition at line 2891 of file rtp_engine.c.
References ast_rtp_instance::timeout.
Referenced by apply_negotiated_sdp_stream(), and rtp_check_timeout().
◆ ast_rtp_instance_make_compatible()
| int ast_rtp_instance_make_compatible | ( | struct ast_channel * | chan, |
| struct ast_rtp_instance * | instance, | ||
| struct ast_channel * | peer | ||
| ) |
Request that the underlying RTP engine make two RTP instances compatible with eachother.
- Parameters
-
chan Our own Asterisk channel instance The first RTP instance peer The peer Asterisk channel
- Return values
-
0 success -1 failure
Example usage:
This makes the RTP instance for 'peer' compatible with 'instance' and vice versa.
- Since
- 1.8
Definition at line 2795 of file rtp_engine.c.
References ao2_ref, ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_log, ast_rtp_instance_get_glue(), ast_rtp_instance::engine, ast_rtp_glue::get_rtp_info, ast_rtp_instance::glue, LOG_ERROR, ast_rtp_engine::make_compatible, NULL, type, and ast_rtp_glue::type.
◆ ast_rtp_instance_new()
| struct ast_rtp_instance * ast_rtp_instance_new | ( | const char * | engine_name, |
| struct ast_sched_context * | sched, | ||
| const struct ast_sockaddr * | sa, | ||
| void * | data | ||
| ) |
Create a new RTP instance.
- Parameters
-
engine_name Name of the engine to use for the RTP instance sched Scheduler context that the RTP engine may want to use sa Address we want to bind to data Unique data for the engine
- Return values
-
non-NULL success NULL failure
Example usage:
This creates a new RTP instance using the default engine and asks the RTP engine to bind to the address given in the address structure.
- Note
- The RTP engine does not have to use the address provided when creating an RTP instance. It may choose to use another depending on it's own configuration.
- Since
- 1.8
Definition at line 493 of file rtp_engine.c.
References ao2_alloc, ao2_lock, ao2_ref, ao2_unlock, ast_debug, ast_log, ast_module_running_ref, ast_module_unref, ast_rtp_codecs_payloads_initialize(), AST_RWLIST_FIRST, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_sockaddr_copy(), ast_strlen_zero(), AST_VECTOR_INIT, ast_rtp_instance::codecs, ast_rtp_instance::engine, ast_module::entry, ast_rtp_instance::extmap_enabled, ast_rtp_instance::extmap_negotiated, ast_rtp_instance::extmap_unique_ids, instance_destructor(), ast_rtp_instance::local_address, LOG_ERROR, ast_rtp_engine::mod, ast_rtp_engine::name, ast_rtp_engine::new, and NULL.
Referenced by configure_local_rtp(), create_rtp(), jingle_alloc(), jingle_enable_video(), multicast_rtp_request(), start_rtp(), test_init_rtp_instances(), and unicast_rtp_request().
◆ ast_rtp_instance_read()
| struct ast_frame * ast_rtp_instance_read | ( | struct ast_rtp_instance * | instance, |
| int | rtcp | ||
| ) |
Receive a frame over RTP.
- Parameters
-
instance The RTP instance to receive frame on rtcp Whether to read in RTCP or not
- Return values
-
non-NULL success NULL failure
Example usage:
This asks the RTP engine to read in RTP from the instance and return it as an Asterisk frame.
- Since
- 1.8
Definition at line 606 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::read.
Referenced by AST_TEST_DEFINE(), jingle_read(), media_session_rtcp_read_callback(), media_session_rtp_read_callback(), ooh323_rtp_read(), rtp_read(), test_read_frames(), test_write_and_read_interleaved_frames(), and unistim_rtp_read().
◆ ast_rtp_instance_sendcng()
| int ast_rtp_instance_sendcng | ( | struct ast_rtp_instance * | instance, |
| int | level | ||
| ) |
Send a comfort noise packet to the RTP instance.
- Parameters
-
instance The RTP instance level Magnitude of the noise level
- Return values
-
0 Success non-zero Failure
Definition at line 2978 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::sendcng.
Referenced by do_monitor(), and send_keepalive().
◆ ast_rtp_instance_set_bridged()
| void ast_rtp_instance_set_bridged | ( | struct ast_rtp_instance * | instance, |
| struct ast_rtp_instance * | bridged | ||
| ) |
Set the other RTP instance that an instance is bridged to.
- Parameters
-
instance The RTP instance that we want to set the bridged value on bridged The RTP instance they are bridged to
- Since
- 12
Definition at line 2426 of file rtp_engine.c.
References ao2_lock, ao2_unlock, and ast_rtp_instance::bridged.
Referenced by native_rtp_bridge_start(), and native_rtp_bridge_stop().
◆ ast_rtp_instance_set_channel_id()
| void ast_rtp_instance_set_channel_id | ( | struct ast_rtp_instance * | instance, |
| const char * | uniqueid | ||
| ) |
Set the channel that owns this RTP instance.
- Parameters
-
instance The RTP instance uniqueid The uniqueid of the channel
- Since
- 12
Definition at line 581 of file rtp_engine.c.
References ast_copy_string(), and ast_rtp_instance::channel_uniqueid.
Referenced by apply_negotiated_sdp_stream(), jingle_enable_video(), jingle_set_owner(), multicast_rtp_request(), set_channel_on_rtp_instance(), start_rtp(), test_init_rtp_instances(), unicast_rtp_request(), and unistim_set_owner().
◆ ast_rtp_instance_set_data()
| void ast_rtp_instance_set_data | ( | struct ast_rtp_instance * | instance, |
| void * | data | ||
| ) |
Set the data portion of an RTP instance.
- Parameters
-
instance The RTP instance to manipulate data Pointer to data
Example usage:
This sets the data pointer on the RTP instance pointed to by 'instance' to blob.
- Since
- 1.8
Definition at line 586 of file rtp_engine.c.
References ast_rtp_instance::data.
Referenced by ast_rtp_new(), and multicast_rtp_new().
◆ ast_rtp_instance_set_extended_prop()
| void ast_rtp_instance_set_extended_prop | ( | struct ast_rtp_instance * | instance, |
| int | property, | ||
| void * | value | ||
| ) |
Set the value of an RTP instance extended property.
- Parameters
-
instance The RTP instance to set the extended property on property The extended property to set value The value to set the extended property to
- Since
- 1.8
Definition at line 709 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::extended_prop_set, and value.
◆ ast_rtp_instance_set_hold_timeout()
| void ast_rtp_instance_set_hold_timeout | ( | struct ast_rtp_instance * | instance, |
| int | timeout | ||
| ) |
Set the RTP timeout value for when the instance is on hold.
- Parameters
-
instance The RTP instance timeout Value to set the timeout to
Example usage:
This sets the RTP hold timeout value on 'instance' to be 5000.
- Since
- 1.8
Definition at line 2881 of file rtp_engine.c.
References ast_rtp_instance::holdtimeout, and ast_rtp_instance::timeout.
◆ ast_rtp_instance_set_incoming_source_address()
| int ast_rtp_instance_set_incoming_source_address | ( | struct ast_rtp_instance * | instance, |
| const struct ast_sockaddr * | address | ||
| ) |
Set the incoming source address of the remote endpoint that we are sending RTP to.
This sets the incoming source address the engine is sending RTP to. Usually this will be the same as the requested target address, however in the case where the engine "learns" the address (for instance, symmetric RTP enabled) this will then contain the learned address.
- Parameters
-
instance The RTP instance to change the address on address Address to set it to
- Return values
-
0 success -1 failure
Definition at line 634 of file rtp_engine.c.
References ao2_lock, ao2_unlock, and rtp_instance_set_incoming_source_address_nolock().
Referenced by ast_rtp_read().
◆ ast_rtp_instance_set_keepalive()
| void ast_rtp_instance_set_keepalive | ( | struct ast_rtp_instance * | instance, |
| int | timeout | ||
| ) |
Set the RTP keepalive interval.
- Parameters
-
instance The RTP instance timeout Value to set the keepalive interval to
Example usage:
This sets the RTP keepalive interval on 'instance' to be 5000.
- Since
- 1.8
Definition at line 2886 of file rtp_engine.c.
References ast_rtp_instance::keepalive.
Referenced by apply_negotiated_sdp_stream().
◆ ast_rtp_instance_set_last_rx()
| void ast_rtp_instance_set_last_rx | ( | struct ast_rtp_instance * | rtp, |
| time_t | time | ||
| ) |
Set the last RTP reception time.
- Parameters
-
rtp The instance on which to set the last reception time time The last reception time
Definition at line 4012 of file rtp_engine.c.
References ast_rtp_instance::last_rx.
Referenced by create_rtp(), media_session_rtcp_read_callback(), media_session_rtp_read_callback(), and rtp_check_timeout().
◆ ast_rtp_instance_set_last_tx()
| void ast_rtp_instance_set_last_tx | ( | struct ast_rtp_instance * | rtp, |
| time_t | time | ||
| ) |
Set the last RTP transmission time.
- Parameters
-
rtp The instance on which to set the last transmission time time The last transmission time
Definition at line 4002 of file rtp_engine.c.
References ast_rtp_instance::last_tx.
Referenced by __rtp_sendto().
◆ ast_rtp_instance_set_local_address()
| int ast_rtp_instance_set_local_address | ( | struct ast_rtp_instance * | instance, |
| const struct ast_sockaddr * | address | ||
| ) |
Set the address that we are expecting to receive RTP on.
- Parameters
-
instance The RTP instance to change the address on address Address to set it to
- Return values
-
0 success -1 failure
Example usage:
This changes the local address that RTP is expected on to the address given in the sin structure.
- Since
- 1.8
Definition at line 616 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_copy(), and ast_rtp_instance::local_address.
Referenced by ast_rtp_remote_address_set(), and rtp_allocate_transport().
◆ ast_rtp_instance_set_prop()
| void ast_rtp_instance_set_prop | ( | struct ast_rtp_instance * | instance, |
| enum ast_rtp_property | property, | ||
| int | value | ||
| ) |
Set the value of an RTP instance property.
- Parameters
-
instance The RTP instance to set the property on property The property to modify value The value to set the property to
Example usage:
This enables the AST_RTP_PROPERTY_NAT property on the instance pointed to by instance.
- Since
- 1.8
Definition at line 733 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::prop_set, ast_rtp_instance::properties, and value.
Referenced by check_for_rtp_changes(), configure_local_rtp(), create_rtp(), enable_rtcp(), get_codecs(), jingle_alloc(), jingle_enable_video(), pjsip_acf_dtmf_mode_write(), start_rtp(), and test_init_rtp_instances().
◆ ast_rtp_instance_set_qos()
| int ast_rtp_instance_set_qos | ( | struct ast_rtp_instance * | instance, |
| int | tos, | ||
| int | cos, | ||
| const char * | desc | ||
| ) |
Set QoS parameters on an RTP session.
- Parameters
-
instance Instance to set the QoS parameters on tos Terms of service value cos Class of service value desc What is setting the QoS values
- Return values
-
0 success -1 failure
Example usage:
This sets the TOS and COS values to 0 on the instance pointed to by instance.
- Since
- 1.8
Definition at line 2351 of file rtp_engine.c.
References ao2_lock, ao2_unlock, cos, desc, ast_rtp_instance::engine, ast_rtp_engine::qos, and tos.
Referenced by configure_local_rtp(), create_rtp(), and start_rtp().
◆ ast_rtp_instance_set_read_format()
| int ast_rtp_instance_set_read_format | ( | struct ast_rtp_instance * | instance, |
| struct ast_format * | format | ||
| ) |
Request that the underlying RTP engine provide audio frames in a specific format.
- Parameters
-
instance The RTP instance to change read format on format Format that frames are wanted in
- Return values
-
0 success -1 failure
Example usage:
This requests that the RTP engine provide audio frames in the ULAW format.
- Since
- 1.8
Definition at line 2766 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_read_format.
◆ ast_rtp_instance_set_remote_ssrc()
| void ast_rtp_instance_set_remote_ssrc | ( | struct ast_rtp_instance * | rtp, |
| unsigned int | ssrc | ||
| ) |
Set the remote SSRC for an RTP instance.
- Since
- 15.0.0
- Parameters
-
rtp The RTP instance ssrc The remote SSRC
Definition at line 4060 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_remote_ssrc.
Referenced by process_ssrc_attributes().
◆ ast_rtp_instance_set_requested_target_address()
| int ast_rtp_instance_set_requested_target_address | ( | struct ast_rtp_instance * | instance, |
| const struct ast_sockaddr * | address | ||
| ) |
Set the requested target address of the remote endpoint.
This should always be the address of the remote endpoint. Consequently, this can differ from the address the engine is sending RTP to. However, usually they will be the same except in some circumstances (for instance when the engine "learns" the address if symmetric RTP is enabled).
- Parameters
-
instance The RTP instance to change the address on address Address to set it to
- Return values
-
0 success -1 failure
Definition at line 644 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_sockaddr_copy(), ast_rtp_instance::requested_target_address, and rtp_instance_set_incoming_source_address_nolock().
◆ ast_rtp_instance_set_stats_vars()
| void ast_rtp_instance_set_stats_vars | ( | struct ast_channel * | chan, |
| struct ast_rtp_instance * | instance | ||
| ) |
Set standard statistics from an RTP instance on a channel.
- Parameters
-
chan Channel to set the statistics on instance The RTP instance that statistics will be retrieved from
- Note
- Absolutely NO channel locks should be held before calling this function.
Example usage:
This retrieves standard statistics from the RTP instance rtp and sets it on the channel pointed to by chan.
- Since
- 1.8
Definition at line 2697 of file rtp_engine.c.
References ast_channel_bridge_peer(), ast_channel_lock, ast_channel_lock_both, ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_unlock, ast_channel_unref, AST_MAX_USER_FIELD, ast_rtp_instance_get_quality(), AST_RTP_INSTANCE_STAT_FIELD_QUALITY, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_JITTER, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_LOSS, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_MES, AST_RTP_INSTANCE_STAT_FIELD_QUALITY_RTT, ast_channel::bridge, pbx_builtin_setvar_helper(), and quality.
Referenced by chan_pjsip_session_end(), and hangup().
◆ ast_rtp_instance_set_stream_num()
| void ast_rtp_instance_set_stream_num | ( | struct ast_rtp_instance * | instance, |
| int | stream_num | ||
| ) |
Set the stream number for an RTP instance.
- Since
- 15.0.0
- Parameters
-
instance The RTP instance stream_num The stream identifier number
Definition at line 4069 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::set_stream_num.
Referenced by apply_negotiated_sdp_stream().
◆ ast_rtp_instance_set_timeout()
| void ast_rtp_instance_set_timeout | ( | struct ast_rtp_instance * | instance, |
| int | timeout | ||
| ) |
Set the RTP timeout value.
- Parameters
-
instance The RTP instance timeout Value to set the timeout to
Example usage:
This sets the RTP timeout value on 'instance' to be 5000.
- Since
- 1.8
Definition at line 2876 of file rtp_engine.c.
References ast_rtp_instance::timeout.
Referenced by apply_negotiated_sdp_stream(), and configure_local_rtp().
◆ ast_rtp_instance_set_write_format()
| int ast_rtp_instance_set_write_format | ( | struct ast_rtp_instance * | instance, |
| struct ast_format * | format | ||
| ) |
Tell underlying RTP engine that audio frames will be provided in a specific format.
- Parameters
-
instance The RTP instance to change write format on format Format that frames will be provided in
- Return values
-
0 success -1 failure
Example usage:
This tells the underlying RTP engine that audio frames will be provided to it in ULAW format.
- Since
- 1.8
Definition at line 2780 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, ast_rtp_engine::set_read_format, and ast_rtp_engine::set_write_format.
◆ ast_rtp_instance_stop()
| void ast_rtp_instance_stop | ( | struct ast_rtp_instance * | instance | ) |
Stop an RTP instance.
- Parameters
-
instance Instance that media is no longer going to at this time
Example usage:
This tells the RTP engine being used for the instance pointed to by instance that media is no longer going to it at this time, but may in the future.
- Since
- 1.8
Definition at line 2365 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::stop.
Referenced by apply_negotiated_sdp_stream(), close_rtp_connection(), jingle_session_destructor(), ooh323_destroy(), stream_stop(), and unistim_hangup_clean().
◆ ast_rtp_instance_stun_request()
| void ast_rtp_instance_stun_request | ( | struct ast_rtp_instance * | instance, |
| struct ast_sockaddr * | suggestion, | ||
| const char * | username | ||
| ) |
Request that the underlying RTP engine send a STUN BIND request.
- Parameters
-
instance The RTP instance suggestion The suggested destination username Optionally a username for the request
Example usage:
This requests that the RTP engine send a STUN BIND request on the session pointed to by 'instance'.
- Since
- 1.8
Definition at line 2867 of file rtp_engine.c.
References ast_rtp_instance::engine, and ast_rtp_engine::stun_request.
Referenced by jingle_interpret_google_transport().
◆ ast_rtp_instance_update_source()
| void ast_rtp_instance_update_source | ( | struct ast_rtp_instance * | instance | ) |
Indicate that the RTP marker bit should be set on an RTP stream.
- Parameters
-
instance Instance that the new media source is feeding into
Example usage:
This indicates that the source of media that is feeding the instance pointed to by instance has been updated and that the marker bit should be set.
- Since
- 1.8
Definition at line 2333 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::update_source.
Referenced by jingle_indicate(), and ooh323_indicate().
◆ ast_rtp_instance_write()
| int ast_rtp_instance_write | ( | struct ast_rtp_instance * | instance, |
| struct ast_frame * | frame | ||
| ) |
Send a frame out over RTP.
- Parameters
-
instance The RTP instance to send frame out on frame the frame to send out
- Return values
-
0 success -1 failure
Example usage:
This gives the frame pointed to by frame to the RTP engine being used for the instance and asks that it be transmitted to the current remote address set on the RTP instance.
- Since
- 1.8
Definition at line 596 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::write.
Referenced by AST_TEST_DEFINE(), chan_pjsip_indicate(), jingle_write(), media_session_rtp_write_callback(), ooh323_write(), rtp_write(), test_write_and_read_interleaved_frames(), test_write_frames(), and unistim_write().
◆ ast_rtp_lookup_mime_multiple2()
| char * ast_rtp_lookup_mime_multiple2 | ( | struct ast_str * | buf, |
| struct ast_format_cap * | ast_format_capability, | ||
| int | rtp_capability, | ||
| const int | asterisk_format, | ||
| enum ast_rtp_options | options | ||
| ) |
Convert formats into a string and put them into a buffer.
- Parameters
-
buf Buffer to put the mime output into ast_format_capability Asterisk Formats we are looking up. rtp_capability RTP codes that we are looking up asterisk_format Non-zero if the ast_format_capability structure is to be used, 0 if rtp_capability is to be used options Additional options that may change the result
- Return values
-
non-NULL success NULL failure
Example usage:
This returns the mime values for ULAW and ALAW in the buffer pointed to by buf.
- Since
- 1.8
Definition at line 2227 of file rtp_engine.c.
References ao2_ref, ast_format_cap_count(), ast_format_cap_get_format(), ast_rtp_lookup_mime_subtype2(), AST_RTP_MAX, ast_str_append(), ast_str_buffer(), ast_rtp_payload_type::asterisk_format, buf, name, NULL, and options.
◆ ast_rtp_lookup_mime_subtype2()
| const char * ast_rtp_lookup_mime_subtype2 | ( | const int | asterisk_format, |
| const struct ast_format * | format, | ||
| int | code, | ||
| enum ast_rtp_options | options | ||
| ) |
Retrieve mime subtype information on a payload.
- Parameters
-
asterisk_format Non-zero to look up using Asterisk format format Asterisk format to look up code RTP code to look up options Additional options that may change the result
- Returns
- Mime subtype success
- Return values
-
NULL failure
Example usage:
This looks up the mime subtype for the ULAW format.
- Since
- 1.8
Definition at line 2174 of file rtp_engine.c.
References ast_format_cmp(), AST_FORMAT_CMP_EQUAL, AST_FORMAT_CMP_NOT_EQUAL, ast_format_g726_aal2, ast_rtp_mime_types, AST_RTP_OPT_G726_NONSTANDARD, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rtp_payload_type::asterisk_format, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, options, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, and ast_rtp_mime_type::subtype.
Referenced by ast_rtp_lookup_mime_multiple2(), generate_rtpmap_attr(), generate_rtpmap_attr2(), and jingle_add_payloads_to_description().
◆ ast_rtp_lookup_sample_rate2()
| unsigned int ast_rtp_lookup_sample_rate2 | ( | int | asterisk_format, |
| const struct ast_format * | format, | ||
| int | code | ||
| ) |
Get the sample rate associated with known RTP payload types.
- Parameters
-
asterisk_format True if the value in format is to be used. format An asterisk format code from AST_RTP list
- Returns
- the sample rate if the format was found, zero if it was not found
- Since
- 1.8
Definition at line 2204 of file rtp_engine.c.
References ast_format_cmp(), AST_FORMAT_CMP_NOT_EQUAL, ast_rtp_mime_types, ast_rwlock_rdlock, ast_rwlock_unlock, ast_rtp_payload_type::asterisk_format, ast_rtp_payload_type::format, mime_types_len, mime_types_lock, ast_rtp_mime_type::payload_type, ast_rtp_payload_type::rtp_code, and ast_rtp_mime_type::sample_rate.
Referenced by create_outgoing_sdp_stream(), generate_rtpmap_attr(), and jingle_add_payloads_to_description().
◆ ast_rtp_payload_mapping_tx_is_present()
| int ast_rtp_payload_mapping_tx_is_present | ( | struct ast_rtp_codecs * | codecs, |
| const struct ast_rtp_payload_type * | to_match | ||
| ) |
Determine if a type of payload is already present in mappings.
- Since
- 18
- Parameters
-
codecs Codecs to be checked for mappings. to_match Payload type object to compare against.
- Note
- It is assumed that codecs is not locked before calling.
- Return values
-
0 not found 1 found
Definition at line 1226 of file rtp_engine.c.
References ast_rwlock_rdlock, ast_rwlock_unlock, codecs, and payload_mapping_tx_is_present().
Referenced by ast_rtp_dtmf_begin().
◆ ast_rtp_publish_rtcp_message()
| void ast_rtp_publish_rtcp_message | ( | struct ast_rtp_instance * | rtp, |
| struct stasis_message_type * | message_type, | ||
| struct ast_rtp_rtcp_report * | report, | ||
| struct ast_json * | blob | ||
| ) |
Publish an RTCP message to Stasis Message Bus API.
- Since
- 12
- Parameters
-
rtp The rtp instance object message_type The RTP message type to publish report The RTCP report object to publish. This should be an ao2 ref counted object. This routine will increase the reference count of the object. blob Additional JSON objects to publish along with the RTCP information
Definition at line 3696 of file rtp_engine.c.
References ao2_alloc, ao2_cleanup, ao2_ref, ast_channel_snapshot_get_latest(), ast_json_ref(), ast_rtp_topic(), ast_strlen_zero(), ast_rtp_instance::channel_uniqueid, NULL, RAII_VAR, rtcp_message_payload_dtor(), stasis_message_create(), and stasis_publish().
Referenced by ast_rtcp_calculate_sr_rr_statistics(), and ast_rtcp_interpret().
◆ ast_rtp_red_buffer()
| int ast_rtp_red_buffer | ( | struct ast_rtp_instance * | instance, |
| struct ast_frame * | frame | ||
| ) |
Buffer a frame in an RTP instance for RED.
- Parameters
-
instance The instance to buffer the frame on frame Frame that we want to buffer
- Return values
-
0 success -1 failure
- Since
- 1.8
Definition at line 2614 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::red_buffer.
◆ ast_rtp_red_init()
| int ast_rtp_red_init | ( | struct ast_rtp_instance * | instance, |
| int | buffer_time, | ||
| int * | payloads, | ||
| int | generations | ||
| ) |
Initialize RED support on an RTP instance.
- Parameters
-
instance The instance to initialize RED support on buffer_time How long to buffer before sending payloads Payload values generations Number of generations
- Return values
-
0 success -1 failure
- Since
- 1.8
Definition at line 2600 of file rtp_engine.c.
References ao2_lock, ao2_unlock, ast_rtp_instance::engine, and ast_rtp_engine::red_init.
◆ ast_rtp_rtcp_report_alloc()
| struct ast_rtp_rtcp_report * ast_rtp_rtcp_report_alloc | ( | unsigned int | report_blocks | ) |
Allocate an ao2 ref counted instance of ast_rtp_rtcp_report.
- Parameters
-
report_blocks The number of report blocks to allocate
- Returns
- An ao2 ref counted ast_rtp_rtcp_report object on success
- Return values
-
NULL on error
Definition at line 3685 of file rtp_engine.c.
References ao2_alloc, and rtp_rtcp_report_dtor().
Referenced by ast_rtcp_interpret(), ast_rtcp_write(), ast_rtp_read(), rtp_write_rtcp_fir(), and rtp_write_rtcp_psfb().
◆ ast_rtp_topic()
| struct stasis_topic * ast_rtp_topic | ( | void | ) |
Stasis Message Bus API topic for RTP and RTCP related messages
- Since
- 12
- Returns
- A Stasis Message Bus API topic
Definition at line 3742 of file rtp_engine.c.
References rtp_topic.
Referenced by ast_rtp_publish_rtcp_message(), load_module(), and manager_subscriptions_init().
