Nsound::FilterTone Class Reference

#include <Nsound/FilterTone.h>

Inheritance diagram for Nsound::FilterTone:

Classes
struct	Kernel
	A class to store calculated kernels. More...

Public Member Functions
	FilterTone (const float64 &sample_rate, const float64 &half_power_frequency)
virtual	~FilterTone ()
AudioStream	filter (const AudioStream &x)
AudioStream	filter (const AudioStream &x, const Buffer &hp_frequencies)
Buffer	filter (const Buffer &x)
Buffer	filter (const Buffer &x, const Buffer &hp_frequencies)
float64	filter (const float64 &x)
float64	filter (const float64 &x, const float64 &hp_frequency)
float64	getFrequency () const
uint32	getKernelSize () const
void	plot (boolean show_fc=true, boolean show_phase=false)
void	reset ()
void	makeKernel (const float64 &half_power_frequency)
void	setRealtime (bool flag)
AudioStream	filter (const AudioStream &x, const float64 &frequency)
Buffer	filter (const Buffer &x, const float64 &frequency)
Buffer	getFrequencyAxis (const uint32 n_fft=8192)
Buffer	getFrequencyResponse (const uint32 n_fft=8192)
Buffer	getImpulseResponse (const uint32 n_samples=8192)
Buffer	getPhaseResponse ()
float64	getSampleRate () const
void	plot (boolean show_phase=false)

Protected Types
typedef std::set< Kernel >	KernelCache

Protected Attributes
float64	hp_frequency_
float64	b_
float64	a_
float64	last_output_
KernelCache	kernel_cache_
float64	sample_rate_
float64	two_pi_over_sample_rate_
float64	sample_time_
uint32	kernel_size_
bool	is_realtime_

Detailed Description

Definition at line 47 of file FilterTone.h.

Member Typedef Documentation

typedef std::set<Kernel> Nsound::FilterTone::KernelCache

protected

Definition at line 112 of file FilterTone.h.

Constructor & Destructor Documentation

FilterTone::FilterTone	(	const float64 &	sample_rate,
		const float64 &	half_power_frequency
	)

Definition at line 42 of file FilterTone.cc.

References reset().

    :
    Filter(sample_rate),
    hp_frequency_(half_power_frequency),
    b_(0.0),
    a_(0.0),
    last_output_(0.0),
    kernel_cache_()
{
    reset();
}

FilterTone::~FilterTone ( )

virtual

Definition at line 56 of file FilterTone.cc.

{

}

Member Function Documentation

AudioStream FilterTone::filter

(

const AudioStream &

x

)

Definition at line 63 of file FilterTone.cc.

References Nsound::Filter::filter().

Referenced by filter(), Nsound::Pluck::generate(), Nsound::GuitarBass::play(), and Nsound::FluteSlide::play().

{
    return Filter::filter(x);
}

AudioStream FilterTone::filter	(	const AudioStream &	x,
		const Buffer &	hp_frequencies
	)

Definition at line 70 of file FilterTone.cc.

References Nsound::Filter::filter().

{
    return Filter::filter(x, hp_frequencies);
}

Buffer FilterTone::filter

(

const Buffer &

x

)

Definition at line 77 of file FilterTone.cc.

References Nsound::Filter::filter().

{
    return Filter::filter(x);
}

Buffer FilterTone::filter	(	const Buffer &	x,
		const Buffer &	hp_frequencies
	)

Definition at line 84 of file FilterTone.cc.

References Nsound::Filter::filter().

{
    return Filter::filter(x, hp_frequencies);
}

float64 FilterTone::filter ( const float64 &  x )

virtual

Implements Nsound::Filter.

Definition at line 91 of file FilterTone.cc.

References a_, b_, and last_output_.

{
    float64 y = b_ * x - a_ * last_output_;

    last_output_ = y;

    return y;
}

float64 FilterTone::filter ( const float64 &  x, const float64 &  hp_frequency  )

virtual

Implements Nsound::Filter.

Definition at line 102 of file FilterTone.cc.

References filter(), and makeKernel().

{
    makeKernel(hp_frequency);

    return FilterTone::filter(x);
}

float64 Nsound::FilterTone::getFrequency ( ) const

inline

Definition at line 76 of file FilterTone.h.

References hp_frequency_.

{return hp_frequency_;};

uint32 Nsound::FilterTone::getKernelSize ( ) const

inlinevirtual

Reimplemented from Nsound::Filter.

Definition at line 79 of file FilterTone.h.

{ return 2; };

void FilterTone::plot	(	boolean	show_fc = true,
		boolean	show_phase = false
	)

Definition at line 142 of file FilterTone.cc.

References Nsound::Plotter::axvline(), hp_frequency_, Nsound::Filter::plot(), Nsound::Filter::sample_rate_, Nsound::Plotter::subplot(), and Nsound::Plotter::title().

{
    char title[128];
    sprintf(title,
        "Tone Filter Frequency Response\n"
        "order = %d, fc = %0.1f Hz, sr = %0.1f Hz",
        2, hp_frequency_, sample_rate_);

    Filter::plot(show_phase);

    Plotter pylab;

    uint32 n_rows = 1;

    if(show_phase)
    {
        n_rows = 2;
    }

    if(show_fc)
    {
        pylab.subplot(n_rows, 1, 1);

        pylab.axvline(hp_frequency_,"color='red'");

        pylab.title(title);
    }

}

void FilterTone::reset ( )

virtual

Resets interal history buffer and sets the cut off frequency to the one used at declaration.

Implements Nsound::Filter.

Definition at line 174 of file FilterTone.cc.

References hp_frequency_, last_output_, and makeKernel().

Referenced by FilterTone().

{
    last_output_ = 0.0;
    makeKernel(hp_frequency_);
}

void FilterTone::makeKernel

(

const float64 &

half_power_frequency

)

Definition at line 111 of file FilterTone.cc.

References a_, b_, kernel_cache_, and Nsound::Filter::two_pi_over_sample_rate_.

Referenced by filter(), and reset().

{
    FilterTone::
    Kernel new_kernel(static_cast<uint32>(half_power_frequency * 10));

    // See if the kernel is in the cache.
    KernelCache::const_iterator itor = kernel_cache_.find(new_kernel);

    if(itor != kernel_cache_.end())
    {
        // The kernel was found in the cache.
        b_ = itor->b_;
        a_ = itor->a_;
        return;
    }

    // The filter wasn't in the cache, need to make it.

    float64 temp = 2.0 - ::cos(two_pi_over_sample_rate_ * half_power_frequency);

    a_ = -1.0 * (temp - ::sqrt(temp * temp - 1.0));
    b_ = 1.0 + a_;

    new_kernel.b_ = b_;
    new_kernel.a_ = a_;

    kernel_cache_.insert(new_kernel);
}

void Nsound::Filter::setRealtime ( bool  flag )

inlineinherited

Definition at line 57 of file Filter.h.

References Nsound::Filter::is_realtime_.

{is_realtime_ = flag;}

AudioStream Filter::filter ( const AudioStream &  x, const float64 &  frequency  )

inherited

Definition at line 76 of file Filter.cc.

References Nsound::Filter::filter(), Nsound::AudioStream::getNChannels(), Nsound::AudioStream::getSampleRate(), Nsound::Filter::is_realtime_, M_THROW, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    uint32 n_channels = x.getNChannels();

    if(is_realtime_ && n_channels > 1)
    {
        M_THROW("In real-time mode, a filter per audio channel must be used!");
    }

    AudioStream y(x.getSampleRate(), n_channels);

    for(uint32 channel = 0; channel < n_channels; ++channel)
    {
        y[channel] = filter(x[channel], frequency);
    }

    return y;
}

Buffer Filter::filter ( const Buffer &  x, const float64 &  frequency  )

inherited

Definition at line 140 of file Filter.cc.

References Nsound::Buffer::begin(), Nsound::Buffer::end(), Nsound::Filter::filter(), Nsound::Buffer::getLength(), Nsound::Filter::is_realtime_, and Nsound::Filter::reset().

{
    if(!is_realtime_) reset();

    Buffer::const_iterator itor = x.begin();
    Buffer::const_iterator end = x.end();

    Buffer y(x.getLength());

    while(itor != end)
    {
        y << filter(*itor, frequency);

        ++itor;
    }

    return y;
}

Buffer Filter::getFrequencyAxis ( const uint32  n_fft = 8192 )

inherited

Definition at line 185 of file Filter.cc.

References Nsound::FFTransform::roundUp2(), and Nsound::Filter::sample_rate_.

Referenced by main(), Nsound::Filter::plot(), and Nsound::FilterIIR::savePlot().

{
    uint32 fft_chunk_size = FFTransform::roundUp2(
        static_cast<int32>(n_fft));

    uint32 n_samples = fft_chunk_size / 2 + 1;

    float64 f_step = (1.0 / (static_cast<float64>(fft_chunk_size) / 2.0))
                   * (sample_rate_ / 2.0);

    Buffer f_axis;

    float64 f = 0.0;

    for(uint32 i = 0; i < n_samples; ++i)
    {
        f_axis << f;
        f += f_step;
    }

    return f_axis;
};

Buffer Filter::getFrequencyResponse ( const uint32  n_fft = 8192 )

inherited

Definition at line 210 of file Filter.cc.

References Nsound::FFTransform::fft(), Nsound::Filter::getImpulseResponse(), and Nsound::Filter::sample_rate_.

Referenced by Nsound::FilterBandPassIIR::FilterBandPassIIR(), FilterLeastSquaresFIR_UnitTest(), Nsound::FilterIIR::getRMS(), main(), Nsound::Filter::plot(), and Nsound::FilterIIR::savePlot().

{
    FFTransform fft(sample_rate_);

//~    fft.setWindow(HANNING);

    FFTChunkVector vec;

    vec = fft.fft(getImpulseResponse(), n_fft);

    return vec[0].getMagnitude();
}

Buffer Filter::getImpulseResponse ( const uint32  n_samples = 8192 )

inherited

Definition at line 225 of file Filter.cc.

References Nsound::Filter::filter(), Nsound::Filter::is_realtime_, and Nsound::Filter::reset().

Referenced by Nsound::Filter::getFrequencyResponse(), Nsound::FilterHighPassFIR::getImpulseResponse(), Nsound::FilterLowPassFIR::getImpulseResponse(), Nsound::FilterLeastSquaresFIR::getImpulseResponse(), Nsound::FilterIIR::getImpulseResponse(), and Nsound::Filter::getPhaseResponse().

{
    if(!is_realtime_) reset();

    Buffer response(n_samples);

    response << filter(1.0);

    for(uint32 i = 1; i < n_samples; ++i)
    {
        response << filter(0.0);
    }

    if(!is_realtime_) reset();

    return response;
}

Buffer Filter::getPhaseResponse ( )

inherited

Definition at line 245 of file Filter.cc.

References Nsound::FFTransform::fft(), Nsound::Filter::getImpulseResponse(), Nsound::Buffer::getLength(), Nsound::Filter::sample_rate_, and Nsound::Buffer::subbuffer().

Referenced by Nsound::Filter::plot().

{
    uint32 n_samples = static_cast<uint32>(sample_rate_ * 2);

    FFTransform fft(n_samples);

    FFTChunkVector vec;

    vec = fft.fft(getImpulseResponse(), n_samples);

    Buffer phase = vec[0].getPhase();

    return phase.subbuffer(0, phase.getLength() / 2 + 1);
}

float64 Nsound::Filter::getSampleRate ( ) const

inlineinherited

Definition at line 102 of file Filter.h.

References Nsound::Filter::sample_rate_.

{ return sample_rate_; };

void Filter::plot ( boolean  show_phase = false )

inherited

Definition at line 262 of file Filter.cc.

References Nsound::Plotter::figure(), Nsound::Buffer::getdB(), Nsound::Filter::getFrequencyAxis(), Nsound::Filter::getFrequencyResponse(), Nsound::Buffer::getMax(), Nsound::Filter::getPhaseResponse(), Nsound::Plotter::plot(), Nsound::Plotter::subplot(), Nsound::Plotter::xlabel(), Nsound::Plotter::ylabel(), and Nsound::Plotter::ylim().

Referenced by main(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterPhaser::plot(), plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterAllPass::plot(), Nsound::FilterBandPassVocoder::plot(), Nsound::FilterBandPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandPassIIR::plot(), Nsound::FilterBandRejectIIR::plot(), and Nsound::FilterParametricEqualizer::plot().

{
    Buffer x = getFrequencyAxis();
    Buffer fr = getFrequencyResponse().getdB();

    Plotter pylab;

    pylab.figure();

    uint32 n_rows = 1;
    uint32 n_cols = 1;

    if(show_phase)
    {
        n_rows = 2;
    }

    pylab.subplot(n_rows, n_cols, 1);

    // Frequency response
    pylab.plot(x,fr, "blue");

    pylab.xlabel("Frequency (Hz)");
    pylab.ylabel("Frequency Response (dB)");

    // Phase response
    if(show_phase)
    {
        pylab.subplot(n_rows, n_cols, 2);

        Buffer pr = getPhaseResponse().getdB();

        pylab.plot(x,pr);

        pylab.xlabel("Frequency (Hz)");
        pylab.ylabel("Phase Response (dB)");
    }

    float64 ymax = fr.getMax();
    float64 height = ymax - -60.0;

    pylab.ylim(-60.0, ymax + 0.05 * height);
}

Member Data Documentation

float64 Nsound::FilterTone::hp_frequency_

protected

Definition at line 94 of file FilterTone.h.

Referenced by getFrequency(), plot(), and reset().

float64 Nsound::FilterTone::b_

protected

Definition at line 95 of file FilterTone.h.

Referenced by filter(), and makeKernel().

float64 Nsound::FilterTone::a_

protected

Definition at line 96 of file FilterTone.h.

Referenced by filter(), and makeKernel().

float64 Nsound::FilterTone::last_output_

protected

Definition at line 97 of file FilterTone.h.

Referenced by filter(), and reset().

KernelCache Nsound::FilterTone::kernel_cache_

protected

Definition at line 114 of file FilterTone.h.

Referenced by makeKernel().

float64 Nsound::Filter::sample_rate_

protectedinherited

Definition at line 113 of file Filter.h.

Referenced by Nsound::FilterPhaser::filter(), Nsound::FilterCombLowPassFeedback::filter(), Nsound::FilterDelay::filter(), Nsound::FilterAllPass::FilterAllPass(), Nsound::FilterCombLowPassFeedback::FilterCombLowPassFeedback(), Nsound::FilterDelay::FilterDelay(), Nsound::FilterFlanger::FilterFlanger(), Nsound::FilterPhaser::FilterPhaser(), Nsound::FilterSlinky::FilterSlinky(), Nsound::Filter::getFrequencyAxis(), Nsound::Filter::getFrequencyResponse(), Nsound::Filter::getPhaseResponse(), Nsound::Filter::getSampleRate(), Nsound::FilterStageIIR::makeIIRKernelHelper(), Nsound::FilterHighPassFIR::makeKernel(), Nsound::FilterStageIIR::makeKernel(), Nsound::FilterBandPassVocoder::makeKernel(), Nsound::FilterLeastSquaresFIR::makeKernel(), Nsound::FilterParametricEqualizer::makeKernel(), Nsound::FilterPhaser::operator=(), Nsound::FilterLeastSquaresFIR::operator=(), Nsound::FilterFlanger::operator=(), Nsound::FilterIIR::operator=(), Nsound::FilterLowPassMoogVcf::plot(), Nsound::FilterPhaser::plot(), plot(), Nsound::FilterHighPassIIR::plot(), Nsound::FilterLowPassIIR::plot(), Nsound::FilterCombLowPassFeedback::plot(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterAllPass::plot(), Nsound::FilterBandPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterFlanger::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterBandRejectIIR::plot(), Nsound::FilterBandPassIIR::plot(), Nsound::FilterParametricEqualizer::plot(), Nsound::FilterLowPassIIR::setCutoff(), and Nsound::FilterLeastSquaresFIR::setWindow().

float64 Nsound::Filter::two_pi_over_sample_rate_

protectedinherited

Definition at line 114 of file Filter.h.

Referenced by makeKernel(), Nsound::FilterLowPassFIR::makeKernel(), and Nsound::FilterParametricEqualizer::makeKernel().

float64 Nsound::Filter::sample_time_

protectedinherited

Definition at line 115 of file Filter.h.

Referenced by Nsound::FilterLowPassMoogVcf::_make_filter().

uint32 Nsound::Filter::kernel_size_

protectedinherited

Definition at line 116 of file Filter.h.

Referenced by Nsound::FilterLowPassFIR::filter(), Nsound::FilterLeastSquaresFIR::filter(), Nsound::FilterBandPassFIR::FilterBandPassFIR(), Nsound::FilterBandPassIIR::FilterBandPassIIR(), Nsound::FilterBandRejectIIR::FilterBandRejectIIR(), Nsound::FilterHighPassIIR::FilterHighPassIIR(), Nsound::FilterLeastSquaresFIR::FilterLeastSquaresFIR(), Nsound::FilterLowPassFIR::FilterLowPassFIR(), Nsound::FilterLowPassIIR::FilterLowPassIIR(), Nsound::FilterLeastSquaresFIR::getKernel(), Nsound::Filter::getKernelSize(), Nsound::FilterHighPassFIR::makeKernel(), Nsound::FilterLowPassFIR::makeKernel(), Nsound::FilterBandRejectFIR::makeKernel(), Nsound::FilterLeastSquaresFIR::makeKernel(), Nsound::FilterLeastSquaresFIR::operator=(), Nsound::FilterLowPassFIR::plot(), Nsound::FilterHighPassFIR::plot(), Nsound::FilterLeastSquaresFIR::plot(), Nsound::FilterBandRejectFIR::plot(), Nsound::FilterLowPassFIR::reset(), Nsound::FilterHighPassFIR::reset(), Nsound::FilterLeastSquaresFIR::reset(), Nsound::FilterLeastSquaresFIR::setKernel(), Nsound::FilterLeastSquaresFIR::setWindow(), and Nsound::FilterHighPassFIR::spectraReversal_().

bool Nsound::Filter::is_realtime_

protectedinherited

Definition at line 118 of file Filter.h.

Referenced by Nsound::Filter::filter(), Nsound::FilterBandRejectIIR::filter(), Nsound::FilterBandRejectFIR::filter(), Nsound::Filter::getImpulseResponse(), and Nsound::Filter::setRealtime().

---

The documentation for this class was generated from the following files:

• Nsound/FilterTone.h
• Nsound/FilterTone.cc