summaryrefslogtreecommitdiff
path: root/libs/surfaces/maschine2/m2controls.h
blob: a19e074d8d865aafe5aa7b71e4e8cbff41975be1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
 * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
 *
 * 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, 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 _ardour_surfaces_m2controls_h_
#define _ardour_surfaces_m2controls_h_

#include <map>

#include "m2_button.h"
#include "m2_encoder.h"
#include "m2_pad.h"

namespace ArdourSurface {

/** Abstraction for various variants:
 *  - NI Maschine Mikro
 *  - NI Maschine
 *  - NI Maschine Studio
 */

class M2Contols
{
	public:
		M2Contols () {}
		virtual ~M2Contols () {}

		typedef enum {
			ModNone = 0,
			ModShift,
		} Modifier;

		typedef enum {
			/* Transport */
			BtnRestart,
			BtnStepLeft,
			BtnStepRight,
			BtnGrid,
			BtnPlay,
			BtnRec,
			BtnErase,
			BtnShift,

			/* modes */
			BtnScene,
			BtnPattern,
			BtnPadMode,
			BtnNavigate, // aka. "view" on Mikro
			BtnDuplicate,
			BtnSelect,
			BtnSolo,
			BtnMute,

			/* global */
#if 0
			BtnArrange, // Studio only
			BtnMix,     // Studio only
#endif

			BtnControl, // Studio: "Channel"
			BtnStep,    // Studio: "Plug-In"
			BtnBrowse,
			BtnSampling,
			BtnSelLeft,
			BtnSelRight,
			BtnAll,
			BtnAuto,

			/* master */
			BtnVolume,
			BtnSwing,
			BtnTempo,
			BtnNavLeft,
			BtnNavRight,
			BtnEnter,
			BtnNoteRepeat, // Tap
			BtnWheel, // Encoder Push

			/* Selectors above display */
			BtnTop0, BtnTop1, BtnTop2, BtnTop3, // Mikro F1, F2, F3
			BtnTop4, BtnTop5, BtnTop6, BtnTop7,

			/* Maschine & Studio "Groups" */
			BtnGroupA, BtnGroupB, BtnGroupC, BtnGroupD,
			BtnGroupE, BtnGroupF, BtnGroupG, BtnGroupH,

#if 1 // Studio only -- Edit
			BtnCopy,
			BtnPaste,
			BtnNote,
			BtnNudge,
			BtnUndo,
			BtnRedo,
			BtnQuantize,
			BtnClear,

			BtnIn1, BtnIn2, BtnIn3, BtnIn4,
			BtnMst, BtnGrp, BtnSnd, BtnCue,
#endif
		} PhysicalButtonId;

		typedef enum {
			Play,
			Rec,
			Loop,
			Metronom,
			GotoStart,
			GotoEnd,
			JumpBackward,
			JumpForward,
			FastRewind,
			FastForward,
			Grid,
			Delete,
			Undo, Redo,
			Save,
			EncoderWheel, // multi-purpose
			MasterVolume,
			MasterTempo,
			Solo, Mute,
			Panic
		} SemanticButtonId;

		typedef std::map <PhysicalButtonId, M2ButtonInterface*> PhysicalMap;
		typedef std::map <SemanticButtonId, M2ButtonInterface*> SematicMap;

		virtual M2ButtonInterface* button (PhysicalButtonId id, Modifier m) {
			if (id == BtnShift) {
				return &_shift;
			}
			return &_dummy_button;
		}

		virtual M2ButtonInterface* button (SemanticButtonId id) {
			return &_dummy_button;
		}

		virtual M2EncoderInterface* encoder (unsigned int id) {
			return &_dummy_encoder;
		}

		virtual M2PadInterface* pad (unsigned int id) {
			return &_dummy_pad;
		}

	protected:
		M2ButtonInterface  _dummy_button;
		M2EncoderInterface _dummy_encoder;
		M2PadInterface     _dummy_pad;

		M2ToggleHoldButton  _shift;
};

} /* namespace */
#endif /* _ardour_surfaces_m2controls_h_*/