drum.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 "definitions_cxx.hpp"
#include "io/midi/learned_midi.h"
#include "model/voiced.h"
#include "modulation/arpeggiator.h"
#include <cstdint>
 
class Clip;
class Kit;
class ModControllable;
class ModelStackWithSoundFlags;
class ModelStackWithThreeMainThings;
class ModelStackWithTimelineCounter;
class ParamManager;
class ParamManagerForTimeline;
class Song;
 
/*
 * Kits are made up of multiple Drums. Even when they are not drum sounds, the class is called Drum, for better or
 * worse. In most instructional material for users, Synthstrom has referred to them often as “items within kits”, or
 * sometimes “rows” or “sounds” where applicable.
 *
 * Types of Drum are MIDIDrum, GateDrum, and SoundDrum (most often a sample).
 */
 
class Drum : public virtual Voiced {
public:
    Drum(DrumType newType);
    ~Drum() override = default;
 
    Kit* kit;
 
    const DrumType type;
    bool noteRowAssignedTemp;
    uint8_t earlyNoteVelocity; // If 0, then there's none
    bool earlyNoteStillActive;
 
    bool auditioned;
    uint8_t lastMIDIChannelAuditioned; // Primarily for MPE purposes
 
    int8_t lastExpressionInputsReceived[2][kNumExpressionDimensions];
 
    Drum* next;
 
    LearnedMIDI midiInput;
    LearnedMIDI muteMIDICommand;
 
    ArpeggiatorForDrum arpeggiator;
    ArpeggiatorSettings arpSettings;
 
    virtual void noteOn(ModelStackWithThreeMainThings* modelStack, uint8_t velocity, int16_t const* mpeValues,
                        int32_t fromMIDIChannel = MIDI_CHANNEL_NONE, uint32_t sampleSyncLength = 0,
                        int32_t ticksLate = 0, uint32_t samplesLate = 0) = 0;
    virtual void noteOff(ModelStackWithThreeMainThings* modelStack, int32_t velocity = kDefaultLiftValue) = 0;
 
    virtual Error loadAllSamples(bool mayActuallyReadFiles) { return Error::NONE; }
    virtual void prepareDrumToHaveNoActiveClip() {}
 
    virtual void writeToFile(Serializer& writer, bool savingSong, ParamManager* paramManager) = 0;
    virtual Error readFromFile(Deserializer& reader, Song* song, Clip* clip, int32_t readAutomationUpToPos) = 0;
    virtual void drumWontBeRenderedForAWhile();
 
    virtual void getName(char* buffer) = 0; // May return up to 5 actual characters, so supply at least a char[6]
    virtual void choke(ModelStackWithSoundFlags* modelStack) {} // modelStack can be NULL if you really insist
    void writeMIDICommandsToFile(Serializer& writer);
    bool readDrumTagFromFile(Deserializer& reader, char const* tagName);
    void recordNoteOnEarly(int32_t velocity, bool noteTailsAllowed);
    void expressionEventPossiblyToRecord(ModelStackWithTimelineCounter* modelStack, int16_t newValue,
                                         int32_t expressionDimension, int32_t level);
    virtual void expressionEvent(int32_t newValue, int32_t expressionDimension) {}
    void getCombinedExpressionInputs(int16_t* combined);
 
    virtual ModControllable* toModControllable() { return nullptr; }
};