cyfaust 0.1.0__cp311-cp311-macosx_15_0_arm64.whl

cyfaust/resources/architecture/AU/AUPublic/AUInstrumentBase/SynthElement.h

@@ -0,0 +1,227 @@
+/*
+     File: SynthElement.h
+ Abstract: Part of CoreAudio Utility Classes
+  Version: 1.2
+ 
+ Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
+ Inc. ("Apple") in consideration of your agreement to the following
+ terms, and your use, installation, modification or redistribution of
+ this Apple software constitutes acceptance of these terms.  If you do
+ not agree with these terms, please do not use, install, modify or
+ redistribute this Apple software.
+ 
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc. may
+ be used to endorse or promote products derived from the Apple Software
+ without specific prior written permission from Apple.  Except as
+ expressly stated in this notice, no other rights or licenses, express or
+ implied, are granted by Apple herein, including but not limited to any
+ patent rights that may be infringed by your derivative works or by other
+ works in which the Apple Software may be incorporated.
+ 
+ The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+ 
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ 
+ Copyright (C) 2012 Apple Inc. All Rights Reserved.
+ 
+*/
+#ifndef __SynthElement__
+#define __SynthElement__
+
+#include <AudioUnit/AudioUnit.h>
+#include "MusicDeviceBase.h"
+#include "SynthNoteList.h"
+#include "MIDIControlHandler.h"
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+class AUInstrumentBase;
+
+class SynthElement : public AUElement
+{
+public:
+	SynthElement(AUInstrumentBase *audioUnit, UInt32 inElement);
+	virtual ~SynthElement();
+
+	UInt32 GetIndex() const { return mIndex; }
+	
+	AUInstrumentBase* GetAUInstrument() { return (AUInstrumentBase*)GetAudioUnit(); }
+	
+private:
+	UInt32 mIndex;
+};
+
+class MidiControls : public MIDIControlHandler
+{
+	enum { kMaxControls = 128 };
+public:
+	MidiControls();
+	virtual ~MidiControls() {}
+	virtual void	Reset();
+	virtual bool	SetProgramChange(UInt16	inProgram) { mProgramChange = inProgram; return true; }
+	virtual bool	SetPitchWheel(UInt16 inValue) {
+		mPitchBend = inValue;
+		mFPitchBend = (float)(((SInt16)mPitchBend - 8192) / 8192.);
+		return true;
+	}
+	virtual bool	SetChannelPressure(UInt8 inValue) { mMonoPressure = inValue; return true; }
+	virtual bool	SetPolyPressure(UInt8 inKey, UInt8 inValue) {
+		mPolyPressure[inKey] = inValue;
+		return true;
+	}
+	virtual bool	SetController(UInt8 inControllerNumber, UInt8 inValue) {
+		if (inControllerNumber < kMaxControls) {
+			mControls[inControllerNumber] = inValue;
+			return true;
+		}
+		return false;
+	}
+	virtual bool	SetSysex(void *inSysexMsg) { return false; }
+
+	virtual float GetPitchBend() const { return mFPitchBend * mFPitchBendDepth; }
+
+	SInt16 GetHiResControl(UInt32 inIndex) const 
+	{   
+		return ((mControls[inIndex] & 127) << 7) | (mControls[inIndex + 32] & 127);
+	}
+	
+	float GetControl(UInt32 inIndex) const
+	{
+		if (inIndex < 32) {
+			return (float)(mControls[inIndex] + (mControls[inIndex + 32] / 127.));
+		} else {
+			return (float)mControls[inIndex];
+		}
+	}
+	
+	
+private:
+	
+	UInt8 mControls[128];
+	UInt8 mPolyPressure[128];
+	UInt8 mMonoPressure;
+	UInt8 mProgramChange;
+	UInt16 mPitchBend;
+	UInt16 mActiveRPN;
+	UInt16 mActiveNRPN;
+	UInt16 mActiveRPValue;
+	UInt16 mActiveNRPValue;
+	
+	UInt16 mPitchBendDepth;
+	float mFPitchBendDepth;
+	float mFPitchBend;
+	
+	void SetHiResControl(UInt32 inIndex, UInt8 inMSB, UInt8 inLSB)
+		{ 
+			mControls[inIndex] = inMSB;
+			mControls[inIndex + 32] = inLSB;
+		}
+		
+};
+
+
+class SynthGroupElement : public SynthElement
+{
+public:
+	enum {
+		kUnassignedGroup = 0xFFFFFFFF
+	};
+	
+	SynthGroupElement(AUInstrumentBase *audioUnit, UInt32 inElement, MIDIControlHandler *inHandler);
+	virtual					~SynthGroupElement();
+
+	virtual void			NoteOn(SynthNote *note, SynthPartElement *part, NoteInstanceID inNoteID, UInt32 inOffsetSampleFrame, const MusicDeviceNoteParams &inParams);
+	virtual void			NoteOff(NoteInstanceID inNoteID, UInt32 inOffsetSampleFrame);
+	void						SustainOn(UInt32 inFrame);
+	void						SustainOff(UInt32 inFrame);
+	void						SostenutoOn(UInt32 inFrame);
+	void						SostenutoOff(UInt32 inFrame);
+
+	void						NoteEnded(SynthNote *inNote, UInt32 inFrame);
+	void						NoteFastReleased(SynthNote *inNote);
+	
+	virtual bool			ChannelMessage(UInt16 controlID, UInt16 controlValue);
+	void						AllNotesOff(UInt32 inFrame);
+	void						AllSoundOff(UInt32 inFrame);
+	void						ResetAllControllers(UInt32 inFrame);
+	
+	SynthNote *				GetNote(NoteInstanceID inNoteID, bool unreleasedOnly=false, UInt32 *outNoteState=NULL);
+	
+	void						Reset();
+	
+	virtual OSStatus		Render(SInt64 inAbsoluteSampleFrame, UInt32 inNumberFrames, AUScope &outputs);
+	
+	float						GetPitchBend() const { return mMidiControlHandler->GetPitchBend(); }
+	SInt64					GetCurrentAbsoluteFrame() const { return mCurrentAbsoluteFrame; }
+	
+	MusicDeviceGroupID	GroupID () const { return mGroupID; }
+	virtual void			SetGroupID (MusicDeviceGroupID inGroup);
+
+	MIDIControlHandler *	GetMIDIControlHandler() const { return mMidiControlHandler; }
+	
+protected:	
+	SInt64					mCurrentAbsoluteFrame;
+	SynthNoteList 			mNoteList[kNumberOfSoundingNoteStates];
+	MIDIControlHandler		*mMidiControlHandler;
+
+private:
+	friend class AUInstrumentBase;
+	friend class AUMonotimbralInstrumentBase;
+	friend class AUMultitimbralInstrumentBase;
+	
+	bool					mSustainIsOn;
+	bool					mSostenutoIsOn;
+	UInt32					mOutputBus;
+	MusicDeviceGroupID		mGroupID;
+};
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+struct SynthKeyZone
+{
+	UInt8 mLoNote;
+	UInt8 mHiNote;
+	UInt8 mLoVelocity;
+	UInt8 mHiVelocity;
+};
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+const UInt32 kUnlimitedPolyphony = 0xFFFFFFFF;
+
+class SynthPartElement : public SynthElement
+{
+public:
+	SynthPartElement(AUInstrumentBase *audioUnit, UInt32 inElement);
+
+	UInt32		GetGroupIndex() const { return mGroupIndex; }
+	bool		InRange(Float32 inNote, Float32 inVelocity);
+	
+	UInt32		GetMaxPolyphony() const { return mMaxPolyphony; }
+	void		SetMaxPolyphony(UInt32 inMaxPolyphony) { mMaxPolyphony = inMaxPolyphony; }
+	
+private:
+	UInt32							mGroupIndex;
+	UInt32							mPatchIndex;
+	UInt32							mMaxPolyphony;
+	SynthKeyZone					mKeyZone;	
+};
+
+#endif

cyfaust/resources/architecture/AU/AUPublic/AUInstrumentBase/SynthEvent.h

@@ -0,0 +1,145 @@
+/*
+     File: SynthEvent.h
+ Abstract: Part of CoreAudio Utility Classes
+  Version: 1.2
+ 
+ Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
+ Inc. ("Apple") in consideration of your agreement to the following
+ terms, and your use, installation, modification or redistribution of
+ this Apple software constitutes acceptance of these terms.  If you do
+ not agree with these terms, please do not use, install, modify or
+ redistribute this Apple software.
+ 
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc. may
+ be used to endorse or promote products derived from the Apple Software
+ without specific prior written permission from Apple.  Except as
+ expressly stated in this notice, no other rights or licenses, express or
+ implied, are granted by Apple herein, including but not limited to any
+ patent rights that may be infringed by your derivative works or by other
+ works in which the Apple Software may be incorporated.
+ 
+ The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+ 
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ 
+ Copyright (C) 2012 Apple Inc. All Rights Reserved.
+ 
+*/
+/* You can either fill in code here or remove this and create or add new files. */
+
+#ifndef __SynthEvent__
+#define __SynthEvent__
+
+#include <AudioUnit/AudioUnit.h>
+#include <CoreAudio/CoreAudio.h>
+#include "MusicDeviceBase.h"
+#include <stdexcept>
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
+class SynthEvent
+{
+public:
+	enum {
+		kEventType_NoteOn = 1,
+		kEventType_NoteOff = 2,
+		kEventType_SustainOn = 3,
+		kEventType_SustainOff = 4,
+		kEventType_SostenutoOn = 5,
+		kEventType_SostenutoOff = 6,
+		kEventType_AllNotesOff = 7,
+		kEventType_AllSoundOff = 8,
+		kEventType_ResetAllControllers = 9
+	};
+
+
+	SynthEvent() {}
+	~SynthEvent() {}
+
+	void Set(   
+				UInt32							inEventType,
+				MusicDeviceGroupID				inGroupID,
+				NoteInstanceID					inNoteID,
+				UInt32							inOffsetSampleFrame,
+				const MusicDeviceNoteParams*	inNoteParams
+		)
+	{
+		mEventType = inEventType;
+		mGroupID = inGroupID;
+		mNoteID = inNoteID;
+		mOffsetSampleFrame = inOffsetSampleFrame;
+		
+		if (inNoteParams)
+		{
+			UInt32 paramSize = offsetof(MusicDeviceNoteParams, mControls) + (inNoteParams->argCount-2)*sizeof(NoteParamsControlValue); 
+			mNoteParams = inNoteParams->argCount > 3 
+								? (MusicDeviceNoteParams*)malloc(paramSize) 
+								: &mSmallNoteParams;
+			memcpy(mNoteParams, inNoteParams, paramSize);
+		}
+		else 
+			mNoteParams = NULL;
+	}
+	
+	
+	void Free()
+	{
+		if (mNoteParams)
+		{
+			if (mNoteParams->argCount > 3)
+				free(mNoteParams);
+			mNoteParams = NULL;
+		}
+	}
+	
+	UInt32					GetEventType() const { return mEventType; }
+	MusicDeviceGroupID		GetGroupID() const { return mGroupID; }
+	NoteInstanceID			GetNoteID() const { return mNoteID; }
+	UInt32					GetOffsetSampleFrame() const { return mOffsetSampleFrame; }
+	
+	MusicDeviceNoteParams*  GetParams() const { return mNoteParams; }
+
+	UInt32					GetArgCount() const { return mNoteParams->argCount; }
+	UInt32					NumberParameters() const { return mNoteParams->argCount - 2; }
+	
+	Float32					GetNote() const { return mNoteParams->mPitch; }
+	Float32					GetVelocity() const { return mNoteParams->mVelocity; }
+	
+	NoteParamsControlValue  GetParameter(UInt32 inIndex) const 
+							{
+								if (inIndex >= NumberParameters()) 
+									throw std::runtime_error("index out of range");
+								return mNoteParams->mControls[inIndex]; 
+							}
+	
+private:
+	UInt32					mEventType;
+	MusicDeviceGroupID		mGroupID;
+	NoteInstanceID			mNoteID;
+	UInt32					mOffsetSampleFrame;
+	MusicDeviceNoteParams*  mNoteParams;
+	MusicDeviceNoteParams   mSmallNoteParams; // inline a small one to eliminate malloc for the simple case.
+};
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////
+#endif

cyfaust/resources/architecture/AU/AUPublic/AUInstrumentBase/SynthNote.cpp

@@ -0,0 +1,138 @@
+/*
+     File: SynthNote.cpp
+ Abstract: SynthNote.h
+  Version: 1.2
+ 
+ Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
+ Inc. ("Apple") in consideration of your agreement to the following
+ terms, and your use, installation, modification or redistribution of
+ this Apple software constitutes acceptance of these terms.  If you do
+ not agree with these terms, please do not use, install, modify or
+ redistribute this Apple software.
+ 
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc. may
+ be used to endorse or promote products derived from the Apple Software
+ without specific prior written permission from Apple.  Except as
+ expressly stated in this notice, no other rights or licenses, express or
+ implied, are granted by Apple herein, including but not limited to any
+ patent rights that may be infringed by your derivative works or by other
+ works in which the Apple Software may be incorporated.
+ 
+ The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+ 
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ 
+ Copyright (C) 2012 Apple Inc. All Rights Reserved.
+ 
+*/
+#include "SynthNote.h"
+#include "SynthElement.h"
+#include "AUInstrumentBase.h"
+
+bool SynthNote::AttackNote(
+			SynthPartElement *				inPart,
+			SynthGroupElement *				inGroup,
+			NoteInstanceID					inNoteID, 
+			UInt64							inAbsoluteSampleFrame, 
+			UInt32							inOffsetSampleFrame, 
+			const MusicDeviceNoteParams		&inParams)
+{
+#if DEBUG_PRINT
+	printf("SynthNote::AttackNote %lu %lu abs frame %llu rel frame %lu\n", (UInt32)inGroup->GroupID(), (UInt32)inNoteID, inAbsoluteSampleFrame, inOffsetSampleFrame);
+#endif
+	mPart = inPart;
+	mGroup = inGroup;
+	mNoteID = inNoteID;
+
+	mAbsoluteStartFrame = inAbsoluteSampleFrame;
+	mRelativeStartFrame = inOffsetSampleFrame;
+	mRelativeReleaseFrame = -1;
+	mRelativeKillFrame = -1;
+
+	mPitch = inParams.mPitch;
+	mVelocity = inParams.mVelocity;
+	
+	return Attack(inParams);
+}
+
+void SynthNote::Reset()
+{
+	mPart = 0;
+	mGroup = 0;
+	mAbsoluteStartFrame = 0;
+	mRelativeStartFrame = 0;
+	mRelativeReleaseFrame = 0;
+	mRelativeKillFrame = 0;
+}
+
+void SynthNote::Kill(UInt32 inFrame)
+{
+	mRelativeKillFrame = inFrame;
+}
+
+void SynthNote::Release(UInt32 inFrame)
+{
+	mRelativeReleaseFrame = inFrame;
+}
+
+void SynthNote::FastRelease(UInt32 inFrame)
+{
+	mRelativeReleaseFrame = inFrame;
+}
+
+double SynthNote::TuningA() const
+{
+	return 440.0;
+}
+
+double SynthNote::Frequency()
+{
+	return TuningA() * pow(2., (mPitch - 69. + GetPitchBend()) / 12.);
+}
+
+double SynthNote::SampleRate()
+{
+	return GetAudioUnit()->GetOutput(0)->GetStreamFormat().mSampleRate;
+}
+
+AUInstrumentBase* SynthNote::GetAudioUnit() const 
+{ 
+	return (AUInstrumentBase*)mGroup->GetAudioUnit(); 
+}
+
+Float32 SynthNote::GetGlobalParameter(AudioUnitParameterID inParamID) const 
+{
+	return mGroup->GetAudioUnit()->Globals()->GetParameter(inParamID);
+}
+
+void SynthNote::NoteEnded(UInt32 inFrame) 
+{ 
+	mGroup->NoteEnded(this, inFrame);
+	mNoteID = 0xFFFFFFFF; 
+}
+
+float SynthNote::GetPitchBend() const 
+{ 
+	return mGroup->GetPitchBend(); 
+}
+
+

cyfaust/resources/architecture/AU/AUPublic/AUInstrumentBase/SynthNote.h

@@ -0,0 +1,186 @@
+/*
+     File: SynthNote.h
+ Abstract: Part of CoreAudio Utility Classes
+  Version: 1.2
+ 
+ Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
+ Inc. ("Apple") in consideration of your agreement to the following
+ terms, and your use, installation, modification or redistribution of
+ this Apple software constitutes acceptance of these terms.  If you do
+ not agree with these terms, please do not use, install, modify or
+ redistribute this Apple software.
+ 
+ In consideration of your agreement to abide by the following terms, and
+ subject to these terms, Apple grants you a personal, non-exclusive
+ license, under Apple's copyrights in this original Apple software (the
+ "Apple Software"), to use, reproduce, modify and redistribute the Apple
+ Software, with or without modifications, in source and/or binary forms;
+ provided that if you redistribute the Apple Software in its entirety and
+ without modifications, you must retain this notice and the following
+ text and disclaimers in all such redistributions of the Apple Software.
+ Neither the name, trademarks, service marks or logos of Apple Inc. may
+ be used to endorse or promote products derived from the Apple Software
+ without specific prior written permission from Apple.  Except as
+ expressly stated in this notice, no other rights or licenses, express or
+ implied, are granted by Apple herein, including but not limited to any
+ patent rights that may be infringed by your derivative works or by other
+ works in which the Apple Software may be incorporated.
+ 
+ The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
+ MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
+ THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
+ FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
+ OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
+ 
+ IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
+ OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
+ MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
+ AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
+ STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
+ POSSIBILITY OF SUCH DAMAGE.
+ 
+ Copyright (C) 2012 Apple Inc. All Rights Reserved.
+ 
+*/
+#ifndef __SynthNote__
+#define __SynthNote__
+
+#include <AudioUnit/AudioUnit.h>
+#include <CoreAudio/CoreAudio.h>
+#include "MusicDeviceBase.h"
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+enum SynthNoteState {
+	kNoteState_Attacked = 0,
+	kNoteState_Sostenutoed = 1,
+	kNoteState_ReleasedButSostenutoed = 2,
+	kNoteState_ReleasedButSustained = 3,
+	kNoteState_Released = 4,
+	kNoteState_FastReleased = 5,
+	kNoteState_Free = 6,
+	kNumberOfActiveNoteStates = 5,
+	kNumberOfSoundingNoteStates = 6,
+	kNumberOfNoteStates = 7,
+	kNoteState_Unset = kNumberOfNoteStates
+};
+
+/*
+		This table describes the state transitions for SynthNotes
+
+        EVENT                   CURRENT STATE                                   NEW STATE
+        note on                 free                                            attacked
+        note off                attacked (and sustain on)                       released but sustained
+        note off                attacked                                        released
+        note off                sostenutoed                                     released but sostenutoed
+        sustain on              -- no changes --
+        sustain off             released but sustained                          released
+        sostenuto on            attacked                                        sostenutoed
+        sostenuto off           sostenutoed                                     attacked
+        sostenuto off           released but sostenutoed (and sustain on)       released but sustained
+        sostenuto off           released but sostenutoed                        released
+        end of note             any state                                       free
+		soft voice stealing     any state                                       fast released
+		hard voice stealing     any state                                       free
+		
+		soft voice stealing happens when there is a note on event and NumActiveNotes > MaxActiveNotes
+		hard voice stealing happens when there is a note on event and NumActiveNotes == NumNotes (no free notes)
+		voice stealing removes the quietest note in the highest numbered state that has sounding notes.
+*/
+
+class SynthGroupElement;
+class SynthPartElement;
+class AUInstrumentBase;
+
+struct SynthNote
+{
+	SynthNote() :
+		mPrev(0), mNext(0), mPart(0), mGroup(0),
+		mNoteID(0xffffffff),
+		mState(kNoteState_Unset),
+		mAbsoluteStartFrame(0),
+		mRelativeStartFrame(0),
+		mRelativeReleaseFrame(-1),
+		mRelativeKillFrame(-1),
+		mPitch(0.0f),
+		mVelocity(0.0f)
+	{
+	}
+	
+	virtual					~SynthNote() {}
+	
+	virtual void			Reset();
+	//! Returns true if active note resulted from this call, otherwise false
+	virtual bool			AttackNote(
+									SynthPartElement *				inPart,
+									SynthGroupElement *				inGroup,
+									NoteInstanceID					inNoteID, 
+									UInt64							inAbsoluteSampleFrame, 
+									UInt32							inOffsetSampleFrame, 
+									const MusicDeviceNoteParams		&inParams
+							);
+								
+	virtual OSStatus		Render(UInt64 inAbsoluteSampleFrame, UInt32 inNumFrames, AudioBufferList** inBufferList, UInt32 inOutBusCount) = 0;
+	//! Returns true if active note resulted from this call, otherwise false
+	virtual bool			Attack(const MusicDeviceNoteParams &inParams) = 0;
+	virtual void			Kill(UInt32 inFrame); // voice is being stolen.
+	virtual void			Release(UInt32 inFrame);
+	virtual void			FastRelease(UInt32 inFrame);
+	virtual Float32			Amplitude() = 0; // used for finding quietest note for voice stealing.
+
+	virtual void			NoteEnded(UInt32 inFrame);
+
+	SynthGroupElement*		GetGroup() const { return mGroup; }
+	SynthPartElement*		GetPart() const { return mPart; }
+	
+	AUInstrumentBase*		GetAudioUnit() const;
+
+	Float32					GetGlobalParameter(AudioUnitParameterID inParamID) const;
+
+	NoteInstanceID			GetNoteID() const { return mNoteID; }
+	SynthNoteState			GetState() const { return mState; }
+	UInt8					GetMidiKey() const { return (UInt8) mPitch; }
+	UInt8					GetMidiVelocity() const { return (UInt8) mVelocity; }
+	
+	Boolean					IsSounding() const { return mState < kNumberOfSoundingNoteStates; }
+	Boolean					IsActive() const { return mState < kNumberOfActiveNoteStates; }
+	UInt64					GetAbsoluteStartFrame() const { return mAbsoluteStartFrame; }
+	SInt32					GetRelativeStartFrame() const { return mRelativeStartFrame; }
+	SInt32					GetRelativeReleaseFrame() const { return mRelativeReleaseFrame; }
+	SInt32					GetRelativeKillFrame() const { return mRelativeKillFrame; }
+
+	void					ListRemove() { mPrev = mNext = 0; } // only use when lists will be reset.
+
+	float					GetPitchBend() const;
+	double					TuningA() const;
+	
+	virtual double			Frequency(); // returns the frequency of note + pitch bend.
+	virtual double			SampleRate();
+
+	// linked list pointers
+	SynthNote				*mPrev;
+	SynthNote				*mNext;
+	
+	friend class			SynthGroupElement;
+	friend struct			SynthNoteList;
+protected:
+	void					SetState(SynthNoteState inState) { mState = inState; }
+private:
+	SynthPartElement*		mPart;
+	SynthGroupElement*	mGroup;
+		
+	NoteInstanceID			mNoteID;
+	SynthNoteState			mState;
+	UInt64					mAbsoluteStartFrame;
+	SInt32					mRelativeStartFrame;
+	SInt32					mRelativeReleaseFrame;
+	SInt32					mRelativeKillFrame;
+	
+	Float32					mPitch;
+	Float32					mVelocity;
+};
+
+#endif
+