bridge_features: Support One touch Monitor/MixMonitor
[asterisk/asterisk.git] / include / asterisk / features_config.h
1 /*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2013, Digium, Inc.
5 *
6 * Mark Michelson <mmichelson@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 #ifndef _FEATURES_CONFIG_H
20 #define _FEATURES_CONFIG_H
21
22 #include "asterisk/stringfields.h"
23
24 struct ast_channel;
25
26 /*!
27  * \brief General features configuration items
28  */
29 struct ast_features_general_config {
30         AST_DECLARE_STRING_FIELDS(
31                 /*! Sound played when automon or automixmon features are used */
32                 AST_STRING_FIELD(courtesytone);
33                 /*! Sound played when automon or automixmon features fail when used */
34                 AST_STRING_FIELD(recordingfailsound);
35         );
36         /*! Milliseconds allowed between digit presses when entering feature code */
37         unsigned int featuredigittimeout;
38 };
39
40 /*!
41  * \brief Get the general configuration options for a channel
42  *
43  * \note The channel should be locked before calling this function.
44  * \note The returned value has its reference count incremented.
45  *
46  * If no channel is provided, then the global features configuration is returned.
47  *
48  * \param chan The channel to get configuration options for
49  * \retval NULL Failed to get configuration
50  * \retval non-NULL The general features configuration
51  */
52 struct ast_features_general_config *ast_get_chan_features_general_config(struct ast_channel *chan);
53
54 /*!
55  * \brief Feature configuration relating to transfers
56  */
57 struct ast_features_xfer_config {
58         AST_DECLARE_STRING_FIELDS (
59                 /*! Sound to play when transfer succeeds */
60                 AST_STRING_FIELD(xfersound);
61                 /*! Sound to play when transfer fails */
62                 AST_STRING_FIELD(xferfailsound);
63                 /*! DTMF sequence used to abort an attempted atxfer */
64                 AST_STRING_FIELD(atxferabort);
65                 /*! DTMF sequence used to complete an attempted atxfer */
66                 AST_STRING_FIELD(atxfercomplete);
67                 /*! DTMF sequence used to turn an attempted atxfer into a three-way call */
68                 AST_STRING_FIELD(atxferthreeway);
69         );
70         /*! Milliseconds allowed between digit presses when dialing transfer destination */
71         unsigned int transferdigittimeout;
72         /*! Milliseconds to wait for the transfer target to answer a transferred call */
73         unsigned int atxfernoanswertimeout;
74         /*! Milliseconds to wait before attempting to re-dial the transfer target */
75         unsigned int atxferloopdelay;
76         /*! Number of times to re-attempt dialing the transfer target */
77         unsigned int atxfercallbackretries;
78         /*! Determines if the call is dropped on attended transfer failure */
79         unsigned int atxferdropcall;
80 };
81
82 /*!
83  * \brief Get the transfer configuration options for a channel
84  *
85  * \note The channel should be locked before calling this function.
86  * \note The returned value has its reference count incremented.
87  *
88  * If no channel is provided, then the global transfer configuration is returned.
89  *
90  * \param chan The channel to get configuration options for
91  * \retval NULL Failed to get configuration
92  * \retval non-NULL The transfer features configuration
93  */
94 struct ast_features_xfer_config *ast_get_chan_features_xfer_config(struct ast_channel *chan);
95
96 /*!
97  * \brief Configuration relating to call pickup
98  */
99 struct ast_features_pickup_config {
100         AST_DECLARE_STRING_FIELDS (
101                 /*! Digit sequence to press to pick up a ringing call */
102                 AST_STRING_FIELD(pickupexten);
103                 /*! Sound to play to picker when pickup succeeds */
104                 AST_STRING_FIELD(pickupsound);
105                 /*! Sound to play to picker when pickup fails */
106                 AST_STRING_FIELD(pickupfailsound);
107         );
108 };
109
110 /*!
111  * \brief Get the pickup configuration options for a channel
112  *
113  * \note The channel should be locked before calling this function.
114  * \note The returned value has its reference count incremented.
115  *
116  * If no channel is provided, then the global pickup configuration is returned.
117  *
118  * \param chan The channel to get configuration options for
119  * \retval NULL Failed to get configuration
120  * \retval non-NULL The pickup features configuration
121  */
122 struct ast_features_pickup_config *ast_get_chan_features_pickup_config(struct ast_channel *chan);
123
124 /*!
125  * \brief Configuration for the builtin features
126  */
127 struct ast_featuremap_config {
128         AST_DECLARE_STRING_FIELDS (
129                 /*! Blind transfer DTMF code */
130                 AST_STRING_FIELD(blindxfer);
131                 /*! Disconnect DTMF code */
132                 AST_STRING_FIELD(disconnect);
133                 /*! Automon DTMF code */
134                 AST_STRING_FIELD(automon);
135                 /*! Attended Transfer DTMF code */
136                 AST_STRING_FIELD(atxfer);
137                 /*! One-touch parking DTMF code */
138                 AST_STRING_FIELD(parkcall);
139                 /*! Automixmon DTMF code */
140                 AST_STRING_FIELD(automixmon);
141         );
142 };
143
144 /*!
145  * \brief Get the featuremap configuration options for a channel
146  *
147  * \note The channel should be locked before calling this function.
148  * \note The returned value has its reference count incremented.
149  *
150  * If no channel is provided, then the global featuremap configuration is returned.
151  *
152  * \param chan The channel to get configuration options for
153  * \retval NULL Failed to get configuration
154  * \retval non-NULL The pickup features configuration
155  */
156 struct ast_featuremap_config *ast_get_chan_featuremap_config(struct ast_channel *chan);
157
158 /*!
159  * \brief Get the DTMF code for a builtin feature
160  *
161  * \note The channel should be locked before calling this function
162  *
163  * If no channel is provided, then the global setting for the option is returned.
164  *
165  * \param chan The channel to get the option from
166  * \param feature The short name of the feature (as it appears in features.conf)
167  * \param[out] buf The buffer to write the DTMF value into
168  * \param size The size of the buffer in bytes
169  * \retval 0 Success
170  * \retval non-zero Unrecognized builtin feature name
171  */
172 int ast_get_builtin_feature(struct ast_channel *chan, const char *feature, char *buf, size_t len);
173
174 /*!
175  * \brief Get the DTMF code for a call feature
176  *
177  * \note The channel should be locked before calling this function
178  *
179  * If no channel is provided, then the global setting for the option is returned.
180  *
181  * This function is like \ref ast_get_builtin_feature except that it will
182  * also check the applicationmap in addition to the builtin features.
183  *
184  * \param chan The channel to get the option from
185  * \param feature The short name of the feature
186  * \param[out] buf The buffer to write the DTMF value into
187  * \param size The size of the buffer in bytes
188  * \retval 0 Success
189  * \retval non-zero Unrecognized feature name
190  */
191 int ast_get_feature(struct ast_channel *chan, const char *feature, char *buf, size_t len);
192
193 #define AST_FEATURE_MAX_LEN 11
194
195 /*!
196  * \brief An applicationmap configuration item
197  */
198 struct ast_applicationmap_item {
199         AST_DECLARE_STRING_FIELDS (
200                 /* Name of the item */
201                 AST_STRING_FIELD(name);
202                 /* Name Dialplan application that is invoked by the feature */
203                 AST_STRING_FIELD(app);
204                 /* Data to pass to the application */
205                 AST_STRING_FIELD(app_data);
206                 /* Music-on-hold class to play to party on which feature is not activated */
207                 AST_STRING_FIELD(moh_class);
208         );
209         /* DTMF key sequence used to activate the feature */
210         char dtmf[AST_FEATURE_MAX_LEN];
211         /* If true, activate on party that input the sequence, otherwise activate on the other party */
212         unsigned int activate_on_self;
213 };
214
215 /*!
216  * \brief Get the applicationmap for a given channel.
217  *
218  * \note The channel should be locked before calling this function.
219  *
220  * This uses the value of the DYNAMIC_FEATURES channel variable to build a
221  * custom applicationmap for this channel. The returned container has
222  * applicationmap_items inside.
223  *
224  * \param chan The channel for which applicationmap is being retrieved.
225  * \retval NULL An error occurred or the channel has no dynamic features.
226  * \retval non-NULL A container of applicationmap_items pertaining to the channel.
227  */
228 struct ao2_container *ast_get_chan_applicationmap(struct ast_channel *chan);
229
230 void ast_features_config_shutdown(void);
231
232 int ast_features_config_reload(void);
233
234 int ast_features_config_init(void);
235
236 #endif /* _FEATURES_CONFIG_H */