drivers/midi/MidiInputPort.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2013 Christian Schoenebeck                       *
 *                                                                         *
 *   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                                                   *
 ***************************************************************************/

#ifndef __LS_MIDIINPUTPORT_H__
#define __LS_MIDIINPUTPORT_H__

#include "../../common/global.h"
#include "../../common/Mutex.h"
#include "../../common/Exception.h"
#include "../DeviceParameter.h"
#include "midi.h"
#include "MidiInputDevice.h"
#include "../../engines/EngineChannel.h"
#include "../../common/SynchronizedConfig.h"

namespace LinuxSampler {

    // just symbol prototyping
    class MidiInputDevice;
    class EngineChannel;
    class VirtualMidiDevice;

    class MidiInputPort {
        public:

            /////////////////////////////////////////////////////////////////
            // type definitions

            /** MIDI Port Parameter 'NAME'
             *
             * Used to assign an arbitrary name to the MIDI port.
             */
            class ParameterName : public DeviceRuntimeParameterString {
                public:
                    ParameterName(MidiInputPort* pPort);
                    ParameterName(MidiInputPort* pPort, String val);
                    virtual String Description();
                    virtual bool   Fix();
                    virtual std::vector<String> PossibilitiesAsString();
                    virtual void OnSetValue(String s) throw (Exception);
                protected:
                    MidiInputPort* pPort;
            };


            /////////////////////////////////////////////////////////////////
            // normal methods
            //     (usually not to be overriden by descendant)

            /**
             * Connect given sampler engine channel with this MIDI input
             * device. The engine channel can either be connected to one
             * specific MIDI channel or all MIDI channels. If an engine
             * channel gets connected twice to this MIDI input device, then
             * the engine's old connection will be detached (no matter on
             * which MIDI channel).
             *
             * @param pEngineChannel - sampler engine
             * @param MidiChannel - MIDI channel to connect to
             * @throws MidiInputException  if MidiChannel argument invalid
             */
            void Connect(EngineChannel* pEngineChannel, midi_chan_t MidiChannel);

            /**
             * Disconnect given sampler engine channel from this MIDI input
             * device. If the given engine channel was not connected with
             * this device, nothing happens.
             *
             * @param pEngineChannel - sampler engine
             */
            void Disconnect(EngineChannel* pEngineChannel);

            /**
             * Return MIDI device where this MIDI port belongs to.
             */
            MidiInputDevice* GetDevice();

            /**
             * Return port number with which this MIDI port is registered to
             * the MIDI device.
             */
            uint GetPortNumber();

            /**
             * Return all parameter settings of this MIDI port.
             */
            std::map<String,DeviceRuntimeParameter*> PortParameters();

            /**
             * Registers that an engine wants to have sysex messages.
             */
            static void AddSysexListener(Engine* engine);

            /**
             * Removes engine from list of engines getting sysex
             * messages.
             *
             * @returns true if engine was removed, false if it wasn't
             *          present in the list.
             */
            static bool RemoveSysexListener(Engine* engine);

            /**
             * Connects the given virtual MIDI device to this MIDI input
             * device. This can be used to listen to MIDI data arriving on
             * the MIDI input device's MIDI ports, e.g. to show an MIDI
             * activity indicator somewhere.
             */
            void Connect(VirtualMidiDevice* pDevice);

            /**
             * Disconnect the previously connected virtual MIDI device.
             */
            void Disconnect(VirtualMidiDevice* pDevice);
            
            /**
             * Registers the given @a filter to be applied against all note on
             * events, adjusting their MIDI velocity data. The vector supplied
             * here must exactly be either of size 128 or 0. In case the given
             * vector is of size 128, it will be used as lookup table by this
             * MIDI inpurt port to remap any incoming MIDI note on velocity
             * data to the respective value in that vector, or exactly:
             * @code
             * velocity = filter[velocity];
             * @endcode
             * Accordingly the values in the vector have to be in the range
             * 0..127, however note that a value 0 should actually never be
             * used, since by MIDI specification, a note on with velocity 0 is
             * interpreted as note off event instead!
             *
             * If a vector of size 0 is supplied, this note on velocity filter
             * mechanism will be disabled.
             *
             * @param filter - lookup table in the format described above
             * @throws MidiInputException - if filter is in invalid format
             */
            void SetNoteOnVelocityFilter(const std::vector<uint8_t>& filter);


            /////////////////////////////////////////////////////////////////
            // dispatch methods
            //     (should be called by the MidiInputDevice descendant on events)

            /**
             * Should be called by the implementing MIDI input device
             * whenever a note on event arrived, this will cause the note on
             * event to be forwarded to all connected engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for realtime rendering, this way an event
             * is immediately created with the current system time as time
             * stamp.
             *
             * @param Key         - MIDI key number of the triggered key
             * @param Velocity    - MIDI velocity of the triggered key
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             */
            void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a note on event arrived, this will cause the note on
             * event to be forwarded to all connected engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for offline rendering and / or in case the
             * exact fragment position of the event is already known.
             *
             * @param Key         - MIDI key number of the triggered key
             * @param Velocity    - MIDI velocity of the triggered key
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             * @param FragmentPos - event's sample point position in the
             *                      current audio fragment
             */
            void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a note off event arrived, this will cause the note
             * off event to be forwarded to all connected engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for realtime rendering, this way an event
             * is immediately created with the current system time as time
             * stamp.
             *
             * @param Key         - MIDI key number of the released key
             * @param Velocity    - MIDI velocity of the released key
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             */
            void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a note off event arrived, this will cause the note
             * off event to be forwarded to all connected engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for offline rendering and / or in case the
             * exact fragment position of the event is already known.
             *
             * @param Key         - MIDI key number of the released key
             * @param Velocity    - MIDI velocity of the released key
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             * @param FragmentPos - event's sample point position in the
             *                      current audio fragment
             */
            void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a pitchbend event arrived, this will cause the
             * pitchbend event to be forwarded to all connected engines.
             *
             * This method is meant for realtime rendering, this way an event
             * is immediately created with the current system time as time
             * stamp.
             *
             * @param Pitch       - MIDI pitch value
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             */
            void DispatchPitchbend(int Pitch, uint MidiChannel);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a pitchbend event arrived, this will cause the
             * pitchbend event to be forwarded to all connected engines.
             *
             * This method is meant for offline rendering and / or in case the
             * exact fragment position of the event is already known.
             *
             * @param Pitch       - MIDI pitch value
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             * @param FragmentPos - event's sample point position in the
             *                      current audio fragment
             */
            void DispatchPitchbend(int Pitch, uint MidiChannel, int32_t FragmentPos);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a control change event arrived, this will cause the
             * control change event to be forwarded to all engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for realtime rendering, this way an event
             * is immediately created with the current system time as time
             * stamp.
             *
             * @param Controller  - MIDI controller number
             * @param Value       - MIDI control change value
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             */
            void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a control change event arrived, this will cause the
             * control change event to be forwarded to all engines on the
             * corresponding MIDI channel.
             *
             * This method is meant for offline rendering and / or in case the
             * exact fragment position of the event is already known.
             *
             * @param Controller  - MIDI controller number
             * @param Value       - MIDI control change value
             * @param MidiChannel - MIDI channel on which event occured on
             *                      (low level indexing, means 0..15)
             * @param FragmentPos - event's sample point position in the
             *                      current audio fragment
             */
            void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel, int32_t FragmentPos);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a program change event arrived. In case the
             * respective sampler channel(s) are enabled for MIDI
             * instrument mapping, the respective sampler engine and
             * instrument will be loaded on the connected sampler
             * channel(s) as defined by the respective entry in the
             * MIDI instrument map.
             *
             * @e Note: the MIDI instrument map is empty by default on
             * sampler startup. It has to be explicitly filled with
             * entries and the sampler channel(s) have to be enabled for
             * a certain MIDI instrument table, otherwise program change
             * messages are ignored!
             *
             * @param Program     - MIDI program change number
             * @param MidiChannel - MIDI channel on which this program
             *                      change occured
             * @see MidiInstrumentMapper
             */
            void DispatchProgramChange(uint8_t Program, uint MidiChannel);

            void DispatchBankSelectMsb(uint8_t BankMsb, uint MidiChannel);

            void DispatchBankSelectLsb(uint8_t BankLsb, uint MidiChannel);

            /**
             * Should be called by the implementing MIDI input device
             * whenever a system exclusive message arrived, this will cause
             * the message to be forwarded to all connected engines.
             *
             * @param pData - pointer to the sysex data
             * @param Size  - length of the sysex data (in bytes)
             */
            void DispatchSysex(void* pData, uint Size);

            /**
             * Helper function for MIDI input devices that have the
             * MIDI data as raw bytes.
             *
             * @param pData - pointer to the raw MIDI data
             */
            void DispatchRaw(uint8_t* pData);

            /**
             * Helper function for MIDI input devices that have the
             * MIDI data as raw bytes.
             *
             * @param pData       - pointer to the raw MIDI data
             * @param FragmentPos - event's sample point position in the
             *                      current audio fragment
             */
            void DispatchRaw(uint8_t* pData, int32_t FragmentPos);

        protected:
            MidiInputDevice* pDevice;
            int portNumber;
            std::map<String,DeviceRuntimeParameter*> Parameters;  ///< All port parameters.
            typedef std::set<EngineChannel*> MidiChannelMap_t[17];
            SynchronizedConfig<MidiChannelMap_t> MidiChannelMap; ///< Contains the list of connected engines for each MIDI channel, where index 0 points to the list of engines which are connected to all MIDI channels. Usually it's not necessary for the descendant to use this map, instead it should just use the Dispatch* methods.
            SynchronizedConfig<MidiChannelMap_t>::Reader MidiChannelMapReader; ///< MIDI thread access to MidiChannelMap
            Mutex MidiChannelMapMutex; ///< Used to protect the MidiChannelMap from being used at the same time by different threads.
            SynchronizedConfig<std::set<Engine*> >::Reader SysexListenersReader; ///< MIDI thread access to SysexListeners
            SynchronizedConfig<std::vector<VirtualMidiDevice*> > virtualMidiDevices;
            SynchronizedConfig<std::vector<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader;
            Mutex virtualMidiDevicesMutex;
            SynchronizedConfig<std::vector<uint8_t> > noteOnVelocityFilter;
            SynchronizedConfig<std::vector<uint8_t> >::Reader noteOnVelocityFilterReader;
            Mutex noteOnVelocityFilterMutex;
            uint8_t runningStatusBuf[3];

            /**
             * Constructor
             */
            MidiInputPort(MidiInputDevice* pDevice, int portNumber);

            /**
             * Destructor
             */
            virtual ~MidiInputPort();

            friend class MidiInputDevice;

        private:            
            static SynchronizedConfig<std::set<Engine*> > SysexListeners; ///< All engines that are listening to sysex messages.
            
            uint8_t* handleRunningStatus(uint8_t* pData);
    };

} // namsepace LinuxSampler

#endif // __LS_MIDIINPUTPORT_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005 - 2013 Christian Schoenebeck *
7	* *
8	* This program is free software; you can redistribute it and/or modify *
9	* it under the terms of the GNU General Public License as published by *
10	* the Free Software Foundation; either version 2 of the License, or *
11	* (at your option) any later version. *
12	* *
13	* This program is distributed in the hope that it will be useful, *
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16	* GNU General Public License for more details. *
17	* *
18	* You should have received a copy of the GNU General Public License *
19	* along with this program; if not, write to the Free Software *
20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21	* MA 02111-1307 USA *
22	***************************************************************************/
23
24	#ifndef __LS_MIDIINPUTPORT_H__
25	#define __LS_MIDIINPUTPORT_H__
26
27	#include "../../common/global.h"
28	#include "../../common/Mutex.h"
29	#include "../../common/Exception.h"
30	#include "../DeviceParameter.h"
31	#include "midi.h"
32	#include "MidiInputDevice.h"
33	#include "../../engines/EngineChannel.h"
34	#include "../../common/SynchronizedConfig.h"
35
36	namespace LinuxSampler {
37
38	// just symbol prototyping
39	class MidiInputDevice;
40	class EngineChannel;
41	class VirtualMidiDevice;
42
43	class MidiInputPort {
44	public:
45
46	/////////////////////////////////////////////////////////////////
47	// type definitions
48
49	/** MIDI Port Parameter 'NAME'
50	*
51	* Used to assign an arbitrary name to the MIDI port.
52	*/
53	class ParameterName : public DeviceRuntimeParameterString {
54	public:
55	ParameterName(MidiInputPort* pPort);
56	ParameterName(MidiInputPort* pPort, String val);
57	virtual String Description();
58	virtual bool Fix();
59	virtual std::vector<String> PossibilitiesAsString();
60	virtual void OnSetValue(String s) throw (Exception);
61	protected:
62	MidiInputPort* pPort;
63	};
64
65
66
67	/////////////////////////////////////////////////////////////////
68	// normal methods
69	// (usually not to be overriden by descendant)
70
71	/**
72	* Connect given sampler engine channel with this MIDI input
73	* device. The engine channel can either be connected to one
74	* specific MIDI channel or all MIDI channels. If an engine
75	* channel gets connected twice to this MIDI input device, then
76	* the engine's old connection will be detached (no matter on
77	* which MIDI channel).
78	*
79	* @param pEngineChannel - sampler engine
80	* @param MidiChannel - MIDI channel to connect to
81	* @throws MidiInputException if MidiChannel argument invalid
82	*/
83	void Connect(EngineChannel* pEngineChannel, midi_chan_t MidiChannel);
84
85	/**
86	* Disconnect given sampler engine channel from this MIDI input
87	* device. If the given engine channel was not connected with
88	* this device, nothing happens.
89	*
90	* @param pEngineChannel - sampler engine
91	*/
92	void Disconnect(EngineChannel* pEngineChannel);
93
94	/**
95	* Return MIDI device where this MIDI port belongs to.
96	*/
97	MidiInputDevice* GetDevice();
98
99	/**
100	* Return port number with which this MIDI port is registered to
101	* the MIDI device.
102	*/
103	uint GetPortNumber();
104
105	/**
106	* Return all parameter settings of this MIDI port.
107	*/
108	std::map<String,DeviceRuntimeParameter*> PortParameters();
109
110	/**
111	* Registers that an engine wants to have sysex messages.
112	*/
113	static void AddSysexListener(Engine* engine);
114
115	/**
116	* Removes engine from list of engines getting sysex
117	* messages.
118	*
119	* @returns true if engine was removed, false if it wasn't
120	* present in the list.
121	*/
122	static bool RemoveSysexListener(Engine* engine);
123
124	/**
125	* Connects the given virtual MIDI device to this MIDI input
126	* device. This can be used to listen to MIDI data arriving on
127	* the MIDI input device's MIDI ports, e.g. to show an MIDI
128	* activity indicator somewhere.
129	*/
130	void Connect(VirtualMidiDevice* pDevice);
131
132	/**
133	* Disconnect the previously connected virtual MIDI device.
134	*/
135	void Disconnect(VirtualMidiDevice* pDevice);
136
137	/**
138	* Registers the given @a filter to be applied against all note on
139	* events, adjusting their MIDI velocity data. The vector supplied
140	* here must exactly be either of size 128 or 0. In case the given
141	* vector is of size 128, it will be used as lookup table by this
142	* MIDI inpurt port to remap any incoming MIDI note on velocity
143	* data to the respective value in that vector, or exactly:
144	* @code
145	* velocity = filter[velocity];
146	* @endcode
147	* Accordingly the values in the vector have to be in the range
148	* 0..127, however note that a value 0 should actually never be
149	* used, since by MIDI specification, a note on with velocity 0 is
150	* interpreted as note off event instead!
151	*
152	* If a vector of size 0 is supplied, this note on velocity filter
153	* mechanism will be disabled.
154	*
155	* @param filter - lookup table in the format described above
156	* @throws MidiInputException - if filter is in invalid format
157	*/
158	void SetNoteOnVelocityFilter(const std::vector<uint8_t>& filter);
159
160
161	/////////////////////////////////////////////////////////////////
162	// dispatch methods
163	// (should be called by the MidiInputDevice descendant on events)
164
165	/**
166	* Should be called by the implementing MIDI input device
167	* whenever a note on event arrived, this will cause the note on
168	* event to be forwarded to all connected engines on the
169	* corresponding MIDI channel.
170	*
171	* This method is meant for realtime rendering, this way an event
172	* is immediately created with the current system time as time
173	* stamp.
174	*
175	* @param Key - MIDI key number of the triggered key
176	* @param Velocity - MIDI velocity of the triggered key
177	* @param MidiChannel - MIDI channel on which event occured on
178	* (low level indexing, means 0..15)
179	*/
180	void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel);
181
182	/**
183	* Should be called by the implementing MIDI input device
184	* whenever a note on event arrived, this will cause the note on
185	* event to be forwarded to all connected engines on the
186	* corresponding MIDI channel.
187	*
188	* This method is meant for offline rendering and / or in case the
189	* exact fragment position of the event is already known.
190	*
191	* @param Key - MIDI key number of the triggered key
192	* @param Velocity - MIDI velocity of the triggered key
193	* @param MidiChannel - MIDI channel on which event occured on
194	* (low level indexing, means 0..15)
195	* @param FragmentPos - event's sample point position in the
196	* current audio fragment
197	*/
198	void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);
199
200	/**
201	* Should be called by the implementing MIDI input device
202	* whenever a note off event arrived, this will cause the note
203	* off event to be forwarded to all connected engines on the
204	* corresponding MIDI channel.
205	*
206	* This method is meant for realtime rendering, this way an event
207	* is immediately created with the current system time as time
208	* stamp.
209	*
210	* @param Key - MIDI key number of the released key
211	* @param Velocity - MIDI velocity of the released key
212	* @param MidiChannel - MIDI channel on which event occured on
213	* (low level indexing, means 0..15)
214	*/
215	void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel);
216
217	/**
218	* Should be called by the implementing MIDI input device
219	* whenever a note off event arrived, this will cause the note
220	* off event to be forwarded to all connected engines on the
221	* corresponding MIDI channel.
222	*
223	* This method is meant for offline rendering and / or in case the
224	* exact fragment position of the event is already known.
225	*
226	* @param Key - MIDI key number of the released key
227	* @param Velocity - MIDI velocity of the released key
228	* @param MidiChannel - MIDI channel on which event occured on
229	* (low level indexing, means 0..15)
230	* @param FragmentPos - event's sample point position in the
231	* current audio fragment
232	*/
233	void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);
234
235	/**
236	* Should be called by the implementing MIDI input device
237	* whenever a pitchbend event arrived, this will cause the
238	* pitchbend event to be forwarded to all connected engines.
239	*
240	* This method is meant for realtime rendering, this way an event
241	* is immediately created with the current system time as time
242	* stamp.
243	*
244	* @param Pitch - MIDI pitch value
245	* @param MidiChannel - MIDI channel on which event occured on
246	* (low level indexing, means 0..15)
247	*/
248	void DispatchPitchbend(int Pitch, uint MidiChannel);
249
250	/**
251	* Should be called by the implementing MIDI input device
252	* whenever a pitchbend event arrived, this will cause the
253	* pitchbend event to be forwarded to all connected engines.
254	*
255	* This method is meant for offline rendering and / or in case the
256	* exact fragment position of the event is already known.
257	*
258	* @param Pitch - MIDI pitch value
259	* @param MidiChannel - MIDI channel on which event occured on
260	* (low level indexing, means 0..15)
261	* @param FragmentPos - event's sample point position in the
262	* current audio fragment
263	*/
264	void DispatchPitchbend(int Pitch, uint MidiChannel, int32_t FragmentPos);
265
266	/**
267	* Should be called by the implementing MIDI input device
268	* whenever a control change event arrived, this will cause the
269	* control change event to be forwarded to all engines on the
270	* corresponding MIDI channel.
271	*
272	* This method is meant for realtime rendering, this way an event
273	* is immediately created with the current system time as time
274	* stamp.
275	*
276	* @param Controller - MIDI controller number
277	* @param Value - MIDI control change value
278	* @param MidiChannel - MIDI channel on which event occured on
279	* (low level indexing, means 0..15)
280	*/
281	void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel);
282
283	/**
284	* Should be called by the implementing MIDI input device
285	* whenever a control change event arrived, this will cause the
286	* control change event to be forwarded to all engines on the
287	* corresponding MIDI channel.
288	*
289	* This method is meant for offline rendering and / or in case the
290	* exact fragment position of the event is already known.
291	*
292	* @param Controller - MIDI controller number
293	* @param Value - MIDI control change value
294	* @param MidiChannel - MIDI channel on which event occured on
295	* (low level indexing, means 0..15)
296	* @param FragmentPos - event's sample point position in the
297	* current audio fragment
298	*/
299	void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel, int32_t FragmentPos);
300
301	/**
302	* Should be called by the implementing MIDI input device
303	* whenever a program change event arrived. In case the
304	* respective sampler channel(s) are enabled for MIDI
305	* instrument mapping, the respective sampler engine and
306	* instrument will be loaded on the connected sampler
307	* channel(s) as defined by the respective entry in the
308	* MIDI instrument map.
309	*
310	* @e Note: the MIDI instrument map is empty by default on
311	* sampler startup. It has to be explicitly filled with
312	* entries and the sampler channel(s) have to be enabled for
313	* a certain MIDI instrument table, otherwise program change
314	* messages are ignored!
315	*
316	* @param Program - MIDI program change number
317	* @param MidiChannel - MIDI channel on which this program
318	* change occured
319	* @see MidiInstrumentMapper
320	*/
321	void DispatchProgramChange(uint8_t Program, uint MidiChannel);
322
323	void DispatchBankSelectMsb(uint8_t BankMsb, uint MidiChannel);
324
325	void DispatchBankSelectLsb(uint8_t BankLsb, uint MidiChannel);
326
327	/**
328	* Should be called by the implementing MIDI input device
329	* whenever a system exclusive message arrived, this will cause
330	* the message to be forwarded to all connected engines.
331	*
332	* @param pData - pointer to the sysex data
333	* @param Size - length of the sysex data (in bytes)
334	*/
335	void DispatchSysex(void* pData, uint Size);
336
337	/**
338	* Helper function for MIDI input devices that have the
339	* MIDI data as raw bytes.
340	*
341	* @param pData - pointer to the raw MIDI data
342	*/
343	void DispatchRaw(uint8_t* pData);
344
345	/**
346	* Helper function for MIDI input devices that have the
347	* MIDI data as raw bytes.
348	*
349	* @param pData - pointer to the raw MIDI data
350	* @param FragmentPos - event's sample point position in the
351	* current audio fragment
352	*/
353	void DispatchRaw(uint8_t* pData, int32_t FragmentPos);
354
355	protected:
356	MidiInputDevice* pDevice;
357	int portNumber;
358	std::map<String,DeviceRuntimeParameter*> Parameters; ///< All port parameters.
359	typedef std::set<EngineChannel*> MidiChannelMap_t[17];
360	SynchronizedConfig<MidiChannelMap_t> MidiChannelMap; ///< Contains the list of connected engines for each MIDI channel, where index 0 points to the list of engines which are connected to all MIDI channels. Usually it's not necessary for the descendant to use this map, instead it should just use the Dispatch* methods.
361	SynchronizedConfig<MidiChannelMap_t>::Reader MidiChannelMapReader; ///< MIDI thread access to MidiChannelMap
362	Mutex MidiChannelMapMutex; ///< Used to protect the MidiChannelMap from being used at the same time by different threads.
363	SynchronizedConfig<std::set<Engine*> >::Reader SysexListenersReader; ///< MIDI thread access to SysexListeners
364	SynchronizedConfig<std::vector<VirtualMidiDevice*> > virtualMidiDevices;
365	SynchronizedConfig<std::vector<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader;
366	Mutex virtualMidiDevicesMutex;
367	SynchronizedConfig<std::vector<uint8_t> > noteOnVelocityFilter;
368	SynchronizedConfig<std::vector<uint8_t> >::Reader noteOnVelocityFilterReader;
369	Mutex noteOnVelocityFilterMutex;
370	uint8_t runningStatusBuf[3];
371
372	/**
373	* Constructor
374	*/
375	MidiInputPort(MidiInputDevice* pDevice, int portNumber);
376
377	/**
378	* Destructor
379	*/
380	virtual ~MidiInputPort();
381
382	friend class MidiInputDevice;
383
384	private:
385	static SynchronizedConfig<std::set<Engine*> > SysexListeners; ///< All engines that are listening to sysex messages.
386
387	uint8_t* handleRunningStatus(uint8_t* pData);
388	};
389
390	} // namsepace LinuxSampler
391
392	#endif // __LS_MIDIINPUTPORT_H__