sound_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 "model/drum/drum.h"
#include "modulation/arpeggiator.h"
#include "processing/sound/sound.h"
#include "util/d_string.h"
 
class ModelStackWithTimelineCounter;
 
class SoundDrum final : public Sound, public Drum {
public:
    String path;
    bool nameIsDiscardable = false;
 
    SoundDrum() : Drum(DrumType::SOUND) {}
 
    using Sound::allowNoteTails;
    using Sound::anyNoteIsOn;
    using Sound::hasActiveVoices;
    using Sound::prepareForHibernation;
    void killAllVoices() override;
 
    bool isDrum() override { return true; }
    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) override;
    void noteOff(ModelStackWithThreeMainThings* modelStack, int32_t velocity = kDefaultLiftValue) override;
 
    void setupPatchingForAllParamManagers(Song* song) override;
    bool readTagFromFile(Deserializer& reader, char const* tagName) override;
    Error loadAllSamples(bool mayActuallyReadFiles) override;
    void writeToFile(Serializer& writer, bool savingSong, ParamManager* paramManager) override;
    void writeToFileAsInstrument(bool savingSong, ParamManager* paramManager);
    std::string getDrumName() override;
    Error readFromFile(Deserializer& reader, Song* song, Clip* clip, int32_t readAutomationUpToPos) override;
    void choke(ModelStackWithSoundFlags* modelStack) override;
    void setSkippingRendering(bool newSkipping) override;
    uint8_t* getModKnobMode() override;
    void drumWontBeRenderedForAWhile() override;
    ModControllable* toModControllable() override { return this; }
 
    void expressionEvent(int32_t newValue, int32_t expressionDimension) override;
    void polyphonicExpressionEventOnChannelOrNote(int32_t newValue, int32_t expressionDimension,
                                                  int32_t channelOrNoteNumber,
                                                  MIDICharacteristic whichCharacteristic) override;
 
    ArpeggiatorBase* getArp() override { return &arpeggiator; }
    ArpeggiatorSettings* getArpSettings(InstrumentClip* clip = nullptr) override { return &arpSettings; }
    void resetTimeEnteredState();
    const char* getName() override { return drumName.c_str(); }
};