PeakDetector.h

/*
 * PeakDetector.h
 *
 * (c) 2022 Sofian Audry        :: info(@)sofianaudry(.)com
 *
 * 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 3 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef PEAK_DETECTOR_H_
#define PEAK_DETECTOR_H_
 
#include "PqCore.h"
 
enum {
  PEAK_RISING,
  PEAK_FALLING,
  PEAK_MAX,
  PEAK_MIN
};
 
namespace pq {
 
class PeakDetector : public DigitalUnit {
public:
  PeakDetector(float triggerThreshold, Engine& engine = Engine::primary());
 
  PeakDetector(float triggerThreshold, uint8_t mode, Engine& engine = Engine::primary());
  virtual ~PeakDetector() {}
 
  void triggerThreshold(float triggerThreshold);
 
  float triggerThreshold() const { return _triggerThreshold; }
 
  void reloadThreshold(float reloadThreshold);
 
  float reloadThreshold() const { return _reloadThreshold; }
 
  void fallbackTolerance(float fallbackTolerance);
 
  float fallbackTolerance() const { return _fallbackTolerance; }
 
  bool modeInverted() const;
 
  bool modeCrossing() const;
 
  bool modeApex() const;
 
  void mode(uint8_t mode);
 
  uint8_t mode() const { return _mode; }
 
  virtual float put(float value);
 
  virtual bool isOn() { return _onValue; }
 
  virtual void onBang(EventCallback callback);
 
protected:
  // Resets peak detection flags.
  void _reset();
 
  // Returns true if event is triggered.
  virtual bool eventTriggered(EventType eventType);
 
  // Threshold values.
  float _triggerThreshold;
  float _reloadThreshold;
  float _fallbackTolerance;
  float _peakValue;
 
  // Thresholding mode.
  bool _onValue  : 1;
  uint8_t  _mode : 2;
 
  // Booleans used to keep track of signal value.
  bool _isHigh   : 1;
  bool _wasLow   : 1;
  bool _crossed  : 1;
  bool _firstRun : 1;
 
  // Unused extra space.
  uint8_t _data  : 1;
};
 
}
 
#endif