patch_cable.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 "modulation/automation/auto_param.h"
#include "modulation/params/param_descriptor.h"
#include "util/fixedpoint.h"
#include <cstdint>
 
class Sound;
class ParamManagerForTimeline;
class InstrumentClip;
 
class PatchCable {
public:
    PatchCable() = default;
    void setup(PatchSource newFrom, uint8_t newTo, int32_t newAmount);
    bool isActive();
    void initAmount(int32_t value);
    void makeUnusable();
 
    [[gnu::always_inline]] [[nodiscard]] int32_t applyRangeAdjustment(int32_t value) const {
        int32_t small = multiply_32x32_rshift32(value, *this->rangeAdjustmentPointer);
        return signed_saturate<32 - 5>(small) << 3; // Not sure if these limits are as wide as they could be...
    }
 
    PatchSource from;
    ParamDescriptor destinationParamDescriptor;
    AutoParam param; // Amounts have to be within +1073741824 and -1073741824
    int32_t const* rangeAdjustmentPointer = nullptr;
};