Asterisk - The Open Source Telephony Project GIT-master-2de1a68
func_volume.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 2011, Digium, Inc.
5 *
6 * Joshua Colp <jcolp@digium.com>
7 *
8 * See http://www.asterisk.org for more information about
9 * the Asterisk project. Please do not directly contact
10 * any of the maintainers of this project for assistance;
11 * the project provides a web site, mailing lists and IRC
12 * channels for your use.
13 *
14 * This program is free software, distributed under the terms of
15 * the GNU General Public License Version 2. See the LICENSE file
16 * at the top of the source tree.
17 */
18
19/*! \file
20 *
21 * \brief Technology independent volume control
22 *
23 * \author Joshua Colp <jcolp@digium.com>
24 *
25 * \ingroup functions
26 *
27 */
28
29/*** MODULEINFO
30 <support_level>core</support_level>
31 ***/
32
33#include "asterisk.h"
34
35#include "asterisk/module.h"
36#include "asterisk/channel.h"
37#include "asterisk/pbx.h"
38#include "asterisk/utils.h"
39#include "asterisk/audiohook.h"
40#include "asterisk/app.h"
41
42/*** DOCUMENTATION
43 <function name="VOLUME" language="en_US">
44 <synopsis>
45 Set or get the TX or RX volume of a channel.
46 </synopsis>
47 <syntax>
48 <parameter name="direction" required="true">
49 <para>Must be <literal>TX</literal> or <literal>RX</literal>.</para>
50 </parameter>
51 <parameter name="options">
52 <optionlist>
53 <option name="p">
54 <para>Enable DTMF volume control</para>
55 </option>
56 </optionlist>
57 </parameter>
58 </syntax>
59 <description>
60 <para>The VOLUME function can be used to increase or decrease the <literal>tx</literal> or
61 <literal>rx</literal> gain of any channel.</para>
62 <example title="Increase volume">
63 same => n,Set(VOLUME(TX)=3)
64 </example>
65 <example title="Increase volume">
66 same => n,Set(VOLUME(RX)=2)
67 </example>
68 <example title="Increase volume with DTMF control">
69 same => n,Set(VOLUME(TX,p)=3)
70 </example>
71 <example title="Increase RX volume with DTMF control">
72 same => n,Set(VOLUME(RX,p)=3)
73 </example>
74 <example title="Decrease RX volume">
75 same => n,Set(VOLUME(RX)=-4)
76 </example>
77 <example title="Reset to normal">
78 same => n,Set(VOLUME(RX)=0)
79 </example>
80 </description>
81 </function>
82 ***/
83
86 float tx_gain;
87 float rx_gain;
88 unsigned int flags;
89};
90
93};
94
97});
98
99static void destroy_callback(void *data)
100{
101 struct volume_information *vi = data;
102
103 /* Destroy the audiohook, and destroy ourselves */
108 ast_free(vi);
109
110 return;
111}
112
113/*! \brief Static structure for datastore information */
115 .type = "volume",
116 .destroy = destroy_callback
117};
118
119static int volume_callback(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction)
120{
121 struct ast_datastore *datastore = NULL;
122 struct volume_information *vi = NULL;
123 float *gain = NULL;
124
125 /* If the audiohook is stopping it means the channel is shutting down.... but we let the datastore destroy take care of it */
127 return 0;
128
129 /* Grab datastore which contains our gain information */
130 if (!(datastore = ast_channel_datastore_find(chan, &volume_datastore, NULL)))
131 return 0;
132
133 vi = datastore->data;
134
135 /* If this is DTMF then allow them to increase/decrease the gains */
137 if (frame->frametype == AST_FRAME_DTMF) {
138 /* Only use DTMF coming from the source... not going to it */
140 return 0;
141 if (frame->subclass.integer == '*') {
142 vi->tx_gain += 1;
143 vi->rx_gain += 1;
144 } else if (frame->subclass.integer == '#') {
145 vi->tx_gain -= 1;
146 vi->rx_gain -= 1;
147 }
148 }
149 }
150
151
152 if (frame->frametype == AST_FRAME_VOICE) {
153 /* Based on direction of frame grab the gain, and confirm it is applicable */
154 if (!(gain = (direction == AST_AUDIOHOOK_DIRECTION_READ) ? &vi->rx_gain : &vi->tx_gain) || !*gain)
155 return 0;
156 /* Apply gain to frame... easy as pi */
157 ast_frame_adjust_volume_float(frame, *gain);
158 }
159
160 return 0;
161}
162
163static int volume_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
164{
165 struct ast_datastore *datastore = NULL;
166 struct volume_information *vi = NULL;
167 int is_new = 0;
168
169 /* Separate options from argument */
170
174 );
175
176 if (!chan) {
177 ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
178 return -1;
179 }
180
182
183 ast_channel_lock(chan);
184 if (!(datastore = ast_channel_datastore_find(chan, &volume_datastore, NULL))) {
185 ast_channel_unlock(chan);
186 /* Allocate a new datastore to hold the reference to this volume and audiohook information */
187 if (!(datastore = ast_datastore_alloc(&volume_datastore, NULL)))
188 return 0;
189 if (!(vi = ast_calloc(1, sizeof(*vi)))) {
190 ast_datastore_free(datastore);
191 return 0;
192 }
196 is_new = 1;
197 } else {
198 ast_channel_unlock(chan);
199 vi = datastore->data;
200 }
201
202 /* Adjust gain on volume information structure */
203 if (ast_strlen_zero(args.direction)) {
204 ast_log(LOG_ERROR, "Direction must be specified for VOLUME function\n");
205 return -1;
206 }
207
208 if (!strcasecmp(args.direction, "tx")) {
209 vi->tx_gain = atof(value);
210 } else if (!strcasecmp(args.direction, "rx")) {
211 vi->rx_gain = atof(value);
212 } else {
213 ast_log(LOG_ERROR, "Direction must be either RX or TX\n");
214 }
215
216 if (is_new) {
217 datastore->data = vi;
218 ast_channel_lock(chan);
219 ast_channel_datastore_add(chan, datastore);
220 ast_channel_unlock(chan);
222 }
223
224 /* Add Option data to struct */
225
226 if (!ast_strlen_zero(args.options)) {
227 struct ast_flags flags = { 0 };
229 vi->flags = flags.flags;
230 } else {
231 vi->flags = 0;
232 }
233
234 return 0;
235}
236
237static int volume_read(struct ast_channel *chan, const char *cmd, char *data, char *buffer, size_t buflen)
238{
239 struct ast_datastore *datastore = NULL;
240 struct volume_information *vi = NULL;
241
242 /* Separate options from argument */
243
247 );
248
249 if (!chan) {
250 ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
251 return -1;
252 }
253
255
256 ast_channel_lock(chan);
257 if (!(datastore = ast_channel_datastore_find(chan, &volume_datastore, NULL))) {
258 ast_channel_unlock(chan);
259 return -1; /* no active audiohook, nothing to read */
260 } else {
261 ast_channel_unlock(chan);
262 vi = datastore->data;
263 }
264
265 /* Obtain current gain using volume information structure */
266 if (ast_strlen_zero(args.direction)) {
267 ast_log(LOG_ERROR, "Direction must be specified for VOLUME function\n");
268 return -1;
269 }
270
271 if (!strcasecmp(args.direction, "tx")) {
272 snprintf(buffer, buflen, "%f", vi->tx_gain);
273 } else if (!strcasecmp(args.direction, "rx")) {
274 snprintf(buffer, buflen, "%f", vi->rx_gain);
275 } else {
276 ast_log(LOG_ERROR, "Direction must be either RX or TX\n");
277 }
278
279 return 0;
280}
281
283 .name = "VOLUME",
284 .write = volume_write,
285 .read = volume_read,
286};
287
288static int unload_module(void)
289{
291}
292
293static int load_module(void)
294{
296}
297
298AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Technology independent volume control");
Asterisk main include file. File version handling, generic pbx functions.
#define ast_free(a)
Definition: astmm.h:180
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ast_log
Definition: astobj2.c:42
Audiohooks Architecture.
@ AST_AUDIOHOOK_MANIPULATE_ALL_RATES
Definition: audiohook.h:75
int ast_audiohook_init(struct ast_audiohook *audiohook, enum ast_audiohook_type type, const char *source, enum ast_audiohook_init_flags flags)
Initialize an audiohook structure.
Definition: audiohook.c:100
ast_audiohook_direction
Definition: audiohook.h:48
@ AST_AUDIOHOOK_DIRECTION_READ
Definition: audiohook.h:49
#define ast_audiohook_lock(ah)
Lock an audiohook.
Definition: audiohook.h:313
@ AST_AUDIOHOOK_WANTS_DTMF
Definition: audiohook.h:58
int ast_audiohook_detach(struct ast_audiohook *audiohook)
Detach audiohook from channel.
Definition: audiohook.c:550
int ast_audiohook_attach(struct ast_channel *chan, struct ast_audiohook *audiohook)
Attach audiohook to channel.
Definition: audiohook.c:484
int ast_audiohook_destroy(struct ast_audiohook *audiohook)
Destroys an audiohook structure.
Definition: audiohook.c:124
#define ast_audiohook_unlock(ah)
Unlock an audiohook.
Definition: audiohook.h:318
@ AST_AUDIOHOOK_TYPE_MANIPULATE
Definition: audiohook.h:38
@ AST_AUDIOHOOK_STATUS_DONE
Definition: audiohook.h:45
General Asterisk PBX channel definitions.
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2385
#define ast_channel_lock(chan)
Definition: channel.h:2922
#define ast_channel_unlock(chan)
Definition: channel.h:2923
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2399
#define ast_datastore_alloc(info, uid)
Definition: datastore.h:85
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:68
direction
static struct ast_custom_function volume_function
Definition: func_volume.c:282
static const struct ast_datastore_info volume_datastore
Static structure for datastore information.
Definition: func_volume.c:114
static int volume_read(struct ast_channel *chan, const char *cmd, char *data, char *buffer, size_t buflen)
Definition: func_volume.c:237
static const struct ast_app_option volume_opts[128]
Definition: func_volume.c:97
static void destroy_callback(void *data)
Definition: func_volume.c:99
static int volume_callback(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction)
Definition: func_volume.c:119
static int load_module(void)
Definition: func_volume.c:293
static int unload_module(void)
Definition: func_volume.c:288
static int volume_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
Definition: func_volume.c:163
volume_flags
Definition: func_volume.c:91
@ VOLUMEFLAG_CHANGE
Definition: func_volume.c:92
Application convenience functions, designed to give consistent look and feel to Asterisk apps.
#define AST_APP_ARG(name)
Define an application argument.
#define AST_APP_OPTIONS(holder, options...)
Declares an array of options for an application.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
#define AST_APP_OPTION(option, flagno)
Declares an application option that does not accept an argument.
int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
Parses a string containing application options and sets flags/arguments.
Definition: main/app.c:3056
#define AST_FRAME_DTMF
int ast_frame_adjust_volume_float(struct ast_frame *f, float adjustment)
Adjusts the volume of the audio samples contained in a frame.
Definition: main/frame.c:812
@ AST_FRAME_VOICE
#define LOG_ERROR
#define LOG_WARNING
Asterisk module definitions.
#define AST_MODULE_INFO_STANDARD(keystr, desc)
Definition: module.h:567
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:46
Core PBX routines and definitions.
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1558
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
#define NULL
Definition: resample.c:96
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
ast_audiohook_manipulate_callback manipulate_callback
Definition: audiohook.h:118
enum ast_audiohook_status status
Definition: audiohook.h:108
Main Channel structure associated with a channel.
Data structure associated with a custom dialplan function.
Definition: pbx.h:118
const char * name
Definition: pbx.h:119
Structure for a data store type.
Definition: datastore.h:31
const char * type
Definition: datastore.h:32
Structure for a data store object.
Definition: datastore.h:64
void * data
Definition: datastore.h:66
Structure used to handle boolean flags.
Definition: utils.h:199
unsigned int flags
Definition: utils.h:200
Data structure associated with a single frame of data.
struct ast_frame_subclass subclass
enum ast_frame_type frametype
struct ast_audiohook audiohook
Definition: func_volume.c:85
unsigned int flags
Definition: func_volume.c:88
int value
Definition: syslog.c:37
const char * args
static struct test_options options
Utility functions.
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define ast_set_flag(p, flag)
Definition: utils.h:70