param.h

/*
 * Copyright © 2024 Synthstrom Audible Limited
 *
 * This file is part of The Synthstrom Audible Deluge Firmware.
 *
 * The Synthstrom Audible Deluge Firmware 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 <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "definitions_cxx.hpp"
#include "modulation/params/param_descriptor.h"
#include "util/misc.h"
#include <algorithm>
#include <cstdint>

 
class ModControllableAudio;
 
namespace deluge::modulation::params {
enum class Kind : int32_t {
    NONE,

    PATCHED,
    UNPATCHED_SOUND,
    UNPATCHED_GLOBAL,
    STATIC,
    MIDI,
    PATCH_CABLE,
    EXPRESSION,
};

using ParamType = uint8_t;

enum Local : ParamType {
    // Local linear params begin
    LOCAL_OSC_A_VOLUME,
    LOCAL_OSC_B_VOLUME,
    LOCAL_VOLUME,
    LOCAL_NOISE_VOLUME,
    LOCAL_MODULATOR_0_VOLUME,
    LOCAL_MODULATOR_1_VOLUME,
    LOCAL_FOLD,
 
    // Local non-volume params begin
    FIRST_LOCAL_NON_VOLUME,
    LOCAL_MODULATOR_0_FEEDBACK = FIRST_LOCAL_NON_VOLUME,
    LOCAL_MODULATOR_1_FEEDBACK,
    LOCAL_CARRIER_0_FEEDBACK,
    LOCAL_CARRIER_1_FEEDBACK,
    LOCAL_LPF_RESONANCE,
    LOCAL_HPF_RESONANCE,
    LOCAL_ENV_0_SUSTAIN,
    LOCAL_ENV_1_SUSTAIN,
    LOCAL_ENV_2_SUSTAIN,
    LOCAL_ENV_3_SUSTAIN,
    LOCAL_LPF_MORPH,
    LOCAL_HPF_MORPH,
 
    // Local hybrid params begin
    FIRST_LOCAL__HYBRID,
    LOCAL_OSC_A_PHASE_WIDTH = FIRST_LOCAL__HYBRID,
    LOCAL_OSC_B_PHASE_WIDTH,
    LOCAL_OSC_A_WAVE_INDEX,
    LOCAL_OSC_B_WAVE_INDEX,
    LOCAL_PAN,
 
    // Local exp params begin
    FIRST_LOCAL_EXP,
    LOCAL_LPF_FREQ = FIRST_LOCAL_EXP,
    LOCAL_PITCH_ADJUST,
    LOCAL_OSC_A_PITCH_ADJUST,
    LOCAL_OSC_B_PITCH_ADJUST,
    LOCAL_MODULATOR_0_PITCH_ADJUST,
    LOCAL_MODULATOR_1_PITCH_ADJUST,
    LOCAL_HPF_FREQ,
    LOCAL_LFO_LOCAL_FREQ_1,
    LOCAL_LFO_LOCAL_FREQ_2,
    LOCAL_ENV_0_ATTACK,
    LOCAL_ENV_1_ATTACK,
    LOCAL_ENV_2_ATTACK,
    LOCAL_ENV_3_ATTACK,
    LOCAL_ENV_0_DECAY,
    LOCAL_ENV_1_DECAY,
    LOCAL_ENV_2_DECAY,
    LOCAL_ENV_3_DECAY,
    LOCAL_ENV_0_RELEASE,
    LOCAL_ENV_1_RELEASE,
    LOCAL_ENV_2_RELEASE,
    LOCAL_ENV_3_RELEASE,

    LOCAL_LAST,
};

enum Global : ParamType {
    FIRST_GLOBAL = LOCAL_LAST,
    // Global (linear) params begin
    GLOBAL_VOLUME_POST_FX = FIRST_GLOBAL,
    GLOBAL_VOLUME_POST_REVERB_SEND,
    GLOBAL_REVERB_AMOUNT,
    GLOBAL_MOD_FX_DEPTH,
 
    // Global non-volume params begin
    FIRST_GLOBAL_NON_VOLUME,
    GLOBAL_DELAY_FEEDBACK = FIRST_GLOBAL_NON_VOLUME,
 
    // Global hybrid params begin
 
    // There are no global hybrid params, so FIRST_GLOBAL_EXP is set to the same value. If you add a GLOBAL_HYBRID
    // param, make sure you undo that!
    FIRST_GLOBAL_HYBRID,
 
    // Global exp params begin
    FIRST_GLOBAL_EXP = FIRST_GLOBAL_HYBRID,
    GLOBAL_DELAY_RATE = FIRST_GLOBAL_EXP,
    GLOBAL_MOD_FX_RATE,
    GLOBAL_LFO_FREQ_1,
    GLOBAL_LFO_FREQ_2,
    GLOBAL_ARP_RATE,
 
    GLOBAL_NONE,
};

enum Placeholder : ParamType {
    PLACEHOLDER_RANGE = 89,
};
 
static_assert(util::to_underlying(PLACEHOLDER_RANGE) > util::to_underlying(GLOBAL_NONE),
              "RANGE placeholder collides with global params");

constexpr ParamType UNPATCHED_START = 90;
static_assert(UNPATCHED_START > PLACEHOLDER_RANGE, "UNPATCHED params collide with placeholders");

enum UnpatchedShared : ParamType {
    UNPATCHED_STUTTER_RATE,
    UNPATCHED_BASS,
    UNPATCHED_TREBLE,
    UNPATCHED_BASS_FREQ,
    UNPATCHED_TREBLE_FREQ,
    UNPATCHED_SAMPLE_RATE_REDUCTION,
    UNPATCHED_BITCRUSHING,
    UNPATCHED_MOD_FX_OFFSET,
    UNPATCHED_MOD_FX_FEEDBACK,
    UNPATCHED_SIDECHAIN_SHAPE,
    UNPATCHED_COMPRESSOR_THRESHOLD,
    // Arp
    UNPATCHED_FIRST_ARP_PARAM,
    UNPATCHED_ARP_GATE = UNPATCHED_FIRST_ARP_PARAM,
    UNPATCHED_ARP_RHYTHM,
    UNPATCHED_ARP_SEQUENCE_LENGTH,
    UNPATCHED_ARP_CHORD_POLYPHONY,
    UNPATCHED_ARP_RATCHET_AMOUNT,
    UNPATCHED_NOTE_PROBABILITY,
    UNPATCHED_REVERSE_PROBABILITY,
    UNPATCHED_ARP_BASS_PROBABILITY,
    UNPATCHED_ARP_CHORD_PROBABILITY,
    UNPATCHED_ARP_RATCHET_PROBABILITY,
    UNPATCHED_ARP_SPREAD_GATE,
    UNPATCHED_ARP_SPREAD_OCTAVE,
    UNPATCHED_SPREAD_VELOCITY,
    UNPATCHED_LAST_ARP_PARAM,
    UNPATCHED_NUM_SHARED = UNPATCHED_LAST_ARP_PARAM,
};

enum UnpatchedSound : ParamType {
    UNPATCHED_PORTAMENTO = UNPATCHED_NUM_SHARED,
    UNPATCHED_SOUND_MAX_NUM,
};

enum UnpatchedGlobal : ParamType {
    UNPATCHED_MOD_FX_RATE = UNPATCHED_NUM_SHARED,
    UNPATCHED_MOD_FX_DEPTH,
    UNPATCHED_DELAY_RATE,
    UNPATCHED_DELAY_AMOUNT,
    UNPATCHED_ARP_RATE,
    UNPATCHED_PAN,
    UNPATCHED_LPF_FREQ,
    UNPATCHED_LPF_RES,
    UNPATCHED_LPF_MORPH,
    UNPATCHED_HPF_FREQ,
    UNPATCHED_HPF_RES,
    UNPATCHED_HPF_MORPH,
    UNPATCHED_REVERB_SEND_AMOUNT,
    UNPATCHED_VOLUME,
    UNPATCHED_SIDECHAIN_VOLUME,
    UNPATCHED_PITCH_ADJUST,
    UNPATCHED_TEMPO,
    UNPATCHED_GLOBAL_MAX_NUM,
};
 
constexpr ParamType STATIC_START = 162;
 
enum Static : ParamType {
    STATIC_SIDECHAIN_ATTACK = STATIC_START,
    STATIC_SIDECHAIN_RELEASE,
 
    // Only used for the reverb sidechain. Normally this is done with patching
    STATIC_SIDECHAIN_VOLUME,
};

constexpr ParamType PATCH_CABLE = 190;

constexpr ParamType kNumParams = GLOBAL_NONE;
constexpr ParamType kMaxNumUnpatchedParams =
    std::max<ParamType>(util::to_underlying(UNPATCHED_GLOBAL_MAX_NUM), util::to_underlying(UNPATCHED_SOUND_MAX_NUM));

constexpr ParamType kUnpatchedAndPatchedMaximum = kMaxNumUnpatchedParams + UNPATCHED_START;
 
static_assert(kMaxNumUnpatchedParams < STATIC_START, "Error: Too many UNPATCHED parameters, (collision with STATIC)");
 
bool isParamBipolar(Kind kind, int32_t paramID);
bool isParamPan(Kind kind, int32_t paramID);
bool isParamPitch(Kind kind, int32_t paramID);
bool isParamPitchBend(Kind kind, int32_t paramID);
bool isParamArpRhythm(Kind kind, int32_t paramID);
bool isParamStutter(Kind kind, int32_t paramID);
bool isParamQuantizedStutter(Kind kind, int32_t paramID, ModControllableAudio* modControllableAudio);
 
bool isVibratoPatchCableShortcut(int32_t xDisplay, int32_t yDisplay);
bool isSidechainPatchCableShortcut(int32_t xDisplay, int32_t yDisplay);
bool isPatchCableShortcut(int32_t xDisplay, int32_t yDisplay);
void getPatchCableFromShortcut(int32_t xDisplay, int32_t yDisplay, ParamDescriptor* paramDescriptor);
 
char const* getPatchedParamDisplayName(int32_t p);
char const* getPatchedParamShortName(ParamType type);
char const* getParamDisplayName(Kind kind, int32_t p);
 
bool paramNeedsLPF(ParamType p, bool fromAutomation);

char const* paramNameForFile(Kind kind, ParamType param);

ParamType fileStringToParam(Kind kind, char const* name, bool allowPatched);

constexpr uint32_t kNoParamID = 0xFFFFFFFF;

// clang-format off
const uint32_t patchedParamShortcuts[kDisplayWidth][kDisplayHeight] = {
    {kNoParamID              , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {kNoParamID              , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {LOCAL_OSC_A_VOLUME      , LOCAL_OSC_A_PITCH_ADJUST      , kNoParamID                    , LOCAL_OSC_A_PHASE_WIDTH, kNoParamID     , LOCAL_CARRIER_0_FEEDBACK  , LOCAL_OSC_A_WAVE_INDEX, LOCAL_NOISE_VOLUME},
    {LOCAL_OSC_B_VOLUME      , LOCAL_OSC_B_PITCH_ADJUST      , kNoParamID                    , LOCAL_OSC_B_PHASE_WIDTH, kNoParamID     , LOCAL_CARRIER_1_FEEDBACK  , LOCAL_OSC_B_WAVE_INDEX, kNoParamID},
    {LOCAL_MODULATOR_0_VOLUME, LOCAL_MODULATOR_0_PITCH_ADJUST, kNoParamID                    , kNoParamID             , kNoParamID     , LOCAL_MODULATOR_0_FEEDBACK, kNoParamID            , kNoParamID},
    {LOCAL_MODULATOR_1_VOLUME, LOCAL_MODULATOR_1_PITCH_ADJUST, kNoParamID                    , kNoParamID             , kNoParamID     , LOCAL_MODULATOR_1_FEEDBACK, kNoParamID            , kNoParamID},
    {GLOBAL_VOLUME_POST_FX   , LOCAL_PITCH_ADJUST            , kNoParamID                    , LOCAL_PAN              , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {kNoParamID              , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , LOCAL_FOLD},
    {LOCAL_ENV_0_RELEASE     , LOCAL_ENV_0_SUSTAIN           , LOCAL_ENV_0_DECAY             , LOCAL_ENV_0_ATTACK     , LOCAL_LPF_MORPH, kNoParamID                , LOCAL_LPF_RESONANCE   , LOCAL_LPF_FREQ},
    {LOCAL_ENV_1_RELEASE     , LOCAL_ENV_1_SUSTAIN           , LOCAL_ENV_1_DECAY             , LOCAL_ENV_1_ATTACK     , LOCAL_HPF_MORPH, kNoParamID                , LOCAL_HPF_RESONANCE   , LOCAL_HPF_FREQ},
    {kNoParamID              , kNoParamID                    , kNoParamID                  , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {GLOBAL_ARP_RATE         , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {GLOBAL_LFO_FREQ_1         , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , GLOBAL_MOD_FX_DEPTH   , GLOBAL_MOD_FX_RATE},
    {LOCAL_LFO_LOCAL_FREQ_1    , kNoParamID                    , kNoParamID                    , GLOBAL_REVERB_AMOUNT   , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {GLOBAL_DELAY_RATE       , kNoParamID                    , kNoParamID                    , GLOBAL_DELAY_FEEDBACK  , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID},
    {kNoParamID              , kNoParamID                    , kNoParamID                    , kNoParamID             , kNoParamID     , kNoParamID                , kNoParamID            , kNoParamID}
};
// clang-format on

// clang-format off
const uint32_t unpatchedNonGlobalParamShortcuts[kDisplayWidth][kDisplayHeight] = {
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , UNPATCHED_STUTTER_RATE},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , UNPATCHED_SAMPLE_RATE_REDUCTION, UNPATCHED_BITCRUSHING, kNoParamID},
    {UNPATCHED_PORTAMENTO, kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, UNPATCHED_SIDECHAIN_SHAPE , kNoParamID                     , UNPATCHED_BASS       , UNPATCHED_BASS_FREQ},
    {kNoParamID          , kNoParamID, UNPATCHED_ARP_GATE, kNoParamID, kNoParamID                , kNoParamID                     , UNPATCHED_TREBLE     , UNPATCHED_TREBLE_FREQ},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, UNPATCHED_MOD_FX_OFFSET   , UNPATCHED_MOD_FX_FEEDBACK      , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , kNoParamID, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID},
    {kNoParamID          , UNPATCHED_SPREAD_VELOCITY, kNoParamID        , kNoParamID, kNoParamID                , kNoParamID                     , kNoParamID           , kNoParamID}
};
// clang-format on

// clang-format off
const uint32_t unpatchedGlobalParamShortcuts[kDisplayWidth][kDisplayHeight] = {
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , UNPATCHED_STUTTER_RATE},
    {UNPATCHED_VOLUME    , UNPATCHED_PITCH_ADJUST, kNoParamID                , UNPATCHED_PAN               , kNoParamID                , UNPATCHED_SAMPLE_RATE_REDUCTION, UNPATCHED_BITCRUSHING , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , UNPATCHED_LPF_MORPH       , kNoParamID                       , UNPATCHED_LPF_RES     , UNPATCHED_LPF_FREQ},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , UNPATCHED_HPF_MORPH       , kNoParamID                       , UNPATCHED_HPF_RES     , UNPATCHED_HPF_FREQ},
    {kNoParamID          , kNoParamID            , UNPATCHED_SIDECHAIN_VOLUME, kNoParamID                  , UNPATCHED_SIDECHAIN_SHAPE , kNoParamID                     , UNPATCHED_BASS        , UNPATCHED_BASS_FREQ},
    {UNPATCHED_ARP_RATE  , kNoParamID            , UNPATCHED_ARP_GATE        , kNoParamID                  , kNoParamID                  , kNoParamID                       , UNPATCHED_TREBLE      , UNPATCHED_TREBLE_FREQ},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , UNPATCHED_MOD_FX_OFFSET   , UNPATCHED_MOD_FX_FEEDBACK      , UNPATCHED_MOD_FX_DEPTH, UNPATCHED_MOD_FX_RATE},
    {kNoParamID          , kNoParamID            , kNoParamID                , UNPATCHED_REVERB_SEND_AMOUNT, kNoParamID                , kNoParamID                       , kNoParamID            , kNoParamID},
    {UNPATCHED_DELAY_RATE, kNoParamID            , kNoParamID                , UNPATCHED_DELAY_AMOUNT      , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID},
    {kNoParamID          , kNoParamID            , kNoParamID                , kNoParamID                  , kNoParamID                  , kNoParamID                       , kNoParamID            , kNoParamID}};
// clang-format on
 
uint32_t expressionParamFromShortcut(int x, int y);
} // namespace deluge::modulation::params