Added support level for new modules
[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_FILE_VERSION(__FILE__, "$Revision$")
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 enum ast_format_cmp_res celt_cmp(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2)
49 {
50         struct celt_attr *attr1 = (struct celt_attr *) fattr1;
51         struct celt_attr *attr2 = (struct celt_attr *) fattr2;
52
53         if (attr1->samplerate == attr2->samplerate) {
54                 return AST_FORMAT_CMP_EQUAL;
55         }
56         return AST_FORMAT_CMP_NOT_EQUAL;
57 }
58
59 static int celt_get_val(const struct ast_format_attr *fattr, int key, void *result)
60 {
61         const struct celt_attr *attr = (struct celt_attr *) fattr;
62         int *val = result;
63
64         switch (key) {
65         case CELT_ATTR_KEY_SAMP_RATE:
66                 *val = attr->samplerate;
67                 break;
68         case CELT_ATTR_KEY_MAX_BITRATE:
69                 *val = attr->maxbitrate;
70                 break;
71         case CELT_ATTR_KEY_FRAME_SIZE:
72                 *val = attr->framesize;
73                 break;
74         default:
75                 return -1;
76                 ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
77         }
78         return 0;
79 }
80
81 static int celt_isset(const struct ast_format_attr *fattr, va_list ap)
82 {
83         enum celt_attr_keys key;
84         const struct celt_attr *attr = (struct celt_attr *) fattr;
85
86         for (key = va_arg(ap, int);
87                 key != AST_FORMAT_ATTR_END;
88                 key = va_arg(ap, int))
89         {
90                 switch (key) {
91                 case CELT_ATTR_KEY_SAMP_RATE:
92                         if (attr->samplerate != (va_arg(ap, int))) {
93                                 return -1;
94                         }
95                         break;
96                 case CELT_ATTR_KEY_MAX_BITRATE:
97                         if (attr->maxbitrate != (va_arg(ap, int))) {
98                                 return -1;
99                         }
100                         break;
101                 case CELT_ATTR_KEY_FRAME_SIZE:
102                         if (attr->framesize != (va_arg(ap, int))) {
103                                 return -1;
104                         }
105                         break;
106                 default:
107                         return -1;
108                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
109                 }
110         }
111         return 0;
112 }
113 static int celt_getjoint(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2, struct ast_format_attr *result)
114 {
115         struct celt_attr *attr1 = (struct celt_attr *) fattr1;
116         struct celt_attr *attr2 = (struct celt_attr *) fattr2;
117         struct celt_attr *attr_res = (struct celt_attr *) result;
118
119         /* sample rate is the only attribute that has any bearing on if joint capabilities exist or not */
120         if (attr1->samplerate != attr2->samplerate) {
121                 return -1;
122         }
123         /* either would work, they are guaranteed the same at this point. */
124         attr_res->samplerate = attr1->samplerate;
125         /* Take the lowest max bitrate */
126         attr_res->maxbitrate = MIN(attr1->maxbitrate, attr2->maxbitrate);
127
128         attr_res->framesize = attr2->framesize; /* TODO figure out what joint framesize means */
129         return 0;
130 }
131
132 static void celt_set(struct ast_format_attr *fattr, va_list ap)
133 {
134         enum celt_attr_keys key;
135         struct celt_attr *attr = (struct celt_attr *) fattr;
136
137         for (key = va_arg(ap, int);
138                 key != AST_FORMAT_ATTR_END;
139                 key = va_arg(ap, int))
140         {
141                 switch (key) {
142                 case CELT_ATTR_KEY_SAMP_RATE:
143                         attr->samplerate = (va_arg(ap, int));
144                         break;
145                 case CELT_ATTR_KEY_MAX_BITRATE:
146                         attr->maxbitrate = (va_arg(ap, int));
147                         break;
148                 case CELT_ATTR_KEY_FRAME_SIZE:
149                         attr->framesize = (va_arg(ap, int));
150                         break;
151                 default:
152                         ast_log(LOG_WARNING, "unknown attribute type %d\n", key);
153                 }
154         }
155 }
156
157 static struct ast_format_attr_interface celt_interface = {
158         .id = AST_FORMAT_CELT,
159         .format_attr_cmp = celt_cmp,
160         .format_attr_get_joint = celt_getjoint,
161         .format_attr_set = celt_set,
162         .format_attr_isset = celt_isset,
163         .format_attr_get_val = celt_get_val,
164 };
165
166 static int load_module(void)
167 {
168         if (ast_format_attr_reg_interface(&celt_interface)) {
169                 return AST_MODULE_LOAD_DECLINE;
170         }
171
172         return AST_MODULE_LOAD_SUCCESS;
173 }
174
175 static int unload_module(void)
176 {
177         ast_format_attr_unreg_interface(&celt_interface);
178         return 0;
179 }
180
181 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "CELT Format Attribute Module",
182         .load = load_module,
183         .unload = unload_module,
184         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
185 );