tmp
[blender.git] / extern / audaspace / include / fx / DynamicIIRFilterReader.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file DynamicIIRFilterReader.h
21  * @ingroup fx
22  * The DynamicIIRFilterReader class.
23  */
24
25 #include "fx/IIRFilterReader.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 class IDynamicIIRFilterCalculator;
30
31 /**
32  * This class is for dynamic infinite impulse response filters with simple
33  * coefficients that change depending on the sample rate.
34  */
35 class AUD_API DynamicIIRFilterReader : public IIRFilterReader
36 {
37 private:
38         /**
39          * The sound for dynamically recalculating filter coefficients.
40          */
41         std::shared_ptr<IDynamicIIRFilterCalculator> m_calculator;
42
43 public:
44         /**
45          * Creates a new DynamicIIRFilterReader.
46          * @param reader The reader the filter is applied on.
47          * @param calculator The IDynamicIIRFilterCalculator that recalculates the filter coefficients.
48          */
49         DynamicIIRFilterReader(std::shared_ptr<IReader> reader,
50                                                            std::shared_ptr<IDynamicIIRFilterCalculator> calculator);
51
52         /**
53          * The function sampleRateChanged is called whenever the sample rate of the
54          * underlying reader changes and thus updates the filter coefficients.
55          * @param rate The new sample rate.
56          */
57         virtual void sampleRateChanged(SampleRate rate);
58 };
59
60 AUD_NAMESPACE_END