| /* |
| * Copyright (c) 2017, Intel Corporation |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * * Neither the name of the Intel Corporation nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| * |
| * Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com> |
| */ |
| |
| #ifndef EQ_H |
| #define EQ_H |
| |
| /* FIR EQ type */ |
| |
| /* Component will reject non-matching configuration. The version number need |
| * to be incremented with any ABI changes in function fir_cmd(). |
| */ |
| #define SOF_EQ_FIR_ABI_VERSION 1 |
| |
| #define SOF_EQ_FIR_IDX_SWITCH 0 |
| |
| #define SOF_EQ_FIR_MAX_SIZE 4096 /* Max size allowed for coef data in bytes */ |
| |
| #define SOF_EQ_FIR_MAX_LENGTH 192 /* Max length for individual filter */ |
| |
| /* |
| * eq_fir_configuration data structure contains this information |
| * uint32_t size |
| * This is the number of bytes need to store the received EQ |
| * configuration. |
| * uint16_t channels_in_config |
| * This describes the number of channels in this EQ config data. It |
| * can be different from PLATFORM_MAX_CHANNELS. |
| * uint16_t number_of_responses |
| * 0=no responses, 1=one response defined, 2=two responses defined, etc. |
| * int16_t data[] |
| * assign_response[channels_in_config] |
| * 0 = use first response, 1 = use 2nd response, etc. |
| * E.g. {0, 0, 0, 0, 1, 1, 1, 1} would apply to channels 0-3 the |
| * same first defined response and for to channels 4-7 the second. |
| * coef_data[] |
| * Repeated data |
| * { filter_length, output_shift, h[] } |
| * for every EQ response defined where vector h has filter_length |
| * number of coefficients. Coefficients in h[] are in Q1.15 format. |
| * E.g. 16384 (Q1.15) = 0.5. The shifts are number of right shifts. |
| * |
| * NOTE: The channels_in_config must be even to have coef_data aligned to |
| * 32 bit word in RAM. Therefore a mono EQ assign must be duplicated to 2ch |
| * even if it would never used. Similarly a 5ch EQ assign must be increased |
| * to 6ch. EQ init will return an error if this is not met. |
| * |
| * NOTE: The filter_length must be multiple of four. Therefore the filter must |
| * be padded from the end with zeros have this condition met. |
| */ |
| |
| struct sof_eq_fir_config { |
| uint32_t size; |
| uint16_t channels_in_config; |
| uint16_t number_of_responses; |
| int16_t data[]; |
| }; |
| |
| struct sof_eq_fir_coef_data { |
| int16_t length; /* Number of FIR taps */ |
| int16_t out_shift; /* Amount of right shifts at output */ |
| int16_t coef[]; /* FIR coefficients */ |
| }; |
| |
| /* In the struct above there's two words (length, shift) before the actual |
| * FIR coefficients. This information is used in parsing of the config blob. |
| */ |
| #define SOF_EQ_FIR_COEF_NHEADER 2 |
| |
| /* IIR EQ type */ |
| |
| /* Component will reject non-matching configuration. The version number need |
| * to be incremented with any ABI changes in function fir_cmd(). |
| */ |
| #define SOF_EQ_IIR_ABI_VERSION 1 |
| |
| #define SOF_EQ_IIR_IDX_SWITCH 0 |
| |
| #define SOF_EQ_IIR_MAX_SIZE 1024 /* Max size allowed for coef data in bytes */ |
| |
| /* eq_iir_configuration |
| * uint32_t channels_in_config |
| * This describes the number of channels in this EQ config data. It |
| * can be different from PLATFORM_MAX_CHANNELS. |
| * uint32_t number_of_responses_defined |
| * 0=no responses, 1=one response defined, 2=two responses defined, etc. |
| * int32_t data[] |
| * Data consist of two parts. First is the response assign vector that |
| * has length of channels_in_config. The latter part is coefficient |
| * data. |
| * uint32_t assign_response[channels_in_config] |
| * -1 = not defined, 0 = use first response, 1 = use 2nd, etc. |
| * E.g. {0, 0, 0, 0, -1, -1, -1, -1} would apply to channels 0-3 the |
| * same first defined response and leave channels 4-7 unequalized. |
| * coefficient_data[] |
| * <1st EQ> |
| * uint32_t num_biquads |
| * uint32_t num_biquads_in_series |
| * <1st biquad> |
| * int32_t coef_a2 Q2.30 format |
| * int32_t coef_a1 Q2.30 format |
| * int32_t coef_b2 Q2.30 format |
| * int32_t coef_b1 Q2.30 format |
| * int32_t coef_b0 Q2.30 format |
| * int32_t output_shift number of shifts right, shift left is negative |
| * int32_t output_gain Q2.14 format |
| * <2nd biquad> |
| * ... |
| * <2nd EQ> |
| * |
| * Note: A flat response biquad can be made with a section set to |
| * b0 = 1.0, gain = 1.0, and other parameters set to 0 |
| * {0, 0, 0, 0, 1073741824, 0, 16484} |
| */ |
| |
| struct sof_eq_iir_config { |
| uint32_t channels_in_config; |
| uint32_t number_of_responses; |
| int32_t data[]; |
| }; |
| |
| #endif /* EQ_H */ |
