engines/sfz/Engine.cpp

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
 *   Copyright (C) 2005-2009 Christian Schoenebeck                         *
 *   Copyright (C) 2009 Grigor Iliev                                       *
 *                                                                         *
 *   This program 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 2 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, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "Engine.h"
#include "EngineChannel.h"

namespace LinuxSampler { namespace sfz {
    Engine::Format Engine::GetEngineFormat() { return SFZ; }

    /**
     *  Reacts on supported control change commands (e.g. pitch bend wheel,
     *  modulation wheel, aftertouch).
     *
     *  @param pEngineChannel - engine channel on which this event occured on
     *  @param itControlChangeEvent - controller, value and time stamp of the event
     */
    void Engine::ProcessControlChange (
        LinuxSampler::EngineChannel*  pEngineChannel,
        Pool<Event>::Iterator&        itControlChangeEvent
    ) {
        dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value));

        EngineChannel* pChannel = dynamic_cast<EngineChannel*>(pEngineChannel);
        // handle the "control triggered" MIDI rule: a control change
        // event can trigger a new note on or note off event
        if (pChannel->pInstrument) {

            // TODO: 
        }

        // update controller value in the engine channel's controller table
        pChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value;

        ProcessHardcodedControllers(pEngineChannel, itControlChangeEvent);

        // handle FX send controllers
        ProcessFxSendControllers(pChannel, itControlChangeEvent);
    }

    DiskThread* Engine::CreateDiskThread() {
        return new DiskThread (
            iMaxDiskStreams,
            ((pAudioOutputDevice->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6, //FIXME: assuming stereo
            &instruments
        );
    }

    void Engine::TriggerNewVoices (
        LinuxSampler::EngineChannel* pEngineChannel,
        RTList<Event>::Iterator&     itNoteOnEvent,
        bool                         HandleKeyGroupConflicts
    ) {
        EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);

        uint8_t  chan     = pChannel->MidiChannel();
        int      key      = itNoteOnEvent->Param.Note.Key;
        uint8_t  vel      = itNoteOnEvent->Param.Note.Velocity;
        int      bend     = pChannel->Pitch;
        uint8_t  chanaft  = pChannel->ControllerTable[128];
        uint8_t* cc       = pChannel->ControllerTable;
        ::sfz::trigger_t trig = TRIGGER_ATTACK;

        pChannel->regionsTemp = pChannel->pInstrument->GetRegionsOnKey (
            chan, key, vel, bend, 0, chanaft, 0, 0, 0, trig, cc,
            0.0f, 1, pChannel->PressedKeys, pChannel->LastKeySwitch, pChannel->LastKey
        );

        for (int i = 0; i < pChannel->regionsTemp.size(); i++) {
            if (!RegionSuspended(pChannel->regionsTemp[i])) {
                LaunchVoice(pChannel, itNoteOnEvent, i, false, true, HandleKeyGroupConflicts);
            }
        }
    }

    void Engine::TriggerReleaseVoices (
        LinuxSampler::EngineChannel*  pEngineChannel,
        RTList<Event>::Iterator&      itNoteOffEvent
    ) {
        EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);
        uint8_t  chan     = pChannel->MidiChannel();
        int      key      = itNoteOffEvent->Param.Note.Key;
        uint8_t  vel      = itNoteOffEvent->Param.Note.Velocity;
        int      bend     = pChannel->Pitch;
        uint8_t  chanaft  = pChannel->ControllerTable[128];
        uint8_t* cc       = pChannel->ControllerTable;
        ::sfz::trigger_t trig = TRIGGER_RELEASE;

        pChannel->regionsTemp = pChannel->pInstrument->GetRegionsOnKey (
            chan, key, vel, bend, 0, chanaft, 0, 0, 0, trig, cc, 0.0f, 0, NULL, 0, 0
        );

        // now launch the required amount of voices
        for (int i = 0; i < pChannel->regionsTemp.size(); i++) {
            LaunchVoice(pChannel, itNoteOffEvent, i, true, false, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples
        }
    }

    Pool<Voice>::Iterator Engine::LaunchVoice (
        LinuxSampler::EngineChannel*  pEngineChannel,
        Pool<Event>::Iterator&        itNoteOnEvent,
        int                           iLayer,
        bool                          ReleaseTriggerVoice,
        bool                          VoiceStealing,
        bool                          HandleKeyGroupConflicts
    ) {
        EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);
        int key = itNoteOnEvent->Param.Note.Key;
        EngineChannel::MidiKey* pKey  = &pChannel->pMIDIKeyInfo[key];
        Voice::type_t VoiceType = Voice::type_normal;

        Pool<Voice>::Iterator itNewVoice;
        ::sfz::Region* pRgn = pChannel->regionsTemp[iLayer];

        // no need to process if sample is silent
        if (!pRgn->GetSample() || !pRgn->GetSample()->GetTotalFrameCount()) return Pool<Voice>::Iterator();

        // only mark the first voice of a layered voice (group) to be in a
        // key group, so the layered voices won't kill each other
        int iKeyGroup = (iLayer == 0 && !ReleaseTriggerVoice) ? pRgn->group : 0;
        if (HandleKeyGroupConflicts) pChannel->HandleKeyGroupConflicts(iKeyGroup, itNoteOnEvent);

        // allocate a new voice for the key
        itNewVoice = pKey->pActiveVoices->allocAppend();
        int res = InitNewVoice (
                pChannel, pRgn, itNoteOnEvent, VoiceType, iLayer,
                iKeyGroup, ReleaseTriggerVoice, VoiceStealing, itNewVoice
        );
        if (!res) return itNewVoice;

        // return if this is a release triggered voice and there is no
        // releasetrigger dimension (could happen if an instrument
        // change has occured between note on and off)
        //if (ReleaseTriggerVoice && VoiceType != Voice::type_release_trigger) return Pool<Voice>::Iterator();

        return Pool<Voice>::Iterator(); // no free voice or error
    }

    bool Engine::DiskStreamSupported() {
        return true;
    }

    String Engine::Description() {
        return "SFZ Format Engine";
    }

    String Engine::Version() {
        String s = "$Revision: 1.2 $";
        return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
    }

}} // namespace LinuxSampler::sfz
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005-2009 Christian Schoenebeck *
7	* Copyright (C) 2009 Grigor Iliev *
8	* *
9	* This program is free software; you can redistribute it and/or modify *
10	* it under the terms of the GNU General Public License as published by *
11	* the Free Software Foundation; either version 2 of the License, or *
12	* (at your option) any later version. *
13	* *
14	* This program is distributed in the hope that it will be useful, *
15	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
17	* GNU General Public License for more details. *
18	* *
19	* You should have received a copy of the GNU General Public License *
20	* along with this program; if not, write to the Free Software *
21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
22	* MA 02111-1307 USA *
23	***************************************************************************/
24
25	#include "Engine.h"
26	#include "EngineChannel.h"
27
28	namespace LinuxSampler { namespace sfz {
29	Engine::Format Engine::GetEngineFormat() { return SFZ; }
30
31	/**
32	* Reacts on supported control change commands (e.g. pitch bend wheel,
33	* modulation wheel, aftertouch).
34	*
35	* @param pEngineChannel - engine channel on which this event occured on
36	* @param itControlChangeEvent - controller, value and time stamp of the event
37	*/
38	void Engine::ProcessControlChange (
39	LinuxSampler::EngineChannel* pEngineChannel,
40	Pool<Event>::Iterator& itControlChangeEvent
41	) {
42	dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value));
43
44	EngineChannel* pChannel = dynamic_cast<EngineChannel*>(pEngineChannel);
45	// handle the "control triggered" MIDI rule: a control change
46	// event can trigger a new note on or note off event
47	if (pChannel->pInstrument) {
48
49	// TODO:
50	}
51
52	// update controller value in the engine channel's controller table
53	pChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value;
54
55	ProcessHardcodedControllers(pEngineChannel, itControlChangeEvent);
56
57	// handle FX send controllers
58	ProcessFxSendControllers(pChannel, itControlChangeEvent);
59	}
60
61	DiskThread* Engine::CreateDiskThread() {
62	return new DiskThread (
63	iMaxDiskStreams,
64	((pAudioOutputDevice->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6, //FIXME: assuming stereo
65	&instruments
66	);
67	}
68
69	void Engine::TriggerNewVoices (
70	LinuxSampler::EngineChannel* pEngineChannel,
71	RTList<Event>::Iterator& itNoteOnEvent,
72	bool HandleKeyGroupConflicts
73	) {
74	EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);
75
76	uint8_t chan = pChannel->MidiChannel();
77	int key = itNoteOnEvent->Param.Note.Key;
78	uint8_t vel = itNoteOnEvent->Param.Note.Velocity;
79	int bend = pChannel->Pitch;
80	uint8_t chanaft = pChannel->ControllerTable[128];
81	uint8_t* cc = pChannel->ControllerTable;
82	::sfz::trigger_t trig = TRIGGER_ATTACK;
83
84	pChannel->regionsTemp = pChannel->pInstrument->GetRegionsOnKey (
85	chan, key, vel, bend, 0, chanaft, 0, 0, 0, trig, cc,
86	0.0f, 1, pChannel->PressedKeys, pChannel->LastKeySwitch, pChannel->LastKey
87	);
88
89	for (int i = 0; i < pChannel->regionsTemp.size(); i++) {
90	if (!RegionSuspended(pChannel->regionsTemp[i])) {
91	LaunchVoice(pChannel, itNoteOnEvent, i, false, true, HandleKeyGroupConflicts);
92	}
93	}
94	}
95
96	void Engine::TriggerReleaseVoices (
97	LinuxSampler::EngineChannel* pEngineChannel,
98	RTList<Event>::Iterator& itNoteOffEvent
99	) {
100	EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);
101	uint8_t chan = pChannel->MidiChannel();
102	int key = itNoteOffEvent->Param.Note.Key;
103	uint8_t vel = itNoteOffEvent->Param.Note.Velocity;
104	int bend = pChannel->Pitch;
105	uint8_t chanaft = pChannel->ControllerTable[128];
106	uint8_t* cc = pChannel->ControllerTable;
107	::sfz::trigger_t trig = TRIGGER_RELEASE;
108
109	pChannel->regionsTemp = pChannel->pInstrument->GetRegionsOnKey (
110	chan, key, vel, bend, 0, chanaft, 0, 0, 0, trig, cc, 0.0f, 0, NULL, 0, 0
111	);
112
113	// now launch the required amount of voices
114	for (int i = 0; i < pChannel->regionsTemp.size(); i++) {
115	LaunchVoice(pChannel, itNoteOffEvent, i, true, false, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples
116	}
117	}
118
119	Pool<Voice>::Iterator Engine::LaunchVoice (
120	LinuxSampler::EngineChannel* pEngineChannel,
121	Pool<Event>::Iterator& itNoteOnEvent,
122	int iLayer,
123	bool ReleaseTriggerVoice,
124	bool VoiceStealing,
125	bool HandleKeyGroupConflicts
126	) {
127	EngineChannel* pChannel = static_cast<EngineChannel*>(pEngineChannel);
128	int key = itNoteOnEvent->Param.Note.Key;
129	EngineChannel::MidiKey* pKey = &pChannel->pMIDIKeyInfo[key];
130	Voice::type_t VoiceType = Voice::type_normal;
131
132	Pool<Voice>::Iterator itNewVoice;
133	::sfz::Region* pRgn = pChannel->regionsTemp[iLayer];
134
135	// no need to process if sample is silent
136	if (!pRgn->GetSample() \|\| !pRgn->GetSample()->GetTotalFrameCount()) return Pool<Voice>::Iterator();
137
138	// only mark the first voice of a layered voice (group) to be in a
139	// key group, so the layered voices won't kill each other
140	int iKeyGroup = (iLayer == 0 && !ReleaseTriggerVoice) ? pRgn->group : 0;
141	if (HandleKeyGroupConflicts) pChannel->HandleKeyGroupConflicts(iKeyGroup, itNoteOnEvent);
142
143	// allocate a new voice for the key
144	itNewVoice = pKey->pActiveVoices->allocAppend();
145	int res = InitNewVoice (
146	pChannel, pRgn, itNoteOnEvent, VoiceType, iLayer,
147	iKeyGroup, ReleaseTriggerVoice, VoiceStealing, itNewVoice
148	);
149	if (!res) return itNewVoice;
150
151	// return if this is a release triggered voice and there is no
152	// releasetrigger dimension (could happen if an instrument
153	// change has occured between note on and off)
154	//if (ReleaseTriggerVoice && VoiceType != Voice::type_release_trigger) return Pool<Voice>::Iterator();
155
156	return Pool<Voice>::Iterator(); // no free voice or error
157	}
158
159	bool Engine::DiskStreamSupported() {
160	return true;
161	}
162
163	String Engine::Description() {
164	return "SFZ Format Engine";
165	}
166
167	String Engine::Version() {
168	String s = "$Revision: 1.2 $";
169	return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
170	}
171
172	}} // namespace LinuxSampler::sfz