Merge "rtp_engine/res_rtp_asterisk: Fix RTP struct reentrancy crashes."
[asterisk/asterisk.git] / res / res_format_attr_ilbc.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2016, Alexander Traud
5  *
6  * Alexander Traud <pabstraud@compuserve.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 iLBC format attribute interface
22  *
23  * \author Alexander Traud <pabstraud@compuserve.com>
24  *
25  * \note http://tools.ietf.org/html/rfc3952
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 #include "asterisk/module.h"
35 #include "asterisk/format.h"
36 #include "asterisk/strings.h"           /* for ast_str_append */
37 #include "asterisk/utils.h"             /* for ast_calloc, ast_free */
38
39 #include "asterisk/ilbc.h"
40
41 static struct ilbc_attr default_ilbc_attr = {
42         .mode = 20,
43 };
44
45 static void ilbc_destroy(struct ast_format *format)
46 {
47         struct ilbc_attr *attr = ast_format_get_attribute_data(format);
48
49         ast_free(attr);
50 }
51
52 static int ilbc_clone(const struct ast_format *src, struct ast_format *dst)
53 {
54         struct ilbc_attr *original = ast_format_get_attribute_data(src);
55         struct ilbc_attr *attr = ast_malloc(sizeof(*attr));
56
57         if (!attr) {
58                 return -1;
59         }
60
61         if (original) {
62                 *attr = *original;
63         } else {
64                 *attr = default_ilbc_attr;
65         }
66
67         ast_format_set_attribute_data(dst, attr);
68
69         return 0;
70 }
71
72 static struct ast_format *ilbc_parse_sdp_fmtp(const struct ast_format *format, const char *attributes)
73 {
74         struct ast_format *cloned;
75         struct ilbc_attr *attr;
76         const char *kvp;
77         unsigned int val;
78
79         cloned = ast_format_clone(format);
80         if (!cloned) {
81                 return NULL;
82         }
83         attr = ast_format_get_attribute_data(cloned);
84
85         if ((kvp = strstr(attributes, "mode")) && sscanf(kvp, "mode=%30u", &val) == 1) {
86                 attr->mode = val;
87         } else {
88                 attr->mode = 30; /* optional attribute; 30 is default value */
89         }
90
91         return cloned;
92 }
93
94 static void ilbc_generate_sdp_fmtp(const struct ast_format *format, unsigned int payload, struct ast_str **str)
95 {
96         struct ilbc_attr *attr = ast_format_get_attribute_data(format);
97
98         if (!attr) {
99                 attr = &default_ilbc_attr;
100         }
101
102         /* When the VoIP/SIP client Zoiper calls Asterisk and its
103          * iLBC 20 is disabled but iLBC 30 enabled, Zoiper still
104          * falls back to iLBC 20, when there is no mode=30 in the
105          * answer. Consequently, Zoiper defaults to iLBC 20. To
106          * make that client happy, Asterisk sends mode always.
107          * tested in June 2016, Zoiper Premium 1.13.2 for iPhone
108          */
109         /* if (attr->mode != 30) */ {
110                 ast_str_append(str, 0, "a=fmtp:%u mode=%u\r\n", payload, attr->mode);
111         }
112 }
113
114 static struct ast_format *ilbc_getjoint(const struct ast_format *format1, const struct ast_format *format2)
115 {
116         struct ast_format *jointformat;
117         struct ilbc_attr *attr1 = ast_format_get_attribute_data(format1);
118         struct ilbc_attr *attr2 = ast_format_get_attribute_data(format2);
119         struct ilbc_attr *attr_res;
120
121         if (!attr1) {
122                 attr1 = &default_ilbc_attr;
123         }
124
125         if (!attr2) {
126                 attr2 = &default_ilbc_attr;
127         }
128
129         jointformat = ast_format_clone(format1);
130         if (!jointformat) {
131                 return NULL;
132         }
133         attr_res = ast_format_get_attribute_data(jointformat);
134
135         if (attr1->mode != attr2->mode) {
136                 attr_res->mode = 30;
137         }
138
139         return jointformat;
140 }
141
142 static struct ast_format_interface ilbc_interface = {
143         .format_destroy = ilbc_destroy,
144         .format_clone = ilbc_clone,
145         .format_cmp = NULL,
146         .format_get_joint = ilbc_getjoint,
147         .format_attribute_set = NULL,
148         .format_parse_sdp_fmtp = ilbc_parse_sdp_fmtp,
149         .format_generate_sdp_fmtp = ilbc_generate_sdp_fmtp,
150 };
151
152 static int load_module(void)
153 {
154         if (ast_format_interface_register("ilbc", &ilbc_interface)) {
155                 return AST_MODULE_LOAD_DECLINE;
156         }
157
158         return AST_MODULE_LOAD_SUCCESS;
159 }
160
161 static int unload_module(void)
162 {
163         return 0;
164 }
165
166 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER,
167         "iLBC Format Attribute Module",
168         .support_level = AST_MODULE_SUPPORT_CORE,
169         .load = load_module,
170         .unload = unload_module,
171         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
172 );