be7852c8f5ec123d433ae6cd8006f3ea0a656a80
[asterisk/asterisk.git] / channels / iax2 / format_compatibility.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 Bitfield Compatibility 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 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/logger.h"
35 #include "asterisk/astobj2.h"
36 #include "asterisk/codec.h"
37 #include "asterisk/format.h"
38 #include "asterisk/format_compatibility.h"
39 #include "asterisk/format_cache.h"
40 #include "asterisk/format_cap.h"
41 #include "asterisk/utils.h"
42
43 #include "include/format_compatibility.h"
44
45 uint64_t iax2_format_compatibility_cap2bitfield(const struct ast_format_cap *cap)
46 {
47         uint64_t bitfield = 0;
48         int x;
49
50         for (x = 0; x < ast_format_cap_count(cap); x++) {
51                 struct ast_format *format = ast_format_cap_get_format(cap, x);
52
53                 bitfield |= ast_format_compatibility_format2bitfield(format);
54
55                 ao2_ref(format, -1);
56         }
57
58         return bitfield;
59 }
60
61 int iax2_format_compatibility_bitfield2cap(uint64_t bitfield, struct ast_format_cap *cap)
62 {
63         int bit;
64
65         for (bit = 0; bit < 64; ++bit) {
66                 uint64_t mask = (1ULL << bit);
67
68                 if (mask & bitfield) {
69                         struct ast_format *format;
70
71                         format = ast_format_compatibility_bitfield2format(mask);
72                         if (format && ast_format_cap_append(cap, format, 0)) {
73                                 return -1;
74                         }
75                 }
76         }
77
78         return 0;
79 }
80
81 uint64_t iax2_format_compatibility_best(uint64_t formats)
82 {
83         /*
84          * This just our opinion, expressed in code.  We are
85          * asked to choose the best codec to use, given no
86          * information.
87          */
88         static const uint64_t best[] = {
89                 /*! Okay, ulaw is used by all telephony equipment, so start with it */
90                 AST_FORMAT_ULAW,
91                 /*! Unless of course, you're a silly European, so then prefer ALAW */
92                 AST_FORMAT_ALAW,
93                 AST_FORMAT_G719,
94                 AST_FORMAT_SIREN14,
95                 AST_FORMAT_SIREN7,
96                 AST_FORMAT_TESTLAW,
97                 /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
98                 AST_FORMAT_G722,
99                 /*! Okay, well, signed linear is easy to translate into other stuff */
100                 AST_FORMAT_SLIN16,
101                 AST_FORMAT_SLIN,
102                 /*! G.726 is standard ADPCM, in RFC3551 packing order */
103                 AST_FORMAT_G726,
104                 /*! G.726 is standard ADPCM, in AAL2 packing order */
105                 AST_FORMAT_G726_AAL2,
106                 /*! ADPCM has great sound quality and is still pretty easy to translate */
107                 AST_FORMAT_ADPCM,
108                 /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
109                     translate and sounds pretty good */
110                 AST_FORMAT_GSM,
111                 /*! iLBC is not too bad */
112                 AST_FORMAT_ILBC,
113                 /*! Speex is free, but computationally more expensive than GSM */
114                 AST_FORMAT_SPEEX16,
115                 AST_FORMAT_SPEEX,
116                 /*! Opus */
117                 AST_FORMAT_OPUS,
118                 /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
119                     to use it */
120                 AST_FORMAT_LPC10,
121                 /*! G.729a is faster than 723 and slightly less expensive */
122                 AST_FORMAT_G729,
123                 /*! Down to G.723.1 which is proprietary but at least designed for voice */
124                 AST_FORMAT_G723,
125         };
126         int idx;
127
128         /* Find the first preferred codec in the format given */
129         for (idx = 0; idx < ARRAY_LEN(best); ++idx) {
130                 if (formats & best[idx]) {
131                         return best[idx];
132                 }
133         }
134
135         return 0;
136 }