aflibaudiobwfilter.3

来自「一个共享源码的音频库5(doc 文档)」· 3 代码 · 共 119 行

.TH "aflibAudioBWFilter" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioBWFilter \- Audio Butterworth filter class. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibAudioBWFilter.h>\fP
.PP
Inherits \fBaflibAudio\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBAFLIB_BWFILTER_MODE\fP { \fBLOW_PASS\fP, \fBHIGH_PASS\fP, \fBBAND_PASS\fP, \fBBAND_REJECT\fP }"
.br
.in -1c
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibAudioBWFilter\fP (\fBaflibAudio\fP &audio, \fBaflibAudioBWFilter::AFLIB_BWFILTER_MODE\fP mode, double freq, double bw)"
.br
.RI "\fIConstuctor with an audio parent.\fP"
.ti -1c
.RI "\fB~aflibAudioBWFilter\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "void \fBsetParameters\fP (\fBaflibAudioBWFilter::AFLIB_BWFILTER_MODE\fP mode, double freq, double bw)"
.br
.RI "\fISets parameters for the butterworth filter class.\fP"
.ti -1c
.RI "void \fBsetInputConfig\fP (const \fBaflibConfig\fP &cfg)"
.br
.RI "\fISets the input audio data configuration of an object.\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBcompute_segment\fP (list< \fBaflibData\fP * > &data, long long position=-1)"
.br
.RI "\fIWork function, must be implemented by derived class.\fP"
.ti -1c
.RI "const char * \fBgetName\fP () const"
.br
.RI "\fIReturns the name of the derived class.\fP"
.ti -1c
.RI "bool \fBisDataSizeSupported\fP (\fBaflib_data_size\fP size)"
.br
.RI "\fIInform base class that this object only supports 16bit signed data.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Audio Butterworth filter class.
.PP
This class provides support for band pass, band reject, low pass, and high pass filters using Butterworth filters. 
.PP
.SH "MEMBER ENUMERATION DOCUMENTATION"
.PP 
.SS "enum aflibAudioBWFilter::AFLIB_BWFILTER_MODE"
.PP
\fBEnumeration values:\fP
.in +1c
.TP
\fB\fI\fILOW_PASS\fP \fP\fP
.TP
\fB\fI\fIHIGH_PASS\fP \fP\fP
.TP
\fB\fI\fIBAND_PASS\fP \fP\fP
.TP
\fB\fI\fIBAND_REJECT\fP \fP\fP

.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibAudioBWFilter::aflibAudioBWFilter (\fBaflibAudio\fP & audio, \fBaflibAudioBWFilter::AFLIB_BWFILTER_MODE\fP mode, double freq, double bw)"
.PP
Constuctor with an audio parent.
.PP
This constructor will setup the Butterworth filter. It accepts a mode which can be one of LOW_PASS, HIGH_PASS, BAND_PASS, and BAND_REJECT. The freq parameter applies to all 4 modes while bw is ignored for  LOW_PASS and HIGH_PASS. The freq parameter represents the corner frequency for LOW_PASS or HIGH_PASS and the center frequency for BAND_PASS or BAND_REJECT. The bw parameter represents the bandwidth. Both freq and bw should be specified in Hertz. 
.SS "aflibAudioBWFilter::~aflibAudioBWFilter ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibAudioBWFilter::compute_segment (list< \fBaflibData\fP * > & data, long long position = -1)\fC [virtual]\fP"
.PP
Work function, must be implemented by derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "const char* aflibAudioBWFilter::getName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioBWFilter::isDataSizeSupported (\fBaflib_data_size\fP size)\fC [virtual]\fP"
.PP
Inform base class that this object only supports 16bit signed data.
.PP
This overrides the virtual function in the base class. This algorithm works only on 16 bit signed data. Base class must convert the data. 
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "void aflibAudioBWFilter::setInputConfig (const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
Sets the input audio data configuration of an object.
.PP
This is a virtual function that derived classes can override if needed. It allows the caller to set the configuration of the audio data of an object. By default it saves the output audio configuration to be the same as the input data configuration that is passed in. This should be sufficient for most derived classes. For those classes that will have a change from the output to input config mapping then this function should be overriden and the output config processed and saved. 
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "void aflibAudioBWFilter::setParameters (\fBaflibAudioBWFilter::AFLIB_BWFILTER_MODE\fP mode, double freq, double bw)"
.PP
Sets parameters for the butterworth filter class.
.PP
This allows the user to change the filter parameters of the butterworth filter after the class has been setup. With this one could change the center frequency or bandwidth dynamically as data is streaming. 

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.