Resolve some BUGBUG comments.
[asterisk/asterisk.git] / include / asterisk / bridge_channel.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013 Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  * Richard Mudgett <rmudgett@digium.com>
8  * Matt Jordan <mjordan@digium.com>
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  * This program is free software, distributed under the terms of
17  * the GNU General Public License Version 2. See the LICENSE file
18  * at the top of the source tree.
19  */
20
21 /*!
22  * \file
23  * \page AstBridgeChannel Bridging Channel API
24  *
25  * An API that act on a channel in a bridge. Note that while the
26  * \ref ast_bridge_channel is owned by a channel, it should only be used
27  * by members of the bridging system. The only places where this API should
28  * be used is:
29  *  \arg \ref AstBridging API itself
30  *  \arg Bridge mixing technologies
31  *  \arg Bridge sub-classes
32  *
33  * In general, anywhere else it is unsafe to use this API. Care should be
34  * taken when using this API to ensure that the locking order remains
35  * correct. The locking order must be:
36  *  \arg The \ref \c ast_bridge
37  *  \arg The \ref \c ast_bridge_channel
38  *  \arg The \ref \c ast_channel
39  *
40  * \author Joshua Colp <jcolp@digium.com>
41  * \author Richard Mudgett <rmudgett@digium.com>
42  * \author Matt Jordan <mjordan@digium.com>
43  *
44  * See Also:
45  * \arg \ref AstBridging
46  * \arg \ref AstCREDITS
47  */
48
49 #ifndef _ASTERISK_BRIDGING_CHANNEL_H
50 #define _ASTERISK_BRIDGING_CHANNEL_H
51
52 #if defined(__cplusplus) || defined(c_plusplus)
53 extern "C" {
54 #endif
55
56 #include "asterisk/bridge_technology.h"
57
58 /*! \brief State information about a bridged channel */
59 enum bridge_channel_state {
60         /*! Waiting for a signal (Channel in the bridge) */
61         BRIDGE_CHANNEL_STATE_WAIT = 0,
62         /*! Bridged channel was forced out and should be hung up (Bridge may dissolve.) */
63         BRIDGE_CHANNEL_STATE_END,
64         /*! Bridged channel was forced out. Don't dissolve the bridge regardless */
65         BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE,
66 };
67
68 enum bridge_channel_thread_state {
69         /*! Bridge channel thread is idle/waiting. */
70         BRIDGE_CHANNEL_THREAD_IDLE,
71         /*! Bridge channel thread is writing a normal/simple frame. */
72         BRIDGE_CHANNEL_THREAD_SIMPLE,
73         /*! Bridge channel thread is processing a frame. */
74         BRIDGE_CHANNEL_THREAD_FRAME,
75 };
76
77 struct ast_bridge;
78 struct ast_bridge_tech_optimizations;
79
80  /*!
81  * \brief Structure that contains information regarding a channel in a bridge
82  */
83 struct ast_bridge_channel {
84 /* BUGBUG cond is only here because of external party suspend/unsuspend support. */
85         /*! Condition, used if we want to wake up a thread waiting on the bridged channel */
86         ast_cond_t cond;
87         /*! Current bridged channel state */
88         enum bridge_channel_state state;
89         /*! Asterisk channel participating in the bridge */
90         struct ast_channel *chan;
91         /*! Asterisk channel we are swapping with (if swapping) */
92         struct ast_channel *swap;
93         /*!
94          * \brief Bridge this channel is participating in
95          *
96          * \note The bridge pointer cannot change while the bridge or
97          * bridge_channel is locked.
98          */
99         struct ast_bridge *bridge;
100         /*!
101          * \brief Bridge class private channel data.
102          *
103          * \note This information is added when the channel is pushed
104          * into the bridge and removed when it is pulled from the
105          * bridge.
106          */
107         void *bridge_pvt;
108         /*!
109          * \brief Private information unique to the bridge technology.
110          *
111          * \note This information is added when the channel joins the
112          * bridge's technology and removed when it leaves the bridge's
113          * technology.
114          */
115         void *tech_pvt;
116         /*! Thread handling the bridged channel (Needed by ast_bridge_depart) */
117         pthread_t thread;
118         /* v-- These flags change while the bridge is locked or before the channel is in the bridge. */
119         /*! TRUE if the channel is in a bridge. */
120         unsigned int in_bridge:1;
121         /*! TRUE if the channel just joined the bridge. */
122         unsigned int just_joined:1;
123         /*! TRUE if the channel is suspended from the bridge. */
124         unsigned int suspended:1;
125         /*! TRUE if the channel must wait for an ast_bridge_depart to reclaim the channel. */
126         unsigned int depart_wait:1;
127         /* ^-- These flags change while the bridge is locked or before the channel is in the bridge. */
128         /*! Features structure for features that are specific to this channel */
129         struct ast_bridge_features *features;
130         /*! Technology optimization parameters used by bridging technologies capable of
131          *  optimizing based upon talk detection. */
132         struct ast_bridge_tech_optimizations tech_args;
133         /*! Copy of read format used by chan before join */
134         struct ast_format read_format;
135         /*! Copy of write format used by chan before join */
136         struct ast_format write_format;
137         /*! Call ID associated with bridge channel */
138         struct ast_callid *callid;
139         /*! A clone of the roles living on chan when the bridge channel joins the bridge. This may require some opacification */
140         struct bridge_roles_datastore *bridge_roles;
141         /*! Linked list information */
142         AST_LIST_ENTRY(ast_bridge_channel) entry;
143         /*! Queue of outgoing frames to the channel. */
144         AST_LIST_HEAD_NOLOCK(, ast_frame) wr_queue;
145         /*! Pipe to alert thread when frames are put into the wr_queue. */
146         int alert_pipe[2];
147         /*! TRUE if the bridge channel thread is waiting on channels (needs to be atomically settable) */
148         int waiting;
149         /*!
150          * \brief The bridge channel thread activity.
151          *
152          * \details Used by local channel optimization to determine if
153          * the thread is in an acceptable state to optimize.
154          *
155          * \note Needs to be atomically settable.
156          */
157         enum bridge_channel_thread_state activity;
158 };
159
160 /*!
161  * \brief Try locking the bridge_channel.
162  *
163  * \param bridge_channel What to try locking
164  *
165  * \retval 0 on success.
166  * \retval non-zero on error.
167  */
168 #define ast_bridge_channel_trylock(bridge_channel)      _ast_bridge_channel_trylock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
169 static inline int _ast_bridge_channel_trylock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
170 {
171         return __ao2_trylock(bridge_channel, AO2_LOCK_REQ_MUTEX, file, function, line, var);
172 }
173
174 /*!
175  * \brief Lock the bridge_channel.
176  *
177  * \param bridge_channel What to lock
178  *
179  * \return Nothing
180  */
181 #define ast_bridge_channel_lock(bridge_channel) _ast_bridge_channel_lock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
182 static inline void _ast_bridge_channel_lock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
183 {
184         __ao2_lock(bridge_channel, AO2_LOCK_REQ_MUTEX, file, function, line, var);
185 }
186
187 /*!
188  * \brief Unlock the bridge_channel.
189  *
190  * \param bridge_channel What to unlock
191  *
192  * \return Nothing
193  */
194 #define ast_bridge_channel_unlock(bridge_channel)       _ast_bridge_channel_unlock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
195 static inline void _ast_bridge_channel_unlock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
196 {
197         __ao2_unlock(bridge_channel, file, function, line, var);
198 }
199
200 /*!
201  * \brief Lock the bridge associated with the bridge channel.
202  * \since 12.0.0
203  *
204  * \param bridge_channel Channel that wants to lock the bridge.
205  *
206  * \details
207  * This is an upstream lock operation.  The defined locking
208  * order is bridge then bridge_channel.
209  *
210  * \note On entry, neither the bridge nor bridge_channel is locked.
211  *
212  * \note The bridge_channel->bridge pointer changes because of a
213  * bridge-merge/channel-move operation between bridges.
214  *
215  * \return Nothing
216  */
217 void ast_bridge_channel_lock_bridge(struct ast_bridge_channel *bridge_channel);
218
219 /*!
220  * \brief Lets the bridging indicate when a bridge channel has stopped or started talking.
221  *
222  * \note All DSP functionality on the bridge has been pushed down to the lowest possible
223  * layer, which in this case is the specific bridging technology being used. Since it
224  * is necessary for the knowledge of which channels are talking to make its way up to the
225  * application, this function has been created to allow the bridging technology to communicate
226  * that information with the bridging core.
227  *
228  * \param bridge_channel The bridge channel that has either started or stopped talking.
229  * \param started_talking set to 1 when this indicates the channel has started talking set to 0
230  * when this indicates the channel has stopped talking.
231  *
232  * \retval 0 on success.
233  * \retval -1 on error.
234  */
235 int ast_bridge_channel_notify_talking(struct ast_bridge_channel *bridge_channel, int started_talking);
236
237 /*!
238  * \brief Set bridge channel state to leave bridge (if not leaving already).
239  *
240  * \param bridge_channel Channel to change the state on
241  * \param new_state The new state to place the channel into
242  *
243  * Example usage:
244  *
245  * \code
246  * ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END);
247  * \endcode
248  *
249  * This places the channel pointed to by bridge_channel into the
250  * state BRIDGE_CHANNEL_STATE_END if it was
251  * BRIDGE_CHANNEL_STATE_WAIT before.
252  */
253 void ast_bridge_channel_leave_bridge(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state);
254
255 /*!
256  * \brief Set bridge channel state to leave bridge (if not leaving already).
257  *
258  * \param bridge_channel Channel to change the state on
259  * \param new_state The new state to place the channel into
260  *
261  * Example usage:
262  *
263  * \code
264  * ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END);
265  * \endcode
266  *
267  * This places the channel pointed to by bridge_channel into the
268  * state BRIDGE_CHANNEL_STATE_END if it was
269  * BRIDGE_CHANNEL_STATE_WAIT before.
270  */
271 void ast_bridge_channel_leave_bridge_nolock(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state);
272
273 /*!
274  * \brief Get the peer bridge channel of a two party bridge.
275  * \since 12.0.0
276  *
277  * \param bridge_channel What to get the peer of.
278  *
279  * \note On entry, bridge_channel->bridge is already locked.
280  *
281  * \note This is an internal bridge function.
282  *
283  * \retval peer on success.
284  * \retval NULL no peer channel.
285  */
286 struct ast_bridge_channel *ast_bridge_channel_peer(struct ast_bridge_channel *bridge_channel);
287
288 /*!
289  * \brief Restore the formats of a bridge channel's channel to how they were before bridge_channel_internal_join
290  * \since 12.0.0
291  *
292  * \param bridge_channel Channel to restore
293  */
294 void ast_bridge_channel_restore_formats(struct ast_bridge_channel *bridge_channel);
295
296 /*!
297  * \brief Adjust the bridge_channel's bridge merge inhibit request count.
298  * \since 12.0.0
299  *
300  * \param bridge_channel What to operate on.
301  * \param request Inhibit request increment.
302  *     (Positive to add requests.  Negative to remove requests.)
303  *
304  * \note This API call is meant for internal bridging operations.
305  *
306  * \retval bridge adjusted merge inhibit with reference count.
307  */
308 struct ast_bridge *ast_bridge_channel_merge_inhibit(struct ast_bridge_channel *bridge_channel, int request);
309
310 /*!
311  * \internal
312  * \brief Update the linkedids for all channels in a bridge
313  * \since 12.0.0
314  *
315  * \param bridge_channel The channel joining the bridge
316  * \param swap The channel being swapped out of the bridge. May be NULL.
317  *
318  * \note The bridge must be locked prior to calling this function. This should be called
319  * during a \ref bridge_channel_internal_push operation, typically by a sub-class of a bridge
320  */
321 void ast_bridge_channel_update_linkedids(struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap);
322
323 /*!
324  * \internal
325  * \brief Update the accountcodes for a channel entering a bridge
326  * \since 12.0.0
327  *
328  * This function updates the accountcode and peeraccount on channels in two-party
329  * bridges. In multi-party bridges, peeraccount is not set - it doesn't make much sense -
330  * however accountcode propagation will still occur if the channel joining has an
331  * accountcode.
332  *
333  * \param bridge_channel The channel joining the bridge
334  * \param swap The channel being swapped out of the bridge. May be NULL.
335  *
336  * \note The bridge must be locked prior to calling this function. This should be called
337  * during a \ref bridge_channel_internal_push operation, typically by a sub-class of a bridge
338  */
339 void ast_bridge_channel_update_accountcodes(struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap);
340
341 /*!
342  * \brief Write a frame to the specified bridge_channel.
343  * \since 12.0.0
344  *
345  * \param bridge_channel Channel to queue the frame.
346  * \param fr Frame to write.
347  *
348  * \retval 0 on success.
349  * \retval -1 on error.
350  */
351 int ast_bridge_channel_queue_frame(struct ast_bridge_channel *bridge_channel, struct ast_frame *fr);
352
353 /*!
354  * \brief Queue a control frame onto the bridge channel with data.
355  * \since 12.0.0
356  *
357  * \param bridge_channel Which channel to queue the frame onto.
358  * \param control Type of control frame.
359  * \param data Frame payload data to pass.
360  * \param datalen Frame payload data length to pass.
361  *
362  * \retval 0 on success.
363  * \retval -1 on error.
364  */
365 int ast_bridge_channel_queue_control_data(struct ast_bridge_channel *bridge_channel, enum ast_control_frame_type control, const void *data, size_t datalen);
366
367 /*!
368  * \brief Write a control frame into the bridge with data.
369  * \since 12.0.0
370  *
371  * \param bridge_channel Which channel is putting the frame into the bridge.
372  * \param control Type of control frame.
373  * \param data Frame payload data to pass.
374  * \param datalen Frame payload data length to pass.
375  *
376  * \retval 0 on success.
377  * \retval -1 on error.
378  */
379 int ast_bridge_channel_write_control_data(struct ast_bridge_channel *bridge_channel, enum ast_control_frame_type control, const void *data, size_t datalen);
380
381 /*!
382  * \brief Write a hold frame into the bridge.
383  * \since 12.0.0
384  *
385  * \param bridge_channel Which channel is putting the hold into the bridge.
386  * \param moh_class The suggested music class for the other end to use.
387  *
388  * \retval 0 on success.
389  * \retval -1 on error.
390  */
391 int ast_bridge_channel_write_hold(struct ast_bridge_channel *bridge_channel, const char *moh_class);
392
393 /*!
394  * \brief Write an unhold frame into the bridge.
395  * \since 12.0.0
396  *
397  * \param bridge_channel Which channel is putting the hold into the bridge.
398  *
399  * \retval 0 on success.
400  * \retval -1 on error.
401  */
402 int ast_bridge_channel_write_unhold(struct ast_bridge_channel *bridge_channel);
403
404 /*!
405  * \brief Run an application on the bridge channel.
406  * \since 12.0.0
407  *
408  * \param bridge_channel Which channel to run the application on.
409  * \param app_name Dialplan application name.
410  * \param app_args Arguments for the application. (NULL tolerant)
411  * \param moh_class MOH class to request bridge peers to hear while application is running.
412  *     NULL if no MOH.
413  *     Empty if default MOH class.
414  *
415  * \note This is intended to be called by bridge hooks.
416  *
417  * \return Nothing
418  */
419 void ast_bridge_channel_run_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
420
421 /*!
422  * \brief Write a bridge action run application frame into the bridge.
423  * \since 12.0.0
424  *
425  * \param bridge_channel Which channel is putting the frame into the bridge
426  * \param app_name Dialplan application name.
427  * \param app_args Arguments for the application. (NULL or empty for no arguments)
428  * \param moh_class MOH class to request bridge peers to hear while application is running.
429  *     NULL if no MOH.
430  *     Empty if default MOH class.
431  *
432  * \note This is intended to be called by bridge hooks.
433  *
434  * \retval 0 on success.
435  * \retval -1 on error.
436  */
437 int ast_bridge_channel_write_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
438
439 /*!
440  * \brief Queue a bridge action run application frame onto the bridge channel.
441  * \since 12.0.0
442  *
443  * \param bridge_channel Which channel to put the frame onto
444  * \param app_name Dialplan application name.
445  * \param app_args Arguments for the application. (NULL or empty for no arguments)
446  * \param moh_class MOH class to request bridge peers to hear while application is running.
447  *     NULL if no MOH.
448  *     Empty if default MOH class.
449  *
450  * \note This is intended to be called by bridge hooks.
451  *
452  * \retval 0 on success.
453  * \retval -1 on error.
454  */
455 int ast_bridge_channel_queue_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
456
457 /*!
458  * \brief Custom interpretation of the playfile name.
459  *
460  * \param bridge_channel Which channel to play the file on
461  * \param playfile Sound filename to play.
462  *
463  * \return Nothing
464  */
465 typedef void (*ast_bridge_custom_play_fn)(struct ast_bridge_channel *bridge_channel, const char *playfile);
466
467 /*!
468  * \brief Play a file on the bridge channel.
469  * \since 12.0.0
470  *
471  * \param bridge_channel Which channel to play the file on
472  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
473  * \param playfile Sound filename to play.
474  * \param moh_class MOH class to request bridge peers to hear while file is played.
475  *     NULL if no MOH.
476  *     Empty if default MOH class.
477  *
478  * \note This is intended to be called by bridge hooks.
479  *
480  * \return Nothing
481  */
482 void ast_bridge_channel_playfile(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class);
483
484 /*!
485  * \brief Write a bridge action play file frame into the bridge.
486  * \since 12.0.0
487  *
488  * \param bridge_channel Which channel is putting the frame into the bridge
489  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
490  * \param playfile Sound filename to play.
491  * \param moh_class MOH class to request bridge peers to hear while file is played.
492  *     NULL if no MOH.
493  *     Empty if default MOH class.
494  *
495  * \note This is intended to be called by bridge hooks.
496  *
497  * \retval 0 on success.
498  * \retval -1 on error.
499  */
500 int ast_bridge_channel_write_playfile(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class);
501
502 /*!
503  * \brief Queue a bridge action play file frame onto the bridge channel.
504  * \since 12.0.0
505  *
506  * \param bridge_channel Which channel to put the frame onto.
507  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
508  * \param playfile Sound filename to play.
509  * \param moh_class MOH class to request bridge peers to hear while file is played.
510  *     NULL if no MOH.
511  *     Empty if default MOH class.
512  *
513  * \note This is intended to be called by bridge hooks.
514  *
515  * \retval 0 on success.
516  * \retval -1 on error.
517  */
518 int ast_bridge_channel_queue_playfile(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class);
519
520 /*!
521  * \brief Custom callback run on a bridge channel.
522  *
523  * \param bridge_channel Which channel to operate on.
524  * \param payload Data to pass to the callback. (NULL if none).
525  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
526  *
527  * \note The payload MUST NOT have any resources that need to be freed.
528  *
529  * \return Nothing
530  */
531 typedef void (*ast_bridge_custom_callback_fn)(struct ast_bridge_channel *bridge_channel, const void *payload, size_t payload_size);
532
533 /*!
534  * \brief Write a bridge action custom callback frame into the bridge.
535  * \since 12.0.0
536  *
537  * \param bridge_channel Which channel is putting the frame into the bridge
538  * \param callback Custom callback run on a bridge channel.
539  * \param payload Data to pass to the callback. (NULL if none).
540  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
541  *
542  * \note The payload MUST NOT have any resources that need to be freed.
543  *
544  * \note This is intended to be called by bridge hooks.
545  *
546  * \retval 0 on success.
547  * \retval -1 on error.
548  */
549 int ast_bridge_channel_write_callback(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_callback_fn callback, const void *payload, size_t payload_size);
550
551 /*!
552  * \brief Queue a bridge action custom callback frame onto the bridge channel.
553  * \since 12.0.0
554  *
555  * \param bridge_channel Which channel to put the frame onto.
556  * \param callback Custom callback run on a bridge channel.
557  * \param payload Data to pass to the callback. (NULL if none).
558  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
559  *
560  * \note The payload MUST NOT have any resources that need to be freed.
561  *
562  * \note This is intended to be called by bridge hooks.
563  *
564  * \retval 0 on success.
565  * \retval -1 on error.
566  */
567 int ast_bridge_channel_queue_callback(struct ast_bridge_channel *bridge_channel, ast_bridge_custom_callback_fn callback, const void *payload, size_t payload_size);
568
569 /*!
570  * \brief Have a bridge channel park a channel in the bridge
571  * \since 12.0.0
572  *
573  * \param bridge_channel Bridge channel performing the parking
574  * \param parkee_uuid Unique id of the channel we want to park
575  * \param parker_uuid Unique id of the channel parking the call
576  * \param app_data string indicating data used for park application (NULL allowed)
577  *
578  * \note This is intended to be called by bridge hooks.
579  *
580  * \retval 0 on success.
581  * \retval -1 on error.
582  */
583 int ast_bridge_channel_write_park(struct ast_bridge_channel *bridge_channel, const char *parkee_uuid,
584         const char *parker_uuid, const char *app_data);
585
586 #if defined(__cplusplus) || defined(c_plusplus)
587 }
588 #endif
589
590 #endif  /* _ASTERISK_BRIDGING_CHANNEL_H */