Files
asterisk/apps/confbridge/conf_chan_announce.c

180 lines
4.5 KiB
C
Raw Normal View History

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013 Digium, Inc.
*
* Richard Mudgett <rmudgett@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.
*/
/*!
* \file
* \brief ConfBridge announcer channel driver
*
* \author Richard Mudgett <rmudgett@digium.com>
*
* See Also:
* \arg \ref AstCREDITS
*/
#include "asterisk.h"
#include "asterisk/channel.h"
#include "asterisk/bridge.h"
#include "asterisk/core_unreal.h"
#include "include/confbridge.h"
/* ------------------------------------------------------------------- */
/*! ConfBridge announcer channel private. */
struct announce_pvt {
/*! Unreal channel driver base class values. */
struct ast_unreal_pvt base;
/*! Conference bridge associated with this announcer. */
struct ast_bridge *bridge;
};
static int announce_call(struct ast_channel *chan, const char *addr, int timeout)
{
/* Make sure anyone calling ast_call() for this channel driver is going to fail. */
return -1;
}
static int announce_hangup(struct ast_channel *ast)
{
struct announce_pvt *p = ast_channel_tech_pvt(ast);
int res;
if (!p) {
return -1;
}
/* give the pvt a ref to fulfill calling requirements. */
ao2_ref(p, +1);
res = ast_unreal_hangup(&p->base, ast);
ao2_ref(p, -1);
return res;
}
static void announce_pvt_destructor(void *vdoomed)
{
struct announce_pvt *doomed = vdoomed;
ao2_cleanup(doomed->bridge);
doomed->bridge = NULL;
ast_unreal_destructor(&doomed->base);
}
static struct ast_channel *announce_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause)
{
struct ast_channel *chan;
const char *conf_name = data;
RAII_VAR(struct confbridge_conference *, conference, NULL, ao2_cleanup);
RAII_VAR(struct announce_pvt *, pvt, NULL, ao2_cleanup);
conference = ao2_find(conference_bridges, conf_name, OBJ_KEY);
if (!conference) {
return NULL;
}
ast_assert(conference->bridge != NULL);
/* Allocate a new private structure and then Asterisk channels */
pvt = (struct announce_pvt *) ast_unreal_alloc(sizeof(*pvt), announce_pvt_destructor,
cap);
if (!pvt) {
return NULL;
}
ast_set_flag(&pvt->base, AST_UNREAL_NO_OPTIMIZATION);
ast_copy_string(pvt->base.name, conf_name, sizeof(pvt->base.name));
pvt->bridge = conference->bridge;
ao2_ref(pvt->bridge, +1);
chan = ast_unreal_new_channels(&pvt->base, conf_announce_get_tech(),
AST_STATE_UP, AST_STATE_UP, NULL, NULL, assignedids, requestor, 0);
if (chan) {
ast_answer(pvt->base.owner);
ast_answer(pvt->base.chan);
if (ast_channel_add_bridge_role(pvt->base.chan, "announcer")) {
ast_hangup(chan);
chan = NULL;
}
}
return chan;
}
static struct ast_channel_tech announce_tech = {
.type = "CBAnn",
.description = "Conference Bridge Announcing Channel",
.requester = announce_request,
.call = announce_call,
.hangup = announce_hangup,
.send_digit_begin = ast_unreal_digit_begin,
.send_digit_end = ast_unreal_digit_end,
.read = ast_unreal_read,
.write = ast_unreal_write,
.write_video = ast_unreal_write,
.exception = ast_unreal_read,
.indicate = ast_unreal_indicate,
.fixup = ast_unreal_fixup,
.send_html = ast_unreal_sendhtml,
.send_text = ast_unreal_sendtext,
.queryoption = ast_unreal_queryoption,
.setoption = ast_unreal_setoption,
Hide the Surrogate channels from external consumers; kill Masquerade events This patch does three things: 1. It provides a Surrogate channel technology with a consolidated "implementation detail flag" on the channel technology. This tells consumers of Stasis that the creation of this channel is an implementation detail in Asterisk and can be ignored (if they so choose). This consolidates the conference recorder/announcer flags as well - these flags had no additional meaning beyond "ignore this channel please". 2. It modifies allocation of a channel in two ways: (a) If a channel technology can be determined from the name, we set it directly in the allocation routine. This prevents the initial publication of the message from going out with a NULL channel technology where possible. This lets Stasis consumers get the right channel technology on the first publication. (b) It reorganizes allocation to make use of the 'finalized' property on the channel. This was already used to know that a channel had completely finished its construction in the masquerade routine; now we also use it to know whether or not the setting of certain channel properties is occurring during or post construction. The various set routines were modified accordingly as well. 3. The masquerade event is now dead, Jim. It no longer served any purpose whatsoever - if you perform a call pickup you'll get a Pickup event; if you perform an attended transfer you will still get those events; if you steal a channel to put it elsewhere you'll get the corresponding NewExten or BridgeEnter events. Review: https://reviewboard.asterisk.org/r/2740 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@396392 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-08-08 14:13:05 +00:00
.properties = AST_CHAN_TP_INTERNAL,
};
struct ast_channel_tech *conf_announce_get_tech(void)
{
return &announce_tech;
}
int conf_announce_channel_push(struct ast_channel *ast)
{
struct ast_bridge_features *features;
struct ast_channel *chan;
RAII_VAR(struct announce_pvt *, p, NULL, ao2_cleanup);
{
SCOPED_CHANNELLOCK(lock, ast);
p = ast_channel_tech_pvt(ast);
if (!p) {
return -1;
}
ao2_ref(p, +1);
chan = p->base.chan;
if (!chan) {
return -1;
}
}
features = ast_bridge_features_new();
if (!features) {
return -1;
}
ast_set_flag(&features->feature_flags, AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE);
/* Impart the output channel into the bridge */
if (ast_bridge_impart(p->bridge, chan, NULL, features,
ConfBridge: Rework announcer channel methodology NOTE: This patch was submitted earlier and reverted because of a failing test. The test has been patched so that it adjusts for the changes here, so this is being resubmitted for review. One feature that confbridge has is the ability to play sounds to all participants in the conference. Prior to this commit, the algorithm for this was as follows: * Grab the playback lock * Push the conference announcer channel into the bridge * Play back the sound * Pull the conference announcer channel from the bridge * Release the playback lock The issue here is that the act of adding the playback channel to the bridge and removing it for each announcement is expensive. Amongst the expenses: * The announcer channel is imparted into the bridge, meaning a new thread is spun up for each playback. * When the announcer is added or removed from the bridge, it results in the BRIDGEPEER channel variable being set on all channels in the bridge. This requires keeping the bridge locked and locking each individual channel in order to set it. * There's also just the general overhead of adding the channel and removing it from the bridge. The bridge potentially has to reconfigure every single time With this commit, the paradigm for playing back announcements has shifted. * The announcer channel is now added to the bridge when the conference is allocated, and it is hung up when the conference is destroyed. * A taskprocessor is used to queue playbacks onto the announcer channel. This keeps the behavior from before where playbacks do not overlap. * The announcer channel is no longer placed into the bridge as departable. Since we are not constantly removing the channel from the bridge, it is safe to add the channel using an independent thread and simply hang the channel up when it is time for the conference to be destroyed. The use of the taskprocessor for playbacks opens up the interesting possibility of having asynchronous announcements played. In this commit, however, the behavior is still exactly the same as it previously was. ASTERISK-26289 Reported by Mark Michelson Change-Id: Ica9fa4907c2f3728cdd1cf0bc564ef4eb40754a0
2016-08-10 15:14:09 -05:00
AST_BRIDGE_IMPART_CHAN_INDEPENDENT)) {
return -1;
}
ao2_lock(p);
ast_set_flag(&p->base, AST_UNREAL_CARETAKER_THREAD);
ao2_unlock(p);
return 0;
}