source/modules/juce_dsp/widgets/juce_Phaser.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library.
   5    Copyright (c) 2022 - Raw Material Software Limited
   6
   7    JUCE is an open source library subject to commercial or open-source
   8    licensing.
   9
  10    By using JUCE, you agree to the terms of both the JUCE 7 End-User License
  11    Agreement and JUCE Privacy Policy.
  12
  13    End User License Agreement: www.juce.com/juce-7-licence
  14    Privacy Policy: www.juce.com/juce-privacy-policy
  15
  16    Or: You may also use this code under the terms of the GPL v3 (see
  17    www.gnu.org/licenses).
  18
  19    JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
  20    EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
  21    DISCLAIMED.
  22
  23   ==============================================================================
  24 */
  25
  26 namespace juce
  27 {
  28 namespace dsp
  29 {
  30
  31 //==============================================================================
  32 template <typename SampleType>
  33 Phaser<SampleType>::Phaser()
  34 {
  35     auto oscFunction = [] (SampleType x) { return std::sin (x); };
  36     osc.initialise (oscFunction);
  37
  38     for (auto n = 0; n < numStages; ++n)
  39     {
  40         filters.add (new FirstOrderTPTFilter<SampleType>());
  41         filters[n]->setType (FirstOrderTPTFilterType::allpass);
  42     }
  43
  44     dryWet.setMixingRule (DryWetMixingRule::linear);
  45 }
  46
  47 template <typename SampleType>
  48 void Phaser<SampleType>::setRate (SampleType newRateHz)
  49 {
  50     jassert (isPositiveAndBelow (newRateHz, static_cast<SampleType> (100.0)));
  51
  52     rate = newRateHz;
  53     update();
  54 }
  55
  56 template <typename SampleType>
  57 void Phaser<SampleType>::setDepth (SampleType newDepth)
  58 {
  59     jassert (isPositiveAndNotGreaterThan (newDepth, static_cast<SampleType> (1.0)));
  60
  61     depth = newDepth;
  62     update();
  63 }
  64
  65 template <typename SampleType>
  66 void Phaser<SampleType>::setCentreFrequency (SampleType newCentreHz)
  67 {
  68     jassert (isPositiveAndBelow (newCentreHz, static_cast<SampleType> (sampleRate * 0.5)));
  69
  70     centreFrequency = newCentreHz;
  71     normCentreFrequency = mapFromLog10 (centreFrequency, static_cast<SampleType> (20.0), static_cast<SampleType> (jmin (20000.0, 0.49 * sampleRate)));
  72 }
  73
  74 template <typename SampleType>
  75 void Phaser<SampleType>::setFeedback (SampleType newFeedback)
  76 {
  77     jassert (newFeedback >= static_cast<SampleType> (-1.0) && newFeedback <= static_cast<SampleType> (1.0));
  78
  79     feedback = newFeedback;
  80     update();
  81 }
  82
  83 template <typename SampleType>
  84 void Phaser<SampleType>::setMix (SampleType newMix)
  85 {
  86     jassert (isPositiveAndNotGreaterThan (newMix, static_cast<SampleType> (1.0)));
  87
  88     mix = newMix;
  89     update();
  90 }
  91
  92 //==============================================================================
  93 template <typename SampleType>
  94 void Phaser<SampleType>::prepare (const ProcessSpec& spec)
  95 {
  96     jassert (spec.sampleRate > 0);
  97     jassert (spec.numChannels > 0);
  98
  99     sampleRate = spec.sampleRate;
 100
 101     for (auto n = 0; n < numStages; ++n)
 102         filters[n]->prepare (spec);
 103
 104     dryWet.prepare (spec);
 105     feedbackVolume.resize (spec.numChannels);
 106     lastOutput.resize (spec.numChannels);
 107
 108     auto specDown = spec;
 109     specDown.sampleRate /= (double) maxUpdateCounter;
 110     specDown.maximumBlockSize = specDown.maximumBlockSize / (uint32) maxUpdateCounter + 1;
 111
 112     osc.prepare (specDown);
 113     bufferFrequency.setSize (1, (int) specDown.maximumBlockSize, false, false, true);
 114
 115     update();
 116     reset();
 117 }
 118
 119 template <typename SampleType>
 120 void Phaser<SampleType>::reset()
 121 {
 122     std::fill (lastOutput.begin(), lastOutput.end(), static_cast<SampleType> (0));
 123
 124     for (auto n = 0; n < numStages; ++n)
 125         filters[n]->reset();
 126
 127     osc.reset();
 128     dryWet.reset();
 129
 130     oscVolume.reset (sampleRate / (double) maxUpdateCounter, 0.05);
 131
 132     for (auto& vol : feedbackVolume)
 133         vol.reset (sampleRate, 0.05);
 134
 135     updateCounter = 0;
 136 }
 137
 138 template <typename SampleType>
 139 void Phaser<SampleType>::update()
 140 {
 141     osc.setFrequency (rate);
 142     oscVolume.setTargetValue (depth * (SampleType) 0.5);
 143     dryWet.setWetMixProportion (mix);
 144
 145     for (auto& vol : feedbackVolume)
 146         vol.setTargetValue (feedback);
 147 }
 148
 149 //==============================================================================
 150 template class Phaser<float>;
 151 template class Phaser<double>;
 152
 153 } // namespace dsp
 154 } // namespace juce