AbstractOscillator.h

/*
 * AbstractOscillator.h
 *
 * (c) 2025 Sofian Audry        :: info(@)sofianaudry(.)com
 * (c) 2025 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_OSCILLATOR_H_
#define ABSTRACT_OSCILLATOR_H_
 
#include "PqCore.h"
#include "Timeable.h"
#include "pq_phase_utils.h"
 
namespace pq {

class AbstractOscillator : public Timeable {
public:
  typedef ParameterSlot<AbstractOscillator> Parameter;

  AbstractOscillator(float period);
 
  virtual ~AbstractOscillator() {}

  virtual void start();

  virtual void period(float period);

  virtual float period() const { return _period; }

  Parameter Period() { return Parameter(this, &AbstractOscillator::period, &AbstractOscillator::period); }

  virtual void frequency(float frequency);

  virtual float frequency() const {
#if PQ_OPTIMIZE_FOR_CPU
    return _frequency;
#else
    return periodToFrequency(_period);
#endif
  }

  Parameter Frequency() { return Parameter(this, &AbstractOscillator::frequency, &AbstractOscillator::frequency); }

  virtual void bpm(float bpm);

  virtual float bpm() const { return frequency() * HZ_TO_BPM; }

  Parameter Bpm() { return Parameter(this, &AbstractOscillator::bpm, &AbstractOscillator::bpm); }

  virtual void phase(float phase);

  virtual float phase() const { return pq::fixed32ToFloat(_phase32); }

  Parameter Phase() { return Parameter(this, &AbstractOscillator::phase, &AbstractOscillator::phase); }

  virtual void phaseShift(float phaseShift);

  virtual float phaseShift() const;

  Parameter PhaseShift() { return Parameter(this, &AbstractOscillator::phaseShift, &AbstractOscillator::phaseShift); }

  virtual void jitter(float jitter);

  virtual float jitter() const;

  virtual void noJitter() { jitter(0); }

  Parameter Jitter() { return Parameter(this, &AbstractOscillator::jitter, &AbstractOscillator::jitter); }

  virtual float jitteredPeriod() const;

  virtual float jitteredFrequency() const;

  virtual float timeToPhase(float time) const;

  virtual void setTime(float time);

  virtual void addTime(float time);

  virtual bool isRunning() const { return _isRunning; }

  virtual bool isForward() const { return _isForward; }

  virtual void setForward(bool isForward) { _isForward = isForward; }

  virtual void forward() { _isForward = true; }

  virtual void reverse() { _isForward = false; }

  virtual void toggleReverse() { _isForward = !_isForward; }
 
protected:
  // Returns true iff jittering is enabled.
  bool _hasJitter() const { return bool(_jitter); }
 
  // Perform step with under
  void _stepPhase(float deltaTimeSecondsTimesFixed32Max);
 
  // Sets phase time.
  virtual void _setPhase32(q0_32u_t phase32);
 
  // Sets running state.
  virtual void _setRunning(bool isRunning);
 
  // Picks next random frequency multiplier (for randomized oscillation).
  void _randomPickNext();
 
  // Period (seconds).
  float _period;
 
#if PQ_OPTIMIZE_FOR_CPU
  // Frequency (Hz).
  float _frequency;
#endif
 
  // Non-random mode: Phase shift (in % of period).
  // Random mode: random frequency ratio (in % of frequency).
  float _phaseShiftOrRandomFrequencyRatio;
 
  // Internal use: holds current phase time.
  q0_32u_t _phase32;
 
  // Internal use : overflow indicator
  bool _overflowed : 1;
 
  // Is the wave currently running?
  bool _isRunning : 1;
 
  // The direction of oscillation.
  bool _isForward : 1;
 
  // Flag that makes sure the value is updated only on a need basis.
  bool _valueNeedsUpdate : 1;
 
  // AbstractWave subclass usage. Used to keep track of state.
  bool _preSkew    : 1;
  bool _passedSkew : 1;
 
  // Extra data.
  uint8_t _data : 2;
 
  // Jittering level.
  float _jitter;
};
 
}
 
#endif