500cfa6e258b5b4d39fe5323596d75a5552b45d4
[dcpomatic.git] / src / lib / audio_filter.h
1 /*
2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
6     DCP-o-matic is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     DCP-o-matic is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
18
19 */
20
21 #ifndef DCPOMATIC_AUDIO_FILTER_H
22 #define DCPOMATIC_AUDIO_FILTER_H
23
24
25 #include <memory>
26
27
28 class AudioBuffers;
29 struct audio_filter_impulse_input_test;
30
31 /** An audio filter which can take AudioBuffers and apply some filtering operation,
32  *  returning filtered samples
33  */
34 class AudioFilter
35 {
36 public:
37         explicit AudioFilter (float transition_bandwidth)
38                 : _ir (0)
39         {
40                 _M = 4 / transition_bandwidth;
41                 if (_M % 2) {
42                         ++_M;
43                 }
44         }
45
46         virtual ~AudioFilter ();
47
48         std::shared_ptr<AudioBuffers> run (std::shared_ptr<const AudioBuffers> in);
49
50         void flush ();
51
52 protected:
53         friend struct audio_filter_impulse_kernel_test;
54         friend struct audio_filter_impulse_input_test;
55
56         float* sinc_blackman (float cutoff, bool invert) const;
57
58         float* _ir;
59         int _M;
60         std::shared_ptr<AudioBuffers> _tail;
61 };
62
63 class LowPassAudioFilter : public AudioFilter
64 {
65 public:
66         /** Construct a windowed-sinc low-pass filter using the Blackman window.
67          *  @param transition_bandwidth Transition bandwidth as a fraction of the sampling rate.
68          *  @param cutoff Cutoff frequency as a fraction of the sampling rate.
69          */
70         LowPassAudioFilter (float transition_bandwidth, float cutoff);
71 };
72
73 class HighPassAudioFilter : public AudioFilter
74 {
75 public:
76         /** Construct a windowed-sinc high-pass filter using the Blackman window.
77          *  @param transition_bandwidth Transition bandwidth as a fraction of the sampling rate.
78          *  @param cutoff Cutoff frequency as a fraction of the sampling rate.
79          */
80         HighPassAudioFilter (float transition_bandwidth, float cutoff);
81 };
82
83 class BandPassAudioFilter : public AudioFilter
84 {
85 public:
86         /** Construct a windowed-sinc band-pass filter using the Blackman window.
87          *  @param transition_bandwidth Transition bandwidth as a fraction of the sampling rate.
88          *  @param lower Lower cutoff frequency as a fraction of the sampling rate.
89          *  @param higher Higher cutoff frequency as a fraction of the sampling rate.
90          */
91         BandPassAudioFilter (float transition_bandwidth, float lower, float higher);
92 };
93
94 #endif