8df19d9e97eebf354c9de3aad28bbf411a5e806d
[asterisk/asterisk.git] / include / asterisk / bridge_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          * \note The bridge technology must tollerate a failed to join channel
112          * until it can be kicked from the bridge.
113          */
114         int (*join)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
115         /*!
116          * \brief Remove a channel from a bridging technology instance for a bridge.
117          *
118          * \note On entry, bridge is already locked.
119          * \note Do not make assumptions about the number of channels in the bridge when
120          * this callback is called. When a channel is swapped into a bridge for another
121          * channel, the leave callback is called after the new channel has been added to
122          * the bridge.
123          */
124         void (*leave)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
125         /*!
126          * \brief Suspend a channel on a bridging technology instance for a bridge.
127          *
128          * \note On entry, bridge is already locked.
129          */
130         void (*suspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
131         /*!
132          * \brief Unsuspend a channel on a bridging technology instance for a bridge.
133          *
134          * \note On entry, bridge is already locked.
135          */
136         void (*unsuspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
137         /*!
138          * \brief Check if a bridge is compatible with the bridging technology.
139          *
140          * \retval 0 if not compatible
141          * \retval non-zero if compatible
142          *
143          * \note On entry, bridge may or may not already be locked.
144          * However, it can be accessed as if it were locked.
145          */
146         int (*compatible)(struct ast_bridge *bridge);
147         /*!
148          * \brief Write a frame into the bridging technology instance for a bridge.
149          *
150          * \note The bridge must be tolerant of bridge_channel being NULL.
151          *
152          * \retval 0 Frame accepted into the bridge.
153          * \retval -1 Frame needs to be deferred.
154          *
155          * \note On entry, bridge is already locked.
156          */
157         int (*write)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel, struct ast_frame *frame);
158         /*! TRUE if the bridge technology is currently suspended. */
159         unsigned int suspended:1;
160         /*! Module this bridge technology belongs to. It is used for reference counting bridges using the technology. */
161         struct ast_module *mod;
162         /*! Linked list information */
163         AST_RWLIST_ENTRY(ast_bridge_technology) entry;
164 };
165
166 /*!
167  * \brief Register a bridge technology for use
168  *
169  * \param technology The bridge technology to register
170  * \param mod The module that is registering the bridge technology
171  *
172  * \retval 0 on success
173  * \retval -1 on failure
174  *
175  * Example usage:
176  *
177  * \code
178  * ast_bridge_technology_register(&simple_bridge_tech);
179  * \endcode
180  *
181  * This registers a bridge technology declared as the structure
182  * simple_bridge_tech with the bridging core and makes it available for
183  * use when creating bridges.
184  */
185 int __ast_bridge_technology_register(struct ast_bridge_technology *technology, struct ast_module *mod);
186
187 /*! \brief See \ref __ast_bridge_technology_register() */
188 #define ast_bridge_technology_register(technology) __ast_bridge_technology_register(technology, AST_MODULE_SELF)
189
190 /*!
191  * \brief Unregister a bridge technology from use
192  *
193  * \param technology The bridge technology to unregister
194  *
195  * \retval 0 on success
196  * \retval -1 on failure
197  *
198  * Example usage:
199  *
200  * \code
201  * ast_bridge_technology_unregister(&simple_bridge_tech);
202  * \endcode
203  *
204  * This unregisters a bridge technlogy declared as the structure
205  * simple_bridge_tech with the bridging core. It will no longer be
206  * considered when creating a new bridge.
207  */
208 int ast_bridge_technology_unregister(struct ast_bridge_technology *technology);
209
210 /*!
211  * \brief Suspend a bridge technology from consideration
212  *
213  * \param technology The bridge technology to suspend
214  *
215  * Example usage:
216  *
217  * \code
218  * ast_bridge_technology_suspend(&simple_bridge_tech);
219  * \endcode
220  *
221  * This suspends the bridge technology simple_bridge_tech from being considered
222  * when creating a new bridge. Existing bridges using the bridge technology
223  * are not affected.
224  */
225 void ast_bridge_technology_suspend(struct ast_bridge_technology *technology);
226
227 /*!
228  * \brief Unsuspend a bridge technology
229  *
230  * \param technology The bridge technology to unsuspend
231  *
232  * Example usage:
233  *
234  * \code
235  * ast_bridge_technology_unsuspend(&simple_bridge_tech);
236  * \endcode
237  *
238  * This makes the bridge technology simple_bridge_tech considered when
239  * creating a new bridge again.
240  */
241 void ast_bridge_technology_unsuspend(struct ast_bridge_technology *technology);
242
243 #if defined(__cplusplus) || defined(c_plusplus)
244 }
245 #endif
246
247 #endif /* _ASTERISK_BRIDGING_TECHNOLOGY_H */