fdb3803ad24efe5d4f92cb0ea0b7b8bf6d16ba2f
[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 };
106
107 /*! \brief This is used for both SINGLE_SRC mode to set what channel
108  *  should be the current single video feed */
109 struct ast_bridge_video_single_src_data {
110         /*! Only accept video coming from this channel */
111         struct ast_channel *chan_vsrc;
112 };
113
114 /*! \brief This is used for both SINGLE_SRC_TALKER mode to set what channel
115  *  should be the current single video feed */
116 struct ast_bridge_video_talker_src_data {
117         /*! Only accept video coming from this channel */
118         struct ast_channel *chan_vsrc;
119         int average_talking_energy;
120
121         /*! Current talker see's this person */
122         struct ast_channel *chan_old_vsrc;
123 };
124
125 /*! \brief Data structure that defines a video source mode */
126 struct ast_bridge_video_mode {
127         enum ast_bridge_video_mode_type mode;
128         /* Add data for all the video modes here. */
129         union {
130                 struct ast_bridge_video_single_src_data single_src_data;
131                 struct ast_bridge_video_talker_src_data talker_src_data;
132         } mode_data;
133 };
134
135 /*!
136  * \brief Destroy the bridge.
137  *
138  * \param self Bridge to operate upon.
139  *
140  * \return Nothing
141  */
142 typedef void (*ast_bridge_destructor_fn)(struct ast_bridge *self);
143
144 /*!
145  * \brief The bridge is being dissolved.
146  *
147  * \param self Bridge to operate upon.
148  *
149  * \details
150  * The bridge is being dissolved.  Remove any external
151  * references to the bridge so it can be destroyed.
152  *
153  * \note On entry, self must NOT be locked.
154  *
155  * \return Nothing
156  */
157 typedef void (*ast_bridge_dissolving_fn)(struct ast_bridge *self);
158
159 /*!
160  * \brief Push this channel into the bridge.
161  *
162  * \param self Bridge to operate upon.
163  * \param bridge_channel Bridge channel to push.
164  * \param swap Bridge channel to swap places with if not NULL.
165  *
166  * \details
167  * Setup any channel hooks controlled by the bridge.  Allocate
168  * bridge_channel->bridge_pvt and initialize any resources put
169  * in bridge_channel->bridge_pvt if needed.  If there is a swap
170  * channel, use it as a guide to setting up the bridge_channel.
171  *
172  * \note On entry, self is already locked.
173  *
174  * \retval 0 on success.
175  * \retval -1 on failure.  The channel did not get pushed.
176  */
177 typedef int (*ast_bridge_push_channel_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap);
178
179 /*!
180  * \brief Pull this channel from the bridge.
181  *
182  * \param self Bridge to operate upon.
183  * \param bridge_channel Bridge channel to pull.
184  *
185  * \details
186  * Remove any channel hooks controlled by the bridge.  Release
187  * any resources held by bridge_channel->bridge_pvt and release
188  * bridge_channel->bridge_pvt.
189  *
190  * \note On entry, self is already locked.
191  *
192  * \return Nothing
193  */
194 typedef void (*ast_bridge_pull_channel_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel);
195
196 /*!
197  * \brief Notify the bridge that this channel was just masqueraded.
198  *
199  * \param self Bridge to operate upon.
200  * \param bridge_channel Bridge channel that was masqueraded.
201  *
202  * \details
203  * A masquerade just happened to this channel.  The bridge needs
204  * to re-evaluate this a channel in the bridge.
205  *
206  * \note On entry, self is already locked.
207  *
208  * \return Nothing
209  */
210 typedef void (*ast_bridge_notify_masquerade_fn)(struct ast_bridge *self, struct ast_bridge_channel *bridge_channel);
211
212 /*!
213  * \brief Get the merge priority of this bridge.
214  *
215  * \param self Bridge to operate upon.
216  *
217  * \note On entry, self is already locked.
218  *
219  * \return Merge priority
220  */
221 typedef int (*ast_bridge_merge_priority_fn)(struct ast_bridge *self);
222
223 /*!
224  * \brief Bridge virtual methods table definition.
225  *
226  * \note Any changes to this struct must be reflected in
227  * bridge_alloc() validity checking.
228  */
229 struct ast_bridge_methods {
230         /*! Bridge class name for log messages. */
231         const char *name;
232         /*! Destroy the bridge. */
233         ast_bridge_destructor_fn destroy;
234         /*! The bridge is being dissolved.  Remove any references to the bridge. */
235         ast_bridge_dissolving_fn dissolving;
236         /*! Push the bridge channel into the bridge. */
237         ast_bridge_push_channel_fn push;
238         /*! Pull the bridge channel from the bridge. */
239         ast_bridge_pull_channel_fn pull;
240         /*! Notify the bridge of a masquerade with the channel. */
241         ast_bridge_notify_masquerade_fn notify_masquerade;
242         /*! Get the bridge merge priority. */
243         ast_bridge_merge_priority_fn get_merge_priority;
244 };
245
246 struct ast_bridge_channel;
247
248 /*! Softmix technology parameters. */
249 struct ast_bridge_softmix {
250         /*! The video mode softmix is using */
251         struct ast_bridge_video_mode video_mode;
252         /*!
253          * \brief The internal sample rate softmix uses to mix channels.
254          *
255          * \note If this value is 0, the sofmix may auto adjust the mixing rate.
256          */
257         unsigned int internal_sample_rate;
258         /*!
259          * \brief The mixing interval indicates how quickly softmix
260          * mixing should occur to mix audio.
261          *
262          * \note When set to 0, softmix must choose a default interval
263          * for itself.
264          */
265         unsigned int internal_mixing_interval;
266 };
267
268 /*!
269  * \brief Structure that contains information about a bridge
270  */
271 struct ast_bridge {
272         /*! Bridge virtual method table. */
273         const struct ast_bridge_methods *v_table;
274         /*! "Personality" currently exhibited by bridge subclass */
275         void *personality;
276         /*! Bridge technology that is handling the bridge */
277         struct ast_bridge_technology *technology;
278         /*! Private information unique to the bridge technology */
279         void *tech_pvt;
280         /*! Per-bridge topics */
281         struct stasis_cp_single *topics;
282         /*! Call ID associated with the bridge */
283         struct ast_callid *callid;
284         /*! Linked list of channels participating in the bridge */
285         AST_LIST_HEAD_NOLOCK(, ast_bridge_channel) channels;
286         /*! Queue of actions to perform on the bridge. */
287         AST_LIST_HEAD_NOLOCK(, ast_frame) action_queue;
288         /*! Softmix technology parameters. */
289         struct ast_bridge_softmix softmix;
290         /*! Bridge flags to tweak behavior */
291         struct ast_flags feature_flags;
292         /*! Allowed bridge technology capabilities when AST_BRIDGE_FLAG_SMART enabled. */
293         uint32_t allowed_capabilities;
294         /*! Number of channels participating in the bridge */
295         unsigned int num_channels;
296         /*! Number of active channels in the bridge. */
297         unsigned int num_active;
298         /*! Number of channels with AST_BRIDGE_CHANNEL_FLAG_LONELY in the bridge. */
299         unsigned int num_lonely;
300         /*!
301          * \brief Count of the active temporary requests to inhibit bridge merges.
302          * Zero if merges are allowed.
303          *
304          * \note Temporary as in try again in a moment.
305          */
306         unsigned int inhibit_merge;
307         /*! Cause code of the dissolved bridge. */
308         int cause;
309         /*! TRUE if the bridge was reconfigured. */
310         unsigned int reconfigured:1;
311         /*! TRUE if the bridge has been dissolved.  Any channel that now tries to join is immediately ejected. */
312         unsigned int dissolved:1;
313         /*! TRUE if the bridge construction was completed. */
314         unsigned int construction_completed:1;
315         /*! Immutable bridge UUID. */
316         char uniqueid[AST_UUID_STR_LEN];
317 };
318
319 /*! \brief Bridge base class virtual method table. */
320 extern struct ast_bridge_methods ast_bridge_base_v_table;
321
322 /*!
323  * \brief Create a new base class bridge
324  *
325  * \param capabilities The capabilities that we require to be used on the bridge
326  * \param flags Flags that will alter the behavior of the bridge
327  *
328  * \retval a pointer to a new bridge on success
329  * \retval NULL on failure
330  *
331  * Example usage:
332  *
333  * \code
334  * struct ast_bridge *bridge;
335  * bridge = ast_bridge_base_new(AST_BRIDGE_CAPABILITY_1TO1MIX, AST_BRIDGE_FLAG_DISSOLVE_HANGUP);
336  * \endcode
337  *
338  * This creates a no frills two party bridge that will be
339  * destroyed once one of the channels hangs up.
340  */
341 struct ast_bridge *ast_bridge_base_new(uint32_t capabilities, unsigned int flags);
342
343 /*!
344  * \brief Try locking the bridge.
345  *
346  * \param bridge Bridge to try locking
347  *
348  * \retval 0 on success.
349  * \retval non-zero on error.
350  */
351 #define ast_bridge_trylock(bridge)      _ast_bridge_trylock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
352 static inline int _ast_bridge_trylock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
353 {
354         return __ao2_trylock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
355 }
356
357 /*!
358  * \brief Lock the bridge.
359  *
360  * \param bridge Bridge to lock
361  *
362  * \return Nothing
363  */
364 #define ast_bridge_lock(bridge) _ast_bridge_lock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
365 static inline void _ast_bridge_lock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
366 {
367         __ao2_lock(bridge, AO2_LOCK_REQ_MUTEX, file, function, line, var);
368 }
369
370 /*!
371  * \brief Unlock the bridge.
372  *
373  * \param bridge Bridge to unlock
374  *
375  * \return Nothing
376  */
377 #define ast_bridge_unlock(bridge)       _ast_bridge_unlock(bridge, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge)
378 static inline void _ast_bridge_unlock(struct ast_bridge *bridge, const char *file, const char *function, int line, const char *var)
379 {
380         __ao2_unlock(bridge, file, function, line, var);
381 }
382
383 /*! \brief Lock two bridges. */
384 #define ast_bridge_lock_both(bridge1, bridge2)          \
385         do {                                                                                    \
386                 for (;;) {                                                                      \
387                         ast_bridge_lock(bridge1);                               \
388                         if (!ast_bridge_trylock(bridge2)) {             \
389                                 break;                                                          \
390                         }                                                                               \
391                         ast_bridge_unlock(bridge1);                             \
392                         sched_yield();                                                  \
393                 }                                                                                       \
394         } while (0)
395
396 /*!
397  * \brief Destroy a bridge
398  *
399  * \param bridge Bridge to destroy
400  * \param cause Cause of bridge being destroyed.  (If cause <= 0 then use AST_CAUSE_NORMAL_CLEARING)
401  *
402  * \retval 0 on success
403  * \retval -1 on failure
404  *
405  * Example usage:
406  *
407  * \code
408  * ast_bridge_destroy(bridge, AST_CAUSE_NORMAL_CLEARING);
409  * \endcode
410  *
411  * This destroys a bridge that was previously created.
412  *
413  * \note
414  * While this function will kick all channels out of the bridge, channels that
415  * were added to the bridge using ast_bridge_impart() with the flag
416  * AST_BRIDGE_IMPART_CHAN_DEPARTABLE set must have ast_bridge_depart() called
417  * on them.
418  */
419 int ast_bridge_destroy(struct ast_bridge *bridge, int cause);
420
421 /*!
422  * \brief Notify bridging that this channel was just masqueraded.
423  * \since 12.0.0
424  *
425  * \param chan Channel just involved in a masquerade
426  *
427  * \return Nothing
428  */
429 void ast_bridge_notify_masquerade(struct ast_channel *chan);
430
431 enum ast_bridge_join_flags {
432         /*! The bridge reference is being passed by the caller. */
433         AST_BRIDGE_JOIN_PASS_REFERENCE = (1 << 0),
434         /*! The initial bridge join does not cause a COLP exchange. */
435         AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP = (1 << 1),
436 };
437
438 /*!
439  * \brief Join (blocking) a channel to a bridge
440  *
441  * \param bridge Bridge to join
442  * \param chan Channel to join
443  * \param swap Channel to swap out if swapping
444  * \param features Bridge features structure
445  * \param tech_args Optional Bridging tech optimization parameters for this channel.
446  * \param flags defined by enum ast_bridge_join_flags.
447  *
448  * \note Absolutely _NO_ locks should be held before calling
449  * this function since it blocks.
450  *
451  * \retval 0 if the channel successfully joined the bridge before it exited.
452  * \retval -1 if the channel failed to join the bridge
453  *
454  * Example usage:
455  *
456  * \code
457  * ast_bridge_join(bridge, chan, NULL, NULL, NULL, AST_BRIDGE_JOIN_PASS_REFERENCE);
458  * \endcode
459  *
460  * This adds a channel pointed to by the chan pointer to the bridge pointed to by
461  * the bridge pointer. This function will not return until the channel has been
462  * removed from the bridge, swapped out for another channel, or has hung up.
463  *
464  * If this channel will be replacing another channel the other channel can be specified
465  * in the swap parameter. The other channel will be thrown out of the bridge in an
466  * atomic fashion.
467  *
468  * If channel specific features are enabled a pointer to the features structure
469  * can be specified in the features parameter.
470  */
471 int ast_bridge_join(struct ast_bridge *bridge,
472         struct ast_channel *chan,
473         struct ast_channel *swap,
474         struct ast_bridge_features *features,
475         struct ast_bridge_tech_optimizations *tech_args,
476         enum ast_bridge_join_flags flags);
477
478 enum ast_bridge_impart_flags {
479         /*! Field describing what the caller can do with the channel after it is imparted. */
480         AST_BRIDGE_IMPART_CHAN_MASK = (1 << 0),
481         /*! The caller wants to reclaim the channel using ast_bridge_depart(). */
482         AST_BRIDGE_IMPART_CHAN_DEPARTABLE = (0 << 0),
483         /*! The caller is passing channel control entirely to the bridging system. */
484         AST_BRIDGE_IMPART_CHAN_INDEPENDENT = (1 << 0),
485         /*! The initial bridge join does not cause a COLP exchange. */
486         AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP = (1 << 1),
487 };
488
489 /*!
490  * \brief Impart (non-blocking) a channel onto a bridge
491  *
492  * \param bridge Bridge to impart on
493  * \param chan Channel to impart (The channel reference is stolen if impart successful.)
494  * \param swap Channel to swap out if swapping.  NULL if not swapping.
495  * \param features Bridge features structure.
496  * \param flags defined by enum ast_bridge_impart_flags.
497  *
498  * \note The features parameter must be NULL or obtained by
499  * ast_bridge_features_new().  You must not dereference features
500  * after calling even if the call fails.
501  *
502  * \note chan is locked by this function.
503  *
504  * \retval 0 on success
505  * \retval -1 on failure (Caller still has ownership of chan)
506  *
507  * Example usage:
508  *
509  * \code
510  * ast_bridge_impart(bridge, chan, NULL, NULL, AST_BRIDGE_IMPART_CHAN_INDEPENDENT);
511  * \endcode
512  *
513  * \details
514  * This adds a channel pointed to by the chan pointer to the
515  * bridge pointed to by the bridge pointer.  This function will
516  * return immediately and will not wait until the channel is no
517  * longer part of the bridge.
518  *
519  * If this channel will be replacing another channel the other
520  * channel can be specified in the swap parameter.  The other
521  * channel will be thrown out of the bridge in an atomic
522  * fashion.
523  *
524  * If channel specific features are enabled, a pointer to the
525  * features structure can be specified in the features
526  * parameter.
527  *
528  * \note If you impart a channel with
529  * AST_BRIDGE_IMPART_CHAN_DEPARTABLE you MUST
530  * ast_bridge_depart() the channel if this call succeeds.  The
531  * bridge channel thread is created join-able.  The implication
532  * is that the channel is special and will not behave like a
533  * normal channel.
534  *
535  * \note If you impart a channel with
536  * AST_BRIDGE_IMPART_CHAN_INDEPENDENT you must not
537  * ast_bridge_depart() the channel.  The bridge channel thread
538  * is created non-join-able.  The channel must be treated as if
539  * it were placed into the bridge by ast_bridge_join().
540  * Channels placed into a bridge by ast_bridge_join() are
541  * removed by a third party using ast_bridge_remove().
542  */
543 int ast_bridge_impart(struct ast_bridge *bridge,
544         struct ast_channel *chan,
545         struct ast_channel *swap,
546         struct ast_bridge_features *features,
547         enum ast_bridge_impart_flags flags) attribute_warn_unused_result;
548
549 /*!
550  * \brief Depart a channel from a bridge
551  *
552  * \param chan Channel to depart
553  *
554  * \note chan is locked by this function.
555  *
556  * \retval 0 on success
557  * \retval -1 on failure
558  *
559  * Example usage:
560  *
561  * \code
562  * ast_bridge_depart(chan);
563  * \endcode
564  *
565  * This removes the channel pointed to by the chan pointer from any bridge
566  * it may be in and gives control to the calling thread.
567  * This does not hang up the channel.
568  *
569  * \note This API call can only be used on channels that were added to the bridge
570  *       using the ast_bridge_impart API call with the AST_BRIDGE_IMPART_CHAN_DEPARTABLE
571  *       flag.
572  */
573 int ast_bridge_depart(struct ast_channel *chan);
574
575 /*!
576  * \brief Remove a channel from a bridge
577  *
578  * \param bridge Bridge that the channel is to be removed from
579  * \param chan Channel to remove
580  *
581  * \retval 0 on success
582  * \retval -1 on failure
583  *
584  * Example usage:
585  *
586  * \code
587  * ast_bridge_remove(bridge, chan);
588  * \endcode
589  *
590  * This removes the channel pointed to by the chan pointer from the bridge
591  * pointed to by the bridge pointer and requests that it be hung up. Control
592  * over the channel will NOT be given to the calling thread.
593  *
594  * \note This API call can be used on channels that were added to the bridge
595  *       using both ast_bridge_join and ast_bridge_impart.
596  */
597 int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan);
598
599 /*!
600  * \brief Kick a channel from a bridge
601  *
602  * \param bridge Bridge that the channel is to be kicked from
603  * \param chan Channel to kick
604  *
605  * \retval 0 on success
606  * \retval -1 on failure
607  *
608  * Example usage:
609  *
610  * \code
611  * ast_bridge_kick(bridge, chan);
612  * \endcode
613  *
614  * \details
615  * This kicks the channel pointed to by the chan pointer from
616  * the bridge pointed to by the bridge pointer and requests that
617  * it be hung up.  Control over the channel will NOT be given to
618  * the calling thread.
619  *
620  * \note The functional difference between ast_bridge_kick() and
621  * ast_bridge_remove() is that the bridge may dissolve as a
622  * result of the channel being kicked.
623  *
624  * \note This API call can be used on channels that were added
625  * to the bridge using both ast_bridge_join and
626  * ast_bridge_impart.
627  */
628 int ast_bridge_kick(struct ast_bridge *bridge, struct ast_channel *chan);
629
630 /*!
631  * \brief Merge two bridges together
632  *
633  * \param dst_bridge Destination bridge of merge.
634  * \param src_bridge Source bridge of merge.
635  * \param merge_best_direction TRUE if don't care about which bridge merges into the other.
636  * \param kick_me Array of channels to kick from the bridges.
637  * \param num_kick Number of channels in the kick_me array.
638  *
639  * \note Absolutely _NO_ bridge or channel locks should be held
640  * before calling this function.
641  *
642  * \retval 0 on success
643  * \retval -1 on failure
644  *
645  * Example usage:
646  *
647  * \code
648  * ast_bridge_merge(dst_bridge, src_bridge, 0, NULL, 0);
649  * \endcode
650  *
651  * This moves the channels in src_bridge into the bridge pointed
652  * to by dst_bridge.
653  */
654 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);
655
656 /*!
657  * \brief Move a channel from one bridge to another.
658  * \since 12.0.0
659  *
660  * \param dst_bridge Destination bridge of bridge channel move.
661  * \param src_bridge Source bridge of bridge channel move.
662  * \param chan Channel to move.
663  * \param swap Channel to replace in dst_bridge.
664  * \param attempt_recovery TRUE if failure attempts to push channel back into original bridge.
665  *
666  * \note Absolutely _NO_ bridge or channel locks should be held
667  * before calling this function.
668  *
669  * \retval 0 on success.
670  * \retval -1 on failure.
671  */
672 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);
673
674 /*!
675  * \brief Adjust the bridge merge inhibit request count.
676  * \since 12.0.0
677  *
678  * \param bridge What to operate on.
679  * \param request Inhibit request increment.
680  *     (Positive to add requests.  Negative to remove requests.)
681  *
682  * \return Nothing
683  */
684 void ast_bridge_merge_inhibit(struct ast_bridge *bridge, int request);
685
686 /*!
687  * \brief Suspend a channel temporarily from a bridge
688  *
689  * \param bridge Bridge to suspend the channel from
690  * \param chan Channel to suspend
691  *
692  * \retval 0 on success
693  * \retval -1 on failure
694  *
695  * Example usage:
696  *
697  * \code
698  * ast_bridge_suspend(bridge, chan);
699  * \endcode
700  *
701  * This suspends the channel pointed to by chan from the bridge pointed to by bridge temporarily.
702  * Control of the channel is given to the calling thread. This differs from ast_bridge_depart as
703  * the channel will not be removed from the bridge.
704  *
705  * \note This API call can be used on channels that were added to the bridge
706  *       using both ast_bridge_join and ast_bridge_impart.
707  */
708 int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan);
709
710 /*!
711  * \brief Unsuspend a channel from a bridge
712  *
713  * \param bridge Bridge to unsuspend the channel from
714  * \param chan Channel to unsuspend
715  *
716  * \retval 0 on success
717  * \retval -1 on failure
718  *
719  * Example usage:
720  *
721  * \code
722  * ast_bridge_unsuspend(bridge, chan);
723  * \endcode
724  *
725  * This unsuspends the channel pointed to by chan from the bridge pointed to by bridge.
726  * The bridge will go back to handling the channel once this function returns.
727  *
728  * \note You must not mess with the channel once this function returns.
729  *       Doing so may result in bad things happening.
730  */
731 int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan);
732
733 struct ast_unreal_pvt;
734
735 /*!
736  * \brief Check and optimize out the unreal channels between bridges.
737  * \since 12.0.0
738  *
739  * \param chan Unreal channel writing a frame into the channel driver.
740  * \param peer Other unreal channel in the pair.
741  * \param pvt Private data provided by an implementation of the unreal driver that
742  * contains the callbacks that should be called when optimization begins/ends
743  *
744  * \note It is assumed that chan is already locked.
745  *
746  * \retval 0 if unreal channels were not optimized out.
747  * \retval non-zero if unreal channels were optimized out.
748  */
749 int ast_bridge_unreal_optimize_out(struct ast_channel *chan, struct ast_channel *peer, struct ast_unreal_pvt *pvt);
750
751 /*!
752  * \brief Tells, if optimization is allowed, how the optimization would be performed
753  */
754 enum ast_bridge_optimization {
755         /*! Optimization would swap peer into the chan_bridge */
756         AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE,
757         /*! Optimization would swap chan into the peer_bridge */
758         AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE,
759         /*! Optimization would merge peer_bridge into chan_bridge */
760         AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE,
761         /*! Optimization would merge chan_bridge into peer_bridge */
762         AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE,
763         /*! Optimization is not permitted on one or both bridges */
764         AST_BRIDGE_OPTIMIZE_PROHIBITED,
765 };
766
767 /*!
768  * \brief Determine if bridges allow for optimization to occur betweem them
769  * \since 12.0.0
770  *
771  * \param chan_bridge First bridge being tested
772  * \param peer_bridge Second bridge being tested
773  *
774  * This determines if two bridges allow for unreal channel optimization
775  * to occur between them. The function does not require for unreal channels
776  * to already be in the bridges when called.
777  *
778  * \note It is assumed that both bridges are locked prior to calling this function
779  *
780  * \note A return other than AST_BRIDGE_OPTIMIZE_PROHIBITED does not guarantee
781  * that an optimization attempt will succeed. However, a return of
782  * AST_BRIDGE_OPTIMIZE_PROHIBITED guarantees that an optimization attempt will
783  * never succeed.
784  *
785  * \returns Optimization allowability for the bridges
786  */
787 enum ast_bridge_optimization ast_bridges_allow_optimization(struct ast_bridge *chan_bridge,
788                 struct ast_bridge *peer_bridge);
789
790 /*!
791  * \brief Put an action onto the specified bridge.
792  * \since 12.0.0
793  *
794  * \param bridge What to queue the action on.
795  * \param action What to do.
796  *
797  * \retval 0 on success.
798  * \retval -1 on error.
799  *
800  * \note This API call is meant for internal bridging operations.
801  */
802 int ast_bridge_queue_action(struct ast_bridge *bridge, struct ast_frame *action);
803
804 /*!
805  * \brief Queue the given frame to everyone else.
806  * \since 12.0.0
807  *
808  * \param bridge What bridge to distribute frame.
809  * \param bridge_channel Channel to optionally not pass frame to. (NULL to pass to everyone)
810  * \param frame Frame to pass.
811  *
812  * \note This is intended to be called by bridge hooks and
813  * bridge technologies.
814  *
815  * \retval 0 Frame written to at least one channel.
816  * \retval -1 Frame written to no channels.
817  */
818 int ast_bridge_queue_everyone_else(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame);
819
820 /*!
821  * \brief Adjust the internal mixing sample rate of a bridge
822  * used during multimix mode.
823  *
824  * \param bridge Channel to change the sample rate on.
825  * \param sample_rate the sample rate to change to. If a
826  *        value of 0 is passed here, the bridge will be free to pick
827  *        what ever sample rate it chooses.
828  *
829  */
830 void ast_bridge_set_internal_sample_rate(struct ast_bridge *bridge, unsigned int sample_rate);
831
832 /*!
833  * \brief Adjust the internal mixing interval of a bridge used
834  * during multimix mode.
835  *
836  * \param bridge Channel to change the sample rate on.
837  * \param mixing_interval the sample rate to change to.  If 0 is set
838  * the bridge tech is free to choose any mixing interval it uses by default.
839  */
840 void ast_bridge_set_mixing_interval(struct ast_bridge *bridge, unsigned int mixing_interval);
841
842 /*!
843  * \brief Set a bridge to feed a single video source to all participants.
844  */
845 void ast_bridge_set_single_src_video_mode(struct ast_bridge *bridge, struct ast_channel *video_src_chan);
846
847 /*!
848  * \brief Set the bridge to pick the strongest talker supporting
849  * video as the single source video feed
850  */
851 void ast_bridge_set_talker_src_video_mode(struct ast_bridge *bridge);
852
853 /*!
854  * \brief Update information about talker energy for talker src video mode.
855  */
856 void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame);
857
858 /*!
859  * \brief Returns the number of video sources currently active in the bridge
860  */
861 int ast_bridge_number_video_src(struct ast_bridge *bridge);
862
863 /*!
864  * \brief Determine if a channel is a video src for the bridge
865  *
866  * \retval 0 Not a current video source of the bridge.
867  * \retval None 0, is a video source of the bridge, The number
868  *         returned represents the priority this video stream has
869  *         on the bridge where 1 is the highest priority.
870  */
871 int ast_bridge_is_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
872
873 /*!
874  * \brief remove a channel as a source of video for the bridge.
875  */
876 void ast_bridge_remove_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
877
878 enum ast_transfer_result {
879         /*! The transfer completed successfully */
880         AST_BRIDGE_TRANSFER_SUCCESS,
881         /*! A bridge involved does not permit transferring */
882         AST_BRIDGE_TRANSFER_NOT_PERMITTED,
883         /*! The current bridge setup makes transferring an invalid operation */
884         AST_BRIDGE_TRANSFER_INVALID,
885         /*! The transfer operation failed for a miscellaneous reason */
886         AST_BRIDGE_TRANSFER_FAIL,
887 };
888
889 enum ast_transfer_type {
890         /*! Transfer of a single party */
891         AST_BRIDGE_TRANSFER_SINGLE_PARTY,
892         /*! Transfer of multiple parties */
893         AST_BRIDGE_TRANSFER_MULTI_PARTY,
894 };
895
896 /*!
897  * \brief Callback function type called during blind transfers
898  *
899  * A caller of ast_bridge_transfer_blind() may wish to set data on
900  * the channel that ends up running dialplan. For instance, it may
901  * be useful to set channel variables on the channel.
902  *
903  * \param chan The involved channel
904  * \param user_data User-provided data needed in the callback
905  * \param transfer_type The type of transfer being completed
906  */
907 typedef void (*transfer_channel_cb)(struct ast_channel *chan, void *user_data,
908                 enum ast_transfer_type transfer_type);
909
910 /*!
911  * \brief Blind transfer target to the extension and context provided
912  *
913  * The channel given is bridged to one or multiple channels. Depending on
914  * the bridge and the number of participants, the entire bridge could be
915  * transferred to the given destination, or a single channel may be redirected.
916  *
917  * Callers may also provide a callback to be called on the channel that will
918  * be running dialplan. The user data passed into ast_bridge_transfer_blind
919  * will be given as the argument to the callback to be interpreted as desired.
920  * This callback is guaranteed to be called in the same thread as
921  * ast_bridge_transfer_blind() and before ast_bridge_transfer_blind() returns.
922  *
923  * \note Absolutely _NO_ channel locks should be held before
924  * calling this function.
925  *
926  * \param is_external Indicates that transfer was initiated externally
927  * \param transferer The channel performing the blind transfer
928  * \param exten The dialplan extension to send the call to
929  * \param context The dialplan context to send the call to
930  * \param new_channel_cb A callback to be called on the channel that will
931  *        be executing dialplan
932  * \param user_data Argument for new_channel_cb
933  * \return The success or failure result of the blind transfer
934  */
935 enum ast_transfer_result ast_bridge_transfer_blind(int is_external,
936                 struct ast_channel *transferer, const char *exten, const char *context,
937                 transfer_channel_cb new_channel_cb, void *user_data);
938
939 /*!
940  * \brief Attended transfer
941  *
942  * The two channels are both transferer channels. The first is the channel
943  * that is bridged to the transferee (or if unbridged, the 'first' call of
944  * the transfer). The second is the channel that is bridged to the transfer
945  * target (or if unbridged, the 'second' call of the transfer).
946  *
947  * \note Absolutely _NO_ channel locks should be held before
948  * calling this function.
949  *
950  * \param to_transferee Transferer channel on initial call (presumably bridged to transferee)
951  * \param to_transfer_target Transferer channel on consultation call (presumably bridged to transfer target)
952  * \return The success or failure of the attended transfer
953  */
954 enum ast_transfer_result ast_bridge_transfer_attended(struct ast_channel *to_transferee,
955                 struct ast_channel *to_transfer_target);
956
957 /*!
958  * \brief Set the relevant transfer variables for a single channel
959  *
960  * Sets either the ATTENDEDTRANSFER or BLINDTRANSFER variable for a channel while clearing
961  * the opposite.
962  *
963  * \param chan Channel the variable is being set for
964  * \param value Value the variable is being set to
965  * \param is_attended false  set BLINDTRANSFER and unset ATTENDEDTRANSFER
966  *                    true   set ATTENDEDTRANSFER and unset BLINDTRANSFER
967  */
968 void ast_bridge_set_transfer_variables(struct ast_channel *chan, const char *value, int is_attended);
969
970 /*!
971  * \brief Get a container of all channels in the bridge
972  * \since 12.0.0
973  *
974  * \param bridge The bridge which is already locked.
975  *
976  * \retval NULL Failed to create container
977  * \retval non-NULL Container of channels in the bridge
978  */
979 struct ao2_container *ast_bridge_peers_nolock(struct ast_bridge *bridge);
980
981 /*!
982  * \brief Get a container of all channels in the bridge
983  * \since 12.0.0
984  *
985  * \param bridge The bridge
986  *
987  * \note The returned container is a snapshot of channels in the
988  * bridge when called.
989  *
990  * \retval NULL Failed to create container
991  * \retval non-NULL Container of channels in the bridge
992  */
993 struct ao2_container *ast_bridge_peers(struct ast_bridge *bridge);
994
995 /*!
996  * \brief Get the channel's bridge peer only if the bridge is two-party.
997  * \since 12.0.0
998  *
999  * \param bridge The bridge which is already locked.
1000  * \param chan Channel desiring the bridge peer channel.
1001  *
1002  * \note The returned peer channel is the current peer in the
1003  * bridge when called.
1004  *
1005  * \retval NULL Channel not in a bridge or the bridge is not two-party.
1006  * \retval non-NULL Reffed peer channel at time of calling.
1007  */
1008 struct ast_channel *ast_bridge_peer_nolock(struct ast_bridge *bridge, struct ast_channel *chan);
1009
1010 /*!
1011  * \brief Get the channel's bridge peer only if the bridge is two-party.
1012  * \since 12.0.0
1013  *
1014  * \param bridge The bridge
1015  * \param chan Channel desiring the bridge peer channel.
1016  *
1017  * \note The returned peer channel is the current peer in the
1018  * bridge when called.
1019  *
1020  * \retval NULL Channel not in a bridge or the bridge is not two-party.
1021  * \retval non-NULL Reffed peer channel at time of calling.
1022  */
1023 struct ast_channel *ast_bridge_peer(struct ast_bridge *bridge, struct ast_channel *chan);
1024
1025 /*!
1026  * \brief Remove marked bridge channel feature hooks.
1027  * \since 12.0.0
1028  *
1029  * \param features Bridge features structure
1030  * \param flags Determinator for whether hook is removed.
1031  *
1032  * \return Nothing
1033  */
1034 void ast_bridge_features_remove(struct ast_bridge_features *features, enum ast_bridge_hook_remove_flags flags);
1035
1036 /*!
1037  * \brief Find bridge by id
1038  * \since 12.0.0
1039  *
1040  * \param bridge_id Bridge identifier
1041  *
1042  * \return NULL bridge not found
1043  * \return non-NULL reference to bridge
1044  */
1045 struct ast_bridge *ast_bridge_find_by_id(const char *bridge_id);
1046
1047 #if defined(__cplusplus) || defined(c_plusplus)
1048 }
1049 #endif
1050
1051 #endif  /* _ASTERISK_BRIDGING_H */