ARI: Bridge Playback, Bridge Record

Adds a new channel driver for creating channels for specific purposes
in bridges, primarily to act as either recorders or announcers. Adds
ARI commands for playing announcements to ever participant in a bridge
as well as for recording a bridge. This patch also includes some
documentation/reponse fixes to related ARI models such as playback
controls.

(closes issue ASTERISK-21592)
Reported by: Matt Jordan

(closes issue ASTERISK-21593)
Reported by: Matt Jordan

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


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

1 files changed, 218 insertions, 0 deletions

diff --git a/channels/chan_bridge_media.c b/channels/chan_bridge_media.c
new file mode 100644
index 000000000..d24201207
--- /dev/null
+++ b/channels/chan_bridge_media.c
@@ -0,0 +1,218 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2013 Digium, Inc.
+ *
+ * Jonathan Rose <jrose@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 Bridge Media Channels driver
+ *
+ * \author Jonathan Rose <jrose@digium.com>
+ * \author Richard Mudgett <rmudgett@digium.com>
+ *
+ * \brief Bridge Media Channels
+ *
+ * \ingroup channel_drivers
+ */
+
+/*** MODULEINFO
+	<support_level>core</support_level>
+ ***/
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "asterisk/channel.h"
+#include "asterisk/bridging.h"
+#include "asterisk/core_unreal.h"
+#include "asterisk/module.h"
+
+static int media_call(struct ast_channel *chan, const char *addr, int timeout)
+{
+	/* ast_call() will fail unconditionally against channels provided by this driver */
+	return -1;
+}
+
+static int media_hangup(struct ast_channel *ast)
+{
+	struct ast_unreal_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, ast);
+	ao2_ref(p, -1);
+
+	return res;
+}
+
+static struct ast_channel *announce_request(const char *type, struct ast_format_cap *cap,
+	const struct ast_channel *requestor, const char *data, int *cause);
+
+static struct ast_channel *record_request(const char *type, struct ast_format_cap *cap,
+	const struct ast_channel *requestor, const char *data, int *cause);
+
+static struct ast_channel_tech announce_tech = {
+	.type = "Announcer",
+	.description = "Bridge Media Announcing Channel Driver",
+	.requester = announce_request,
+	.call = media_call,
+	.hangup = media_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,
+	.properties = AST_CHAN_TP_ANNOUNCER,
+};
+
+static struct ast_channel_tech record_tech = {
+	.type = "Recorder",
+	.description = "Bridge Media Recording Channel Driver",
+	.requester = record_request,
+	.call = media_call,
+	.hangup = media_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,
+	.properties = AST_CHAN_TP_RECORDER,
+};
+
+static struct ast_channel *media_request_helper(struct ast_format_cap *cap,
+	const struct ast_channel *requestor, const char *data, struct ast_channel_tech *tech, const char *role)
+{
+	struct ast_channel *chan;
+
+	RAII_VAR(struct ast_callid *, callid, NULL, ast_callid_cleanup);
+	RAII_VAR(struct ast_unreal_pvt *, pvt, NULL, ao2_cleanup);
+
+	if (!(pvt = ast_unreal_alloc(sizeof(*pvt), ast_unreal_destructor, cap))) {
+		return NULL;
+	}
+
+	ast_copy_string(pvt->name, data, sizeof(pvt->name));
+
+	ast_set_flag(pvt, AST_UNREAL_NO_OPTIMIZATION);
+
+	callid = ast_read_threadstorage_callid();
+
+	chan = ast_unreal_new_channels(pvt, tech,
+		AST_STATE_UP, AST_STATE_UP, NULL, NULL, requestor, callid);
+	if (!chan) {
+		return NULL;
+	}
+
+	ast_answer(pvt->owner);
+	ast_answer(pvt->chan);
+
+	if (ast_channel_add_bridge_role(pvt->chan, role)) {
+		ast_hangup(chan);
+		return NULL;
+	}
+
+	return chan;
+}
+
+static struct ast_channel *announce_request(const char *type, struct ast_format_cap *cap,
+	const struct ast_channel *requestor, const char *data, int *cause)
+{
+	return media_request_helper(cap, requestor, data, &announce_tech, "announcer");
+}
+
+static struct ast_channel *record_request(const char *type, struct ast_format_cap *cap,
+	const struct ast_channel *requestor, const char *data, int *cause)
+{
+	return media_request_helper(cap, requestor, data, &record_tech, "recorder");
+}
+
+static void cleanup_capabilities(void)
+{
+	if (announce_tech.capabilities) {
+		announce_tech.capabilities = ast_format_cap_destroy(announce_tech.capabilities);
+	}
+
+	if (record_tech.capabilities) {
+		record_tech.capabilities = ast_format_cap_destroy(record_tech.capabilities);
+	}
+}
+
+static int unload_module(void)
+{
+	ast_channel_unregister(&announce_tech);
+	ast_channel_unregister(&record_tech);
+	cleanup_capabilities();
+	return 0;
+}
+
+static int load_module(void)
+{
+	announce_tech.capabilities = ast_format_cap_alloc();
+	if (!announce_tech.capabilities) {
+		return AST_MODULE_LOAD_DECLINE;
+	}
+
+	record_tech.capabilities = ast_format_cap_alloc();
+	if (!record_tech.capabilities) {
+		return AST_MODULE_LOAD_DECLINE;
+	}
+
+	ast_format_cap_add_all(announce_tech.capabilities);
+	ast_format_cap_add_all(record_tech.capabilities);
+
+	if (ast_channel_register(&announce_tech)) {
+		ast_log(LOG_ERROR, "Unable to register channel technology %s(%s).\n",
+			announce_tech.type, announce_tech.description);
+		cleanup_capabilities();
+		return AST_MODULE_LOAD_DECLINE;
+	}
+
+	if (ast_channel_register(&record_tech)) {
+		ast_log(LOG_ERROR, "Unable to register channel technology %s(%s).\n",
+			record_tech.type, record_tech.description);
+		cleanup_capabilities();
+		return AST_MODULE_LOAD_DECLINE;
+	}
+
+	return AST_MODULE_LOAD_SUCCESS;
+}
+
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Bridge Media Channel Driver",
+    .load = load_module,
+    .unload = unload_module,
+);