Perform the initial renaming of the Bridging API
[asterisk/asterisk.git] / include / asterisk / bridging_technology.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 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  */
23
24 #ifndef _ASTERISK_BRIDGING_TECHNOLOGY_H
25 #define _ASTERISK_BRIDGING_TECHNOLOGY_H
26
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30
31 /*!
32  * \brief Base preference values for choosing a bridge technology.
33  *
34  * \note Higher is more preference.
35  */
36 enum ast_bridge_preference {
37         AST_BRIDGE_PREFERENCE_BASE_HOLDING  = 50,
38         AST_BRIDGE_PREFERENCE_BASE_EARLY    = 100,
39         AST_BRIDGE_PREFERENCE_BASE_NATIVE   = 90,
40         AST_BRIDGE_PREFERENCE_BASE_1TO1MIX  = 50,
41         AST_BRIDGE_PREFERENCE_BASE_MULTIMIX = 10,
42 };
43
44 /*!
45  * \brief Structure specific to bridge technologies capable of
46  * performing talking optimizations.
47  */
48 struct ast_bridge_tech_optimizations {
49         /*! The amount of time in ms that talking must be detected before
50          *  the dsp determines that talking has occurred */
51         unsigned int talking_threshold;
52         /*! The amount of time in ms that silence must be detected before
53          *  the dsp determines that talking has stopped */
54         unsigned int silence_threshold;
55         /*! Whether or not the bridging technology should drop audio
56          *  detected as silence from the mix. */
57         unsigned int drop_silence:1;
58 };
59
60 /*!
61  * \brief Structure that is the essence of a bridge technology
62  */
63 struct ast_bridge_technology {
64         /*! Unique name to this bridge technology */
65         const char *name;
66         /*! The capabilities that this bridge technology is capable of.  This has nothing to do with
67          * format capabilities. */
68         uint32_t capabilities;
69         /*! Preference level that should be used when determining whether to use this bridge technology or not */
70         enum ast_bridge_preference preference;
71         /*!
72          * \brief Create a bridge technology instance for a bridge.
73          *
74          * \retval 0 on success
75          * \retval -1 on failure
76          *
77          * \note On entry, bridge may or may not already be locked.
78          * However, it can be accessed as if it were locked.
79          */
80         int (*create)(struct ast_bridge *bridge);
81         /*!
82          * \brief Request a bridge technology instance start operations.
83          *
84          * \retval 0 on success
85          * \retval -1 on failure
86          *
87          * \note On entry, bridge may or may not already be locked.
88          * However, it can be accessed as if it were locked.
89          */
90         int (*start)(struct ast_bridge *bridge);
91         /*!
92          * \brief Request a bridge technology instance stop in preparation for being destroyed.
93          *
94          * \note On entry, bridge is already locked.
95          */
96         void (*stop)(struct ast_bridge *bridge);
97         /*!
98          * \brief Destroy a bridging technology instance for a bridge.
99          *
100          * \note On entry, bridge must NOT be locked.
101          */
102         void (*destroy)(struct ast_bridge *bridge);
103         /*!
104          * \brief Add a channel to a bridging technology instance for a bridge.
105          *
106          * \retval 0 on success
107          * \retval -1 on failure
108          *
109          * \note On entry, bridge is already locked.
110          */
111         int (*join)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
112         /*!
113          * \brief Remove a channel from a bridging technology instance for a bridge.
114          *
115          * \note On entry, bridge is already locked.
116          */
117         void (*leave)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
118         /*!
119          * \brief Suspend a channel on a bridging technology instance for a bridge.
120          *
121          * \note On entry, bridge is already locked.
122          */
123         void (*suspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
124         /*!
125          * \brief Unsuspend a channel on a bridging technology instance for a bridge.
126          *
127          * \note On entry, bridge is already locked.
128          */
129         void (*unsuspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
130         /*!
131          * \brief Check if a bridge is compatible with the bridging technology.
132          *
133          * \retval 0 if not compatible
134          * \retval non-zero if compatible
135          *
136          * \note On entry, bridge may or may not already be locked.
137          * However, it can be accessed as if it were locked.
138          */
139         int (*compatible)(struct ast_bridge *bridge);
140         /*!
141          * \brief Write a frame into the bridging technology instance for a bridge.
142          *
143          * \note The bridge must be tolerant of bridge_channel being NULL.
144          *
145          * \retval 0 Frame accepted into the bridge.
146          * \retval -1 Frame needs to be deferred.
147          *
148          * \note On entry, bridge is already locked.
149          */
150         int (*write)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame);
151         /*! Formats that the bridge technology supports */
152         struct ast_format_cap *format_capabilities;
153         /*! TRUE if the bridge technology is currently suspended. */
154         unsigned int suspended:1;
155         /*! Module this bridge technology belongs to. It is used for reference counting bridges using the technology. */
156         struct ast_module *mod;
157         /*! Linked list information */
158         AST_RWLIST_ENTRY(ast_bridge_technology) entry;
159 };
160
161 /*!
162  * \brief Register a bridge technology for use
163  *
164  * \param technology The bridge technology to register
165  * \param mod The module that is registering the bridge technology
166  *
167  * \retval 0 on success
168  * \retval -1 on failure
169  *
170  * Example usage:
171  *
172  * \code
173  * ast_bridge_technology_register(&simple_bridge_tech);
174  * \endcode
175  *
176  * This registers a bridge technology declared as the structure
177  * simple_bridge_tech with the bridging core and makes it available for
178  * use when creating bridges.
179  */
180 int __ast_bridge_technology_register(struct ast_bridge_technology *technology, struct ast_module *mod);
181
182 /*! \brief See \ref __ast_bridge_technology_register() */
183 #define ast_bridge_technology_register(technology) __ast_bridge_technology_register(technology, ast_module_info->self)
184
185 /*!
186  * \brief Unregister a bridge technology from use
187  *
188  * \param technology The bridge technology to unregister
189  *
190  * \retval 0 on success
191  * \retval -1 on failure
192  *
193  * Example usage:
194  *
195  * \code
196  * ast_bridge_technology_unregister(&simple_bridge_tech);
197  * \endcode
198  *
199  * This unregisters a bridge technlogy declared as the structure
200  * simple_bridge_tech with the bridging core. It will no longer be
201  * considered when creating a new bridge.
202  */
203 int ast_bridge_technology_unregister(struct ast_bridge_technology *technology);
204
205 /*!
206  * \brief Lets the bridging indicate when a bridge channel has stopped or started talking.
207  *
208  * \note All DSP functionality on the bridge has been pushed down to the lowest possible
209  * layer, which in this case is the specific bridging technology being used. Since it
210  * is necessary for the knowledge of which channels are talking to make its way up to the
211  * application, this function has been created to allow the bridging technology to communicate
212  * that information with the bridging core.
213  *
214  * \param bridge_channel The bridge channel that has either started or stopped talking.
215  * \param started_talking set to 1 when this indicates the channel has started talking set to 0
216  * when this indicates the channel has stopped talking.
217  *
218  * \retval 0 on success.
219  * \retval -1 on error.
220  */
221 int ast_bridge_notify_talking(struct ast_bridge_channel *bridge_channel, int started_talking);
222
223 /*!
224  * \brief Suspend a bridge technology from consideration
225  *
226  * \param technology The bridge technology to suspend
227  *
228  * Example usage:
229  *
230  * \code
231  * ast_bridge_technology_suspend(&simple_bridge_tech);
232  * \endcode
233  *
234  * This suspends the bridge technology simple_bridge_tech from being considered
235  * when creating a new bridge. Existing bridges using the bridge technology
236  * are not affected.
237  */
238 void ast_bridge_technology_suspend(struct ast_bridge_technology *technology);
239
240 /*!
241  * \brief Unsuspend a bridge technology
242  *
243  * \param technology The bridge technology to unsuspend
244  *
245  * Example usage:
246  *
247  * \code
248  * ast_bridge_technology_unsuspend(&simple_bridge_tech);
249  * \endcode
250  *
251  * This makes the bridge technology simple_bridge_tech considered when
252  * creating a new bridge again.
253  */
254 void ast_bridge_technology_unsuspend(struct ast_bridge_technology *technology);
255
256 #if defined(__cplusplus) || defined(c_plusplus)
257 }
258 #endif
259
260 #endif /* _ASTERISK_BRIDGING_TECHNOLOGY_H */