New HD ConfBridge conferencing application.

Includes a new highly optimized and customizable
ConfBridge application capable of mixing audio at
sample rates ranging from 8khz-192khz.

Review: https://reviewboard.asterisk.org/r/1147/



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@314598 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 320 insertions, 0 deletions

diff --git a/apps/confbridge/include/confbridge.h b/apps/confbridge/include/confbridge.h
new file mode 100644
index 000000000..4b6c0615e
--- /dev/null
+++ b/apps/confbridge/include/confbridge.h
@@ -0,0 +1,320 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2011, Digium, Inc.
+ *
+ * David Vossel <dvossel@digium.com>
+ * Joshua Colp <jcolp@digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+
+#ifndef _CONFBRIDGE_H
+#define _CONFBRIDGE_H
+
+#include "asterisk.h"
+#include "asterisk/app.h"
+#include "asterisk/logger.h"
+#include "asterisk/linkedlists.h"
+#include "asterisk/channel.h"
+#include "asterisk/bridging.h"
+#include "asterisk/bridging_features.h"
+
+/* Maximum length of a conference bridge name */
+#define MAX_CONF_NAME 32
+/* Maximum length of a conference pin */
+#define MAX_PIN     80
+
+#define DEFAULT_USER_PROFILE "default_user"
+#define DEFAULT_BRIDGE_PROFILE "default_bridge"
+
+#define DEFAULT_TALKING_THRESHOLD 160
+#define DEFAULT_SILENCE_THRESHOLD 2500
+
+enum user_profile_flags {
+	USER_OPT_ADMIN =        (1 << 0), /*!< Set if the caller is an administrator */
+	USER_OPT_NOONLYPERSON = (1 << 1), /*!< Set if the "you are currently the only person in this conference" sound file should not be played */
+	USER_OPT_MARKEDUSER =   (1 << 2), /*!< Set if the caller is a marked user */
+	USER_OPT_STARTMUTED =   (1 << 3), /*!< Set if the caller should be initially set muted */
+	USER_OPT_MUSICONHOLD =  (1 << 4), /*!< Set if music on hold should be played if nobody else is in the conference bridge */
+	USER_OPT_QUIET =        (1 << 5), /*!< Set if no audio prompts should be played */
+	USER_OPT_ANNOUNCEUSERCOUNT = (1 << 6), /*!< Set if the number of users should be announced to the caller */
+	USER_OPT_WAITMARKED =   (1 << 7), /*!< Set if the user must wait for a marked user before starting */
+	USER_OPT_ENDMARKED =    (1 << 8), /*!< Set if the user should be kicked after the last Marked user exits */
+	USER_OPT_DENOISE =      (1 << 9), /*!< Sets if denoise filter should be used on audio before mixing. */
+	USER_OPT_ANNOUNCE_JOIN_LEAVE = (1 << 10), /*!< Sets if the user's name should be recorded and announced on join and leave. */
+	USER_OPT_TALKER_DETECT = (1 << 11), /*!< Sets if start and stop talking events should generated for this user over AMI. */
+	USER_OPT_DROP_SILENCE =  (1 << 12), /*!< Sets if silence should be dropped from the mix or not. */
+	USER_OPT_DTMF_PASS    =  (1 << 13), /*!< Sets if dtmf should be passed into the conference or not */
+	USER_OPT_ANNOUNCEUSERCOUNTALL = (1 << 14), /*!< Sets if the number of users should be announced to everyone. */
+	USER_OPT_JITTERBUFFER =  (1 << 15), /*!< Places a jitterbuffer on the user. */
+};
+
+enum bridge_profile_flags {
+	BRIDGE_OPT_RECORD_CONFERENCE = (1 << 0), /*!< Set if the conference should be recorded */
+};
+
+enum conf_menu_action_id {
+	MENU_ACTION_TOGGLE_MUTE = 1,
+	MENU_ACTION_PLAYBACK,
+	MENU_ACTION_PLAYBACK_AND_CONTINUE,
+	MENU_ACTION_INCREASE_LISTENING,
+	MENU_ACTION_DECREASE_LISTENING,
+	MENU_ACTION_RESET_LISTENING,
+	MENU_ACTION_RESET_TALKING,
+	MENU_ACTION_INCREASE_TALKING,
+	MENU_ACTION_DECREASE_TALKING,
+	MENU_ACTION_DIALPLAN_EXEC,
+	MENU_ACTION_ADMIN_TOGGLE_LOCK,
+	MENU_ACTION_ADMIN_KICK_LAST,
+	MENU_ACTION_LEAVE,
+	MENU_ACTION_NOOP,
+};
+
+/*! The conference menu action contains both
+ *  the action id that represents the action that
+ *  must take place, along with any data associated
+ *  with that action. */
+struct conf_menu_action {
+	enum conf_menu_action_id id;
+	union {
+		char playback_file[PATH_MAX];
+		struct {
+			char context[AST_MAX_CONTEXT];
+			char exten[AST_MAX_EXTENSION];
+			int priority;
+		} dialplan_args;
+	} data;
+	AST_LIST_ENTRY(conf_menu_action) action;
+};
+
+/*! Conference menu entries contain the DTMF sequence
+ *  and the list of actions that are associated with that
+ *  sequence. */
+struct conf_menu_entry {
+	/*! the DTMF sequence that triggers the actions */
+	char dtmf[MAXIMUM_DTMF_FEATURE_STRING];
+	/*! The actions associated with this menu entry. */
+	AST_LIST_HEAD_NOLOCK(, conf_menu_action) actions;
+	AST_LIST_ENTRY(conf_menu_entry) entry;
+};
+
+/*! Conference menu structure.  Contains a list
+ * of DTMF sequences coupled with the actions those
+ * sequences invoke.*/
+struct conf_menu {
+	char name[128];
+	int delme;
+	AST_LIST_HEAD_NOLOCK(, conf_menu_entry) entries;
+};
+
+struct user_profile {
+	char name[128];
+	char pin[MAX_PIN];
+	char moh_class[128];
+	unsigned int flags;
+	unsigned int announce_user_count_all_after;
+	/*! The time in ms of talking before a user is considered to be talking by the dsp. */
+	unsigned int talking_threshold;
+	/*! The time in ms of silence before a user is considered to be silent by the dsp. */
+	unsigned int silence_threshold;
+	int delme;
+};
+
+enum conf_sounds {
+	CONF_SOUND_HAS_JOINED,
+	CONF_SOUND_HAS_LEFT,
+	CONF_SOUND_KICKED,
+	CONF_SOUND_MUTED,
+	CONF_SOUND_UNMUTED,
+	CONF_SOUND_ONLY_ONE,
+	CONF_SOUND_THERE_ARE,
+	CONF_SOUND_OTHER_IN_PARTY,
+	CONF_SOUND_PLACE_IN_CONF,
+	CONF_SOUND_WAIT_FOR_LEADER,
+	CONF_SOUND_LEADER_HAS_LEFT,
+	CONF_SOUND_GET_PIN,
+	CONF_SOUND_INVALID_PIN,
+	CONF_SOUND_ONLY_PERSON,
+	CONF_SOUND_LOCKED,
+	CONF_SOUND_LOCKED_NOW,
+	CONF_SOUND_UNLOCKED_NOW,
+	CONF_SOUND_ERROR_MENU,
+	CONF_SOUND_JOIN,
+	CONF_SOUND_LEAVE,
+};
+
+struct bridge_profile_sounds {
+	AST_DECLARE_STRING_FIELDS(
+		AST_STRING_FIELD(hasjoin);
+		AST_STRING_FIELD(hasleft);
+		AST_STRING_FIELD(kicked);
+		AST_STRING_FIELD(muted);
+		AST_STRING_FIELD(unmuted);
+		AST_STRING_FIELD(onlyone);
+		AST_STRING_FIELD(thereare);
+		AST_STRING_FIELD(otherinparty);
+		AST_STRING_FIELD(placeintoconf);
+		AST_STRING_FIELD(waitforleader);
+		AST_STRING_FIELD(leaderhasleft);
+		AST_STRING_FIELD(getpin);
+		AST_STRING_FIELD(invalidpin);
+		AST_STRING_FIELD(onlyperson);
+		AST_STRING_FIELD(locked);
+		AST_STRING_FIELD(lockednow);
+		AST_STRING_FIELD(unlockednow);
+		AST_STRING_FIELD(errormenu);
+		AST_STRING_FIELD(leave);
+		AST_STRING_FIELD(join);
+	);
+};
+
+struct bridge_profile {
+	char name[64];
+	char rec_file[PATH_MAX];
+	unsigned int flags;
+	unsigned int max_members;          /*!< The maximum number of participants allowed in the conference */
+	unsigned int internal_sample_rate; /*!< The internal sample rate of the bridge. 0 when set to auto adjust mode. */
+	unsigned int mix_interval;  /*!< The internal mixing interval used by the bridge. When set to 0 the bridgewill use a default interval. */
+	struct bridge_profile_sounds *sounds;
+	int delme;
+};
+
+/*! \brief The structure that represents a conference bridge */
+struct conference_bridge {
+	char name[MAX_CONF_NAME];                                         /*!< Name of the conference bridge */
+	struct ast_bridge *bridge;                                        /*!< Bridge structure doing the mixing */
+	struct bridge_profile b_profile;                                  /*!< The Bridge Configuration Profile */
+	unsigned int users;                                               /*!< Number of users present */
+	unsigned int markedusers;                                         /*!< Number of marked users present */
+	unsigned int locked:1;                                            /*!< Is this conference bridge locked? */
+	struct ast_channel *playback_chan;                                /*!< Channel used for playback into the conference bridge */
+	struct ast_channel *record_chan;                                  /*!< Channel used for recording the conference */
+	pthread_t record_thread;                                          /*!< The thread the recording chan lives in */
+	ast_mutex_t playback_lock;                                        /*!< Lock used for playback channel */
+	AST_LIST_HEAD_NOLOCK(, conference_bridge_user) users_list;        /*!< List of users participating in the conference bridge */
+};
+
+/*! \brief The structure that represents a conference bridge user */
+struct conference_bridge_user {
+	struct conference_bridge *conference_bridge; /*!< Conference bridge they are participating in */
+	struct bridge_profile b_profile;             /*!< The Bridge Configuration Profile */
+	struct user_profile u_profile;               /*!< The User Configuration Profile */
+	char menu_name[64];                          /*!< The name of the DTMF menu assigned to this user */
+	char name_rec_location[PATH_MAX];            /*!< Location of the User's name recorded file if it exists */
+	struct ast_channel *chan;                    /*!< Asterisk channel participating */
+	struct ast_bridge_features features;         /*!< Bridge features structure */
+	struct ast_bridge_tech_optimizations tech_args; /*!< Bridge technology optimizations for talk detection */
+	unsigned int kicked:1;                       /*!< User has been kicked from the conference */
+	AST_LIST_ENTRY(conference_bridge_user) list; /*!< Linked list information */
+};
+
+/*! \brief load confbridge.conf file */
+int conf_load_config(int reload);
+
+/*! \brief destroy the information loaded from the confbridge.conf file*/
+void conf_destroy_config(void);
+
+/*!
+ * \brief find a user profile given a user profile's name and store
+ * that profile in result structure.
+ *
+ * \details This function first attempts to find any custom user
+ * profile that might exist on a channel datastore, if that doesn't
+ * exist it looks up the provided user profile name, if that doesn't
+ * exist either the default_user profile is used.
+
+ * \retval user profile on success
+ * \retval NULL on failure
+ */
+const struct user_profile *conf_find_user_profile(struct ast_channel *chan, const char *user_profile_name, struct user_profile *result);
+
+/*!
+ * \brief Find a bridge profile
+ *
+ * \details Any bridge profile found using this function must be
+ * destroyed using conf_bridge_profile_destroy.  This function first
+ * attempts to find any custom bridge profile that might exist on
+ * a channel datastore, if that doesn't exist it looks up the
+ * provided bridge profile name, if that doesn't exist either
+ * the default_bridge profile is used.
+ *
+ * \retval Bridge profile on success
+ * \retval NULL on failure
+ */
+const struct bridge_profile *conf_find_bridge_profile(struct ast_channel *chan, const char *bridge_profile_name, struct bridge_profile *result);
+
+/*!
+ * \brief Destroy a bridge profile found by 'conf_find_bridge_profile'
+ */
+void conf_bridge_profile_destroy(struct bridge_profile *b_profile);
+
+/*!
+ * \brief copies a bridge profile
+ * \note conf_bridge_profile_destroy must be called on the dst structure
+ */
+void conf_bridge_profile_copy(struct bridge_profile *dst, struct bridge_profile *src);
+
+/*!
+ * \brief Set a DTMF menu to a conference user by menu name.
+ *
+ * \retval 0 on success, menu was found and set
+ * \retval -1 on error, menu was not found
+ */
+int conf_set_menu_to_user(const char *menu_name, struct conference_bridge_user *conference_bridge_user);
+
+/*!
+ * \brief Finds a menu_entry in a menu structure matched by DTMF sequence.
+ *
+ * \note the menu entry found must be destroyed using conf_menu_entry_destroy()
+ *
+ * \retval 1 success, entry is found and stored in result
+ * \retval 0 failure, no entry found for given DTMF sequence
+ */
+int conf_find_menu_entry_by_sequence(const char *dtmf_sequence, struct conf_menu *menu, struct conf_menu_entry *result);
+
+/*!
+ * \brief Destroys and frees all the actions stored in a menu_entry structure
+ */
+void conf_menu_entry_destroy(struct conf_menu_entry *menu_entry);
+
+/*!
+ * \brief Once a DTMF sequence matches a sequence in the user's DTMF menu, this function will get
+ * called to perform the menu action.
+ *
+ * \param bridge_channel, Bridged channel this is involving
+ * \param conference_bridge_user, the conference user to perform the action on.
+ * \param menu_entry, the menu entry that invoked this callback to occur.
+ * \param menu, an AO2 referenced pointer to the entire menu structure the menu_entry
+ *        derived from.
+ *
+ * \note The menu_entry is a deep copy of the entry found in the menu structure.  This allows
+ * for the menu_entry to be accessed without requiring the menu lock.  If the menu must
+ * be accessed, the menu lock must be held.  Reference counting of the menu structure is
+ * handled outside of the scope of this function.
+ *
+ * \retval 0 success
+ * \retval -1 failure
+ */
+int conf_handle_dtmf(
+	struct ast_bridge_channel *bridge_channel,
+	struct conference_bridge_user *conference_bridge_user,
+	struct conf_menu_entry *menu_entry,
+	struct conf_menu *menu);
+
+
+/*! \brief Looks to see if sound file is stored in bridge profile sounds, if not
+ *  default sound is provided.*/
+const char *conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds *custom_sounds);
+
+int func_confbridge_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value);
+#endif