TTAllpass1a.h

Go to the documentation of this file.

/** @file
 *
 * @ingroup dspFilterLib
 *
 * @brief #TTAllpass1a is a first-order building-block allpass filter.
 *
 * @details This allpass filter uses a fixed delay of 1 sample.
 *
 * @authors Timothy Place, Trond Lossius
 *
 * @copyright Copyright © 2010, Timothy Place @n
 * This code is licensed under the terms of the "New BSD License" @n
 * http://creativecommons.org/licenses/BSD/
 */


#ifndef __TT_ALLPASS1A_H__
#define __TT_ALLPASS1A_H__

#include "TTDSP.h"


/** A first-order building-block allpass filter.
    This allpass filter uses a fixed delay of 1 sample. */
class TTAllpass1a : public TTAudioObjectBase {
    TTCLASS_SETUP(TTAllpass1a)

protected:

    TTFloat64           mAlpha;             ///< single coefficient for the first-order allpass
    TTSampleVector      mX1;                ///< previous input sample (n-1) for each channel
    TTSampleVector      mY1;                ///< previous output sample (n-1) for each channel
    
    // Notifications
    TTErr updateMaxNumChannels(const TTValue& oldMaxNumChannels, TTValue&);

    // Zero filter history
    TTErr clear();
    
    // Do the processing
    TTErr processAudio(TTAudioSignalArrayPtr inputs, TTAudioSignalArrayPtr outputs);
    
    /** Unit Tests
     @param returnedTestInfo        Used to return test information
     @return                        #TTErr error code if the method fails to execute, else #kTTErrNone.
     */
    virtual TTErr test(TTValue& returnedTestInfo);

public:
    TTErr calculateValue(const TTFloat64& x, TTFloat64& y, TTPtrSizedInt channel=0);
};


#endif // __TT_ALLPASS1A_H__