drivers/midi/MidiInputPort.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005, 2006 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 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 with this MIDI input device.
             * The engine can either be connected to one specific MIDI
             * channel or all MIDI channels. If an engine gets connected
             * twice to this MIDI input device, then the engine's old
             * connection will be detached (no matter on which MIDI channel).
             *
             * @param pEngine     - 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 from this MIDI input device.
             * If the given engine was not connected with this device,
             * nothing happens.
             *
             * @param pEngine - 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);


            /////////////////////////////////////////////////////////////////
            // 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, this will cause the
             * appropriate sampler channel to be connected with this MIDI
             * device.
             *
             * For example consider a program change event on MIDI channel
             * 3 for program number 18. This would cause this MIDI input
             * device to be connected to sampler channel 18 and would cause
             * sampler channel 18 to listen to MIDI channel 3.
             *
             * This is the current, general implementation of program
             * change events. It might change in future, e.g to allow
             * sampler engines to allow by themselfes how to act on a
             * program change event.
             *
             * @param Program     - sampler channel to connect to this MIDI
             *                      input device
             * @param MidiChannel - MIDI channel on which sampler channel
             *                      \a Program should listen to
             */
            void DispatchProgramChange(uint8_t Program, 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);

        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

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

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

            friend class MidiInputDevice;

        private:
            EngineChannel* pPreviousProgramChangeEngineChannel; ///< Points to the engine channel which was connected by the previous DispatchProgramChange() call.
            static SynchronizedConfig<std::set<Engine*> > SysexListeners; ///< All engines that are listening to sysex messages.
    };

} // 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, 2006 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
42	class MidiInputPort {
43	public:
44
45	/////////////////////////////////////////////////////////////////
46	// type definitions
47
48	/** MIDI Port Parameter 'NAME'
49	*
50	* Used to assign an arbitrary name to the MIDI port.
51	*/
52	class ParameterName : public DeviceRuntimeParameterString {
53	public:
54	ParameterName(MidiInputPort* pPort);
55	ParameterName(MidiInputPort* pPort, String val);
56	virtual String Description();
57	virtual bool Fix();
58	virtual std::vector<String> PossibilitiesAsString();
59	virtual void OnSetValue(String s) throw (Exception);
60	protected:
61	MidiInputPort* pPort;
62	};
63
64
65
66	/////////////////////////////////////////////////////////////////
67	// normal methods
68	// (usually not to be overriden by descendant)
69
70	/**
71	* Connect given sampler engine with this MIDI input device.
72	* The engine can either be connected to one specific MIDI
73	* channel or all MIDI channels. If an engine gets connected
74	* twice to this MIDI input device, then the engine's old
75	* connection will be detached (no matter on which MIDI channel).
76	*
77	* @param pEngine - sampler engine
78	* @param MidiChannel - MIDI channel to connect to
79	* @throws MidiInputException if MidiChannel argument invalid
80	*/
81	void Connect(EngineChannel* pEngineChannel, midi_chan_t MidiChannel);
82
83	/**
84	* Disconnect given sampler engine from this MIDI input device.
85	* If the given engine was not connected with this device,
86	* nothing happens.
87	*
88	* @param pEngine - sampler engine
89	*/
90	void Disconnect(EngineChannel* pEngineChannel);
91
92	/**
93	* Return MIDI device where this MIDI port belongs to.
94	*/
95	MidiInputDevice* GetDevice();
96
97	/**
98	* Return port number with which this MIDI port is registered to
99	* the MIDI device.
100	*/
101	uint GetPortNumber();
102
103	/**
104	* Return all parameter settings of this MIDI port.
105	*/
106	std::map<String,DeviceRuntimeParameter*> PortParameters();
107
108	/**
109	* Registers that an engine wants to have sysex messages.
110	*/
111	static void AddSysexListener(Engine* engine);
112
113	/**
114	* Removes engine from list of engines getting sysex
115	* messages.
116	*
117	* @returns true if engine was removed, false if it wasn't
118	* present in the list.
119	*/
120	static bool RemoveSysexListener(Engine* engine);
121
122
123	/////////////////////////////////////////////////////////////////
124	// dispatch methods
125	// (should be called by the MidiInputDevice descendant on events)
126
127	/**
128	* Should be called by the implementing MIDI input device
129	* whenever a note on event arrived, this will cause the note on
130	* event to be forwarded to all connected engines on the
131	* corresponding MIDI channel.
132	*
133	* This method is meant for realtime rendering, this way an event
134	* is immediately created with the current system time as time
135	* stamp.
136	*
137	* @param Key - MIDI key number of the triggered key
138	* @param Velocity - MIDI velocity of the triggered key
139	* @param MidiChannel - MIDI channel on which event occured on
140	* (low level indexing, means 0..15)
141	*/
142	void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel);
143
144	/**
145	* Should be called by the implementing MIDI input device
146	* whenever a note on event arrived, this will cause the note on
147	* event to be forwarded to all connected engines on the
148	* corresponding MIDI channel.
149	*
150	* This method is meant for offline rendering and / or in case the
151	* exact fragment position of the event is already known.
152	*
153	* @param Key - MIDI key number of the triggered key
154	* @param Velocity - MIDI velocity of the triggered key
155	* @param MidiChannel - MIDI channel on which event occured on
156	* (low level indexing, means 0..15)
157	* @param FragmentPos - event's sample point position in the
158	* current audio fragment
159	*/
160	void DispatchNoteOn(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);
161
162	/**
163	* Should be called by the implementing MIDI input device
164	* whenever a note off event arrived, this will cause the note
165	* off event to be forwarded to all connected engines on the
166	* corresponding MIDI channel.
167	*
168	* This method is meant for realtime rendering, this way an event
169	* is immediately created with the current system time as time
170	* stamp.
171	*
172	* @param Key - MIDI key number of the released key
173	* @param Velocity - MIDI velocity of the released key
174	* @param MidiChannel - MIDI channel on which event occured on
175	* (low level indexing, means 0..15)
176	*/
177	void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel);
178
179	/**
180	* Should be called by the implementing MIDI input device
181	* whenever a note off event arrived, this will cause the note
182	* off event to be forwarded to all connected engines on the
183	* corresponding MIDI channel.
184	*
185	* This method is meant for offline rendering and / or in case the
186	* exact fragment position of the event is already known.
187	*
188	* @param Key - MIDI key number of the released key
189	* @param Velocity - MIDI velocity of the released key
190	* @param MidiChannel - MIDI channel on which event occured on
191	* (low level indexing, means 0..15)
192	* @param FragmentPos - event's sample point position in the
193	* current audio fragment
194	*/
195	void DispatchNoteOff(uint8_t Key, uint8_t Velocity, uint MidiChannel, int32_t FragmentPos);
196
197	/**
198	* Should be called by the implementing MIDI input device
199	* whenever a pitchbend event arrived, this will cause the
200	* pitchbend event to be forwarded to all connected engines.
201	*
202	* This method is meant for realtime rendering, this way an event
203	* is immediately created with the current system time as time
204	* stamp.
205	*
206	* @param Pitch - MIDI pitch value
207	* @param MidiChannel - MIDI channel on which event occured on
208	* (low level indexing, means 0..15)
209	*/
210	void DispatchPitchbend(int Pitch, uint MidiChannel);
211
212	/**
213	* Should be called by the implementing MIDI input device
214	* whenever a pitchbend event arrived, this will cause the
215	* pitchbend event to be forwarded to all connected engines.
216	*
217	* This method is meant for offline rendering and / or in case the
218	* exact fragment position of the event is already known.
219	*
220	* @param Pitch - MIDI pitch value
221	* @param MidiChannel - MIDI channel on which event occured on
222	* (low level indexing, means 0..15)
223	* @param FragmentPos - event's sample point position in the
224	* current audio fragment
225	*/
226	void DispatchPitchbend(int Pitch, uint MidiChannel, int32_t FragmentPos);
227
228	/**
229	* Should be called by the implementing MIDI input device
230	* whenever a control change event arrived, this will cause the
231	* control change event to be forwarded to all engines on the
232	* corresponding MIDI channel.
233	*
234	* This method is meant for realtime rendering, this way an event
235	* is immediately created with the current system time as time
236	* stamp.
237	*
238	* @param Controller - MIDI controller number
239	* @param Value - MIDI control change value
240	* @param MidiChannel - MIDI channel on which event occured on
241	* (low level indexing, means 0..15)
242	*/
243	void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel);
244
245	/**
246	* Should be called by the implementing MIDI input device
247	* whenever a control change event arrived, this will cause the
248	* control change event to be forwarded to all engines on the
249	* corresponding MIDI channel.
250	*
251	* This method is meant for offline rendering and / or in case the
252	* exact fragment position of the event is already known.
253	*
254	* @param Controller - MIDI controller number
255	* @param Value - MIDI control change value
256	* @param MidiChannel - MIDI channel on which event occured on
257	* (low level indexing, means 0..15)
258	* @param FragmentPos - event's sample point position in the
259	* current audio fragment
260	*/
261	void DispatchControlChange(uint8_t Controller, uint8_t Value, uint MidiChannel, int32_t FragmentPos);
262
263	/**
264	* Should be called by the implementing MIDI input device
265	* whenever a program change event arrived, this will cause the
266	* appropriate sampler channel to be connected with this MIDI
267	* device.
268	*
269	* For example consider a program change event on MIDI channel
270	* 3 for program number 18. This would cause this MIDI input
271	* device to be connected to sampler channel 18 and would cause
272	* sampler channel 18 to listen to MIDI channel 3.
273	*
274	* This is the current, general implementation of program
275	* change events. It might change in future, e.g to allow
276	* sampler engines to allow by themselfes how to act on a
277	* program change event.
278	*
279	* @param Program - sampler channel to connect to this MIDI
280	* input device
281	* @param MidiChannel - MIDI channel on which sampler channel
282	* \a Program should listen to
283	*/
284	void DispatchProgramChange(uint8_t Program, uint MidiChannel);
285
286	/**
287	* Should be called by the implementing MIDI input device
288	* whenever a system exclusive message arrived, this will cause
289	* the message to be forwarded to all connected engines.
290	*
291	* @param pData - pointer to the sysex data
292	* @param Size - length of the sysex data (in bytes)
293	*/
294	void DispatchSysex(void* pData, uint Size);
295
296	protected:
297	MidiInputDevice* pDevice;
298	int portNumber;
299	std::map<String,DeviceRuntimeParameter*> Parameters; ///< All port parameters.
300	typedef std::set<EngineChannel*> MidiChannelMap_t[17];
301	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.
302	SynchronizedConfig<MidiChannelMap_t>::Reader MidiChannelMapReader; ///< MIDI thread access to MidiChannelMap
303	Mutex MidiChannelMapMutex; ///< Used to protect the MidiChannelMap from being used at the same time by different threads.
304	SynchronizedConfig<std::set<Engine*> >::Reader SysexListenersReader; ///< MIDI thread access to SysexListeners
305
306	/**
307	* Constructor
308	*/
309	MidiInputPort(MidiInputDevice* pDevice, int portNumber);
310
311	/**
312	* Destructor
313	*/
314	virtual ~MidiInputPort();
315
316	friend class MidiInputDevice;
317
318	private:
319	EngineChannel* pPreviousProgramChangeEngineChannel; ///< Points to the engine channel which was connected by the previous DispatchProgramChange() call.
320	static SynchronizedConfig<std::set<Engine*> > SysexListeners; ///< All engines that are listening to sysex messages.
321	};
322
323	} // namsepace LinuxSampler
324
325	#endif // __LS_MIDIINPUTPORT_H__