drivers/midi/MidiInputDeviceFactory.cpp

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

#include "MidiInputDeviceFactory.h"

#include "../../common/global_private.h"

#if HAVE_ALSA
# include "MidiInputDeviceAlsa.h"
#endif // HAVE_ALSA

#if HAVE_COREMIDI
# include "MidiInputDeviceCoreMidi.h"
#endif // HAVE_CORE_MIDI

#if HAVE_MIDISHARE
# include "MidiInputDeviceMidiShare.h"
#endif // HAVE_MIDISHARE

#if HAVE_MME_MIDI
# include "MidiInputDeviceMme.h"
#endif // HAVE_MME_MIDI

#if HAVE_JACK_MIDI
# include "MidiInputDeviceJack.h"
#endif // HAVE_JACK_MIDI

namespace LinuxSampler {

    std::map<String, MidiInputDeviceFactory::InnerFactory*> MidiInputDeviceFactory::InnerFactories;
    std::map<String, DeviceParameterFactory*> MidiInputDeviceFactory::ParameterFactories;

#if HAVE_ALSA
    REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceAlsa);
    /* Common parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterActive);
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterPorts);
    /* Driver specific parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterName);
#endif // HAVE_ALSA

#if HAVE_COREMIDI
    REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceCoreMidi);
    /* Common parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceCoreMidi, ParameterActive);
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceCoreMidi, ParameterPorts);
#endif // HAVE_COREMIDI

#if HAVE_MIDISHARE
    REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceMidiShare);
    /* Common parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMidiShare, ParameterActive);
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMidiShare, ParameterPorts);
#endif // HAVE_MIDISHARE

#if HAVE_MME_MIDI
    REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceMme);
    /* Common parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMme, ParameterActive);
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMme, ParameterPorts);
#endif // HAVE_MME_MIDI

#if HAVE_JACK_MIDI
    REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceJack);
    /* Common parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterActive);
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterPorts);
    /* Driver specific parameters */
    REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterName);
#endif // HAVE_JACK_MIDI

    MidiInputDeviceFactory::MidiInputDeviceMap MidiInputDeviceFactory::mMidiInputDevices;

    /**
     * Creates a new MIDI input device for the given driver name and
     * parameters. Note, this method will also check whether it is actually
     * allowed to create an instance of the given driver on its own and throw
     * an Exception in case it is not allowed (this is the case for host plugin
     * drivers like VST, AU, DSSI, LV2).
     *
     * @param DriverName - name of the driver of which a new device shall be created
     * @param Parameters - device creation parameters which shall be passed to the driver's constructor
     * @param pSampler - the sampler instance
     *
     * @returns pointer to the new device instance
     * @throws Exception - in case the device could not be created
     *
     * @see CreatePrivate()
     */
    MidiInputDevice* MidiInputDeviceFactory::Create(String DriverName, std::map<String,String> Parameters, Sampler* pSampler) throw (Exception) {
        if (!InnerFactories.count(DriverName))
            throw Exception("There is no midi input driver '" + DriverName + "'.");
        if (!InnerFactories[DriverName]->isAutonomousDriver())
            throw Exception("You cannot directly create a new MIDI input device of the '" + DriverName + "' driver!");

        return CreatePrivate(DriverName, Parameters, pSampler);
    }

    /**
     * Same as Create(), but this method won't check whether it is allowed to
     * create an instance of the given driver on its own. This method is
     * usually called by host plugins (e.g. VST, AU, DSSI, LV2) to actually
     * create their respective MIDI input devices for the sampler. Usually one
     * shouldn't call this method directly, but call Create() instead.
     */
    MidiInputDevice* MidiInputDeviceFactory::CreatePrivate(String DriverName, std::map<String,String> Parameters, Sampler* pSampler) throw (Exception) {
        if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
        // let's see if we need to create parameters
        std::map<String,DeviceCreationParameter*> thisDeviceParams;
        DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
        if (pParamFactory) {
            thisDeviceParams = pParamFactory->CreateAllParams(Parameters);
        } else {
            // no parameters are registered by the driver. Throw if any parameters were specified.
            if (Parameters.size() != 0) throw Exception("Driver '" + DriverName + "' does not have any parameters.");
        }

        // get a free device id
        int iDeviceId = -1;
        for (int i = 0; i >= 0; i++) { // seek for a free place starting from the beginning
            if (!mMidiInputDevices[i]) {
                iDeviceId = i;
                break;
            }
        }
        if (iDeviceId < 0)
            throw Exception("Could not retrieve free device ID!");

        // now create the device using those parameters
        MidiInputDevice* pDevice = InnerFactories[DriverName]->Create(thisDeviceParams, pSampler);
        pDevice->setDeviceId(iDeviceId);
        // now attach all parameters to the newely created device.
        for (std::map<String,DeviceCreationParameter*>::iterator iter = thisDeviceParams.begin(); iter != thisDeviceParams.end(); iter++) {
            iter->second->Attach(pDevice);
        }

        // add new audio device to the audio device list
        mMidiInputDevices[iDeviceId] = pDevice;

        return pDevice;
    }

    std::vector<String> MidiInputDeviceFactory::AvailableDrivers() {
        std::vector<String> result;
        std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
        while (iter != InnerFactories.end()) {
            result.push_back(iter->first);
            iter++;
        }
        return result;
    }

    String MidiInputDeviceFactory::AvailableDriversAsString() {
        std::vector<String> drivers = AvailableDrivers();
        String result;
        std::vector<String>::iterator iter = drivers.begin();
        for (; iter != drivers.end(); iter++) {
            if (result != "") result += ",";
            result += *iter;
        }
        return result;
    }

    std::map<String,DeviceCreationParameter*> MidiInputDeviceFactory::GetAvailableDriverParameters(String DriverName) throw (Exception) {
        if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
        std::map<String,DeviceCreationParameter*> thisDeviceParams;
        DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
        if (pParamFactory) {
            thisDeviceParams = pParamFactory->CreateAllParams();
        }
        return thisDeviceParams;
    }

    DeviceCreationParameter* MidiInputDeviceFactory::GetDriverParameter(String DriverName, String ParameterName) throw (Exception) {
        if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
        DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
        if (pParamFactory) {
            try { return pParamFactory->Create(ParameterName); }
            catch(Exception e) { }
        }
        throw Exception("Midi input driver '" + DriverName + "' does not have a parameter '" + ParameterName + "'.");
    }

    String MidiInputDeviceFactory::GetDriverDescription(String DriverName) throw (Exception) {
        if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
        return InnerFactories[DriverName]->Description();
    }

    String MidiInputDeviceFactory::GetDriverVersion(String DriverName) throw (Exception) {
        if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
        return InnerFactories[DriverName]->Version();
    }

    std::map<uint, MidiInputDevice*> MidiInputDeviceFactory::Devices() {
        return mMidiInputDevices;
    }

    /**
     * Destroys the given device. Usually this method shouldn't be called
     * directly, Sampler::DestroyMidiInputDevice should be called instead,
     * since it also takes care whether some sampler channel is still using
     * the device, etc.
     */
    void MidiInputDeviceFactory::Destroy(MidiInputDevice* pDevice) throw (Exception) {
        if (pDevice && !pDevice->isAutonomousDevice())
            throw Exception("You cannot directly destroy this '" + pDevice->Driver() + "' device!");

        DestroyPrivate(pDevice);
    }

    void MidiInputDeviceFactory::DestroyPrivate(MidiInputDevice* pDevice) throw (Exception) {
        MidiInputDeviceMap::iterator iter = mMidiInputDevices.begin();
        for (; iter != mMidiInputDevices.end(); iter++) {
            if (iter->second == pDevice) {
                // disable device
                pDevice->StopListen();

                // remove device from the device list
                mMidiInputDevices.erase(iter);

                // destroy and free device from memory
                delete pDevice;

                break;
            }
        }
    }

} // namespace LinuxSampler
1	schoenebeck	201	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5			* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	1934	* Copyright (C) 2005 - 2009 Christian Schoenebeck *
7	schoenebeck	201	* *
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			#include "MidiInputDeviceFactory.h"
25
26	schoenebeck	1424	#include "../../common/global_private.h"
27
28	schoenebeck	289	#if HAVE_ALSA
29			# include "MidiInputDeviceAlsa.h"
30			#endif // HAVE_ALSA
31	schoenebeck	288
32	wylder	817	#if HAVE_COREMIDI
33	schoenebeck	361	# include "MidiInputDeviceCoreMidi.h"
34			#endif // HAVE_CORE_MIDI
35
36			#if HAVE_MIDISHARE
37			# include "MidiInputDeviceMidiShare.h"
38			#endif // HAVE_MIDISHARE
39
40	senoner	1481	#if HAVE_MME_MIDI
41			# include "MidiInputDeviceMme.h"
42			#endif // HAVE_MME_MIDI
43	persson	1651
44			#if HAVE_JACK_MIDI
45			# include "MidiInputDeviceJack.h"
46			#endif // HAVE_JACK_MIDI
47
48	schoenebeck	201	namespace LinuxSampler {
49
50			std::map<String, MidiInputDeviceFactory::InnerFactory*> MidiInputDeviceFactory::InnerFactories;
51			std::map<String, DeviceParameterFactory*> MidiInputDeviceFactory::ParameterFactories;
52
53	schoenebeck	289	#if HAVE_ALSA
54			REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceAlsa);
55			/* Common parameters */
56			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterActive);
57			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterPorts);
58	schoenebeck	1993	/* Driver specific parameters */
59			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceAlsa, ParameterName);
60	schoenebeck	289	#endif // HAVE_ALSA
61	schoenebeck	288
62	wylder	817	#if HAVE_COREMIDI
63	schoenebeck	361	REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceCoreMidi);
64			/* Common parameters */
65			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceCoreMidi, ParameterActive);
66			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceCoreMidi, ParameterPorts);
67	wylder	817	#endif // HAVE_COREMIDI
68	schoenebeck	361
69			#if HAVE_MIDISHARE
70			REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceMidiShare);
71			/* Common parameters */
72			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMidiShare, ParameterActive);
73			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMidiShare, ParameterPorts);
74			#endif // HAVE_MIDISHARE
75
76	senoner	1481	#if HAVE_MME_MIDI
77			REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceMme);
78			/* Common parameters */
79			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMme, ParameterActive);
80			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceMme, ParameterPorts);
81			#endif // HAVE_MME_MIDI
82
83	persson	1651	#if HAVE_JACK_MIDI
84			REGISTER_MIDI_INPUT_DRIVER(MidiInputDeviceJack);
85			/* Common parameters */
86			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterActive);
87			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterPorts);
88			/* Driver specific parameters */
89			REGISTER_MIDI_INPUT_DRIVER_PARAMETER(MidiInputDeviceJack, ParameterName);
90			#endif // HAVE_JACK_MIDI
91
92	schoenebeck	1934	MidiInputDeviceFactory::MidiInputDeviceMap MidiInputDeviceFactory::mMidiInputDevices;
93
94			/**
95			* Creates a new MIDI input device for the given driver name and
96			* parameters. Note, this method will also check whether it is actually
97			* allowed to create an instance of the given driver on its own and throw
98			* an Exception in case it is not allowed (this is the case for host plugin
99			* drivers like VST, AU, DSSI, LV2).
100			*
101			* @param DriverName - name of the driver of which a new device shall be created
102			* @param Parameters - device creation parameters which shall be passed to the driver's constructor
103			* @param pSampler - the sampler instance
104			*
105			* @returns pointer to the new device instance
106			* @throws Exception - in case the device could not be created
107			*
108			* @see CreatePrivate()
109			*/
110	schoenebeck	880	MidiInputDevice* MidiInputDeviceFactory::Create(String DriverName, std::map<String,String> Parameters, Sampler* pSampler) throw (Exception) {
111	schoenebeck	1934	if (!InnerFactories.count(DriverName))
112			throw Exception("There is no midi input driver '" + DriverName + "'.");
113			if (!InnerFactories[DriverName]->isAutonomousDriver())
114			throw Exception("You cannot directly create a new MIDI input device of the '" + DriverName + "' driver!");
115
116			return CreatePrivate(DriverName, Parameters, pSampler);
117			}
118
119			/**
120			* Same as Create(), but this method won't check whether it is allowed to
121			* create an instance of the given driver on its own. This method is
122			* usually called by host plugins (e.g. VST, AU, DSSI, LV2) to actually
123			* create their respective MIDI input devices for the sampler. Usually one
124			* shouldn't call this method directly, but call Create() instead.
125			*/
126			MidiInputDevice* MidiInputDeviceFactory::CreatePrivate(String DriverName, std::map<String,String> Parameters, Sampler* pSampler) throw (Exception) {
127	schoenebeck	880	if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
128	schoenebeck	1934	// let's see if we need to create parameters
129			std::map<String,DeviceCreationParameter*> thisDeviceParams;
130			DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
131			if (pParamFactory) {
132			thisDeviceParams = pParamFactory->CreateAllParams(Parameters);
133			} else {
134			// no parameters are registered by the driver. Throw if any parameters were specified.
135			if (Parameters.size() != 0) throw Exception("Driver '" + DriverName + "' does not have any parameters.");
136			}
137
138			// get a free device id
139			int iDeviceId = -1;
140			for (int i = 0; i >= 0; i++) { // seek for a free place starting from the beginning
141			if (!mMidiInputDevices[i]) {
142			iDeviceId = i;
143			break;
144			}
145			}
146			if (iDeviceId < 0)
147			throw Exception("Could not retrieve free device ID!");
148
149			// now create the device using those parameters
150			MidiInputDevice* pDevice = InnerFactories[DriverName]->Create(thisDeviceParams, pSampler);
151			pDevice->setDeviceId(iDeviceId);
152			// now attach all parameters to the newely created device.
153			for (std::map<String,DeviceCreationParameter*>::iterator iter = thisDeviceParams.begin(); iter != thisDeviceParams.end(); iter++) {
154			iter->second->Attach(pDevice);
155			}
156
157			// add new audio device to the audio device list
158			mMidiInputDevices[iDeviceId] = pDevice;
159
160			return pDevice;
161	schoenebeck	201	}
162
163			std::vector<String> MidiInputDeviceFactory::AvailableDrivers() {
164			std::vector<String> result;
165			std::map<String, InnerFactory*>::iterator iter = InnerFactories.begin();
166			while (iter != InnerFactories.end()) {
167			result.push_back(iter->first);
168			iter++;
169			}
170			return result;
171			}
172
173			String MidiInputDeviceFactory::AvailableDriversAsString() {
174			std::vector<String> drivers = AvailableDrivers();
175			String result;
176			std::vector<String>::iterator iter = drivers.begin();
177			for (; iter != drivers.end(); iter++) {
178			if (result != "") result += ",";
179			result += *iter;
180			}
181			return result;
182			}
183
184	schoenebeck	880	std::map<String,DeviceCreationParameter*> MidiInputDeviceFactory::GetAvailableDriverParameters(String DriverName) throw (Exception) {
185			if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
186	schoenebeck	1934	std::map<String,DeviceCreationParameter*> thisDeviceParams;
187			DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
188			if (pParamFactory) {
189			thisDeviceParams = pParamFactory->CreateAllParams();
190			}
191			return thisDeviceParams;
192	schoenebeck	201	}
193
194	schoenebeck	880	DeviceCreationParameter* MidiInputDeviceFactory::GetDriverParameter(String DriverName, String ParameterName) throw (Exception) {
195	iliev	1835	if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
196			DeviceParameterFactory* pParamFactory = ParameterFactories[DriverName];
197			if (pParamFactory) {
198			try { return pParamFactory->Create(ParameterName); }
199			catch(Exception e) { }
200			}
201			throw Exception("Midi input driver '" + DriverName + "' does not have a parameter '" + ParameterName + "'.");
202	schoenebeck	201	}
203
204	schoenebeck	880	String MidiInputDeviceFactory::GetDriverDescription(String DriverName) throw (Exception) {
205			if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
206	schoenebeck	201	return InnerFactories[DriverName]->Description();
207			}
208
209	schoenebeck	880	String MidiInputDeviceFactory::GetDriverVersion(String DriverName) throw (Exception) {
210			if (!InnerFactories.count(DriverName)) throw Exception("There is no midi input driver '" + DriverName + "'.");
211	schoenebeck	201	return InnerFactories[DriverName]->Version();
212			}
213
214	schoenebeck	1934	std::map<uint, MidiInputDevice*> MidiInputDeviceFactory::Devices() {
215			return mMidiInputDevices;
216			}
217
218			/**
219			* Destroys the given device. Usually this method shouldn't be called
220			* directly, Sampler::DestroyMidiInputDevice should be called instead,
221			* since it also takes care whether some sampler channel is still using
222			* the device, etc.
223			*/
224			void MidiInputDeviceFactory::Destroy(MidiInputDevice* pDevice) throw (Exception) {
225			if (pDevice && !pDevice->isAutonomousDevice())
226			throw Exception("You cannot directly destroy this '" + pDevice->Driver() + "' device!");
227
228			DestroyPrivate(pDevice);
229			}
230
231			void MidiInputDeviceFactory::DestroyPrivate(MidiInputDevice* pDevice) throw (Exception) {
232			MidiInputDeviceMap::iterator iter = mMidiInputDevices.begin();
233			for (; iter != mMidiInputDevices.end(); iter++) {
234			if (iter->second == pDevice) {
235			// disable device
236			pDevice->StopListen();
237
238			// remove device from the device list
239			mMidiInputDevices.erase(iter);
240
241			// destroy and free device from memory
242			delete pDevice;
243
244			break;
245			}
246			}
247			}
248
249	schoenebeck	201	} // namespace LinuxSampler