linuxsampler 2.3.1
LinuxSampler::Engine Class Referenceabstract

LinuxSampler Sampler Engine Interface. More...

#include <Engine.h>

Public Member Functions

virtual int RenderAudio (uint Samples)=0
 
virtual void SendSysex (void *pData, uint Size, MidiInputPort *pSender)=0
 
virtual void Reset ()=0
 
virtual void Enable ()=0
 
virtual void Disable ()=0
 
virtual uint VoiceCount ()=0
 
virtual uint VoiceCountMax ()=0
 
virtual int MaxVoices ()=0
 
virtual void SetMaxVoices (int iVoices) throw (Exception) =0
 
virtual bool DiskStreamSupported ()=0
 
virtual uint DiskStreamCount ()=0
 
virtual uint DiskStreamCountMax ()=0
 
virtual int MaxDiskStreams ()=0
 
virtual void SetMaxDiskStreams (int iStreams) throw (Exception) =0
 
virtual String DiskStreamBufferFillBytes ()=0
 
virtual String DiskStreamBufferFillPercentage ()=0
 
virtual String Description ()=0
 
virtual String Version ()=0
 
virtual String EngineName ()=0
 
virtual InstrumentManagerGetInstrumentManager ()=0
 Returns pointer to the Engine's InstrumentManager or NULL if the Engine does not provide an InstrumentManager.
 
virtual void ReconnectAudioOutputDevice ()=0
 Will be called by audio output drivers in case some fundamental audio driver parameter like sample rate or max.
 
virtual void AdjustScaleTuning (const int8_t ScaleTunes[12])=0
 Modifies the scale tuning from standard well tempered chromatic scaling to any other kind of scaling.
 
virtual void GetScaleTuning (int8_t *pScaleTunes)=0
 Expects a byte array with 12 elements as argument pScaleTunes, where the currently effectve scale tuning setup is written to.
 
virtual void ResetScaleTuning ()=0
 Reset to standard well tempered chromatic scaling, i.e.
 

Protected Member Functions

virtual ~Engine ()
 
void Unregister ()
 

Friends

class EngineFactory
 

Detailed Description

LinuxSampler Sampler Engine Interface.

Abstract base interface class for all LinuxSampler engines which defines all mandatory methods which have to be implemented by all sampler engine implementations.

Definition at line 41 of file Engine.h.

Constructor & Destructor Documentation

◆ ~Engine()

virtual LinuxSampler::Engine::~Engine ( )
inlineprotectedvirtual

Definition at line 112 of file Engine.h.

Member Function Documentation

◆ AdjustScaleTuning()

virtual void LinuxSampler::Engine::AdjustScaleTuning ( const int8_t  ScaleTunes[12])
pure virtual

Modifies the scale tuning from standard well tempered chromatic scaling to any other kind of scaling.

ScaleTunes - detune factors (-64..+63 cents) for all 12 semitones of an octave

◆ Description()

virtual String LinuxSampler::Engine::Description ( )
pure virtual

◆ Disable()

virtual void LinuxSampler::Engine::Disable ( )
pure virtual

◆ DiskStreamBufferFillBytes()

virtual String LinuxSampler::Engine::DiskStreamBufferFillBytes ( )
pure virtual

◆ DiskStreamBufferFillPercentage()

virtual String LinuxSampler::Engine::DiskStreamBufferFillPercentage ( )
pure virtual

◆ DiskStreamCount()

virtual uint LinuxSampler::Engine::DiskStreamCount ( )
pure virtual

◆ DiskStreamCountMax()

virtual uint LinuxSampler::Engine::DiskStreamCountMax ( )
pure virtual

◆ DiskStreamSupported()

virtual bool LinuxSampler::Engine::DiskStreamSupported ( )
pure virtual

◆ Enable()

virtual void LinuxSampler::Engine::Enable ( )
pure virtual

◆ EngineName()

virtual String LinuxSampler::Engine::EngineName ( )
pure virtual

◆ GetInstrumentManager()

virtual InstrumentManager * LinuxSampler::Engine::GetInstrumentManager ( )
pure virtual

Returns pointer to the Engine's InstrumentManager or NULL if the Engine does not provide an InstrumentManager.

Important: All engine instances of the same engine type have to return the same InstrumentManager, that is all instances of the same engine type have to share one and the same InstrumentManager object.

◆ GetScaleTuning()

virtual void LinuxSampler::Engine::GetScaleTuning ( int8_t pScaleTunes)
pure virtual

Expects a byte array with 12 elements as argument pScaleTunes, where the currently effectve scale tuning setup is written to.

pScaleTunes - output: detune factors (-64..+63 cents) for all 12 semitones of an octave

◆ MaxDiskStreams()

virtual int LinuxSampler::Engine::MaxDiskStreams ( )
pure virtual

◆ MaxVoices()

virtual int LinuxSampler::Engine::MaxVoices ( )
pure virtual

◆ ReconnectAudioOutputDevice()

virtual void LinuxSampler::Engine::ReconnectAudioOutputDevice ( )
pure virtual

Will be called by audio output drivers in case some fundamental audio driver parameter like sample rate or max.

samples per cycle changed.

◆ RenderAudio()

virtual int LinuxSampler::Engine::RenderAudio ( uint  Samples)
pure virtual

◆ Reset()

virtual void LinuxSampler::Engine::Reset ( )
pure virtual

◆ ResetScaleTuning()

virtual void LinuxSampler::Engine::ResetScaleTuning ( )
pure virtual

Reset to standard well tempered chromatic scaling, i.e.

after being altered with AdjustScaleTuning() or after having sent the respective standard scale tuning SysEx MIDI message.

◆ SendSysex()

virtual void LinuxSampler::Engine::SendSysex ( void pData,
uint  Size,
MidiInputPort pSender 
)
pure virtual

◆ SetMaxDiskStreams()

virtual void LinuxSampler::Engine::SetMaxDiskStreams ( int  iStreams)
throw (Exception
)
pure virtual

◆ SetMaxVoices()

virtual void LinuxSampler::Engine::SetMaxVoices ( int  iVoices)
throw (Exception
)
pure virtual

◆ Unregister()

void LinuxSampler::Engine::Unregister ( )
protected

◆ Version()

virtual String LinuxSampler::Engine::Version ( )
pure virtual

◆ VoiceCount()

virtual uint LinuxSampler::Engine::VoiceCount ( )
pure virtual

◆ VoiceCountMax()

virtual uint LinuxSampler::Engine::VoiceCountMax ( )
pure virtual

Friends And Related Symbol Documentation

◆ EngineFactory

friend class EngineFactory
friend

Definition at line 114 of file Engine.h.


The documentation for this class was generated from the following file: