Add support for parsing SDP attributes, generating SDP attributes, and passing it...
[asterisk/asterisk.git] / res / res_format_attr_silk.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2011, Digium, Inc.
5  *
6  * David Vossel <dvossel@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 /*!
20  * \file
21  * \brief SILK format attribute interface
22  *
23  * \author David Vossel <dvossel@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/module.h"
35 #include "asterisk/format.h"
36
37 /*!
38  * \brief SILK attribute structure.
39  *
40  * \note The only attribute that affects compatibility here is the sample rate.
41  */
42 struct silk_attr {
43         unsigned int samplerate;
44         unsigned int maxbitrate;
45         unsigned int dtx;
46         unsigned int fec;
47         unsigned int packetloss_percentage;
48 };
49
50 static int silk_sdp_parse(struct ast_format_attr *format_attr, const char *attributes)
51 {
52         struct silk_attr *attr = (struct silk_attr *) format_attr;
53         unsigned int val;
54
55         if (sscanf(attributes, "maxaveragebitrate=%30u", &val) == 1) {
56                 attr->maxbitrate = val;
57         }
58         if (sscanf(attributes, "usedtx=%30u", &val) == 1) {
59                 attr->dtx = val;
60         }
61         if (sscanf(attributes, "useinbandfec=%30u", &val) == 1) {
62                 attr->fec = val;
63         }
64
65         return 0;
66 }
67
68 static void silk_sdp_generate(const struct ast_format_attr *format_attr, unsigned int payload, struct ast_str **str)
69 {
70         struct silk_attr *attr = (struct silk_attr *) format_attr;
71
72         if ((attr->maxbitrate > 5000) && (attr->maxbitrate < 40000)) { 
73                 ast_str_append(str, 0, "a=fmtp:%d maxaveragebitrate=%d\r\n", payload, attr->maxbitrate);
74         }
75
76         ast_str_append(str, 0, "a=fmtp:%d usedtx=%d\r\n", payload, attr->dtx);
77         ast_str_append(str, 0, "a=fmtp:%d useinbandfec=%d\r\n", payload, attr->fec);
78 }
79
80 static enum ast_format_cmp_res silk_cmp(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2)
81 {
82         struct silk_attr *attr1 = (struct silk_attr *) fattr1;
83         struct silk_attr *attr2 = (struct silk_attr *) fattr2;
84
85         if (attr1->samplerate == attr2->samplerate) {
86                 return AST_FORMAT_CMP_EQUAL;
87         }
88         return AST_FORMAT_CMP_NOT_EQUAL;
89 }
90
91 static int silk_get_val(const struct ast_format_attr *fattr, int key, void *result)
92 {
93         const struct silk_attr *attr = (struct silk_attr *) fattr;
94         int *val = result;
95
96         switch (key) {
97         case SILK_ATTR_KEY_SAMP_RATE:
98                 *val = attr->samplerate;
99                 break;
100         case SILK_ATTR_KEY_MAX_BITRATE:
101                 *val = attr->maxbitrate;
102                 break;
103         case SILK_ATTR_KEY_DTX:
104                 *val = attr->dtx;
105                 break;
106         case SILK_ATTR_KEY_FEC:
107                 *val = attr->fec;
108                 break;
109         case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
110                 *val = attr->packetloss_percentage;
111                 break;
112         default:
113                 ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
114                 return -1;
115         }
116         return 0;
117 }
118
119 static int silk_isset(const struct ast_format_attr *fattr, va_list ap)
120 {
121         enum silk_attr_keys key;
122         const struct silk_attr *attr = (struct silk_attr *) fattr;
123
124         for (key = va_arg(ap, int);
125                 key != AST_FORMAT_ATTR_END;
126                 key = va_arg(ap, int))
127         {
128                 switch (key) {
129                 case SILK_ATTR_KEY_SAMP_RATE:
130                         if (attr->samplerate != (va_arg(ap, int))) {
131                                 return -1;
132                         }
133                         break;
134                 case SILK_ATTR_KEY_MAX_BITRATE:
135                         if (attr->maxbitrate != (va_arg(ap, int))) {
136                                 return -1;
137                         }
138                         break;
139                 case SILK_ATTR_KEY_DTX:
140                         if (attr->dtx != (va_arg(ap, int))) {
141                                 return -1;
142                         }
143                         break;
144                 case SILK_ATTR_KEY_FEC:
145                         if (attr->fec != (va_arg(ap, int))) {
146                                 return -1;
147                         }
148                         break;
149                 case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
150                         if (attr->packetloss_percentage != (va_arg(ap, int))) {
151                                 return -1;
152                         }
153                         break;
154                 default:
155                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
156                         return -1;
157                 }
158         }
159         return 0;
160 }
161 static int silk_getjoint(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2, struct ast_format_attr *result)
162 {
163         struct silk_attr *attr1 = (struct silk_attr *) fattr1;
164         struct silk_attr *attr2 = (struct silk_attr *) fattr2;
165         struct silk_attr *attr_res = (struct silk_attr *) result;
166         int joint = -1;
167
168         attr_res->samplerate = attr1->samplerate & attr2->samplerate;
169         /* sample rate is the only attribute that has any bearing on if joint capabilities exist or not */
170         if (attr_res->samplerate) {
171                 joint = 0;
172         }
173         /* Take the lowest max bitrate */
174         attr_res->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
175
176         /* Only do dtx if both sides want it. DTX is a trade off between
177          * computational complexity and bandwidth. */
178         attr_res->dtx = attr1->dtx && attr2->dtx ? 1 : 0;
179
180         /* Only do FEC if both sides want it.  If a peer specifically requests not
181          * to receive with FEC, it may be a waste of bandwidth. */
182         attr_res->fec = attr1->fec && attr2->fec ? 1 : 0;
183
184         /* Use the maximum packetloss percentage between the two attributes. This affects how
185          * much redundancy is used in the FEC. */
186         attr_res->packetloss_percentage = MAX(attr1->packetloss_percentage, attr2->packetloss_percentage);
187         return joint;
188 }
189
190 static void silk_set(struct ast_format_attr *fattr, va_list ap)
191 {
192         enum silk_attr_keys key;
193         struct silk_attr *attr = (struct silk_attr *) fattr;
194
195         for (key = va_arg(ap, int);
196                 key != AST_FORMAT_ATTR_END;
197                 key = va_arg(ap, int))
198         {
199                 switch (key) {
200                 case SILK_ATTR_KEY_SAMP_RATE:
201                         attr->samplerate = (va_arg(ap, int));
202                         break;
203                 case SILK_ATTR_KEY_MAX_BITRATE:
204                         attr->maxbitrate = (va_arg(ap, int));
205                         break;
206                 case SILK_ATTR_KEY_DTX:
207                         attr->dtx = (va_arg(ap, int));
208                         break;
209                 case SILK_ATTR_KEY_FEC:
210                         attr->fec = (va_arg(ap, int));
211                         break;
212                 case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
213                         attr->packetloss_percentage = (va_arg(ap, int));
214                         break;
215                 default:
216                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
217                 }
218         }
219 }
220
221 static struct ast_format_attr_interface silk_interface = {
222         .id = AST_FORMAT_SILK,
223         .format_attr_cmp = silk_cmp,
224         .format_attr_get_joint = silk_getjoint,
225         .format_attr_set = silk_set,
226         .format_attr_isset = silk_isset,
227         .format_attr_get_val = silk_get_val,
228         .format_attr_sdp_parse = silk_sdp_parse,
229         .format_attr_sdp_generate = silk_sdp_generate,
230 };
231
232 static int load_module(void)
233 {
234         if (ast_format_attr_reg_interface(&silk_interface)) {
235                 return AST_MODULE_LOAD_DECLINE;
236         }
237
238         return AST_MODULE_LOAD_SUCCESS;
239 }
240
241 static int unload_module(void)
242 {
243         ast_format_attr_unreg_interface(&silk_interface);
244         return 0;
245 }
246
247 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SILK Format Attribute Module",
248         .load = load_module,
249         .unload = unload_module,
250         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
251 );