aboutsummaryrefslogtreecommitdiffstats
path: root/trunk/funcs/func_channel.c
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/funcs/func_channel.c')
-rw-r--r--trunk/funcs/func_channel.c206
1 files changed, 206 insertions, 0 deletions
diff --git a/trunk/funcs/func_channel.c b/trunk/funcs/func_channel.c
new file mode 100644
index 000000000..d920ac21f
--- /dev/null
+++ b/trunk/funcs/func_channel.c
@@ -0,0 +1,206 @@
+/*
+ * Asterisk -- An open source telephony toolkit.
+ *
+ * Copyright (C) 2006, Digium, Inc.
+ *
+ * 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 Channel info dialplan function
+ *
+ * \author Kevin P. Fleming <kpfleming@digium.com>
+ *
+ * \ingroup functions
+ */
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "asterisk/module.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/utils.h"
+#include "asterisk/app.h"
+#include "asterisk/indications.h"
+#include "asterisk/stringfields.h"
+
+#define locked_copy_string(chan, dest, source, len) \
+ do { \
+ ast_channel_lock(chan); \
+ ast_copy_string(dest, source, len); \
+ ast_channel_unlock(chan); \
+ } while (0)
+#define locked_string_field_set(chan, field, source) \
+ do { \
+ ast_channel_lock(chan); \
+ ast_string_field_set(chan, field, source); \
+ ast_channel_unlock(chan); \
+ } while (0)
+
+char *transfercapability_table[0x20] = {
+ "SPEECH", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
+ "DIGITAL", "RESTRICTED_DIGITAL", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
+ "3K1AUDIO", "DIGITAL_W_TONES", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
+ "VIDEO", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", };
+
+static int func_channel_read(struct ast_channel *chan, const char *function,
+ char *data, char *buf, size_t len)
+{
+ int ret = 0;
+
+ if (!strcasecmp(data, "audionativeformat"))
+ /* use the _multiple version when chan->nativeformats holds multiple formats */
+ /* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_AUDIO_MASK); */
+ ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_AUDIO_MASK), len);
+ else if (!strcasecmp(data, "videonativeformat"))
+ /* use the _multiple version when chan->nativeformats holds multiple formats */
+ /* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_VIDEO_MASK); */
+ ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_VIDEO_MASK), len);
+ else if (!strcasecmp(data, "audioreadformat"))
+ ast_copy_string(buf, ast_getformatname(chan->readformat), len);
+ else if (!strcasecmp(data, "audiowriteformat"))
+ ast_copy_string(buf, ast_getformatname(chan->writeformat), len);
+ else if (!strcasecmp(data, "tonezone") && chan->zone)
+ locked_copy_string(chan, buf, chan->zone->country, len);
+ else if (!strcasecmp(data, "language"))
+ locked_copy_string(chan, buf, chan->language, len);
+ else if (!strcasecmp(data, "musicclass"))
+ locked_copy_string(chan, buf, chan->musicclass, len);
+ else if (!strcasecmp(data, "state"))
+ locked_copy_string(chan, buf, ast_state2str(chan->_state), len);
+ else if (!strcasecmp(data, "channeltype"))
+ locked_copy_string(chan, buf, chan->tech->type, len);
+ else if (!strcasecmp(data, "transfercapability"))
+ locked_copy_string(chan, buf, transfercapability_table[chan->transfercapability & 0x1f], len);
+ else if (!strcasecmp(data, "callgroup")) {
+ char groupbuf[256];
+ locked_copy_string(chan, buf, ast_print_group(groupbuf, sizeof(groupbuf), chan->callgroup), len);
+ } else if (!chan->tech->func_channel_read
+ || chan->tech->func_channel_read(chan, function, data, buf, len)) {
+ ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n", data);
+ ret = -1;
+ }
+
+ return ret;
+}
+
+static int func_channel_write(struct ast_channel *chan, const char *function,
+ char *data, const char *value)
+{
+ int ret = 0;
+ signed char gainset;
+
+ if (!strcasecmp(data, "language"))
+ locked_string_field_set(chan, language, value);
+ else if (!strcasecmp(data, "musicclass"))
+ locked_string_field_set(chan, musicclass, value);
+ else if (!strcasecmp(data, "tonezone")) {
+ struct ind_tone_zone *new_zone;
+ if (!(new_zone = ast_get_indication_zone(value))) {
+ ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", value);
+ ret = -1;
+ } else
+ chan->zone = new_zone;
+ } else if (!strcasecmp(data, "callgroup"))
+ chan->callgroup = ast_get_group(value);
+ else if (!strcasecmp(data, "txgain")) {
+ sscanf(value, "%hhd", &gainset);
+ ast_channel_setoption(chan, AST_OPTION_TXGAIN, &gainset, sizeof(gainset), 0);
+ } else if (!strcasecmp(data, "rxgain")) {
+ sscanf(value, "%hhd", &gainset);
+ ast_channel_setoption(chan, AST_OPTION_RXGAIN, &gainset, sizeof(gainset), 0);
+ } else if (!strcasecmp(data, "transfercapability")) {
+ unsigned short i;
+ for (i = 0; i < 0x20; i++) {
+ if (!strcasecmp(transfercapability_table[i], value) && strcmp(value, "UNK")) {
+ chan->transfercapability = i;
+ break;
+ }
+ }
+ } else if (!chan->tech->func_channel_write
+ || chan->tech->func_channel_write(chan, function, data, value)) {
+ ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n",
+ data);
+ ret = -1;
+ }
+
+ return ret;
+}
+
+static struct ast_custom_function channel_function = {
+ .name = "CHANNEL",
+ .synopsis = "Gets/sets various pieces of information about the channel.",
+ .syntax = "CHANNEL(item)",
+ .desc = "Gets/set various pieces of information about the channel.\n"
+ "Standard items (provided by all channel technologies) are:\n"
+ "R/O audioreadformat format currently being read\n"
+ "R/O audionativeformat format used natively for audio\n"
+ "R/O audiowriteformat format currently being written\n"
+ "R/W callgroup call groups for call pickup\n"
+ "R/O channeltype technology used for channel\n"
+ "R/W language language for sounds played\n"
+ "R/W musicclass class (from musiconhold.conf) for hold music\n"
+ "R/W rxgain set rxgain level on channel drivers that support it\n"
+ "R/O state state for channel\n"
+ "R/W tonezone zone for indications played\n"
+ "R/W txgain set txgain level on channel drivers that support it\n"
+ "R/O videonativeformat format used natively for video\n"
+ "\n"
+ "chan_sip provides the following additional options:\n"
+ "R/O rtpqos Get QOS information about the RTP stream\n"
+ " This option takes two additional arguments:\n"
+ " Argument 1:\n"
+ " audio Get data about the audio stream\n"
+ " video Get data about the video stream\n"
+ " text Get data about the text stream\n"
+ " Argument 2:\n"
+ " local_ssrc Local SSRC (stream ID)\n"
+ " local_lostpackets Local lost packets\n"
+ " local_jitter Local calculated jitter\n"
+ " local_count Number of received packets\n"
+ " remote_ssrc Remote SSRC (stream ID)\n"
+ " remote_lostpackets Remote lost packets\n"
+ " remote_jitter Remote reported jitter\n"
+ " remote_count Number of transmitted packets\n"
+ " rtt Round trip time\n"
+ " all All statistics (in a form suited to logging, but not for parsing)\n"
+ "R/O rtpdest Get remote RTP destination information\n"
+ " This option takes one additional argument:\n"
+ " Argument 1:\n"
+ " audio Get audio destination\n"
+ " video Get video destination\n"
+ "\n"
+ "chan_iax2 provides the following additional options:\n"
+ "R/W osptoken Get or set the OSP token information for a call\n"
+ "\n"
+ "Additional items may be available from the channel driver providing\n"
+ "the channel; see its documentation for details.\n"
+ "\n"
+ "Any item requested that is not available on the current channel will\n"
+ "return an empty string.\n",
+ .read = func_channel_read,
+ .write = func_channel_write,
+};
+
+static int unload_module(void)
+{
+ return ast_custom_function_unregister(&channel_function);
+}
+
+static int load_module(void)
+{
+ return ast_custom_function_register(&channel_function);
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel information dialplan function");
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-18 05:41:54 +0000