8d5c502113e98d74507e415c19ff9fa7f3c9e3dd
[asterisk/asterisk.git] / include / asterisk / bridge.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2009, 2013 Digium, Inc.
5  *
6  * Richard Mudgett <rmudgett@digium.com>
7  * Joshua Colp <jcolp@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*!
21  * \file
22  * \brief Bridging API
23  *
24  * \author Richard Mudgett <rmudgett@digium.com>
25  * \author Joshua Colp <jcolp@digium.com>
26  * \ref AstBridging
27  *
28  * See Also:
29  * \arg \ref AstCREDITS
30  */
31
32 /*!
33  * \page AstBridging Bridging API
34  *
35  * The purpose of this API is to provide an easy and flexible way to bridge
36  * channels of different technologies with different features.
37  *
38  * Bridging technologies provide the mechanism that do the actual handling
39  * of frames between channels. They provide capability information, codec information,
40  * and preference value to assist the bridging core in choosing a bridging technology when
41  * creating a bridge. Different bridges may use different bridging technologies based on needs
42  * but once chosen they all operate under the same premise; they receive frames and send frames.
43  *
44  * Bridges are a combination of bridging technology, channels, and features. A
45  * developer creates a new bridge based on what they are currently expecting to do
46  * with it or what they will do with it in the future. The bridging core determines what
47  * available bridging technology will best fit the requirements and creates a new bridge.
48  * Once created, channels can be added to the bridge in a blocking or non-blocking fashion.
49  *
50  * Features are such things as channel muting or DTMF based features such as attended transfer,
51  * blind transfer, and hangup. Feature information must be set at the most granular level, on
52  * the channel. While you can use features on a global scope the presence of a feature structure
53  * on the channel will override the global scope. An example would be having the bridge muted
54  * at global scope and attended transfer enabled on a channel. Since the channel itself is not muted
55  * it would be able to speak.
56  *
57  * Feature hooks allow a developer to tell the bridging core that when a DTMF string
58  * is received from a channel a callback should be called in their application. For
59  * example, a conference bridge application may want to provide an IVR to control various
60  * settings on the conference bridge. This can be accomplished by attaching a feature hook
61  * that calls an IVR function when a DTMF string is entered.
62  *
63  */
64
65 #ifndef _ASTERISK_BRIDGING_H
66 #define _ASTERISK_BRIDGING_H
67
68 #if defined(__cplusplus) || defined(c_plusplus)
69 extern "C" {
70 #endif
71
72 #include "asterisk/bridge_features.h"
73 #include "asterisk/bridge_channel.h"
74 #include "asterisk/bridge_roles.h"
75 #include "asterisk/dsp.h"
76 #include "asterisk/uuid.h"
77
78 struct ast_bridge_technology;
79 struct ast_bridge;
80 struct ast_bridge_tech_optimizations;
81
82 /*! \brief Capabilities for a bridge technology */
83 enum ast_bridge_capability {
84         /*! Bridge technology can service calls on hold. */
85         AST_BRIDGE_CAPABILITY_HOLDING = (1 << 0),
86         /*! Bridge waits for channel to answer.  Passes early media. (XXX Not supported yet) */
87         AST_BRIDGE_CAPABILITY_EARLY = (1 << 1),
88         /*! Bridge is capable of natively bridging two channels. (Smart bridge only) */
89         AST_BRIDGE_CAPABILITY_NATIVE = (1 << 2),
90         /*! Bridge is capable of mixing at most two channels. (Smart bridgeable) */
91         AST_BRIDGE_CAPABILITY_1TO1MIX = (1 << 3),
92         /*! Bridge is capable of mixing an arbitrary number of channels. (Smart bridgeable) */
93         AST_BRIDGE_CAPABILITY_MULTIMIX = (1 << 4),
94 };
95
96 /*! \brief Video source modes */
97 enum ast_bridge_video_mode_type {
98         /*! Video is not allowed in the bridge */
99         AST_BRIDGE_VIDEO_MODE_NONE = 0,
100         /*! A single user is picked as the only distributed of video across the bridge */
101         AST_BRIDGE_VIDEO_MODE_SINGLE_SRC,
102         /*! A single user's video feed is distributed to all bridge channels, but
103          *  that feed is automatically picked based on who is talking the most. */
104         AST_BRIDGE_VIDEO_MODE_TALKER_SRC,
105         /*! Operate as a selective forwarding unit. Video from each participant is
106          * cloned to a dedicated stream on a subset of the remaining participants.
107          */
108         AST_BRIDGE_VIDEO_MODE_SFU,
109 };
110
111 /*! \brief This is used for both SINGLE_SRC mode to set what channel
112  *  should be the current single video feed */
113 struct ast_bridge_video_single_src_data {
114         /*! Only accept video coming from this channel */
115         struct ast_channel *chan_vsrc;
116 };
117
118 /*! \brief This is used for both SINGLE_SRC_TALKER mode to set what channel
119  *  should be the current single video feed */
120 struct ast_bridge_video_talker_src_data {
121         /*! Only accept video coming from this channel */
122         struct ast_channel *chan_vsrc;
123         int average_talking_energy;
124
125         /*! Current talker see's this person */
126         struct ast_channel *chan_old_vsrc;
127 };
128
129 /*! \brief Data structure that defines a video source mode */
130 struct ast_bridge_video_mode {
131         enum ast_bridge_video_mode_type mode;
132         /* Add data for all the video modes here. */
133         union {
134                 struct ast_bridge_video_single_src_data single_src_data;
135                 struct ast_bridge_video_talker_src_data talker_src_data;
136         } mode_data;
137         unsigned int video_update_discard;
138 };
139
140 /*!
141  * \brief Destroy the bridge.
142  *
143  * \param self Bridge to operate upon.
144  *
145  * \return Nothing
146  */
147 typedef void (*ast_bridge_destructor_fn)(struct ast_bridge *self);
148
149 /*!
150  * \brief The bridge is being dissolved.
151  *
152  * \param self Bridge to operate upon.
153  *
154  * \details
155  * The bridge is being dissolved.  Remove any external
156  * references to the bridge so it can be destroyed.
157  *
158  * \note On entry, self must NOT be locked.
159  *
160  * \return Nothing
161  */
162 typedef void (*ast_bridge_dissolving_fn)(struct ast_bridge *self);
163
164 /*!
165  * \brief Push this channel into the bridge.
166  *
167  * \param self Bridge to operate upon.
168  * \param bridge_channel Bridge channel to push.
169  * \param swap Bridge channel to swap places with if not NULL.
170  *
171  * \details
172  * Setup any channel hooks controlled by the bridge.  Allocate
173  * bridge_channel->bridge_pvt and initialize any resources put
174  * in bridge_channel->bridge_pvt if needed.  If there is a swap
175  * channel, use it as a guide to setting up the bridge_channel.
176  *
177  * \note On entry, self is already locked.
178  *
179  * \retval 0 on success.
180  * \retval -1 on failure.  The channel did not get pushed.
181  */
182 typedef int (*ast_bridge_push_channel_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap);
183
184 /*!
185  * \brief Pull this channel from the bridge.
186  *
187  * \param self Bridge to operate upon.
188  * \param bridge_channel Bridge channel to pull.
189  *
190  * \details
191  * Remove any channel hooks controlled by the bridge.  Release
192  * any resources held by bridge_channel->bridge_pvt and release
193  * bridge_channel->bridge_pvt.
194  *
195  * \note On entry, self is already locked.
196  *
197  * \return Nothing
198  */
199 typedef void (*ast_bridge_pull_channel_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel);
200
201 /*!
202  * \brief Notify the bridge that this channel was just masqueraded.
203  *
204  * \param self Bridge to operate upon.
205  * \param bridge_channel Bridge channel that was masqueraded.
206  *
207  * \details
208  * A masquerade just happened to this channel.  The bridge needs
209  * to re-evaluate this a channel in the bridge.
210  *
211  * \note On entry, self is already locked.
212  *
213  * \return Nothing
214  */
215 typedef void (*ast_bridge_notify_masquerade_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel);
216
217 /*!
218  * \brief Get the merge priority of this bridge.
219  *
220  * \param self Bridge to operate upon.
221  *
222  * \note On entry, self is already locked.
223  *
224  * \return Merge priority
225  */
226 typedef int (*ast_bridge_merge_priority_fn)(struct ast_bridge *self);
227
228 /*!
229  * \brief Bridge virtual methods table definition.
230  *
231  * \note Any changes to this struct must be reflected in
232  * bridge_alloc() validity checking.
233  */
234 struct ast_bridge_methods {
235         /*! Bridge class name for log messages. */
236         const char *name;
237         /*! Destroy the bridge. */
238         ast_bridge_destructor_fn destroy;
239         /*! The bridge is being dissolved.  Remove any references to the bridge. */
240         ast_bridge_dissolving_fn dissolving;
241         /*! Push the bridge channel into the bridge. */
242         ast_bridge_push_channel_fn push;
243         /*! Pull the bridge channel from the bridge. */
244         ast_bridge_pull_channel_fn pull;
245         /*! Notify the bridge of a masquerade with the channel. */
246         ast_bridge_notify_masquerade_fn notify_masquerade;
247         /*! Get the bridge merge priority. */
248         ast_bridge_merge_priority_fn get_merge_priority;
249         /*! Peek at swap channel before it can hang up, prior to push. */
250         ast_bridge_push_channel_fn push_peek;
251 };
252
253 /*! Softmix technology parameters. */
254 struct ast_bridge_softmix {
255         /*! The video mode softmix is using */
256         struct ast_bridge_video_mode video_mode;
257         /*!
258          * \brief The internal sample rate softmix uses to mix channels.
259          *
260          * \note If this value is 0, the sofmix may auto adjust the mixing rate.
261          */
262         unsigned int internal_sample_rate;
263         /*!
264          * \brief The mixing interval indicates how quickly softmix
265          * mixing should occur to mix audio.
266          *
267          * \note When set to 0, softmix must choose a default interval
268          * for itself.
269          */
270         unsigned int internal_mixing_interval;
271         /*! TRUE if binaural convolve is activated in configuration. */
272         unsigned int binaural_active;
273 };
274
275 AST_LIST_HEAD_NOLOCK(ast_bridge_channels_list, ast_bridge_channel);
276
277 /*!
278  * \brief Structure that contains information about a bridge
279  */
280 struct ast_bridge {
281         /*! Bridge virtual method table. */
282         const struct ast_bridge_methods *v_table;
283         /*! "Personality" currently exhibited by bridge subclass */
284         void *personality;
285         /*! Bridge technology that is handling the bridge */
286         struct ast_bridge_technology *technology;
287         /*! Private information unique to the bridge technology */
288         void *tech_pvt;
289         /*! Per-bridge topics */
290         struct stasis_cp_single *topics;
291         /*! Call ID associated with the bridge */
292         ast_callid callid;
293         /*! Linked list of channels participating in the bridge */
294         struct ast_bridge_channels_list channels;
295         /*! Queue of actions to perform on the bridge. */
296         AST_LIST_HEAD_NOLOCK(, ast_frame) action_queue;
297         /*! Softmix technology parameters. */
298         struct ast_bridge_softmix softmix;
299         /*! Bridge flags to tweak behavior */
300         struct ast_flags feature_flags;
301         /*! Allowed bridge technology capabilities when AST_BRIDGE_FLAG_SMART enabled. */
302         uint32_t allowed_capabilities;
303         /*! Number of channels participating in the bridge */
304         unsigned int num_channels;
305         /*! Number of active channels in the bridge. */
306         unsigned int num_active;
307         /*! Number of channels with AST_BRIDGE_CHANNEL_FLAG_LONELY in the bridge. */
308         unsigned int num_lonely;
309         /*!
310          * \brief Count of the active temporary requests to inhibit bridge merges.
311          * Zero if merges are allowed.
312          *
313          * \note Temporary as in try again in a moment.
314          */
315         unsigned int inhibit_merge;
316         /*! Cause code of the dissolved bridge. */
317         int cause;
318         /*! TRUE if the bridge was reconfigured. */
319         unsigned int reconfigured:1;
320         /*! TRUE if the bridge has been dissolved.  Any channel that now tries to join is immediately ejected. */
321         unsigned int dissolved:1;
322         /*! TRUE if the bridge construction was completed. */
323         unsigned int construction_completed:1;
324
325         AST_DECLARE_STRING_FIELDS(
326                 /*! Immutable name of the creator for the bridge */
327                 AST_STRING_FIELD(creator);
328                 /*! Immutable name given to the bridge by its creator */
329                 AST_STRING_FIELD(name);
330                 /*! Immutable bridge UUID. */
331                 AST_STRING_FIELD(uniqueid);
332         );
333
334         /*! Type mapping used for media routing */
335         struct ast_vector_int media_types;
336 };
337
338 /*! \brief Bridge base class virtual method table. */
339 extern struct ast_bridge_methods ast_bridge_base_v_table;
340
341 /*!
342  * \brief Create a new base class bridge
343  *
344  * \param capabilities The capabilities that we require to be used on the bridge
345  * \param flags Flags that will alter the behavior of the bridge
346  * \param creator Entity that created the bridge (optional)
347  * \param name Name given to the bridge by its creator (optional, requires named creator)
348  * \param id Unique ID given to the bridge by its creator (optional)
349  *
350  * \retval a pointer to a new bridge on success
351  * \retval NULL on failure
352  *
353  * Example usage:
354  *
355  * \code
356  * struct ast_bridge *bridge;
357  * bridge = ast_bridge_base_new(AST_BRIDGE_CAPABILITY_1TO1MIX, AST_BRIDGE_FLAG_DISSOLVE_HANGUP);
358  * \endcode
359  *
360  * This creates a no frills two party bridge that will be
361  * destroyed once one of the channels hangs up.
362  */
363 struct ast_bridge *ast_bridge_base_new(uint32_t capabilities, unsigned int flags, const char *creator, const char *name, const char *id);
364
365 /*!
366  * \brief Try locking the bridge.
367  *
368  * \param bridge Bridge to try locking
369  *
370  * \retval 0 on success.
371  * \retval non-zero on error.
372  */
373 #define ast_bridge_trylock(bridge)      _ast_bridge_trylock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
374 static inline int _ast_bridge_trylock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
375 {
376         return __ao2_trylock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
377 }
378
379 /*!
380  * \brief Lock the bridge.
381  *
382  * \param bridge Bridge to lock
383  *
384  * \return Nothing
385  */
386 #define ast_bridge_lock(bridge) _ast_bridge_lock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
387 static inline void _ast_bridge_lock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
388 {
389         __ao2_lock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
390 }
391
392 /*!
393  * \brief Unlock the bridge.
394  *
395  * \param bridge Bridge to unlock
396  *
397  * \return Nothing
398  */
399 #define ast_bridge_unlock(bridge)       _ast_bridge_unlock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
400 static inline void _ast_bridge_unlock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
401 {
402         __ao2_unlock(bridge, file, function, line, var);
403 }
404
405 /*! \brief Lock two bridges. */
406 #define ast_bridge_lock_both(bridge1, bridge2)          \
407         do {                                                                                    \
408                 for (;;) {                                                                      \
409                         ast_bridge_lock(bridge1);                               \
410                         if (!ast_bridge_trylock(bridge2)) {             \
411                                 break;                                                          \
412                         }                                                                               \
413                         ast_bridge_unlock(bridge1);                             \
414                         sched_yield();                                                  \
415                 }                                                                                       \
416         } while (0)
417
418 /*!
419  * \brief Destroy a bridge
420  *
421  * \param bridge Bridge to destroy
422  * \param cause Cause of bridge being destroyed.  (If cause <= 0 then use AST_CAUSE_NORMAL_CLEARING)
423  *
424  * \retval 0 on success
425  * \retval -1 on failure
426  *
427  * Example usage:
428  *
429  * \code
430  * ast_bridge_destroy(bridge, AST_CAUSE_NORMAL_CLEARING);
431  * \endcode
432  *
433  * This destroys a bridge that was previously created.
434  *
435  * \note
436  * While this function will kick all channels out of the bridge, channels that
437  * were added to the bridge using ast_bridge_impart() with the flag
438  * AST_BRIDGE_IMPART_CHAN_DEPARTABLE set must have ast_bridge_depart() called
439  * on them.
440  */
441 int ast_bridge_destroy(struct ast_bridge *bridge, int cause);
442
443 /*!
444  * \brief Notify bridging that this channel was just masqueraded.
445  * \since 12.0.0
446  *
447  * \param chan Channel just involved in a masquerade
448  *
449  * \return Nothing
450  */
451 void ast_bridge_notify_masquerade(struct ast_channel *chan);
452
453 enum ast_bridge_join_flags {
454         /*! The bridge reference is being passed by the caller. */
455         AST_BRIDGE_JOIN_PASS_REFERENCE = (1 << 0),
456         /*! The initial bridge join does not cause a COLP exchange. */
457         AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP = (1 << 1),
458 };
459
460 /*!
461  * \brief Join a channel to a bridge (blocking)
462  *
463  * \param bridge Bridge to join
464  * \param chan Channel to join
465  * \param swap Channel to swap out if swapping (A channel reference is stolen.)
466  * \param features Bridge features structure
467  * \param tech_args Optional Bridging tech optimization parameters for this channel.
468  * \param flags defined by enum ast_bridge_join_flags.
469  *
470  * \note The passed in swap channel is always unreffed on return.  It is not a
471  * good idea to access the swap channel on return or for the caller to keep a
472  * reference to it.
473  *
474  * \note Absolutely _NO_ locks should be held before calling
475  * this function since it blocks.
476  *
477  * \retval 0 if the channel successfully joined the bridge before it exited.
478  * \retval -1 if the channel failed to join the bridge
479  *
480  * Example usage:
481  *
482  * \code
483  * ast_bridge_join(bridge, chan, NULL, NULL, NULL, AST_BRIDGE_JOIN_PASS_REFERENCE);
484  * \endcode
485  *
486  * This adds a channel pointed to by the chan pointer to the bridge pointed to by
487  * the bridge pointer. This function will not return until the channel has been
488  * removed from the bridge, swapped out for another channel, or has hung up.
489  *
490  * If this channel will be replacing another channel the other channel can be specified
491  * in the swap parameter. The other channel will be thrown out of the bridge in an
492  * atomic fashion.
493  *
494  * If channel specific features are enabled a pointer to the features structure
495  * can be specified in the features parameter.
496  */
497 int ast_bridge_join(struct ast_bridge *bridge,
498         struct ast_channel *chan,
499         struct ast_channel *swap,
500         struct ast_bridge_features *features,
501         struct ast_bridge_tech_optimizations *tech_args,
502         enum ast_bridge_join_flags flags);
503
504 enum ast_bridge_impart_flags {
505         /*! Field describing what the caller can do with the channel after it is imparted. */
506         AST_BRIDGE_IMPART_CHAN_MASK = (1 << 0),
507         /*! The caller wants to reclaim the channel using ast_bridge_depart(). */
508         AST_BRIDGE_IMPART_CHAN_DEPARTABLE = (0 << 0),
509         /*! The caller is passing channel control entirely to the bridging system. */
510         AST_BRIDGE_IMPART_CHAN_INDEPENDENT = (1 << 0),
511         /*! The initial bridge join does not cause a COLP exchange. */
512         AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP = (1 << 1),
513 };
514
515 /*!
516  * \brief Impart a channel to a bridge (non-blocking)
517  *
518  * \param bridge Bridge to impart on
519  * \param chan Channel to impart (The channel reference is stolen if impart successful.)
520  * \param swap Channel to swap out if swapping.  NULL if not swapping.
521  * \param features Bridge features structure.
522  * \param flags defined by enum ast_bridge_impart_flags.
523  *
524  * \note The given bridge must be unlocked when calling this function.
525  *
526  * \note The features parameter must be NULL or obtained by
527  * ast_bridge_features_new().  You must not dereference features
528  * after calling even if the call fails.
529  *
530  * \note chan is locked by this function.
531  *
532  * \retval 0 on success
533  * \retval -1 on failure (Caller still has ownership of chan)
534  *
535  * Example usage:
536  *
537  * \code
538  * ast_bridge_impart(bridge, chan, NULL, NULL, AST_BRIDGE_IMPART_CHAN_INDEPENDENT);
539  * \endcode
540  *
541  * \details
542  * This adds a channel pointed to by the chan pointer to the
543  * bridge pointed to by the bridge pointer.  This function will
544  * return immediately and will not wait until the channel is no
545  * longer part of the bridge.
546  *
547  * If this channel will be replacing another channel the other
548  * channel can be specified in the swap parameter.  The other
549  * channel will be thrown out of the bridge in an atomic
550  * fashion.
551  *
552  * If channel specific features are enabled, a pointer to the
553  * features structure can be specified in the features
554  * parameter.
555  *
556  * \note If you impart a channel with
557  * AST_BRIDGE_IMPART_CHAN_DEPARTABLE you MUST
558  * ast_bridge_depart() the channel if this call succeeds.  The
559  * bridge channel thread is created join-able.  The implication
560  * is that the channel is special and will not behave like a
561  * normal channel.
562  *
563  * \note If you impart a channel with
564  * AST_BRIDGE_IMPART_CHAN_INDEPENDENT you must not
565  * ast_bridge_depart() the channel.  The bridge channel thread
566  * is created non-join-able.  The channel must be treated as if
567  * it were placed into the bridge by ast_bridge_join().
568  * Channels placed into a bridge by ast_bridge_join() are
569  * removed by a third party using ast_bridge_remove().
570  */
571 int ast_bridge_impart(struct ast_bridge *bridge,
572         struct ast_channel *chan,
573         struct ast_channel *swap,
574         struct ast_bridge_features *features,
575         enum ast_bridge_impart_flags flags) attribute_warn_unused_result;
576
577 /*!
578  * \brief Depart a channel from a bridge
579  *
580  * \param chan Channel to depart
581  *
582  * \note chan is locked by this function.
583  *
584  * \retval 0 on success
585  * \retval -1 on failure
586  *
587  * Example usage:
588  *
589  * \code
590  * ast_bridge_depart(chan);
591  * \endcode
592  *
593  * This removes the channel pointed to by the chan pointer from any bridge
594  * it may be in and gives control to the calling thread.
595  * This does not hang up the channel.
596  *
597  * \note This API call can only be used on channels that were added to the bridge
598  *       using the ast_bridge_impart API call with the AST_BRIDGE_IMPART_CHAN_DEPARTABLE
599  *       flag.
600  */
601 int ast_bridge_depart(struct ast_channel *chan);
602
603 /*!
604  * \brief Remove a channel from a bridge
605  *
606  * \param bridge Bridge that the channel is to be removed from
607  * \param chan Channel to remove
608  *
609  * \retval 0 on success
610  * \retval -1 on failure
611  *
612  * Example usage:
613  *
614  * \code
615  * ast_bridge_remove(bridge, chan);
616  * \endcode
617  *
618  * This removes the channel pointed to by the chan pointer from the bridge
619  * pointed to by the bridge pointer and requests that it be hung up. Control
620  * over the channel will NOT be given to the calling thread.
621  *
622  * \note This API call can be used on channels that were added to the bridge
623  *       using both ast_bridge_join and ast_bridge_impart.
624  */
625 int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan);
626
627 /*!
628  * \brief Kick a channel from a bridge
629  *
630  * \param bridge Bridge that the channel is to be kicked from
631  * \param chan Channel to kick
632  *
633  * \retval 0 on success
634  * \retval -1 on failure
635  *
636  * Example usage:
637  *
638  * \code
639  * ast_bridge_kick(bridge, chan);
640  * \endcode
641  *
642  * \details
643  * This kicks the channel pointed to by the chan pointer from
644  * the bridge pointed to by the bridge pointer and requests that
645  * it be hung up.  Control over the channel will NOT be given to
646  * the calling thread.
647  *
648  * \note The functional difference between ast_bridge_kick() and
649  * ast_bridge_remove() is that the bridge may dissolve as a
650  * result of the channel being kicked.
651  *
652  * \note This API call can be used on channels that were added
653  * to the bridge using both ast_bridge_join and
654  * ast_bridge_impart.
655  */
656 int ast_bridge_kick(struct ast_bridge *bridge, struct ast_channel *chan);
657
658 /*!
659  * \brief Merge two bridges together
660  *
661  * \param dst_bridge Destination bridge of merge.
662  * \param src_bridge Source bridge of merge.
663  * \param merge_best_direction TRUE if don't care about which bridge merges into the other.
664  * \param kick_me Array of channels to kick from the bridges.
665  * \param num_kick Number of channels in the kick_me array.
666  *
667  * \note Absolutely _NO_ bridge or channel locks should be held
668  * before calling this function.
669  *
670  * \retval 0 on success
671  * \retval -1 on failure
672  *
673  * Example usage:
674  *
675  * \code
676  * ast_bridge_merge(dst_bridge, src_bridge, 0, NULL, 0);
677  * \endcode
678  *
679  * This moves the channels in src_bridge into the bridge pointed
680  * to by dst_bridge.
681  */
682 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);
683
684 /*!
685  * \brief Move a channel from one bridge to another.
686  * \since 12.0.0
687  *
688  * \param dst_bridge Destination bridge of bridge channel move.
689  * \param src_bridge Source bridge of bridge channel move.
690  * \param chan Channel to move.
691  * \param swap Channel to replace in dst_bridge.
692  * \param attempt_recovery TRUE if failure attempts to push channel back into original bridge.
693  *
694  * \note Absolutely _NO_ bridge or channel locks should be held
695  * before calling this function.
696  *
697  * \retval 0 on success.
698  * \retval -1 on failure.
699  */
700 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);
701
702 /*!
703  * \brief Adjust the bridge merge inhibit request count.
704  * \since 12.0.0
705  *
706  * \param bridge What to operate on.
707  * \param request Inhibit request increment.
708  *     (Positive to add requests.  Negative to remove requests.)
709  *
710  * \return Nothing
711  */
712 void ast_bridge_merge_inhibit(struct ast_bridge *bridge, int request);
713
714 /*!
715  * \brief Suspend a channel temporarily from a bridge
716  *
717  * \param bridge Bridge to suspend the channel from
718  * \param chan Channel to suspend
719  *
720  * \retval 0 on success
721  * \retval -1 on failure
722  *
723  * Example usage:
724  *
725  * \code
726  * ast_bridge_suspend(bridge, chan);
727  * \endcode
728  *
729  * This suspends the channel pointed to by chan from the bridge pointed to by bridge temporarily.
730  * Control of the channel is given to the calling thread. This differs from ast_bridge_depart as
731  * the channel will not be removed from the bridge.
732  *
733  * \note This API call can be used on channels that were added to the bridge
734  *       using both ast_bridge_join and ast_bridge_impart.
735  */
736 int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan);
737
738 /*!
739  * \brief Unsuspend a channel from a bridge
740  *
741  * \param bridge Bridge to unsuspend the channel from
742  * \param chan Channel to unsuspend
743  *
744  * \retval 0 on success
745  * \retval -1 on failure
746  *
747  * Example usage:
748  *
749  * \code
750  * ast_bridge_unsuspend(bridge, chan);
751  * \endcode
752  *
753  * This unsuspends the channel pointed to by chan from the bridge pointed to by bridge.
754  * The bridge will go back to handling the channel once this function returns.
755  *
756  * \note You must not mess with the channel once this function returns.
757  *       Doing so may result in bad things happening.
758  */
759 int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan);
760
761 /*!
762  * \brief Sets BRIDGECHANNEL and BRIDGEPVTCALLID for a channel
763  *
764  * \pre chan must be locked before calling
765  *
766  * \param name channel name of the bridged peer
767  * \param pvtid Private CallID of the bridged peer
768  *
769  * \return nothing
770  */
771 void ast_bridge_vars_set(struct ast_channel *chan, const char *name, const char *pvtid);
772
773 struct ast_unreal_pvt;
774
775 /*!
776  * \brief Check and optimize out the unreal channels between bridges.
777  * \since 12.0.0
778  *
779  * \param chan Unreal channel writing a frame into the channel driver.
780  * \param peer Other unreal channel in the pair.
781  * \param pvt Private data provided by an implementation of the unreal driver that
782  * contains the callbacks that should be called when optimization begins/ends
783  *
784  * \note It is assumed that chan is already locked.
785  *
786  * \retval 0 if unreal channels were not optimized out.
787  * \retval non-zero if unreal channels were optimized out.
788  */
789 int ast_bridge_unreal_optimize_out(struct ast_channel *chan, struct ast_channel *peer, struct ast_unreal_pvt *pvt);
790
791 /*!
792  * \brief Tells, if optimization is allowed, how the optimization would be performed
793  */
794 enum ast_bridge_optimization {
795         /*! Optimization would swap peer into the chan_bridge */
796         AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE,
797         /*! Optimization would swap chan into the peer_bridge */
798         AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE,
799         /*! Optimization would merge peer_bridge into chan_bridge */
800         AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE,
801         /*! Optimization would merge chan_bridge into peer_bridge */
802         AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE,
803         /*! Optimization is not permitted on one or both bridges */
804         AST_BRIDGE_OPTIMIZE_PROHIBITED,
805 };
806
807 /*!
808  * \brief Determine if bridges allow for optimization to occur betweem them
809  * \since 12.0.0
810  *
811  * \param chan_bridge First bridge being tested
812  * \param peer_bridge Second bridge being tested
813  *
814  * This determines if two bridges allow for unreal channel optimization
815  * to occur between them. The function does not require for unreal channels
816  * to already be in the bridges when called.
817  *
818  * \note It is assumed that both bridges are locked prior to calling this function
819  *
820  * \note A return other than AST_BRIDGE_OPTIMIZE_PROHIBITED does not guarantee
821  * that an optimization attempt will succeed. However, a return of
822  * AST_BRIDGE_OPTIMIZE_PROHIBITED guarantees that an optimization attempt will
823  * never succeed.
824  *
825  * \returns Optimization allowability for the bridges
826  */
827 enum ast_bridge_optimization ast_bridges_allow_optimization(struct ast_bridge *chan_bridge,
828                 struct ast_bridge *peer_bridge);
829
830 /*!
831  * \brief Put an action onto the specified bridge.
832  * \since 12.0.0
833  *
834  * \param bridge What to queue the action on.
835  * \param action What to do.
836  *
837  * \retval 0 on success.
838  * \retval -1 on error.
839  *
840  * \note This API call is meant for internal bridging operations.
841  */
842 int ast_bridge_queue_action(struct ast_bridge *bridge, struct ast_frame *action);
843
844 /*!
845  * \brief Queue the given frame to everyone else.
846  * \since 12.0.0
847  *
848  * \param bridge What bridge to distribute frame.
849  * \param bridge_channel Channel to optionally not pass frame to. (NULL to pass to everyone)
850  * \param frame Frame to pass.
851  *
852  * \note This is intended to be called by bridge hooks and
853  * bridge technologies.
854  *
855  * \retval 0 Frame written to at least one channel.
856  * \retval -1 Frame written to no channels.
857  */
858 int ast_bridge_queue_everyone_else(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame);
859
860 /*!
861  * \brief Adjust the internal mixing sample rate of a bridge
862  * used during multimix mode.
863  *
864  * \param bridge Channel to change the sample rate on.
865  * \param sample_rate the sample rate to change to. If a
866  *        value of 0 is passed here, the bridge will be free to pick
867  *        what ever sample rate it chooses.
868  *
869  */
870 void ast_bridge_set_internal_sample_rate(struct ast_bridge *bridge, unsigned int sample_rate);
871
872 /*!
873  * \brief Adjust the internal mixing interval of a bridge used
874  * during multimix mode.
875  *
876  * \param bridge Channel to change the sample rate on.
877  * \param mixing_interval the sample rate to change to.  If 0 is set
878  * the bridge tech is free to choose any mixing interval it uses by default.
879  */
880 void ast_bridge_set_mixing_interval(struct ast_bridge *bridge, unsigned int mixing_interval);
881
882 /*!
883  * \brief Activates the use of binaural signals in a conference bridge.
884  *
885  *  \param bridge Channel to activate the binaural signals.
886  *  \param binaural_active If true binaural signal processing will be active for the bridge.
887  */
888 void ast_bridge_set_binaural_active(struct ast_bridge *bridge, unsigned int binaural_active);
889
890 /*!
891  * \brief Set a bridge to feed a single video source to all participants.
892  */
893 void ast_bridge_set_single_src_video_mode(struct ast_bridge *bridge, struct ast_channel *video_src_chan);
894
895 /*!
896  * \brief Set the bridge to pick the strongest talker supporting
897  * video as the single source video feed
898  */
899 void ast_bridge_set_talker_src_video_mode(struct ast_bridge *bridge);
900
901 /*!
902  * \brief Set the bridge to be a selective forwarding unit
903  */
904 void ast_bridge_set_sfu_video_mode(struct ast_bridge *bridge);
905
906 /*!
907  * \brief Set the amount of time to discard subsequent video updates after a video update has been sent
908  *
909  * \param bridge Bridge to set the minimum video update wait time on
910  * \param video_update_discard Amount of time after sending a video update that others should be discarded
911  */
912 void ast_bridge_set_video_update_discard(struct ast_bridge *bridge, unsigned int video_update_discard);
913
914 /*!
915  * \brief Update information about talker energy for talker src video mode.
916  */
917 void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame);
918
919 /*!
920  * \brief Returns the number of video sources currently active in the bridge
921  */
922 int ast_bridge_number_video_src(struct ast_bridge *bridge);
923
924 /*!
925  * \brief Determine if a channel is a video src for the bridge
926  *
927  * \retval 0 Not a current video source of the bridge.
928  * \retval None 0, is a video source of the bridge, The number
929  *         returned represents the priority this video stream has
930  *         on the bridge where 1 is the highest priority.
931  */
932 int ast_bridge_is_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
933
934 /*!
935  * \brief remove a channel as a source of video for the bridge.
936  */
937 void ast_bridge_remove_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
938
939 /*!
940  * \brief Converts an enum representation of a bridge video mode to string
941  *
942  * \param video_mode The video mode
943  *
944  * \retval A string representation of \c video_mode
945  */
946 const char *ast_bridge_video_mode_to_string(enum ast_bridge_video_mode_type video_mode);
947
948 enum ast_transfer_result {
949         /*! The transfer completed successfully */
950         AST_BRIDGE_TRANSFER_SUCCESS,
951         /*! A bridge involved does not permit transferring */
952         AST_BRIDGE_TRANSFER_NOT_PERMITTED,
953         /*! The current bridge setup makes transferring an invalid operation */
954         AST_BRIDGE_TRANSFER_INVALID,
955         /*! The transfer operation failed for a miscellaneous reason */
956         AST_BRIDGE_TRANSFER_FAIL,
957 };
958
959 enum ast_transfer_type {
960         /*! Transfer of a single party */
961         AST_BRIDGE_TRANSFER_SINGLE_PARTY,
962         /*! Transfer of multiple parties */
963         AST_BRIDGE_TRANSFER_MULTI_PARTY,
964 };
965
966 /*!
967  * \brief AO2 object that wraps data for transfer_channel_cb
968  */
969 struct transfer_channel_data {
970         void *data;    /*! Data to be used by the transfer_channel_cb -- note that this
971                         *  pointer is going to be pointing to something on the stack, so
972                         *  it must not be used at any point after returning from the
973                         *  transfer_channel_cb. */
974         int completed; /*! Initially 0, This will be set to 1 by either the transfer
975                         *  code or by transfer code hooks (e.g. parking) when the
976                         *  transfer is completed and any remaining actions have taken
977                         *  place (e.g. parking announcements). It will never be reset
978                         *  to 0. This is used for deferring progress for channel
979                         *  drivers that support deferred progress. */
980 };
981
982 /*!
983  * \brief Callback function type called during blind transfers
984  *
985  * A caller of ast_bridge_transfer_blind() may wish to set data on
986  * the channel that ends up running dialplan. For instance, it may
987  * be useful to set channel variables on the channel.
988  *
989  * \param chan The involved channel
990  * \param user_data User-provided data needed in the callback
991  * \param transfer_type The type of transfer being completed
992  */
993 typedef void (*transfer_channel_cb)(struct ast_channel *chan, struct transfer_channel_data *user_data,
994                 enum ast_transfer_type transfer_type);
995
996 /*!
997  * \brief Blind transfer target to the extension and context provided
998  *
999  * The channel given is bridged to one or multiple channels. Depending on
1000  * the bridge and the number of participants, the entire bridge could be
1001  * transferred to the given destination, or a single channel may be redirected.
1002  *
1003  * Callers may also provide a callback to be called on the channel that will
1004  * be running dialplan. The user data passed into ast_bridge_transfer_blind
1005  * will be given as the argument to the callback to be interpreted as desired.
1006  * This callback is guaranteed to be called in the same thread as
1007  * ast_bridge_transfer_blind() and before ast_bridge_transfer_blind() returns.
1008  *
1009  * \note Absolutely _NO_ channel locks should be held before
1010  * calling this function.
1011  *
1012  * \param is_external Indicates that transfer was initiated externally
1013  * \param transferer The channel performing the blind transfer
1014  * \param exten The dialplan extension to send the call to
1015  * \param context The dialplan context to send the call to
1016  * \param new_channel_cb A callback to be called on the channel that will
1017  *        be executing dialplan
1018  * \param user_data Argument for new_channel_cb
1019  * \return The success or failure result of the blind transfer
1020  */
1021 enum ast_transfer_result ast_bridge_transfer_blind(int is_external,
1022                 struct ast_channel *transferer, const char *exten, const char *context,
1023                 transfer_channel_cb new_channel_cb, void *user_data);
1024
1025 /*!
1026  * \brief Attended transfer
1027  *
1028  * The two channels are both transferer channels. The first is the channel
1029  * that is bridged to the transferee (or if unbridged, the 'first' call of
1030  * the transfer). The second is the channel that is bridged to the transfer
1031  * target (or if unbridged, the 'second' call of the transfer).
1032  *
1033  * \note Absolutely _NO_ channel locks should be held before
1034  * calling this function.
1035  *
1036  * \param to_transferee Transferer channel on initial call (presumably bridged to transferee)
1037  * \param to_transfer_target Transferer channel on consultation call (presumably bridged to transfer target)
1038  * \return The success or failure of the attended transfer
1039  */
1040 enum ast_transfer_result ast_bridge_transfer_attended(struct ast_channel *to_transferee,
1041                 struct ast_channel *to_transfer_target);
1042
1043 /*!
1044  * \brief Set the relevant transfer variables for a single channel
1045  *
1046  * Sets either the ATTENDEDTRANSFER or BLINDTRANSFER variable for a channel while clearing
1047  * the opposite.
1048  *
1049  * \param chan Channel the variable is being set for
1050  * \param value Value the variable is being set to
1051  * \param is_attended false  set BLINDTRANSFER and unset ATTENDEDTRANSFER
1052  *                    true   set ATTENDEDTRANSFER and unset BLINDTRANSFER
1053  */
1054 void ast_bridge_set_transfer_variables(struct ast_channel *chan, const char *value, int is_attended);
1055
1056 /*!
1057  * \brief Get a container of all channels in the bridge
1058  * \since 12.0.0
1059  *
1060  * \param bridge The bridge which is already locked.
1061  *
1062  * \retval NULL Failed to create container
1063  * \retval non-NULL Container of channels in the bridge
1064  */
1065 struct ao2_container *ast_bridge_peers_nolock(struct ast_bridge *bridge);
1066
1067 /*!
1068  * \brief Get a container of all channels in the bridge
1069  * \since 12.0.0
1070  *
1071  * \param bridge The bridge
1072  *
1073  * \note The returned container is a snapshot of channels in the
1074  * bridge when called.
1075  *
1076  * \retval NULL Failed to create container
1077  * \retval non-NULL Container of channels in the bridge
1078  */
1079 struct ao2_container *ast_bridge_peers(struct ast_bridge *bridge);
1080
1081 /*!
1082  * \brief Get the channel's bridge peer only if the bridge is two-party.
1083  * \since 12.0.0
1084  *
1085  * \param bridge The bridge which is already locked.
1086  * \param chan Channel desiring the bridge peer channel.
1087  *
1088  * \note The returned peer channel is the current peer in the
1089  * bridge when called.
1090  *
1091  * \retval NULL Channel not in a bridge or the bridge is not two-party.
1092  * \retval non-NULL Reffed peer channel at time of calling.
1093  */
1094 struct ast_channel *ast_bridge_peer_nolock(struct ast_bridge *bridge, struct ast_channel *chan);
1095
1096 /*!
1097  * \brief Get the channel's bridge peer only if the bridge is two-party.
1098  * \since 12.0.0
1099  *
1100  * \param bridge The bridge
1101  * \param chan Channel desiring the bridge peer channel.
1102  *
1103  * \note The returned peer channel is the current peer in the
1104  * bridge when called.
1105  *
1106  * \retval NULL Channel not in a bridge or the bridge is not two-party.
1107  * \retval non-NULL Reffed peer channel at time of calling.
1108  */
1109 struct ast_channel *ast_bridge_peer(struct ast_bridge *bridge, struct ast_channel *chan);
1110
1111 /*!
1112  * \brief Remove marked bridge channel feature hooks.
1113  * \since 12.0.0
1114  *
1115  * \param features Bridge features structure
1116  * \param flags Determinator for whether hook is removed.
1117  *
1118  * \return Nothing
1119  */
1120 void ast_bridge_features_remove(struct ast_bridge_features *features, enum ast_bridge_hook_remove_flags flags);
1121
1122 /*!
1123  * \brief Find bridge by id
1124  * \since 12.0.0
1125  *
1126  * \param bridge_id Bridge identifier
1127  *
1128  * \return NULL bridge not found
1129  * \return non-NULL reference to bridge
1130  */
1131 struct ast_bridge *ast_bridge_find_by_id(const char *bridge_id);
1132
1133 #if defined(__cplusplus) || defined(c_plusplus)
1134 }
1135 #endif
1136
1137 #endif  /* _ASTERISK_BRIDGING_H */