Resolve issues in ConfBridge regarding marked, waitmarked, and unmarked users
[asterisk/asterisk.git] / apps / confbridge / include / confbridge.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2011, Digium, Inc.
5  *
6  * David Vossel <dvossel@digium.com>
7  * Joshua Colp <jcolp@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20
21 #ifndef _CONFBRIDGE_H
22 #define _CONFBRIDGE_H
23
24 #include "asterisk.h"
25 #include "asterisk/app.h"
26 #include "asterisk/logger.h"
27 #include "asterisk/linkedlists.h"
28 #include "asterisk/channel.h"
29 #include "asterisk/bridging.h"
30 #include "asterisk/bridging_features.h"
31 #include "conf_state.h"
32
33 /* Maximum length of a conference bridge name */
34 #define MAX_CONF_NAME 32
35 /* Maximum length of a conference pin */
36 #define MAX_PIN     80
37
38 #define DEFAULT_USER_PROFILE "default_user"
39 #define DEFAULT_BRIDGE_PROFILE "default_bridge"
40
41 #define DEFAULT_TALKING_THRESHOLD 160
42 #define DEFAULT_SILENCE_THRESHOLD 2500
43
44 enum user_profile_flags {
45         USER_OPT_ADMIN =        (1 << 0), /*!< Set if the caller is an administrator */
46         USER_OPT_NOONLYPERSON = (1 << 1), /*!< Set if the "you are currently the only person in this conference" sound file should not be played */
47         USER_OPT_MARKEDUSER =   (1 << 2), /*!< Set if the caller is a marked user */
48         USER_OPT_STARTMUTED =   (1 << 3), /*!< Set if the caller should be initially set muted */
49         USER_OPT_MUSICONHOLD =  (1 << 4), /*!< Set if music on hold should be played if nobody else is in the conference bridge */
50         USER_OPT_QUIET =        (1 << 5), /*!< Set if no audio prompts should be played */
51         USER_OPT_ANNOUNCEUSERCOUNT = (1 << 6), /*!< Set if the number of users should be announced to the caller */
52         USER_OPT_WAITMARKED =   (1 << 7), /*!< Set if the user must wait for a marked user before starting */
53         USER_OPT_ENDMARKED =    (1 << 8), /*!< Set if the user should be kicked after the last Marked user exits */
54         USER_OPT_DENOISE =      (1 << 9), /*!< Sets if denoise filter should be used on audio before mixing. */
55         USER_OPT_ANNOUNCE_JOIN_LEAVE = (1 << 10), /*!< Sets if the user's name should be recorded and announced on join and leave. */
56         USER_OPT_TALKER_DETECT = (1 << 11), /*!< Sets if start and stop talking events should generated for this user over AMI. */
57         USER_OPT_DROP_SILENCE =  (1 << 12), /*!< Sets if silence should be dropped from the mix or not. */
58         USER_OPT_DTMF_PASS    =  (1 << 13), /*!< Sets if dtmf should be passed into the conference or not */
59         USER_OPT_ANNOUNCEUSERCOUNTALL = (1 << 14), /*!< Sets if the number of users should be announced to everyone. */
60         USER_OPT_JITTERBUFFER =  (1 << 15), /*!< Places a jitterbuffer on the user. */
61 };
62
63 enum bridge_profile_flags {
64         BRIDGE_OPT_RECORD_CONFERENCE = (1 << 0), /*!< Set if the conference should be recorded */
65         BRIDGE_OPT_VIDEO_SRC_LAST_MARKED = (1 << 1), /*!< Set if conference should feed video of last marked user to all participants. */
66         BRIDGE_OPT_VIDEO_SRC_FIRST_MARKED = (1 << 2), /*!< Set if conference should feed video of first marked user to all participants. */
67         BRIDGE_OPT_VIDEO_SRC_FOLLOW_TALKER = (1 << 3), /*!< Set if conference set the video feed to follow the loudest talker.  */
68 };
69
70 enum conf_menu_action_id {
71         MENU_ACTION_TOGGLE_MUTE = 1,
72         MENU_ACTION_PLAYBACK,
73         MENU_ACTION_PLAYBACK_AND_CONTINUE,
74         MENU_ACTION_INCREASE_LISTENING,
75         MENU_ACTION_DECREASE_LISTENING,
76         MENU_ACTION_RESET_LISTENING,
77         MENU_ACTION_RESET_TALKING,
78         MENU_ACTION_INCREASE_TALKING,
79         MENU_ACTION_DECREASE_TALKING,
80         MENU_ACTION_DIALPLAN_EXEC,
81         MENU_ACTION_ADMIN_TOGGLE_LOCK,
82         MENU_ACTION_ADMIN_KICK_LAST,
83         MENU_ACTION_LEAVE,
84         MENU_ACTION_NOOP,
85         MENU_ACTION_SET_SINGLE_VIDEO_SRC,
86         MENU_ACTION_RELEASE_SINGLE_VIDEO_SRC,
87         MENU_ACTION_PARTICIPANT_COUNT,
88         MENU_ACTION_ADMIN_TOGGLE_MUTE_PARTICIPANTS,
89 };
90
91 /*! The conference menu action contains both
92  *  the action id that represents the action that
93  *  must take place, along with any data associated
94  *  with that action. */
95 struct conf_menu_action {
96         enum conf_menu_action_id id;
97         union {
98                 char playback_file[PATH_MAX];
99                 struct {
100                         char context[AST_MAX_CONTEXT];
101                         char exten[AST_MAX_EXTENSION];
102                         int priority;
103                 } dialplan_args;
104         } data;
105         AST_LIST_ENTRY(conf_menu_action) action;
106 };
107
108 /*! Conference menu entries contain the DTMF sequence
109  *  and the list of actions that are associated with that
110  *  sequence. */
111 struct conf_menu_entry {
112         /*! the DTMF sequence that triggers the actions */
113         char dtmf[MAXIMUM_DTMF_FEATURE_STRING];
114         /*! The actions associated with this menu entry. */
115         AST_LIST_HEAD_NOLOCK(, conf_menu_action) actions;
116         AST_LIST_ENTRY(conf_menu_entry) entry;
117 };
118
119 /*! Conference menu structure.  Contains a list
120  * of DTMF sequences coupled with the actions those
121  * sequences invoke.*/
122 struct conf_menu {
123         char name[128];
124         AST_LIST_HEAD_NOLOCK(, conf_menu_entry) entries;
125 };
126
127 struct user_profile {
128         char name[128];
129         char pin[MAX_PIN];
130         char moh_class[128];
131         char announcement[PATH_MAX];
132         unsigned int flags;
133         unsigned int announce_user_count_all_after;
134         /*! The time in ms of talking before a user is considered to be talking by the dsp. */
135         unsigned int talking_threshold;
136         /*! The time in ms of silence before a user is considered to be silent by the dsp. */
137         unsigned int silence_threshold;
138 };
139
140 enum conf_sounds {
141         CONF_SOUND_HAS_JOINED,
142         CONF_SOUND_HAS_LEFT,
143         CONF_SOUND_KICKED,
144         CONF_SOUND_MUTED,
145         CONF_SOUND_UNMUTED,
146         CONF_SOUND_ONLY_ONE,
147         CONF_SOUND_THERE_ARE,
148         CONF_SOUND_OTHER_IN_PARTY,
149         CONF_SOUND_PLACE_IN_CONF,
150         CONF_SOUND_WAIT_FOR_LEADER,
151         CONF_SOUND_LEADER_HAS_LEFT,
152         CONF_SOUND_GET_PIN,
153         CONF_SOUND_INVALID_PIN,
154         CONF_SOUND_ONLY_PERSON,
155         CONF_SOUND_LOCKED,
156         CONF_SOUND_LOCKED_NOW,
157         CONF_SOUND_UNLOCKED_NOW,
158         CONF_SOUND_ERROR_MENU,
159         CONF_SOUND_JOIN,
160         CONF_SOUND_LEAVE,
161         CONF_SOUND_PARTICIPANTS_MUTED,
162         CONF_SOUND_PARTICIPANTS_UNMUTED,
163 };
164
165 struct bridge_profile_sounds {
166         AST_DECLARE_STRING_FIELDS(
167                 AST_STRING_FIELD(hasjoin);
168                 AST_STRING_FIELD(hasleft);
169                 AST_STRING_FIELD(kicked);
170                 AST_STRING_FIELD(muted);
171                 AST_STRING_FIELD(unmuted);
172                 AST_STRING_FIELD(onlyone);
173                 AST_STRING_FIELD(thereare);
174                 AST_STRING_FIELD(otherinparty);
175                 AST_STRING_FIELD(placeintoconf);
176                 AST_STRING_FIELD(waitforleader);
177                 AST_STRING_FIELD(leaderhasleft);
178                 AST_STRING_FIELD(getpin);
179                 AST_STRING_FIELD(invalidpin);
180                 AST_STRING_FIELD(onlyperson);
181                 AST_STRING_FIELD(locked);
182                 AST_STRING_FIELD(lockednow);
183                 AST_STRING_FIELD(unlockednow);
184                 AST_STRING_FIELD(errormenu);
185                 AST_STRING_FIELD(leave);
186                 AST_STRING_FIELD(join);
187                 AST_STRING_FIELD(participantsmuted);
188                 AST_STRING_FIELD(participantsunmuted);
189         );
190 };
191
192 struct bridge_profile {
193         char name[64];
194         char rec_file[PATH_MAX];
195         unsigned int flags;
196         unsigned int max_members;          /*!< The maximum number of participants allowed in the conference */
197         unsigned int internal_sample_rate; /*!< The internal sample rate of the bridge. 0 when set to auto adjust mode. */
198         unsigned int mix_interval;  /*!< The internal mixing interval used by the bridge. When set to 0 the bridgewill use a default interval. */
199         struct bridge_profile_sounds *sounds;
200 };
201
202 /*! \brief The structure that represents a conference bridge */
203 struct conference_bridge {
204         char name[MAX_CONF_NAME];                                         /*!< Name of the conference bridge */
205         struct conference_state *state;                                   /*!< Conference state information */
206         struct ast_bridge *bridge;                                        /*!< Bridge structure doing the mixing */
207         struct bridge_profile b_profile;                                  /*!< The Bridge Configuration Profile */
208         unsigned int activeusers;                                         /*!< Number of active users present */
209         unsigned int markedusers;                                         /*!< Number of marked users present */
210         unsigned int waitingusers;                                        /*!< Number of waiting users present */
211         unsigned int locked:1;                                            /*!< Is this conference bridge locked? */
212         unsigned int muted:1;                                            /*!< Is this conference bridge muted? */
213         unsigned int record_state:2;                                      /*!< Whether recording is started, stopped, or should exit */
214         struct ast_channel *playback_chan;                                /*!< Channel used for playback into the conference bridge */
215         struct ast_channel *record_chan;                                  /*!< Channel used for recording the conference */
216         pthread_t record_thread;                                          /*!< The thread the recording chan lives in */
217         ast_mutex_t playback_lock;                                        /*!< Lock used for playback channel */
218         ast_mutex_t record_lock;                                          /*!< Lock used for the record thread */
219         ast_cond_t record_cond;                                           /*!< Recording condition variable */
220         AST_LIST_HEAD_NOLOCK(, conference_bridge_user) active_list;       /*!< List of users participating in the conference bridge */
221         AST_LIST_HEAD_NOLOCK(, conference_bridge_user) waiting_list;      /*!< List of users waiting to join the conference bridge */
222 };
223
224 struct post_join_action {
225         int (*func)(struct conference_bridge_user *);
226         AST_LIST_ENTRY(post_join_action) list;
227 };
228
229 /*! \brief The structure that represents a conference bridge user */
230 struct conference_bridge_user {
231         struct conference_bridge *conference_bridge; /*!< Conference bridge they are participating in */
232         struct bridge_profile b_profile;             /*!< The Bridge Configuration Profile */
233         struct user_profile u_profile;               /*!< The User Configuration Profile */
234         char menu_name[64];                          /*!< The name of the DTMF menu assigned to this user */
235         char name_rec_location[PATH_MAX];            /*!< Location of the User's name recorded file if it exists */
236         struct ast_channel *chan;                    /*!< Asterisk channel participating */
237         struct ast_bridge_features features;         /*!< Bridge features structure */
238         struct ast_bridge_tech_optimizations tech_args; /*!< Bridge technology optimizations for talk detection */
239         unsigned int kicked:1;                       /*!< User has been kicked from the conference */
240         unsigned int playing_moh:1;                  /*!< MOH is currently being played to the user */
241         AST_LIST_HEAD_NOLOCK(, post_join_action) post_join_list; /*!< List of sounds to play after joining */;
242         AST_LIST_ENTRY(conference_bridge_user) list; /*!< Linked list information */
243 };
244
245 /*! \brief load confbridge.conf file */
246 int conf_load_config(int reload);
247
248 /*! \brief destroy the information loaded from the confbridge.conf file*/
249 void conf_destroy_config(void);
250
251 /*!
252  * \brief find a user profile given a user profile's name and store
253  * that profile in result structure.
254  *
255  * \details This function first attempts to find any custom user
256  * profile that might exist on a channel datastore, if that doesn't
257  * exist it looks up the provided user profile name, if that doesn't
258  * exist either the default_user profile is used.
259
260  * \retval user profile on success
261  * \retval NULL on failure
262  */
263 const struct user_profile *conf_find_user_profile(struct ast_channel *chan, const char *user_profile_name, struct user_profile *result);
264
265 /*!
266  * \brief Find a bridge profile
267  *
268  * \details Any bridge profile found using this function must be
269  * destroyed using conf_bridge_profile_destroy.  This function first
270  * attempts to find any custom bridge profile that might exist on
271  * a channel datastore, if that doesn't exist it looks up the
272  * provided bridge profile name, if that doesn't exist either
273  * the default_bridge profile is used.
274  *
275  * \retval Bridge profile on success
276  * \retval NULL on failure
277  */
278 const struct bridge_profile *conf_find_bridge_profile(struct ast_channel *chan, const char *bridge_profile_name, struct bridge_profile *result);
279
280 /*!
281  * \brief Destroy a bridge profile found by 'conf_find_bridge_profile'
282  */
283 void conf_bridge_profile_destroy(struct bridge_profile *b_profile);
284
285 /*!
286  * \brief copies a bridge profile
287  * \note conf_bridge_profile_destroy must be called on the dst structure
288  */
289 void conf_bridge_profile_copy(struct bridge_profile *dst, struct bridge_profile *src);
290
291 /*!
292  * \brief Set a DTMF menu to a conference user by menu name.
293  *
294  * \retval 0 on success, menu was found and set
295  * \retval -1 on error, menu was not found
296  */
297 int conf_set_menu_to_user(const char *menu_name, struct conference_bridge_user *conference_bridge_user);
298
299 /*!
300  * \brief Finds a menu_entry in a menu structure matched by DTMF sequence.
301  *
302  * \note the menu entry found must be destroyed using conf_menu_entry_destroy()
303  *
304  * \retval 1 success, entry is found and stored in result
305  * \retval 0 failure, no entry found for given DTMF sequence
306  */
307 int conf_find_menu_entry_by_sequence(const char *dtmf_sequence, struct conf_menu *menu, struct conf_menu_entry *result);
308
309 /*!
310  * \brief Destroys and frees all the actions stored in a menu_entry structure
311  */
312 void conf_menu_entry_destroy(struct conf_menu_entry *menu_entry);
313
314 /*!
315  * \brief Once a DTMF sequence matches a sequence in the user's DTMF menu, this function will get
316  * called to perform the menu action.
317  *
318  * \param bridge_channel Bridged channel this is involving
319  * \param conference_bridge_user the conference user to perform the action on.
320  * \param menu_entry the menu entry that invoked this callback to occur.
321  * \param menu an AO2 referenced pointer to the entire menu structure the menu_entry
322  *        derived from.
323  *
324  * \note The menu_entry is a deep copy of the entry found in the menu structure.  This allows
325  * for the menu_entry to be accessed without requiring the menu lock.  If the menu must
326  * be accessed, the menu lock must be held.  Reference counting of the menu structure is
327  * handled outside of the scope of this function.
328  *
329  * \retval 0 success
330  * \retval -1 failure
331  */
332 int conf_handle_dtmf(
333         struct ast_bridge_channel *bridge_channel,
334         struct conference_bridge_user *conference_bridge_user,
335         struct conf_menu_entry *menu_entry,
336         struct conf_menu *menu);
337
338
339 /*! \brief Looks to see if sound file is stored in bridge profile sounds, if not
340  *  default sound is provided.*/
341 const char *conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds *custom_sounds);
342
343 int func_confbridge_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value);
344
345 /*!
346  * \brief Play sound file into conference bridge
347  *
348  * \param conference_bridge The conference bridge to play sound file into
349  * \param filename Sound file to play
350  *
351  * \retval 0 success
352  * \retval -1 failure
353  */
354 int play_sound_file(struct conference_bridge *conference_bridge, const char *filename);
355
356 /*! \brief Callback to be called when the conference has become empty
357  * \param conference_bridge The conference bridge
358  */
359 void conf_ended(struct conference_bridge *conference_bridge);
360
361 /*! \brief Attempt to mute/play MOH to the only user in the conference if they require it
362  * \param conference_bridge A conference bridge containing a single user
363  */
364 void conf_mute_only_active(struct conference_bridge *conference_bridge);
365
366 /*! \brief Callback to execute any time we transition from zero to one marked users
367  * \param cbu The first marked user joining the conference
368  * \retval 0 success
369  * \retval -1 failure
370  */
371 int conf_handle_first_marked_common(struct conference_bridge_user *cbu);
372
373 /*! \brief Callback to execute any time we transition from zero to one active users
374  * \param conference_bridge The conference bridge with a single active user joined
375  * \retval 0 success
376  * \retval -1 failure
377  */
378 void conf_handle_first_join(struct conference_bridge *conference_bridge);
379
380 /*! \brief Handle actions every time a waitmarked user joins w/o a marked user present
381  * \param cbu The waitmarked user
382  * \retval 0 success
383  * \retval -1 failure
384  */
385 int conf_handle_inactive_waitmarked(struct conference_bridge_user *cbu);
386
387 /*! \brief Handle actions whenever an unmarked user joins an inactive conference
388  * \note These actions seem like they could apply just as well to a marked user
389  * and possibly be made to happen any time transitioning to a single state.
390  *
391  * \param cbu The unmarked user
392  */
393 int conf_handle_only_unmarked(struct conference_bridge_user *cbu);
394
395 /*! \brief Handle when a conference moves to having more than one active participant
396  * \param conference_bridge The conference bridge with more than one active participant
397  */
398 void conf_handle_second_active(struct conference_bridge *conference_bridge);
399
400 /*! \brief Add a conference bridge user as an unmarked active user of the conference
401  * \param conference_bridge The conference bridge to add the user to
402  * \param cbu The conference bridge user to add to the conference
403  */
404 void conf_add_user_active(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
405
406 /*! \brief Add a conference bridge user as a marked active user of the conference
407  * \param conference_bridge The conference bridge to add the user to
408  * \param cbu The conference bridge user to add to the conference
409  */
410 void conf_add_user_marked(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
411
412 /*! \brief Add a conference bridge user as an waiting user of the conference
413  * \param conference_bridge The conference bridge to add the user to
414  * \param cbu The conference bridge user to add to the conference
415  */
416 void conf_add_user_waiting(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
417
418 /*! \brief Remove a conference bridge user from the unmarked active conference users in the conference
419  * \param conference_bridge The conference bridge to remove the user from
420  * \param cbu The conference bridge user to remove from the conference
421  */
422 void conf_remove_user_active(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
423
424 /*! \brief Remove a conference bridge user from the marked active conference users in the conference
425  * \param conference_bridge The conference bridge to remove the user from
426  * \param cbu The conference bridge user to remove from the conference
427  */
428 void conf_remove_user_marked(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
429
430 /*! \brief Remove a conference bridge user from the waiting conference users in the conference
431  * \param conference_bridge The conference bridge to remove the user from
432  * \param cbu The conference bridge user to remove from the conference
433  */
434 void conf_remove_user_waiting(struct conference_bridge *conference_bridge, struct conference_bridge_user *cbu);
435
436 /*! \brief Queue a function to run with the given conference bridge user as an argument once the state transition is complete
437  * \param cbu The conference bridge user to pass to the function
438  * \param func The function to queue
439  * \retval 0 success
440  * \retval non-zero failure
441  */
442 int conf_add_post_join_action(struct conference_bridge_user *cbu, int (*func)(struct conference_bridge_user *cbu));
443 #endif