PJPROJECT logging: Made easier to get available logging levels.
[asterisk/asterisk.git] / main / format_cache.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 /*! \file
20  *
21  * \brief Media Format Cache API
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 #include "asterisk/logger.h"
33 #include "asterisk/format.h"
34 #include "asterisk/format_cache.h"
35 #include "asterisk/astobj2.h"
36 #include "asterisk/strings.h"
37
38 /*!
39  * \brief Built-in cached signed linear 8kHz format.
40  */
41 struct ast_format *ast_format_slin;
42
43 /*!
44  * \brief Built-in cached signed linear 12kHz format.
45  */
46 struct ast_format *ast_format_slin12;
47
48 /*!
49  * \brief Built-in cached signed linear 16kHz format.
50  */
51 struct ast_format *ast_format_slin16;
52
53 /*!
54  * \brief Built-in cached signed linear 24kHz format.
55  */
56 struct ast_format *ast_format_slin24;
57
58 /*!
59  * \brief Built-in cached signed linear 32kHz format.
60  */
61 struct ast_format *ast_format_slin32;
62
63 /*!
64  * \brief Built-in cached signed linear 44kHz format.
65  */
66 struct ast_format *ast_format_slin44;
67
68 /*!
69  * \brief Built-in cached signed linear 48kHz format.
70  */
71 struct ast_format *ast_format_slin48;
72
73 /*!
74  * \brief Built-in cached signed linear 96kHz format.
75  */
76 struct ast_format *ast_format_slin96;
77
78 /*!
79  * \brief Built-in cached signed linear 192kHz format.
80  */
81 struct ast_format *ast_format_slin192;
82
83 /*!
84  * \brief Built-in cached ulaw format.
85  */
86 struct ast_format *ast_format_ulaw;
87
88 /*!
89  * \brief Built-in cached alaw format.
90  */
91 struct ast_format *ast_format_alaw;
92
93 /*!
94  * \brief Built-in cached testlaw format.
95  */
96 struct ast_format *ast_format_testlaw;
97
98 /*!
99  * \brief Built-in cached gsm format.
100  */
101 struct ast_format *ast_format_gsm;
102
103 /*!
104  * \brief Built-in cached adpcm format.
105  */
106 struct ast_format *ast_format_adpcm;
107
108 /*!
109  * \brief Built-in cached g722 format.
110  */
111 struct ast_format *ast_format_g722;
112
113 /*!
114  * \brief Built-in cached g726 format.
115  */
116 struct ast_format *ast_format_g726;
117
118 /*!
119  * \brief Built-in cached g726-aal2 format.
120  */
121 struct ast_format *ast_format_g726_aal2;
122
123 /*!
124  * \brief Built-in cached ilbc format.
125  */
126 struct ast_format *ast_format_ilbc;
127
128 /*!
129  * \brief Built-in cached ilbc format.
130  */
131 struct ast_format *ast_format_lpc10;
132
133 /*!
134  * \brief Built-in cached speex format.
135  */
136 struct ast_format *ast_format_speex;
137
138 /*!
139  * \brief Built-in cached speex at 16kHz format.
140  */
141 struct ast_format *ast_format_speex16;
142
143 /*!
144  * \brief Built-in cached speex at 32kHz format.
145  */
146 struct ast_format *ast_format_speex32;
147
148 /*!
149  * \brief Built-in cached g723.1 format.
150  */
151 struct ast_format *ast_format_g723;
152
153 /*!
154  * \brief Built-in cached g729 format.
155  */
156 struct ast_format *ast_format_g729;
157
158 /*!
159  * \brief Built-in cached g719 format.
160  */
161 struct ast_format *ast_format_g719;
162
163 /*!
164  * \brief Built-in cached h261 format.
165  */
166 struct ast_format *ast_format_h261;
167
168 /*!
169  * \brief Built-in cached h263 format.
170  */
171 struct ast_format *ast_format_h263;
172
173 /*!
174  * \brief Built-in cached h263 plus format.
175  */
176 struct ast_format *ast_format_h263p;
177
178 /*!
179  * \brief Built-in cached h264 format.
180  */
181 struct ast_format *ast_format_h264;
182
183 /*!
184  * \brief Built-in cached mp4 format.
185  */
186 struct ast_format *ast_format_mp4;
187
188 /*!
189  * \brief Built-in cached vp8 format.
190  */
191 struct ast_format *ast_format_vp8;
192
193 /*!
194  * \brief Built-in cached jpeg format.
195  */
196 struct ast_format *ast_format_jpeg;
197
198 /*!
199  * \brief Built-in cached png format.
200  */
201 struct ast_format *ast_format_png;
202
203 /*!
204  * \brief Built-in cached siren14 format.
205  */
206 struct ast_format *ast_format_siren14;
207
208 /*!
209  * \brief Built-in cached siren7 format.
210  */
211 struct ast_format *ast_format_siren7;
212
213 /*!
214  * \brief Built-in cached opus format.
215  */
216 struct ast_format *ast_format_opus;
217
218 /*!
219  * \brief Built-in cached codec2 format.
220  */
221 struct ast_format *ast_format_codec2;
222
223 /*!
224  * \brief Built-in cached t140 format.
225  */
226 struct ast_format *ast_format_t140;
227
228 /*!
229  * \brief Built-in cached t140 red format.
230  */
231 struct ast_format *ast_format_t140_red;
232
233 /*!
234  * \brief Built-in "null" format.
235  */
236 struct ast_format *ast_format_none;
237
238 /*!
239  * \brief Built-in "silk" format
240  */
241 struct ast_format *ast_format_silk8;
242 struct ast_format *ast_format_silk12;
243 struct ast_format *ast_format_silk16;
244 struct ast_format *ast_format_silk24;
245
246 /*! \brief Number of buckets to use for the media format cache (should be prime for performance reasons) */
247 #define CACHE_BUCKETS 53
248
249 /*! \brief Cached formats */
250 static struct ao2_container *formats;
251
252 static int format_hash_cb(const void *obj, int flags)
253 {
254         const struct ast_format *format;
255         const char *key;
256
257         switch (flags & OBJ_SEARCH_MASK) {
258         case OBJ_SEARCH_KEY:
259                 key = obj;
260                 return ast_str_case_hash(key);
261         case OBJ_SEARCH_OBJECT:
262                 format = obj;
263                 return ast_str_case_hash(ast_format_get_name(format));
264         default:
265                 /* Hash can only work on something with a full key. */
266                 ast_assert(0);
267                 return 0;
268         }
269 }
270
271 static int format_cmp_cb(void *obj, void *arg, int flags)
272 {
273         const struct ast_format *left = obj;
274         const struct ast_format *right = arg;
275         const char *right_key = arg;
276         int cmp;
277
278         switch (flags & OBJ_SEARCH_MASK) {
279         case OBJ_SEARCH_OBJECT:
280                 right_key = ast_format_get_name(right);
281                 /* Fall through */
282         case OBJ_SEARCH_KEY:
283                 cmp = strcasecmp(ast_format_get_name(left), right_key);
284                 break;
285         case OBJ_SEARCH_PARTIAL_KEY:
286                 cmp = strncasecmp(ast_format_get_name(left), right_key, strlen(right_key));
287                 break;
288         default:
289                 ast_assert(0);
290                 cmp = 0;
291                 break;
292         }
293         if (cmp) {
294                 return 0;
295         }
296
297         return CMP_MATCH;
298 }
299
300 /*! \brief Function called when the process is shutting down */
301 static void format_cache_shutdown(void)
302 {
303         ao2_cleanup(formats);
304         formats = NULL;
305
306         ao2_replace(ast_format_g723, NULL);
307         ao2_replace(ast_format_ulaw, NULL);
308         ao2_replace(ast_format_alaw, NULL);
309         ao2_replace(ast_format_gsm, NULL);
310         ao2_replace(ast_format_g726, NULL);
311         ao2_replace(ast_format_g726_aal2, NULL);
312         ao2_replace(ast_format_adpcm, NULL);
313         ao2_replace(ast_format_slin, NULL);
314         ao2_replace(ast_format_slin12, NULL);
315         ao2_replace(ast_format_slin16, NULL);
316         ao2_replace(ast_format_slin24, NULL);
317         ao2_replace(ast_format_slin32, NULL);
318         ao2_replace(ast_format_slin44, NULL);
319         ao2_replace(ast_format_slin48, NULL);
320         ao2_replace(ast_format_slin96, NULL);
321         ao2_replace(ast_format_slin192, NULL);
322         ao2_replace(ast_format_lpc10, NULL);
323         ao2_replace(ast_format_g729, NULL);
324         ao2_replace(ast_format_speex, NULL);
325         ao2_replace(ast_format_speex16, NULL);
326         ao2_replace(ast_format_speex32, NULL);
327         ao2_replace(ast_format_ilbc, NULL);
328         ao2_replace(ast_format_g722, NULL);
329         ao2_replace(ast_format_siren7, NULL);
330         ao2_replace(ast_format_siren14, NULL);
331         ao2_replace(ast_format_testlaw, NULL);
332         ao2_replace(ast_format_g719, NULL);
333         ao2_replace(ast_format_opus, NULL);
334         ao2_replace(ast_format_codec2, NULL);
335         ao2_replace(ast_format_jpeg, NULL);
336         ao2_replace(ast_format_png, NULL);
337         ao2_replace(ast_format_h261, NULL);
338         ao2_replace(ast_format_h263, NULL);
339         ao2_replace(ast_format_h263p, NULL);
340         ao2_replace(ast_format_h264, NULL);
341         ao2_replace(ast_format_mp4, NULL);
342         ao2_replace(ast_format_vp8, NULL);
343         ao2_replace(ast_format_t140_red, NULL);
344         ao2_replace(ast_format_t140, NULL);
345         ao2_replace(ast_format_none, NULL);
346         ao2_replace(ast_format_silk8, NULL);
347         ao2_replace(ast_format_silk12, NULL);
348         ao2_replace(ast_format_silk16, NULL);
349         ao2_replace(ast_format_silk24, NULL);
350 }
351
352 int ast_format_cache_init(void)
353 {
354         formats = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, CACHE_BUCKETS,
355                 format_hash_cb, format_cmp_cb);
356         if (!formats) {
357                 return -1;
358         }
359
360         ast_register_cleanup(format_cache_shutdown);
361
362         return 0;
363 }
364
365 static void set_cached_format(const char *name, struct ast_format *format)
366 {
367         if (!strcmp(name, "codec2")) {
368                 ao2_replace(ast_format_codec2, format);
369         } else if (!strcmp(name, "g723")) {
370                 ao2_replace(ast_format_g723, format);
371         } else if (!strcmp(name, "ulaw")) {
372                 ao2_replace(ast_format_ulaw, format);
373         } else if (!strcmp(name, "alaw")) {
374                 ao2_replace(ast_format_alaw, format);
375         } else if (!strcmp(name, "gsm")) {
376                 ao2_replace(ast_format_gsm, format);
377         } else if (!strcmp(name, "g726")) {
378                 ao2_replace(ast_format_g726, format);
379         } else if (!strcmp(name, "g726aal2")) {
380                 ao2_replace(ast_format_g726_aal2, format);
381         } else if (!strcmp(name, "adpcm")) {
382                 ao2_replace(ast_format_adpcm, format);
383         } else if (!strcmp(name, "slin")) {
384                 ao2_replace(ast_format_slin, format);
385         } else if (!strcmp(name, "slin12")) {
386                 ao2_replace(ast_format_slin12, format);
387         } else if (!strcmp(name, "slin16")) {
388                 ao2_replace(ast_format_slin16, format);
389         } else if (!strcmp(name, "slin24")) {
390                 ao2_replace(ast_format_slin24, format);
391         } else if (!strcmp(name, "slin32")) {
392                 ao2_replace(ast_format_slin32, format);
393         } else if (!strcmp(name, "slin44")) {
394                 ao2_replace(ast_format_slin44, format);
395         } else if (!strcmp(name, "slin48")) {
396                 ao2_replace(ast_format_slin48, format);
397         } else if (!strcmp(name, "slin96")) {
398                 ao2_replace(ast_format_slin96, format);
399         } else if (!strcmp(name, "slin192")) {
400                 ao2_replace(ast_format_slin192, format);
401         } else if (!strcmp(name, "lpc10")) {
402                 ao2_replace(ast_format_lpc10, format);
403         } else if (!strcmp(name, "g729")) {
404                 ao2_replace(ast_format_g729, format);
405         } else if (!strcmp(name, "speex")) {
406                 ao2_replace(ast_format_speex, format);
407         } else if (!strcmp(name, "speex16")) {
408                 ao2_replace(ast_format_speex16, format);
409         } else if (!strcmp(name, "speex32")) {
410                 ao2_replace(ast_format_speex32, format);
411         } else if (!strcmp(name, "ilbc")) {
412                 ao2_replace(ast_format_ilbc, format);
413         } else if (!strcmp(name, "g722")) {
414                 ao2_replace(ast_format_g722, format);
415         } else if (!strcmp(name, "siren7")) {
416                 ao2_replace(ast_format_siren7, format);
417         } else if (!strcmp(name, "siren14")) {
418                 ao2_replace(ast_format_siren14, format);
419         } else if (!strcmp(name, "testlaw")) {
420                 ao2_replace(ast_format_testlaw, format);
421         } else if (!strcmp(name, "g719")) {
422                 ao2_replace(ast_format_g719, format);
423         } else if (!strcmp(name, "opus")) {
424                 ao2_replace(ast_format_opus, format);
425         } else if (!strcmp(name, "jpeg")) {
426                 ao2_replace(ast_format_jpeg, format);
427         } else if (!strcmp(name, "png")) {
428                 ao2_replace(ast_format_png, format);
429         } else if (!strcmp(name, "h261")) {
430                 ao2_replace(ast_format_h261, format);
431         } else if (!strcmp(name, "h263")) {
432                 ao2_replace(ast_format_h263, format);
433         } else if (!strcmp(name, "h263p")) {
434                 ao2_replace(ast_format_h263p, format);
435         } else if (!strcmp(name, "h264")) {
436                 ao2_replace(ast_format_h264, format);
437         } else if (!strcmp(name, "mpeg4")) {
438                 ao2_replace(ast_format_mp4, format);
439         } else if (!strcmp(name, "vp8")) {
440                 ao2_replace(ast_format_vp8, format);
441         } else if (!strcmp(name, "red")) {
442                 ao2_replace(ast_format_t140_red, format);
443         } else if (!strcmp(name, "t140")) {
444                 ao2_replace(ast_format_t140, format);
445         } else if (!strcmp(name, "none")) {
446                 ao2_replace(ast_format_none, format);
447         } else if (!strcmp(name, "silk8")) {
448                 ao2_replace(ast_format_silk8, format);
449         } else if (!strcmp(name, "silk12")) {
450                 ao2_replace(ast_format_silk12, format);
451         } else if (!strcmp(name, "silk16")) {
452                 ao2_replace(ast_format_silk16, format);
453         } else if (!strcmp(name, "silk24")) {
454                 ao2_replace(ast_format_silk24, format);
455         }
456 }
457
458 int ast_format_cache_set(struct ast_format *format)
459 {
460         SCOPED_AO2WRLOCK(lock, formats);
461         struct ast_format *old_format;
462
463         ast_assert(format != NULL);
464
465         if (ast_strlen_zero(ast_format_get_name(format))) {
466                 return -1;
467         }
468
469         old_format = ao2_find(formats, ast_format_get_name(format), OBJ_SEARCH_KEY | OBJ_NOLOCK);
470         if (old_format) {
471                 ao2_unlink_flags(formats, old_format, OBJ_NOLOCK);
472         }
473         ao2_link_flags(formats, format, OBJ_NOLOCK);
474
475         set_cached_format(ast_format_get_name(format), format);
476
477         ast_verb(2, "%s cached format with name '%s'\n",
478                 old_format ? "Updated" : "Created",
479                 ast_format_get_name(format));
480
481         ao2_cleanup(old_format);
482
483         return 0;
484 }
485
486 struct ast_format *__ast_format_cache_get(const char *name,
487         const char *tag, const char *file, int line, const char *func)
488 {
489         if (ast_strlen_zero(name)) {
490                 return NULL;
491         }
492
493         return __ao2_find(formats, name, OBJ_SEARCH_KEY, tag, file, line, func);
494 }
495
496 struct ast_format *ast_format_cache_get_slin_by_rate(unsigned int rate)
497 {
498         if (rate >= 192000) {
499                 return ast_format_slin192;
500         } else if (rate >= 96000) {
501                 return ast_format_slin96;
502         } else if (rate >= 48000) {
503                 return ast_format_slin48;
504         } else if (rate >= 44100) {
505                 return ast_format_slin44;
506         } else if (rate >= 32000) {
507                 return ast_format_slin32;
508         } else if (rate >= 24000) {
509                 return ast_format_slin24;
510         } else if (rate >= 16000) {
511                 return ast_format_slin16;
512         } else if (rate >= 12000) {
513                 return ast_format_slin12;
514         }
515         return ast_format_slin;
516 }
517
518 int ast_format_cache_is_slinear(struct ast_format *format)
519 {
520         if ((ast_format_cmp(format, ast_format_slin) == AST_FORMAT_CMP_EQUAL)
521                 || (ast_format_cmp(format, ast_format_slin12) == AST_FORMAT_CMP_EQUAL)
522                 || (ast_format_cmp(format, ast_format_slin16) == AST_FORMAT_CMP_EQUAL)
523                 || (ast_format_cmp(format, ast_format_slin24) == AST_FORMAT_CMP_EQUAL)
524                 || (ast_format_cmp(format, ast_format_slin32) == AST_FORMAT_CMP_EQUAL)
525                 || (ast_format_cmp(format, ast_format_slin44) == AST_FORMAT_CMP_EQUAL)
526                 || (ast_format_cmp(format, ast_format_slin48) == AST_FORMAT_CMP_EQUAL)
527                 || (ast_format_cmp(format, ast_format_slin96) == AST_FORMAT_CMP_EQUAL)
528                 || (ast_format_cmp(format, ast_format_slin192) == AST_FORMAT_CMP_EQUAL)) {
529                 return 1;
530         }
531
532         return 0;
533 }
534