Support for Channel Mapping 253
[opus.git] / src / mapping_matrix.h
1 /* Copyright (c) 2017 Google Inc.
2    Written by Andrew Allen */
3 /*
4    Redistribution and use in source and binary forms, with or without
5    modification, are permitted provided that the following conditions
6    are met:
7
8    - Redistributions of source code must retain the above copyright
9    notice, this list of conditions and the following disclaimer.
10
11    - Redistributions in binary form must reproduce the above copyright
12    notice, this list of conditions and the following disclaimer in the
13    documentation and/or other materials provided with the distribution.
14
15    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
19    OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 /**
29  * @file mapping_matrix.h
30  * @brief Opus reference implementation mapping matrix API
31  */
32
33 #ifndef MAPPING_MATRIX_H
34 #define MAPPING_MATRIX_H
35
36 #ifdef ENABLE_EXPERIMENTAL_AMBISONICS
37
38 #include "opus_types.h"
39 #include "opus_projection.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 typedef struct MappingMatrix
46 {
47     int rows;
48     int cols;
49     int gain; /* in dB. S7.8-format. */
50     /* Matrix cell data goes here using col-wise ordering. */
51 } MappingMatrix;
52
53 int mapping_matrix_get_size(int rows, int cols);
54
55 opus_int16 *mapping_matrix_get_data(const MappingMatrix *matrix);
56
57 void mapping_matrix_init(
58     MappingMatrix * const st,
59     int rows,
60     int cols,
61     int gain,
62     const opus_int16 *data,
63     opus_int32 data_size
64 );
65
66 #ifndef DISABLE_FLOAT_API
67 void mapping_matrix_multiply_float(
68     const MappingMatrix *matrix,
69     const float *input,
70     int input_rows,
71     float *output,
72     int output_rows,
73     int frame_size
74 );
75 #endif /* DISABLE_FLOAT_API */
76
77 void mapping_matrix_multiply_short(
78     const MappingMatrix *matrix,
79     const opus_int16 *input,
80     int input_rows,
81     opus_int16 *output,
82     int output_rows,
83     int frame_size
84 );
85
86 /* Pre-computed mixing and demixing matrices for 1st to 3rd-order ambisonics.
87  *   foa: first-order ambisonics
88  *   soa: second-order ambisonics
89  *   toa: third-order ambisonics
90  */
91 extern const MappingMatrix mapping_matrix_foa_mixing;
92 extern const opus_int16 mapping_matrix_foa_mixing_data[36];
93
94 extern const MappingMatrix mapping_matrix_soa_mixing;
95 extern const opus_int16 mapping_matrix_soa_mixing_data[121];
96
97 extern const MappingMatrix mapping_matrix_toa_mixing;
98 extern const opus_int16 mapping_matrix_toa_mixing_data[324];
99
100 extern const MappingMatrix mapping_matrix_foa_demixing;
101 extern const opus_int16 mapping_matrix_foa_demixing_data[36];
102
103 extern const MappingMatrix mapping_matrix_soa_demixing;
104 extern const opus_int16 mapping_matrix_soa_demixing_data[121];
105
106 extern const MappingMatrix mapping_matrix_toa_demixing;
107 extern const opus_int16 mapping_matrix_toa_demixing_data[324];
108
109 #ifdef __cplusplus
110 }
111 #endif
112
113 #endif /* ENABLE_EXPERIMENTAL_AMBISONICS */
114
115 #endif /* MAPPING_MATRIX_H */