flatmax@674: 
flatmax@598: // Author Matt Flax <flatmax@>
flatmax@597: //
flatmax@597: // This C++ file is part of an implementation of Lyon's cochlear model:
flatmax@597: // "Cascade of Asymmetric Resonators with Fast-Acting Compression"
flatmax@597: // to supplement Lyon's upcoming book "Human and Machine Hearing"
flatmax@597: //
flatmax@597: // Licensed under the Apache License, Version 2.0 (the "License");
flatmax@597: // you may not use this file except in compliance with the License.
flatmax@597: // You may obtain a copy of the License at
flatmax@597: //
flatmax@597: //     http://www.apache.org/licenses/LICENSE-2.0
flatmax@597: //
flatmax@597: // Unless required by applicable law or agreed to in writing, software
flatmax@597: // distributed under the License is distributed on an "AS IS" BASIS,
flatmax@597: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
flatmax@597: // See the License for the specific language governing permissions and
flatmax@597: // limitations under the License.
flatmax@597: #ifndef EAR_H_
flatmax@597: #define EAR_H_
flatmax@597: 
flatmax@597: #include "CAR.H"
flatmax@597: #include "IHC.H"
flatmax@597: #include "AGC.H"
flatmax@597: 
flatmax@597: /**
flatmax@597:     \author {Matt Flax <flatmax\@>}
flatmax@597:     \date 2013.02.08
flatmax@597: 
flatmax@597: Class which encapsulates an ear, using the CAR, IHC and AGC classes
flatmax@597: */
flatmax@597: class Ear {
flatmax@598:     FP_TYPE fs; ///< The sample rate
flatmax@598:     FP_TYPE max_channels_per_octave; ///< How many channels in each octave
flatmax@598:     int n_ch; ///< The number of channels (in the ear)
flatmax@597: 
flatmax@598:     CAR car; ///< The cascade of asymmetric resontaors for this ear
flatmax@598:     IHC ihc; ///< The inner hair cell for this ear
flatmax@598:     AGC agc; ///< The automatic gain control for this ear
flatmax@597: 
flatmax@597: public:
flatmax@598:     /** Constructor specifying the sample rate
flatmax@598:     \param fs_ The sample rate to use
flatmax@598:     */
flatmax@598:     Ear(FP_TYPE fs_);
flatmax@598: 
flatmax@598:     /** Constructor using the DEFAULT_SAMPLERATE as the sample rate
flatmax@598:     */
flatmax@598:     Ear(void);
flatmax@598:     virtual ~Ear(void);
flatmax@598: 
flatmax@598:     /** Estimates the number of filter stages and executes the dsign method for each of CAR, AGC and IHC
flatmax@598:     */
flatmax@598:     void design(void);
flatmax@597: };
flatmax@597: 
flatmax@597: #endif // EAR_H_