diff options
Diffstat (limited to 'extern/audaspace/include/fx/CallbackIIRFilterReader.h')
-rw-r--r-- | extern/audaspace/include/fx/CallbackIIRFilterReader.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/extern/audaspace/include/fx/CallbackIIRFilterReader.h b/extern/audaspace/include/fx/CallbackIIRFilterReader.h new file mode 100644 index 00000000000..f1dfab70d7f --- /dev/null +++ b/extern/audaspace/include/fx/CallbackIIRFilterReader.h @@ -0,0 +1,88 @@ +/******************************************************************************* + * Copyright 2009-2016 Jörg Müller + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + ******************************************************************************/ + +#pragma once + +/** + * @file CallbackIIRFilterReader.h + * @ingroup fx + * The CallbackIIRFilterReader class. + */ + +#include "fx/BaseIIRFilterReader.h" + +AUD_NAMESPACE_BEGIN + +class CallbackIIRFilterReader; + +/** + * The doFilterIIR callback is executed when a new sample of a callback filter + * should be calculated. For sample access the CallbackIIRFilterReader is + * provided. Furthermore a user defined pointer is also handed to the callback. + */ +typedef sample_t (*doFilterIIR)(CallbackIIRFilterReader*, void*); + +/** + * The endFilterIIR callback is called when the callback filter is not needed + * anymore. The goal of this function should be to clean up the data behind the + * user supplied pointer which is handed to the callback. + */ +typedef void (*endFilterIIR)(void*); + +/** + * This class provides an interface for infinite impulse response filters via a + * callback filter function. + */ +class AUD_API CallbackIIRFilterReader : public BaseIIRFilterReader +{ +private: + /** + * Filter function. + */ + const doFilterIIR m_filter; + + /** + * End filter function. + */ + const endFilterIIR m_endFilter; + + /** + * Data pointer. + */ + void* m_data; + + // delete copy constructor and operator= + CallbackIIRFilterReader(const CallbackIIRFilterReader&) = delete; + CallbackIIRFilterReader& operator=(const CallbackIIRFilterReader&) = delete; + +public: + /** + * Creates a new callback IIR filter reader. + * \param reader The reader to read from. + * \param in The count of past input samples needed. + * \param out The count of past output samples needed. + * \param doFilter The filter callback. + * \param endFilter The finishing callback. + * \param data Data pointer for the callbacks. + */ + CallbackIIRFilterReader(std::shared_ptr<IReader> reader, int in, int out, doFilterIIR doFilter, endFilterIIR endFilter = 0, void* data = nullptr); + + virtual ~CallbackIIRFilterReader(); + + virtual sample_t filter(); +}; + +AUD_NAMESPACE_END |