Fix a crash when a bridge switches from the softmix bridge technology to another.
[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 that is the essence of a bridge technology
46  */
47 struct ast_bridge_technology {
48         /*! Unique name to this bridge technology */
49         const char *name;
50         /*! The capabilities that this bridge technology is capable of.  This has nothing to do with
51          * format capabilities. */
52         uint32_t capabilities;
53         /*! Preference level that should be used when determining whether to use this bridge technology or not */
54         enum ast_bridge_preference preference;
55         /*!
56          * \brief Create a bridge technology instance for a bridge.
57          *
58          * \retval 0 on success
59          * \retval -1 on failure
60          *
61          * \note On entry, bridge may or may not already be locked.
62          * However, it can be accessed as if it were locked.
63          */
64         int (*create)(struct ast_bridge *bridge);
65         /*!
66          * \brief Request a bridge technology instance stop in preparation for being destroyed.
67          *
68          * \note On entry, bridge is already locked.
69          */
70         void (*stop)(struct ast_bridge *bridge);
71         /*!
72          * \brief Destroy a bridging technology instance for a bridge.
73          *
74          * \note On entry, bridge must NOT be locked.
75          */
76         void (*destroy)(struct ast_bridge *bridge);
77         /*!
78          * \brief Add a channel to a bridging technology instance for a bridge.
79          *
80          * \retval 0 on success
81          * \retval -1 on failure
82          *
83          * \note On entry, bridge is already locked.
84          */
85         int (*join)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
86         /*!
87          * \brief Remove a channel from a bridging technology instance for a bridge.
88          *
89          * \note On entry, bridge is already locked.
90          */
91         void (*leave)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
92         /*!
93          * \brief Suspend a channel on a bridging technology instance for a bridge.
94          *
95          * \note On entry, bridge is already locked.
96          */
97         void (*suspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
98         /*!
99          * \brief Unsuspend a channel on a bridging technology instance for a bridge.
100          *
101          * \note On entry, bridge is already locked.
102          */
103         void (*unsuspend)(struct ast_bridge *bridge, struct ast_bridge_channel *bridge_channel);
104         /*!
105          * \brief Check if a bridge is compatible with the bridging technology.
106          *
107          * \retval 0 if not compatible
108          * \retval non-zero if compatible
109          */
110         int (*compatible)(struct ast_bridge *bridge);
111         /*!
112          * \brief Write a frame into the bridging technology instance for a bridge.
113          *
114          * \retval 0 on success
115          * \retval -1 on failure
116          *
117          * \note On entry, bridge is already locked.
118          */
119         int (*write)(struct ast_bridge *bridge, struct ast_bridge_channel *bridged_channel, struct ast_frame *frame);
120         /*! Formats that the bridge technology supports */
121         struct ast_format_cap *format_capabilities;
122         /*! TRUE if the bridge technology is currently suspended. */
123         unsigned int suspended:1;
124         /*! Module this bridge technology belongs to. It is used for reference counting bridges using the technology. */
125         struct ast_module *mod;
126         /*! Linked list information */
127         AST_RWLIST_ENTRY(ast_bridge_technology) entry;
128 };
129
130 /*!
131  * \brief Register a bridge technology for use
132  *
133  * \param technology The bridge technology to register
134  * \param mod The module that is registering the bridge technology
135  *
136  * \retval 0 on success
137  * \retval -1 on failure
138  *
139  * Example usage:
140  *
141  * \code
142  * ast_bridge_technology_register(&simple_bridge_tech);
143  * \endcode
144  *
145  * This registers a bridge technology declared as the structure
146  * simple_bridge_tech with the bridging core and makes it available for
147  * use when creating bridges.
148  */
149 int __ast_bridge_technology_register(struct ast_bridge_technology *technology, struct ast_module *mod);
150
151 /*! \brief See \ref __ast_bridge_technology_register() */
152 #define ast_bridge_technology_register(technology) __ast_bridge_technology_register(technology, ast_module_info->self)
153
154 /*!
155  * \brief Unregister a bridge technology from use
156  *
157  * \param technology The bridge technology to unregister
158  *
159  * \retval 0 on success
160  * \retval -1 on failure
161  *
162  * Example usage:
163  *
164  * \code
165  * ast_bridge_technology_unregister(&simple_bridge_tech);
166  * \endcode
167  *
168  * This unregisters a bridge technlogy declared as the structure
169  * simple_bridge_tech with the bridging core. It will no longer be
170  * considered when creating a new bridge.
171  */
172 int ast_bridge_technology_unregister(struct ast_bridge_technology *technology);
173
174 /*!
175  * \brief Lets the bridging indicate when a bridge channel has stopped or started talking.
176  *
177  * \note All DSP functionality on the bridge has been pushed down to the lowest possible
178  * layer, which in this case is the specific bridging technology being used. Since it
179  * is necessary for the knowledge of which channels are talking to make its way up to the
180  * application, this function has been created to allow the bridging technology to communicate
181  * that information with the bridging core.
182  *
183  * \param bridge_channel The bridge channel that has either started or stopped talking.
184  * \param started_talking set to 1 when this indicates the channel has started talking set to 0
185  * when this indicates the channel has stopped talking.
186  */
187 void ast_bridge_notify_talking(struct ast_bridge_channel *bridge_channel, int started_talking);
188
189 /*!
190  * \brief Suspend a bridge technology from consideration
191  *
192  * \param technology The bridge technology to suspend
193  *
194  * Example usage:
195  *
196  * \code
197  * ast_bridge_technology_suspend(&simple_bridge_tech);
198  * \endcode
199  *
200  * This suspends the bridge technology simple_bridge_tech from being considered
201  * when creating a new bridge. Existing bridges using the bridge technology
202  * are not affected.
203  */
204 void ast_bridge_technology_suspend(struct ast_bridge_technology *technology);
205
206 /*!
207  * \brief Unsuspend a bridge technology
208  *
209  * \param technology The bridge technology to unsuspend
210  *
211  * Example usage:
212  *
213  * \code
214  * ast_bridge_technology_unsuspend(&simple_bridge_tech);
215  * \endcode
216  *
217  * This makes the bridge technology simple_bridge_tech considered when
218  * creating a new bridge again.
219  */
220 void ast_bridge_technology_unsuspend(struct ast_bridge_technology *technology);
221
222 #if defined(__cplusplus) || defined(c_plusplus)
223 }
224 #endif
225
226 #endif /* _ASTERISK_BRIDGING_TECHNOLOGY_H */