source/modules/juce_dsp/maths/juce_Phase.h

   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     Represents an increasing phase value between 0 and 2*pi.
  33
  34     This represents a value which can be incremented, and which wraps back to 0 when it
  35     goes past 2 * pi.
  36
  37     @tags{DSP}
  38 */
  39 template <typename Type>
  40 struct Phase
  41 {
  42     /** Resets the phase to 0. */
  43     void reset() noexcept               { phase = 0; }
  44
  45     /** Returns the current value, and increments the phase by the given increment.
  46         The increment must be a positive value, it can't go backwards!
  47         The new value of the phase after calling this function will be (phase + increment) % (2 * pi).
  48     */
  49     Type advance (Type increment) noexcept
  50     {
  51         jassert (increment >= 0); // cannot run this value backwards!
  52
  53         auto last = phase;
  54         auto next = last + increment;
  55
  56         while (next >= MathConstants<Type>::twoPi)
  57             next -= MathConstants<Type>::twoPi;
  58
  59         phase = next;
  60         return last;
  61     }
  62
  63     Type phase = 0;
  64 };
  65
  66 } // namespace dsp
  67 } // namespace juce