trunk/src/qsamplerChannel.h

// qsamplerChannel.h
//
/****************************************************************************
   Copyright (C) 2004-2012, 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 __qsamplerChannel_h
#define __qsamplerChannel_h

#include <QTableWidgetItem>
#include <QItemDelegate>

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

#include "qsamplerOptions.h"

namespace QSampler {

class Device;

// Typedef'd QMap.
typedef QMap<int, int> ChannelRoutingMap;


//-------------------------------------------------------------------------
// QSampler::Channel - Sampler channel structure.
//

class Channel
{
public:

        // Constructor.
        Channel(int iChannelID = -1);
        // Default destructor.
        ~Channel();

        // Add/remove sampler channel methods.
        bool     addChannel();
        bool     removeChannel();

        // Sampler channel ID accessors.
        int      channelID() const;
        void     setChannelID(int iChannelID);

        // Readable channel name.
        QString  channelName() const;

        // Engine name property.
        const QString& engineName() const;
        bool     loadEngine(const QString& sEngineName);

        // Instrument file and index.
        const QString& instrumentFile() const;
        int      instrumentNr() const;
        const QString& instrumentName() const;
        int      instrumentStatus() const;

        // Instrument file loader.
        bool     loadInstrument(const QString& sInstrumentFile, int iInstrumentNr);
        // Special instrument file/name/number settler.
        bool     setInstrument(const QString& sInstrumentFile, int iInstrumentNr);

        // MIDI input driver (DEPRECATED).
        const QString& midiDriver() const;
        bool     setMidiDriver(const QString& sMidiDriver);

        // MIDI input device.
        int      midiDevice() const;
        bool     setMidiDevice(int iMidiDevice);

        // MIDI input port.
        int      midiPort() const;
        bool     setMidiPort(int iMidiPort);

        // MIDI input channel.
        int      midiChannel() const;
        bool     setMidiChannel(int iMidiChannel);

        // MIDI instrument map.
        int      midiMap() const;
        bool     setMidiMap(int iMidiMap);

        // Audio output driver (DEPRECATED).
        const QString& audioDriver() const;
        bool     setAudioDriver(const QString& sAudioDriver);

        // Audio output device.
        int      audioDevice() const;
        bool     setAudioDevice(int iAudioDevice);

        // Sampler channel volume.
        float    volume() const;
        bool     setVolume(float fVolume);

        // Sampler channel mute state.
        bool     channelMute() const;
        bool     setChannelMute(bool bMute);

        // Sampler channel solo state.
        bool     channelSolo() const;
        bool     setChannelSolo(bool bSolo);

        // Audio routing accessors.
        int      audioChannel(int iAudioOut) const;
        bool     setAudioChannel(int iAudioOut, int iAudioIn);
        // The audio routing map itself.
        const ChannelRoutingMap& audioRouting() const;

        // Istrument name remapper.
        void     updateInstrumentName();

        // Channel info structure map executive.
        bool     updateChannelInfo();

        // Channel setup dialog form.
        bool     channelSetup(QWidget *pParent);

        // Reset channel method.
        bool     channelReset();

        // Spawn instrument editor method.
        bool     editChannel();

        // 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;

        // Context menu event handler.
        void contextMenuEvent(QContextMenuEvent *pEvent);

        // Common (invalid) name-helpers.
        static QString noEngineName();
        static QString noInstrumentName();
        static QString loadingInstrument();

        // Check whether a given file is an instrument file.
        static bool isDlsInstrumentFile (const QString& sInstrumentFile);

        // Retrieve the available instrument name(s) of an instrument file (.gig).
        static QString getInstrumentName (const QString& sInstrumentFile,
                                                        int iInstrumentNr, bool bInstrumentNames);
        static QStringList getInstrumentList (const QString& sInstrumentFile,
                                                        bool bInstrumentNames);

private:

        // Unique channel identifier.
        int     m_iChannelID;

        // Sampler channel info map.
        QString m_sEngineName;
        QString m_sInstrumentName;
        QString m_sInstrumentFile;
        int     m_iInstrumentNr;
        int     m_iInstrumentStatus;
        QString m_sMidiDriver;
        int     m_iMidiDevice;
        int     m_iMidiPort;
        int     m_iMidiChannel;
        int     m_iMidiMap;
        QString m_sAudioDriver;
        int     m_iAudioDevice;
        float   m_fVolume;
        bool    m_bMute;
        bool    m_bSolo;

        // The audio routing mapping.
        ChannelRoutingMap m_audioRouting;
};


//-------------------------------------------------------------------------
// QSampler::ChannelRoutingModel - data model for audio routing
//                                 (used for QTableView)
//

struct ChannelRoutingItem {
        QStringList options;
        int         selection;
};

class ChannelRoutingModel : public QAbstractTableModel
{
        Q_OBJECT
public:

        ChannelRoutingModel(QObject* pParent = NULL);

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

        // own methods
        ChannelRoutingMap routingMap() const { return m_routing; }

        void clear() { m_routing.clear(); }

public slots:

        void refresh(Device *pDevice,
                const ChannelRoutingMap& routing);

private:

        Device *m_pDevice;
        ChannelRoutingMap m_routing;
};


//-------------------------------------------------------------------------
// QSampler::ChannelRoutingDelegate - table cell renderer for audio routing
//

class ChannelRoutingDelegate : public QItemDelegate
{
        Q_OBJECT

public:

        ChannelRoutingDelegate(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* model,
                const QModelIndex& index) const;
        void updateEditorGeometry(QWidget *pEditor,
                const QStyleOptionViewItem& option, const QModelIndex& index) const;
};

} // namespace QSampler

// So we can use it i.e. through QVariant
Q_DECLARE_METATYPE(QSampler::ChannelRoutingItem)

#endif  // __qsamplerChannel_h


// end of qsamplerChannel.h
1	// qsamplerChannel.h
2	//
3	/****************************************************************************
4	Copyright (C) 2004-2012, 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 __qsamplerChannel_h
24	#define __qsamplerChannel_h
25
26	#include <QTableWidgetItem>
27	#include <QItemDelegate>
28
29	#include <lscp/client.h>
30	#include <lscp/device.h>
31
32	#include "qsamplerOptions.h"
33
34	namespace QSampler {
35
36	class Device;
37
38	// Typedef'd QMap.
39	typedef QMap<int, int> ChannelRoutingMap;
40
41
42	//-------------------------------------------------------------------------
43	// QSampler::Channel - Sampler channel structure.
44	//
45
46	class Channel
47	{
48	public:
49
50	// Constructor.
51	Channel(int iChannelID = -1);
52	// Default destructor.
53	~Channel();
54
55	// Add/remove sampler channel methods.
56	bool addChannel();
57	bool removeChannel();
58
59	// Sampler channel ID accessors.
60	int channelID() const;
61	void setChannelID(int iChannelID);
62
63	// Readable channel name.
64	QString channelName() const;
65
66	// Engine name property.
67	const QString& engineName() const;
68	bool loadEngine(const QString& sEngineName);
69
70	// Instrument file and index.
71	const QString& instrumentFile() const;
72	int instrumentNr() const;
73	const QString& instrumentName() const;
74	int instrumentStatus() const;
75
76	// Instrument file loader.
77	bool loadInstrument(const QString& sInstrumentFile, int iInstrumentNr);
78	// Special instrument file/name/number settler.
79	bool setInstrument(const QString& sInstrumentFile, int iInstrumentNr);
80
81	// MIDI input driver (DEPRECATED).
82	const QString& midiDriver() const;
83	bool setMidiDriver(const QString& sMidiDriver);
84
85	// MIDI input device.
86	int midiDevice() const;
87	bool setMidiDevice(int iMidiDevice);
88
89	// MIDI input port.
90	int midiPort() const;
91	bool setMidiPort(int iMidiPort);
92
93	// MIDI input channel.
94	int midiChannel() const;
95	bool setMidiChannel(int iMidiChannel);
96
97	// MIDI instrument map.
98	int midiMap() const;
99	bool setMidiMap(int iMidiMap);
100
101	// Audio output driver (DEPRECATED).
102	const QString& audioDriver() const;
103	bool setAudioDriver(const QString& sAudioDriver);
104
105	// Audio output device.
106	int audioDevice() const;
107	bool setAudioDevice(int iAudioDevice);
108
109	// Sampler channel volume.
110	float volume() const;
111	bool setVolume(float fVolume);
112
113	// Sampler channel mute state.
114	bool channelMute() const;
115	bool setChannelMute(bool bMute);
116
117	// Sampler channel solo state.
118	bool channelSolo() const;
119	bool setChannelSolo(bool bSolo);
120
121	// Audio routing accessors.
122	int audioChannel(int iAudioOut) const;
123	bool setAudioChannel(int iAudioOut, int iAudioIn);
124	// The audio routing map itself.
125	const ChannelRoutingMap& audioRouting() const;
126
127	// Istrument name remapper.
128	void updateInstrumentName();
129
130	// Channel info structure map executive.
131	bool updateChannelInfo();
132
133	// Channel setup dialog form.
134	bool channelSetup(QWidget *pParent);
135
136	// Reset channel method.
137	bool channelReset();
138
139	// Spawn instrument editor method.
140	bool editChannel();
141
142	// Message logging methods (brainlessly mapped to main form's).
143	void appendMessages (const QString & s) const;
144	void appendMessagesColor (const QString & s, const QString & c) const;
145	void appendMessagesText (const QString & s) const;
146	void appendMessagesError (const QString & s) const;
147	void appendMessagesClient (const QString & s) const;
148
149	// Context menu event handler.
150	void contextMenuEvent(QContextMenuEvent *pEvent);
151
152	// Common (invalid) name-helpers.
153	static QString noEngineName();
154	static QString noInstrumentName();
155	static QString loadingInstrument();
156
157	// Check whether a given file is an instrument file.
158	static bool isDlsInstrumentFile (const QString& sInstrumentFile);
159
160	// Retrieve the available instrument name(s) of an instrument file (.gig).
161	static QString getInstrumentName (const QString& sInstrumentFile,
162	int iInstrumentNr, bool bInstrumentNames);
163	static QStringList getInstrumentList (const QString& sInstrumentFile,
164	bool bInstrumentNames);
165
166	private:
167
168	// Unique channel identifier.
169	int m_iChannelID;
170
171	// Sampler channel info map.
172	QString m_sEngineName;
173	QString m_sInstrumentName;
174	QString m_sInstrumentFile;
175	int m_iInstrumentNr;
176	int m_iInstrumentStatus;
177	QString m_sMidiDriver;
178	int m_iMidiDevice;
179	int m_iMidiPort;
180	int m_iMidiChannel;
181	int m_iMidiMap;
182	QString m_sAudioDriver;
183	int m_iAudioDevice;
184	float m_fVolume;
185	bool m_bMute;
186	bool m_bSolo;
187
188	// The audio routing mapping.
189	ChannelRoutingMap m_audioRouting;
190	};
191
192
193	//-------------------------------------------------------------------------
194	// QSampler::ChannelRoutingModel - data model for audio routing
195	// (used for QTableView)
196	//
197
198	struct ChannelRoutingItem {
199	QStringList options;
200	int selection;
201	};
202
203	class ChannelRoutingModel : public QAbstractTableModel
204	{
205	Q_OBJECT
206	public:
207
208	ChannelRoutingModel(QObject* pParent = NULL);
209
210	// overridden methods from subclass(es)
211	int rowCount(const QModelIndex& parent = QModelIndex()) const;
212	int columnCount(const QModelIndex& parent = QModelIndex()) const;
213	Qt::ItemFlags flags(const QModelIndex& index) const;
214	bool setData(const QModelIndex& index, const QVariant& value,
215	int role = Qt::EditRole);
216	QVariant data(const QModelIndex &index, int role) const;
217	QVariant headerData(int section, Qt::Orientation orientation,
218	int role = Qt::DisplayRole) const;
219
220	// own methods
221	ChannelRoutingMap routingMap() const { return m_routing; }
222
223	void clear() { m_routing.clear(); }
224
225	public slots:
226
227	void refresh(Device *pDevice,
228	const ChannelRoutingMap& routing);
229
230	private:
231
232	Device *m_pDevice;
233	ChannelRoutingMap m_routing;
234	};
235
236
237	//-------------------------------------------------------------------------
238	// QSampler::ChannelRoutingDelegate - table cell renderer for audio routing
239	//
240
241	class ChannelRoutingDelegate : public QItemDelegate
242	{
243	Q_OBJECT
244
245	public:
246
247	ChannelRoutingDelegate(QObject* pParent = NULL);
248
249	QWidget* createEditor(QWidget *pParent,
250	const QStyleOptionViewItem& option, const QModelIndex& index) const;
251	void setEditorData(QWidget *pEditor, const QModelIndex& index) const;
252	void setModelData(QWidget pEditor, QAbstractItemModel model,
253	const QModelIndex& index) const;
254	void updateEditorGeometry(QWidget *pEditor,
255	const QStyleOptionViewItem& option, const QModelIndex& index) const;
256	};
257
258	} // namespace QSampler
259
260	// So we can use it i.e. through QVariant
261	Q_DECLARE_METATYPE(QSampler::ChannelRoutingItem)
262
263	#endif // __qsamplerChannel_h
264
265
266	// end of qsamplerChannel.h