Merged revisions 319083 via svnmerge from
[asterisk/asterisk.git] / formats / 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 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "asterisk/module.h"
31 #include "asterisk/format.h"
32
33 /*!
34  * \brief SILK attribute structure.
35  *
36  * \note The only attribute that affects compatibility here is the sample rate.
37  */
38 struct silk_attr {
39         unsigned int samplerate;
40         unsigned int maxbitrate;
41         unsigned int dtx;
42         unsigned int fec;
43         unsigned int packetloss_percentage;
44 };
45
46 static enum ast_format_cmp_res silk_cmp(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2)
47 {
48         struct silk_attr *attr1 = (struct silk_attr *) fattr1;
49         struct silk_attr *attr2 = (struct silk_attr *) fattr2;
50
51         if (attr1->samplerate == attr2->samplerate) {
52                 return AST_FORMAT_CMP_EQUAL;
53         }
54         return AST_FORMAT_CMP_NOT_EQUAL;
55 }
56
57 static int silk_get_val(const struct ast_format_attr *fattr, int key, void *result)
58 {
59         const struct silk_attr *attr = (struct silk_attr *) fattr;
60         int *val = result;
61
62         switch (key) {
63         case SILK_ATTR_KEY_SAMP_RATE:
64                 *val = attr->samplerate;
65                 break;
66         case SILK_ATTR_KEY_MAX_BITRATE:
67                 *val = attr->maxbitrate;
68                 break;
69         case SILK_ATTR_KEY_DTX:
70                 *val = attr->dtx;
71                 break;
72         case SILK_ATTR_KEY_FEC:
73                 *val = attr->fec;
74                 break;
75         case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
76                 *val = attr->packetloss_percentage;
77                 break;
78         default:
79                 return -1;
80                 ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
81         }
82         return 0;
83 }
84
85 static int silk_isset(const struct ast_format_attr *fattr, va_list ap)
86 {
87         enum silk_attr_keys key;
88         const struct silk_attr *attr = (struct silk_attr *) fattr;
89
90         for (key = va_arg(ap, int);
91                 key != AST_FORMAT_ATTR_END;
92                 key = va_arg(ap, int))
93         {
94                 switch (key) {
95                 case SILK_ATTR_KEY_SAMP_RATE:
96                         if (attr->samplerate != (va_arg(ap, int))) {
97                                 return -1;
98                         }
99                         break;
100                 case SILK_ATTR_KEY_MAX_BITRATE:
101                         if (attr->maxbitrate != (va_arg(ap, int))) {
102                                 return -1;
103                         }
104                         break;
105                 case SILK_ATTR_KEY_DTX:
106                         if (attr->dtx != (va_arg(ap, int))) {
107                                 return -1;
108                         }
109                         break;
110                 case SILK_ATTR_KEY_FEC:
111                         if (attr->fec != (va_arg(ap, int))) {
112                                 return -1;
113                         }
114                         break;
115                 case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
116                         if (attr->packetloss_percentage != (va_arg(ap, int))) {
117                                 return -1;
118                         }
119                         break;
120                 default:
121                         return -1;
122                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
123                 }
124         }
125         return 0;
126 }
127 static int silk_getjoint(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2, struct ast_format_attr *result)
128 {
129         struct silk_attr *attr1 = (struct silk_attr *) fattr1;
130         struct silk_attr *attr2 = (struct silk_attr *) fattr2;
131         struct silk_attr *attr_res = (struct silk_attr *) result;
132         int joint = -1;
133
134         attr_res->samplerate = attr1->samplerate & attr2->samplerate;
135         /* sample rate is the only attribute that has any bearing on if joint capabilities exist or not */
136         if (attr_res->samplerate) {
137                 joint = 0;
138         }
139         /* Take the lowest max bitrate */
140         attr_res->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
141
142         /* Only do dtx if both sides want it. DTX is a trade off between
143          * computational complexity and bandwidth. */
144         attr_res->dtx = attr1->dtx && attr2->dtx ? 1 : 0;
145
146         /* Only do FEC if both sides want it.  If a peer specifically requests not
147          * to receive with FEC, it may be a waste of bandwidth. */
148         attr_res->fec = attr1->fec && attr2->fec ? 1 : 0;
149
150         /* Use the maximum packetloss percentage between the two attributes. This affects how
151          * much redundancy is used in the FEC. */
152         attr_res->packetloss_percentage = MAX(attr1->packetloss_percentage, attr2->packetloss_percentage);
153         return joint;
154 }
155
156 static void silk_set(struct ast_format_attr *fattr, va_list ap)
157 {
158         enum silk_attr_keys key;
159         struct silk_attr *attr = (struct silk_attr *) fattr;
160
161         for (key = va_arg(ap, int);
162                 key != AST_FORMAT_ATTR_END;
163                 key = va_arg(ap, int))
164         {
165                 switch (key) {
166                 case SILK_ATTR_KEY_SAMP_RATE:
167                         attr->samplerate = (va_arg(ap, int));
168                         break;
169                 case SILK_ATTR_KEY_MAX_BITRATE:
170                         attr->maxbitrate = (va_arg(ap, int));
171                         break;
172                 case SILK_ATTR_KEY_DTX:
173                         attr->dtx = (va_arg(ap, int));
174                         break;
175                 case SILK_ATTR_KEY_FEC:
176                         attr->fec = (va_arg(ap, int));
177                         break;
178                 case SILK_ATTR_KEY_PACKETLOSS_PERCENTAGE:
179                         attr->packetloss_percentage = (va_arg(ap, int));
180                         break;
181                 default:
182                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
183                 }
184         }
185 }
186
187 static struct ast_format_attr_interface silk_interface = {
188         .id = AST_FORMAT_SILK,
189         .format_attr_cmp = silk_cmp,
190         .format_attr_get_joint = silk_getjoint,
191         .format_attr_set = silk_set,
192         .format_attr_isset = silk_isset,
193         .format_attr_get_val = silk_get_val,
194 };
195
196 static int load_module(void)
197 {
198         if (ast_format_attr_reg_interface(&silk_interface)) {
199                 return AST_MODULE_LOAD_DECLINE;
200         }
201
202         return AST_MODULE_LOAD_SUCCESS;
203 }
204
205 static int unload_module(void)
206 {
207         ast_format_attr_unreg_interface(&silk_interface);
208         return 0;
209 }
210
211 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "SILK Format Attribute Module",
212         .load = load_module,
213         .unload = unload_module,
214         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
215 );