sysmocom/asterisk
11
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
asterisk/funcs/func_frame_trace.c
George Joseph 4fb7967c73 bridge_softmix: Forward TEXT frames 
Core bridging and, more specifically, bridge_softmix have been
enhanced to relay received frames of type TEXT or TEXT_DATA to all
participants in a softmix bridge.  res_pjsip_messaging and
chan_pjsip have been enhanced to take advantage of this so when
res_pjsip_messaging receives an in-dialog MESSAGE message from a
user in a conference call, it's relayed to all other participants
in the call.

res_pjsip_messaging already queues TEXT frames to the channel when
it receives an in-dialog MESSAGE from an endpoint and chan_pjsip
will send an MESSAGE when it gets a TEXT frame.  On a normal
point-to-point call, the frames are forwarded between the two
correctly.  bridge_softmix was not though so messages weren't
getting forwarded to conference bridge participants.  Even if they
were, the bridging code had no way to tell the participants who
sent the message so it would look like it came from the bridge
itself.

* The TEXT frame type doesn't allow storage of any meta data, such
as sender, on the frame so a new TEXT_DATA frame type was added that
uses the new ast_msg_data structure as its payload.  A channel
driver can queue a frame of that type when it receives a message
from outside.  A channel driver can use it for sending messages
by implementing the new send_text_data channel tech callback and
setting the new AST_CHAN_TP_SEND_TEXT_DATA flag in its tech
properties.  If set, the bridging/channel core will use it instead
of the original send_text callback and it will get the ast_msg_data
structure. Channel drivers aren't required to implement this.  Even
if a TEXT_DATA enabled driver uses it for incoming messages, an
outgoing channel driver that doesn't will still have it's send_text
callback called with only the message text just as before.

* res_pjsip_messaging now creates a TEXT_DATA frame for incoming
in-dialog messages and sets the "from" to the display name in the
"From" header, or if that's empty, the caller id name from the
channel.  This allows the chat client user to set a friendly name
for the chat.

* bridge_softmix now forwards TEXT and TEXT_DATA frames to all
participants (except the sender).

* A new function "ast_sendtext_data" was added to channel which
takes an ast_msg_data structure and calls a channel's
send_text_data callback, or if that's not defined, the original
send_text callback.

* bridge_channel now calls ast_sendtext_data for TEXT_DATA frame
types and ast_sendtext for TEXT frame types.

* chan_pjsip now uses the "from" name in the ast_msg_data structure
(if it exists) to set the "From" header display name on outgoing text
messages.

Change-Id: Idacf5900bfd5f22ab8cd235aa56dfad090d18489
2018-04-17 10:30:23 -06:00

447 lines
12 KiB
C
Raw Blame History

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2010, Digium, Inc.
*
* David Vossel <dvossel@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 Trace internal ast_frames on a channel.
*
* \author David Vossel <dvossel@digium.com>
*
* \ingroup functions
*/
/*** MODULEINFO
<support_level>extended</support_level>
***/
#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/framehook.h"
/*** DOCUMENTATION
<function name="FRAME_TRACE" language="en_US">
<synopsis>
View internal ast_frames as they are read and written on a channel.
</synopsis>
<syntax>
<parameter name="filter list type" required="true">
<para>A filter can be applied to the trace to limit what frames are viewed. This
filter can either be a <literal>white</literal> or <literal>black</literal> list
of frame types. When no filter type is present, <literal>white</literal> is
used. If no arguments are provided at all, all frames will be output.
</para>
<para>Below are the different types of frames that can be filtered.</para>
<enumlist>
<enum name = "DTMF_BEGIN" />
<enum name = "DTMF_END" />
<enum name = "VOICE" />
<enum name = "VIDEO" />
<enum name = "CONTROL" />
<enum name = "NULL" />
<enum name = "IAX" />
<enum name = "TEXT" />
<enum name = "TEXT_DATA" />
<enum name = "IMAGE" />
<enum name = "HTML" />
<enum name = "CNG" />
<enum name = "MODEM" />
</enumlist>
</parameter>
</syntax>
<description>
<para>Examples:</para>
<para>exten => 1,1,Set(FRAME_TRACE(white)=DTMF_BEGIN,DTMF_END); view only DTMF frames. </para>
<para>exten => 1,1,Set(FRAME_TRACE()=DTMF_BEGIN,DTMF_END); view only DTMF frames. </para>
<para>exten => 1,1,Set(FRAME_TRACE(black)=DTMF_BEGIN,DTMF_END); view everything except DTMF frames. </para>
</description>
</function>
***/
static void print_frame(struct ast_frame *frame);
static struct {
enum ast_frame_type type;
const char *str;
} frametype2str[] = {
{ AST_FRAME_DTMF_BEGIN, "DTMF_BEGIN" },
{ AST_FRAME_DTMF_END, "DTMF_END" },
{ AST_FRAME_VOICE, "VOICE" },
{ AST_FRAME_VIDEO, "VIDEO" },
{ AST_FRAME_CONTROL, "CONTROL" },
{ AST_FRAME_NULL, "NULL" },
{ AST_FRAME_IAX, "IAX" },
{ AST_FRAME_TEXT, "TEXT" },
{ AST_FRAME_TEXT_DATA, "TEXT_DATA" },
{ AST_FRAME_IMAGE, "IMAGE" },
{ AST_FRAME_HTML, "HTML" },
{ AST_FRAME_CNG, "CNG" },
{ AST_FRAME_MODEM, "MODEM" },
};
struct frame_trace_data {
int list_type; /* 0 = white, 1 = black */
int values[ARRAY_LEN(frametype2str)];
};
static void datastore_destroy_cb(void *data) {
ast_free(data);
}
static const struct ast_datastore_info frame_trace_datastore = {
.type = "frametrace",
.destroy = datastore_destroy_cb
};
static void hook_destroy_cb(void *framedata)
{
ast_free(framedata);
}
static struct ast_frame *hook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
{
int i;
int show_frame = 0;
struct frame_trace_data *framedata = data;
if (!frame) {
return frame;
}
if ((event != AST_FRAMEHOOK_EVENT_WRITE) && (event != AST_FRAMEHOOK_EVENT_READ)) {
return frame;
}
for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
if (frame->frametype == frametype2str[i].type) {
if ((framedata->list_type == 0) && (framedata->values[i])) { /* white list */
show_frame = 1;
} else if ((framedata->list_type == 1) && (!framedata->values[i])){ /* black list */
show_frame = 1;
}
break;
}
}
if (show_frame) {
ast_verbose("%s on Channel %s\n", event == AST_FRAMEHOOK_EVENT_READ ? "<--Read" : "--> Write", ast_channel_name(chan));
print_frame(frame);
}
return frame;
}
static int frame_trace_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value)
{
struct frame_trace_data *framedata;
struct ast_datastore *datastore = NULL;
struct ast_framehook_interface interface = {
.version = AST_FRAMEHOOK_INTERFACE_VERSION,
.event_cb = hook_event_cb,
.destroy_cb = hook_destroy_cb,
};
int i = 0;
if (!chan) {
ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
return -1;
}
if (!(framedata = ast_calloc(1, sizeof(*framedata)))) {
return 0;
}
interface.data = framedata;
if (!strcasecmp(data, "black")) {
framedata->list_type = 1;
}
for (i = 0; i < ARRAY_LEN(frametype2str); i++) {
if (strcasestr(value, frametype2str[i].str)) {
framedata->values[i] = 1;
}
}
ast_channel_lock(chan);
i = ast_framehook_attach(chan, &interface);
if (i >= 0) {
int *id;
if ((datastore = ast_channel_datastore_find(chan, &frame_trace_datastore, NULL))) {
id = datastore->data;
ast_framehook_detach(chan, *id);
ast_channel_datastore_remove(chan, datastore);
ast_datastore_free(datastore);
}
if (!(datastore = ast_datastore_alloc(&frame_trace_datastore, NULL))) {
ast_framehook_detach(chan, i);
ast_channel_unlock(chan);
return 0;
}
if (!(id = ast_calloc(1, sizeof(int)))) {
ast_datastore_free(datastore);
ast_framehook_detach(chan, i);
ast_channel_unlock(chan);
return 0;
}
*id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
datastore->data = id;
ast_channel_datastore_add(chan, datastore);
}
ast_channel_unlock(chan);
return 0;
}
static void print_frame(struct ast_frame *frame)
{
switch (frame->frametype) {
case AST_FRAME_DTMF_END:
ast_verbose("FrameType: DTMF END\n");
ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
break;
case AST_FRAME_VOICE:
ast_verbose("FrameType: VOICE\n");
ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
ast_verbose("MS: %ld\n", frame->len);
ast_verbose("Samples: %d\n", frame->samples);
ast_verbose("Bytes: %d\n", frame->datalen);
break;
case AST_FRAME_VIDEO:
ast_verbose("FrameType: VIDEO\n");
ast_verbose("Codec: %s\n", ast_format_get_name(frame->subclass.format));
ast_verbose("MS: %ld\n", frame->len);
ast_verbose("Samples: %d\n", frame->samples);
ast_verbose("Bytes: %d\n", frame->datalen);
break;
case AST_FRAME_CONTROL:
ast_verbose("FrameType: CONTROL\n");
switch ((enum ast_control_frame_type) frame->subclass.integer) {
case AST_CONTROL_HANGUP:
ast_verbose("SubClass: HANGUP\n");
break;
case AST_CONTROL_RING:
ast_verbose("SubClass: RING\n");
break;
case AST_CONTROL_RINGING:
ast_verbose("SubClass: RINGING\n");
break;
case AST_CONTROL_ANSWER:
ast_verbose("SubClass: ANSWER\n");
break;
case AST_CONTROL_BUSY:
ast_verbose("SubClass: BUSY\n");
break;
case AST_CONTROL_TAKEOFFHOOK:
ast_verbose("SubClass: TAKEOFFHOOK\n");
break;
case AST_CONTROL_OFFHOOK:
ast_verbose("SubClass: OFFHOOK\n");
break;
case AST_CONTROL_CONGESTION:
ast_verbose("SubClass: CONGESTION\n");
break;
case AST_CONTROL_FLASH:
ast_verbose("SubClass: FLASH\n");
break;
case AST_CONTROL_WINK:
ast_verbose("SubClass: WINK\n");
break;
case AST_CONTROL_OPTION:
ast_verbose("SubClass: OPTION\n");
break;
case AST_CONTROL_RADIO_KEY:
ast_verbose("SubClass: RADIO KEY\n");
break;
case AST_CONTROL_RADIO_UNKEY:
ast_verbose("SubClass: RADIO UNKEY\n");
break;
case AST_CONTROL_PROGRESS:
ast_verbose("SubClass: PROGRESS\n");
break;
case AST_CONTROL_PROCEEDING:
ast_verbose("SubClass: PROCEEDING\n");
break;
case AST_CONTROL_HOLD:
ast_verbose("SubClass: HOLD\n");
break;
case AST_CONTROL_UNHOLD:
ast_verbose("SubClass: UNHOLD\n");
break;
case AST_CONTROL_VIDUPDATE:
ast_verbose("SubClass: VIDUPDATE\n");
break;
case _XXX_AST_CONTROL_T38:
ast_verbose("SubClass: XXX T38\n");
break;
case AST_CONTROL_SRCUPDATE:
ast_verbose("SubClass: SRCUPDATE\n");
break;
case AST_CONTROL_TRANSFER:
ast_verbose("SubClass: TRANSFER\n");
break;
case AST_CONTROL_CONNECTED_LINE:
ast_verbose("SubClass: CONNECTED LINE\n");
break;
case AST_CONTROL_REDIRECTING:
ast_verbose("SubClass: REDIRECTING\n");
break;
case AST_CONTROL_T38_PARAMETERS:
ast_verbose("SubClass: T38 PARAMETERS\n");
break;
case AST_CONTROL_CC:
ast_verbose("SubClass: CC\n");
break;
case AST_CONTROL_SRCCHANGE:
ast_verbose("SubClass: SRCCHANGE\n");
break;
case AST_CONTROL_READ_ACTION:
ast_verbose("SubClass: READ ACTION\n");
break;
case AST_CONTROL_AOC:
ast_verbose("SubClass: AOC\n");
break;
case AST_CONTROL_MCID:
ast_verbose("SubClass: MCID\n");
break;
case AST_CONTROL_INCOMPLETE:
ast_verbose("SubClass: INCOMPLETE\n");
break;
case AST_CONTROL_END_OF_Q:
ast_verbose("SubClass: END_OF_Q\n");
break;
case AST_CONTROL_UPDATE_RTP_PEER:
ast_verbose("SubClass: UPDATE_RTP_PEER\n");
break;
case AST_CONTROL_PVT_CAUSE_CODE:
ast_verbose("SubClass: PVT_CAUSE_CODE\n");
break;
case AST_CONTROL_MASQUERADE_NOTIFY:
/* Should never happen. */
ast_assert(0);
break;
case AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE:
ast_verbose("SubClass: STREAM_TOPOLOGY_REQUEST_CHANGE\n");
break;
case AST_CONTROL_STREAM_TOPOLOGY_CHANGED:
ast_verbose("SubClass: STREAM_TOPOLOGY_CHANGED\n");
break;
case AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED:
ast_verbose("SubClass: STREAM_TOPOLOGY_SOURCE_CHANGED\n");
break;
case AST_CONTROL_STREAM_STOP:
ast_verbose("SubClass: STREAM_STOP\n");
break;
case AST_CONTROL_STREAM_SUSPEND:
ast_verbose("SubClass: STREAM_SUSPEND\n");
break;
case AST_CONTROL_STREAM_RESTART:
ast_verbose("SubClass: STREAM_RESTART\n");
break;
case AST_CONTROL_STREAM_REVERSE:
ast_verbose("SubClass: STREAM_REVERSE\n");
break;
case AST_CONTROL_STREAM_FORWARD:
ast_verbose("SubClass: STREAM_FORWARD\n");
break;
case AST_CONTROL_RECORD_CANCEL:
ast_verbose("SubClass: RECORD_CANCEL\n");
break;
case AST_CONTROL_RECORD_STOP:
ast_verbose("SubClass: RECORD_STOP\n");
break;
case AST_CONTROL_RECORD_SUSPEND:
ast_verbose("SubClass: RECORD_SUSPEND\n");
break;
case AST_CONTROL_RECORD_MUTE:
ast_verbose("SubClass: RECORD_MUTE\n");
break;
}
if (frame->subclass.integer == -1) {
ast_verbose("SubClass: %d\n", frame->subclass.integer);
}
ast_verbose("Bytes: %d\n", frame->datalen);
break;
case AST_FRAME_RTCP:
ast_verbose("FrameType: RTCP\n");
break;
case AST_FRAME_NULL:
ast_verbose("FrameType: NULL\n");
break;
case AST_FRAME_IAX:
ast_verbose("FrameType: IAX\n");
break;
case AST_FRAME_TEXT:
ast_verbose("FrameType: TXT\n");
break;
case AST_FRAME_TEXT_DATA:
ast_verbose("FrameType: TXT_DATA\n");
break;
case AST_FRAME_IMAGE:
ast_verbose("FrameType: IMAGE\n");
break;
case AST_FRAME_HTML:
ast_verbose("FrameType: HTML\n");
break;
case AST_FRAME_CNG:
ast_verbose("FrameType: CNG\n");
break;
case AST_FRAME_MODEM:
ast_verbose("FrameType: MODEM\n");
break;
case AST_FRAME_DTMF_BEGIN:
ast_verbose("FrameType: DTMF BEGIN\n");
ast_verbose("Digit: 0x%02X '%c'\n", (unsigned)frame->subclass.integer,
frame->subclass.integer < ' ' ? ' ' : frame->subclass.integer);
break;
case AST_FRAME_BRIDGE_ACTION:
ast_verbose("FrameType: Bridge\n");
ast_verbose("SubClass: %d\n", frame->subclass.integer);
break;
case AST_FRAME_BRIDGE_ACTION_SYNC:
ast_verbose("Frametype: Synchronous Bridge\n");
ast_verbose("Subclass: %d\n", frame->subclass.integer);
break;
}
ast_verbose("Src: %s\n", ast_strlen_zero(frame->src) ? "NOT PRESENT" : frame->src);
ast_verbose("\n");
}
static struct ast_custom_function frame_trace_function = {
.name = "FRAME_TRACE",
.write = frame_trace_helper,
};
static int unload_module(void)
{
return ast_custom_function_unregister(&frame_trace_function);
}
static int load_module(void)
{
int res = ast_custom_function_register(&frame_trace_function);
return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
}
AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Frame Trace for internal ast_frame debugging.");
Reference in a new issue View git blame Copy permalink