PitchShiftEffect: extend effect options

src/effects/backends/builtin/pitchshifteffect.cpp

@@ -2,6 +2,16 @@
 
 #include "util/sample.h"
 
+namespace {
+static constexpr SINT kDefaultNorm = 2;
+static constexpr SINT kSemitones = 12;
+static constexpr SINT kWideRangeOctaves = 2;
+} // anonymous namespace
+
+PitchShiftEffect::PitchShiftEffect()
+        : m_currentFormant(false) {
+}
+
 PitchShiftGroupState::PitchShiftGroupState(
         const mixxx::EngineParameters& engineParameters)
         : EffectState(engineParameters) {
@@ -61,12 +71,69 @@ EffectManifestPointer PitchShiftEffect::getManifest() {
     pitch->setNeutralPointOnScale(0.0);
     pitch->setRange(-1.0, 0.0, 1.0);
 
+    EffectManifestParameterPointer rangeMode = pManifest->addParameter();
+    rangeMode->setId("rangeMode");
+    rangeMode->setName(QObject::tr("Mode"));
+    rangeMode->setShortName(QObject::tr("Mode"));
+    rangeMode->setDescription(QObject::tr(
+            "Set the range mode. There are three possible options "
+            "based on the knob position:\n"
+            "neutral:\n"
+            "\t - knob: default\n"
+            "\t - range: from the lowest pitch to the highest pitch\n"
+            "positive:\n"
+            "\t - knob: maximum\n"
+            "\t - range: from the default pitch to the highest pitch\n"
+            "negative:\n"
+            "\t - knob: minimum\n"
+            "\t - range: from the default pitch to the lowest pitch"));
+    rangeMode->setValueScaler(EffectManifestParameter::ValueScaler::Linear);
+    rangeMode->setDefaultLinkType(EffectManifestParameter::LinkType::Linked);
+    rangeMode->setNeutralPointOnScale(0.0);
+    rangeMode->setRange(-1.0, 0.0, 1.0);
+
+    EffectManifestParameterPointer semitonesMode = pManifest->addParameter();
+    semitonesMode->setId("semitonesMode");
+    semitonesMode->setName(QObject::tr("Semitones"));
+    semitonesMode->setShortName(QObject::tr("Semitones"));
+    semitonesMode->setDescription(QObject::tr(
+            "Set the pitch scale to the semitones mode "
+            "instead of the contiguous mode (set as default)."));
+    semitonesMode->setValueScaler(EffectManifestParameter::ValueScaler::Toggle);
+    semitonesMode->setUnitsHint(EffectManifestParameter::UnitsHint::Unknown);
+    semitonesMode->setRange(0, 1, 1);
+
+    EffectManifestParameterPointer wideRange = pManifest->addParameter();
+    wideRange->setId("wideRange");
+    wideRange->setName(QObject::tr("Wide Range"));
+    wideRange->setShortName(QObject::tr("Wide Range"));
+    wideRange->setDescription(QObject::tr(
+            "Double the pitch scale range."));
+    wideRange->setValueScaler(EffectManifestParameter::ValueScaler::Toggle);
+    wideRange->setUnitsHint(EffectManifestParameter::UnitsHint::Unknown);
+    wideRange->setRange(0, 0, 1);
+
+    EffectManifestParameterPointer formant = pManifest->addParameter();
+    formant->setId("formant");
+    formant->setName(QObject::tr("Formant"));
+    formant->setShortName(QObject::tr("Formant"));
+    formant->setDescription(QObject::tr(
+            "Applies the Formant Preserving processing "
+            "and activates the handling of the formant shape."));
+    formant->setValueScaler(EffectManifestParameter::ValueScaler::Toggle);
+    formant->setUnitsHint(EffectManifestParameter::UnitsHint::Unknown);
+    formant->setRange(0, 0, 1);
+
     return pManifest;
 }
 
 void PitchShiftEffect::loadEngineEffectParameters(
         const QMap<QString, EngineEffectParameterPointer>& parameters) {
     m_pPitchParameter = parameters.value("pitch");
+    m_pRangeModeParameter = parameters.value("rangeMode");
+    m_pSemitonesModeParameter = parameters.value("semitonesMode");
+    m_pWideRangeParameter = parameters.value("wideRange");
+    m_pFormantParameter = parameters.value("formant");
 }
 
 void PitchShiftEffect::processChannel(
@@ -79,16 +146,44 @@ void PitchShiftEffect::processChannel(
     Q_UNUSED(groupFeatures);
     Q_UNUSED(enableState);
 
-    const double pitchParameter = m_pPitchParameter->value();
-
-    const double pitch = 1.0 + [=] {
-        if (pitchParameter < 0.0) {
-            return pitchParameter / 2.0;
+    if (m_currentFormant != m_pFormantParameter->toBool()) {
+        m_currentFormant = !m_currentFormant;
+
+        pState->m_pRubberBand->setFormantOption(m_currentFormant
+                        ? RubberBand::RubberBandStretcher::
+                                  OptionFormantPreserved
+                        : RubberBand::RubberBandStretcher::
+                                  OptionFormantShifted);
+    }
+
+    const double rangeModeParameter = m_pRangeModeParameter->value();
+
+    double pitchParameter = [=, this] {
+        if (std::abs(rangeModeParameter) < 0.5) {
+            if (m_pWideRangeParameter->toBool()) {
+                return m_pPitchParameter->value() * kWideRangeOctaves;
+            } else {
+                return m_pPitchParameter->value();
+            }
         } else {
-            return pitchParameter;
+            if (m_pWideRangeParameter->toBool()) {
+                return sgn(rangeModeParameter) * kWideRangeOctaves *
+                        (m_pPitchParameter->value() + 1) /
+                        kDefaultNorm;
+            } else {
+                return sgn(rangeModeParameter) *
+                        (m_pPitchParameter->value() + 1) /
+                        kDefaultNorm;
+            }
         }
     }();
 
+    if (m_pSemitonesModeParameter->toBool()) {
+        pitchParameter = roundToFraction(pitchParameter, kSemitones);
+    }
+
+    const double pitch = std::pow(2.0, pitchParameter);
+
     pState->m_pRubberBand->setPitchScale(pitch);
 
     SampleUtil::deinterleaveBuffer(

src/effects/backends/builtin/pitchshifteffect.h

@@ -9,6 +9,7 @@
 #include "engine/effects/engineeffectparameter.h"
 #include "util/class.h"
 #include "util/defs.h"
+#include "util/math.h"
 #include "util/sample.h"
 #include "util/types.h"
 
@@ -30,7 +31,7 @@ class PitchShiftGroupState : public EffectState {
 
 class PitchShiftEffect final : public EffectProcessorImpl<PitchShiftGroupState> {
   public:
-    PitchShiftEffect() = default;
+    PitchShiftEffect();
 
     static QString getId();
     static EffectManifestPointer getManifest();
@@ -51,7 +52,12 @@ class PitchShiftEffect final : public EffectProcessorImpl<PitchShiftGroupState>
         return getId();
     }
 
+    bool m_currentFormant;
     EngineEffectParameterPointer m_pPitchParameter;
+    EngineEffectParameterPointer m_pRangeModeParameter;
+    EngineEffectParameterPointer m_pSemitonesModeParameter;
+    EngineEffectParameterPointer m_pWideRangeParameter;
+    EngineEffectParameterPointer m_pFormantParameter;
 
     DISALLOW_COPY_AND_ASSIGN(PitchShiftEffect);
 };

src/util/math.h

@@ -79,3 +79,9 @@ inline const T db2ratio(const T a) {
     static_assert(std::is_floating_point_v<T>, "db2ratio works only for floating point type");
     return static_cast<T>(pow(10, a / 20));
 }
+
+template<typename T>
+inline const T sgn(const T a) {
+    static_assert(std::is_arithmetic_v<T>, "the value has to be an arithmetic type");
+    return (a > T(0)) - (a < T(0));
+}