mode.h

/*
 * Copyright (c) 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 "definitions_cxx.hpp"
#include "gui/l10n/l10n.h"
#include "gui/menu_item/filter/info.h"
#include "gui/menu_item/selection.h"
#include "gui/ui/sound_editor.h"
#include "model/instrument/kit.h"
#include "model/mod_controllable/mod_controllable_audio.h"
#include "model/settings/runtime_feature_settings.h"
#include "model/song/song.h"
#include "processing/sound/sound.h"
#include "processing/sound/sound_drum.h"
#include "util/misc.h"
 
namespace deluge::gui::menu_item::filter {
 
class FilterModeSelection final : public Selection {
public:
    FilterModeSelection(deluge::l10n::String newName, deluge::l10n::String newTitle, FilterSlot slot_)
        : Selection{newName, newTitle}, info{slot_, FilterParamType::MODE} {}
    void readCurrentValue() override { this->setValue(info.getModeValue()); }
    bool usesAffectEntire() override { return true; }
    void writeCurrentValue() override {
        auto current_value = this->getValue();
 
        // If affect-entire button held, do whole kit
        if (currentUIMode == UI_MODE_HOLDING_AFFECT_ENTIRE_IN_SOUND_EDITOR && soundEditor.editingKitRow()) {
 
            Kit* kit = getCurrentKit();
 
            for (Drum* thisDrum = kit->firstDrum; thisDrum != nullptr; thisDrum = thisDrum->next) {
                if (thisDrum->type == DrumType::SOUND) {
                    auto* soundDrum = static_cast<SoundDrum*>(thisDrum);
 
                    info.setModeForModControllable(current_value, soundDrum);
                }
            }
        }
        // Or, the normal case of just one sound
        else {
            info.setMode(current_value);
        }
    }
    bool wrapAround() override {
        // We want the mode menus to wrap around when using horizontal menus: that way NONE -> turn clockwise
        // turns the filter on.
        return display->have7SEG() || runtimeFeatureSettings.isOn(RuntimeFeatureSettingType::HorizontalMenus);
    }
    deluge::vector<std::string_view> getOptions(OptType optType) override {
        using enum l10n::String;
        bool shortOpt = optType == OptType::SHORT;
        if (info.getSlot() == FilterSlot::HPF) {
            return {
                l10n::getView(shortOpt ? STRING_FOR_SVF_BAND_SHORT : STRING_FOR_SVF_BAND),
                l10n::getView(shortOpt ? STRING_FOR_SVF_NOTCH_SHORT : STRING_FOR_SVF_NOTCH),
                l10n::getView(shortOpt ? STRING_FOR_12DB_LADDER_SHORT : STRING_FOR_HPLADDER),
                l10n::getView(STRING_FOR_OFF),
            };
        }
        else {
            return {
                l10n::getView(shortOpt ? STRING_FOR_12DB_LADDER_SHORT : STRING_FOR_12DB_LADDER),
                l10n::getView(shortOpt ? STRING_FOR_24DB_LADDER_SHORT : STRING_FOR_24DB_LADDER),
                l10n::getView(STRING_FOR_DRIVE),
                l10n::getView(shortOpt ? STRING_FOR_SVF_BAND_SHORT : STRING_FOR_SVF_BAND),
                l10n::getView(shortOpt ? STRING_FOR_SVF_NOTCH_SHORT : STRING_FOR_SVF_NOTCH),
                l10n::getView(STRING_FOR_OFF),
            };
        }
    }
 
private:
    FilterInfo info;
};
 
} // namespace deluge::gui::menu_item::filter