res_resolver_unbound: Fix config documentation.
[asterisk/asterisk.git] / res / res_format_attr_celt.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 CELT 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_REGISTER_FILE()
33
34 #include "asterisk/module.h"
35 #include "asterisk/format.h"
36
37 /*!
38  * \brief CELT attribute structure.
39  *
40  * \note The only attribute that affects compatibility here is the sample rate.
41  */
42 struct celt_attr {
43         unsigned int samplerate;
44         unsigned int maxbitrate;
45         unsigned int framesize;
46 };
47
48 static void celt_destroy(struct ast_format *format)
49 {
50         struct celt_attr *attr = ast_format_get_attribute_data(format);
51
52         ast_free(attr);
53 }
54
55 static int celt_clone(const struct ast_format *src, struct ast_format *dst)
56 {
57         struct celt_attr *original = ast_format_get_attribute_data(src);
58         struct celt_attr *attr = ast_calloc(1, sizeof(*attr));
59
60         if (!attr) {
61                 return -1;
62         }
63
64         if (original) {
65                 *attr = *original;
66         }
67
68         ast_format_set_attribute_data(dst, attr);
69
70         return 0;
71 }
72
73 static struct ast_format *celt_parse_sdp_fmtp(const struct ast_format *format, const char *attributes)
74 {
75         struct ast_format *cloned;
76         struct celt_attr *attr;
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 (sscanf(attributes, "framesize=%30u", &val) == 1) {
86                 attr->framesize = val;
87         }
88
89         return cloned;
90 }
91
92 static void celt_generate_sdp_fmtp(const struct ast_format *format, unsigned int payload, struct ast_str **str)
93 {
94         struct celt_attr *attr = ast_format_get_attribute_data(format);
95
96         if (!attr || !attr->framesize) {
97                 return;
98         }
99
100         ast_str_append(str, 0, "a=fmtp:%u framesize=%u\r\n", payload, attr->framesize);
101 }
102
103 static enum ast_format_cmp_res celt_cmp(const struct ast_format *format1, const struct ast_format *format2)
104 {
105         struct celt_attr *attr1 = ast_format_get_attribute_data(format1);
106         struct celt_attr *attr2 = ast_format_get_attribute_data(format2);
107
108         if (((!attr1 || !attr1->samplerate) && (!attr2 || !attr2->samplerate)) ||
109                 (attr1->samplerate == attr2->samplerate)) {
110                 return AST_FORMAT_CMP_EQUAL;
111         }
112
113         return AST_FORMAT_CMP_NOT_EQUAL;
114 }
115
116 static struct ast_format *celt_getjoint(const struct ast_format *format1, const struct ast_format *format2)
117 {
118         struct celt_attr *attr1 = ast_format_get_attribute_data(format1);
119         struct celt_attr *attr2 = ast_format_get_attribute_data(format2);
120         struct ast_format *jointformat;
121         struct celt_attr *jointattr;
122
123         if (attr1 && attr2 && (attr1->samplerate != attr2->samplerate)) {
124                 return NULL;
125         }
126
127         jointformat = ast_format_clone(format1);
128         if (!jointformat) {
129                 return NULL;
130         }
131         jointattr = ast_format_get_attribute_data(jointformat);
132
133         /* either would work, they are guaranteed the same at this point. */
134         jointattr->samplerate = attr1->samplerate;
135         /* Take the lowest max bitrate */
136         jointattr->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
137
138         jointattr->framesize = attr2->framesize; /* TODO figure out what joint framesize means */
139
140         return jointformat;
141 }
142
143 static struct ast_format *celt_set(const struct ast_format *format, const char *name, const char *value)
144 {
145         struct ast_format *cloned;
146         struct celt_attr *attr;
147         unsigned int val;
148
149         cloned = ast_format_clone(format);
150         if (!cloned) {
151                 return NULL;
152         }
153         attr = ast_format_get_attribute_data(cloned);
154
155         if (sscanf(value, "%30u", &val) != 1) {
156                 ast_log(LOG_WARNING, "Unknown value '%s' for attribute type '%s'\n",
157                         value, name);
158                 ao2_ref(cloned, -1);
159                 return NULL;
160         }
161
162         if (!strcasecmp(name, "sample_rate")) {
163                 attr->samplerate = val;
164         } else if (!strcasecmp(name, "max_bitrate")) {
165                 attr->maxbitrate = val;
166         } else if (!strcasecmp(name, "frame_size")) {
167                 attr->framesize = val;
168         } else {
169                 ast_log(LOG_WARNING, "Unknown attribute type '%s'\n", name);
170                 ao2_ref(cloned, -1);
171                 return NULL;
172         }
173
174         return cloned;
175 }
176
177 static struct ast_format_interface celt_interface = {
178         .format_destroy = celt_destroy,
179         .format_clone = celt_clone,
180         .format_cmp = celt_cmp,
181         .format_get_joint = celt_getjoint,
182         .format_attribute_set = celt_set,
183         .format_parse_sdp_fmtp = celt_parse_sdp_fmtp,
184         .format_generate_sdp_fmtp = celt_generate_sdp_fmtp,
185 };
186
187 static int load_module(void)
188 {
189         if (ast_format_interface_register("celt", &celt_interface)) {
190                 return AST_MODULE_LOAD_DECLINE;
191         }
192
193         return AST_MODULE_LOAD_SUCCESS;
194 }
195
196 static int unload_module(void)
197 {
198         return 0;
199 }
200
201 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "CELT Format Attribute Module",
202         .support_level = AST_MODULE_SUPPORT_CORE,
203         .load = load_module,
204         .unload = unload_module,
205         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
206 );