FilterAllPass.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  $Id: FilterAllPass.h 874 2014-09-08 02:21:29Z weegreenblobbie $
//
//  Nsound is a C++ library and Python module for audio synthesis featuring
//  dynamic digital filters. Nsound lets you easily shape waveforms and write
//  to disk or plot them. Nsound aims to be as powerful as Csound but easy to
//  use.
//
//  Copyright (c) 2007 Nick Hilton
//
//  weegreenblobbie_yahoo_com (replace '_' with '@' and '.')
//
//-----------------------------------------------------------------------------

//-----------------------------------------------------------------------------
//
//  This program 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,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Library 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
//-----------------------------------------------------------------------------
#ifndef _NSOUND_FILTER_ALL_PASS_H_
#define _NSOUND_FILTER_ALL_PASS_H_

#include <Nsound/Filter.h>

namespace Nsound
{

// Forward class declarations
class AudioStream;
class Buffer;
class FilterDelay;

//-----------------------------------------------------------------------------
class FilterAllPass : public Filter
{
    public:

    FilterAllPass(
        const float64 & sample_rate,
        const float64 & max_delay_time_seconds,
        const float64 & gain);

    FilterAllPass(const FilterAllPass & copy);

    virtual
    ~FilterAllPass();

    AudioStream
    filter(const AudioStream & x);

    AudioStream
    filter(const AudioStream & x, const float64 & delay_in_seconds);

    AudioStream
    filter(const AudioStream & x, const Buffer & delay_in_seconds);

    Buffer
    filter(const Buffer & x);

    Buffer
    filter(const Buffer & x, const float64 & delay_in_seconds);

    Buffer
    filter(const Buffer & x, const Buffer & delay_in_seconds);

    float64
    filter(const float64 & x);

    float64
    filter(const float64 & x, const float64 & delay_in_seconds);

    FilterAllPass &
    operator=(const FilterAllPass & rhs);

    void
    plot(boolean show_fc = true, boolean show_phase = false);

    void
    reset();

    protected:

    FilterDelay * x_delay_;
    FilterDelay * y_delay_;

    float64 gain_;

    float64 y_history_;
};

};

// :mode=c++:  jEdit modeline
#endif