AbstractWave.h

/*
 * AbstractWave.h
 *
 * (c) 2022 Sofian Audry        :: info(@)sofianaudry(.)com
 * (c) 2015 Thomas O Fredericks :: tof(@)t-o-f(.)info
 *
 * 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 ABSTRACT_WAVE_H_
#define ABSTRACT_WAVE_H_
 
#include "PqCore.h"
#include "AbstractOscillator.h"
#include "pq_phase_utils.h"
 
namespace pq {

class AbstractWave : public AnalogSource, public AbstractOscillator {
public:
  typedef ParameterSlot<AbstractWave> Parameter;

  AbstractWave(Engine& engine = Engine::primary());

  AbstractWave(float period, Engine& engine = Engine::primary());

  AbstractWave(float period, float skew, Engine& engine = Engine::primary());
 
  virtual ~AbstractWave() {}

  virtual float get();

  virtual float shiftBy(float phaseShift) const;

  virtual float shiftByTime(float timeShift) const;

  virtual float atPhase(float phase) const;

  [[deprecated("Use wave.mapTo(min,max) instead.")]]
   virtual void amplitude(float amplitude);

  [[deprecated("Use wave.mapTo(min,max) instead.")]]
   virtual float amplitude() const { return fixed32ToFloat(_amplitude); }

  virtual void skew(float skew);

  virtual float skew() const { return fixed32ToFloat(_skew32); }

  virtual Parameter Skew() { return Parameter(this, &AbstractWave::skew, &AbstractWave::skew); }

  [[deprecated("Use skew(float) instead.")]]
  virtual void width(float width) { skew(width); }

  [[deprecated("Use skew() instead.")]]
  virtual float width() const { return skew(); }

  virtual bool passedPeriod() const { return _overflowed; }

  virtual bool passedSkew() const { return _passedSkew; }

  virtual void onPassPeriod(EventCallback callback);

  virtual void onPassSkew(EventCallback callback);
 
protected:
  // Core Plaquette methods.
  virtual void begin();
  virtual void step();
 
  // Returns true if event is triggered.
  virtual bool eventTriggered(EventType eventType);
 
  // Returns value in [0, 1] as fixed32-point value (to be defined by subclasses).
  virtual q0_32u_t _getFixed32(q0_32u_t t) const = 0;
 
  // Returns amplified version of _get(t).
  virtual float _getAmplified(q0_32u_t t) const;
 
  bool _isPreSkew() const {
    return (_phase32 <= _skew32);
  }
 
  // Call after a change.
  void _updatePassedSkew();
 
  // Amplitude (in %).
  q0_32u_t _amplitude;
 
  // Skew of the signal.
  q0_32u_t _skew32;
};
 
}
 
#endif