Removing registrar_expire from basic-pbx config
[asterisk/asterisk.git] / res / res_format_attr_opus.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Lorenzo Miniero <lorenzo@meetecho.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 Opus format attribute interface
22  *
23  * \author Lorenzo Miniero <lorenzo@meetecho.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 #include "asterisk/logger.h"
35 #include "asterisk/strings.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/opus.h"
38
39 /*!
40  * \brief Opus attribute structure.
41  *
42  * \note http://tools.ietf.org/html/rfc7587#section-6
43  */
44 struct opus_attr {
45         int maxbitrate;
46         int maxplayrate;
47         int ptime;
48         int stereo;
49         int cbr;
50         int fec;
51         int dtx;
52         int spropmaxcapturerate;
53         int spropstereo;
54         int maxptime;
55         /* Note data is expected to be an ao2_object type */
56         void *data;
57 };
58
59 static struct opus_attr default_opus_attr = {
60         .maxbitrate = CODEC_OPUS_DEFAULT_BITRATE,
61         .maxplayrate = CODEC_OPUS_DEFAULT_SAMPLE_RATE,
62         .ptime = CODEC_OPUS_DEFAULT_PTIME,
63         .stereo = CODEC_OPUS_DEFAULT_STEREO,
64         .cbr = CODEC_OPUS_DEFAULT_CBR,
65         .fec = CODEC_OPUS_DEFAULT_FEC,
66         .dtx = CODEC_OPUS_DEFAULT_DTX,
67         .spropmaxcapturerate = CODEC_OPUS_DEFAULT_SAMPLE_RATE,
68         .spropstereo = CODEC_OPUS_DEFAULT_STEREO,
69         .maxptime = CODEC_OPUS_DEFAULT_MAX_PTIME
70 };
71
72 static void opus_destroy(struct ast_format *format)
73 {
74         struct opus_attr *attr = ast_format_get_attribute_data(format);
75
76         if (!attr) {
77                 return;
78         }
79
80         ao2_cleanup(attr->data);
81         ast_free(attr);
82 }
83
84 static int opus_clone(const struct ast_format *src, struct ast_format *dst)
85 {
86         struct opus_attr *original = ast_format_get_attribute_data(src);
87         struct opus_attr *attr = ast_malloc(sizeof(*attr));
88
89         if (!attr) {
90                 return -1;
91         }
92
93         *attr = original ? *original : default_opus_attr;
94         ao2_bump(attr->data);
95
96         ast_format_set_attribute_data(dst, attr);
97         ast_format_set_channel_count(dst, ast_format_get_channel_count(src));
98
99         return 0;
100 }
101
102 static void sdp_fmtp_get(const char *attributes, const char *name, int *attr)
103 {
104         const char *kvp = attributes;
105         int val;
106
107         if (ast_strlen_zero(attributes)) {
108                 return;
109         }
110
111         /* This logic goes through each attribute in the fmtp line looking for the
112          * requested named attribute.
113          */
114         while (*kvp) {
115                 /* Skip any preceeding blanks as some implementations separate attributes using spaces too */
116                 kvp = ast_skip_blanks(kvp);
117
118                 /* If we are at the requested attribute get its value and return */
119                 if (!strncmp(kvp, name, strlen(name)) && kvp[strlen(name)] == '=') {
120                         if (sscanf(kvp, "%*[^=]=%30d", &val) == 1) {
121                                 *attr = val;
122                                 break;
123                         }
124                 }
125
126                 /* Move on to the next attribute if possible */
127                 kvp = strchr(kvp, ';');
128                 if (!kvp) {
129                         break;
130                 }
131
132                 kvp++;
133         }
134 }
135
136 static struct ast_format *opus_parse_sdp_fmtp(const struct ast_format *format, const char *attributes)
137 {
138         struct ast_format *cloned;
139         struct opus_attr *attr;
140
141         cloned = ast_format_clone(format);
142         if (!cloned) {
143                 return NULL;
144         }
145
146         attr = ast_format_get_attribute_data(cloned);
147
148         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE, &attr->maxplayrate);
149         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH,
150                 &attr->maxplayrate);
151         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE,
152                 &attr->spropmaxcapturerate);
153         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_MAX_PTIME, &attr->maxptime);
154         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_PTIME, &attr->ptime);
155         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE, &attr->maxbitrate);
156         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_STEREO, &attr->stereo);
157         if (attr->stereo) {
158                 ast_format_set_channel_count(cloned, 2);
159         }
160         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_SPROP_STEREO, &attr->spropstereo);
161         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_CBR, &attr->cbr);
162         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_FEC, &attr->fec);
163         sdp_fmtp_get(attributes, CODEC_OPUS_ATTR_DTX, &attr->dtx);
164
165         return cloned;
166 }
167
168 static void opus_generate_sdp_fmtp(const struct ast_format *format, unsigned int payload, struct ast_str **str)
169 {
170         struct opus_attr *attr = ast_format_get_attribute_data(format);
171         int base_fmtp_size;
172         int original_size;
173
174         if (!attr) {
175                 /*
176                  * (Only) cached formats do not have attribute data assigned because
177                  * they were created before this attribute module was registered.
178                  * Therefore, we assume the default attribute values here.
179                  */
180                 attr = &default_opus_attr;
181         }
182
183         original_size = ast_str_strlen(*str);
184         base_fmtp_size = ast_str_append(str, 0, "a=fmtp:%u ", payload);
185
186         if (CODEC_OPUS_DEFAULT_SAMPLE_RATE != attr->maxplayrate) {
187                 ast_str_append(str, 0, "%s=%d;",
188                         CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE, attr->maxplayrate);
189         }
190
191         if (CODEC_OPUS_DEFAULT_SAMPLE_RATE != attr->spropmaxcapturerate) {
192                 ast_str_append(str, 0, "%s=%d;",
193                         CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE, attr->spropmaxcapturerate);
194         }
195
196         if (CODEC_OPUS_DEFAULT_BITRATE != attr->maxbitrate || attr->maxbitrate > 0) {
197                 ast_str_append(str, 0, "%s=%d;",
198                         CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE, attr->maxbitrate);
199         }
200
201         if (CODEC_OPUS_DEFAULT_STEREO != attr->stereo) {
202                 ast_str_append(str, 0, "%s=%d;",
203                         CODEC_OPUS_ATTR_STEREO, attr->stereo);
204         }
205
206         if (CODEC_OPUS_DEFAULT_STEREO != attr->spropstereo) {
207                 ast_str_append(str, 0, "%s=%d;",
208                         CODEC_OPUS_ATTR_SPROP_STEREO, attr->spropstereo);
209         }
210
211         if (CODEC_OPUS_DEFAULT_CBR != attr->cbr) {
212                 ast_str_append(str, 0, "%s=%d;",
213                         CODEC_OPUS_ATTR_CBR, attr->cbr);
214         }
215
216         if (CODEC_OPUS_DEFAULT_FEC!= attr->fec) {
217                 ast_str_append(str, 0, "%s=%d;",
218                        CODEC_OPUS_ATTR_FEC, attr->fec);
219         }
220
221         if (CODEC_OPUS_DEFAULT_DTX != attr->dtx) {
222                 ast_str_append(str, 0, "%s=%d;",
223                         CODEC_OPUS_ATTR_DTX, attr->dtx);
224         }
225
226         if (base_fmtp_size == ast_str_strlen(*str) - original_size) {
227                 ast_str_truncate(*str, original_size);
228         } else {
229                 ast_str_truncate(*str, -1);
230                 ast_str_append(str, 0, "\r\n");
231         }
232 }
233
234 static struct ast_format *opus_getjoint(const struct ast_format *format1, const struct ast_format *format2)
235 {
236         struct opus_attr *attr1 = ast_format_get_attribute_data(format1);
237         struct opus_attr *attr2 = ast_format_get_attribute_data(format2);
238         struct ast_format *jointformat;
239         struct opus_attr *attr_res;
240
241         if (!attr1) {
242                 attr1 = &default_opus_attr;
243         }
244
245         if (!attr2) {
246                 attr2 = &default_opus_attr;
247         }
248
249         jointformat = ast_format_clone(format1);
250         if (!jointformat) {
251                 return NULL;
252         }
253
254         if (ast_format_get_channel_count(format1) == 2 || ast_format_get_channel_count(format2) == 2) {
255                 ast_format_set_channel_count(jointformat, 2);
256         }
257         attr_res = ast_format_get_attribute_data(jointformat);
258
259         attr_res->dtx = attr1->dtx || attr2->dtx ? 1 : 0;
260
261         /* Only do FEC if both sides want it.  If a peer specifically requests not
262          * to receive with FEC, it may be a waste of bandwidth. */
263         attr_res->fec = attr1->fec && attr2->fec ? 1 : 0;
264
265         attr_res->cbr = attr1->cbr || attr2->cbr ? 1 : 0;
266         attr_res->spropstereo = attr1->spropstereo || attr2->spropstereo ? 1 : 0;
267
268         /* Only do stereo if both sides want it.  If a peer specifically requests not
269          * to receive stereo signals, it may be a waste of bandwidth. */
270         attr_res->stereo = attr1->stereo && attr2->stereo ? 1 : 0;
271
272         if (attr1->maxbitrate < 0) {
273                 attr_res->maxbitrate = attr2->maxbitrate;
274         } else if (attr2->maxbitrate < 0) {
275                 attr_res->maxbitrate = attr1->maxbitrate;
276         } else {
277                 attr_res->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
278         }
279
280         attr_res->spropmaxcapturerate = MIN(attr1->spropmaxcapturerate, attr2->spropmaxcapturerate);
281         attr_res->maxplayrate = MIN(attr1->maxplayrate, attr2->maxplayrate);
282
283         return jointformat;
284 }
285
286 static struct ast_format *opus_set(const struct ast_format *format,
287         const char *name, const char *value)
288 {
289         struct ast_format *cloned;
290         struct opus_attr *attr;
291         int val;
292
293         if (!(cloned = ast_format_clone(format))) {
294                 return NULL;
295         }
296
297         attr = ast_format_get_attribute_data(cloned);
298
299         if (!strcmp(name, CODEC_OPUS_ATTR_DATA)) {
300                 ao2_cleanup(attr->data);
301                 attr->data = ao2_bump((void*)value);
302                 return cloned;
303         }
304
305         if (sscanf(value, "%30d", &val) != 1) {
306                 ast_log(LOG_WARNING, "Unknown value '%s' for attribute type '%s'\n",
307                         value, name);
308                 ao2_ref(cloned, -1);
309                 return NULL;
310         }
311
312         if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE)) {
313                 attr->maxplayrate = val;
314         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_CODED_AUDIO_BANDWIDTH)) {
315                 attr->maxplayrate = val;
316         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE)) {
317                 attr->spropmaxcapturerate = val;
318         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_PTIME)) {
319                 attr->maxptime = val;
320         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_PTIME)) {
321                 attr->ptime = val;
322         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE)) {
323                 attr->maxbitrate = val;
324         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_STEREO)) {
325                 attr->stereo = val;
326         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_SPROP_STEREO)) {
327                 attr->spropstereo = val;
328         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_CBR)) {
329                 attr->cbr = val;
330         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_FEC)) {
331                 attr->fec = val;
332         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_DTX)) {
333                 attr->dtx = val;
334         } else {
335                 ast_log(LOG_WARNING, "unknown attribute type %s\n", name);
336         }
337
338         return cloned;
339 }
340
341 static const void *opus_get(const struct ast_format *format, const char *name)
342 {
343         struct opus_attr *attr = ast_format_get_attribute_data(format);
344         int *val = NULL;
345
346         if (!attr) {
347                 return NULL;
348         }
349
350         if (!strcasecmp(name, CODEC_OPUS_ATTR_DATA)) {
351                 return ao2_bump(attr->data);
352         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_PLAYBACK_RATE)) {
353                 val = &attr->maxplayrate;
354         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_SPROP_MAX_CAPTURE_RATE)) {
355                 val = &attr->spropmaxcapturerate;
356         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_PTIME)) {
357                 val = &attr->maxptime;
358         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_PTIME)) {
359                 val = &attr->ptime;
360         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_MAX_AVERAGE_BITRATE)) {
361                 val = &attr->maxbitrate;
362         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_STEREO)) {
363                 val = &attr->stereo;
364         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_SPROP_STEREO)) {
365                 val = &attr->spropstereo;
366         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_CBR)) {
367                 val = &attr->cbr;
368         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_FEC)) {
369                 val = &attr->fec;
370         } else if (!strcasecmp(name, CODEC_OPUS_ATTR_DTX)) {
371                 val = &attr->dtx;
372         } else {
373                 ast_log(LOG_WARNING, "unknown attribute type %s\n", name);
374         }
375
376         return val;
377 }
378
379 static struct ast_format_interface opus_interface = {
380         .format_destroy = opus_destroy,
381         .format_clone = opus_clone,
382         .format_get_joint = opus_getjoint,
383         .format_attribute_set = opus_set,
384         .format_parse_sdp_fmtp = opus_parse_sdp_fmtp,
385         .format_generate_sdp_fmtp = opus_generate_sdp_fmtp,
386         .format_attribute_get = opus_get
387 };
388
389 static int load_module(void)
390 {
391         if (__ast_format_interface_register("opus", &opus_interface, ast_module_info->self)) {
392                 return AST_MODULE_LOAD_DECLINE;
393         }
394
395         return AST_MODULE_LOAD_SUCCESS;
396 }
397
398 static int unload_module(void)
399 {
400         return 0;
401 }
402
403 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Opus Format Attribute Module",
404         .support_level = AST_MODULE_SUPPORT_CORE,
405         .load = load_module,
406         .unload = unload_module,
407         .load_pri = AST_MODPRI_REALTIME_DRIVER /* Needs to load before codec_opus */
408 );