SynthLab::KSOscillator Class Reference
Physical modeling oscillator fearuring Karplus-Strong plucked string algorithm. More...
#include <ksoscillator.h>
Inheritance diagram for SynthLab::KSOscillator:
Public Member Functions | |
| KSOscillator (std::shared_ptr< MidiInputData > _midiInputData, std::shared_ptr< KSOscParameters > _parameters, uint32_t blockSize=32) | |
| virtual bool | reset (double _sampleRate) |
| virtual bool | update () |
| virtual bool | render (uint32_t samplesToProcess=1) |
| virtual bool | doNoteOn (MIDINoteEvent ¬eEvent) |
| virtual bool | doNoteOff (MIDINoteEvent ¬eEvent) |
 Public Member Functions inherited from SynthLab::SynthModule | |
| SynthModule (std::shared_ptr< MidiInputData > _midiInputData) | |
| Constructs a SynthModule. More... | |
| virtual | ~SynthModule () |
| Removes cores, if any. | |
| virtual bool | initialize (const char *_dllDirectory) |
| virtual int32_t | getState () |
| virtual bool | shutdown () |
| virtual bool | startGlideModulation (GlideInfo &glideInfo) |
| starts the built-in glide modulator More... | |
| std::shared_ptr< Modulators > | getModulationInput () |
| std::shared_ptr< Modulators > | getModulationOutput () |
| std::shared_ptr< AudioBuffer > | getAudioBuffers () |
| void | setUnisonMode (double _unisonDetuneCents, double _unisonStarPhase) |
| void | setFMBuffer (std::shared_ptr< AudioBuffer > pmBuffer) |
| void | clearFMBuffer () |
| virtual bool | getModuleStrings (std::vector< std::string > &moduleStrings, std::string ignoreStr="") |
| Gets a std::vector of Module Strings. More... | |
| virtual bool | getModuleStrings (uint32_t coreIndex, std::vector< std::string > &moduleStrings, std::string ignoreStr) |
| Gets a std::vector of Module Strings from a particular core. More... | |
| virtual bool | getAllModuleStrings (std::vector< std::string > &moduleStrings, std::string ignoreStr) |
| Gets a std::vector of all Module Strings concatenated from all cores in succession. More... | |
| virtual bool | getModKnobStrings (std::vector< std::string > &modKnobStrings) |
| Gets a std::vector of Mod Knob label strings for the selected core. More... | |
| virtual bool | getModKnobStrings (uint32_t coreIndex, std::vector< std::string > &modKnobStrings) |
| Gets a std::vector of Mod Knob label strings for a given core; if the core cannot be found returs the mod knob labels of the module itself. More... | |
| virtual bool | getModuleCoreStrings (std::vector< std::string > &moduleCoreStrings) |
| Gets a std::vector of the names of the four cores in this module. More... | |
| virtual bool | addModuleCore (std::shared_ptr< ModuleCore > core) |
| adds a module core to the module's set of four More... | |
| virtual uint32_t | getSelectedCoreIndex () |
| get the index of the selected core More... | |
| virtual bool | selectModuleCore (uint32_t index) |
| Select a core. More... | |
| virtual bool | selectDefaultModuleCore () |
| Select the default core, which is always the first in the list. More... | |
| virtual void | packCores () |
| packs the cores into non-null ordering | |
| virtual bool | clearModuleCores () |
| Clears out the module core pointer list. More... | |
| virtual void | setStandAloneMode (bool b) |
| Sets the stand-alone mode flag on all cores. More... | |
Protected Attributes | |
| std::shared_ptr< KSOscParameters > | parameters = nullptr |
| Protected Attributes inherited from SynthLab::SynthModule | |
| std::shared_ptr< Modulators > | modulationInput = std::make_shared<Modulators>() |
| std::shared_ptr< Modulators > | modulationOutput = std::make_shared<Modulators>() |
| std::shared_ptr< MidiInputData > | midiInputData = nullptr |
| std::shared_ptr< AudioBuffer > | audioBuffers = nullptr |
| std::unique_ptr< GlideModulator > | glideModulator |
| std::shared_ptr< AudioBuffer > | fmBuffer = nullptr |
| std::shared_ptr< ModuleCore > | moduleCores [NUM_MODULE_CORES] |
| std::shared_ptr< ModuleCore > | selectedCore = nullptr |
| ModuleCoreData | moduleData |
| modulestrings (16) and mod knob labels (4) More... | |
| double | unisonDetuneCents = 0.0 |
| double | unisonStartPhase = 0.0 |
| bool | standAloneMode = false |
| CoreProcData | coreProcessData |
| std::string | dllDirectory |
Detailed Description
Physical modeling oscillator fearuring Karplus-Strong plucked string algorithm.
- loads and supports up to NUM_MODULE_CORES (4) cores
- it is mainly a wrapper/container for the module cores that do the acutal processing/rendering.
The cores include (zero-indexed): 0. KSOCore the single KS algorithm core for this module
- — EMPTY —
- — EMPTY —
- — EMPTY —
Base Class: SynthModule
- Overrides the five (5) common functions plus a special getParameters() method to return a shared pointer to the parameters structure.
Databases: None
GUI Parameters: KSOscParameters
- getParameters() function allows direct access to std::shared_ptr<KSOscParameters>
std::shared_ptr<KSOscParameters> getParameters()
- call the getParameters() function
- set the parameters in the PCMOscParameters structure with new values, typically from a GUI
To apply these new parameters either:
- (a) call the module's update() function OR
- (b) call the render() function which in turn calls the update() method.
Ordinarily, this operation happens just prior to calling the render() function so that is the preferred method of operation to avoid multiple calls to the update() function, which is usually the most CPU intensive function of the SynthModule.
Access to Modulators
- std::shared_ptr<Modulators> getModulationInput()
- std::shared_ptr<Modulators> getModulationOutput()
Access to audio buffers (I/O)
- std::shared_ptr<AudioBuffer> getAudioBuffers()
Reads:
- Modulation Input values (modulators)
Writes:
- AudioBuffer Output samples
Construction:
(1) For use within a synth project, the constructor is specialized to use shared recources for:
The owning object (SynthVoice for the SynthLab projects) must pass these valid pointers to the object at construction time. Typically the engine or voice will be the primary synthesizers of these resources. See the 2nd Edition Synth Book for more information.
(2) Standalone:
To use in standalone mode, call the constructor with the shared resoure pointers as null:
KSscillator(nullptr, nullptr, 64);
In standalone mode, the object creates and maintains these resources:
- MidiInputData: this has no read access so you cannot access its data. Ordinarily, you pass this shared pointer into the object so that it has access to the current MIDI input data. The object does not write data into this resource, so it is functionally non-opeational.
- KSOscParameters: in standalone mode only, these are synthesized locally on the object, and then the owning object may obtain a shared pointer to them to read/write the parameters directly.
Render:
- renders into its own AudioBuffers object; see SynthModule::getAudioBuffers()
- renders stereo by default; for mono samples, the output is dual-mono.
- Remarks
- This object is included and described in further detail in Designing Software Synthesizer Plugins in C++ 2nd Ed. by Will Pirkle
- Version
- Revision : 1.0
- Date
- Date : 2021 / 04 / 26
Member Function Documentation
◆ reset()
|
virtual |
abstract base class functions: see synth book for details
Implements SynthLab::SynthModule.
The documentation for this class was generated from the following files:
- C:/RackAFX Projects/SynthLab_SDK/source/ksoscillator.h
- C:/RackAFX Projects/SynthLab_SDK/source/ksoscillator.cpp
