1 /* SPDX-License-Identifier: BSD-3-Clause 2 * 3 * Copyright(c) 2021 Waves Audio Ltd. All rights reserved. 4 */ 5 /******************************************************************************* 6 * @page CoreConcepts_MaxxEffect MaxxEffect 7 * 8 * @ref MaxxEffect_t or simply **effect** - is a Waves algorithms handler, that 9 * contains: 10 * @ref MaxxEffect_InternalData_Parameters, 11 * @ref MaxxEffect_InternalData_Coefficients, 12 * @ref MaxxEffect_InternalData_States, 13 * @ref MaxxEffect_InternalData_Meters, etc. required during 14 * effect life-cycle. It is caller responsibility to allocate enough memory 15 * for storing effect handler, and to properly initialize it. Refer to the 16 * @ref Initialization page for handler allocation and initialization. 17 * 18 * @section MaxxEffect_InternalData Data structures 19 * @subsection MaxxEffect_InternalData_Parameters Parameters 20 * Data segment with algorithms parameters representing some 21 * configuration available for tuning, e.g. Master Bypass, Mute, Parametric 22 * EQ band frequency, gain etc. *Parameters preset* is an array of parameter 23 * ID and float-point value (id, value) pairs. Might not be included in 24 * MaxxEffect handler. **Updated in the control path.** 25 * 26 * @subsection MaxxEffect_InternalData_Coefficients Coefficients 27 * Data segment with algorithms coefficients such as filters 28 * difference equations. Computed from parameters and used for processing. 29 * Single coefficient is represented by its ID and the corresponding buffer. 30 * *Coefficients preset* is an array of such pairs. 31 * **Updated in the control path.** 32 * 33 * @subsection MaxxEffect_InternalData_States States 34 * Data segment with algorithms states. 35 * **Updated in the data path.** 36 * 37 * @subsection MaxxEffect_InternalData_Meters Meters 38 * Data segment with algorithms meters representing measure of some value 39 * over a period of time, e.g. level, gain reduction, peak, etc. 40 * **Updated in the data path.** 41 ******************************************************************************/ 42 #ifndef MAXX_EFFECT_H 43 #define MAXX_EFFECT_H 44 45 /** 46 * Waves effect handler. 47 * 48 * @see @ref CoreConcepts_MaxxEffect 49 */ 50 typedef void MaxxEffect_t; 51 52 53 #endif 54
