res_pjsip: improve realtime performance on CLI 'pjsip show contacts'
[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 #include "asterisk/module.h"
33 #include "asterisk/format.h"
34
35 /*!
36  * \brief SILK attribute structure.
37  *
38  * \note The only attribute that affects compatibility here is the sample rate.
39  */
40 struct silk_attr {
41         unsigned int maxbitrate;
42         unsigned int dtx;
43         unsigned int fec;
44         unsigned int packetloss_percentage;
45 };
46
47 static void silk_destroy(struct ast_format *format)
48 {
49         struct silk_attr *attr = ast_format_get_attribute_data(format);
50
51         ast_free(attr);
52 }
53
54 static void attr_init(struct silk_attr *attr)
55 {
56         memset(attr, 0, sizeof(*attr));
57 }
58
59 static int silk_clone(const struct ast_format *src, struct ast_format *dst)
60 {
61         struct silk_attr *original = ast_format_get_attribute_data(src);
62         struct silk_attr *attr = ast_malloc(sizeof(*attr));
63
64         if (!attr) {
65                 return -1;
66         }
67
68         if (original) {
69                 *attr = *original;
70         } else {
71                 attr_init(attr);
72         }
73
74         ast_format_set_attribute_data(dst, attr);
75
76         return 0;
77 }
78
79 static struct ast_format *silk_parse_sdp_fmtp(const struct ast_format *format, const char *attributes)
80 {
81         struct ast_format *cloned;
82         struct silk_attr *attr;
83         unsigned int val;
84
85         cloned = ast_format_clone(format);
86         if (!cloned) {
87                 return NULL;
88         }
89         attr = ast_format_get_attribute_data(cloned);
90
91         if (sscanf(attributes, "maxaveragebitrate=%30u", &val) == 1) {
92                 attr->maxbitrate = val;
93         }
94         if (sscanf(attributes, "usedtx=%30u", &val) == 1) {
95                 attr->dtx = val;
96         }
97         if (sscanf(attributes, "useinbandfec=%30u", &val) == 1) {
98                 attr->fec = val;
99         }
100
101         return cloned;
102 }
103
104 static void silk_generate_sdp_fmtp(const struct ast_format *format, unsigned int payload, struct ast_str **str)
105 {
106         struct silk_attr *attr = ast_format_get_attribute_data(format);
107
108         if (!attr) {
109                 return;
110         }
111
112         if ((attr->maxbitrate > 5000) && (attr->maxbitrate < 40000)) {
113                 ast_str_append(str, 0, "a=fmtp:%u maxaveragebitrate=%u\r\n", payload, attr->maxbitrate);
114         }
115
116         if (attr->dtx) {
117                 ast_str_append(str, 0, "a=fmtp:%u usedtx=%u\r\n", payload, attr->dtx);
118         }
119         if (attr->fec) {
120                 ast_str_append(str, 0, "a=fmtp:%u useinbandfec=%u\r\n", payload, attr->fec);
121         }
122 }
123
124 static enum ast_format_cmp_res silk_cmp(const struct ast_format *format1, const struct ast_format *format2)
125 {
126         if (ast_format_get_sample_rate(format1) == ast_format_get_sample_rate(format2)) {
127                 return AST_FORMAT_CMP_EQUAL;
128         }
129
130         return AST_FORMAT_CMP_NOT_EQUAL;
131 }
132
133 static struct ast_format *silk_getjoint(const struct ast_format *format1, const struct ast_format *format2)
134 {
135         struct silk_attr *attr1 = ast_format_get_attribute_data(format1);
136         struct silk_attr *attr2 = ast_format_get_attribute_data(format2);
137         struct ast_format *jointformat;
138         struct silk_attr *attr_res;
139
140         if (ast_format_get_sample_rate(format1) != ast_format_get_sample_rate(format2)) {
141                 return NULL;
142         }
143
144         jointformat = ast_format_clone(format1);
145         if (!jointformat) {
146                 return NULL;
147         }
148         attr_res = ast_format_get_attribute_data(jointformat);
149
150         if (!attr1 || !attr2) {
151                 attr_init(attr_res);
152         } else {
153                 /* Take the lowest max bitrate */
154                 attr_res->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
155
156                 /* Only do dtx if both sides want it. DTX is a trade off between
157                  * computational complexity and bandwidth. */
158                 attr_res->dtx = attr1->dtx && attr2->dtx ? 1 : 0;
159
160                 /* Only do FEC if both sides want it.  If a peer specifically requests not
161                  * to receive with FEC, it may be a waste of bandwidth. */
162                 attr_res->fec = attr1->fec && attr2->fec ? 1 : 0;
163
164                 /* Use the maximum packetloss percentage between the two attributes. This affects how
165                  * much redundancy is used in the FEC. */
166                 attr_res->packetloss_percentage = MAX(attr1->packetloss_percentage, attr2->packetloss_percentage);
167         }
168
169         return jointformat;
170 }
171
172 static struct ast_format *silk_set(const struct ast_format *format, const char *name, const char *value)
173 {
174         struct ast_format *cloned;
175         struct silk_attr *attr;
176         unsigned int val;
177
178         if (sscanf(value, "%30u", &val) != 1) {
179                 ast_log(LOG_WARNING, "Unknown value '%s' for attribute type '%s'\n",
180                         value, name);
181                 return NULL;
182         }
183
184         cloned = ast_format_clone(format);
185         if (!cloned) {
186                 return NULL;
187         }
188         attr = ast_format_get_attribute_data(cloned);
189
190         if (!strcasecmp(name, "max_bitrate")) {
191                 attr->maxbitrate = val;
192         } else if (!strcasecmp(name, "dtx")) {
193                 attr->dtx = val;
194         } else if (!strcasecmp(name, "fec")) {
195                 attr->fec = val;
196         } else if (!strcasecmp(name, "packetloss_percentage")) {
197                 attr->packetloss_percentage = val;
198         } else {
199                 ast_log(LOG_WARNING, "unknown attribute type %s\n", name);
200         }
201
202         return cloned;
203 }
204
205 static const void *silk_get(const struct ast_format *format, const char *name)
206 {
207         struct silk_attr *attr = ast_format_get_attribute_data(format);
208         unsigned int *val;
209
210         if (!strcasecmp(name, "max_bitrate")) {
211                 val = &attr->maxbitrate;
212         } else if (!strcasecmp(name, "dtx")) {
213                 val = &attr->dtx;
214         } else if (!strcasecmp(name, "fec")) {
215                 val = &attr->fec;
216         } else if (!strcasecmp(name, "packetloss_percentage")) {
217                 val = &attr->packetloss_percentage;
218         } else {
219                 ast_log(LOG_WARNING, "unknown attribute type %s\n", name);
220                 return NULL;
221         }
222
223         return val;
224 }
225
226 static struct ast_format_interface silk_interface = {
227         .format_destroy = silk_destroy,
228         .format_clone = silk_clone,
229         .format_cmp = silk_cmp,
230         .format_get_joint = silk_getjoint,
231         .format_attribute_set = silk_set,
232         .format_attribute_get = silk_get,
233         .format_parse_sdp_fmtp = silk_parse_sdp_fmtp,
234         .format_generate_sdp_fmtp = silk_generate_sdp_fmtp,
235 };
236
237 static int load_module(void)
238 {
239         if (ast_format_interface_register("silk", &silk_interface)) {
240                 return AST_MODULE_LOAD_DECLINE;
241         }
242
243         return AST_MODULE_LOAD_SUCCESS;
244 }
245
246 static int unload_module(void)
247 {
248         return 0;
249 }
250
251 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SILK Format Attribute Module",
252         .support_level = AST_MODULE_SUPPORT_CORE,
253         .load = load_module,
254         .unload = unload_module,
255         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
256 );