patch_cable_strength.h

/*
 * Copyright © 2014-2023 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 "decimal.h"
#include "gui/menu_item/automation/automation.h"
#include "menu_item_with_cc_learning.h"
 
#include <gui/ui/sound_editor.h>
#include <modulation/patch/patch_cable.h>
class MultiRange;
 
namespace deluge::gui::menu_item {
 
class PatchCableStrength : public Decimal, public MenuItemWithCCLearning, public Automation {
public:
    using Decimal::Decimal;
    void beginSession(MenuItem* navigatedBackwardFrom) final;
    void endSession() final;
    void readCurrentValue() final;
    void writeCurrentValue() override;
    [[nodiscard]] int32_t getMinValue() const final { return kMinMenuPatchCableValue; }
    [[nodiscard]] int32_t getMaxValue() const final { return kMaxMenuPatchCableValue; }
    [[nodiscard]] int32_t getNumDecimalPlaces() const final { return 2; }
    virtual int32_t getDefaultEditPos() { return 2; }
    MenuPermission checkPermissionToBeginSession(ModControllableAudio* modControllable, int32_t whichThing,
                                                 MultiRange** currentRange) override;
    virtual ParamDescriptor getDestinationDescriptor() = 0;
    virtual PatchSource getS() = 0;
    uint8_t getIndexOfPatchedParamToBlink() final;
    MenuItem* selectButtonPress() final;
    ActionResult buttonAction(hid::Button b, bool on, bool inCardRoutine) override;
    void selectEncoderAction(int32_t offset) override;
    void horizontalEncoderAction(int32_t offset) override;
    [[nodiscard]] bool allowToBeginSessionFromHorizontalMenu() override { return true; }
 
    modulation::params::Kind getParamKind();
    uint32_t getParamIndex();
    PatchSource getPatchSource() override;
 
    // OLED Only
    void renderOLED() override;
    // 7SEG only
    void appendAdditionalDots(std::vector<uint8_t>& dotPositions) override;
 
    void unlearnAction() final { MenuItemWithCCLearning::unlearnAction(); }
    bool allowsLearnMode() final { return MenuItemWithCCLearning::allowsLearnMode(); }
    void learnKnob(MIDICable* cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel) final {
        MenuItemWithCCLearning::learnKnob(cable, whichKnob, modKnobMode, midiChannel);
    };
 
    ModelStackWithAutoParam* getModelStackWithParam(void* memory) override;

    uint32_t delayHorizontalScrollUntil = 0;
 
protected:
    ModelStackWithAutoParam* getModelStack(void* memory, bool allowCreation = false);
    void getNotificationValue(StringBuf& valueBuf) override { return valueBuf.appendFloat(getValue() / 100.0f, 2, 2); }
 
private:
    bool isInHorizontalMenu() const;
    void setPatchCablePolarity(Polarity newPolarity);
    void updatePolarityUI();
    Polarity polarity_in_the_ui_;
    // if polarity is set before the patch cable is created then we'll need to update the patch cable when it exists
    bool patch_cable_exists_ = false;
};
 
} // namespace deluge::gui::menu_item