Massively clean up app_queue.
[asterisk/asterisk.git] / include / asterisk / core_unreal.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013 Digium, Inc.
5  *
6  * Richard Mudgett <rmudgett@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 /*!
20  * \file
21  * \brief Unreal channel derivative framework.
22  *
23  * \author Richard Mudgett <rmudgett@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  */
28
29 #ifndef _ASTERISK_CORE_UNREAL_H
30 #define _ASTERISK_CORE_UNREAL_H
31
32 #include "asterisk/astobj2.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/bridge.h"
35 #include "asterisk/abstract_jb.h"
36
37 #if defined(__cplusplus) || defined(c_plusplus)
38 extern "C" {
39 #endif
40
41 /* Forward declare some struct names */
42 struct ast_format_cap;
43 struct ast_callid;
44
45 /* ------------------------------------------------------------------- */
46
47 struct ast_unreal_pvt;
48
49 enum ast_unreal_channel_indicator {
50         AST_UNREAL_OWNER,
51         AST_UNREAL_CHAN,
52 };
53
54 /*!
55  * \brief Callbacks that can be provided by concrete implementations of the unreal
56  * channel driver that will be called when events occur in the unreal layer
57  */
58 struct ast_unreal_pvt_callbacks {
59         /*!
60          * \brief Called when an optimization attempt has started
61          * \note p is locked when this callback is called
62          * \param p The \ref ast_unreal_pvt object
63          * \param source The channel that is optimizing into an unreal_pvt channel's bridge.
64          * If NULL, the optimization is being accomplished via a bridge merge.
65          * \param dest Indicator of which channel's bridge in the unreal_pvt will survive the
66          * optimization
67          * \param id Unique identifier for this optimization operation.
68          */
69         void (* const optimization_started)(struct ast_unreal_pvt *p, struct ast_channel *source,
70                         enum ast_unreal_channel_indicator dest, unsigned int id);
71
72         /*!
73          * \brief Called when an optimization attempt completed successfully
74          * \note p is locked when this callback is called
75          * \param p The \ref ast_unreal_pvt object
76          * \param success Non-zero if the optimization succeeded, zero if the optimization
77          * met with fatal and permanent error
78          * \param id Unique identifier for this optimization. Same as the one from the optimization_started
79          * call
80          */
81         void (* const optimization_finished)(struct ast_unreal_pvt *p, int success, unsigned int id);
82 };
83
84 /*!
85  * \brief The base pvt structure for local channel derivatives.
86  *
87  * The unreal pvt has two ast_chan objects - the "owner" and the "next channel", the outbound channel
88  *
89  * ast_chan owner -> ast_unreal_pvt -> ast_chan chan
90  */
91 struct ast_unreal_pvt {
92         struct ast_unreal_pvt_callbacks *callbacks; /*!< Event callbacks */
93         struct ast_channel *owner;                  /*!< Master Channel - ;1 side */
94         struct ast_channel *chan;                   /*!< Outbound channel - ;2 side */
95         struct ast_format_cap *reqcap;              /*!< Requested format capabilities */
96         struct ast_jb_conf jb_conf;                 /*!< jitterbuffer configuration */
97         unsigned int flags;                         /*!< Private option flags */
98         /*! Base name of the unreal channels.  exten@context or other name. */
99         char name[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 2];
100 };
101
102 #define AST_UNREAL_IS_OUTBOUND(a, b) ((a) == (b)->chan ? 1 : 0)
103
104 #define AST_UNREAL_CARETAKER_THREAD (1 << 0) /*!< The ;2 side launched a PBX, was pushed into a bridge, or was masqueraded into an application. */
105 #define AST_UNREAL_NO_OPTIMIZATION  (1 << 1) /*!< Do not optimize out the unreal channels */
106 #define AST_UNREAL_MOH_INTERCEPT    (1 << 2) /*!< Intercept and act on hold/unhold control frames */
107 #define AST_UNREAL_OPTIMIZE_BEGUN   (1 << 3) /*!< Indicates that an optimization attempt has been started */
108
109 /*!
110  * \brief Send an unreal pvt in with no locks held and get all locks
111  *
112  * \note NO locks should be held prior to calling this function
113  * \note The pvt must have a ref held before calling this function
114  * \note if outchan or outowner is set != NULL after calling this function
115  *       those channels are locked and reffed.
116  * \note Batman.
117  */
118 void ast_unreal_lock_all(struct ast_unreal_pvt *p, struct ast_channel **outchan, struct ast_channel **outowner);
119
120 /*!
121  * \brief Hangup one end (maybe both ends) of an unreal channel derivative.
122  * \since 12.0.0
123  *
124  * \param p Private channel struct (reffed)
125  * \param ast Channel being hung up.  (locked)
126  *
127  * \note Common hangup code for unreal channels.  Derived
128  * channels will need to deal with any additional resources.
129  *
130  * \retval 0 on success.
131  * \retval -1 on error.
132  */
133 int ast_unreal_hangup(struct ast_unreal_pvt *p, struct ast_channel *ast);
134
135 /*! Unreal channel framework struct ast_channel_tech.send_digit_begin callback */
136 int ast_unreal_digit_begin(struct ast_channel *ast, char digit);
137
138 /*! Unreal channel framework struct ast_channel_tech.send_digit_end callback */
139 int ast_unreal_digit_end(struct ast_channel *ast, char digit, unsigned int duration);
140
141 /*! Unreal channel framework struct ast_channel_tech.answer callback */
142 int ast_unreal_answer(struct ast_channel *ast);
143
144 /*! Unreal channel framework struct ast_channel_tech.read and struct ast_channel_tech.exception callback */
145 struct ast_frame *ast_unreal_read(struct ast_channel *ast);
146
147 /*! Unreal channel framework struct ast_channel_tech.write callback */
148 int ast_unreal_write(struct ast_channel *ast, struct ast_frame *f);
149
150 /*! Unreal channel framework struct ast_channel_tech.indicate callback */
151 int ast_unreal_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
152
153 /*! Unreal channel framework struct ast_channel_tech.fixup callback */
154 int ast_unreal_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
155
156 /*! Unreal channel framework struct ast_channel_tech.send_html callback */
157 int ast_unreal_sendhtml(struct ast_channel *ast, int subclass, const char *data, int datalen);
158
159 /*! Unreal channel framework struct ast_channel_tech.send_text callback */
160 int ast_unreal_sendtext(struct ast_channel *ast, const char *text);
161
162 /*! Unreal channel framework struct ast_channel_tech.queryoption callback */
163 int ast_unreal_queryoption(struct ast_channel *ast, int option, void *data, int *datalen);
164
165 /*! Unreal channel framework struct ast_channel_tech.setoption callback */
166 int ast_unreal_setoption(struct ast_channel *chan, int option, void *data, int datalen);
167
168 /*!
169  * \brief struct ast_unreal_pvt destructor.
170  * \since 12.0.0
171  *
172  * \param vdoomed Object to destroy.
173  *
174  * \return Nothing
175  */
176 void ast_unreal_destructor(void *vdoomed);
177
178 /*!
179  * \brief Allocate the base unreal struct for a derivative.
180  * \since 12.0.0
181  *
182  * \param size Size of the unreal struct to allocate.
183  * \param destructor Destructor callback.
184  * \param cap Format capabilities to give the unreal private struct.
185  *
186  * \retval pvt on success.
187  * \retval NULL on error.
188  */
189 struct ast_unreal_pvt *ast_unreal_alloc(size_t size, ao2_destructor_fn destructor, struct ast_format_cap *cap);
190
191 /*!
192  * \brief Create the semi1 and semi2 unreal channels.
193  * \since 12.0.0
194  *
195  * \param p Unreal channel private struct.
196  * \param tech Channel technology to use.
197  * \param semi1_state State to start the semi1(owner) channel in.
198  * \param semi2_state State to start the semi2(outgoing chan) channel in.
199  * \param exten Exten to start the chennels in. (NULL if s)
200  * \param context Context to start the channels in. (NULL if default)
201  * \param requestor Channel requesting creation. (NULL if none)
202  * \param callid Thread callid to use.
203  *
204  * \retval semi1_channel on success.
205  * \retval NULL on error.
206  */
207 struct ast_channel *ast_unreal_new_channels(struct ast_unreal_pvt *p,
208         const struct ast_channel_tech *tech, int semi1_state, int semi2_state,
209         const char *exten, const char *context, const struct ast_channel *requestor,
210         struct ast_callid *callid);
211
212 /*!
213  * \brief Setup unreal owner and chan channels before initiating call.
214  * \since 12.0.0
215  *
216  * \param semi1 Owner channel of unreal channel pair.
217  * \param semi2 Outgoing channel of unreal channel pair.
218  *
219  * \note On entry, the semi1 and semi2 channels are already locked.
220  *
221  * \return Nothing
222  */
223 void ast_unreal_call_setup(struct ast_channel *semi1, struct ast_channel *semi2);
224
225 /*!
226  * \brief Push the semi2 unreal channel into a bridge from either member of the unreal pair
227  * \since 12.0.0
228  *
229  * \param ast A member of the unreal channel being pushed
230  * \param bridge Which bridge we want to push the channel to
231  * \param flags Feature flags to be set on the bridge channel.
232  *
233  * \retval 0 if the channel is successfully imparted onto the bridge
234  * \retval -1 on failure
235  *
236  * \note This is equivalent to ast_call() on unreal based channel drivers that are designed to use it instead.
237  */
238 int ast_unreal_channel_push_to_bridge(struct ast_channel *ast, struct ast_bridge *bridge, unsigned int flags);
239
240 /* ------------------------------------------------------------------- */
241
242 #if defined(__cplusplus) || defined(c_plusplus)
243 }
244 #endif
245
246 #endif  /* _ASTERISK_CORE_UNREAL_H */