flt.h

説明を見る。

#pragma once
#include <filter.h>
#include <shortfract>
/** フィルター・クラス・ヘッダーファイル
* \file flt.h
* fltクラス・ライブラリの宣言を行うヘッダ。フィルタ・クラスを使う場合には必ず見込む。名前空間はflt。
*/

/** フィルター・クラスの名前空間
* IIRフィルタ、FIRフィルタなどのクラスを提供する名前空間。
*/
namespace flt{  
/** フィルタクラス
*
*/
    class CFilter{
    protected:
    /** ディレイライン割付フラグ
     * 外部からディレイ・ラインが割り付けられたときに1にしておく。
     */
        short givenDelayLine;
    public:
/** 便宜上のデストラクタ
*
* このデストラクタは何もしない。しかし、すべての子孫のクラスのデストラクタを
* 仮想デストラクタにするために、ここで便宜上virtual宣言を行う。
*/
        virtual ~CFilter(){};
/** 純粋仮想フィルタ・メソッド
 * \param input shortfract型の入力配列。フィルタへの入力をここに与える。
 * \param output shortfract型の出力配列。フィルタの実行結果がここに格納される。
 * \param count input引数の要素数
*
* input[]で受け取ったデータ列にフィルタ処理を施して、outpu[]に出力する。
* 処理を行うデータ個数はcountで指定する。
*
* このメソッドは純粋仮想メソッドであるため実際には何も実装しない。
* 実装は子孫のクラスが行う。
*/
        virtual void run( const shortfract input[], shortfract output[], int count )=0;

    };


/** FIRフィルタクラス
*
* CFirFilterは、16bit固定小数点によるFIRフィルタのクラスである。VisauDSP++の
* fir_fr16()関数のラッパーとして働く。
*/
    class CFIRFilter : public CFilter{
    protected:
    /** 内部変数
    *
    * この変数はVisualDSP++に用意されている関数、fir_fr16用の内部変数である。
    * 構造体になっており、係数配列へのポインタ、タップ数、ディレイラインへの
    * ポインタなどを収める。
    */  
        fir_state_fr16 state;
    public:
    /** 内部変数を初期化
    * @param h 伝達関数H(係数配列)を与える。
    * @param tap フィルタのタップ数を与える
    * @param d ディレイラインへのポインタを与える。
    *
    * このコンストラクタは内部変数stateの初期化を行う。
    *
    * 伝達関数である係数配列とディレイラインには外部から与えられるポインタをそのまま使う。
    * ディレイラインを与える引数が省略された場合には、内部で割り付けて使う。
    */
        CFIRFilter( const shortfract h[], int tap, shortfract d[] = 0 );
    /** デストラクタ
    *
    * コンストラクタが確保した*(state.d)の領域を開放する。
    */
        virtual ~CFIRFilter();
    /** フィルタ実行メソッド
     * \param input shortfract型の入力配列。フィルタへの入力をここに与える。
     * \param output shortfract型の出力配列。フィルタの実行結果がここに格納される。
     * \param count input引数の要素数
     * 
     * VisualDSP++のfir_fr16のラッパーメソッドとして働く。
    */
        virtual void run( const shortfract input[], shortfract output[], int count );

    };
    
/** バイクワッドIIRフィルタクラス
*
* CIIRFilterは、16bit固定小数点によるIIRフィルタのクラスである。VisauDSP++の
* iir_fr16()関数のラッパーとして働く。VisualDSP++ 4.0 ( July 2006 update )の
* iir_fr16()関数は、転置直接型IIのバイクワッドIIRフィルタである。コンストラクタ
* の引数によって、何段のバイクワッド・フィルタを縦続接続するのか指定できる。
*/
    class CIIRFilter : public CFilter{
    protected:
    /** 内部変数
    *
    * この変数はVisualDSP++に用意されている関数、iir_fr16用の内部変数である。
    * 構造体になっており、係数配列へのポインタ、ステージ数、ディレイラインへの
    * ポインタなどを収める。
    */  
        iir_state_fr16 state;
    public:
    /** 内部変数を初期化
    * @param coeff 伝達関数Hの係数列(係数配列)を与える。
    * @param stage バイクワッド・フィルタの縦続段数を与える
    * @param d ディレイラインへのポインタを与える。
    *
    * このコンストラクタは内部変数stateの初期化を行う。
    *
    * 伝達関数である係数配列とディレイラインには外部から与えられるポインタをそのまま使う。
    * ディレイラインを与える引数が省略された場合には、内部で割り付けて使う。
    *
    * バイクワッド・フィルタの伝達関数H(z)は次のようにあらわす
    *
    * H(z) = B0 + B1*z^-1 + B1*z^-2 / A0 + A1*(z^-1) + A2*(z^-2)
    *
    * ここでcoeff[]には、先頭からA2,A1,B2,B1,B0の順で格納する。A0は常に
    * 1であると仮定しており、不要である。2段のバイクワッド・フィルタの
    * 場合には続けて二段目の係数を格納する。
    *
    * 伝達関数の式およびA,Bの符号の表現方法は文献により異なる。
    * くれぐれも注意すること。
    */
        CIIRFilter( const shortfract coeff[], int stage, shortfract d[] = 0 );
    /** デストラクタ
    *
    * コンストラクタが確保した*(state.d)の領域を開放する。
    */
        virtual ~CIIRFilter();
    /** フィルタ実行メソッド
     * \param input shortfract型の入力配列。フィルタへの入力をここに与える。
     * \param output shortfract型の出力配列。フィルタの実行結果がここに格納される。
     * \param count input引数の要素数
     * 
     * VisualDSP++のiir_fr16のラッパーメソッドとして働く。
    */
        virtual void run( const shortfract input[], shortfract output[], int count );
    };
    
/** デシメーター・クラス
*
* CDecimatorは、16bit固定小数点によるIIRフィルタのクラスである。VisauDSP++の
* fir_decima_fr16()関数のラッパーとして働く。
*/
    class CDecimator : public CFIRFilter{
    public:
    /** 内部変数を初期化
    * @param h 伝達関数H(係数配列)を与える。
    * @param tap フィルタのタップ数を与える
    * @param ratio デシメーション比を与える
    * @param d 内部ディレイライン
    *
    * このコンストラクタは内部変数stateの初期化を行う。ただし、
    * 多くの初期化をCFIRFilter::CFIRFilterから継承しているので
    * 実際にはデシメーション比を内部変数に格納しているだけである。
    *
    * 伝達関数である係数配列とディレイラインには外部から与えられる
    * ポインタhをそのまま使う。ディレイラインの長さはtapである。
    * ディレイラインを与える引数が省略された場合には、内部で割り付けて使う。
    */
        CDecimator( const shortfract h[], int tap, int ratio, shortfract d[] = 0 );
    /** フィルタ実行メソッド
     * \param input shortfract型の入力配列。フィルタへの入力をここに与える。
     * \param output shortfract型の出力配列。フィルタの実行結果がここに格納される。
     *         サイズはcount/デシメーション比。
     * \param count input引数の要素数。この値はCDecimator::CDecimatorで与えたデシメーション比の
     * 整数倍でなければならない
     *
     * VisualDSP++のfir_decima_fr16のラッパーメソッドとして働く。
    */
        virtual void run( const shortfract input[], shortfract output[], int count );
    };
    
/** インターポレーター・クラス
*
* CDecimatorは、16bit固定小数点によるIIRフィルタのクラスである。VisauDSP++の
* fir_interp_fr16()関数のラッパーとして働く。
*/
    
    class CInterpolator : public CFIRFilter{
    public:
    /** 内部変数を初期化
    * @param h 伝達関数H(係数配列)を与える。
    * @param tap フィルタのタップ数を与える。インターポレーション比の整数倍でなければならない。
    * @param ratio インターポレーション比を与える
    * @param d 内部ディレイライン
    *
    * このコンストラクタは内部変数stateの初期化を行う。ただし、
    * 多くの初期化をCFIRFilter::CFIRFilterから継承している。
    * ディレイラインとして与える配列の長さはtap/ratioにする。
    * ディレイラインを与える引数が省略された場合には、内部で割り付けて使う。
    *
    * 
    */
        CInterpolator( const shortfract h[], int tap, int ratio, shortfract d[] = 0 );
    /** フィルタ実行メソッド
     * \param input shortfract型の入力配列。フィルタへの入力をここに与える。
     * \param output shortfract型の出力配列。フィルタの実行結果がここに格納される。
     *         サイズはcount*インターポレーション比。
     * \param count input引数の要素数。
     *
     * VisualDSP++のfir_interp_fr16のラッパーメソッドとして働く。
    */
        virtual void run( const shortfract input[], shortfract output[], int count );
    };
}; // namespace flt

---