WvOut.h

#ifndef STK_WVOUT_H
#define STK_WVOUT_H
 
#include "Stk.h"
 
namespace stk {
 
/***************************************************/
/***************************************************/
 
class WvOut : public Stk
{
 public:
 
  WvOut( void ) : frameCounter_(0), clipping_(false) {};
 
  unsigned long getFrameCount( void ) const { return frameCounter_; };
 
  StkFloat getTime( void ) const { return (StkFloat) frameCounter_ / Stk::sampleRate(); };
 
  bool clipStatus( void ) { return clipping_; };
 
  void resetClipStatus( void ) { clipping_ = false; };
 
 
  virtual void tick( const StkFloat sample ) = 0;
 
  virtual void tick( const StkFrames& frames ) = 0;
 
 protected:
 
  // Check for sample clipping and clamp.
  StkFloat& clipTest( StkFloat& sample );
 
  StkFrames data_;
  unsigned long frameCounter_;
  bool clipping_;
 
};
 
inline StkFloat& WvOut :: clipTest( StkFloat& sample )
{
  bool clip = false;
  if ( sample > 1.0 ) {
    sample = 1.0;
    clip = true;
  }
  else if ( sample < -1.0 ) {
    sample = -1.0;
    clip = true;
  }
 
  if ( clip == true && clipping_ == false ) {
    // First occurrence of clipping since instantiation or reset.
    clipping_ = true;
    handleError("WvOut: data value(s) outside +-1.0 detected ... clamping at outer bound!",  StkError::WARNING );
  }
 
  return sample;
}
 
} // stk namespace
 
#endif