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