tracktion::engine::MidiInputDevice Class Reference

#include <tracktion_MidiInputDevice.h>

Inheritance diagram for tracktion::engine::MidiInputDevice:

Classes
struct	MidiKeyChangeDispatcher
	Gets notified (lazily, not in real-time) when any MidiInputDevice's key's state changes. More...
struct	NoteFilterRange

Public Types
enum class	MergeMode { always , never , optional }
Public Types inherited from tracktion::engine::InputDevice
enum	DeviceType {   waveDevice , trackWaveDevice , physicalMidiDevice , virtualMidiDevice ,   trackMidiDevice }
	enum to allow quick querying of the device type. More...
enum class	MonitorMode { off , automatic , on }
	Enum to describe monitor modes. More...
Public Types inherited from tracktion::engine::Selectable
using	WeakRef = juce::WeakReference< Selectable >

Public Member Functions
	MidiInputDevice (Engine &, juce::String type, juce::String name, juce::String deviceID)
	~MidiInputDevice () override
virtual juce::String	openDevice ()=0
virtual void	closeDevice ()=0
void	setEnabled (bool) override
bool	isMidi () const override
MidiChannel	getChannelToUse () const noexcept
void	setChannelToUse (int)
int	getProgramToUse () const noexcept
void	setProgramToUse (int)
void	setBankToUse (int)
int	getBankToUse () const
void	setChannelAllowed (int midiChannel, bool)
bool	isChannelAllowed (int midiChannel) const
void	setNoteFilterRange (NoteFilterRange)
NoteFilterRange	getNoteFilterRange () const
void	setOverridingNoteVelocities (bool)
bool	isOverridingNoteVelocities () const
void	setManualAdjustmentMs (double)
double	getManualAdjustmentMs () const
void	setMinimumLengthMs (double)
double	getMinimumLengthMs () const
bool	isMPEDevice () const
	Returns true if the given device is an MPE device and so should always record incoming MIDI to Note Expression.
void	masterTimeUpdate (double time) override
	This is a bit of a hack but allows the time for MIDI devices to be set through the base class interface.
void	connectionStateChanged ()
bool	handleIncomingMessage (juce::MidiMessage &)
	Updates the timestamp of the message and handles sending it out to listeners.
void	addInstance (MidiInputDeviceInstanceBase *)
void	removeInstance (MidiInputDeviceInstanceBase *)
virtual void	loadProps ()=0
Clip *	addMidiAsTransaction (Edit &, EditItemID targetID, Clip *takeClip, juce::MidiMessageSequence, TimeRange markedRange, MergeMode, MidiChannel)
void	handleIncomingMidiMessage (juce::MidiInput *, const juce::MidiMessage &) override
virtual void	handleIncomingMidiMessage (const juce::MidiMessage &, MPESourceID)=0
RetrospectiveMidiBuffer *	getRetrospectiveMidiBuffer () const
void	updateRetrospectiveBufferLength (double length) override
double	getAdjustSecs () const
juce::Array< AudioTrack * >	getDestinationTracks ()
MidiChannel	getMidiChannelFor (int rawChannelNumber) const
MPESourceID	getMPESourceID () const
Public Member Functions inherited from tracktion::engine::InputDevice
	InputDevice (Engine &, juce::String type, juce::String name, juce::String deviceID)
	~InputDevice () override
const juce::String &	getName () const
const juce::String &	getType () const
juce::String	getDeviceID () const
virtual DeviceType	getDeviceType () const =0
bool	isTrackDevice () const
juce::String	getAlias () const
	the alias is the name shown in the draggable input device components
void	setAlias (const juce::String &newAlias)
virtual bool	isAvailableToEdit () const
bool	isEnabled () const
MonitorMode	getMonitorMode () const
void	setMonitorMode (MonitorMode)
virtual InputDeviceInstance *	createInstance (EditPlaybackContext &)=0
	Creates an instance to use for a given playback context.
juce::String	getSelectableDescription () override
	Subclasses must return a description of what they are.
virtual void	saveProps ()=0
Public Member Functions inherited from tracktion::engine::Selectable
	Selectable ()
virtual	~Selectable ()
virtual void	selectionStatusChanged (bool isNowSelected)
	Can be overridden to tell this object that it has just been selected or deselected.
virtual void	changed ()
	This should be called to send a change notification to any SelectableListeners that are registered with this object.
virtual void	selectableAboutToBeDeleted ()
	Called just before the selectable is about to be deleted so any subclasses should still be valid at this point.
void	addListener (SelectableListener *)
void	removeListener (SelectableListener *)
void	addSelectableListener (SelectableListener *)
void	removeSelectableListener (SelectableListener *)
void	cancelAnyPendingUpdates ()
	If changed() has been called, this will cancel any pending async change notificaions.
void	deselect ()
void	propertiesChanged ()
void	notifyListenersOfDeletion ()
WeakRef	getWeakRef ()

Public Attributes
bool	mergeRecordings = true
bool	recordingEnabled = true
bool	replaceExistingClips = false
bool	recordToNoteAutomation = false
QuantisationType	quantisation
juce::MidiKeyboardState	keyboardState
Public Attributes inherited from tracktion::engine::InputDevice
Engine &	engine
LevelMeasurer	levelMeasurer
Public Attributes inherited from tracktion::engine::Selectable
WeakRef::Master	masterReference

Protected Member Functions
void	handleNoteOn (juce::MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void	handleNoteOff (juce::MidiKeyboardState *, int midiChannel, int midiNoteNumber, float velocity) override
void	timerCallback () override
void	sendNoteOnToMidiKeyListeners (juce::MidiMessage &)
void	loadMidiProps (const juce::XmlElement *)
void	saveMidiProps (juce::XmlElement &)
void	sendMessageToInstances (const juce::MidiMessage &, MPESourceID)

Protected Attributes
std::atomic< double >	adjustSecs { 0 }
double	manualAdjustMs = 0
double	minimumLengthMs = 0
bool	overrideNoteVels = false
bool	eventReceivedFromDevice = false
juce::BigInteger	disallowedChannels
MidiChannel	channelToUse
int	programToUse = 0
int	bankToUse = 0
NoteFilterRange	noteFilterRange
MPESourceID	midiSourceID = createUniqueMPESourceID()
std::unique_ptr< NoteDispatcher >	noteDispatcher
std::vector< double >	lastNoteOns
juce::CriticalSection	noteLock
bool	keysDown [128]
bool	keysUp [128]
uint8_t	keyDownVelocities [128]
juce::SharedResourcePointer< MidiKeyChangeDispatcher >	midiKeyChangeDispatcher
juce::CriticalSection	instanceLock
juce::Array< MidiInputDeviceInstanceBase * >	instances
std::unique_ptr< RetrospectiveMidiBuffer >	retrospectiveBuffer
Protected Attributes inherited from tracktion::engine::InputDevice
std::atomic< bool >	enabled { false }
MonitorMode	monitorMode = MonitorMode::automatic
MonitorMode	defaultMonitorMode = MonitorMode::automatic
bool	retrospectiveRecordLock = false

Additional Inherited Members
Static Public Member Functions inherited from tracktion::engine::InputDevice
static void	setRetrospectiveLock (Engine &, const juce::Array< InputDeviceInstance * > &, bool lock)
Static Public Member Functions inherited from tracktion::engine::Selectable
static void	initialise ()
static bool	isSelectableValid (const Selectable *) noexcept
	checks whether this object has been deleted.

Member Enumeration Documentation

MergeMode

enum class tracktion::engine::MidiInputDevice::MergeMode

strong

Enumerator
always
never
optional

Constructor & Destructor Documentation

MidiInputDevice()

tracktion::engine::MidiInputDevice::MidiInputDevice	(	Engine &	,
		juce::String	type,
		juce::String	name,
		juce::String	deviceID
	)

~MidiInputDevice()

tracktion::engine::MidiInputDevice::~MidiInputDevice ( )

override

Member Function Documentation

openDevice()

virtual juce::String tracktion::engine::MidiInputDevice::openDevice ( )

pure virtual

Implemented in tracktion::engine::PhysicalMidiInputDevice.

closeDevice()

virtual void tracktion::engine::MidiInputDevice::closeDevice ( )

pure virtual

Implemented in tracktion::engine::PhysicalMidiInputDevice.

setEnabled()

void tracktion::engine::MidiInputDevice::setEnabled ( bool  )

overridevirtual

Implements tracktion::engine::InputDevice.

Reimplemented in tracktion::engine::VirtualMidiInputDevice.

isMidi()

bool tracktion::engine::MidiInputDevice::isMidi ( ) const

overridevirtual

Reimplemented from tracktion::engine::InputDevice.

getChannelToUse()

MidiChannel tracktion::engine::MidiInputDevice::getChannelToUse ( ) const

noexcept

References channelToUse.

setChannelToUse()

void tracktion::engine::MidiInputDevice::setChannelToUse

(

int

)

getProgramToUse()

int tracktion::engine::MidiInputDevice::getProgramToUse ( ) const

noexcept

References programToUse.

setProgramToUse()

void tracktion::engine::MidiInputDevice::setProgramToUse

(

int

)

setBankToUse()

void tracktion::engine::MidiInputDevice::setBankToUse

(

int

)

getBankToUse()

int tracktion::engine::MidiInputDevice::getBankToUse

(

)

const

References bankToUse.

setChannelAllowed()

void tracktion::engine::MidiInputDevice::setChannelAllowed	(	int	midiChannel,
		bool
	)

isChannelAllowed()

bool tracktion::engine::MidiInputDevice::isChannelAllowed

(

int

midiChannel

)

const

References disallowedChannels.

setNoteFilterRange()

void tracktion::engine::MidiInputDevice::setNoteFilterRange

(

NoteFilterRange

)

getNoteFilterRange()

NoteFilterRange tracktion::engine::MidiInputDevice::getNoteFilterRange

(

)

const

References noteFilterRange.

setOverridingNoteVelocities()

void tracktion::engine::MidiInputDevice::setOverridingNoteVelocities

(

bool

)

isOverridingNoteVelocities()

bool tracktion::engine::MidiInputDevice::isOverridingNoteVelocities

(

)

const

References overrideNoteVels.

setManualAdjustmentMs()

void tracktion::engine::MidiInputDevice::setManualAdjustmentMs

(

double

)

getManualAdjustmentMs()

double tracktion::engine::MidiInputDevice::getManualAdjustmentMs

(

)

const

References manualAdjustMs.

setMinimumLengthMs()

void tracktion::engine::MidiInputDevice::setMinimumLengthMs

(

double

)

getMinimumLengthMs()

double tracktion::engine::MidiInputDevice::getMinimumLengthMs

(

)

const

References minimumLengthMs.

isMPEDevice()

bool tracktion::engine::MidiInputDevice::isMPEDevice

(

)

const

Returns true if the given device is an MPE device and so should always record incoming MIDI to Note Expression.

masterTimeUpdate()

void tracktion::engine::MidiInputDevice::masterTimeUpdate ( double  time )

overridevirtual

This is a bit of a hack but allows the time for MIDI devices to be set through the base class interface.

Implements tracktion::engine::InputDevice.

connectionStateChanged()

void tracktion::engine::MidiInputDevice::connectionStateChanged

(

)

handleIncomingMessage()

bool tracktion::engine::MidiInputDevice::handleIncomingMessage

(

juce::MidiMessage &

)

Updates the timestamp of the message and handles sending it out to listeners.

false if the given message has been filtered out by channel or number.

addInstance()

void tracktion::engine::MidiInputDevice::addInstance

(

MidiInputDeviceInstanceBase *

)

removeInstance()

void tracktion::engine::MidiInputDevice::removeInstance

(

MidiInputDeviceInstanceBase *

)

loadProps()

virtual void tracktion::engine::MidiInputDevice::loadProps ( )

pure virtual

Implemented in tracktion::engine::PhysicalMidiInputDevice, and tracktion::engine::VirtualMidiInputDevice.

addMidiAsTransaction()

Clip * tracktion::engine::MidiInputDevice::addMidiAsTransaction	(	Edit &	,
		EditItemID	targetID,
		Clip *	takeClip,
		juce::MidiMessageSequence	,
		TimeRange	markedRange,
		MergeMode	,
		MidiChannel
	)

handleIncomingMidiMessage() [1/2]

void tracktion::engine::MidiInputDevice::handleIncomingMidiMessage ( juce::MidiInput *  , const juce::MidiMessage &    )

override

handleIncomingMidiMessage() [2/2]

virtual void tracktion::engine::MidiInputDevice::handleIncomingMidiMessage ( const juce::MidiMessage &  , MPESourceID    )

pure virtual

Implemented in tracktion::engine::PhysicalMidiInputDevice, tracktion::engine::VirtualMidiInputDevice, tracktion::engine::PhysicalMidiInputDevice, and tracktion::engine::VirtualMidiInputDevice.

getRetrospectiveMidiBuffer()

RetrospectiveMidiBuffer * tracktion::engine::MidiInputDevice::getRetrospectiveMidiBuffer

(

)

const

References retrospectiveBuffer.

updateRetrospectiveBufferLength()

void tracktion::engine::MidiInputDevice::updateRetrospectiveBufferLength ( double  length )

overridevirtual

Implements tracktion::engine::InputDevice.

getAdjustSecs()

double tracktion::engine::MidiInputDevice::getAdjustSecs

(

)

const

References adjustSecs.

getDestinationTracks()

juce::Array< AudioTrack * > tracktion::engine::MidiInputDevice::getDestinationTracks

(

)

getMidiChannelFor()

MidiChannel tracktion::engine::MidiInputDevice::getMidiChannelFor

(

int

rawChannelNumber

)

const

getMPESourceID()

MPESourceID tracktion::engine::MidiInputDevice::getMPESourceID

(

)

const

References midiSourceID.

handleNoteOn()

void tracktion::engine::MidiInputDevice::handleNoteOn ( juce::MidiKeyboardState *  , int  midiChannel, int  midiNoteNumber, float  velocity  )

overrideprotected

handleNoteOff()

void tracktion::engine::MidiInputDevice::handleNoteOff ( juce::MidiKeyboardState *  , int  midiChannel, int  midiNoteNumber, float  velocity  )

overrideprotected

timerCallback()

void tracktion::engine::MidiInputDevice::timerCallback ( )

overrideprotected

sendNoteOnToMidiKeyListeners()

void tracktion::engine::MidiInputDevice::sendNoteOnToMidiKeyListeners ( juce::MidiMessage &  )

protected

loadMidiProps()

void tracktion::engine::MidiInputDevice::loadMidiProps ( const juce::XmlElement *  )

protected

saveMidiProps()

void tracktion::engine::MidiInputDevice::saveMidiProps ( juce::XmlElement &  )

protected

sendMessageToInstances()

void tracktion::engine::MidiInputDevice::sendMessageToInstances ( const juce::MidiMessage &  , MPESourceID    )

protected

Member Data Documentation

mergeRecordings

bool tracktion::engine::MidiInputDevice::mergeRecordings = true

recordingEnabled

bool tracktion::engine::MidiInputDevice::recordingEnabled = true

replaceExistingClips

bool tracktion::engine::MidiInputDevice::replaceExistingClips = false

recordToNoteAutomation

bool tracktion::engine::MidiInputDevice::recordToNoteAutomation = false

quantisation

QuantisationType tracktion::engine::MidiInputDevice::quantisation

keyboardState

juce::MidiKeyboardState tracktion::engine::MidiInputDevice::keyboardState

adjustSecs

std::atomic<double> tracktion::engine::MidiInputDevice::adjustSecs { 0 }

protected

Referenced by getAdjustSecs().

manualAdjustMs

double tracktion::engine::MidiInputDevice::manualAdjustMs = 0

protected

Referenced by getManualAdjustmentMs().

minimumLengthMs

double tracktion::engine::MidiInputDevice::minimumLengthMs = 0

protected

Referenced by getMinimumLengthMs().

overrideNoteVels

bool tracktion::engine::MidiInputDevice::overrideNoteVels = false

protected

Referenced by isOverridingNoteVelocities().

eventReceivedFromDevice

bool tracktion::engine::MidiInputDevice::eventReceivedFromDevice = false

protected

disallowedChannels

juce::BigInteger tracktion::engine::MidiInputDevice::disallowedChannels

protected

Referenced by isChannelAllowed().

channelToUse

MidiChannel tracktion::engine::MidiInputDevice::channelToUse

protected

Referenced by getChannelToUse().

programToUse

int tracktion::engine::MidiInputDevice::programToUse = 0

protected

Referenced by getProgramToUse().

bankToUse

int tracktion::engine::MidiInputDevice::bankToUse = 0

protected

Referenced by getBankToUse().

noteFilterRange

NoteFilterRange tracktion::engine::MidiInputDevice::noteFilterRange

protected

Referenced by getNoteFilterRange().

midiSourceID

MPESourceID tracktion::engine::MidiInputDevice::midiSourceID = createUniqueMPESourceID()

protected

Referenced by getMPESourceID().

noteDispatcher

std::unique_ptr<NoteDispatcher> tracktion::engine::MidiInputDevice::noteDispatcher

protected

lastNoteOns

std::vector<double> tracktion::engine::MidiInputDevice::lastNoteOns

protected

noteLock

juce::CriticalSection tracktion::engine::MidiInputDevice::noteLock

protected

keysDown

bool tracktion::engine::MidiInputDevice::keysDown[128]

protected

keysUp

bool tracktion::engine::MidiInputDevice::keysUp[128]

protected

keyDownVelocities

uint8_t tracktion::engine::MidiInputDevice::keyDownVelocities[128]

protected

midiKeyChangeDispatcher

juce::SharedResourcePointer<MidiKeyChangeDispatcher> tracktion::engine::MidiInputDevice::midiKeyChangeDispatcher

protected

instanceLock

juce::CriticalSection tracktion::engine::MidiInputDevice::instanceLock

protected

instances

juce::Array<MidiInputDeviceInstanceBase*> tracktion::engine::MidiInputDevice::instances

protected

retrospectiveBuffer

std::unique_ptr<RetrospectiveMidiBuffer> tracktion::engine::MidiInputDevice::retrospectiveBuffer

protected

Referenced by getRetrospectiveMidiBuffer().

---

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

• tracktion_MidiInputDevice.h