Rename TYPE_DEBUG_PLAYER to TYPE_DEBUG_VIDEO_VIEW.
[dcpomatic.git] / src / lib / audio_filter.h
index f361c27d2cf837508e53887ec7b97600b9310b68..fb7b7b92ccb64283d7bc01235b35d486f0c5422b 100644 (file)
@@ -1,33 +1,39 @@
 /*
     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
-#include <vector>
+#ifndef DCPOMATIC_AUDIO_FILTER_H
+#define DCPOMATIC_AUDIO_FILTER_H
+
 #include <boost/shared_ptr.hpp>
 
 class AudioBuffers;
-class audio_filter_impulse_kernel_test;
-class audio_filter_impulse_input_test;
+struct audio_filter_impulse_input_test;
 
+/** An audio filter which can take AudioBuffers and apply some filtering operation,
+ *  returning filtered samples
+ */
 class AudioFilter
 {
 public:
-       AudioFilter (float transition_bandwidth)
+       explicit AudioFilter (float transition_bandwidth)
+               : _ir (0)
        {
                _M = 4 / transition_bandwidth;
                if (_M % 2) {
@@ -35,17 +41,19 @@ public:
                }
        }
 
-       boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<AudioBuffers> in);
+       virtual ~AudioFilter ();
+
+       boost::shared_ptr<AudioBuffers> run (boost::shared_ptr<const AudioBuffers> in);
 
        void flush ();
 
 protected:
-       friend class audio_filter_impulse_kernel_test;
-       friend class audio_filter_impulse_input_test;
+       friend struct audio_filter_impulse_kernel_test;
+       friend struct audio_filter_impulse_input_test;
 
-       std::vector<float> sinc_blackman (float cutoff, bool invert) const;
+       float* sinc_blackman (float cutoff, bool invert) const;
 
-       std::vector<float> _ir;
+       float* _ir;
        int _M;
        boost::shared_ptr<AudioBuffers> _tail;
 };
@@ -80,3 +88,5 @@ public:
         */
        BandPassAudioFilter (float transition_bandwidth, float lower, float higher);
 };
+
+#endif