dd72f3275fc5d199d56d6e74997242b1dec04cbf
[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_features.h"
57 #include "asterisk/bridge_technology.h"
58
59 /*! \brief State information about a bridged channel */
60 enum bridge_channel_state {
61         /*! Waiting for a signal (Channel in the bridge) */
62         BRIDGE_CHANNEL_STATE_WAIT = 0,
63         /*! Bridged channel was forced out and should be hung up (Bridge may dissolve.) */
64         BRIDGE_CHANNEL_STATE_END,
65         /*! Bridged channel was forced out. Don't dissolve the bridge regardless */
66         BRIDGE_CHANNEL_STATE_END_NO_DISSOLVE,
67 };
68
69 enum bridge_channel_thread_state {
70         /*! Bridge channel thread is idle/waiting. */
71         BRIDGE_CHANNEL_THREAD_IDLE,
72         /*! Bridge channel thread is writing a normal/simple frame. */
73         BRIDGE_CHANNEL_THREAD_SIMPLE,
74         /*! Bridge channel thread is processing a frame. */
75         BRIDGE_CHANNEL_THREAD_FRAME,
76 };
77
78 struct ast_bridge;
79 struct ast_bridge_tech_optimizations;
80
81  /*!
82  * \brief Structure that contains information regarding a channel in a bridge
83  */
84 struct ast_bridge_channel {
85 /* XXX ASTERISK-21271 cond is only here because of external party suspend/unsuspend support. */
86         /*! Condition, used if we want to wake up a thread waiting on the bridged channel */
87         ast_cond_t cond;
88         /*! Current bridged channel state */
89         enum bridge_channel_state state;
90         /*! Asterisk channel participating in the bridge */
91         struct ast_channel *chan;
92         /*! Asterisk channel we are swapping with (if swapping) */
93         struct ast_channel *swap;
94         /*!
95          * \brief Bridge this channel is participating in
96          *
97          * \note The bridge pointer cannot change while the bridge or
98          * bridge_channel is locked.
99          */
100         struct ast_bridge *bridge;
101         /*!
102          * \brief Bridge class private channel data.
103          *
104          * \note This information is added when the channel is pushed
105          * into the bridge and removed when it is pulled from the
106          * bridge.
107          */
108         void *bridge_pvt;
109         /*!
110          * \brief Private information unique to the bridge technology.
111          *
112          * \note This information is added when the channel joins the
113          * bridge's technology and removed when it leaves the bridge's
114          * technology.
115          */
116         void *tech_pvt;
117         /*! Thread handling the bridged channel (Needed by ast_bridge_depart) */
118         pthread_t thread;
119         /* v-- These flags change while the bridge is locked or before the channel is in the bridge. */
120         /*! TRUE if the channel is in a bridge. */
121         unsigned int in_bridge:1;
122         /*! TRUE if the channel just joined the bridge. */
123         unsigned int just_joined:1;
124         /*! TRUE if the channel is suspended from the bridge. */
125         unsigned int suspended:1;
126         /*! TRUE if the COLP update on initial join is inhibited. */
127         unsigned int inhibit_colp:1;
128         /*! TRUE if the channel must wait for an ast_bridge_depart to reclaim the channel. */
129         unsigned int depart_wait:1;
130         /* ^-- These flags change while the bridge is locked or before the channel is in the bridge. */
131         /*! Features structure for features that are specific to this channel */
132         struct ast_bridge_features *features;
133         /*! Technology optimization parameters used by bridging technologies capable of
134          *  optimizing based upon talk detection. */
135         struct ast_bridge_tech_optimizations tech_args;
136         /*! Copy of read format used by chan before join */
137         struct ast_format *read_format;
138         /*! Copy of write format used by chan before join */
139         struct ast_format *write_format;
140         /*! Call ID associated with bridge channel */
141         ast_callid callid;
142         /*! A clone of the roles living on chan when the bridge channel joins the bridge. This may require some opacification */
143         struct bridge_roles_datastore *bridge_roles;
144         /*! Linked list information */
145         AST_LIST_ENTRY(ast_bridge_channel) entry;
146         /*! Queue of outgoing frames to the channel. */
147         AST_LIST_HEAD_NOLOCK(, ast_frame) wr_queue;
148         /*! Pipe to alert thread when frames are put into the wr_queue. */
149         int alert_pipe[2];
150         /*!
151          * \brief The bridge channel thread activity.
152          *
153          * \details Used by local channel optimization to determine if
154          * the thread is in an acceptable state to optimize.
155          *
156          * \note Needs to be atomically settable.
157          */
158         enum bridge_channel_thread_state activity;
159         /*! Owed events to the bridge. */
160         struct {
161                 /*! Time started sending the current digit. (Invalid if owed.dtmf_digit is zero.) */
162                 struct timeval dtmf_tv;
163                 /*! Digit currently sending into the bridge. (zero if not sending) */
164                 char dtmf_digit;
165                 /*! Non-zero if a T.38 session terminate is owed to the bridge. */
166                 char t38_terminate;
167         } owed;
168         /*! DTMF hook sequence state */
169         struct {
170                 /*! Time at which the DTMF hooks should stop waiting for more digits to come. */
171                 struct timeval interdigit_timeout;
172                 /*! Collected DTMF digits for DTMF hooks. */
173                 char collected[MAXIMUM_DTMF_FEATURE_STRING];
174         } dtmf_hook_state;
175         union {
176                 uint32_t raw;
177                 struct {
178                         /*! TRUE if binaural is suspended. */
179                         unsigned int binaural_suspended:1;
180                         /*! TRUE if a change of binaural positions has to be performed. */
181                         unsigned int binaural_pos_change:1;
182                         /*! Padding */
183                         unsigned int padding:30;
184                 };
185         };
186         struct {
187                 /*! An index mapping of where a channel's media needs to be routed */
188                 struct ast_vector_int to_bridge;
189                 /*! An index mapping of where a bridge's media needs to be routed */
190                 struct ast_vector_int to_channel;
191         } stream_map;
192 };
193
194 /*!
195  * \brief Try locking the bridge_channel.
196  *
197  * \param bridge_channel What to try locking
198  *
199  * \retval 0 on success.
200  * \retval non-zero on error.
201  */
202 #define ast_bridge_channel_trylock(bridge_channel)      _ast_bridge_channel_trylock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
203 static inline int _ast_bridge_channel_trylock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
204 {
205         return __ao2_trylock(bridge_channel, AO2_LOCK_REQ_MUTEX, file, function, line, var);
206 }
207
208 /*!
209  * \brief Lock the bridge_channel.
210  *
211  * \param bridge_channel What to lock
212  *
213  * \return Nothing
214  */
215 #define ast_bridge_channel_lock(bridge_channel) _ast_bridge_channel_lock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
216 static inline void _ast_bridge_channel_lock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
217 {
218         __ao2_lock(bridge_channel, AO2_LOCK_REQ_MUTEX, file, function, line, var);
219 }
220
221 /*!
222  * \brief Unlock the bridge_channel.
223  *
224  * \param bridge_channel What to unlock
225  *
226  * \return Nothing
227  */
228 #define ast_bridge_channel_unlock(bridge_channel)       _ast_bridge_channel_unlock(bridge_channel, __FILE__, __PRETTY_FUNCTION__, __LINE__, #bridge_channel)
229 static inline void _ast_bridge_channel_unlock(struct ast_bridge_channel *bridge_channel, const char *file, const char *function, int line, const char *var)
230 {
231         __ao2_unlock(bridge_channel, file, function, line, var);
232 }
233
234 /*!
235  * \brief Lock the bridge associated with the bridge channel.
236  * \since 12.0.0
237  *
238  * \param bridge_channel Channel that wants to lock the bridge.
239  *
240  * \details
241  * This is an upstream lock operation.  The defined locking
242  * order is bridge then bridge_channel.
243  *
244  * \note On entry, neither the bridge nor bridge_channel is locked.
245  *
246  * \note The bridge_channel->bridge pointer changes because of a
247  * bridge-merge/channel-move operation between bridges.
248  *
249  * \return Nothing
250  */
251 void ast_bridge_channel_lock_bridge(struct ast_bridge_channel *bridge_channel);
252
253 /*!
254  * \brief Lets the bridging indicate when a bridge channel has stopped or started talking.
255  *
256  * \note All DSP functionality on the bridge has been pushed down to the lowest possible
257  * layer, which in this case is the specific bridging technology being used. Since it
258  * is necessary for the knowledge of which channels are talking to make its way up to the
259  * application, this function has been created to allow the bridging technology to communicate
260  * that information with the bridging core.
261  *
262  * \param bridge_channel The bridge channel that has either started or stopped talking.
263  * \param started_talking set to 1 when this indicates the channel has started talking set to 0
264  * when this indicates the channel has stopped talking.
265  *
266  * \retval 0 on success.
267  * \retval -1 on error.
268  */
269 int ast_bridge_channel_notify_talking(struct ast_bridge_channel *bridge_channel, int started_talking);
270
271 /*!
272  * \brief Set bridge channel state to leave bridge (if not leaving already).
273  *
274  * \param bridge_channel Channel to change the state on
275  * \param new_state The new state to place the channel into
276  * \param cause Cause of channel leaving bridge.
277  *   If cause <= 0 then use cause on channel if cause still <= 0 use AST_CAUSE_NORMAL_CLEARING.
278  *
279  * Example usage:
280  *
281  * \code
282  * ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END, AST_CAUSE_NORMAL_CLEARING);
283  * \endcode
284  *
285  * This places the channel pointed to by bridge_channel into the
286  * state BRIDGE_CHANNEL_STATE_END if it was
287  * BRIDGE_CHANNEL_STATE_WAIT before.
288  */
289 void ast_bridge_channel_leave_bridge(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state, int cause);
290
291 /*!
292  * \brief Set bridge channel state to leave bridge (if not leaving already).
293  *
294  * \param bridge_channel Channel to change the state on
295  * \param new_state The new state to place the channel into
296  * \param cause Cause of channel leaving bridge.
297  *   If cause <= 0 then use cause on channel if cause still <= 0 use AST_CAUSE_NORMAL_CLEARING.
298  *
299  * Example usage:
300  *
301  * \code
302  * ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END, AST_CAUSE_NORMAL_CLEARING);
303  * \endcode
304  *
305  * This places the channel pointed to by bridge_channel into the
306  * state BRIDGE_CHANNEL_STATE_END if it was
307  * BRIDGE_CHANNEL_STATE_WAIT before.
308  */
309 void ast_bridge_channel_leave_bridge_nolock(struct ast_bridge_channel *bridge_channel, enum bridge_channel_state new_state, int cause);
310
311 /*!
312  * \brief Get the peer bridge channel of a two party bridge.
313  * \since 12.0.0
314  *
315  * \param bridge_channel What to get the peer of.
316  *
317  * \note On entry, bridge_channel->bridge is already locked.
318  *
319  * \note This is an internal bridge function.
320  *
321  * \retval peer on success.
322  * \retval NULL no peer channel.
323  */
324 struct ast_bridge_channel *ast_bridge_channel_peer(struct ast_bridge_channel *bridge_channel);
325
326 /*!
327  * \brief Restore the formats of a bridge channel's channel to how they were before bridge_channel_internal_join
328  * \since 12.0.0
329  *
330  * \param bridge_channel Channel to restore
331  */
332 void ast_bridge_channel_restore_formats(struct ast_bridge_channel *bridge_channel);
333
334 /*!
335  * \brief Adjust the bridge_channel's bridge merge inhibit request count.
336  * \since 12.0.0
337  *
338  * \param bridge_channel What to operate on.
339  * \param request Inhibit request increment.
340  *     (Positive to add requests.  Negative to remove requests.)
341  *
342  * \note This API call is meant for internal bridging operations.
343  *
344  * \retval bridge adjusted merge inhibit with reference count.
345  */
346 struct ast_bridge *ast_bridge_channel_merge_inhibit(struct ast_bridge_channel *bridge_channel, int request);
347
348 /*!
349  * \internal
350  * \brief Update the linkedids for all channels in a bridge
351  * \since 12.0.0
352  *
353  * \param bridge_channel The channel joining the bridge
354  * \param swap The channel being swapped out of the bridge. May be NULL.
355  *
356  * \note The bridge must be locked prior to calling this function.
357  * \note This should be called during a \ref bridge_channel_internal_push
358  * operation, typically by a sub-class of a bridge.
359  */
360 void ast_bridge_channel_update_linkedids(struct ast_bridge_channel *bridge_channel, struct ast_bridge_channel *swap);
361
362 /*!
363  * \internal
364  * \brief Update the accountcodes for channels joining/leaving a bridge
365  * \since 12.0.0
366  *
367  * This function updates the accountcode and peeraccount on channels in two-party
368  * bridges. In multi-party bridges, peeraccount is not set - it doesn't make much sense -
369  * however accountcode propagation will still occur if the channel joining has an
370  * accountcode.
371  *
372  * \param joining The channel joining the bridge.  May be NULL.
373  * \param leaving The channel leaving or being swapped out of the bridge. May be NULL.
374  *
375  * \note The joining and leaving parameters cannot both be NULL.
376  *
377  * \note The bridge must be locked prior to calling this function.
378  * \note This should be called during a \ref bridge_channel_internal_push
379  * or \ref bridge_channel_internal_pull operation, typically by a
380  * sub-class of a bridge.
381  */
382 void ast_bridge_channel_update_accountcodes(struct ast_bridge_channel *joining, struct ast_bridge_channel *leaving);
383
384 /*!
385  * \brief Write a frame to the specified bridge_channel.
386  * \since 12.0.0
387  *
388  * \param bridge_channel Channel to queue the frame.
389  * \param fr Frame to write.
390  *
391  * \retval 0 on success.
392  * \retval -1 on error.
393  */
394 int ast_bridge_channel_queue_frame(struct ast_bridge_channel *bridge_channel, struct ast_frame *fr);
395
396 /*!
397  * \brief Queue a control frame onto the bridge channel with data.
398  * \since 12.0.0
399  *
400  * \param bridge_channel Which channel to queue the frame onto.
401  * \param control Type of control frame.
402  * \param data Frame payload data to pass.
403  * \param datalen Frame payload data length to pass.
404  *
405  * \retval 0 on success.
406  * \retval -1 on error.
407  */
408 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);
409
410 /*!
411  * \brief Write a control frame into the bridge with data.
412  * \since 12.0.0
413  *
414  * \param bridge_channel Which channel is putting the frame into the bridge.
415  * \param control Type of control frame.
416  * \param data Frame payload data to pass.
417  * \param datalen Frame payload data length to pass.
418  *
419  * \retval 0 on success.
420  * \retval -1 on error.
421  */
422 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);
423
424 /*!
425  * \brief Write a hold frame into the bridge.
426  * \since 12.0.0
427  *
428  * \param bridge_channel Which channel is putting the hold into the bridge.
429  * \param moh_class The suggested music class for the other end to use.
430  *
431  * \retval 0 on success.
432  * \retval -1 on error.
433  */
434 int ast_bridge_channel_write_hold(struct ast_bridge_channel *bridge_channel, const char *moh_class);
435
436 /*!
437  * \brief Write an unhold frame into the bridge.
438  * \since 12.0.0
439  *
440  * \param bridge_channel Which channel is putting the hold into the bridge.
441  *
442  * \retval 0 on success.
443  * \retval -1 on error.
444  */
445 int ast_bridge_channel_write_unhold(struct ast_bridge_channel *bridge_channel);
446
447 /*!
448  * \brief Run an application on the bridge channel.
449  * \since 12.0.0
450  *
451  * \param bridge_channel Which channel to run the application on.
452  * \param app_name Dialplan application name.
453  * \param app_args Arguments for the application. (NULL tolerant)
454  * \param moh_class MOH class to request bridge peers to hear while application is running.
455  *     NULL if no MOH.
456  *     Empty if default MOH class.
457  *
458  * \note This is intended to be called by bridge hooks.
459  *
460  * \return Nothing
461  */
462 void ast_bridge_channel_run_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
463
464 /*!
465  * \brief Write a bridge action run application frame into the bridge.
466  * \since 12.0.0
467  *
468  * \param bridge_channel Which channel is putting the frame into the bridge
469  * \param app_name Dialplan application name.
470  * \param app_args Arguments for the application. (NULL or empty for no arguments)
471  * \param moh_class MOH class to request bridge peers to hear while application is running.
472  *     NULL if no MOH.
473  *     Empty if default MOH class.
474  *
475  * \note This is intended to be called by bridge hooks.
476  *
477  * \retval 0 on success.
478  * \retval -1 on error.
479  */
480 int ast_bridge_channel_write_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
481
482 /*!
483  * \brief Queue a bridge action run application frame onto the bridge channel.
484  * \since 12.0.0
485  *
486  * \param bridge_channel Which channel to put the frame onto
487  * \param app_name Dialplan application name.
488  * \param app_args Arguments for the application. (NULL or empty for no arguments)
489  * \param moh_class MOH class to request bridge peers to hear while application is running.
490  *     NULL if no MOH.
491  *     Empty if default MOH class.
492  *
493  * \note This is intended to be called by bridge hooks.
494  *
495  * \retval 0 on success.
496  * \retval -1 on error.
497  */
498 int ast_bridge_channel_queue_app(struct ast_bridge_channel *bridge_channel, const char *app_name, const char *app_args, const char *moh_class);
499
500 /*!
501  * \brief Custom interpretation of the playfile name.
502  *
503  * \param bridge_channel Which channel to play the file on
504  * \param playfile Sound filename to play.
505  *
506  * \return Nothing
507  */
508 typedef void (*ast_bridge_custom_play_fn)(struct ast_bridge_channel *bridge_channel, const char *playfile);
509
510 /*!
511  * \brief Play a file on the bridge channel.
512  * \since 12.0.0
513  *
514  * \param bridge_channel Which channel to play the file on
515  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
516  * \param playfile Sound filename to play.
517  * \param moh_class MOH class to request bridge peers to hear while file is played.
518  *     NULL if no MOH.
519  *     Empty if default MOH class.
520  *
521  * \note This is intended to be called by bridge hooks.
522  *
523  * \return Nothing
524  */
525 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);
526
527 /*!
528  * \brief Write a bridge action play file frame into the bridge.
529  * \since 12.0.0
530  *
531  * \param bridge_channel Which channel is putting the frame into the bridge
532  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
533  * \param playfile Sound filename to play.
534  * \param moh_class MOH class to request bridge peers to hear while file is played.
535  *     NULL if no MOH.
536  *     Empty if default MOH class.
537  *
538  * \note This is intended to be called by bridge hooks.
539  *
540  * \retval 0 on success.
541  * \retval -1 on error.
542  */
543 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);
544
545 /*!
546  * \brief Queue a bridge action play file frame onto the bridge channel.
547  * \since 12.0.0
548  *
549  * \param bridge_channel Which channel to put the frame onto.
550  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
551  * \param playfile Sound filename to play.
552  * \param moh_class MOH class to request bridge peers to hear while file is played.
553  *     NULL if no MOH.
554  *     Empty if default MOH class.
555  *
556  * \note This is intended to be called by bridge hooks.
557  *
558  * \retval 0 on success.
559  * \retval -1 on error.
560  */
561 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);
562
563 /*!
564  * \brief Synchronously queue a bridge action play file frame onto the bridge channel.
565  * \since 12.2.0
566  *
567  * \param bridge_channel Which channel to put the frame onto.
568  * \param custom_play Call this function to play the playfile. (NULL if normal sound file to play)
569  * \param playfile Sound filename to play.
570  * \param moh_class MOH class to request bridge peers to hear while file is played.
571  *     NULL if no MOH.
572  *     Empty if default MOH class.
573  *
574  * This function will block until the queued frame has been destroyed. This will happen
575  * either if an error occurs or if the queued playback finishes.
576  *
577  * \note No locks may be held when calling this function.
578  *
579  * \retval 0 The playback was successfully queued.
580  * \retval -1 The playback could not be queued.
581  */
582 int ast_bridge_channel_queue_playfile_sync(struct ast_bridge_channel *bridge_channel,
583                 ast_bridge_custom_play_fn custom_play, const char *playfile, const char *moh_class);
584
585 /*!
586  * \brief Custom callback run on a bridge channel.
587  *
588  * \param bridge_channel Which channel to operate on.
589  * \param payload Data to pass to the callback. (NULL if none).
590  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
591  *
592  * \note The payload MUST NOT have any resources that need to be freed.
593  *
594  * \return Nothing
595  */
596 typedef void (*ast_bridge_custom_callback_fn)(struct ast_bridge_channel *bridge_channel, const void *payload, size_t payload_size);
597
598 enum ast_bridge_channel_custom_callback_option {
599         /*! The callback temporarily affects media. (Like a custom playfile.) */
600         AST_BRIDGE_CHANNEL_CB_OPTION_MEDIA = (1 << 0),
601 };
602
603 /*!
604  * \brief Write a bridge action custom callback frame into the bridge.
605  * \since 12.0.0
606  *
607  * \param bridge_channel Which channel is putting the frame into the bridge
608  * \param flags Custom callback option flags.
609  * \param callback Custom callback run on a bridge channel.
610  * \param payload Data to pass to the callback. (NULL if none).
611  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
612  *
613  * \note The payload MUST NOT have any resources that need to be freed.
614  *
615  * \note This is intended to be called by bridge hooks.
616  *
617  * \retval 0 on success.
618  * \retval -1 on error.
619  */
620 int ast_bridge_channel_write_callback(struct ast_bridge_channel *bridge_channel,
621         enum ast_bridge_channel_custom_callback_option flags,
622         ast_bridge_custom_callback_fn callback, const void *payload, size_t payload_size);
623
624 /*!
625  * \brief Queue a bridge action custom callback frame onto the bridge channel.
626  * \since 12.0.0
627  *
628  * \param bridge_channel Which channel to put the frame onto.
629  * \param flags Custom callback option flags.
630  * \param callback Custom callback run on a bridge channel.
631  * \param payload Data to pass to the callback. (NULL if none).
632  * \param payload_size Size of the payload if payload is non-NULL.  A number otherwise.
633  *
634  * \note The payload MUST NOT have any resources that need to be freed.
635  *
636  * \note This is intended to be called by bridge hooks.
637  *
638  * \retval 0 on success.
639  * \retval -1 on error.
640  */
641 int ast_bridge_channel_queue_callback(struct ast_bridge_channel *bridge_channel,
642         enum ast_bridge_channel_custom_callback_option flags,
643         ast_bridge_custom_callback_fn callback, const void *payload, size_t payload_size);
644
645 /*!
646  * \brief Have a bridge channel park a channel in the bridge
647  * \since 12.0.0
648  *
649  * \param bridge_channel Bridge channel performing the parking
650  * \param parkee_uuid Unique id of the channel we want to park
651  * \param parker_uuid Unique id of the channel parking the call
652  * \param app_data string indicating data used for park application (NULL allowed)
653  *
654  * \note This is intended to be called by bridge hooks.
655  *
656  * \retval 0 on success.
657  * \retval -1 on error.
658  */
659 int ast_bridge_channel_write_park(struct ast_bridge_channel *bridge_channel, const char *parkee_uuid,
660         const char *parker_uuid, const char *app_data);
661
662 /*!
663  * \brief Kick the channel out of the bridge.
664  * \since 12.0.0
665  *
666  * \param bridge_channel Which channel is being kicked or hungup.
667  * \param cause Cause of channel being kicked.
668  *   If cause <= 0 then use cause on channel if cause still <= 0 use AST_CAUSE_NORMAL_CLEARING.
669  *
670  * \note This is intended to be called by bridge hooks and the
671  * bridge channel thread.
672  *
673  * \return Nothing
674  */
675 void ast_bridge_channel_kick(struct ast_bridge_channel *bridge_channel, int cause);
676
677 /*!
678  * \brief Add a DTMF digit to the collected digits.
679  * \since 13.3.0
680  *
681  * \param bridge_channel Channel that received a DTMF digit.
682  * \param digit DTMF digit to add to collected digits
683  *
684  * \note Neither the bridge nor the bridge_channel locks should be held
685  * when entering this function.
686  *
687  * \note This is can only be called from within DTMF bridge hooks.
688  */
689 void ast_bridge_channel_feature_digit_add(struct ast_bridge_channel *bridge_channel, int digit);
690
691 /*!
692  * \brief Add a DTMF digit to the collected digits to match against DTMF features.
693  * \since 12.8.0
694  *
695  * \param bridge_channel Channel that received a DTMF digit.
696  * \param digit DTMF digit to add to collected digits or 0 for timeout event.
697  * \param clear_digits clear the digits array prior to calling hooks
698  *
699  * \note Neither the bridge nor the bridge_channel locks should be held
700  * when entering this function.
701  *
702  * \note This is intended to be called by bridge hooks and the
703  * bridge channel thread.
704  *
705  * \note This is intended to be called by non-DTMF bridge hooks and the bridge
706  * channel thread.  Calling from a DTMF bridge hook can potentially cause
707  * unbounded recursion.
708  *
709  * \return Nothing
710  */
711 void ast_bridge_channel_feature_digit(struct ast_bridge_channel *bridge_channel, int digit);
712
713 /*!
714  * \brief Maps a channel's stream topology to and from the bridge
715  * \since 15.0.0
716  *
717  * When a channel joins a bridge or its associated stream topology is updated, each stream
718  * in the topology needs to be mapped according to its media type to the bridge. Calling
719  * this method creates a mapping of each stream on the channel indexed to the bridge's
720  * supported media types and vice versa (i.e. bridge's media types indexed to channel
721  * streams).
722  *
723  * The first channel to join the bridge creates the initial order for the bridge's media
724  * types (e.g. a one to one mapping is made). Subsequently added channels are mapped to
725  * that order adding more media types if/when the newly added channel has more streams
726  * and/or media types specified by the bridge.
727  *
728  * \param bridge_channel Channel to map
729  *
730  * \return Nothing
731  */
732 void ast_bridge_channel_stream_map(struct ast_bridge_channel *bridge_channel);
733
734 #if defined(__cplusplus) || defined(c_plusplus)
735 }
736 #endif
737
738 #endif  /* _ASTERISK_BRIDGING_CHANNEL_H */