3c117b7cd2d12744b0eb42ad5df6c500accafb44
[asterisk/asterisk.git] / include / asterisk / bridging.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007 - 2009, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Channel Bridging API
21  * \author Joshua Colp <jcolp@digium.com>
22  * \ref AstBridging
23  */
24
25 /*!
26  * \page AstBridging Channel Bridging API
27  *
28  * The purpose of this API is to provide an easy and flexible way to bridge
29  * channels of different technologies with different features.
30  *
31  * Bridging technologies provide the mechanism that do the actual handling
32  * of frames between channels. They provide capability information, codec information,
33  * and preference value to assist the bridging core in choosing a bridging technology when
34  * creating a bridge. Different bridges may use different bridging technologies based on needs
35  * but once chosen they all operate under the same premise; they receive frames and send frames.
36  *
37  * Bridges are a combination of bridging technology, channels, and features. A
38  * developer creates a new bridge based on what they are currently expecting to do
39  * with it or what they will do with it in the future. The bridging core determines what
40  * available bridging technology will best fit the requirements and creates a new bridge.
41  * Once created, channels can be added to the bridge in a blocking or non-blocking fashion.
42  *
43  * Features are such things as channel muting or DTMF based features such as attended transfer,
44  * blind transfer, and hangup. Feature information must be set at the most granular level, on
45  * the channel. While you can use features on a global scope the presence of a feature structure
46  * on the channel will override the global scope. An example would be having the bridge muted
47  * at global scope and attended transfer enabled on a channel. Since the channel itself is not muted
48  * it would be able to speak.
49  *
50  * Feature hooks allow a developer to tell the bridging core that when a DTMF string
51  * is received from a channel a callback should be called in their application. For
52  * example, a conference bridge application may want to provide an IVR to control various
53  * settings on the conference bridge. This can be accomplished by attaching a feature hook
54  * that calls an IVR function when a DTMF string is entered.
55  *
56  */
57
58 #ifndef _ASTERISK_BRIDGING_H
59 #define _ASTERISK_BRIDGING_H
60
61 #if defined(__cplusplus) || defined(c_plusplus)
62 extern "C" {
63 #endif
64
65 #include "asterisk/bridging_features.h"
66 #include "asterisk/dsp.h"
67
68 /*! \brief Capabilities for a bridge technology */
69 enum ast_bridge_capability {
70         /*! Bridge is only capable of mixing 2 channels */
71         AST_BRIDGE_CAPABILITY_1TO1MIX = (1 << 1),
72         /*! Bridge is capable of mixing 2 or more channels */
73         AST_BRIDGE_CAPABILITY_MULTIMIX = (1 << 2),
74         /*! Bridge should natively bridge two channels if possible */
75         AST_BRIDGE_CAPABILITY_NATIVE = (1 << 3),
76         /*! Bridge should run using the multithreaded model */
77         AST_BRIDGE_CAPABILITY_MULTITHREADED = (1 << 4),
78         /*! Bridge should run a central bridge thread */
79         AST_BRIDGE_CAPABILITY_THREAD = (1 << 5),
80         /*! Bridge technology can do video mixing (or something along those lines) */
81         AST_BRIDGE_CAPABILITY_VIDEO = (1 << 6),
82         /*! Bridge technology can optimize things based on who is talking */
83         AST_BRIDGE_CAPABILITY_OPTIMIZE = (1 << 7),
84 };
85
86 /*! \brief State information about a bridged channel */
87 enum ast_bridge_channel_state {
88         /*! Waiting for a signal */
89         AST_BRIDGE_CHANNEL_STATE_WAIT = 0,
90         /*! Bridged channel has ended itself (it has hung up) */
91         AST_BRIDGE_CHANNEL_STATE_END,
92         /*! Bridged channel should be hung up */
93         AST_BRIDGE_CHANNEL_STATE_HANGUP,
94         /*! Bridged channel should be removed from the bridge without being hung up */
95         AST_BRIDGE_CHANNEL_STATE_DEPART,
96         /*! Bridged channel is executing a feature hook */
97         AST_BRIDGE_CHANNEL_STATE_FEATURE,
98         /*! Bridged channel is sending a DTMF stream out */
99         AST_BRIDGE_CHANNEL_STATE_DTMF,
100         /*! Bridged channel began talking */
101         AST_BRIDGE_CHANNEL_STATE_START_TALKING,
102         /*! Bridged channel has stopped talking */
103         AST_BRIDGE_CHANNEL_STATE_STOP_TALKING,
104 };
105
106 /*! \brief Return values for bridge technology write function */
107 enum ast_bridge_write_result {
108         /*! Bridge technology wrote out frame fine */
109         AST_BRIDGE_WRITE_SUCCESS = 0,
110         /*! Bridge technology attempted to write out the frame but failed */
111         AST_BRIDGE_WRITE_FAILED,
112         /*! Bridge technology does not support writing out a frame of this type */
113         AST_BRIDGE_WRITE_UNSUPPORTED,
114 };
115
116 struct ast_bridge_technology;
117 struct ast_bridge;
118
119 /*!
120  * \brief Structure specific to bridge technologies capable of
121  * performing talking optimizations.
122  */
123 struct ast_bridge_tech_optimizations {
124         /*! The amount of time in ms that talking must be detected before
125          *  the dsp determines that talking has occurred */
126         unsigned int talking_threshold;
127         /*! The amount of time in ms that silence must be detected before
128          *  the dsp determines that talking has stopped */
129         unsigned int silence_threshold;
130         /*! Whether or not the bridging technology should drop audio
131          *  detected as silence from the mix. */
132         unsigned int drop_silence:1;
133 };
134
135 /*!
136  * \brief Structure that contains information regarding a channel in a bridge
137  */
138 struct ast_bridge_channel {
139         /*! Lock to protect this data structure */
140         ast_mutex_t lock;
141         /*! Condition, used if we want to wake up a thread waiting on the bridged channel */
142         ast_cond_t cond;
143         /*! Current bridged channel state */
144         enum ast_bridge_channel_state state;
145         /*! Asterisk channel participating in the bridge */
146         struct ast_channel *chan;
147         /*! Asterisk channel we are swapping with (if swapping) */
148         struct ast_channel *swap;
149         /*! Bridge this channel is participating in */
150         struct ast_bridge *bridge;
151         /*! Private information unique to the bridge technology */
152         void *bridge_pvt;
153         /*! Thread handling the bridged channel */
154         pthread_t thread;
155         /*! Additional file descriptors to look at */
156         int fds[4];
157         /*! Bit to indicate whether the channel is suspended from the bridge or not */
158         unsigned int suspended:1;
159         /*! Bit to indicate if a imparted channel is allowed to get hungup after leaving the bridge by the bridging core. */
160         unsigned int allow_impart_hangup:1;
161         /*! Features structure for features that are specific to this channel */
162         struct ast_bridge_features *features;
163         /*! Technology optimization parameters used by bridging technologies capable of
164          *  optimizing based upon talk detection. */
165         struct ast_bridge_tech_optimizations tech_args;
166         /*! Queue of DTMF digits used for DTMF streaming */
167         char dtmf_stream_q[8];
168         /*! Linked list information */
169         AST_LIST_ENTRY(ast_bridge_channel) entry;
170 };
171
172 enum ast_bridge_video_mode_type {
173         /*! Video is not allowed in the bridge */
174         AST_BRIDGE_VIDEO_MODE_NONE = 0,
175         /*! A single user is picked as the only distributed of video across the bridge */
176         AST_BRIDGE_VIDEO_MODE_SINGLE_SRC,
177         /*! A single user's video feed is distributed to all bridge channels, but
178          *  that feed is automatically picked based on who is talking the most. */
179         AST_BRIDGE_VIDEO_MODE_TALKER_SRC,
180 };
181
182 /*! This is used for both SINGLE_SRC mode to set what channel
183  *  should be the current single video feed */
184 struct ast_bridge_video_single_src_data {
185         /*! Only accept video coming from this channel */
186         struct ast_channel *chan_vsrc;
187 };
188
189 /*! This is used for both SINGLE_SRC_TALKER mode to set what channel
190  *  should be the current single video feed */
191 struct ast_bridge_video_talker_src_data {
192         /*! Only accept video coming from this channel */
193         struct ast_channel *chan_vsrc;
194         int average_talking_energy;
195
196         /*! Current talker see's this person */
197         struct ast_channel *chan_old_vsrc;
198 };
199
200 struct ast_bridge_video_mode {
201         enum ast_bridge_video_mode_type mode;
202         /* Add data for all the video modes here. */
203         union {
204                 struct ast_bridge_video_single_src_data single_src_data;
205                 struct ast_bridge_video_talker_src_data talker_src_data;
206         } mode_data;
207 };
208
209 /*!
210  * \brief Structure that contains information about a bridge
211  */
212 struct ast_bridge {
213         /*! Number of channels participating in the bridge */
214         int num;
215         /*! The video mode this bridge is using */
216         struct ast_bridge_video_mode video_mode;
217         /*! The internal sample rate this bridge is mixed at when multiple channels are being mixed.
218          *  If this value is 0, the bridge technology may auto adjust the internal mixing rate. */
219         unsigned int internal_sample_rate;
220         /*! The mixing interval indicates how quickly the bridges internal mixing should occur
221          * for bridge technologies that mix audio. When set to 0, the bridge tech must choose a
222          * default interval for itself. */
223         unsigned int internal_mixing_interval;
224         /*! Bit to indicate that the bridge thread is waiting on channels in the bridge array */
225         unsigned int waiting:1;
226         /*! Bit to indicate the bridge thread should stop */
227         unsigned int stop:1;
228         /*! Bit to indicate the bridge thread should refresh itself */
229         unsigned int refresh:1;
230         /*! Bridge flags to tweak behavior */
231         struct ast_flags feature_flags;
232         /*! Bridge technology that is handling the bridge */
233         struct ast_bridge_technology *technology;
234         /*! Private information unique to the bridge technology */
235         void *bridge_pvt;
236         /*! Thread running the bridge */
237         pthread_t thread;
238         /*! Enabled features information */
239         struct ast_bridge_features features;
240         /*! Array of channels that the bridge thread is currently handling */
241         struct ast_channel **array;
242         /*! Number of channels in the above array */
243         size_t array_num;
244         /*! Number of channels the array can handle */
245         size_t array_size;
246         /*! Linked list of channels participating in the bridge */
247         AST_LIST_HEAD_NOLOCK(, ast_bridge_channel) channels;
248 };
249
250 /*! \brief Create a new bridge
251  *
252  * \param capabilities The capabilities that we require to be used on the bridge
253  * \param flags Flags that will alter the behavior of the bridge
254  *
255  * \retval a pointer to a new bridge on success
256  * \retval NULL on failure
257  *
258  * Example usage:
259  *
260  * \code
261  * struct ast_bridge *bridge;
262  * bridge = ast_bridge_new(AST_BRIDGE_CAPABILITY_1TO1MIX, AST_BRIDGE_FLAG_DISSOLVE);
263  * \endcode
264  *
265  * This creates a simple two party bridge that will be destroyed once one of
266  * the channels hangs up.
267  */
268 struct ast_bridge *ast_bridge_new(uint32_t capabilities, int flags);
269
270 /*! \brief See if it is possible to create a bridge
271  *
272  * \param capabilities The capabilities that the bridge will use
273  *
274  * \retval 1 if possible
275  * \retval 0 if not possible
276  *
277  * Example usage:
278  *
279  * \code
280  * int possible = ast_bridge_check(AST_BRIDGE_CAPABILITY_1TO1MIX);
281  * \endcode
282  *
283  * This sees if it is possible to create a bridge capable of bridging two channels
284  * together.
285  */
286 int ast_bridge_check(uint32_t capabilities);
287
288 /*! \brief Destroy a bridge
289  *
290  * \param bridge Bridge to destroy
291  *
292  * \retval 0 on success
293  * \retval -1 on failure
294  *
295  * Example usage:
296  *
297  * \code
298  * ast_bridge_destroy(bridge);
299  * \endcode
300  *
301  * This destroys a bridge that was previously created using ast_bridge_new.
302  */
303 int ast_bridge_destroy(struct ast_bridge *bridge);
304
305 /*! \brief Join (blocking) a channel to a bridge
306  *
307  * \param bridge Bridge to join
308  * \param chan Channel to join
309  * \param swap Channel to swap out if swapping
310  * \param features Bridge features structure
311  * \param (Optional) Bridging tech optimization parameters for this channel.
312  *
313  * \retval state that channel exited the bridge with
314  *
315  * Example usage:
316  *
317  * \code
318  * ast_bridge_join(bridge, chan, NULL, NULL);
319  * \endcode
320  *
321  * This adds a channel pointed to by the chan pointer to the bridge pointed to by
322  * the bridge pointer. This function will not return until the channel has been
323  * removed from the bridge, swapped out for another channel, or has hung up.
324  *
325  * If this channel will be replacing another channel the other channel can be specified
326  * in the swap parameter. The other channel will be thrown out of the bridge in an
327  * atomic fashion.
328  *
329  * If channel specific features are enabled a pointer to the features structure
330  * can be specified in the features parameter.
331  */
332 enum ast_bridge_channel_state ast_bridge_join(struct ast_bridge *bridge,
333         struct ast_channel *chan,
334         struct ast_channel *swap,
335         struct ast_bridge_features *features,
336         struct ast_bridge_tech_optimizations *tech_args);
337
338 /*! \brief Impart (non-blocking) a channel on a bridge
339  *
340  * \param bridge Bridge to impart on
341  * \param chan Channel to impart
342  * \param swap Channel to swap out if swapping
343  * \param features Bridge features structure
344  * \param allow_hangup  Indicates if the bridge thread should manage hanging up of the channel or not.
345  *
346  * \retval 0 on success
347  * \retval -1 on failure
348  *
349  * Example usage:
350  *
351  * \code
352  * ast_bridge_impart(bridge, chan, NULL, NULL, 0);
353  * \endcode
354  *
355  * This adds a channel pointed to by the chan pointer to the bridge pointed to by
356  * the bridge pointer. This function will return immediately and will not wait
357  * until the channel is no longer part of the bridge.
358  *
359  * If this channel will be replacing another channel the other channel can be specified
360  * in the swap parameter. The other channel will be thrown out of the bridge in an
361  * atomic fashion.
362  *
363  * If channel specific features are enabled a pointer to the features structure
364  * can be specified in the features parameter.
365  */
366 int ast_bridge_impart(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, int allow_hangup);
367
368 /*! \brief Depart a channel from a bridge
369  *
370  * \param bridge Bridge to depart from
371  * \param chan Channel to depart
372  *
373  * \retval 0 on success
374  * \retval -1 on failure
375  *
376  * Example usage:
377  *
378  * \code
379  * ast_bridge_depart(bridge, chan);
380  * \endcode
381  *
382  * This removes the channel pointed to by the chan pointer from the bridge
383  * pointed to by the bridge pointer and gives control to the calling thread.
384  * This does not hang up the channel.
385  *
386  * \note This API call can only be used on channels that were added to the bridge
387  *       using the ast_bridge_impart API call.
388  */
389 int ast_bridge_depart(struct ast_bridge *bridge, struct ast_channel *chan);
390
391 /*! \brief Remove a channel from a bridge
392  *
393  * \param bridge Bridge that the channel is to be removed from
394  * \param chan Channel to remove
395  *
396  * \retval 0 on success
397  * \retval -1 on failure
398  *
399  * Example usage:
400  *
401  * \code
402  * ast_bridge_remove(bridge, chan);
403  * \endcode
404  *
405  * This removes the channel pointed to by the chan pointer from the bridge
406  * pointed to by the bridge pointer and requests that it be hung up. Control
407  * over the channel will NOT be given to the calling thread.
408  *
409  * \note This API call can be used on channels that were added to the bridge
410  *       using both ast_bridge_join and ast_bridge_impart.
411  */
412 int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan);
413
414 /*! \brief Merge two bridges together
415  *
416  * \param bridge0 First bridge
417  * \param bridge1 Second bridge
418  *
419  * \retval 0 on success
420  * \retval -1 on failure
421  *
422  * Example usage:
423  *
424  * \code
425  * ast_bridge_merge(bridge0, bridge1);
426  * \endcode
427  *
428  * This merges the bridge pointed to by bridge1 with the bridge pointed to by bridge0.
429  * In reality all of the channels in bridge1 are simply moved to bridge0.
430  *
431  * \note The second bridge specified is not destroyed when this operation is
432  *       completed.
433  */
434 int ast_bridge_merge(struct ast_bridge *bridge0, struct ast_bridge *bridge1);
435
436 /*! \brief Suspend a channel temporarily from a bridge
437  *
438  * \param bridge Bridge to suspend the channel from
439  * \param chan Channel to suspend
440  *
441  * \retval 0 on success
442  * \retval -1 on failure
443  *
444  * Example usage:
445  *
446  * \code
447  * ast_bridge_suspend(bridge, chan);
448  * \endcode
449  *
450  * This suspends the channel pointed to by chan from the bridge pointed to by bridge temporarily.
451  * Control of the channel is given to the calling thread. This differs from ast_bridge_depart as
452  * the channel will not be removed from the bridge.
453  *
454  * \note This API call can be used on channels that were added to the bridge
455  *       using both ast_bridge_join and ast_bridge_impart.
456  */
457 int ast_bridge_suspend(struct ast_bridge *bridge, struct ast_channel *chan);
458
459 /*! \brief Unsuspend a channel from a bridge
460  *
461  * \param bridge Bridge to unsuspend the channel from
462  * \param chan Channel to unsuspend
463  *
464  * \retval 0 on success
465  * \retval -1 on failure
466  *
467  * Example usage:
468  *
469  * \code
470  * ast_bridge_unsuspend(bridge, chan);
471  * \endcode
472  *
473  * This unsuspends the channel pointed to by chan from the bridge pointed to by bridge.
474  * The bridge will go back to handling the channel once this function returns.
475  *
476  * \note You must not mess with the channel once this function returns.
477  *       Doing so may result in bad things happening.
478  */
479 int ast_bridge_unsuspend(struct ast_bridge *bridge, struct ast_channel *chan);
480
481 /*! \brief Change the state of a bridged channel
482  *
483  * \param bridge_channel Channel to change the state on
484  * \param new_state The new state to place the channel into
485  *
486  * Example usage:
487  *
488  * \code
489  * ast_bridge_change_state(bridge_channel, AST_BRIDGE_CHANNEL_STATE_WAIT);
490  * \endcode
491  *
492  * This places the channel pointed to by bridge_channel into the state
493  * AST_BRIDGE_CHANNEL_STATE_WAIT.
494  *
495  * \note This API call is only meant to be used in feature hook callbacks to
496  *       make sure the channel either hangs up or returns to the bridge.
497  */
498 void ast_bridge_change_state(struct ast_bridge_channel *bridge_channel, enum ast_bridge_channel_state new_state);
499
500 /*! \brief Adjust the internal mixing sample rate of a bridge used during
501  *         multimix mode.
502  *
503  * \param bridge_channel Channel to change the sample rate on.
504  * \param sample rate, the sample rate to change to. If a
505  *        value of 0 is passed here, the bridge will be free to pick
506  *        what ever sample rate it chooses.
507  *
508  */
509 void ast_bridge_set_internal_sample_rate(struct ast_bridge *bridge, unsigned int sample_rate);
510
511 /*! \brief Adjust the internal mixing interval of a bridge used during
512  *         multimix mode.
513  *
514  * \param bridge_channel Channel to change the sample rate on.
515  * \param mixing_interval, the sample rate to change to.  If 0 is set
516  * the bridge tech is free to choose any mixing interval it uses by default.
517  */
518 void ast_bridge_set_mixing_interval(struct ast_bridge *bridge, unsigned int mixing_interval);
519
520 /*!
521  * \brief Set a bridge to feed a single video source to all participants.
522  */
523 void ast_bridge_set_single_src_video_mode(struct ast_bridge *bridge, struct ast_channel *video_src_chan);
524
525 /*!
526  * \brief Set the bridge to pick the strongest talker supporting
527  * video as the single source video feed
528  */
529 void ast_bridge_set_talker_src_video_mode(struct ast_bridge *bridge);
530
531 /*!
532  * \brief Update information about talker energy for talker src video mode.
533  */
534 void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame);
535
536 /*!
537  * \brief Returns the number of video sources currently active in the bridge
538  */
539 int ast_bridge_number_video_src(struct ast_bridge *bridge);
540
541 /*!
542  * \brief Determine if a channel is a video src for the bridge
543  *
544  * \retval 0 Not a current video source of the bridge.
545  * \retval None 0, is a video source of the bridge, The number
546  *         returned represents the priority this video stream has
547  *         on the bridge where 1 is the highest priority.
548  */
549 int ast_bridge_is_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
550
551 /*!
552  * \brief remove a channel as a source of video for the bridge.
553  */
554 void ast_bridge_remove_video_src(struct ast_bridge *bridge, struct ast_channel *chan);
555
556 #if defined(__cplusplus) || defined(c_plusplus)
557 }
558 #endif
559
560 #endif /* _ASTERISK_BRIDGING_H */