d351b0feab0909d58368caad7618ccbec097e3e3
[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 int ast_bridge_destroy(struct ast_bridge *bridge, int cause);
414
415 /*!
416  * \brief Notify bridging that this channel was just masqueraded.
417  * \since 12.0.0
418  *
419  * \param chan Channel just involved in a masquerade
420  *
421  * \return Nothing
422  */
423 void ast_bridge_notify_masquerade(struct ast_channel *chan);
424
425 /*!
426  * \brief Join (blocking) a channel to a bridge
427  *
428  * \param bridge Bridge to join
429  * \param chan Channel to join
430  * \param swap Channel to swap out if swapping
431  * \param features Bridge features structure
432  * \param tech_args Optional Bridging tech optimization parameters for this channel.
433  * \param pass_reference TRUE if the bridge reference is being passed by the caller.
434  *
435  * \note Absolutely _NO_ locks should be held before calling
436  * this function since it blocks.
437  *
438  * \retval 0 if the channel successfully joined the bridge before it exited.
439  * \retval -1 if the channel failed to join the bridge
440  *
441  * Example usage:
442  *
443  * \code
444  * ast_bridge_join(bridge, chan, NULL, NULL, NULL, 0);
445  * \endcode
446  *
447  * This adds a channel pointed to by the chan pointer to the bridge pointed to by
448  * the bridge pointer. This function will not return until the channel has been
449  * removed from the bridge, swapped out for another channel, or has hung up.
450  *
451  * If this channel will be replacing another channel the other channel can be specified
452  * in the swap parameter. The other channel will be thrown out of the bridge in an
453  * atomic fashion.
454  *
455  * If channel specific features are enabled a pointer to the features structure
456  * can be specified in the features parameter.
457  */
458 int ast_bridge_join(struct ast_bridge *bridge,
459         struct ast_channel *chan,
460         struct ast_channel *swap,
461         struct ast_bridge_features *features,
462         struct ast_bridge_tech_optimizations *tech_args,
463         int pass_reference);
464
465 /*!
466  * \brief Impart (non-blocking) a channel onto a bridge
467  *
468  * \param bridge Bridge to impart on
469  * \param chan Channel to impart (The channel reference is stolen if impart successful.)
470  * \param swap Channel to swap out if swapping.  NULL if not swapping.
471  * \param features Bridge features structure.
472  * \param independent TRUE if caller does not want to reclaim the channel using ast_bridge_depart().
473  *
474  * \note The features parameter must be NULL or obtained by
475  * ast_bridge_features_new().  You must not dereference features
476  * after calling even if the call fails.
477  *
478  * \note chan is locked by this function.
479  *
480  * \retval 0 on success
481  * \retval -1 on failure
482  *
483  * Example usage:
484  *
485  * \code
486  * ast_bridge_impart(bridge, chan, NULL, NULL, 0);
487  * \endcode
488  *
489  * \details
490  * This adds a channel pointed to by the chan pointer to the
491  * bridge pointed to by the bridge pointer.  This function will
492  * return immediately and will not wait until the channel is no
493  * longer part of the bridge.
494  *
495  * If this channel will be replacing another channel the other
496  * channel can be specified in the swap parameter.  The other
497  * channel will be thrown out of the bridge in an atomic
498  * fashion.
499  *
500  * If channel specific features are enabled, a pointer to the
501  * features structure can be specified in the features
502  * parameter.
503  *
504  * \note If you impart a channel as not independent you MUST
505  * ast_bridge_depart() the channel if this call succeeds.  The
506  * bridge channel thread is created join-able.  The implication
507  * is that the channel is special and will not behave like a
508  * normal channel.
509  *
510  * \note If you impart a channel as independent you must not
511  * ast_bridge_depart() the channel.  The bridge channel thread
512  * is created non-join-able.  The channel must be treated as if
513  * it were placed into the bridge by ast_bridge_join().
514  * Channels placed into a bridge by ast_bridge_join() are
515  * removed by a third party using ast_bridge_remove().
516  */
517 int ast_bridge_impart(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, int independent);
518
519 /*!
520  * \brief Depart a channel from a bridge
521  *
522  * \param chan Channel to depart
523  *
524  * \note chan is locked by this function.
525  *
526  * \retval 0 on success
527  * \retval -1 on failure
528  *
529  * Example usage:
530  *
531  * \code
532  * ast_bridge_depart(chan);
533  * \endcode
534  *
535  * This removes the channel pointed to by the chan pointer from any bridge
536  * it may be in and gives control to the calling thread.
537  * This does not hang up the channel.
538  *
539  * \note This API call can only be used on channels that were added to the bridge
540  *       using the ast_bridge_impart API call with the independent flag FALSE.
541  */
542 int ast_bridge_depart(struct ast_channel *chan);
543
544 /*!
545  * \brief Remove a channel from a bridge
546  *
547  * \param bridge Bridge that the channel is to be removed from
548  * \param chan Channel to remove
549  *
550  * \retval 0 on success
551  * \retval -1 on failure
552  *
553  * Example usage:
554  *
555  * \code
556  * ast_bridge_remove(bridge, chan);
557  * \endcode
558  *
559  * This removes the channel pointed to by the chan pointer from the bridge
560  * pointed to by the bridge pointer and requests that it be hung up. Control
561  * over the channel will NOT be given to the calling thread.
562  *
563  * \note This API call can be used on channels that were added to the bridge
564  *       using both ast_bridge_join and ast_bridge_impart.
565  */
566 int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan);
567
568 /*!
569  * \brief Kick a channel from a bridge
570  *
571  * \param bridge Bridge that the channel is to be kicked from
572  * \param chan Channel to kick
573  *
574  * \retval 0 on success
575  * \retval -1 on failure
576  *
577  * Example usage:
578  *
579  * \code
580  * ast_bridge_kick(bridge, chan);
581  * \endcode
582  *
583  * \details
584  * This kicks the channel pointed to by the chan pointer from
585  * the bridge pointed to by the bridge pointer and requests that
586  * it be hung up.  Control over the channel will NOT be given to
587  * the calling thread.
588  *
589  * \note The functional difference between ast_bridge_kick() and
590  * ast_bridge_remove() is that the bridge may dissolve as a
591  * result of the channel being kicked.
592  *
593  * \note This API call can be used on channels that were added
594  * to the bridge using both ast_bridge_join and
595  * ast_bridge_impart.
596  */
597 int ast_bridge_kick(struct ast_bridge *bridge, struct ast_channel *chan);
598
599 /*!
600  * \brief Merge two bridges together
601  *
602  * \param dst_bridge Destination bridge of merge.
603  * \param src_bridge Source bridge of merge.
604  * \param merge_best_direction TRUE if don't care about which bridge merges into the other.
605  * \param kick_me Array of channels to kick from the bridges.
606  * \param num_kick Number of channels in the kick_me array.
607  *
608  * \note Absolutely _NO_ bridge or channel locks should be held
609  * before calling this function.
610  *
611  * \retval 0 on success
612  * \retval -1 on failure
613  *
614  * Example usage:
615  *
616  * \code
617  * ast_bridge_merge(dst_bridge, src_bridge, 0, NULL, 0);
618  * \endcode
619  *
620  * This moves the channels in src_bridge into the bridge pointed
621  * to by dst_bridge.
622  */
623 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);
624
625 /*!
626  * \brief Move a channel from one bridge to another.
627  * \since 12.0.0
628  *
629  * \param dst_bridge Destination bridge of bridge channel move.
630  * \param src_bridge Source bridge of bridge channel move.
631  * \param chan Channel to move.
632  * \param swap Channel to replace in dst_bridge.
633  * \param attempt_recovery TRUE if failure attempts to push channel back into original bridge.
634  *
635  * \note Absolutely _NO_ bridge or channel locks should be held
636  * before calling this function.
637  *
638  * \retval 0 on success.
639  * \retval -1 on failure.
640  */
641 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);
642
643 /*!
644  * \brief Adjust the bridge merge inhibit request count.
645  * \since 12.0.0
646  *
647  * \param bridge What to operate on.
648  * \param request Inhibit request increment.
649  *     (Positive to add requests.  Negative to remove requests.)
650  *
651  * \return Nothing
652  */
653 void ast_bridge_merge_inhibit(struct ast_bridge *bridge, int request);
654
655 /*!
656  * \brief Suspend a channel temporarily from a bridge
657  *
658  * \param bridge Bridge to suspend the channel from
659  * \param chan Channel to suspend
660  *
661  * \retval 0 on success
662  * \retval -1 on failure
663  *
664  * Example usage:
665  *
666  * \code
667  * ast_bridge_suspend(bridge, chan);
668  * \endcode
669  *
670  * This suspends the channel pointed to by chan from the bridge pointed to by bridge temporarily.
671  * Control of the channel is given to the calling thread. This differs from ast_bridge_depart as
672  * the channel will not be removed from the bridge.
673  *
674  * \note This API call can be used on channels that were added to the bridge
675  *       using both ast_bridge_join and ast_bridge_impart.
676  */
677 int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan);
678
679 /*!
680  * \brief Unsuspend a channel from a bridge
681  *
682  * \param bridge Bridge to unsuspend the channel from
683  * \param chan Channel to unsuspend
684  *
685  * \retval 0 on success
686  * \retval -1 on failure
687  *
688  * Example usage:
689  *
690  * \code
691  * ast_bridge_unsuspend(bridge, chan);
692  * \endcode
693  *
694  * This unsuspends the channel pointed to by chan from the bridge pointed to by bridge.
695  * The bridge will go back to handling the channel once this function returns.
696  *
697  * \note You must not mess with the channel once this function returns.
698  *       Doing so may result in bad things happening.
699  */
700 int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan);
701
702 struct ast_unreal_pvt;
703
704 /*!
705  * \brief Check and optimize out the unreal channels between bridges.
706  * \since 12.0.0
707  *
708  * \param chan Unreal channel writing a frame into the channel driver.
709  * \param peer Other unreal channel in the pair.
710  * \param pvt Private data provided by an implementation of the unreal driver that
711  * contains the callbacks that should be called when optimization begins/ends
712  *
713  * \note It is assumed that chan is already locked.
714  *
715  * \retval 0 if unreal channels were not optimized out.
716  * \retval non-zero if unreal channels were optimized out.
717  */
718 int ast_bridge_unreal_optimize_out(struct ast_channel *chan, struct ast_channel *peer, struct ast_unreal_pvt *pvt);
719
720 /*!
721  * \brief Tells, if optimization is allowed, how the optimization would be performed
722  */
723 enum ast_bridge_optimization {
724         /*! Optimization would swap peer into the chan_bridge */
725         AST_BRIDGE_OPTIMIZE_SWAP_TO_CHAN_BRIDGE,
726         /*! Optimization would swap chan into the peer_bridge */
727         AST_BRIDGE_OPTIMIZE_SWAP_TO_PEER_BRIDGE,
728         /*! Optimization would merge peer_bridge into chan_bridge */
729         AST_BRIDGE_OPTIMIZE_MERGE_TO_CHAN_BRIDGE,
730         /*! Optimization would merge chan_bridge into peer_bridge */
731         AST_BRIDGE_OPTIMIZE_MERGE_TO_PEER_BRIDGE,
732         /*! Optimization is not permitted on one or both bridges */
733         AST_BRIDGE_OPTIMIZE_PROHIBITED,
734 };
735
736 /*!
737  * \brief Determine if bridges allow for optimization to occur betweem them
738  * \since 12.0.0
739  *
740  * \param chan_bridge First bridge being tested
741  * \param peer_bridge Second bridge being tested
742  *
743  * This determines if two bridges allow for unreal channel optimization
744  * to occur between them. The function does not require for unreal channels
745  * to already be in the bridges when called.
746  *
747  * \note It is assumed that both bridges are locked prior to calling this function
748  *
749  * \note A return other than AST_BRIDGE_OPTIMIZE_PROHIBITED does not guarantee
750  * that an optimization attempt will succeed. However, a return of
751  * AST_BRIDGE_OPTIMIZE_PROHIBITED guarantees that an optimization attempt will
752  * never succeed.
753  *
754  * \returns Optimization allowability for the bridges
755  */
756 enum ast_bridge_optimization ast_bridges_allow_optimization(struct ast_bridge *chan_bridge,
757                 struct ast_bridge *peer_bridge);
758
759 /*!
760  * \brief Put an action onto the specified bridge.
761  * \since 12.0.0
762  *
763  * \param bridge What to queue the action on.
764  * \param action What to do.
765  *
766  * \retval 0 on success.
767  * \retval -1 on error.
768  *
769  * \note This API call is meant for internal bridging operations.
770  */
771 int ast_bridge_queue_action(struct ast_bridge *bridge, struct ast_frame *action);
772
773 /*!
774  * \brief Queue the given frame to everyone else.
775  * \since 12.0.0
776  *
777  * \param bridge What bridge to distribute frame.
778  * \param bridge_channel Channel to optionally not pass frame to. (NULL to pass to everyone)
779  * \param frame Frame to pass.
780  *
781  * \note This is intended to be called by bridge hooks and
782  * bridge technologies.
783  *
784  * \retval 0 Frame written to at least one channel.
785  * \retval -1 Frame written to no channels.
786  */
787 int ast_bridge_queue_everyone_else(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame);
788
789 /*!
790  * \brief Adjust the internal mixing sample rate of a bridge
791  * used during multimix mode.
792  *
793  * \param bridge Channel to change the sample rate on.
794  * \param sample_rate the sample rate to change to. If a
795  *        value of 0 is passed here, the bridge will be free to pick
796  *        what ever sample rate it chooses.
797  *
798  */
799 void ast_bridge_set_internal_sample_rate(struct ast_bridge *bridge, unsigned int sample_rate);
800
801 /*!
802  * \brief Adjust the internal mixing interval of a bridge used
803  * during multimix mode.
804  *
805  * \param bridge Channel to change the sample rate on.
806  * \param mixing_interval the sample rate to change to.  If 0 is set
807  * the bridge tech is free to choose any mixing interval it uses by default.
808  */
809 void ast_bridge_set_mixing_interval(struct ast_bridge *bridge, unsigned int mixing_interval);
810
811 /*!
812  * \brief Set a bridge to feed a single video source to all participants.
813  */
814 void ast_bridge_set_single_src_video_mode(struct ast_bridge *bridge, struct ast_channel *video_src_chan);
815
816 /*!
817  * \brief Set the bridge to pick the strongest talker supporting
818  * video as the single source video feed
819  */
820 void ast_bridge_set_talker_src_video_mode(struct ast_bridge *bridge);
821
822 /*!
823  * \brief Update information about talker energy for talker src video mode.
824  */
825 void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame);
826
827 /*!
828  * \brief Returns the number of video sources currently active in the bridge
829  */
830 int ast_bridge_number_video_src(struct ast_bridge *bridge);
831
832 /*!
833  * \brief Determine if a channel is a video src for the bridge
834  *
835  * \retval 0 Not a current video source of the bridge.
836  * \retval None 0, is a video source of the bridge, The number
837  *         returned represents the priority this video stream has
838  *         on the bridge where 1 is the highest priority.
839  */
840 int ast_bridge_is_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
841
842 /*!
843  * \brief remove a channel as a source of video for the bridge.
844  */
845 void ast_bridge_remove_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
846
847 enum ast_transfer_result {
848         /*! The transfer completed successfully */
849         AST_BRIDGE_TRANSFER_SUCCESS,
850         /*! A bridge involved does not permit transferring */
851         AST_BRIDGE_TRANSFER_NOT_PERMITTED,
852         /*! The current bridge setup makes transferring an invalid operation */
853         AST_BRIDGE_TRANSFER_INVALID,
854         /*! The transfer operation failed for a miscellaneous reason */
855         AST_BRIDGE_TRANSFER_FAIL,
856 };
857
858 enum ast_transfer_type {
859         /*! Transfer of a single party */
860         AST_BRIDGE_TRANSFER_SINGLE_PARTY,
861         /*! Transfer of multiple parties */
862         AST_BRIDGE_TRANSFER_MULTI_PARTY,
863 };
864
865 /*!
866  * \brief Callback function type called during blind transfers
867  *
868  * A caller of ast_bridge_transfer_blind() may wish to set data on
869  * the channel that ends up running dialplan. For instance, it may
870  * be useful to set channel variables on the channel.
871  *
872  * \param chan The involved channel
873  * \param user_data User-provided data needed in the callback
874  * \param transfer_type The type of transfer being completed
875  */
876 typedef void (*transfer_channel_cb)(struct ast_channel *chan, void *user_data,
877                 enum ast_transfer_type transfer_type);
878
879 /*!
880  * \brief Blind transfer target to the extension and context provided
881  *
882  * The channel given is bridged to one or multiple channels. Depending on
883  * the bridge and the number of participants, the entire bridge could be
884  * transferred to the given destination, or a single channel may be redirected.
885  *
886  * Callers may also provide a callback to be called on the channel that will
887  * be running dialplan. The user data passed into ast_bridge_transfer_blind
888  * will be given as the argument to the callback to be interpreted as desired.
889  * This callback is guaranteed to be called in the same thread as
890  * ast_bridge_transfer_blind() and before ast_bridge_transfer_blind() returns.
891  *
892  * \note Absolutely _NO_ channel locks should be held before
893  * calling this function.
894  *
895  * \param is_external Indicates that transfer was initiated externally
896  * \param transferer The channel performing the blind transfer
897  * \param exten The dialplan extension to send the call to
898  * \param context The dialplan context to send the call to
899  * \param new_channel_cb A callback to be called on the channel that will
900  *        be executing dialplan
901  * \param user_data Argument for new_channel_cb
902  * \return The success or failure result of the blind transfer
903  */
904 enum ast_transfer_result ast_bridge_transfer_blind(int is_external,
905                 struct ast_channel *transferer, const char *exten, const char *context,
906                 transfer_channel_cb new_channel_cb, void *user_data);
907
908 /*!
909  * \brief Attended transfer
910  *
911  * The two channels are both transferer channels. The first is the channel
912  * that is bridged to the transferee (or if unbridged, the 'first' call of
913  * the transfer). The second is the channel that is bridged to the transfer
914  * target (or if unbridged, the 'second' call of the transfer).
915  *
916  * \note Absolutely _NO_ channel locks should be held before
917  * calling this function.
918  *
919  * \param to_transferee Transferer channel on initial call (presumably bridged to transferee)
920  * \param to_transfer_target Transferer channel on consultation call (presumably bridged to transfer target)
921  * \return The success or failure of the attended transfer
922  */
923 enum ast_transfer_result ast_bridge_transfer_attended(struct ast_channel *to_transferee,
924                 struct ast_channel *to_transfer_target);
925
926 /*!
927  * \brief Get a container of all channels in the bridge
928  * \since 12.0.0
929  *
930  * \param bridge The bridge which is already locked.
931  *
932  * \retval NULL Failed to create container
933  * \retval non-NULL Container of channels in the bridge
934  */
935 struct ao2_container *ast_bridge_peers_nolock(struct ast_bridge *bridge);
936
937 /*!
938  * \brief Get a container of all channels in the bridge
939  * \since 12.0.0
940  *
941  * \param bridge The bridge
942  *
943  * \note The returned container is a snapshot of channels in the
944  * bridge when called.
945  *
946  * \retval NULL Failed to create container
947  * \retval non-NULL Container of channels in the bridge
948  */
949 struct ao2_container *ast_bridge_peers(struct ast_bridge *bridge);
950
951 /*!
952  * \brief Get the channel's bridge peer only if the bridge is two-party.
953  * \since 12.0.0
954  *
955  * \param bridge The bridge which is already locked.
956  * \param chan Channel desiring the bridge peer channel.
957  *
958  * \note The returned peer channel is the current peer in the
959  * bridge when called.
960  *
961  * \retval NULL Channel not in a bridge or the bridge is not two-party.
962  * \retval non-NULL Reffed peer channel at time of calling.
963  */
964 struct ast_channel *ast_bridge_peer_nolock(struct ast_bridge *bridge, struct ast_channel *chan);
965
966 /*!
967  * \brief Get the channel's bridge peer only if the bridge is two-party.
968  * \since 12.0.0
969  *
970  * \param bridge The bridge
971  * \param chan Channel desiring the bridge peer channel.
972  *
973  * \note The returned peer channel is the current peer in the
974  * bridge when called.
975  *
976  * \retval NULL Channel not in a bridge or the bridge is not two-party.
977  * \retval non-NULL Reffed peer channel at time of calling.
978  */
979 struct ast_channel *ast_bridge_peer(struct ast_bridge *bridge, struct ast_channel *chan);
980
981 /*!
982  * \brief Remove marked bridge channel feature hooks.
983  * \since 12.0.0
984  *
985  * \param features Bridge features structure
986  * \param flags Determinator for whether hook is removed.
987  *
988  * \return Nothing
989  */
990 void ast_bridge_features_remove(struct ast_bridge_features *features, enum ast_bridge_hook_remove_flags flags);
991
992 #if defined(__cplusplus) || defined(c_plusplus)
993 }
994 #endif
995
996 #endif  /* _ASTERISK_BRIDGING_H */