Asterisk - The Open Source Telephony Project  GIT-master-b91fb3c
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
bridge.h File Reference

Bridging API. More...

#include "asterisk/bridge_features.h"
#include "asterisk/bridge_channel.h"
#include "asterisk/bridge_roles.h"
#include "asterisk/dsp.h"
#include "asterisk/uuid.h"

Go to the source code of this file.

Data Structures

struct  ast_bridge
 Structure that contains information about a bridge. More...
 
struct  ast_bridge_channels_list
 
struct  ast_bridge_methods
 Bridge virtual methods table definition. More...
 
struct  ast_bridge_snapshot
 Structure that contains a snapshot of information about a bridge. More...
 
struct  ast_bridge_softmix
 
struct  ast_bridge_video_mode
 Data structure that defines a video source mode. More...
 
struct  ast_bridge_video_sfu_data
 This is used for selective forwarding unit configuration. More...
 
struct  ast_bridge_video_single_src_data
 This is used for both SINGLE_SRC mode to set what channel should be the current single video feed. More...
 
struct  ast_bridge_video_talker_src_data
 This is used for both SINGLE_SRC_TALKER mode to set what channel should be the current single video feed. More...
 
struct  transfer_channel_data
 AO2 object that wraps data for transfer_channel_cb. More...
 

Macros

#define ast_bridge_lock(bridge)   _ast_bridge_lock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
 Lock the bridge. More...
 
#define ast_bridge_lock_both(bridge1, bridge2)
 Lock two bridges. More...
 
#define ast_bridge_trylock(bridge)   _ast_bridge_trylock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
 Try locking the bridge. More...
 
#define ast_bridge_unlock(bridge)   _ast_bridge_unlock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
 Unlock the bridge. More...
 

Typedefs

typedef void(* ast_bridge_destructor_fn) (struct ast_bridge *self)
 Destroy the bridge. More...
 
typedef void(* ast_bridge_dissolving_fn) (struct ast_bridge *self)
 The bridge is being dissolved. More...
 
typedef int(* ast_bridge_merge_priority_fn) (struct ast_bridge *self)
 Get the merge priority of this bridge. More...
 
typedef void(* ast_bridge_notify_masquerade_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)
 Notify the bridge that this channel was just masqueraded. More...
 
typedef void(* ast_bridge_pull_channel_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)
 Pull this channel from the bridge. More...
 
typedef int(* ast_bridge_push_channel_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap)
 Push this channel into the bridge. More...
 
typedef void(* transfer_channel_cb) (struct ast_channel *chan, struct transfer_channel_data *user_data, enum ast_transfer_type transfer_type)
 Callback function type called during blind transfers. More...
 

Enumerations

enum  ast_bridge_capability {
  AST_BRIDGE_CAPABILITY_HOLDING = (1 << 0), AST_BRIDGE_CAPABILITY_EARLY = (1 << 1), AST_BRIDGE_CAPABILITY_NATIVE = (1 << 2), AST_BRIDGE_CAPABILITY_1TO1MIX = (1 << 3),
  AST_BRIDGE_CAPABILITY_MULTIMIX = (1 << 4)
}
 Capabilities for a bridge technology. More...
 
enum  ast_bridge_impart_flags { AST_BRIDGE_IMPART_CHAN_MASK = (1 << 0), AST_BRIDGE_IMPART_CHAN_DEPARTABLE = (0 << 0), AST_BRIDGE_IMPART_CHAN_INDEPENDENT = (1 << 0), AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP = (1 << 1) }
 
enum  ast_bridge_join_flags { AST_BRIDGE_JOIN_PASS_REFERENCE = (1 << 0), AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP = (1 << 1) }
 
enum  ast_bridge_optimization {
  AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE, AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE, AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE, AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE,
  AST_BRIDGE_OPTIMIZE_PROHIBITED
}
 Tells, if optimization is allowed, how the optimization would be performed. More...
 
enum  ast_bridge_video_mode_type { AST_BRIDGE_VIDEO_MODE_NONE = 0, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, AST_BRIDGE_VIDEO_MODE_TALKER_SRC, AST_BRIDGE_VIDEO_MODE_SFU }
 Video source modes. More...
 
enum  ast_bridge_video_sfu_remb_behavior {
  AST_BRIDGE_VIDEO_SFU_REMB_AVERAGE = 0, AST_BRIDGE_VIDEO_SFU_REMB_LOWEST, AST_BRIDGE_VIDEO_SFU_REMB_HIGHEST, AST_BRIDGE_VIDEO_SFU_REMB_AVERAGE_ALL,
  AST_BRIDGE_VIDEO_SFU_REMB_LOWEST_ALL, AST_BRIDGE_VIDEO_SFU_REMB_HIGHEST_ALL, AST_BRIDGE_VIDEO_SFU_REMB_FORCE
}
 REMB report behaviors. More...
 
enum  ast_transfer_result { AST_BRIDGE_TRANSFER_SUCCESS, AST_BRIDGE_TRANSFER_NOT_PERMITTED, AST_BRIDGE_TRANSFER_INVALID, AST_BRIDGE_TRANSFER_FAIL }
 
enum  ast_transfer_type { AST_BRIDGE_TRANSFER_SINGLE_PARTY, AST_BRIDGE_TRANSFER_MULTI_PARTY }
 

Functions

static void _ast_bridge_lock (struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
 
static int _ast_bridge_trylock (struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
 
static void _ast_bridge_unlock (struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
 
struct ast_bridgeast_bridge_base_new (uint32_t capabilities, unsigned int flags, const char *creator, const char *name, const char *id)
 Create a new base class bridge. More...
 
int ast_bridge_depart (struct ast_channel *chan)
 Depart a channel from a bridge. More...
 
int ast_bridge_destroy (struct ast_bridge *bridge, int cause)
 Destroy a bridge. More...
 
void ast_bridge_features_remove (struct ast_bridge_features *features, enum ast_bridge_hook_remove_flags flags)
 Remove marked bridge channel feature hooks. More...
 
struct ast_bridgeast_bridge_find_by_id (const char *bridge_id)
 Find bridge by id. More...
 
int ast_bridge_impart (struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, enum ast_bridge_impart_flags flags) attribute_warn_unused_result
 Impart a channel to a bridge (non-blocking) More...
 
int ast_bridge_is_video_src (struct ast_bridge *bridge, struct ast_channel *chan)
 Determine if a channel is a video src for the bridge. More...
 
int ast_bridge_join (struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, struct ast_bridge_tech_optimizations *tech_args, enum ast_bridge_join_flags flags)
 Join a channel to a bridge (blocking) More...
 
int ast_bridge_kick (struct ast_bridge *bridge, struct ast_channel *chan)
 Kick a channel from a bridge. More...
 
int ast_bridge_merge (struct ast_bridge *dst_bridge, struct ast_bridge *src_bridge, int merge_best_direction, struct ast_channel **kick_me, unsigned int num_kick)
 Merge two bridges together. More...
 
void ast_bridge_merge_inhibit (struct ast_bridge *bridge, int request)
 Adjust the bridge merge inhibit request count. More...
 
int ast_bridge_move (struct ast_bridge *dst_bridge, struct ast_bridge *src_bridge, struct ast_channel *chan, struct ast_channel *swap, int attempt_recovery)
 Move a channel from one bridge to another. More...
 
void ast_bridge_notify_masquerade (struct ast_channel *chan)
 Notify bridging that this channel was just masqueraded. More...
 
int ast_bridge_number_video_src (struct ast_bridge *bridge)
 Returns the number of video sources currently active in the bridge. More...
 
struct ast_channelast_bridge_peer (struct ast_bridge *bridge, struct ast_channel *chan)
 Get the channel's bridge peer only if the bridge is two-party. More...
 
struct ast_channelast_bridge_peer_nolock (struct ast_bridge *bridge, struct ast_channel *chan)
 Get the channel's bridge peer only if the bridge is two-party. More...
 
struct ao2_containerast_bridge_peers (struct ast_bridge *bridge)
 Get a container of all channels in the bridge. More...
 
struct ao2_containerast_bridge_peers_nolock (struct ast_bridge *bridge)
 Get a container of all channels in the bridge. More...
 
int ast_bridge_queue_action (struct ast_bridge *bridge, struct ast_frame *action)
 Put an action onto the specified bridge. More...
 
int ast_bridge_queue_everyone_else (struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame)
 Queue the given frame to everyone else. More...
 
int ast_bridge_remove (struct ast_bridge *bridge, struct ast_channel *chan)
 Remove a channel from a bridge. More...
 
void ast_bridge_remove_video_src (struct ast_bridge *bridge, struct ast_channel *chan)
 remove a channel as a source of video for the bridge. More...
 
void ast_bridge_set_binaural_active (struct ast_bridge *bridge, unsigned int binaural_active)
 Activates the use of binaural signals in a conference bridge. More...
 
void ast_bridge_set_internal_sample_rate (struct ast_bridge *bridge, unsigned int sample_rate)
 Adjust the internal mixing sample rate of a bridge used during multimix mode. More...
 
void ast_bridge_set_maximum_sample_rate (struct ast_bridge *bridge, unsigned int sample_rate)
 Adjust the maximum mixing sample rate of a bridge used during multimix mode. More...
 
void ast_bridge_set_mixing_interval (struct ast_bridge *bridge, unsigned int mixing_interval)
 Adjust the internal mixing interval of a bridge used during multimix mode. More...
 
void ast_bridge_set_remb_estimated_bitrate (struct ast_bridge *bridge, float estimated_bitrate)
 Force the REMB report estimated bitrate to a specific max value. More...
 
void ast_bridge_set_remb_send_interval (struct ast_bridge *bridge, unsigned int remb_send_interval)
 Set the interval at which a combined REMB frame will be sent to video sources. More...
 
void ast_bridge_set_send_sdp_label (struct ast_bridge *bridge, unsigned int send_sdp_label)
 Controls whether to send a "label" attribute in each stream in an SDP. More...
 
void ast_bridge_set_sfu_video_mode (struct ast_bridge *bridge)
 Set the bridge to be a selective forwarding unit. More...
 
void ast_bridge_set_single_src_video_mode (struct ast_bridge *bridge, struct ast_channel *video_src_chan)
 Set a bridge to feed a single video source to all participants. More...
 
void ast_bridge_set_talker_src_video_mode (struct ast_bridge *bridge)
 Set the bridge to pick the strongest talker supporting video as the single source video feed. More...
 
void ast_bridge_set_transfer_variables (struct ast_channel *chan, const char *value, int is_attended)
 Set the relevant transfer variables for a single channel. More...
 
void ast_bridge_set_video_update_discard (struct ast_bridge *bridge, unsigned int video_update_discard)
 Set the amount of time to discard subsequent video updates after a video update has been sent. More...
 
int ast_bridge_suspend (struct ast_bridge *bridge, struct ast_channel *chan)
 Suspend a channel temporarily from a bridge. More...
 
struct ast_bridgeast_bridge_transfer_acquire_bridge (struct ast_channel *chan)
 Acquire the channel's bridge for transfer purposes. More...
 
enum ast_transfer_result ast_bridge_transfer_attended (struct ast_channel *to_transferee, struct ast_channel *to_transfer_target)
 Attended transfer. More...
 
enum ast_transfer_result ast_bridge_transfer_blind (int is_external, struct ast_channel *transferer, const char *exten, const char *context, transfer_channel_cb new_channel_cb, void *user_data)
 Blind transfer target to the extension and context provided. More...
 
int ast_bridge_unreal_optimize_out (struct ast_channel *chan, struct ast_channel *peer, struct ast_unreal_pvt *pvt)
 Check and optimize out the unreal channels between bridges. More...
 
int ast_bridge_unsuspend (struct ast_bridge *bridge, struct ast_channel *chan)
 Unsuspend a channel from a bridge. More...
 
void ast_bridge_update_talker_src_video_mode (struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame)
 Update information about talker energy for talker src video mode. More...
 
void ast_bridge_vars_set (struct ast_channel *chan, const char *name, const char *pvtid)
 Sets BRIDGECHANNEL and BRIDGEPVTCALLID for a channel. More...
 
const char * ast_bridge_video_mode_to_string (enum ast_bridge_video_mode_type video_mode)
 Converts an enum representation of a bridge video mode to string. More...
 
struct ao2_containerast_bridges (void)
 Returns the global bridges container. More...
 
enum ast_bridge_optimization ast_bridges_allow_optimization (struct ast_bridge *chan_bridge, struct ast_bridge *peer_bridge)
 Determine if bridges allow for optimization to occur betweem them. More...
 
void ast_brige_set_remb_behavior (struct ast_bridge *bridge, enum ast_bridge_video_sfu_remb_behavior behavior)
 Set the REMB report generation behavior on a bridge. More...
 

Variables

struct ast_bridge_methods ast_bridge_base_v_table
 Bridge base class virtual method table. More...
 

Detailed Description

Bridging API.

Author
Richard Mudgett rmudg.nosp@m.ett@.nosp@m.digiu.nosp@m.m.co.nosp@m.m
Joshua Colp jcolp.nosp@m.@dig.nosp@m.ium.c.nosp@m.om Bridging API

See Also:

Definition in file bridge.h.

Macro Definition Documentation

◆ ast_bridge_lock

#define ast_bridge_lock (   bridge)    _ast_bridge_lock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)

Lock the bridge.

Parameters
bridgeBridge to lock
Returns
Nothing

Definition at line 480 of file bridge.h.

Referenced by ast_ari_bridges_clear_video_source(), ast_ari_bridges_create(), ast_ari_bridges_create_with_id(), ast_bridge_basic_set_flags(), ast_bridge_channel_lock_bridge(), ast_bridge_destroy(), ast_bridge_get_snapshot(), ast_bridge_get_snapshot_by_uniqueid(), ast_bridge_is_video_src(), ast_bridge_join(), ast_bridge_kick(), ast_bridge_merge_inhibit(), ast_bridge_number_video_src(), ast_bridge_peer(), ast_bridge_peers(), ast_bridge_remove(), ast_bridge_remove_video_src(), ast_bridge_set_binaural_active(), ast_bridge_set_internal_sample_rate(), ast_bridge_set_maximum_sample_rate(), ast_bridge_set_mixing_interval(), ast_bridge_set_remb_estimated_bitrate(), ast_bridge_set_remb_send_interval(), ast_bridge_set_send_sdp_label(), ast_bridge_set_sfu_video_mode(), ast_bridge_set_single_src_video_mode(), ast_bridge_set_talker_src_video_mode(), ast_bridge_set_video_update_discard(), ast_bridge_suspend(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), ast_bridge_unsuspend(), ast_bridge_update_talker_src_video_mode(), ast_brige_set_remb_behavior(), AST_TEST_DEFINE(), ast_unreal_channel_push_to_bridge(), bridge_action_bridge(), bridge_basic_change_personality(), bridge_channel_internal_join(), bridge_channel_snapshot_pair_init(), bridge_impart_internal(), bridge_manager_service(), bridge_queue_action_nodup(), bridge_register(), bridge_set_video_source_cb(), complete_bridge_participant(), conf_moh_start(), conf_moh_stop(), destroy_bridge(), handle_bridge_kick_channel(), native_rtp_framehook(), play_uri(), send_conf_stasis(), send_conf_stasis_snapshots(), softmix_mixing_loop(), and softmix_mixing_thread().

◆ ast_bridge_lock_both

#define ast_bridge_lock_both (   bridge1,
  bridge2 
)

◆ ast_bridge_trylock

#define ast_bridge_trylock (   bridge)    _ast_bridge_trylock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)

Try locking the bridge.

Parameters
bridgeBridge to try locking
Return values
0on success.
non-zeroon error.

Definition at line 467 of file bridge.h.

Referenced by optimize_lock_chan_stack(), and optimize_lock_peer_stack().

◆ ast_bridge_unlock

#define ast_bridge_unlock (   bridge)    _ast_bridge_unlock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)

Unlock the bridge.

Parameters
bridgeBridge to unlock
Returns
Nothing

Definition at line 493 of file bridge.h.

Referenced by action_toggle_binaural(), agent_alert(), ast_ari_bridges_clear_video_source(), ast_ari_bridges_create(), ast_ari_bridges_create_with_id(), ast_bridge_add_channel(), ast_bridge_basic_set_flags(), ast_bridge_channel_feature_digit(), ast_bridge_channel_lock_bridge(), ast_bridge_channel_merge_inhibit(), ast_bridge_destroy(), ast_bridge_get_snapshot(), ast_bridge_get_snapshot_by_uniqueid(), ast_bridge_is_video_src(), ast_bridge_join(), ast_bridge_kick(), ast_bridge_merge(), ast_bridge_merge_inhibit(), ast_bridge_move(), ast_bridge_notify_masquerade(), ast_bridge_number_video_src(), ast_bridge_peer(), ast_bridge_peers(), ast_bridge_remove(), ast_bridge_remove_video_src(), ast_bridge_set_binaural_active(), ast_bridge_set_internal_sample_rate(), ast_bridge_set_maximum_sample_rate(), ast_bridge_set_mixing_interval(), ast_bridge_set_remb_estimated_bitrate(), ast_bridge_set_remb_send_interval(), ast_bridge_set_send_sdp_label(), ast_bridge_set_sfu_video_mode(), ast_bridge_set_single_src_video_mode(), ast_bridge_set_talker_src_video_mode(), ast_bridge_set_video_update_discard(), ast_bridge_suspend(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), ast_bridge_unreal_optimize_out(), ast_bridge_unsuspend(), ast_bridge_update_talker_src_video_mode(), ast_brige_set_remb_behavior(), AST_TEST_DEFINE(), ast_unreal_channel_push_to_bridge(), attended_transfer_bridge(), basic_hangup_hook(), bridge_action_bridge(), bridge_basic_change_personality(), bridge_channel_handle_control(), bridge_channel_internal_join(), bridge_channel_snapshot_pair_init(), bridge_channel_suspend(), bridge_channel_unsuspend(), bridge_channel_wait(), bridge_channel_write_frame(), bridge_handle_trip(), bridge_impart_internal(), bridge_manager_service(), bridge_merge(), bridge_move(), bridge_queue_action_nodup(), bridge_register(), bridge_set_video_source_cb(), check_binaural_position_change(), complete_bridge_participant(), conf_moh_start(), conf_moh_stop(), deferred_action(), destroy_bridge(), feature_automixmonitor(), feature_automonitor(), handle_bridge_kick_channel(), native_rtp_framehook(), optimize_lock_chan_stack(), optimize_lock_peer_stack(), parking_blind_transfer_park(), play_uri(), send_conf_stasis(), send_conf_stasis_snapshots(), softmix_mixing_loop(), and softmix_mixing_thread().

Typedef Documentation

◆ ast_bridge_destructor_fn

typedef void(* ast_bridge_destructor_fn) (struct ast_bridge *self)

Destroy the bridge.

Parameters
selfBridge to operate upon.
Returns
Nothing

Definition at line 178 of file bridge.h.

◆ ast_bridge_dissolving_fn

typedef void(* ast_bridge_dissolving_fn) (struct ast_bridge *self)

The bridge is being dissolved.

Parameters
selfBridge to operate upon.

The bridge is being dissolved. Remove any external references to the bridge so it can be destroyed.

Note
On entry, self must NOT be locked.
Returns
Nothing

Definition at line 193 of file bridge.h.

◆ ast_bridge_merge_priority_fn

typedef int(* ast_bridge_merge_priority_fn) (struct ast_bridge *self)

Get the merge priority of this bridge.

Parameters
selfBridge to operate upon.
Note
On entry, self is already locked.
Returns
Merge priority

Definition at line 257 of file bridge.h.

◆ ast_bridge_notify_masquerade_fn

typedef void(* ast_bridge_notify_masquerade_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)

Notify the bridge that this channel was just masqueraded.

Parameters
selfBridge to operate upon.
bridge_channelBridge channel that was masqueraded.

A masquerade just happened to this channel. The bridge needs to re-evaluate this a channel in the bridge.

Note
On entry, self is already locked.
Returns
Nothing

Definition at line 246 of file bridge.h.

◆ ast_bridge_pull_channel_fn

typedef void(* ast_bridge_pull_channel_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel)

Pull this channel from the bridge.

Parameters
selfBridge to operate upon.
bridge_channelBridge channel to pull.

Remove any channel hooks controlled by the bridge. Release any resources held by bridge_channel->bridge_pvt and release bridge_channel->bridge_pvt.

Note
On entry, self is already locked.
Returns
Nothing

Definition at line 230 of file bridge.h.

◆ ast_bridge_push_channel_fn

typedef int(* ast_bridge_push_channel_fn) (struct ast_bridge *self, struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap)

Push this channel into the bridge.

Parameters
selfBridge to operate upon.
bridge_channelBridge channel to push.
swapBridge channel to swap places with if not NULL.

Setup any channel hooks controlled by the bridge. Allocate bridge_channel->bridge_pvt and initialize any resources put in bridge_channel->bridge_pvt if needed. If there is a swap channel, use it as a guide to setting up the bridge_channel.

Note
On entry, self is already locked.
Return values
0on success.
-1on failure. The channel did not get pushed.

Definition at line 213 of file bridge.h.

◆ transfer_channel_cb

typedef void(* transfer_channel_cb) (struct ast_channel *chan, struct transfer_channel_data *user_data, enum ast_transfer_type transfer_type)

Callback function type called during blind transfers.

A caller of ast_bridge_transfer_blind() may wish to set data on the channel that ends up running dialplan. For instance, it may be useful to set channel variables on the channel.

Parameters
chanThe involved channel
user_dataUser-provided data needed in the callback
transfer_typeThe type of transfer being completed

Definition at line 1160 of file bridge.h.

Enumeration Type Documentation

◆ ast_bridge_capability

Capabilities for a bridge technology.

Enumerator
AST_BRIDGE_CAPABILITY_HOLDING 

Bridge technology can service calls on hold.

AST_BRIDGE_CAPABILITY_EARLY 

Bridge waits for channel to answer. Passes early media. (XXX Not supported yet)

AST_BRIDGE_CAPABILITY_NATIVE 

Bridge is capable of natively bridging two channels. (Smart bridge only)

AST_BRIDGE_CAPABILITY_1TO1MIX 

Bridge is capable of mixing at most two channels. (Smart bridgeable)

AST_BRIDGE_CAPABILITY_MULTIMIX 

Bridge is capable of mixing an arbitrary number of channels. (Smart bridgeable)

Definition at line 84 of file bridge.h.

84  {
85  /*! Bridge technology can service calls on hold. */
87  /*! Bridge waits for channel to answer. Passes early media. (XXX Not supported yet) */
88  AST_BRIDGE_CAPABILITY_EARLY = (1 << 1),
89  /*! Bridge is capable of natively bridging two channels. (Smart bridge only) */
91  /*! Bridge is capable of mixing at most two channels. (Smart bridgeable) */
93  /*! Bridge is capable of mixing an arbitrary number of channels. (Smart bridgeable) */
95 };

◆ ast_bridge_impart_flags

Enumerator
AST_BRIDGE_IMPART_CHAN_MASK 

Field describing what the caller can do with the channel after it is imparted.

AST_BRIDGE_IMPART_CHAN_DEPARTABLE 

The caller wants to reclaim the channel using ast_bridge_depart().

AST_BRIDGE_IMPART_CHAN_INDEPENDENT 

The caller is passing channel control entirely to the bridging system.

AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP 

The initial bridge join does not cause a COLP exchange.

Definition at line 598 of file bridge.h.

598  {
599  /*! Field describing what the caller can do with the channel after it is imparted. */
600  AST_BRIDGE_IMPART_CHAN_MASK = (1 << 0),
601  /*! The caller wants to reclaim the channel using ast_bridge_depart(). */
603  /*! The caller is passing channel control entirely to the bridging system. */
605  /*! The initial bridge join does not cause a COLP exchange. */
607 };

◆ ast_bridge_join_flags

Enumerator
AST_BRIDGE_JOIN_PASS_REFERENCE 

The bridge reference is being passed by the caller.

AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP 

The initial bridge join does not cause a COLP exchange.

Definition at line 547 of file bridge.h.

547  {
548  /*! The bridge reference is being passed by the caller. */
550  /*! The initial bridge join does not cause a COLP exchange. */
552 };

◆ ast_bridge_optimization

Tells, if optimization is allowed, how the optimization would be performed.

Enumerator
AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE 

Optimization would swap peer into the chan_bridge

AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE 

Optimization would swap chan into the peer_bridge

AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE 

Optimization would merge peer_bridge into chan_bridge

AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE 

Optimization would merge chan_bridge into peer_bridge

AST_BRIDGE_OPTIMIZE_PROHIBITED 

Optimization is not permitted on one or both bridges

Definition at line 891 of file bridge.h.

891  {
892  /*! Optimization would swap peer into the chan_bridge */
894  /*! Optimization would swap chan into the peer_bridge */
896  /*! Optimization would merge peer_bridge into chan_bridge */
898  /*! Optimization would merge chan_bridge into peer_bridge */
900  /*! Optimization is not permitted on one or both bridges */
902 };

◆ ast_bridge_video_mode_type

Video source modes.

Enumerator
AST_BRIDGE_VIDEO_MODE_NONE 

Video is not allowed in the bridge

AST_BRIDGE_VIDEO_MODE_SINGLE_SRC 

A single user is picked as the only distributed of video across the bridge

AST_BRIDGE_VIDEO_MODE_TALKER_SRC 

A single user's video feed is distributed to all bridge channels, but that feed is automatically picked based on who is talking the most.

AST_BRIDGE_VIDEO_MODE_SFU 

Operate as a selective forwarding unit. Video from each participant is cloned to a dedicated stream on a subset of the remaining participants.

Definition at line 98 of file bridge.h.

98  {
99  /*! Video is not allowed in the bridge */
101  /*! A single user is picked as the only distributed of video across the bridge */
103  /*! A single user's video feed is distributed to all bridge channels, but
104  * that feed is automatically picked based on who is talking the most. */
106  /*! Operate as a selective forwarding unit. Video from each participant is
107  * cloned to a dedicated stream on a subset of the remaining participants.
108  */
110 };

◆ ast_bridge_video_sfu_remb_behavior

REMB report behaviors.

Enumerator
AST_BRIDGE_VIDEO_SFU_REMB_AVERAGE 

The average of all reports is sent to the sender

AST_BRIDGE_VIDEO_SFU_REMB_LOWEST 

The lowest reported bitrate is forwarded to the sender

AST_BRIDGE_VIDEO_SFU_REMB_HIGHEST 

The highest reported bitrate is forwarded to the sender

AST_BRIDGE_VIDEO_SFU_REMB_AVERAGE_ALL 

The average of all reports WITHIN the bridge is sent to each sender

AST_BRIDGE_VIDEO_SFU_REMB_LOWEST_ALL 

The lowest reported bitrate from all channels in the bridge is forwarded to each sender

AST_BRIDGE_VIDEO_SFU_REMB_HIGHEST_ALL 

The highest reported bitrate from all channels in the bridge is forwarded to each sender

AST_BRIDGE_VIDEO_SFU_REMB_FORCE 

Force the REMB estimated bitrate to a specified value

Definition at line 131 of file bridge.h.

131  {
132  /*! The average of all reports is sent to the sender */
134  /*! The lowest reported bitrate is forwarded to the sender */
136  /*! The highest reported bitrate is forwarded to the sender */
138  /*! The average of all reports WITHIN the bridge is sent to each sender */
140  /*! The lowest reported bitrate from all channels in the bridge is forwarded to each sender */
142  /*! The highest reported bitrate from all channels in the bridge is forwarded to each sender */
144  /*! Force the REMB estimated bitrate to a specified value */
146 };

◆ ast_transfer_result

Enumerator
AST_BRIDGE_TRANSFER_SUCCESS 

The transfer completed successfully

AST_BRIDGE_TRANSFER_NOT_PERMITTED 

A bridge involved does not permit transferring

AST_BRIDGE_TRANSFER_INVALID 

The current bridge setup makes transferring an invalid operation

AST_BRIDGE_TRANSFER_FAIL 

The transfer operation failed for a miscellaneous reason

Definition at line 1115 of file bridge.h.

1115  {
1116  /*! The transfer completed successfully */
1118  /*! A bridge involved does not permit transferring */
1120  /*! The current bridge setup makes transferring an invalid operation */
1122  /*! The transfer operation failed for a miscellaneous reason */
1124 };

◆ ast_transfer_type

Enumerator
AST_BRIDGE_TRANSFER_SINGLE_PARTY 

Transfer of a single party

AST_BRIDGE_TRANSFER_MULTI_PARTY 

Transfer of multiple parties

Definition at line 1126 of file bridge.h.

1126  {
1127  /*! Transfer of a single party */
1129  /*! Transfer of multiple parties */
1131 };

Function Documentation

◆ _ast_bridge_lock()

static void _ast_bridge_lock ( struct ast_bridge bridge,
const char *  file,
const char *  function,
int  line,
const char *  var 
)
inlinestatic

Definition at line 481 of file bridge.h.

References __ao2_lock(), and AO2_LOCK_REQ_MUTEX.

482 {
483  __ao2_lock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
484 }
int __ao2_lock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var)
Lock an object.
Definition: astobj2.c:222
#define var
Definition: ast_expr2f.c:614

◆ _ast_bridge_trylock()

static int _ast_bridge_trylock ( struct ast_bridge bridge,
const char *  file,
const char *  function,
int  line,
const char *  var 
)
inlinestatic

Definition at line 468 of file bridge.h.

References __ao2_trylock(), and AO2_LOCK_REQ_MUTEX.

469 {
470  return __ao2_trylock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
471 }
#define var
Definition: ast_expr2f.c:614
int __ao2_trylock(void *a, enum ao2_lock_req lock_how, const char *file, const char *func, int line, const char *var)
Try locking– (don&#39;t block if fail)
Definition: astobj2.c:342

◆ _ast_bridge_unlock()

static void _ast_bridge_unlock ( struct ast_bridge bridge,
const char *  file,
const char *  function,
int  line,
const char *  var 
)
inlinestatic

Definition at line 494 of file bridge.h.

References __ao2_unlock().

495 {
496  __ao2_unlock(bridge, file, function, line, var);
497 }
#define var
Definition: ast_expr2f.c:614
int __ao2_unlock(void *a, const char *file, const char *func, int line, const char *var)
Unlock an object.
Definition: astobj2.c:288

◆ ast_bridge_base_new()

struct ast_bridge* ast_bridge_base_new ( uint32_t  capabilities,
unsigned int  flags,
const char *  creator,
const char *  name,
const char *  id 
)

Create a new base class bridge.

Parameters
capabilitiesThe capabilities that we require to be used on the bridge
flagsFlags that will alter the behavior of the bridge
creatorEntity that created the bridge (optional)
nameName given to the bridge by its creator (optional, requires named creator)
idUnique ID given to the bridge by its creator (optional)
Return values
apointer to a new bridge on success
NULLon failure

Example usage:

This creates a no frills two party bridge that will be destroyed once one of the channels hangs up.

Definition at line 960 of file bridge.c.

References bridge_manager_request::bridge, bridge_alloc(), bridge_base_init(), and bridge_register().

Referenced by AST_TEST_DEFINE(), get_wait_bridge_wrapper(), and join_conference_bridge().

961 {
962  void *bridge;
963 
964  bridge = bridge_alloc(sizeof(struct ast_bridge), &ast_bridge_base_v_table);
965  bridge = bridge_base_init(bridge, capabilities, flags, creator, name, id);
966  bridge = bridge_register(bridge);
967  return bridge;
968 }
struct ast_bridge * bridge_alloc(size_t size, const struct ast_bridge_methods *v_table)
Definition: bridge.c:724
struct ast_bridge_methods ast_bridge_base_v_table
Bridge base class virtual method table.
Definition: bridge.c:949
struct ast_bridge * bridge_register(struct ast_bridge *bridge)
Register the new bridge with the system.
Definition: bridge.c:709
Structure that contains information about a bridge.
Definition: bridge.h:357
static const char name[]
Definition: cdr_mysql.c:74
const ast_string_field creator
Definition: bridge.h:409
struct ast_bridge * bridge_base_init(struct ast_bridge *self, uint32_t capabilities, unsigned int flags, const char *creator, const char *name, const char *id)
Initialize the base class of the bridge.
Definition: bridge.c:760

◆ ast_bridge_depart()

int ast_bridge_depart ( struct ast_channel chan)

Depart a channel from a bridge.

Parameters
chanChannel to depart
Note
chan is locked by this function.
Return values
0on success
-1on failure

Example usage:

This removes the channel pointed to by the chan pointer from any bridge it may be in and gives control to the calling thread. This does not hang up the channel.

Note
This API call can only be used on channels that were added to the bridge using the ast_bridge_impart API call with the AST_BRIDGE_IMPART_CHAN_DEPARTABLE flag.

Definition at line 1952 of file bridge.c.

References ao2_ref, ast_assert, ast_bridge_channel_leave_bridge(), AST_CAUSE_NORMAL_CLEARING, ast_channel_internal_bridge_channel(), ast_channel_internal_bridge_channel_set(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_debug, ast_log, BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, ast_bridge_channel::chan, ast_bridge_channel::depart_wait, LOG_ERROR, NULL, SCOPE_TRACE, and ast_bridge_channel::thread.

Referenced by app_control_continue(), AST_TEST_DEFINE(), control_swap_channel_in_bridge(), depart_channel(), and stasis_app_exec().

1953 {
1954  struct ast_bridge_channel *bridge_channel;
1955  int departable;
1956  SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
1957 
1958  ast_channel_lock(chan);
1959  bridge_channel = ast_channel_internal_bridge_channel(chan);
1960  departable = bridge_channel && bridge_channel->depart_wait;
1961  ast_channel_unlock(chan);
1962  if (!departable) {
1963  ast_log(LOG_ERROR, "Channel %s cannot be departed.\n",
1964  ast_channel_name(chan));
1965  /*
1966  * Should never happen. It likely means that
1967  * ast_bridge_depart() is called by two threads for the same
1968  * channel, the channel was never imparted to be departed, or it
1969  * has already been departed.
1970  */
1971  ast_assert(0);
1972  return -1;
1973  }
1974 
1975  /*
1976  * We are claiming the bridge_channel reference held by
1977  * bridge_channel_depart_thread().
1978  */
1979 
1980  ast_bridge_channel_leave_bridge(bridge_channel,
1982 
1983  /* Wait for the depart thread to die */
1984  ast_debug(1, "Waiting for %p(%s) bridge thread to die.\n",
1985  bridge_channel, ast_channel_name(bridge_channel->chan));
1986  pthread_join(bridge_channel->thread, NULL);
1987 
1988  ast_channel_lock(chan);
1990  ast_channel_unlock(chan);
1991 
1992  /* We can get rid of the bridge_channel after the depart thread has died. */
1993  ao2_ref(bridge_channel, -1);
1994  return 0;
1995 }
void ast_channel_internal_bridge_channel_set(struct ast_channel *chan, struct ast_bridge_channel *value)
#define ast_channel_lock(chan)
Definition: channel.h:2890
#define SCOPE_TRACE(__level,...)
Definition: logger.h:883
#define ast_assert(a)
Definition: utils.h:650
#define NULL
Definition: resample.c:96
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ast_log
Definition: astobj2.c:42
#define AST_CAUSE_NORMAL_CLEARING
Definition: causes.h:105
#define ao2_ref(o, delta)
Definition: astobj2.h:464
struct ast_bridge_channel * ast_channel_internal_bridge_channel(const struct ast_channel *chan)
#define LOG_ERROR
Definition: logger.h:285
void ast_bridge_channel_leave_bridge(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state, int cause)
Set bridge channel state to leave bridge (if not leaving already).
#define ast_channel_unlock(chan)
Definition: channel.h:2891
struct ast_channel * chan
Structure that contains information regarding a channel in a bridge.
const char * ast_channel_name(const struct ast_channel *chan)
unsigned int depart_wait

◆ ast_bridge_destroy()

int ast_bridge_destroy ( struct ast_bridge bridge,
int  cause 
)

Destroy a bridge.

Parameters
bridgeBridge to destroy
causeCause of bridge being destroyed. (If cause <= 0 then use AST_CAUSE_NORMAL_CLEARING)
Return values
0on success
-1on failure

Example usage:

This destroys a bridge that was previously created.

Note
While this function will kick all channels out of the bridge, channels that were added to the bridge using ast_bridge_impart() with the flag AST_BRIDGE_IMPART_CHAN_DEPARTABLE set must have ast_bridge_depart() called on them.

Definition at line 970 of file bridge.c.

References ao2_ref, ast_bridge_lock, ast_bridge_unlock, ast_debug, bridge_dissolve(), and ast_bridge::uniqueid.

Referenced by action_bridge(), agent_connect_caller(), agent_logout(), agent_pvt_destructor(), agent_request_exec(), agent_run(), ast_bridge_call_with_flags(), attended_transfer_properties_shutdown(), bridge_create_common(), bridge_exec(), bridge_register(), caller_abort_agent(), destroy_conference_bridge(), fail_enter(), handle_bridge_show_specific(), manager_bridge_destroy(), parked_call_app_exec(), parking_lot_destructor(), safe_bridge_destroy(), stasis_app_bridge_destroy(), stasis_app_control_shutdown(), unload_module(), wait_bridge_wrapper_alloc(), and wait_bridge_wrapper_destructor().

971 {
972  ast_debug(1, "Bridge %s: telling all channels to leave the party\n", bridge->uniqueid);
973  ast_bridge_lock(bridge);
974  bridge_dissolve(bridge, cause);
975  ast_bridge_unlock(bridge);
976 
977  ao2_ref(bridge, -1);
978 
979  return 0;
980 }
const ast_string_field uniqueid
Definition: bridge.h:409
void bridge_dissolve(struct ast_bridge *bridge, int cause)
Definition: bridge.c:319
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ao2_ref(o, delta)
Definition: astobj2.h:464
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_features_remove()

void ast_bridge_features_remove ( struct ast_bridge_features features,
enum ast_bridge_hook_remove_flags  flags 
)

Remove marked bridge channel feature hooks.

Since
12.0.0
Parameters
featuresBridge features structure
flagsDeterminator for whether hook is removed.
Returns
Nothing

Definition at line 3568 of file bridge.c.

References ast_bridge_features::dtmf_hooks, hooks_remove_container(), hooks_remove_heap(), ast_bridge_features::interval_hooks, and ast_bridge_features::other_hooks.

Referenced by bridge_base_pull(), bridge_channel_internal_join(), bridge_do_merge(), bridge_do_move(), and remove_hooks_on_personality_change().

3569 {
3570  hooks_remove_container(features->dtmf_hooks, remove_flags);
3571  hooks_remove_container(features->other_hooks, remove_flags);
3572  hooks_remove_heap(features->interval_hooks, remove_flags);
3573 }
struct ao2_container * dtmf_hooks
static void hooks_remove_heap(struct ast_heap *hooks, enum ast_bridge_hook_remove_flags remove_flags)
Definition: bridge.c:3546
static void hooks_remove_container(struct ao2_container *hooks, enum ast_bridge_hook_remove_flags remove_flags)
Definition: bridge.c:3530
struct ast_heap * interval_hooks
struct ao2_container * other_hooks

◆ ast_bridge_find_by_id()

struct ast_bridge* ast_bridge_find_by_id ( const char *  bridge_id)

Find bridge by id.

Since
12.0.0
Parameters
bridge_idBridge identifier
Returns
NULL bridge not found
non-NULL reference to bridge

Definition at line 5070 of file bridge.c.

References ao2_find, and OBJ_SEARCH_KEY.

Referenced by ast_bridge_get_snapshot_by_uniqueid(), complete_bridge_participant(), handle_bridge_kick_channel(), handle_bridge_show_specific(), manager_bridge_destroy(), and manager_bridge_kick().

5071 {
5072  return ao2_find(bridges, bridge_id, OBJ_SEARCH_KEY);
5073 }
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1105
static struct ao2_container * bridges
Definition: bridge.c:123
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1756

◆ ast_bridge_impart()

int ast_bridge_impart ( struct ast_bridge bridge,
struct ast_channel chan,
struct ast_channel swap,
struct ast_bridge_features features,
enum ast_bridge_impart_flags  flags 
)

Impart a channel to a bridge (non-blocking)

Parameters
bridgeBridge to impart on
chanChannel to impart (The channel reference is stolen if impart successful.)
swapChannel to swap out if swapping. NULL if not swapping.
featuresBridge features structure.
flagsdefined by enum ast_bridge_impart_flags.
Note
The given bridge must be unlocked when calling this function.
The features parameter must be NULL or obtained by ast_bridge_features_new(). You must not dereference features after calling even if the call fails.
chan is locked by this function.
Return values
0on success
-1on failure (Caller still has ownership of chan)

Example usage:

This adds a channel pointed to by the chan pointer to the bridge pointed to by the bridge pointer. This function will return immediately and will not wait until the channel is no longer part of the bridge.

If this channel will be replacing another channel the other channel can be specified in the swap parameter. The other channel will be thrown out of the bridge in an atomic fashion.

If channel specific features are enabled, a pointer to the features structure can be specified in the features parameter.

Note
If you impart a channel with AST_BRIDGE_IMPART_CHAN_DEPARTABLE you MUST ast_bridge_depart() the channel if this call succeeds. The bridge channel thread is created join-able. The implication is that the channel is special and will not behave like a normal channel.
If you impart a channel with AST_BRIDGE_IMPART_CHAN_INDEPENDENT you must not ast_bridge_depart() the channel. The bridge channel thread is created non-join-able. The channel must be treated as if it were placed into the bridge by ast_bridge_join(). Channels placed into a bridge by ast_bridge_join() are removed by a third party using ast_bridge_remove().
Any callbacks on the channel will be invoked on failure with the reason as AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED.

Definition at line 1924 of file bridge.c.

References AST_BRIDGE_AFTER_CB_REASON_IMPART_FAILED, ast_bridge_discard_after_callback(), ast_channel_name(), ast_cond_destroy, ast_cond_init, ast_mutex_destroy, ast_mutex_init, bridge_channel_impart_signal(), bridge_impart_internal(), bridge_channel_impart_cond::cond, bridge_channel_impart_cond::done, bridge_channel_impart_cond::lock, NULL, SCOPE_TRACE, and ast_bridge::uniqueid.

Referenced by add_to_dial_bridge(), ast_bridge_add_channel(), ast_bridge_call_with_flags(), AST_TEST_DEFINE(), ast_unreal_channel_push_to_bridge(), attended_transfer_bridge(), blind_transfer_bridge(), conf_announce_channel_push(), conf_start_record(), control_swap_channel_in_bridge(), feature_attended_transfer(), handle_invite_replaces(), local_call(), parking_blind_transfer_park(), recalling_exit(), refer_incoming_invite_request(), and retransfer_enter().

1929 {
1930  struct bridge_channel_impart_cond cond = {
1931  .done = 0,
1932  };
1933  int res;
1934  SCOPE_TRACE(1, "%s Bridge: %s\n", ast_channel_name(chan), bridge->uniqueid);
1935 
1936  ast_mutex_init(&cond.lock);
1937  ast_cond_init(&cond.cond, NULL);
1938 
1939  res = bridge_impart_internal(bridge, chan, swap, features, flags, &cond);
1940  if (res) {
1941  /* Impart failed. Signal any other waiting impart threads */
1944  }
1945 
1946  ast_cond_destroy(&cond.cond);
1947  ast_mutex_destroy(&cond.lock);
1948 
1949  return res;
1950 }
Internal bridge impart wait condition and associated conditional.
Definition: bridge.c:1515
const ast_string_field uniqueid
Definition: bridge.h:409
#define SCOPE_TRACE(__level,...)
Definition: logger.h:883
void bridge_channel_impart_signal(struct ast_channel *chan)
Signal imparting threads to wake up.
Definition: bridge.c:1626
#define ast_cond_init(cond, attr)
Definition: lock.h:199
#define NULL
Definition: resample.c:96
void ast_bridge_discard_after_callback(struct ast_channel *chan, enum ast_bridge_after_cb_reason reason)
Run discarding any after bridge callbacks.
Definition: bridge_after.c:247
ast_cond_t cond
Definition: app_meetme.c:1090
#define ast_cond_destroy(cond)
Definition: lock.h:200
const char * ast_channel_name(const struct ast_channel *chan)
#define ast_mutex_init(pmutex)
Definition: lock.h:184
#define ast_mutex_destroy(a)
Definition: lock.h:186
static int bridge_impart_internal(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, enum ast_bridge_impart_flags flags, struct bridge_channel_impart_cond *cond)
Definition: bridge.c:1823

◆ ast_bridge_is_video_src()

int ast_bridge_is_video_src ( struct ast_bridge bridge,
struct ast_channel chan 
)

Determine if a channel is a video src for the bridge.

Return values
0Not a current video source of the bridge.
None0, is a video source of the bridge, The number returned represents the priority this video stream has on the bridge where 1 is the highest priority.

Definition at line 3958 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_NONE, AST_BRIDGE_VIDEO_MODE_SFU, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, AST_BRIDGE_VIDEO_MODE_TALKER_SRC, ast_bridge_video_talker_src_data::chan_old_vsrc, ast_bridge_video_single_src_data::chan_vsrc, ast_bridge_video_talker_src_data::chan_vsrc, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge_video_mode::single_src_data, ast_bridge::softmix, ast_bridge_video_mode::talker_src_data, and ast_bridge_softmix::video_mode.

Referenced by handle_video_on_exit(), handle_video_on_join(), softmix_bridge_write_video(), and softmix_pass_video_top_priority().

3959 {
3960  int res = 0;
3961 
3962  ast_bridge_lock(bridge);
3963  switch (bridge->softmix.video_mode.mode) {
3965  break;
3967  if (bridge->softmix.video_mode.mode_data.single_src_data.chan_vsrc == chan) {
3968  res = 1;
3969  }
3970  break;
3972  if (bridge->softmix.video_mode.mode_data.talker_src_data.chan_vsrc == chan) {
3973  res = 1;
3974  } else if (bridge->softmix.video_mode.mode_data.talker_src_data.chan_old_vsrc == chan) {
3975  res = 2;
3976  }
3978  break;
3979  }
3980  ast_bridge_unlock(bridge);
3981  return res;
3982 }
union ast_bridge_video_mode::@221 mode_data
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
struct ast_channel * chan_old_vsrc
Definition: bridge.h:127
struct ast_channel * chan_vsrc
Definition: bridge.h:116
struct ast_bridge_softmix softmix
Definition: bridge.h:375
struct ast_bridge_video_talker_src_data talker_src_data
Definition: bridge.h:164
struct ast_bridge_video_single_src_data single_src_data
Definition: bridge.h:163
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
struct ast_channel * chan_vsrc
Definition: bridge.h:123
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_join()

int ast_bridge_join ( struct ast_bridge bridge,
struct ast_channel chan,
struct ast_channel swap,
struct ast_bridge_features features,
struct ast_bridge_tech_optimizations tech_args,
enum ast_bridge_join_flags  flags 
)

Join a channel to a bridge (blocking)

Parameters
bridgeBridge to join
chanChannel to join
swapChannel to swap out if swapping (A channel reference is stolen.)
featuresBridge features structure
tech_argsOptional Bridging tech optimization parameters for this channel.
flagsdefined by enum ast_bridge_join_flags.
Note
The passed in swap channel is always unreffed on return. It is not a good idea to access the swap channel on return or for the caller to keep a reference to it.
Absolutely NO locks should be held before calling this function since it blocks.
Return values
0if the channel successfully joined the bridge before it exited.
-1if the channel failed to join the bridge

Example usage:

This adds a channel pointed to by the chan pointer to the bridge pointed to by the bridge pointer. This function will not return until the channel has been removed from the bridge, swapped out for another channel, or has hung up.

If this channel will be replacing another channel the other channel can be specified in the swap parameter. The other channel will be thrown out of the bridge in an atomic fashion.

If channel specific features are enabled a pointer to the features structure can be specified in the features parameter.

Definition at line 1667 of file bridge.c.

References ao2_lock, ao2_ref, ao2_t_cleanup, ao2_unlock, ast_assert, AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP, AST_BRIDGE_JOIN_PASS_REFERENCE, ast_bridge_lock, ast_bridge_run_after_callback(), ast_bridge_setup_after_goto(), ast_bridge_unlock, ast_channel_flags(), ast_channel_internal_bridge_channel_set(), ast_channel_lock, ast_channel_name(), ast_channel_softhangup_internal_flag(), ast_channel_unlock, AST_FLAG_ZOMBIE, AST_SOFTHANGUP_ASYNCGOTO, ast_softhangup_nolock(), ast_test_flag, bridge_channel_impart_signal(), bridge_channel_internal_alloc(), bridge_channel_internal_join(), bridge_find_channel(), ast_bridge_channel::chan, ast_bridge_channel::features, ast_bridge_channel::inhibit_colp, NULL, ast_bridge_methods::push_peek, SCOPE_TRACE, ast_bridge_channel::swap, ast_bridge_channel::tech_args, ast_bridge_channel::thread, ast_bridge::uniqueid, and ast_bridge::v_table.

Referenced by agent_request_exec(), agent_run(), ast_bridge_call_with_flags(), bridge_exec(), bridgeadd_exec(), bridgewait_exec(), confbridge_exec(), park_and_announce_app_exec(), park_app_exec(), and parked_call_app_exec().

1673 {
1674  struct ast_bridge_channel *bridge_channel;
1675  int res = 0;
1676  SCOPE_TRACE(1, "%s Bridge: %s\n", ast_channel_name(chan), bridge->uniqueid);
1677 
1678  bridge_channel = bridge_channel_internal_alloc(bridge);
1679  if (flags & AST_BRIDGE_JOIN_PASS_REFERENCE) {
1680  ao2_ref(bridge, -1);
1681  }
1682  if (!bridge_channel) {
1683  ao2_t_cleanup(swap, "Error exit: bridge_channel alloc failed");
1684  res = -1;
1685  goto join_exit;
1686  }
1687 /* XXX ASTERISK-21271 features cannot be NULL when passed in. When it is changed to allocated we can do like ast_bridge_impart() and allocate one. */
1688  ast_assert(features != NULL);
1689  if (!features) {
1690  ao2_ref(bridge_channel, -1);
1691  ao2_t_cleanup(swap, "Error exit: features is NULL");
1692  res = -1;
1693  goto join_exit;
1694  }
1695  if (tech_args) {
1696  bridge_channel->tech_args = *tech_args;
1697  }
1698 
1699  ast_channel_lock(chan);
1701  res = -1;
1702  } else {
1703  ast_channel_internal_bridge_channel_set(chan, bridge_channel);
1704  }
1705  ast_channel_unlock(chan);
1706  bridge_channel->thread = pthread_self();
1707  bridge_channel->chan = chan;
1708  bridge_channel->swap = swap;
1709  bridge_channel->features = features;
1710  bridge_channel->inhibit_colp = !!(flags & AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP);
1711 
1712  /* allow subclass to peek at upcoming push operation */
1713  if (bridge->v_table->push_peek && !res) {
1714  struct ast_bridge_channel *bcswap = NULL;
1715 
1716  ast_bridge_lock(bridge);
1717  if (bridge_channel->swap) {
1718  bcswap = bridge_find_channel(bridge, bridge_channel->swap);
1719  }
1720  res = bridge->v_table->push_peek(bridge, bridge_channel, bcswap);
1721  ast_bridge_unlock(bridge);
1722  }
1723 
1724  if (!res) {
1725  res = bridge_channel_internal_join(bridge_channel);
1726  }
1727 
1728  /* Cleanup all the data in the bridge channel after it leaves the bridge. */
1729  ast_channel_lock(chan);
1731  ast_channel_unlock(chan);
1732  /* Due to a race condition, we lock the bridge channel here for ast_bridge_channel_get_chan */
1733  ao2_lock(bridge_channel);
1734  bridge_channel->chan = NULL;
1735  ao2_unlock(bridge_channel);
1736  /* If bridge_channel->swap is not NULL then the join failed. */
1737  ao2_t_cleanup(bridge_channel->swap, "Bridge complete: join failed");
1738  bridge_channel->swap = NULL;
1739  bridge_channel->features = NULL;
1740 
1741  ao2_ref(bridge_channel, -1);
1742 
1743 join_exit:
1747  && !ast_bridge_setup_after_goto(chan)) {
1748  /* Claim the after bridge goto is an async goto destination. */
1749  ast_channel_lock(chan);
1750  ast_softhangup_nolock(chan, AST_SOFTHANGUP_ASYNCGOTO);
1751  ast_channel_unlock(chan);
1752  }
1753  return res;
1754 }
void ast_channel_internal_bridge_channel_set(struct ast_channel *chan, struct ast_bridge_channel *value)
#define ast_channel_lock(chan)
Definition: channel.h:2890
#define ao2_t_cleanup(obj, tag)
Definition: astobj2.h:1959
const ast_string_field uniqueid
Definition: bridge.h:409
struct ast_bridge_features * features
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define SCOPE_TRACE(__level,...)
Definition: logger.h:883
void bridge_channel_impart_signal(struct ast_channel *chan)
Signal imparting threads to wake up.
Definition: bridge.c:1626
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
#define ast_assert(a)
Definition: utils.h:650
#define ao2_unlock(a)
Definition: astobj2.h:730
#define NULL
Definition: resample.c:96
#define ao2_ref(o, delta)
Definition: astobj2.h:464
#define ao2_lock(a)
Definition: astobj2.h:718
const struct ast_bridge_methods * v_table
Definition: bridge.h:359
struct ast_bridge_tech_optimizations tech_args
int ast_softhangup_nolock(struct ast_channel *chan, int reason)
Softly hangup up a channel (no channel lock)
Definition: channel.c:2449
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
void ast_bridge_run_after_callback(struct ast_channel *chan)
Run any after bridge callback.
Definition: bridge_after.c:220
unsigned int inhibit_colp
struct ast_channel * swap
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
int ast_channel_softhangup_internal_flag(struct ast_channel *chan)
struct ast_channel * chan
Structure that contains information regarding a channel in a bridge.
ast_bridge_push_channel_fn push_peek
Definition: bridge.h:281
struct ast_bridge_channel * bridge_channel_internal_alloc(struct ast_bridge *bridge)
const char * ast_channel_name(const struct ast_channel *chan)
int bridge_channel_internal_join(struct ast_bridge_channel *bridge_channel)
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int ast_bridge_setup_after_goto(struct ast_channel *chan)
Setup any after bridge goto location to begin execution.
Definition: bridge_after.c:447

◆ ast_bridge_kick()

int ast_bridge_kick ( struct ast_bridge bridge,
struct ast_channel chan 
)

Kick a channel from a bridge.

Parameters
bridgeBridge that the channel is to be kicked from
chanChannel to kick
Return values
0on success
-1on failure

Example usage:

ast_bridge_kick(bridge, chan);

This kicks the channel pointed to by the chan pointer from the bridge pointed to by the bridge pointer and requests that it be hung up. Control over the channel will NOT be given to the calling thread.

Note
The functional difference between ast_bridge_kick() and ast_bridge_remove() is that the bridge may dissolve as a result of the channel being kicked.
This API call can be used on channels that were added to the bridge using both ast_bridge_join and ast_bridge_impart.

Definition at line 2025 of file bridge.c.

References ast_bridge_channel_queue_callback(), ast_bridge_lock, ast_bridge_unlock, bridge_find_channel(), kick_it(), and NULL.

Referenced by handle_bridge_kick_channel(), and manager_bridge_kick().

2026 {
2027  struct ast_bridge_channel *bridge_channel;
2028  int res;
2029 
2030  ast_bridge_lock(bridge);
2031 
2032  /* Try to find the channel that we want to kick. */
2033  if (!(bridge_channel = bridge_find_channel(bridge, chan))) {
2034  ast_bridge_unlock(bridge);
2035  return -1;
2036  }
2037 
2038  res = ast_bridge_channel_queue_callback(bridge_channel, 0, kick_it, NULL, 0);
2039 
2040  ast_bridge_unlock(bridge);
2041 
2042  return res;
2043 }
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
static void kick_it(struct ast_bridge_channel *bridge_channel, const void *payload, size_t payload_size)
Definition: bridge.c:2020
#define NULL
Definition: resample.c:96
int ast_bridge_channel_queue_callback(struct ast_bridge_channel *bridge_channel, enum ast_bridge_channel_custom_callback_option flags, ast_bridge_custom_callback_fn callback, const void *payload, size_t payload_size)
Queue a bridge action custom callback frame onto the bridge channel.
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.

◆ ast_bridge_merge()

int ast_bridge_merge ( struct ast_bridge dst_bridge,
struct ast_bridge src_bridge,
int  merge_best_direction,
struct ast_channel **  kick_me,
unsigned int  num_kick 
)

Merge two bridges together.

Parameters
dst_bridgeDestination bridge of merge.
src_bridgeSource bridge of merge.
merge_best_directionTRUE if don't care about which bridge merges into the other.
kick_meArray of channels to kick from the bridges.
num_kickNumber of channels in the kick_me array.
Note
Absolutely NO bridge or channel locks should be held before calling this function.
Return values
0on success
-1on failure

Example usage:

ast_bridge_merge(dst_bridge, src_bridge, 0, NULL, 0);

This moves the channels in src_bridge into the bridge pointed to by dst_bridge.

Definition at line 2348 of file bridge.c.

References ast_assert, ast_bridge_lock_both, ast_bridge_unlock, and bridge_merge_locked().

2349 {
2350  int res;
2351 
2352  /* Sanity check. */
2353  ast_assert(dst_bridge && src_bridge);
2354 
2355  ast_bridge_lock_both(dst_bridge, src_bridge);
2356  res = bridge_merge_locked(dst_bridge, src_bridge, merge_best_direction, kick_me, num_kick);
2357  ast_bridge_unlock(src_bridge);
2358  ast_bridge_unlock(dst_bridge);
2359  return res;
2360 }
#define ast_bridge_lock_both(bridge1, bridge2)
Lock two bridges.
Definition: bridge.h:500
static int bridge_merge_locked(struct ast_bridge *dst_bridge, struct ast_bridge *src_bridge, int merge_best_direction, struct ast_channel **kick_me, unsigned int num_kick)
Definition: bridge.c:2264
#define ast_assert(a)
Definition: utils.h:650
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493

◆ ast_bridge_merge_inhibit()

void ast_bridge_merge_inhibit ( struct ast_bridge bridge,
int  request 
)

Adjust the bridge merge inhibit request count.

Since
12.0.0
Parameters
bridgeWhat to operate on.
requestInhibit request increment. (Positive to add requests. Negative to remove requests.)
Returns
Nothing

Definition at line 3061 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, and bridge_merge_inhibit_nolock().

Referenced by attended_transfer_properties_shutdown(), consulting_exit(), and feature_attended_transfer().

3062 {
3063  ast_bridge_lock(bridge);
3065  ast_bridge_unlock(bridge);
3066 }
void bridge_merge_inhibit_nolock(struct ast_bridge *bridge, int request)
Definition: bridge.c:3052
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
static int request(void *obj)
Definition: chan_pjsip.c:2641
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_move()

int ast_bridge_move ( struct ast_bridge dst_bridge,
struct ast_bridge src_bridge,
struct ast_channel chan,
struct ast_channel swap,
int  attempt_recovery 
)

Move a channel from one bridge to another.

Since
12.0.0
Parameters
dst_bridgeDestination bridge of bridge channel move.
src_bridgeSource bridge of bridge channel move.
chanChannel to move.
swapChannel to replace in dst_bridge.
attempt_recoveryTRUE if failure attempts to push channel back into original bridge.
Note
Absolutely NO bridge or channel locks should be held before calling this function.
Return values
0on success.
-1on failure.

Definition at line 2508 of file bridge.c.

References ast_bridge_lock_both, ast_bridge_unlock, and bridge_move_locked().

Referenced by agent_connect_caller(), parked_call_app_exec(), and parking_park_bridge_channel().

2509 {
2510  int res;
2511 
2512  ast_bridge_lock_both(dst_bridge, src_bridge);
2513  res = bridge_move_locked(dst_bridge, src_bridge, chan, swap, attempt_recovery);
2514  ast_bridge_unlock(src_bridge);
2515  ast_bridge_unlock(dst_bridge);
2516  return res;
2517 }
static int bridge_move_locked(struct ast_bridge *dst_bridge, struct ast_bridge *src_bridge, struct ast_channel *chan, struct ast_channel *swap, int attempt_recovery)
Definition: bridge.c:2447
#define ast_bridge_lock_both(bridge1, bridge2)
Lock two bridges.
Definition: bridge.h:500
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493

◆ ast_bridge_notify_masquerade()

void ast_bridge_notify_masquerade ( struct ast_channel chan)

Notify bridging that this channel was just masqueraded.

Since
12.0.0
Parameters
chanChannel just involved in a masquerade
Returns
Nothing

Definition at line 1482 of file bridge.c.

References ao2_ref, ast_bridge_channel_lock_bridge(), ast_bridge_unlock, ast_channel_get_bridge_channel(), ast_channel_lock, ast_channel_unlock, ast_bridge_channel::bridge, bridge_manager_request::bridge, bridge_find_channel(), bridge_reconfigured(), ast_bridge_methods::notify_masquerade, and ast_bridge::v_table.

Referenced by channel_do_masquerade().

1483 {
1484  struct ast_bridge_channel *bridge_channel;
1485  struct ast_bridge *bridge;
1486 
1487  /* Safely get the bridge_channel pointer for the chan. */
1488  ast_channel_lock(chan);
1489  bridge_channel = ast_channel_get_bridge_channel(chan);
1490  ast_channel_unlock(chan);
1491  if (!bridge_channel) {
1492  /* Not in a bridge */
1493  return;
1494  }
1495 
1496  ast_bridge_channel_lock_bridge(bridge_channel);
1497  bridge = bridge_channel->bridge;
1498  if (bridge_channel == bridge_find_channel(bridge, chan)) {
1499 /*
1500  * XXX ASTERISK-22366 this needs more work. The channels need
1501  * to be made compatible again if the formats change. The
1502  * bridge_channel thread needs to monitor for this case.
1503  */
1504  /* The channel we want to notify is still in a bridge. */
1505  bridge->v_table->notify_masquerade(bridge, bridge_channel);
1506  bridge_reconfigured(bridge, 1);
1507  }
1508  ast_bridge_unlock(bridge);
1509  ao2_ref(bridge_channel, -1);
1510 }
#define ast_channel_lock(chan)
Definition: channel.h:2890
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
struct ast_bridge * bridge
Bridge this channel is participating in.
ast_bridge_notify_masquerade_fn notify_masquerade
Definition: bridge.h:277
#define ao2_ref(o, delta)
Definition: astobj2.h:464
const struct ast_bridge_methods * v_table
Definition: bridge.h:359
Structure that contains information about a bridge.
Definition: bridge.h:357
void bridge_reconfigured(struct ast_bridge *bridge, unsigned int colp_update)
Definition: bridge.c:1443
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
struct ast_bridge_channel * ast_channel_get_bridge_channel(struct ast_channel *chan)
Get a reference to the channel&#39;s bridge pointer.
Definition: channel.c:10640
Structure that contains information regarding a channel in a bridge.
void ast_bridge_channel_lock_bridge(struct ast_bridge_channel *bridge_channel)
Lock the bridge associated with the bridge channel.

◆ ast_bridge_number_video_src()

int ast_bridge_number_video_src ( struct ast_bridge bridge)

Returns the number of video sources currently active in the bridge.

Definition at line 3931 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_NONE, AST_BRIDGE_VIDEO_MODE_SFU, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, AST_BRIDGE_VIDEO_MODE_TALKER_SRC, ast_bridge_video_talker_src_data::chan_old_vsrc, ast_bridge_video_single_src_data::chan_vsrc, ast_bridge_video_talker_src_data::chan_vsrc, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge_video_mode::single_src_data, ast_bridge::softmix, ast_bridge_video_mode::talker_src_data, and ast_bridge_softmix::video_mode.

Referenced by softmix_bridge_write_video().

3932 {
3933  int res = 0;
3934 
3935  ast_bridge_lock(bridge);
3936  switch (bridge->softmix.video_mode.mode) {
3938  break;
3941  res = 1;
3942  }
3943  break;
3946  res++;
3947  }
3949  res++;
3950  }
3952  break;
3953  }
3954  ast_bridge_unlock(bridge);
3955  return res;
3956 }
union ast_bridge_video_mode::@221 mode_data
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
struct ast_channel * chan_old_vsrc
Definition: bridge.h:127
struct ast_channel * chan_vsrc
Definition: bridge.h:116
struct ast_bridge_softmix softmix
Definition: bridge.h:375
struct ast_bridge_video_talker_src_data talker_src_data
Definition: bridge.h:164
struct ast_bridge_video_single_src_data single_src_data
Definition: bridge.h:163
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
struct ast_channel * chan_vsrc
Definition: bridge.h:123
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_peer()

struct ast_channel* ast_bridge_peer ( struct ast_bridge bridge,
struct ast_channel chan 
)

Get the channel's bridge peer only if the bridge is two-party.

Since
12.0.0
Parameters
bridgeThe bridge
chanChannel desiring the bridge peer channel.
Note
The returned peer channel is the current peer in the bridge when called.
Return values
NULLChannel not in a bridge or the bridge is not two-party.
non-NULLReffed peer channel at time of calling.

Definition at line 4142 of file bridge.c.

References ast_bridge_lock, ast_bridge_peer_nolock(), and ast_bridge_unlock.

Referenced by ast_attended_transfer_message_create(), ast_bridge_transfer_blind(), ast_channel_bridge_peer(), and get_transfer_parties_transferer_bridge().

4143 {
4144  struct ast_channel *peer;
4145 
4146  ast_bridge_lock(bridge);
4147  peer = ast_bridge_peer_nolock(bridge, chan);
4148  ast_bridge_unlock(bridge);
4149 
4150  return peer;
4151 }
Main Channel structure associated with a channel.
struct ast_channel * ast_bridge_peer_nolock(struct ast_bridge *bridge, struct ast_channel *chan)
Get the channel&#39;s bridge peer only if the bridge is two-party.
Definition: bridge.c:4114
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_peer_nolock()

struct ast_channel* ast_bridge_peer_nolock ( struct ast_bridge bridge,
struct ast_channel chan 
)

Get the channel's bridge peer only if the bridge is two-party.

Since
12.0.0
Parameters
bridgeThe bridge which is already locked.
chanChannel desiring the bridge peer channel.
Note
The returned peer channel is the current peer in the bridge when called.
Return values
NULLChannel not in a bridge or the bridge is not two-party.
non-NULLReffed peer channel at time of calling.

Definition at line 4114 of file bridge.c.

References AST_BRIDGE_CAPABILITY_1TO1MIX, AST_BRIDGE_CAPABILITY_NATIVE, ast_channel_ref, AST_LIST_TRAVERSE, ast_bridge_technology::capabilities, ast_bridge_channel::chan, ast_bridge::channels, ast_bridge_channel::in_bridge, NULL, ast_bridge::num_channels, and ast_bridge::technology.

Referenced by ast_bridge_peer(), feature_automixmonitor(), and feature_automonitor().

4115 {
4116  struct ast_channel *peer = NULL;
4117  struct ast_bridge_channel *iter;
4118 
4119  /* Asking for the peer channel only makes sense on a two-party bridge. */
4120  if (bridge->num_channels == 2
4121  && bridge->technology->capabilities
4123  int in_bridge = 0;
4124 
4125  AST_LIST_TRAVERSE(&bridge->channels, iter, entry) {
4126  if (iter->chan != chan) {
4127  peer = iter->chan;
4128  } else {
4129  in_bridge = 1;
4130  }
4131  }
4132  if (in_bridge && peer) {
4133  ast_channel_ref(peer);
4134  } else {
4135  peer = NULL;
4136  }
4137  }
4138 
4139  return peer;
4140 }
Main Channel structure associated with a channel.
#define NULL
Definition: resample.c:96
struct ast_bridge_technology * technology
Definition: bridge.h:363
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
unsigned int in_bridge
struct ast_bridge_channels_list channels
Definition: bridge.h:371
struct ast_channel * chan
Structure that contains information regarding a channel in a bridge.
#define ast_channel_ref(c)
Increase channel reference count.
Definition: channel.h:2915
Definition: search.h:40
unsigned int num_channels
Definition: bridge.h:381

◆ ast_bridge_peers()

struct ao2_container* ast_bridge_peers ( struct ast_bridge bridge)

Get a container of all channels in the bridge.

Since
12.0.0
Parameters
bridgeThe bridge
Note
The returned container is a snapshot of channels in the bridge when called.
Return values
NULLFailed to create container
non-NULLContainer of channels in the bridge

Definition at line 4103 of file bridge.c.

References ast_bridge_lock, ast_bridge_peers_nolock(), ast_bridge_unlock, and channels.

4104 {
4105  struct ao2_container *channels;
4106 
4107  ast_bridge_lock(bridge);
4108  channels = ast_bridge_peers_nolock(bridge);
4109  ast_bridge_unlock(bridge);
4110 
4111  return channels;
4112 }
static struct channel_usage channels
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
struct ao2_container * ast_bridge_peers_nolock(struct ast_bridge *bridge)
Get a container of all channels in the bridge.
Definition: bridge.c:4085
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Generic container type.

◆ ast_bridge_peers_nolock()

struct ao2_container* ast_bridge_peers_nolock ( struct ast_bridge bridge)

Get a container of all channels in the bridge.

Since
12.0.0
Parameters
bridgeThe bridge which is already locked.
Return values
NULLFailed to create container
non-NULLContainer of channels in the bridge

Definition at line 4085 of file bridge.c.

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_container_alloc_hash, ao2_link, AST_LIST_TRAVERSE, ast_bridge_channel::chan, channel_cmp(), channel_hash(), channels, ast_bridge::channels, and NULL.

Referenced by ast_bridge_peers(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), and two_bridge_attended_transfer().

4086 {
4087  struct ao2_container *channels;
4088  struct ast_bridge_channel *iter;
4089 
4091  13, channel_hash, NULL, channel_cmp);
4092  if (!channels) {
4093  return NULL;
4094  }
4095 
4096  AST_LIST_TRAVERSE(&bridge->channels, iter, entry) {
4097  ao2_link(channels, iter->chan);
4098  }
4099 
4100  return channels;
4101 }
static int channel_cmp(void *obj, void *arg, int flags)
Definition: bridge.c:4063
#define NULL
Definition: resample.c:96
static struct channel_usage channels
static int channel_hash(const void *obj, int flags)
Definition: bridge.c:4040
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Definition: astobj2.h:1310
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
struct ast_bridge_channels_list channels
Definition: bridge.h:371
struct ast_channel * chan
Structure that contains information regarding a channel in a bridge.
Definition: search.h:40
Generic container type.
#define ao2_link(container, obj)
Definition: astobj2.h:1549

◆ ast_bridge_queue_action()

int ast_bridge_queue_action ( struct ast_bridge bridge,
struct ast_frame action 
)

Put an action onto the specified bridge.

Since
12.0.0
Parameters
bridgeWhat to queue the action on.
actionWhat to do.
Return values
0on success.
-1on error.
Note
This API call is meant for internal bridging operations.

Definition at line 307 of file bridge.c.

References ast_frdup, and bridge_queue_action_nodup().

Referenced by bridge_dissolve().

308 {
309  struct ast_frame *dup;
310 
311  dup = ast_frdup(action);
312  if (!dup) {
313  return -1;
314  }
315  bridge_queue_action_nodup(bridge, dup);
316  return 0;
317 }
#define ast_frdup(fr)
Copies a frame.
static void bridge_queue_action_nodup(struct ast_bridge *bridge, struct ast_frame *action)
Definition: bridge.c:296
Data structure associated with a single frame of data.

◆ ast_bridge_queue_everyone_else()

int ast_bridge_queue_everyone_else ( struct ast_bridge bridge,
struct ast_bridge_channel bridge_channel,
struct ast_frame frame 
)

Queue the given frame to everyone else.

Since
12.0.0
Parameters
bridgeWhat bridge to distribute frame.
bridge_channelChannel to optionally not pass frame to. (NULL to pass to everyone)
frameFrame to pass.
Note
This is intended to be called by bridge hooks and bridge technologies.
Return values
0Frame written to at least one channel.
-1Frame written to no channels.

Definition at line 1118 of file bridge_channel.c.

References ast_bridge_channel_queue_frame(), AST_FRAME_NULL, AST_LIST_TRAVERSE, ast_bridge::channels, and ast_frame::frametype.

Referenced by bridge_hold(), bridge_ringing(), bridge_unhold(), holding_bridge_write(), native_bridge_write(), native_rtp_bridge_write(), simple_bridge_write(), softmix_bridge_write(), softmix_bridge_write_control(), softmix_bridge_write_text(), and softmix_bridge_write_video().

1119 {
1120  struct ast_bridge_channel *cur;
1121  int not_written = -1;
1122 
1123  if (frame->frametype == AST_FRAME_NULL) {
1124  /* "Accept" the frame and discard it. */
1125  return 0;
1126  }
1127 
1128  AST_LIST_TRAVERSE(&bridge->channels, cur, entry) {
1129  if (cur == bridge_channel) {
1130  continue;
1131  }
1132  if (!ast_bridge_channel_queue_frame(cur, frame)) {
1133  not_written = 0;
1134  }
1135  }
1136  return not_written;
1137 }
int ast_bridge_channel_queue_frame(struct ast_bridge_channel *bridge_channel, struct ast_frame *fr)
Write a frame to the specified bridge_channel.
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
struct ast_bridge_channels_list channels
Definition: bridge.h:371
Structure that contains information regarding a channel in a bridge.
Definition: search.h:40
enum ast_frame_type frametype

◆ ast_bridge_remove()

int ast_bridge_remove ( struct ast_bridge bridge,
struct ast_channel chan 
)

Remove a channel from a bridge.

Parameters
bridgeBridge that the channel is to be removed from
chanChannel to remove
Return values
0on success
-1on failure

Example usage:

This removes the channel pointed to by the chan pointer from the bridge pointed to by the bridge pointer and requests that it be hung up. Control over the channel will NOT be given to the calling thread.

Note
This API call can be used on channels that were added to the bridge using both ast_bridge_join and ast_bridge_impart.

Definition at line 1997 of file bridge.c.

References ast_bridge_channel_leave_bridge(), ast_bridge_lock, ast_bridge_unlock, AST_CAUSE_NORMAL_CLEARING, ast_channel_name(), ast_debug, BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE, bridge_find_channel(), and ast_bridge::uniqueid.

Referenced by action_kick_last(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), execute_menu_entry(), kick_conference_participant(), and leave_marked().

1998 {
1999  struct ast_bridge_channel *bridge_channel;
2000 
2001  ast_debug(1, "Removing channel %s from bridge %s\n",
2002  ast_channel_name(chan), bridge->uniqueid);
2003 
2004  ast_bridge_lock(bridge);
2005 
2006  /* Try to find the channel that we want to remove */
2007  if (!(bridge_channel = bridge_find_channel(bridge, chan))) {
2008  ast_bridge_unlock(bridge);
2009  return -1;
2010  }
2011 
2012  ast_bridge_channel_leave_bridge(bridge_channel,
2014 
2015  ast_bridge_unlock(bridge);
2016 
2017  return 0;
2018 }
const ast_string_field uniqueid
Definition: bridge.h:409
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define AST_CAUSE_NORMAL_CLEARING
Definition: causes.h:105
void ast_bridge_channel_leave_bridge(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state, int cause)
Set bridge channel state to leave bridge (if not leaving already).
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.
const char * ast_channel_name(const struct ast_channel *chan)

◆ ast_bridge_remove_video_src()

void ast_bridge_remove_video_src ( struct ast_bridge bridge,
struct ast_channel chan 
)

remove a channel as a source of video for the bridge.

Definition at line 3984 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_NONE, AST_BRIDGE_VIDEO_MODE_SFU, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, AST_BRIDGE_VIDEO_MODE_TALKER_SRC, ast_channel_unref, ast_bridge_video_talker_src_data::average_talking_energy, ast_bridge_video_talker_src_data::chan_old_vsrc, ast_bridge_video_single_src_data::chan_vsrc, ast_bridge_video_talker_src_data::chan_vsrc, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, NULL, ast_bridge_video_mode::single_src_data, ast_bridge::softmix, ast_bridge_video_mode::talker_src_data, and ast_bridge_softmix::video_mode.

Referenced by bridge_channel_internal_join(), and handle_video_on_exit().

3985 {
3986  ast_bridge_lock(bridge);
3987  switch (bridge->softmix.video_mode.mode) {
3989  break;
3991  if (bridge->softmix.video_mode.mode_data.single_src_data.chan_vsrc == chan) {
3994  }
3996  }
3997  break;
3999  if (bridge->softmix.video_mode.mode_data.talker_src_data.chan_vsrc == chan) {
4002  }
4005  }
4009  }
4011  }
4013  break;
4014  }
4015  ast_bridge_unlock(bridge);
4016 }
union ast_bridge_video_mode::@221 mode_data
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2926
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
struct ast_channel * chan_old_vsrc
Definition: bridge.h:127
struct ast_channel * chan_vsrc
Definition: bridge.h:116
#define NULL
Definition: resample.c:96
struct ast_bridge_softmix softmix
Definition: bridge.h:375
struct ast_bridge_video_talker_src_data talker_src_data
Definition: bridge.h:164
struct ast_bridge_video_single_src_data single_src_data
Definition: bridge.h:163
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
struct ast_channel * chan_vsrc
Definition: bridge.h:123
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_binaural_active()

void ast_bridge_set_binaural_active ( struct ast_bridge bridge,
unsigned int  binaural_active 
)

Activates the use of binaural signals in a conference bridge.

Parameters
bridgeChannel to activate the binaural signals.
binaural_activeIf true binaural signal processing will be active for the bridge.

Definition at line 3772 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge_softmix::binaural_active, and ast_bridge::softmix.

Referenced by join_conference_bridge().

3773 {
3774  ast_bridge_lock(bridge);
3775  bridge->softmix.binaural_active = binaural_active;
3776  ast_bridge_unlock(bridge);
3777 }
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
unsigned int binaural_active
Definition: bridge.h:303

◆ ast_bridge_set_internal_sample_rate()

void ast_bridge_set_internal_sample_rate ( struct ast_bridge bridge,
unsigned int  sample_rate 
)

Adjust the internal mixing sample rate of a bridge used during multimix mode.

Parameters
bridgeChannel to change the sample rate on.
sample_ratethe sample rate to change to. If a value of 0 is passed here, the bridge will be free to pick what ever sample rate it chooses.

Definition at line 3779 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge_softmix::internal_sample_rate, and ast_bridge::softmix.

Referenced by join_conference_bridge().

3780 {
3781  ast_bridge_lock(bridge);
3782  bridge->softmix.internal_sample_rate = sample_rate;
3783  ast_bridge_unlock(bridge);
3784 }
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
unsigned int internal_sample_rate
The internal sample rate softmix uses to mix channels.
Definition: bridge.h:293

◆ ast_bridge_set_maximum_sample_rate()

void ast_bridge_set_maximum_sample_rate ( struct ast_bridge bridge,
unsigned int  sample_rate 
)

Adjust the maximum mixing sample rate of a bridge used during multimix mode.

Since
13.31.0
16.8.0
17.2.0
Parameters
bridgeChannel to change the sample rate on.
sample_ratethe maximum sample rate to use. If a value of 0 is passed here, the bridge will be free to pick what ever sample rate it chooses.

Definition at line 3786 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge_softmix::maximum_sample_rate, and ast_bridge::softmix.

Referenced by join_conference_bridge().

3787 {
3788  ast_bridge_lock(bridge);
3789  bridge->softmix.maximum_sample_rate = sample_rate;
3790  ast_bridge_unlock(bridge);
3791 }
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
unsigned int maximum_sample_rate
The maximum sample rate softmix uses to mix channels.
Definition: bridge.h:314

◆ ast_bridge_set_mixing_interval()

void ast_bridge_set_mixing_interval ( struct ast_bridge bridge,
unsigned int  mixing_interval 
)

Adjust the internal mixing interval of a bridge used during multimix mode.

Parameters
bridgeChannel to change the sample rate on.
mixing_intervalthe sample rate to change to. If 0 is set the bridge tech is free to choose any mixing interval it uses by default.

Definition at line 3765 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge_softmix::internal_mixing_interval, and ast_bridge::softmix.

Referenced by join_conference_bridge().

3766 {
3767  ast_bridge_lock(bridge);
3768  bridge->softmix.internal_mixing_interval = mixing_interval;
3769  ast_bridge_unlock(bridge);
3770 }
unsigned int internal_mixing_interval
The mixing interval indicates how quickly softmix mixing should occur to mix audio.
Definition: bridge.h:301
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_set_remb_estimated_bitrate()

void ast_bridge_set_remb_estimated_bitrate ( struct ast_bridge bridge,
float  estimated_bitrate 
)

Force the REMB report estimated bitrate to a specific max value.

Parameters
bridgeBridge to set the REMB behavior on
estimated_bitrateThe estimated bitrate in bits per second
Note
This can only be called when the bridge has been set to the SFU video mode.

Definition at line 3874 of file bridge.c.

References ast_assert, ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_SFU, ast_bridge_video_sfu_data::estimated_bitrate, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge_video_mode::sfu_data, ast_bridge::softmix, and ast_bridge_softmix::video_mode.

Referenced by join_conference_bridge().

3875 {
3877 
3878  ast_bridge_lock(bridge);
3879  bridge->softmix.video_mode.mode_data.sfu_data.estimated_bitrate = estimated_bitrate;
3880  ast_bridge_unlock(bridge);
3881 }
union ast_bridge_video_mode::@221 mode_data
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
#define ast_assert(a)
Definition: utils.h:650
struct ast_bridge_softmix softmix
Definition: bridge.h:375
struct ast_bridge_video_sfu_data sfu_data
Definition: bridge.h:165
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_remb_send_interval()

void ast_bridge_set_remb_send_interval ( struct ast_bridge bridge,
unsigned int  remb_send_interval 
)

Set the interval at which a combined REMB frame will be sent to video sources.

Parameters
bridgeBridge to set the REMB send interval on
remb_send_intervalThe REMB send interval
Note
This can only be called when the bridge has been set to the SFU video mode.

Definition at line 3856 of file bridge.c.

References ast_assert, ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_SFU, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge_video_sfu_data::remb_send_interval, ast_bridge_video_mode::sfu_data, ast_bridge::softmix, and ast_bridge_softmix::video_mode.

Referenced by join_conference_bridge().

3857 {
3859 
3860  ast_bridge_lock(bridge);
3861  bridge->softmix.video_mode.mode_data.sfu_data.remb_send_interval = remb_send_interval;
3862  ast_bridge_unlock(bridge);
3863 }
union ast_bridge_video_mode::@221 mode_data
unsigned int remb_send_interval
Definition: bridge.h:151
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
#define ast_assert(a)
Definition: utils.h:650
struct ast_bridge_softmix softmix
Definition: bridge.h:375
struct ast_bridge_video_sfu_data sfu_data
Definition: bridge.h:165
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_send_sdp_label()

void ast_bridge_set_send_sdp_label ( struct ast_bridge bridge,
unsigned int  send_sdp_label 
)

Controls whether to send a "label" attribute in each stream in an SDP.

Since
16.1.0
Parameters
bridgeThe bridge
send_sdp_labelWhether to send the labels or not
Note
The label will contain the uniqueid of the channel related to the stream. This is used to allow the recipient to correlate the stream to the participant information events sent by app_confbridge. The bridge will be locked in this function.

Definition at line 4033 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge_softmix::send_sdp_label, and ast_bridge::softmix.

Referenced by join_conference_bridge().

4034 {
4035  ast_bridge_lock(bridge);
4036  bridge->softmix.send_sdp_label = send_sdp_label;
4037  ast_bridge_unlock(bridge);
4038 }
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
unsigned int send_sdp_label
Definition: bridge.h:308
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_set_sfu_video_mode()

void ast_bridge_set_sfu_video_mode ( struct ast_bridge bridge)

Set the bridge to be a selective forwarding unit.

Definition at line 3841 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_SFU, cleanup_video_mode(), ast_bridge_video_mode::mode, ast_bridge::softmix, and ast_bridge_softmix::video_mode.

Referenced by bridge_stasis_new(), and join_conference_bridge().

3842 {
3843  ast_bridge_lock(bridge);
3844  cleanup_video_mode(bridge);
3846  ast_bridge_unlock(bridge);
3847 }
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
static void cleanup_video_mode(struct ast_bridge *bridge)
Definition: bridge.c:3793
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_single_src_video_mode()

void ast_bridge_set_single_src_video_mode ( struct ast_bridge bridge,
struct ast_channel video_src_chan 
)

Set a bridge to feed a single video source to all participants.

Definition at line 3816 of file bridge.c.

References ast_bridge_lock, ast_bridge_publish_state(), ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, ast_channel_name(), ast_channel_ref, ast_channel_uniqueid(), AST_CONTROL_VIDUPDATE, ast_indicate(), ast_verb, ast_bridge_video_single_src_data::chan_vsrc, cleanup_video_mode(), ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge::name, ast_bridge_video_mode::single_src_data, ast_bridge::softmix, ast_bridge::uniqueid, and ast_bridge_softmix::video_mode.

Referenced by action_confbridgesetsinglevideosrc(), bridge_set_video_source_cb(), bridge_stasis_new(), execute_menu_entry(), handle_video_on_exit(), and handle_video_on_join().

3817 {
3818  ast_bridge_lock(bridge);
3819  cleanup_video_mode(bridge);
3821  if (video_src_chan) {
3823  ast_verb(5, "Video source in bridge '%s' (%s) is now '%s' (%s)\n",
3824  bridge->name, bridge->uniqueid,
3825  ast_channel_name(video_src_chan),
3826  ast_channel_uniqueid(video_src_chan));
3827  ast_indicate(video_src_chan, AST_CONTROL_VIDUPDATE);
3828  }
3829  ast_bridge_publish_state(bridge);
3830  ast_bridge_unlock(bridge);
3831 }
const ast_string_field uniqueid
Definition: bridge.h:409
union ast_bridge_video_mode::@221 mode_data
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition: channel.c:4291
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
const ast_string_field name
Definition: bridge.h:409
struct ast_channel * chan_vsrc
Definition: bridge.h:116
static void cleanup_video_mode(struct ast_bridge *bridge)
Definition: bridge.c:3793
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_verb(level,...)
Definition: logger.h:455
void ast_bridge_publish_state(struct ast_bridge *bridge)
Publish the state of a bridge.
struct ast_bridge_video_single_src_data single_src_data
Definition: bridge.h:163
const char * ast_channel_uniqueid(const struct ast_channel *chan)
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
#define ast_channel_ref(c)
Increase channel reference count.
Definition: channel.h:2915
const char * ast_channel_name(const struct ast_channel *chan)
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_talker_src_video_mode()

void ast_bridge_set_talker_src_video_mode ( struct ast_bridge bridge)

Set the bridge to pick the strongest talker supporting video as the single source video feed.

Definition at line 3833 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_TALKER_SRC, cleanup_video_mode(), ast_bridge_video_mode::mode, ast_bridge::softmix, and ast_bridge_softmix::video_mode.

Referenced by ast_ari_bridges_clear_video_source(), bridge_stasis_new(), handle_video_on_exit(), and join_conference_bridge().

3834 {
3835  ast_bridge_lock(bridge);
3836  cleanup_video_mode(bridge);
3838  ast_bridge_unlock(bridge);
3839 }
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
static void cleanup_video_mode(struct ast_bridge *bridge)
Definition: bridge.c:3793
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

◆ ast_bridge_set_transfer_variables()

void ast_bridge_set_transfer_variables ( struct ast_channel chan,
const char *  value,
int  is_attended 
)

Set the relevant transfer variables for a single channel.

Sets either the ATTENDEDTRANSFER or BLINDTRANSFER variable for a channel while clearing the opposite.

Parameters
chanChannel the variable is being set for
valueValue the variable is being set to
is_attendedfalse set BLINDTRANSFER and unset ATTENDEDTRANSFER true set ATTENDEDTRANSFER and unset BLINDTRANSFER

Definition at line 4404 of file bridge.c.

References ATTENDEDTRANSFER, BLINDTRANSFER, NULL, and pbx_builtin_setvar_helper().

Referenced by dial_transfer(), manager_park(), park_local_transfer(), parking_park_bridge_channel(), and set_transfer_variables_all().

4405 {
4406  char *writevar;
4407  char *erasevar;
4408 
4409  if (attended) {
4410  writevar = ATTENDEDTRANSFER;
4411  erasevar = BLINDTRANSFER;
4412  } else {
4413  writevar = BLINDTRANSFER;
4414  erasevar = ATTENDEDTRANSFER;
4415  }
4416 
4417  pbx_builtin_setvar_helper(chan, writevar, value);
4418  pbx_builtin_setvar_helper(chan, erasevar, NULL);
4419 }
#define ATTENDEDTRANSFER
Definition: bridge.c:139
#define NULL
Definition: resample.c:96
int value
Definition: syslog.c:37
#define BLINDTRANSFER
Definition: bridge.c:136
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...

◆ ast_bridge_set_video_update_discard()

void ast_bridge_set_video_update_discard ( struct ast_bridge bridge,
unsigned int  video_update_discard 
)

Set the amount of time to discard subsequent video updates after a video update has been sent.

Parameters
bridgeBridge to set the minimum video update wait time on
video_update_discardAmount of time after sending a video update that others should be discarded

Definition at line 3849 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, ast_bridge::softmix, ast_bridge_softmix::video_mode, and ast_bridge_video_mode::video_update_discard.

Referenced by bridge_stasis_new(), and join_conference_bridge().

3850 {
3851  ast_bridge_lock(bridge);
3852  bridge->softmix.video_mode.video_update_discard = video_update_discard;
3853  ast_bridge_unlock(bridge);
3854 }
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
unsigned int video_update_discard
Definition: bridge.h:168
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480

◆ ast_bridge_suspend()

int ast_bridge_suspend ( struct ast_bridge bridge,
struct ast_channel chan 
)

Suspend a channel temporarily from a bridge.

Parameters
bridgeBridge to suspend the channel from
chanChannel to suspend
Return values
0on success
-1on failure

Example usage:

This suspends the channel pointed to by chan from the bridge pointed to by bridge temporarily. Control of the channel is given to the calling thread. This differs from ast_bridge_depart as the channel will not be removed from the bridge.

Note
This API call can be used on channels that were added to the bridge using both ast_bridge_join and ast_bridge_impart.

Definition at line 3068 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, bridge_channel_internal_suspend_nolock(), and bridge_find_channel().

Referenced by conf_moh_start(), and conf_moh_stop().

3069 {
3070  struct ast_bridge_channel *bridge_channel;
3071 /* XXX ASTERISK-21271 the case of a disolved bridge while channel is suspended is not handled. */
3072 /* XXX ASTERISK-21271 suspend/unsuspend needs to be rethought. The caller must block until it has successfully suspended the channel for temporary control. */
3073 /* XXX ASTERISK-21271 external suspend/unsuspend needs to be eliminated. The channel may be playing a file at the time and stealing it then is not good. */
3074 
3075  ast_bridge_lock(bridge);
3076 
3077  if (!(bridge_channel = bridge_find_channel(bridge, chan))) {
3078  ast_bridge_unlock(bridge);
3079  return -1;
3080  }
3081 
3083 
3084  ast_bridge_unlock(bridge);
3085 
3086  return 0;
3087 }
void bridge_channel_internal_suspend_nolock(struct ast_bridge_channel *bridge_channel)
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.

◆ ast_bridge_transfer_acquire_bridge()

struct ast_bridge* ast_bridge_transfer_acquire_bridge ( struct ast_channel chan)

Acquire the channel's bridge for transfer purposes.

Since
13.21.0
Parameters
chanChannel involved in a transfer.
Returns
The bridge the channel is in or NULL if it either isn't in a bridge or should not be considered to be in a bridge.

Definition at line 4460 of file bridge.c.

References ao2_ref, AST_BRIDGE_FLAG_INVISIBLE, AST_BRIDGE_FLAG_MASQUERADE_ONLY, ast_channel_get_bridge(), ast_channel_lock, ast_channel_unlock, ast_test_flag, bridge_manager_request::bridge, ast_bridge::feature_flags, and NULL.

Referenced by ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), handle_invite_replaces(), and invite_replaces().

4461 {
4462  struct ast_bridge *bridge;
4463 
4464  ast_channel_lock(chan);
4465  bridge = ast_channel_get_bridge(chan);
4466  ast_channel_unlock(chan);
4467 
4468  if (bridge && ast_test_flag(&bridge->feature_flags,
4470  ao2_ref(bridge, -1);
4471  bridge = NULL;
4472  }
4473 
4474  return bridge;
4475 }
#define ast_channel_lock(chan)
Definition: channel.h:2890
struct ast_flags feature_flags
Definition: bridge.h:377
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define NULL
Definition: resample.c:96
struct ast_bridge * ast_channel_get_bridge(const struct ast_channel *chan)
Get the bridge associated with a channel.
Definition: channel.c:10592
#define ao2_ref(o, delta)
Definition: astobj2.h:464
Structure that contains information about a bridge.
Definition: bridge.h:357
#define ast_channel_unlock(chan)
Definition: channel.h:2891

◆ ast_bridge_transfer_attended()

enum ast_transfer_result ast_bridge_transfer_attended ( struct ast_channel to_transferee,
struct ast_channel to_transfer_target 
)

Attended transfer.

The two channels are both transferer channels. The first is the channel that is bridged to the transferee (or if unbridged, the 'first' call of the transfer). The second is the channel that is bridged to the transfer target (or if unbridged, the 'second' call of the transfer).

Note
Absolutely NO channel locks should be held before calling this function.
Parameters
to_transfereeTransferer channel on initial call (presumably bridged to transferee)
to_transfer_targetTransferer channel on consultation call (presumably bridged to transfer target)
Returns
The success or failure of the attended transfer

Definition at line 4729 of file bridge.c.

References ao2_cleanup, ao2_container_count(), app, ast_attended_transfer_message_add_app(), ast_attended_transfer_message_create(), ast_bridge_channel_write_playfile(), ast_bridge_channel_write_unhold(), AST_BRIDGE_FLAG_TRANSFER_BRIDGE_ONLY, AST_BRIDGE_FLAG_TRANSFER_PROHIBITED, ast_bridge_lock, ast_bridge_lock_both, ast_bridge_peers_nolock(), ast_bridge_publish_attended_transfer(), ast_bridge_remove(), ast_bridge_transfer_acquire_bridge(), AST_BRIDGE_TRANSFER_FAIL, AST_BRIDGE_TRANSFER_INVALID, AST_BRIDGE_TRANSFER_NOT_PERMITTED, AST_BRIDGE_TRANSFER_SUCCESS, ast_bridge_unlock, ast_channel_appl(), ast_channel_get_bridge_channel(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_log, ast_softhangup(), AST_SOFTHANGUP_DEV, ast_strdupa, ast_strlen_zero, ast_test_flag, attended_transfer_bridge(), bridge_channel_internal_queue_attended_transfer(), channels, end, ast_bridge::feature_flags, get_transferee(), lock, LOG_ERROR, NULL, pbx_builtin_getvar_helper(), RAII_VAR, SCOPED_LOCK, set_transfer_variables_all(), and two_bridge_attended_transfer().

Referenced by analog_attempt_transfer(), AST_TEST_DEFINE(), attempt_transfer(), local_attended_transfer(), misdn_attempt_transfer(), refer_attended_task(), and skinny_transfer_attended().

4731 {
4732  RAII_VAR(struct ast_bridge *, to_transferee_bridge, NULL, ao2_cleanup);
4733  RAII_VAR(struct ast_bridge *, to_target_bridge, NULL, ao2_cleanup);
4734  RAII_VAR(struct ast_bridge_channel *, to_transferee_bridge_channel, NULL, ao2_cleanup);
4735  RAII_VAR(struct ast_bridge_channel *, to_target_bridge_channel, NULL, ao2_cleanup);
4737  RAII_VAR(struct ast_channel *, transferee, NULL, ao2_cleanup);
4738  RAII_VAR(struct ast_attended_transfer_message *, transfer_msg, NULL, ao2_cleanup);
4739  struct ast_bridge *the_bridge = NULL;
4740  struct ast_channel *chan_bridged;
4741  struct ast_channel *chan_unbridged;
4742  int transfer_prohibited;
4743  int do_bridge_transfer;
4744  enum ast_transfer_result res;
4745  const char *app = NULL;
4746  int hangup_target = 0;
4747 
4748  to_transferee_bridge = ast_bridge_transfer_acquire_bridge(to_transferee);
4749  to_target_bridge = ast_bridge_transfer_acquire_bridge(to_transfer_target);
4750 
4751  transfer_msg = ast_attended_transfer_message_create(1, to_transferee, to_transferee_bridge,
4752  to_transfer_target, to_target_bridge, NULL, NULL);
4753  if (!transfer_msg) {
4754  ast_log(LOG_ERROR, "Unable to create Stasis publication for attended transfer from %s\n",
4755  ast_channel_name(to_transferee));
4756  return AST_BRIDGE_TRANSFER_FAIL;
4757  }
4758 
4759  /* They can't both be unbridged, you silly goose! */
4760  if (!to_transferee_bridge && !to_target_bridge) {
4762  goto end;
4763  }
4764 
4765  ast_channel_lock(to_transferee);
4766  to_transferee_bridge_channel = ast_channel_get_bridge_channel(to_transferee);
4767  ast_channel_unlock(to_transferee);
4768 
4769  ast_channel_lock(to_transfer_target);
4770  to_target_bridge_channel = ast_channel_get_bridge_channel(to_transfer_target);
4771  ast_channel_unlock(to_transfer_target);
4772 
4773  if (to_transferee_bridge_channel) {
4774  /* Take off hold if they are on hold. */
4775  if (ast_bridge_channel_write_unhold(to_transferee_bridge_channel)) {
4776  ast_log(LOG_ERROR, "Transferee channel disappeared during transfer!\n");
4778  goto end;
4779  }
4780  }
4781 
4782  if (to_target_bridge_channel) {
4783  const char *target_complete_sound;
4784 
4785  /* Take off hold if they are on hold. */
4786  if (ast_bridge_channel_write_unhold(to_target_bridge_channel)) {
4787  ast_log(LOG_ERROR, "Target channel disappeared during transfer!\n");
4789  goto end;
4790  }
4791 
4792  /* Is there a courtesy sound to play to the target? */
4793  ast_channel_lock(to_transfer_target);
4794  target_complete_sound = pbx_builtin_getvar_helper(to_transfer_target,
4795  "ATTENDED_TRANSFER_COMPLETE_SOUND");
4796  if (!ast_strlen_zero(target_complete_sound)) {
4797  target_complete_sound = ast_strdupa(target_complete_sound);
4798  } else {
4799  target_complete_sound = NULL;
4800  }
4801  ast_channel_unlock(to_transfer_target);
4802  if (!target_complete_sound) {
4803  ast_channel_lock(to_transferee);
4804  target_complete_sound = pbx_builtin_getvar_helper(to_transferee,
4805  "ATTENDED_TRANSFER_COMPLETE_SOUND");
4806  if (!ast_strlen_zero(target_complete_sound)) {
4807  target_complete_sound = ast_strdupa(target_complete_sound);
4808  } else {
4809  target_complete_sound = NULL;
4810  }
4811  ast_channel_unlock(to_transferee);
4812  }
4813  if (target_complete_sound) {
4814  ast_bridge_channel_write_playfile(to_target_bridge_channel, NULL,
4815  target_complete_sound, NULL);
4816  }
4817  }
4818 
4819  /* Let's get the easy one out of the way first */
4820  if (to_transferee_bridge && to_target_bridge) {
4821 
4822  if (!to_transferee_bridge_channel || !to_target_bridge_channel) {
4824  goto end;
4825  }
4826 
4827  ast_bridge_lock_both(to_transferee_bridge, to_target_bridge);
4828  res = two_bridge_attended_transfer(to_transferee, to_transferee_bridge_channel,
4829  to_transfer_target, to_target_bridge_channel,
4830  to_transferee_bridge, to_target_bridge, transfer_msg);
4831  ast_bridge_unlock(to_transferee_bridge);
4832  ast_bridge_unlock(to_target_bridge);
4833 
4834  hangup_target = 1;
4835  goto end;
4836  }
4837 
4838  the_bridge = to_transferee_bridge ?: to_target_bridge;
4839  chan_bridged = to_transferee_bridge ? to_transferee : to_transfer_target;
4840  chan_unbridged = to_transferee_bridge ? to_transfer_target : to_transferee;
4841 
4842  /*
4843  * Race condition makes it possible for app to be NULL, so get the app prior to
4844  * transferring with a fallback of "unknown".
4845  */
4846  app = ast_strdupa(ast_channel_appl(chan_unbridged) ?: "unknown");
4847 
4848  {
4849  int chan_count;
4851 
4852  channels = ast_bridge_peers_nolock(the_bridge);
4853  if (!channels) {
4855  goto end;
4856  }
4857  chan_count = ao2_container_count(channels);
4858  if (chan_count <= 1) {
4860  goto end;
4861  }
4862  transfer_prohibited = ast_test_flag(&the_bridge->feature_flags,
4864  do_bridge_transfer = ast_test_flag(&the_bridge->feature_flags,
4866  chan_count > 2;
4867  }
4868 
4869  if (transfer_prohibited) {
4871  goto end;
4872  }
4873 
4874  set_transfer_variables_all(to_transferee, channels, 1);
4875 
4876  if (do_bridge_transfer) {
4877  /*
4878  * Hang up the target if it was bridged. Note, if it is not bridged
4879  * it is hung up during the masquerade.
4880  */
4881  hangup_target = chan_bridged == to_transfer_target;
4882  ast_bridge_lock(the_bridge);
4883  res = attended_transfer_bridge(chan_bridged, chan_unbridged, the_bridge, NULL, transfer_msg);
4884  ast_bridge_unlock(the_bridge);
4885  goto end;
4886  }
4887 
4888  transferee = get_transferee(channels, chan_bridged);
4889  if (!transferee) {
4891  goto end;
4892  }
4893 
4894  if (bridge_channel_internal_queue_attended_transfer(transferee, chan_unbridged)) {
4896  goto end;
4897  }
4898 
4899  ast_bridge_remove(the_bridge, chan_bridged);
4900 
4901  ast_attended_transfer_message_add_app(transfer_msg, app, NULL);
4903 
4904 end:
4905  if ((res == AST_BRIDGE_TRANSFER_SUCCESS && hangup_target) || res == AST_BRIDGE_TRANSFER_FAIL) {
4906  ast_softhangup(to_transfer_target, AST_SOFTHANGUP_DEV);
4907  }
4908 
4909  transfer_msg->result = res;
4911  return res;
4912 }
#define ast_channel_lock(chan)
Definition: channel.h:2890
Main Channel structure associated with a channel.
#define ast_bridge_lock_both(bridge1, bridge2)
Lock two bridges.
Definition: bridge.h:500
struct ast_flags feature_flags
Definition: bridge.h:377
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
struct ast_bridge * ast_bridge_transfer_acquire_bridge(struct ast_channel *chan)
Acquire the channel&#39;s bridge for transfer purposes.
Definition: bridge.c:4460
Message representing attended transfer.
#define ast_test_flag(p, flag)
Definition: utils.h:63
void ast_bridge_publish_attended_transfer(struct ast_attended_transfer_message *transfer_msg)
Publish an attended transfer.
int ast_attended_transfer_message_add_app(struct ast_attended_transfer_message *transfer_msg, const char *app, struct ast_channel *replace_channel)
Add details for an attended transfer to an application.
static enum ast_transfer_result two_bridge_attended_transfer(struct ast_channel *to_transferee, struct ast_bridge_channel *to_transferee_bridge_channel, struct ast_channel *to_transfer_target, struct ast_bridge_channel *to_target_bridge_channel, struct ast_bridge *to_transferee_bridge, struct ast_bridge *to_target_bridge, struct ast_attended_transfer_message *transfer_msg)
Definition: bridge.c:4663
#define NULL
Definition: resample.c:96
char * end
Definition: eagi_proxy.c:73
ast_transfer_result
Definition: bridge.h:1115
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
#define ast_log
Definition: astobj2.c:42
static void set_transfer_variables_all(struct ast_channel *transferer, struct ao2_container *channels, int is_attended)
Definition: bridge.c:4435
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:851
ast_mutex_t lock
Definition: app_meetme.c:1091
int ast_softhangup(struct ast_channel *chan, int reason)
Softly hangup up a channel.
Definition: channel.c:2462
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
#define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc)
Scoped Locks.
Definition: lock.h:581
static struct channel_usage channels
static enum ast_transfer_result attended_transfer_bridge(struct ast_channel *chan1, struct ast_channel *chan2, struct ast_bridge *bridge1, struct ast_bridge *bridge2, struct ast_attended_transfer_message *transfer_msg)
Perform an attended transfer of a bridge.
Definition: bridge.c:4280
Structure that contains information about a bridge.
Definition: bridge.h:357
#define LOG_ERROR
Definition: logger.h:285
int ast_bridge_channel_write_playfile(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class)
Write a bridge action play file frame into the bridge.
const char * ast_channel_appl(const struct ast_channel *chan)
#define ast_strlen_zero(a)
Definition: muted.c:73
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
struct ao2_container * ast_bridge_peers_nolock(struct ast_bridge *bridge)
Get a container of all channels in the bridge.
Definition: bridge.c:4085
struct ast_bridge_channel * ast_channel_get_bridge_channel(struct ast_channel *chan)
Get a reference to the channel&#39;s bridge pointer.
Definition: channel.c:10640
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
const char * ast_channel_name(const struct ast_channel *chan)
static struct ast_channel * get_transferee(struct ao2_container *channels, struct ast_channel *transferer)
Definition: bridge.c:4241
int bridge_channel_internal_queue_attended_transfer(struct ast_channel *transferee, struct ast_channel *unbridged_chan)
Generic container type.
int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan)
Remove a channel from a bridge.
Definition: bridge.c:1997
int ast_bridge_channel_write_unhold(struct ast_bridge_channel *bridge_channel)
Write an unhold frame into the bridge.
struct ast_attended_transfer_message * ast_attended_transfer_message_create(int is_external, struct ast_channel *to_transferee, struct ast_bridge *transferee_bridge, struct ast_channel *to_transfer_target, struct ast_bridge *target_bridge, struct ast_channel *transferee, struct ast_channel *transfer_target)
Create an Attended transfer message to be published.
static const char app[]
Definition: app_mysql.c:62

◆ ast_bridge_transfer_blind()

enum ast_transfer_result ast_bridge_transfer_blind ( int  is_external,
struct ast_channel transferer,
const char *  exten,
const char *  context,
transfer_channel_cb  new_channel_cb,
void *  user_data 
)

Blind transfer target to the extension and context provided.

The channel given is bridged to one or multiple channels. Depending on the bridge and the number of participants, the entire bridge could be transferred to the given destination, or a single channel may be redirected.

Callers may also provide a callback to be called on the channel that will be running dialplan. The user data passed into ast_bridge_transfer_blind will be given as the argument to the callback to be interpreted as desired. This callback is guaranteed to be called in the same thread as ast_bridge_transfer_blind() and before ast_bridge_transfer_blind() returns.

Note
Absolutely NO channel locks should be held before calling this function.
Parameters
is_externalIndicates that transfer was initiated externally
transfererThe channel performing the blind transfer
extenThe dialplan extension to send the call to
contextThe dialplan context to send the call to
new_channel_cbA callback to be called on the channel that will be executing dialplan
user_dataArgument for new_channel_cb
Returns
The success or failure result of the blind transfer

Definition at line 4477 of file bridge.c.

References ao2_alloc, ao2_cleanup, ao2_container_count(), ast_blind_transfer_message_create(), ast_bridge_channel_write_unhold(), AST_BRIDGE_FLAG_TRANSFER_BRIDGE_ONLY, AST_BRIDGE_FLAG_TRANSFER_PROHIBITED, ast_bridge_lock, ast_bridge_peer(), ast_bridge_peers_nolock(), ast_bridge_publish_blind_transfer(), ast_bridge_remove(), ast_bridge_snapshot_create(), ast_bridge_transfer_acquire_bridge(), AST_BRIDGE_TRANSFER_FAIL, AST_BRIDGE_TRANSFER_INVALID, AST_BRIDGE_TRANSFER_NOT_PERMITTED, AST_BRIDGE_TRANSFER_SUCCESS, ast_bridge_unlock, ast_channel_cleanup, ast_channel_get_bridge_channel(), ast_channel_lock, ast_channel_name(), ast_channel_snapshot_get_latest(), ast_channel_uniqueid(), ast_channel_unlock, ast_log, ast_test_flag, blind_transfer_bridge(), bridge_manager_request::bridge, bridge_channel_internal_queue_blind_transfer(), channels, ast_bridge::feature_flags, lock, LOG_ERROR, NULL, publish, RAII_VAR, SCOPED_LOCK, set_transfer_variables_all(), and try_parking().

Referenced by action_blind_transfer(), blind_transfer_exec(), console_transfer(), feature_blind_transfer(), handle_request_refer(), refer_incoming_attended_request(), refer_incoming_blind_request(), skinny_transfer_blind(), and socket_process_helper().

4480 {
4481  RAII_VAR(struct ast_bridge *, bridge, NULL, ao2_cleanup);
4482  RAII_VAR(struct ast_bridge_channel *, bridge_channel, NULL, ao2_cleanup);
4484  RAII_VAR(struct ast_channel *, transferee, NULL, ast_channel_cleanup);
4485  RAII_VAR(struct transfer_channel_data *, user_data_wrapper, NULL, ao2_cleanup);
4486  RAII_VAR(struct ast_blind_transfer_message *, transfer_message, NULL, ao2_cleanup);
4487  int do_bridge_transfer;
4488  int transfer_prohibited;
4489  enum ast_transfer_result transfer_result;
4490 
4491  transfer_message = ast_blind_transfer_message_create(is_external, transferer, exten, context);
4492  if (!transfer_message) {
4493  /* Out of memory. Not even possible to publish a Stasis message about the
4494  * failure
4495  */
4496  ast_log(LOG_ERROR, "Unable to allocate memory for blind transfer publication from %s\n",
4497  ast_channel_name(transferer));
4498  return AST_BRIDGE_TRANSFER_FAIL;
4499  }
4500 
4501  bridge = ast_bridge_transfer_acquire_bridge(transferer);
4502  if (!bridge) {
4503  transfer_result = AST_BRIDGE_TRANSFER_INVALID;
4504  goto publish;
4505  }
4506 
4507  ast_bridge_lock(bridge);
4508  transfer_message->bridge = ast_bridge_snapshot_create(bridge);
4509  ast_bridge_unlock(bridge);
4510  if (!transfer_message->bridge) {
4511  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4512  goto publish;
4513  }
4514 
4515  transferee = ast_bridge_peer(bridge, transferer);
4516  if (transferee) {
4517  transfer_message->transferee = ast_channel_snapshot_get_latest(ast_channel_uniqueid(transferee));
4518  if (!transfer_message->transferee) {
4519  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4520  goto publish;
4521  }
4522  }
4523 
4524  ast_channel_lock(transferer);
4525  bridge_channel = ast_channel_get_bridge_channel(transferer);
4526  ast_channel_unlock(transferer);
4527  if (!bridge_channel) {
4528  transfer_result = AST_BRIDGE_TRANSFER_INVALID;
4529  goto publish;
4530  }
4531 
4532  user_data_wrapper = ao2_alloc(sizeof(*user_data_wrapper), NULL);
4533  if (!user_data_wrapper) {
4534  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4535  goto publish;
4536  }
4537 
4538  user_data_wrapper->data = user_data;
4539 
4540  /* Take off hold if they are on hold. */
4541  ast_bridge_channel_write_unhold(bridge_channel);
4542 
4543  transfer_result = try_parking(transferer, context, exten, new_channel_cb, user_data_wrapper);
4544  if (transfer_result == AST_BRIDGE_TRANSFER_SUCCESS) {
4545  goto publish;
4546  }
4547 
4548  /* Since parking didn't take control of the user_data_wrapper, we are just going to raise the completed flag now. */
4549  user_data_wrapper->completed = 1;
4550 
4551  {
4553 
4555  if (!channels) {
4556  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4557  goto publish;
4558  }
4559  if (ao2_container_count(channels) <= 1) {
4560  transfer_result = AST_BRIDGE_TRANSFER_INVALID;
4561  goto publish;
4562  }
4563  transfer_prohibited = ast_test_flag(&bridge->feature_flags,
4565  do_bridge_transfer = ast_test_flag(&bridge->feature_flags,
4568  }
4569 
4570  if (transfer_prohibited) {
4571  transfer_result = AST_BRIDGE_TRANSFER_NOT_PERMITTED;
4572  goto publish;
4573  }
4574 
4575  set_transfer_variables_all(transferer, channels, 0);
4576 
4577  if (do_bridge_transfer) {
4578  transfer_result = blind_transfer_bridge(is_external, transferer, bridge,
4579  exten, context, transferee, new_channel_cb, user_data_wrapper, transfer_message);
4580  goto publish;
4581  }
4582 
4583  /* Reaching this portion means that we're dealing with a two-party bridge */
4584 
4585  if (!transferee) {
4586  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4587  goto publish;
4588  }
4589 
4591  new_channel_cb, user_data_wrapper)) {
4592  transfer_result = AST_BRIDGE_TRANSFER_FAIL;
4593  goto publish;
4594  }
4595 
4596  ast_bridge_remove(bridge, transferer);
4597  transfer_result = AST_BRIDGE_TRANSFER_SUCCESS;
4598 
4599 publish:
4600  transfer_message->result = transfer_result;
4601  ast_bridge_publish_blind_transfer(transfer_message);
4602  return transfer_result;
4603 }
#define ast_channel_lock(chan)
Definition: channel.h:2890
static char exten[AST_MAX_EXTENSION]
Definition: chan_alsa.c:118
Main Channel structure associated with a channel.
struct ast_blind_transfer_message * ast_blind_transfer_message_create(int is_external, struct ast_channel *transferer, const char *exten, const char *context)
Create a blind transfer message to be published.
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
struct ast_bridge * ast_bridge_transfer_acquire_bridge(struct ast_channel *chan)
Acquire the channel&#39;s bridge for transfer purposes.
Definition: bridge.c:4460
#define ast_test_flag(p, flag)
Definition: utils.h:63
Message published during a blind transfer.
#define NULL
Definition: resample.c:96
ast_transfer_result
Definition: bridge.h:1115
unsigned char publish
Definition: res_corosync.c:241
#define ast_log
Definition: astobj2.c:42
static void set_transfer_variables_all(struct ast_channel *transferer, struct ao2_container *channels, int is_attended)
Definition: bridge.c:4435
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:851
ast_mutex_t lock
Definition: app_meetme.c:1091
#define ast_channel_cleanup(c)
Cleanup a channel reference.
Definition: channel.h:2937
#define SCOPED_LOCK(varname, lock, lockfunc, unlockfunc)
Scoped Locks.
Definition: lock.h:581
static struct channel_usage channels
const char * ast_channel_uniqueid(const struct ast_channel *chan)
Structure that contains information about a bridge.
Definition: bridge.h:357
#define LOG_ERROR
Definition: logger.h:285
int bridge_channel_internal_queue_blind_transfer(struct ast_channel *transferee, const char *exten, const char *context, transfer_channel_cb new_channel_cb, void *user_data)
static enum ast_transfer_result try_parking(struct ast_channel *transferer, const char *context, const char *exten, transfer_channel_cb new_channel_cb, struct transfer_channel_data *user_data_wrapper)
Definition: bridge.c:4378
static enum ast_transfer_result blind_transfer_bridge(int is_external, struct ast_channel *transferer, struct ast_bridge *bridge, const char *exten, const char *context, struct ast_channel *transferee, transfer_channel_cb new_channel_cb, struct transfer_channel_data *user_data_wrapper, struct ast_blind_transfer_message *transfer_message)
Definition: bridge.c:4178
struct ast_bridge_snapshot * ast_bridge_snapshot_create(struct ast_bridge *bridge)
Generate a snapshot of the bridge state. This is an ao2 object, so ao2_cleanup() to deallocate...
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:411
struct ast_channel * ast_bridge_peer(struct ast_bridge *bridge, struct ast_channel *chan)
Get the channel&#39;s bridge peer only if the bridge is two-party.
Definition: bridge.c:4142
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
void ast_bridge_publish_blind_transfer(struct ast_blind_transfer_message *transfer_message)
Publish a blind transfer event.
struct ao2_container * ast_bridge_peers_nolock(struct ast_bridge *bridge)
Get a container of all channels in the bridge.
Definition: bridge.c:4085
struct ast_bridge_channel * ast_channel_get_bridge_channel(struct ast_channel *chan)
Get a reference to the channel&#39;s bridge pointer.
Definition: channel.c:10640
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.
struct ast_channel_snapshot * ast_channel_snapshot_get_latest(const char *uniqueid)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object...
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
const char * ast_channel_name(const struct ast_channel *chan)
AO2 object that wraps data for transfer_channel_cb.
Definition: bridge.h:1136
Generic container type.
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:116
int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan)
Remove a channel from a bridge.
Definition: bridge.c:1997
int ast_bridge_channel_write_unhold(struct ast_bridge_channel *bridge_channel)
Write an unhold frame into the bridge.

◆ ast_bridge_unreal_optimize_out()

int ast_bridge_unreal_optimize_out ( struct ast_channel chan,
struct ast_channel peer,
struct ast_unreal_pvt pvt 
)

Check and optimize out the unreal channels between bridges.

Since
12.0.0
Parameters
chanUnreal channel writing a frame into the channel driver.
peerOther unreal channel in the pair.
pvtPrivate data provided by an implementation of the unreal driver that contains the callbacks that should be called when optimization begins/ends
Note
It is assumed that chan is already locked.
Return values
0if unreal channels were not optimized out.
non-zeroif unreal channels were optimized out.

Definition at line 2968 of file bridge.c.

References ast_bridge_channel_unlock, ast_bridge_unlock, ast_channel_internal_bridge_channel(), ast_channel_unlock, optimize_lock_chan_stack(), optimize_lock_peer_stack(), try_merge_optimize_out(), and try_swap_optimize_out().

Referenced by got_optimized_out().

2969 {
2970  struct ast_bridge *chan_bridge;
2971  struct ast_bridge *peer_bridge;
2972  struct ast_bridge_channel *chan_bridge_channel;
2973  struct ast_bridge_channel *peer_bridge_channel;
2974  int res = 0;
2975 
2976  chan_bridge = optimize_lock_chan_stack(chan);
2977  if (!chan_bridge) {
2978  return res;
2979  }
2980  chan_bridge_channel = ast_channel_internal_bridge_channel(chan);
2981 
2982  peer_bridge = optimize_lock_peer_stack(peer);
2983  if (peer_bridge) {
2984  peer_bridge_channel = ast_channel_internal_bridge_channel(peer);
2985 
2986  res = try_swap_optimize_out(chan_bridge, chan_bridge_channel,
2987  peer_bridge, peer_bridge_channel, pvt);
2988  if (!res) {
2989  res = try_merge_optimize_out(chan_bridge, chan_bridge_channel,
2990  peer_bridge, peer_bridge_channel, pvt);
2991  } else if (0 < res) {
2992  res = 0;
2993  }
2994 
2995  /* Release peer locks. */
2996  ast_bridge_unlock(peer_bridge);
2997  ast_bridge_channel_unlock(peer_bridge_channel);
2998  ast_channel_unlock(peer);
2999  }
3000 
3001  /* Release chan locks. */
3002  ast_bridge_unlock(chan_bridge);
3003  ast_bridge_channel_unlock(chan_bridge_channel);
3004 
3005  return res;
3006 }
static int try_swap_optimize_out(struct ast_bridge *chan_bridge, struct ast_bridge_channel *chan_bridge_channel, struct ast_bridge *peer_bridge, struct ast_bridge_channel *peer_bridge_channel, struct ast_unreal_pvt *pvt)
Definition: bridge.c:2793
static int try_merge_optimize_out(struct ast_bridge *chan_bridge, struct ast_bridge_channel *chan_bridge_channel, struct ast_bridge *peer_bridge, struct ast_bridge_channel *peer_bridge_channel, struct ast_unreal_pvt *pvt)
Definition: bridge.c:2917
static struct ast_bridge * optimize_lock_peer_stack(struct ast_channel *peer)
Definition: bridge.c:2672
struct ast_bridge_channel * ast_channel_internal_bridge_channel(const struct ast_channel *chan)
#define ast_bridge_channel_unlock(bridge_channel)
Unlock the bridge_channel.
Structure that contains information about a bridge.
Definition: bridge.h:357
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
static struct ast_bridge * optimize_lock_chan_stack(struct ast_channel *chan)
Definition: bridge.c:2627
Structure that contains information regarding a channel in a bridge.

◆ ast_bridge_unsuspend()

int ast_bridge_unsuspend ( struct ast_bridge bridge,
struct ast_channel chan 
)

Unsuspend a channel from a bridge.

Parameters
bridgeBridge to unsuspend the channel from
chanChannel to unsuspend
Return values
0on success
-1on failure

Example usage:

This unsuspends the channel pointed to by chan from the bridge pointed to by bridge. The bridge will go back to handling the channel once this function returns.

Note
You must not mess with the channel once this function returns. Doing so may result in bad things happening.

Definition at line 3089 of file bridge.c.

References ast_bridge_lock, ast_bridge_unlock, bridge_channel_internal_unsuspend_nolock(), and bridge_find_channel().

Referenced by conf_moh_start(), and conf_moh_stop().

3090 {
3091  struct ast_bridge_channel *bridge_channel;
3092 /* XXX ASTERISK-21271 the case of a disolved bridge while channel is suspended is not handled. */
3093 
3094  ast_bridge_lock(bridge);
3095 
3096  if (!(bridge_channel = bridge_find_channel(bridge, chan))) {
3097  ast_bridge_unlock(bridge);
3098  return -1;
3099  }
3100 
3102 
3103  ast_bridge_unlock(bridge);
3104 
3105  return 0;
3106 }
struct ast_bridge_channel * bridge_find_channel(struct ast_bridge *bridge, struct ast_channel *chan)
Definition: bridge.c:1469
void bridge_channel_internal_unsuspend_nolock(struct ast_bridge_channel *bridge_channel)
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
Structure that contains information regarding a channel in a bridge.

◆ ast_bridge_update_talker_src_video_mode()

void ast_bridge_update_talker_src_video_mode ( struct ast_bridge bridge,
struct ast_channel chan,
int  talker_energy,
int  is_keyfame 
)

Update information about talker energy for talker src video mode.

Definition at line 3883 of file bridge.c.

References ast_bridge_lock, ast_bridge_publish_state(), ast_bridge_unlock, ast_channel_name(), ast_channel_nativeformats(), ast_channel_ref, ast_channel_uniqueid(), ast_channel_unref, AST_CONTROL_VIDUPDATE, ast_format_cap_has_type(), ast_indicate(), AST_MEDIA_TYPE_VIDEO, ast_verb, ast_bridge_video_talker_src_data::average_talking_energy, ast_bridge_video_talker_src_data::chan_old_vsrc, ast_bridge_video_talker_src_data::chan_vsrc, ast_bridge_video_mode::mode_data, ast_bridge::name, ast_bridge::softmix, ast_bridge_video_mode::talker_src_data, ast_bridge::uniqueid, and ast_bridge_softmix::video_mode.

Referenced by softmix_bridge_write_video().

3884 {
3885  struct ast_bridge_video_talker_src_data *data;
3886 
3887  /* If the channel doesn't support video, we don't care about it */
3889  return;
3890  }
3891 
3892  ast_bridge_lock(bridge);
3893  data = &bridge->softmix.video_mode.mode_data.talker_src_data;
3894 
3895  if (data->chan_vsrc == chan) {
3896  data->average_talking_energy = talker_energy;
3897  } else if ((data->average_talking_energy < talker_energy) && is_keyframe) {
3898  if (data->chan_old_vsrc) {
3900  }
3901  if (data->chan_vsrc) {
3902  data->chan_old_vsrc = data->chan_vsrc;
3904  }
3905  data->chan_vsrc = ast_channel_ref(chan);
3906  data->average_talking_energy = talker_energy;
3907  ast_verb(5, "Video source in bridge '%s' (%s) is now '%s' (%s)\n",
3908  bridge->name, bridge->uniqueid,
3909  ast_channel_name(data->chan_vsrc),
3911  ast_bridge_publish_state(bridge);
3913  } else if ((data->average_talking_energy < talker_energy) && !is_keyframe) {
3915  } else if (!data->chan_vsrc && is_keyframe) {
3916  data->chan_vsrc = ast_channel_ref(chan);
3917  data->average_talking_energy = talker_energy;
3918  ast_verb(5, "Video source in bridge '%s' (%s) is now '%s' (%s)\n",
3919  bridge->name, bridge->uniqueid,
3920  ast_channel_name(data->chan_vsrc),
3922  ast_bridge_publish_state(bridge);
3924  } else if (!data->chan_old_vsrc && is_keyframe) {
3925  data->chan_old_vsrc = ast_channel_ref(chan);
3927  }
3928  ast_bridge_unlock(bridge);
3929 }
const ast_string_field uniqueid
Definition: bridge.h:409
union ast_bridge_video_mode::@221 mode_data
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2926
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition: channel.c:4291
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
const ast_string_field name
Definition: bridge.h:409
struct ast_channel * chan_old_vsrc
Definition: bridge.h:127
This is used for both SINGLE_SRC_TALKER mode to set what channel should be the current single video f...
Definition: bridge.h:121
struct ast_bridge_softmix softmix
Definition: bridge.h:375
#define ast_verb(level,...)
Definition: logger.h:455
struct ast_bridge_video_talker_src_data talker_src_data
Definition: bridge.h:164
void ast_bridge_publish_state(struct ast_bridge *bridge)
Publish the state of a bridge.
const char * ast_channel_uniqueid(const struct ast_channel *chan)
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
#define ast_channel_ref(c)
Increase channel reference count.
Definition: channel.h:2915
const char * ast_channel_name(const struct ast_channel *chan)
struct ast_channel * chan_vsrc
Definition: bridge.h:123
int ast_format_cap_has_type(const struct ast_format_cap *cap, enum ast_media_type type)
Find out if the capabilities structure has any formats of a specific type.
Definition: format_cap.c:615

◆ ast_bridge_vars_set()

void ast_bridge_vars_set ( struct ast_channel chan,
const char *  name,
const char *  pvtid 
)

Sets BRIDGECHANNEL and BRIDGEPVTCALLID for a channel.

Precondition
chan must be locked before calling
Parameters
namechannel name of the bridged peer
pvtidPrivate CallID of the bridged peer
Returns
nothing

Definition at line 1242 of file bridge.c.

References ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), and pbx_builtin_setvar_helper().

Referenced by ast_bridge_channel_leave_bridge_nolock(), set_bridge_peer_vars_2party(), set_bridge_peer_vars_holding(), and set_bridge_peer_vars_multiparty().

1243 {
1245  pbx_builtin_setvar_helper(chan, "BRIDGEPEER", name);
1246  pbx_builtin_setvar_helper(chan, "BRIDGEPVTCALLID", pvtid);
1248 }
void ast_channel_stage_snapshot_done(struct ast_channel *chan)
Clear flag to indicate channel snapshot is being staged, and publish snapshot.
void ast_channel_stage_snapshot(struct ast_channel *chan)
Set flag to indicate channel snapshot is being staged.
static const char name[]
Definition: cdr_mysql.c:74
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...

◆ ast_bridge_video_mode_to_string()

const char* ast_bridge_video_mode_to_string ( enum ast_bridge_video_mode_type  video_mode)

Converts an enum representation of a bridge video mode to string.

Parameters
video_modeThe video mode
Return values
Astring representation of video_mode

Definition at line 4018 of file bridge.c.

References AST_BRIDGE_VIDEO_MODE_NONE, AST_BRIDGE_VIDEO_MODE_SFU, AST_BRIDGE_VIDEO_MODE_SINGLE_SRC, and AST_BRIDGE_VIDEO_MODE_TALKER_SRC.

Referenced by ast_bridge_snapshot_to_json(), ast_manager_build_bridge_state_string_prefix(), and handle_bridge_show_specific().

4019 {
4020  switch (video_mode) {
4022  return "talker";
4024  return "single";
4026  return "sfu";
4028  default:
4029  return "none";
4030  }
4031 }

◆ ast_bridges()

struct ao2_container* ast_bridges ( void  )

Returns the global bridges container.

Since
17.0
Return values
apointer to the bridges container success
NULLon failure
Note
You must use ao2_ref(<container>, -1) when done with it
Warning
You must not attempt to modify the container returned.

Definition at line 174 of file bridge.c.

References ao2_bump.

Referenced by ast_ari_bridges_list(), bridges_scrape_cb(), and manager_bridges_list().

175 {
176  return ao2_bump(bridges);
177 }
#define ao2_bump(obj)
Definition: astobj2.h:491
static struct ao2_container * bridges
Definition: bridge.c:123

◆ ast_bridges_allow_optimization()

enum ast_bridge_optimization ast_bridges_allow_optimization ( struct ast_bridge chan_bridge,
struct ast_bridge peer_bridge 
)

Determine if bridges allow for optimization to occur betweem them.

Since
12.0.0
Parameters
chan_bridgeFirst bridge being tested
peer_bridgeSecond bridge being tested

This determines if two bridges allow for unreal channel optimization to occur between them. The function does not require for unreal channels to already be in the bridges when called.

Note
It is assumed that both bridges are locked prior to calling this function
A return other than AST_BRIDGE_OPTIMIZE_PROHIBITED does not guarantee that an optimization attempt will succeed. However, a return of AST_BRIDGE_OPTIMIZE_PROHIBITED guarantees that an optimization attempt will never succeed.
Returns
Optimization allowability for the bridges

Definition at line 3008 of file bridge.c.

References AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE, AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE, AST_BRIDGE_OPTIMIZE_PROHIBITED, AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE, AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE, bridge_allows_optimization(), bridges_allow_merge_optimization(), bridges_allow_swap_optimization(), merge_direction::dest, MERGE_ALLOWED, SWAP_PROHIBITED, SWAP_TO_CHAN_BRIDGE, and SWAP_TO_PEER_BRIDGE.

Referenced by two_bridge_attended_transfer().

3010 {
3011  struct merge_direction merge;
3012 
3013  if (!bridge_allows_optimization(chan_bridge) || !bridge_allows_optimization(peer_bridge)) {
3015  }
3016 
3017  switch (bridges_allow_swap_optimization(chan_bridge, peer_bridge)) {
3018  case SWAP_TO_CHAN_BRIDGE:
3020  case SWAP_TO_PEER_BRIDGE:
3022  case SWAP_PROHIBITED:
3023  default:
3024  break;
3025  }
3026 
3027  /* Two channels will be kicked from the bridges, the unreal;1 and unreal;2 channels */
3028  if (bridges_allow_merge_optimization(chan_bridge, peer_bridge, 2, &merge) != MERGE_ALLOWED) {
3030  }
3031 
3032  if (merge.dest == chan_bridge) {
3034  } else {
3036  }
3037 }
static int bridge_allows_optimization(struct ast_bridge *bridge)
Definition: bridge.c:2608
static enum bridge_allow_swap bridges_allow_swap_optimization(struct ast_bridge *chan_bridge, struct ast_bridge *peer_bridge)
Definition: bridge.c:2737
static enum bridge_allow_merge bridges_allow_merge_optimization(struct ast_bridge *chan_bridge, struct ast_bridge *peer_bridge, int num_kick_channels, struct merge_direction *merge)
Definition: bridge.c:2883

◆ ast_brige_set_remb_behavior()

void ast_brige_set_remb_behavior ( struct ast_bridge bridge,
enum ast_bridge_video_sfu_remb_behavior  behavior 
)

Set the REMB report generation behavior on a bridge.

Parameters
bridgeBridge to set the REMB behavior on
behaviorHow REMB reports are generated
Note
This can only be called when the bridge has been set to the SFU video mode.

Definition at line 3865 of file bridge.c.

References ast_assert, ast_bridge_lock, ast_bridge_unlock, AST_BRIDGE_VIDEO_MODE_SFU, ast_bridge_video_mode::mode, ast_bridge_video_mode::mode_data, ast_bridge_video_sfu_data::remb_behavior, ast_bridge_video_mode::sfu_data, ast_bridge::softmix, and ast_bridge_softmix::video_mode.

Referenced by join_conference_bridge().

3866 {
3868 
3869  ast_bridge_lock(bridge);
3870  bridge->softmix.video_mode.mode_data.sfu_data.remb_behavior = behavior;
3871  ast_bridge_unlock(bridge);
3872 }
union ast_bridge_video_mode::@221 mode_data
struct ast_bridge_video_mode video_mode
Definition: bridge.h:287
#define ast_assert(a)
Definition: utils.h:650
struct ast_bridge_softmix softmix
Definition: bridge.h:375
enum ast_bridge_video_sfu_remb_behavior remb_behavior
Definition: bridge.h:153
struct ast_bridge_video_sfu_data sfu_data
Definition: bridge.h:165
#define ast_bridge_unlock(bridge)
Unlock the bridge.
Definition: bridge.h:493
#define ast_bridge_lock(bridge)
Lock the bridge.
Definition: bridge.h:480
enum ast_bridge_video_mode_type mode
Definition: bridge.h:160

Variable Documentation

◆ ast_bridge_base_v_table

struct ast_bridge_methods ast_bridge_base_v_table