media formats: re-architect handling of media for performance improvements
[asterisk/asterisk.git] / tests / test_core_codec.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2014, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 Core Codec API Unit Tests
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  *
25  */
26
27 /*** MODULEINFO
28         <depend>TEST_FRAMEWORK</depend>
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/test.h"
37 #include "asterisk/module.h"
38 #include "asterisk/codec.h"
39
40 static struct ast_codec known_unknown = {
41         .name = "unit_test",
42         .description = "Unit test codec",
43         .type = AST_MEDIA_TYPE_AUDIO,
44         .sample_rate = 8000,
45         .minimum_ms = 10,
46         .maximum_ms = 150,
47         .default_ms = 20,
48 };
49
50 static struct ast_codec doubly = {
51         .name = "unit_test_double",
52         .description = "Unit test codec",
53         .type = AST_MEDIA_TYPE_AUDIO,
54         .sample_rate = 8000,
55         .minimum_ms = 10,
56         .maximum_ms = 150,
57         .default_ms = 20,
58 };
59
60 static struct ast_codec unknown = {
61         .name = "unit_test_unknown",
62         .description = "Unit test codec",
63         .type = AST_MEDIA_TYPE_UNKNOWN,
64         .sample_rate = 8000,
65         .minimum_ms = 10,
66         .maximum_ms = 150,
67         .default_ms = 20,
68 };
69
70 static struct ast_codec audio_without_rate = {
71         .name = "unit_test_audio_without_rate",
72         .description = "Unit test codec",
73         .type = AST_MEDIA_TYPE_AUDIO,
74         .minimum_ms = 10,
75         .maximum_ms = 150,
76         .default_ms = 20,
77 };
78
79 static struct ast_codec audio_get = {
80         .name = "unit_test_audio_get",
81         .description = "Unit test codec",
82         .type = AST_MEDIA_TYPE_AUDIO,
83         .sample_rate = 8000,
84         .minimum_ms = 10,
85         .maximum_ms = 150,
86         .default_ms = 20,
87 };
88
89 static struct ast_codec audio_get_unknown = {
90         .name = "unit_test_audio_get_unknown",
91         .description = "Unit test codec",
92         .type = AST_MEDIA_TYPE_AUDIO,
93         .sample_rate = 8000,
94         .minimum_ms = 10,
95         .maximum_ms = 150,
96         .default_ms = 20,
97 };
98
99 static struct ast_codec audio_get_id = {
100         .name = "unit_test_audio_get_id",
101         .description = "Unit test codec",
102         .type = AST_MEDIA_TYPE_AUDIO,
103         .sample_rate = 8000,
104         .minimum_ms = 10,
105         .maximum_ms = 150,
106         .default_ms = 20,
107 };
108
109 AST_TEST_DEFINE(codec_register)
110 {
111         switch (cmd) {
112         case TEST_INIT:
113                 info->name = "codec_register";
114                 info->category = "/main/core_codec/";
115                 info->summary = "codec registration unit test";
116                 info->description =
117                         "Test registration of a core codec that is known to be unknown";
118                 return AST_TEST_NOT_RUN;
119         case TEST_EXECUTE:
120                 break;
121         }
122
123         if (ast_codec_register(&known_unknown)) {
124                 ast_test_status_update(test, "Unsuccessfully registered a codec that is known to be unknown\n");
125                 return AST_TEST_FAIL;
126         }
127
128         return AST_TEST_PASS;
129 }
130
131 AST_TEST_DEFINE(codec_register_twice)
132 {
133         switch (cmd) {
134         case TEST_INIT:
135                 info->name = "codec_register_twice";
136                 info->category = "/main/core_codec/";
137                 info->summary = "codec registration unit test";
138                 info->description =
139                         "Test double registration of a core codec to confirm it fails";
140                 return AST_TEST_NOT_RUN;
141         case TEST_EXECUTE:
142                 break;
143         }
144
145         if (ast_codec_register(&doubly)) {
146                 ast_test_status_update(test, "Unsuccessfully registered a codec that is known to be unknown\n");
147                 return AST_TEST_FAIL;
148         }
149
150         if (!ast_codec_register(&doubly)) {
151                 ast_test_status_update(test, "Successfully registered a codec twice\n");
152                 return AST_TEST_FAIL;
153         }
154
155         return AST_TEST_PASS;
156 }
157
158 AST_TEST_DEFINE(codec_register_unknown)
159 {
160         switch (cmd) {
161         case TEST_INIT:
162                 info->name = "codec_register_unknown";
163                 info->category = "/main/core_codec/";
164                 info->summary = "codec registration unit test";
165                 info->description =
166                         "Test that registration of an unknown codec type fails";
167                 return AST_TEST_NOT_RUN;
168         case TEST_EXECUTE:
169                 break;
170         }
171
172         if (!ast_codec_register(&unknown)) {
173                 ast_test_status_update(test, "Successfully registered a codec with an unknown media type\n");
174                 return AST_TEST_FAIL;
175         }
176
177         return AST_TEST_PASS;
178 }
179
180 AST_TEST_DEFINE(codec_register_audio_no_sample_rate)
181 {
182         switch (cmd) {
183         case TEST_INIT:
184                 info->name = "codec_register_audio_no_sample_rate";
185                 info->category = "/main/core_codec/";
186                 info->summary = "codec registration unit test";
187                 info->description =
188                         "Test that registration of an audio codec without sample rate fails";
189                 return AST_TEST_NOT_RUN;
190         case TEST_EXECUTE:
191                 break;
192         }
193
194         if (!ast_codec_register(&audio_without_rate)) {
195                 ast_test_status_update(test, "Successfully registered an audio codec without a sample rate\n");
196                 return AST_TEST_FAIL;
197         }
198
199         return AST_TEST_PASS;
200 }
201
202 AST_TEST_DEFINE(codec_get)
203 {
204         RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
205
206         switch (cmd) {
207         case TEST_INIT:
208                 info->name = "codec_get";
209                 info->category = "/main/core_codec/";
210                 info->summary = "codec get unit test";
211                 info->description =
212                         "Test that getting of a known codec succeeds";
213                 return AST_TEST_NOT_RUN;
214         case TEST_EXECUTE:
215                 break;
216         }
217
218         if (ast_codec_register(&audio_get)) {
219                 ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
220                 return AST_TEST_FAIL;
221         }
222
223         codec = ast_codec_get("unit_test_audio_get", AST_MEDIA_TYPE_AUDIO, 8000);
224         if (!codec) {
225                 ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
226                 return AST_TEST_FAIL;
227         } else if (strcmp(codec->name, audio_get.name)) {
228                 ast_test_status_update(test, "Name of retrieved codec does not match registered codec\n");
229                 return AST_TEST_FAIL;
230         } else if (codec->type != audio_get.type) {
231                 ast_test_status_update(test, "Type of retrieved codec does not match registered codec\n");
232                 return AST_TEST_FAIL;
233         } else if (codec->sample_rate != audio_get.sample_rate) {
234                 ast_test_status_update(test, "Sample rate of retrieved codec does not match registered codec\n");
235                 return AST_TEST_FAIL;
236         }
237
238         return AST_TEST_PASS;
239 }
240
241 AST_TEST_DEFINE(codec_get_unregistered)
242 {
243         RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
244
245         switch (cmd) {
246         case TEST_INIT:
247                 info->name = "codec_get_unregistered";
248                 info->category = "/main/core_codec/";
249                 info->summary = "codec get unit test";
250                 info->description =
251                         "Test that getting of a codec that is not registered fails";
252                 return AST_TEST_NOT_RUN;
253         case TEST_EXECUTE:
254                 break;
255         }
256
257         codec = ast_codec_get("goats", AST_MEDIA_TYPE_AUDIO, 8000);
258         if (codec) {
259                 ast_test_status_update(test, "Successfully got a codec named '%s' when getting a codec named 'goats'\n",
260                         codec->name);
261                 return AST_TEST_FAIL;
262         }
263
264         return AST_TEST_PASS;
265 }
266
267 AST_TEST_DEFINE(codec_get_unknown)
268 {
269         RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
270
271         switch (cmd) {
272         case TEST_INIT:
273                 info->name = "codec_get_unknown";
274                 info->category = "/main/core_codec/";
275                 info->summary = "codec get unit test";
276                 info->description =
277                         "Test that getting of a known codec using name and unknown type succeeds";
278                 return AST_TEST_NOT_RUN;
279         case TEST_EXECUTE:
280                 break;
281         }
282
283         if (ast_codec_register(&audio_get_unknown)) {
284                 ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
285                 return AST_TEST_FAIL;
286         }
287
288         codec = ast_codec_get("unit_test_audio_get_unknown", AST_MEDIA_TYPE_UNKNOWN, 8000);
289         if (!codec) {
290                 ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
291                 return AST_TEST_FAIL;
292         } else if (strcmp(codec->name, audio_get_unknown.name)) {
293                 ast_test_status_update(test, "Name of retrieved codec does not match registered codec\n");
294                 return AST_TEST_FAIL;
295         } else if (codec->type != audio_get_unknown.type) {
296                 ast_test_status_update(test, "Type of retrieved codec does not match registered codec\n");
297                 return AST_TEST_FAIL;
298         } else if (codec->sample_rate != audio_get_unknown.sample_rate) {
299                 ast_test_status_update(test, "Sample rate of retrieved codec does not match registered codec\n");
300                 return AST_TEST_FAIL;
301         }
302
303         return AST_TEST_PASS;
304 }
305
306 AST_TEST_DEFINE(codec_get_id)
307 {
308         RAII_VAR(struct ast_codec *, named, NULL, ao2_cleanup);
309         RAII_VAR(struct ast_codec *, codec, NULL, ao2_cleanup);
310
311         switch (cmd) {
312         case TEST_INIT:
313                 info->name = "codec_get_unknown";
314                 info->category = "/main/core_codec/";
315                 info->summary = "codec get unit test";
316                 info->description =
317                         "Test that getting of a known codec using name and unknown type succeeds";
318                 return AST_TEST_NOT_RUN;
319         case TEST_EXECUTE:
320                 break;
321         }
322
323         if (ast_codec_register(&audio_get_id)) {
324                 ast_test_status_update(test, "Unsucessfully registered a codec for getting\n");
325                 return AST_TEST_FAIL;
326         }
327
328         named = ast_codec_get("unit_test_audio_get_id", AST_MEDIA_TYPE_AUDIO, 8000);
329         if (!named) {
330                 ast_test_status_update(test, "Unsuccessfully retrieved a codec we just registered\n");
331                 return AST_TEST_FAIL;
332         }
333
334         codec = ast_codec_get_by_id(named->id);
335         if (!codec) {
336                 ast_test_status_update(test, "Unsuccessfully retrieved a codec using id of a named codec we just got\n");
337                 return AST_TEST_FAIL;
338         }
339
340         return AST_TEST_PASS;
341 }
342
343 static int unload_module(void)
344 {
345         AST_TEST_UNREGISTER(codec_register);
346         AST_TEST_UNREGISTER(codec_register_twice);
347         AST_TEST_UNREGISTER(codec_register_unknown);
348         AST_TEST_UNREGISTER(codec_register_audio_no_sample_rate);
349         AST_TEST_UNREGISTER(codec_get);
350         AST_TEST_UNREGISTER(codec_get_unregistered);
351         AST_TEST_UNREGISTER(codec_get_unknown);
352         AST_TEST_UNREGISTER(codec_get_id);
353         return 0;
354 }
355
356 static int load_module(void)
357 {
358         AST_TEST_REGISTER(codec_register);
359         AST_TEST_REGISTER(codec_register_twice);
360         AST_TEST_REGISTER(codec_register_unknown);
361         AST_TEST_REGISTER(codec_register_audio_no_sample_rate);
362         AST_TEST_REGISTER(codec_get);
363         AST_TEST_REGISTER(codec_get_unregistered);
364         AST_TEST_REGISTER(codec_get_unknown);
365         AST_TEST_REGISTER(codec_get_id);
366         return AST_MODULE_LOAD_SUCCESS;
367 }
368
369 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Core codec API test module");