mod_controllable.h

/*
 * Copyright © 2016-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 "modulation/params/param.h"
 
class ParamManagerForTimeline;
class ParamManagerForTimeline;
class InstrumentClip;
class Action;
class ParamManagerForTimeline;
class AutoParam;
class ParamCollection;
class Sound;
class TimelineCounter;
class ModelStackWithAutoParam;
class ModelStackWithThreeMainThings;
class MIDIKnob;
class ModelStackWithSoundFlags;

class ModControllable {
public:
    ModControllable() = default;
    virtual ~ModControllable() = default;
    virtual bool modEncoderButtonAction(uint8_t whichModEncoder, bool on, ModelStackWithThreeMainThings* modelStack) {
        return false;
    } // Returns whether Instrument was changed
    virtual void modButtonAction(uint8_t whichModButton, bool on, ParamManagerForTimeline* paramManager) {};
    virtual ModelStackWithAutoParam*
    getParamFromModEncoder(int32_t whichModEncoder, ModelStackWithThreeMainThings* modelStack,
                           bool allowCreation = true); // Check that autoParam isn't NULL, after calling this.

    virtual ModelStackWithAutoParam* getParamFromMIDIKnob(MIDIKnob& knob, ModelStackWithThreeMainThings* modelStack);
 
    virtual uint8_t* getModKnobMode(); // Return NULL if different modes not supported
    virtual bool isKit() { return false; }
    virtual bool isSong() { return false; }
    virtual bool isEditingComp() { return false; }
    virtual bool valueChangedEnoughToMatter(int32_t old_value, int32_t new_value, deluge::modulation::params::Kind kind,
                                            uint32_t paramID) {
        return old_value != new_value;
    }
    virtual int32_t getKnobPosForNonExistentParam(
        int32_t whichModEncoder,
        ModelStackWithAutoParam* modelStack); // modelStack->autoParam will be NULL in this rare case!!
    virtual ActionResult modEncoderActionForNonExistentParam(int32_t offset, int32_t whichModEncoder,
                                                             ModelStackWithAutoParam* modelStack) {
        return ActionResult::NOT_DEALT_WITH;
    }
    virtual bool allowNoteTails(ModelStackWithSoundFlags* modelStack, bool disregardSampleLoop = false) { return true; }
    virtual void polyphonicExpressionEventOnChannelOrNote(int32_t newValue, int32_t expressionDimension,
                                                          int32_t channelOrNoteNumber,
                                                          MIDICharacteristic whichCharacteristic) {}
    virtual void monophonicExpressionEvent(int32_t newValue, int32_t expressionDimension) {}
 
protected:
    deluge::modulation::params::Kind unpatchedParamKind_;
};