trunk/src/qsamplerDevice.h

// qsamplerDevice.h
//
/****************************************************************************
   Copyright (C) 2004-2007, rncbc aka Rui Nuno Capela. All rights reserved.
   Copyright (C) 2007, 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.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#ifndef __qsamplerDevice_h
#define __qsamplerDevice_h

#include <QListWidget>
#include <QListWidgetItem>
#include <QTreeWidgetItem>
#include <QTableWidget>
#include <QTableWidgetItem>
#include <QAbstractTableModel>
#include <QItemDelegate>
#include <QFontMetrics>
#include <QModelIndex>
#include <QSize>
#include <QList>

#include <lscp/client.h>
#include <lscp/device.h>

#include "qsamplerOptions.h"


// Special QListViewItem::rtti() unique return value.
#define QSAMPLER_DEVICE_ITEM    1001

// Early forward declarations.
class qsamplerMainForm;
class qsamplerDevicePort;


//-------------------------------------------------------------------------
// qsamplerDeviceParam - MIDI/Audio Device parameter structure.
//
class qsamplerDeviceParam
{
public:

        // Constructor.
        qsamplerDeviceParam(lscp_param_info_t *pParamInfo = NULL,
                const char *pszValue = NULL);
        // Default destructor.
        ~qsamplerDeviceParam();

        // Initializer.
        void setParam(lscp_param_info_t *pParamInfo,
                const char *pszValue = NULL);

        // Info structure field members.
        lscp_type_t     type;
        QString         description;
        bool            mandatory;
        bool            fix;
        bool            multiplicity;
        QStringList depends;
        QString         defaultv;
        QString         range_min;
        QString         range_max;
        QStringList possibilities;
        // The current parameter value.
        QString         value;
};

// Typedef'd parameter QMap.
typedef QMap<QString, qsamplerDeviceParam> qsamplerDeviceParamMap;

// Typedef'd device port/channels QptrList.
typedef QList<qsamplerDevicePort *> qsamplerDevicePortList;


//-------------------------------------------------------------------------
// qsamplerDevice - MIDI/Audio Device structure.
//

class qsamplerDevice
{
public:

        // We use the same class for MIDI and audio device management
        enum DeviceType { None, Midi, Audio };

        // Constructor.
        qsamplerDevice(DeviceType deviceType, int iDeviceID = -1);
        // Copy constructor.
        qsamplerDevice(const qsamplerDevice& device);
        // Default destructor.
        ~qsamplerDevice();

        // Initializer.
        void setDevice(DeviceType deviceType, int iDeviceID = -1);

        // Driver name initializer.
        void setDriver(const QString& sDriverName);

        // Device property accessors.
        int            deviceID() const;
        DeviceType     deviceType() const;
        const QString& deviceTypeName() const;
        const QString& driverName() const;

        // Special device name formatter.
        QString deviceName() const;

        // Set the proper device parameter value.
        bool setParam (const QString& sParam, const QString& sValue);

        // Device parameters accessor.
        const qsamplerDeviceParamMap& params() const;

        // Device port/channel list accessor.
        qsamplerDevicePortList& ports();

        // Device parameter dependency list refreshner.
        int refreshParams();
        // Device port/channel list refreshner.
        int refreshPorts();
        // Refresh/set dependencies given that some parameter has changed.
        int refreshDepends(const QString& sParam);

        // Create/destroy device methods.
        bool createDevice();
        bool deleteDevice();

        // Message logging methods (brainlessly mapped to main form's).
        void appendMessages       (const QString& s) const;
        void appendMessagesColor  (const QString& s, const QString & c) const;
        void appendMessagesText   (const QString& s) const;
        void appendMessagesError  (const QString& s) const;
        void appendMessagesClient (const QString& s) const;

        // Device ids enumerator.
        static int *getDevices(lscp_client_t *pClient,
                DeviceType deviceType);

        // Driver names enumerator.
        static QStringList getDrivers(lscp_client_t *pClient,
                DeviceType deviceType);

private:

        // Refresh/set given parameter based on driver supplied dependencies.
        int refreshParam(const QString& sParam);

        // Instance variables.
        int        m_iDeviceID;
        DeviceType m_deviceType;
        QString    m_sDeviceType;
        QString    m_sDriverName;
        QString    m_sDeviceName;

        // Device parameter list.
        qsamplerDeviceParamMap m_params;

        // Device port/channel list.
        qsamplerDevicePortList m_ports;
};


//-------------------------------------------------------------------------
// qsamplerDevicePort - MIDI/Audio Device port/channel structure.
//

class qsamplerDevicePort
{
public:

        // Constructor.
        qsamplerDevicePort(qsamplerDevice& device, int iPortID);
        // Default destructor.
        ~qsamplerDevicePort();

        // Initializer.
        void setDevicePort(int iPortID);

        // Device port property accessors.
        int            portID()   const;
        const QString& portName() const;

        // Device port parameters accessor.
        const qsamplerDeviceParamMap& params() const;

        // Set the proper device port/channel parameter value.
        bool setParam (const QString& sParam, const QString& sValue);

private:

        // Device reference.
        qsamplerDevice& m_device;

        // Instance variables.
        int     m_iPortID;
        QString m_sPortName;

        // Device port parameter list.
        qsamplerDeviceParamMap m_params;
};


//-------------------------------------------------------------------------
// qsamplerDeviceItem - QListView device item.
//

class qsamplerDeviceItem : public QTreeWidgetItem
{
public:

        // Constructors.
        qsamplerDeviceItem(QTreeWidget *pTreeWidget,
                qsamplerDevice::DeviceType deviceType);
        qsamplerDeviceItem(QTreeWidgetItem *pItem,
                qsamplerDevice::DeviceType deviceType, int iDeviceID);
        // Default destructor.
        ~qsamplerDeviceItem();

        // Instance accessors.
        qsamplerDevice& device();

private:

        // Instance variables.
        qsamplerDevice m_device;
};

struct DeviceParameterRow {
        QString             name;
        qsamplerDeviceParam param;
        bool                alive; // whether these params refer to an existing device or for a device that is yet to be created
};

// so we can use it i.e. through QVariant
Q_DECLARE_METATYPE(DeviceParameterRow)


//-------------------------------------------------------------------------
// AbstractDeviceParamModel - data model base class for device parameters
//
class AbstractDeviceParamModel : public QAbstractTableModel
{
        Q_OBJECT

public:

        AbstractDeviceParamModel(QObject *pParent = NULL);

        // Overridden methods from subclass(es)
        int rowCount(const QModelIndex& parent = QModelIndex()) const;
        int columnCount(const QModelIndex& parent = QModelIndex() ) const;
        QVariant headerData(int section,
                Qt::Orientation orientation, int role = Qt::DisplayRole) const;
        Qt::ItemFlags flags(const QModelIndex& index) const;

        virtual void clear();

        void refresh(const qsamplerDeviceParamMap* params, bool bEditable);

protected:

        const qsamplerDeviceParamMap *m_pParams;
        bool m_bEditable;
};


//-------------------------------------------------------------------------
// DeviceParamModel - data model for device parameters (used for QTableView)
//

class DeviceParamModel : public AbstractDeviceParamModel
{
        Q_OBJECT

public:

        DeviceParamModel(QObject *pParent = NULL);

        // Overridden methods from subclass(es)
        QVariant data(const QModelIndex &index, int role) const;
        bool setData(const QModelIndex& index,
                const QVariant& value, int role = Qt::EditRole);

        void clear();

public slots:

        void refresh(qsamplerDevice* pDevice, bool bEditable);

private:

        qsamplerDevice *m_pDevice;
};


//-------------------------------------------------------------------------
// PortParamModel - data model for port parameters (used for QTableView)
//

class PortParamModel : public AbstractDeviceParamModel
{
        Q_OBJECT

public:

        PortParamModel(QObject *pParent = 0);

        // overridden methods from subclass(es)
        QVariant data(const QModelIndex &index, int role) const;
        bool setData(const QModelIndex& index,
                const QVariant& value, int role = Qt::EditRole);

        void clear();

public slots:

        void refresh(qsamplerDevicePort* pPort, bool bEditable);

private:

        qsamplerDevicePort* m_pPort;
};


//-------------------------------------------------------------------------
// DeviceParamDelegate - table cell renderer for device/port parameters
//
class DeviceParamDelegate : public QItemDelegate
{
        Q_OBJECT

public:

        DeviceParamDelegate(QObject *pParent = NULL);

        QWidget* createEditor(QWidget *pParent,
                const QStyleOptionViewItem& option, const QModelIndex& index) const;
        void setEditorData(QWidget *pEditor, const QModelIndex& index) const;
        void setModelData(QWidget *pEditor, QAbstractItemModel *pModel,
                const QModelIndex& index) const;
        void updateEditorGeometry(QWidget* pEditor,
                const QStyleOptionViewItem& option, const QModelIndex& index) const;
};

#endif  // __qsamplerDevice_h

// end of qsamplerDevice.h
1	// qsamplerDevice.h
2	//
3	/****************************************************************************
4	Copyright (C) 2004-2007, rncbc aka Rui Nuno Capela. All rights reserved.
5	Copyright (C) 2007, Christian Schoenebeck
6
7	This program is free software; you can redistribute it and/or
8	modify it under the terms of the GNU General Public License
9	as published by the Free Software Foundation; either version 2
10	of the License, or (at your option) any later version.
11
12	This program is distributed in the hope that it will be useful,
13	but WITHOUT ANY WARRANTY; without even the implied warranty of
14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15	GNU General Public License for more details.
16
17	You should have received a copy of the GNU General Public License along
18	with this program; if not, write to the Free Software Foundation, Inc.,
19	51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20
21	*****************************************************************************/
22
23	#ifndef __qsamplerDevice_h
24	#define __qsamplerDevice_h
25
26	#include <QListWidget>
27	#include <QListWidgetItem>
28	#include <QTreeWidgetItem>
29	#include <QTableWidget>
30	#include <QTableWidgetItem>
31	#include <QAbstractTableModel>
32	#include <QItemDelegate>
33	#include <QFontMetrics>
34	#include <QModelIndex>
35	#include <QSize>
36	#include <QList>
37
38	#include <lscp/client.h>
39	#include <lscp/device.h>
40
41	#include "qsamplerOptions.h"
42
43
44	// Special QListViewItem::rtti() unique return value.
45	#define QSAMPLER_DEVICE_ITEM 1001
46
47	// Early forward declarations.
48	class qsamplerMainForm;
49	class qsamplerDevicePort;
50
51
52	//-------------------------------------------------------------------------
53	// qsamplerDeviceParam - MIDI/Audio Device parameter structure.
54	//
55	class qsamplerDeviceParam
56	{
57	public:
58
59	// Constructor.
60	qsamplerDeviceParam(lscp_param_info_t *pParamInfo = NULL,
61	const char *pszValue = NULL);
62	// Default destructor.
63	~qsamplerDeviceParam();
64
65	// Initializer.
66	void setParam(lscp_param_info_t *pParamInfo,
67	const char *pszValue = NULL);
68
69	// Info structure field members.
70	lscp_type_t type;
71	QString description;
72	bool mandatory;
73	bool fix;
74	bool multiplicity;
75	QStringList depends;
76	QString defaultv;
77	QString range_min;
78	QString range_max;
79	QStringList possibilities;
80	// The current parameter value.
81	QString value;
82	};
83
84	// Typedef'd parameter QMap.
85	typedef QMap<QString, qsamplerDeviceParam> qsamplerDeviceParamMap;
86
87	// Typedef'd device port/channels QptrList.
88	typedef QList<qsamplerDevicePort *> qsamplerDevicePortList;
89
90
91	//-------------------------------------------------------------------------
92	// qsamplerDevice - MIDI/Audio Device structure.
93	//
94
95	class qsamplerDevice
96	{
97	public:
98
99	// We use the same class for MIDI and audio device management
100	enum DeviceType { None, Midi, Audio };
101
102	// Constructor.
103	qsamplerDevice(DeviceType deviceType, int iDeviceID = -1);
104	// Copy constructor.
105	qsamplerDevice(const qsamplerDevice& device);
106	// Default destructor.
107	~qsamplerDevice();
108
109	// Initializer.
110	void setDevice(DeviceType deviceType, int iDeviceID = -1);
111
112	// Driver name initializer.
113	void setDriver(const QString& sDriverName);
114
115	// Device property accessors.
116	int deviceID() const;
117	DeviceType deviceType() const;
118	const QString& deviceTypeName() const;
119	const QString& driverName() const;
120
121	// Special device name formatter.
122	QString deviceName() const;
123
124	// Set the proper device parameter value.
125	bool setParam (const QString& sParam, const QString& sValue);
126
127	// Device parameters accessor.
128	const qsamplerDeviceParamMap& params() const;
129
130	// Device port/channel list accessor.
131	qsamplerDevicePortList& ports();
132
133	// Device parameter dependency list refreshner.
134	int refreshParams();
135	// Device port/channel list refreshner.
136	int refreshPorts();
137	// Refresh/set dependencies given that some parameter has changed.
138	int refreshDepends(const QString& sParam);
139
140	// Create/destroy device methods.
141	bool createDevice();
142	bool deleteDevice();
143
144	// Message logging methods (brainlessly mapped to main form's).
145	void appendMessages (const QString& s) const;
146	void appendMessagesColor (const QString& s, const QString & c) const;
147	void appendMessagesText (const QString& s) const;
148	void appendMessagesError (const QString& s) const;
149	void appendMessagesClient (const QString& s) const;
150
151	// Device ids enumerator.
152	static int getDevices(lscp_client_t pClient,
153	DeviceType deviceType);
154
155	// Driver names enumerator.
156	static QStringList getDrivers(lscp_client_t *pClient,
157	DeviceType deviceType);
158
159	private:
160
161	// Refresh/set given parameter based on driver supplied dependencies.
162	int refreshParam(const QString& sParam);
163
164	// Instance variables.
165	int m_iDeviceID;
166	DeviceType m_deviceType;
167	QString m_sDeviceType;
168	QString m_sDriverName;
169	QString m_sDeviceName;
170
171	// Device parameter list.
172	qsamplerDeviceParamMap m_params;
173
174	// Device port/channel list.
175	qsamplerDevicePortList m_ports;
176	};
177
178
179	//-------------------------------------------------------------------------
180	// qsamplerDevicePort - MIDI/Audio Device port/channel structure.
181	//
182
183	class qsamplerDevicePort
184	{
185	public:
186
187	// Constructor.
188	qsamplerDevicePort(qsamplerDevice& device, int iPortID);
189	// Default destructor.
190	~qsamplerDevicePort();
191
192	// Initializer.
193	void setDevicePort(int iPortID);
194
195	// Device port property accessors.
196	int portID() const;
197	const QString& portName() const;
198
199	// Device port parameters accessor.
200	const qsamplerDeviceParamMap& params() const;
201
202	// Set the proper device port/channel parameter value.
203	bool setParam (const QString& sParam, const QString& sValue);
204
205	private:
206
207	// Device reference.
208	qsamplerDevice& m_device;
209
210	// Instance variables.
211	int m_iPortID;
212	QString m_sPortName;
213
214	// Device port parameter list.
215	qsamplerDeviceParamMap m_params;
216	};
217
218
219	//-------------------------------------------------------------------------
220	// qsamplerDeviceItem - QListView device item.
221	//
222
223	class qsamplerDeviceItem : public QTreeWidgetItem
224	{
225	public:
226
227	// Constructors.
228	qsamplerDeviceItem(QTreeWidget *pTreeWidget,
229	qsamplerDevice::DeviceType deviceType);
230	qsamplerDeviceItem(QTreeWidgetItem *pItem,
231	qsamplerDevice::DeviceType deviceType, int iDeviceID);
232	// Default destructor.
233	~qsamplerDeviceItem();
234
235	// Instance accessors.
236	qsamplerDevice& device();
237
238	private:
239
240	// Instance variables.
241	qsamplerDevice m_device;
242	};
243
244	struct DeviceParameterRow {
245	QString name;
246	qsamplerDeviceParam param;
247	bool alive; // whether these params refer to an existing device or for a device that is yet to be created
248	};
249
250	// so we can use it i.e. through QVariant
251	Q_DECLARE_METATYPE(DeviceParameterRow)
252
253
254	//-------------------------------------------------------------------------
255	// AbstractDeviceParamModel - data model base class for device parameters
256	//
257	class AbstractDeviceParamModel : public QAbstractTableModel
258	{
259	Q_OBJECT
260
261	public:
262
263	AbstractDeviceParamModel(QObject *pParent = NULL);
264
265	// Overridden methods from subclass(es)
266	int rowCount(const QModelIndex& parent = QModelIndex()) const;
267	int columnCount(const QModelIndex& parent = QModelIndex() ) const;
268	QVariant headerData(int section,
269	Qt::Orientation orientation, int role = Qt::DisplayRole) const;
270	Qt::ItemFlags flags(const QModelIndex& index) const;
271
272	virtual void clear();
273
274	void refresh(const qsamplerDeviceParamMap* params, bool bEditable);
275
276	protected:
277
278	const qsamplerDeviceParamMap *m_pParams;
279	bool m_bEditable;
280	};
281
282
283	//-------------------------------------------------------------------------
284	// DeviceParamModel - data model for device parameters (used for QTableView)
285	//
286
287	class DeviceParamModel : public AbstractDeviceParamModel
288	{
289	Q_OBJECT
290
291	public:
292
293	DeviceParamModel(QObject *pParent = NULL);
294
295	// Overridden methods from subclass(es)
296	QVariant data(const QModelIndex &index, int role) const;
297	bool setData(const QModelIndex& index,
298	const QVariant& value, int role = Qt::EditRole);
299
300	void clear();
301
302	public slots:
303
304	void refresh(qsamplerDevice* pDevice, bool bEditable);
305
306	private:
307
308	qsamplerDevice *m_pDevice;
309	};
310
311
312	//-------------------------------------------------------------------------
313	// PortParamModel - data model for port parameters (used for QTableView)
314	//
315
316	class PortParamModel : public AbstractDeviceParamModel
317	{
318	Q_OBJECT
319
320	public:
321
322	PortParamModel(QObject *pParent = 0);
323
324	// overridden methods from subclass(es)
325	QVariant data(const QModelIndex &index, int role) const;
326	bool setData(const QModelIndex& index,
327	const QVariant& value, int role = Qt::EditRole);
328
329	void clear();
330
331	public slots:
332
333	void refresh(qsamplerDevicePort* pPort, bool bEditable);
334
335	private:
336
337	qsamplerDevicePort* m_pPort;
338	};
339
340
341	//-------------------------------------------------------------------------
342	// DeviceParamDelegate - table cell renderer for device/port parameters
343	//
344	class DeviceParamDelegate : public QItemDelegate
345	{
346	Q_OBJECT
347
348	public:
349
350	DeviceParamDelegate(QObject *pParent = NULL);
351
352	QWidget* createEditor(QWidget *pParent,
353	const QStyleOptionViewItem& option, const QModelIndex& index) const;
354	void setEditorData(QWidget *pEditor, const QModelIndex& index) const;
355	void setModelData(QWidget pEditor, QAbstractItemModel pModel,
356	const QModelIndex& index) const;
357	void updateEditorGeometry(QWidget* pEditor,
358	const QStyleOptionViewItem& option, const QModelIndex& index) const;
359	};
360
361	#endif // __qsamplerDevice_h
362
363	// end of qsamplerDevice.h