0ac121f15b084a7d95f25008b237784d973c727f
[asterisk/asterisk.git] / funcs / func_volume.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007, 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 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/module.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/linkedlists.h"
38 #include "asterisk/audiohook.h"
39
40 struct volume_information {
41         struct ast_audiohook audiohook;
42         int tx_gain;
43         int rx_gain;
44 };
45
46 static void destroy_callback(void *data)
47 {
48         struct volume_information *vi = data;
49
50         /* Destroy the audiohook, and destroy ourselves */
51         ast_audiohook_destroy(&vi->audiohook);
52         free(vi);
53
54         return;
55 }
56
57 /*! \brief Static structure for datastore information */
58 static const struct ast_datastore_info volume_datastore = {
59         .type = "volume",
60         .destroy = destroy_callback
61 };
62
63 static int volume_callback(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction)
64 {
65         struct ast_datastore *datastore = NULL;
66         struct volume_information *vi = NULL;
67         int *gain = NULL;
68
69         /* If the audiohook is stopping it means the channel is shutting down.... but we let the datastore destroy take care of it */
70         if (audiohook->status == AST_AUDIOHOOK_STATUS_DONE)
71                 return 0;
72
73         /* Grab datastore which contains our gain information */
74         if (!(datastore = ast_channel_datastore_find(chan, &volume_datastore, NULL)))
75                 return 0;
76
77         vi = datastore->data;
78
79         /* If this is DTMF then allow them to increase/decrease the gains */
80         if (frame->frametype == AST_FRAME_DTMF) {
81                 /* Only use DTMF coming from the source... not going to it */
82                 if (direction != AST_AUDIOHOOK_DIRECTION_READ)
83                         return 0;
84                 if (frame->subclass == '*') {
85                         vi->tx_gain += 1;
86                         vi->rx_gain += 1;
87                 } else if (frame->subclass == '#') {
88                         vi->tx_gain -= 1;
89                         vi->rx_gain -= 1;
90                 }
91         } else if (frame->frametype == AST_FRAME_VOICE) {
92                 /* Based on direction of frame grab the gain, and confirm it is applicable */
93                 if (!(gain = (direction == AST_AUDIOHOOK_DIRECTION_READ) ? &vi->rx_gain : &vi->tx_gain) || !*gain)
94                         return 0;
95                 /* Apply gain to frame... easy as pi */
96                 ast_frame_adjust_volume(frame, *gain);
97         }
98
99         return 0;
100 }
101
102 static int volume_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
103 {
104         struct ast_datastore *datastore = NULL;
105         struct volume_information *vi = NULL;
106         int is_new = 0;
107
108         if (!(datastore = ast_channel_datastore_find(chan, &volume_datastore, NULL))) {
109                 /* Allocate a new datastore to hold the reference to this volume and audiohook information */
110                 if (!(datastore = ast_channel_datastore_alloc(&volume_datastore, NULL)))
111                         return 0;
112                 if (!(vi = ast_calloc(1, sizeof(*vi)))) {
113                         ast_channel_datastore_free(datastore);
114                         return 0;
115                 }
116                 ast_audiohook_init(&vi->audiohook, AST_AUDIOHOOK_TYPE_MANIPULATE, "Volume");
117                 vi->audiohook.manipulate_callback = volume_callback;
118                 ast_set_flag(&vi->audiohook, AST_AUDIOHOOK_WANTS_DTMF);
119                 is_new = 1;
120         } else {
121                 vi = datastore->data;
122         }
123
124         /* Adjust gain on volume information structure */
125         if (!strcasecmp(data, "tx"))
126                 vi->tx_gain = atoi(value);
127         else if (!strcasecmp(data, "rx"))
128                 vi->rx_gain = atoi(value);
129
130         if (is_new) {
131                 datastore->data = vi;
132                 ast_channel_datastore_add(chan, datastore);
133                 ast_audiohook_attach(chan, &vi->audiohook);
134         }
135
136         return 0;
137 }
138
139 static struct ast_custom_function volume_function = {
140         .name = "VOLUME",
141         .synopsis = "Set the TX or RX volume of a channel",
142         .syntax = "VOLUME(TX|RX)",
143         .desc =
144         "  The VOLUME function can be used to increase or decrease the tx or\n"
145         "rx gain of any channel.  For example:\n"
146         "  Set(VOLUME(TX)=3)\n"
147         "  Set(VOLUME(RX)=2)\n",
148         .write = volume_write,
149 };
150
151 static int unload_module(void)
152 {
153         return ast_custom_function_unregister(&volume_function);
154 }
155
156 static int load_module(void)
157 {
158         return ast_custom_function_register(&volume_function);
159 }
160
161 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Technology independent volume control");