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
|
/*
* MIDIMacros.h
* ------------
* Purpose: Helper functions / classes for MIDI Macro functionality.
* Notes : (currently none)
* Authors: OpenMPT Devs
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
*/
#pragma once
enum
{
NUM_MACROS = 16, // number of parametered macros
MACRO_LENGTH = 32, // max number of chars per macro
};
#ifdef MODPLUG_TRACKER
#include "plugins/PluginStructs.h"
#endif // MODPLUG_TRACKER
OPENMPT_NAMESPACE_BEGIN
// Parametered macro presets
enum parameteredMacroType
{
sfx_unused = 0,
sfx_cutoff, // Type 1 - Z00 - Z7F controls resonant filter cutoff
sfx_reso, // Type 2 - Z00 - Z7F controls resonant filter resonance
sfx_mode, // Type 3 - Z00 - Z7F controls resonant filter mode (lowpass / highpass)
sfx_drywet, // Type 4 - Z00 - Z7F controls plugin Dry / Wet ratio
sfx_plug, // Type 5 - Z00 - Z7F controls a plugin parameter
sfx_cc, // Type 6 - Z00 - Z7F controls MIDI CC
sfx_channelAT, // Type 7 - Z00 - Z7F controls Channel Aftertouch
sfx_polyAT, // Type 8 - Z00 - Z7F controls Poly Aftertouch
sfx_pitch, // Type 9 - Z00 - Z7F controls Pitch Bend
sfx_custom,
sfx_max
};
// Fixed macro presets
enum fixedMacroType
{
zxx_unused = 0,
zxx_reso4Bit, // Type 1 - Z80 - Z8F controls resonant filter resonance
zxx_reso7Bit, // Type 2 - Z80 - ZFF controls resonant filter resonance
zxx_cutoff, // Type 3 - Z80 - ZFF controls resonant filter cutoff
zxx_mode, // Type 4 - Z80 - ZFF controls resonant filter mode (lowpass / highpass)
zxx_resomode, // Type 5 - Z80 - Z9F controls resonance + filter mode
zxx_channelAT, // Type 6 - Z80 - ZFF controls Channel Aftertouch
zxx_polyAT, // Type 7 - Z80 - ZFF controls Poly Aftertouch
zxx_pitch, // Type 8 - Z80 - ZFF controls Pitch Bend
zxx_custom,
zxx_max
};
// Global macro types
enum
{
MIDIOUT_START = 0,
MIDIOUT_STOP,
MIDIOUT_TICK,
MIDIOUT_NOTEON,
MIDIOUT_NOTEOFF,
MIDIOUT_VOLUME,
MIDIOUT_PAN,
MIDIOUT_BANKSEL,
MIDIOUT_PROGRAM,
};
struct MIDIMacroConfigData
{
// encoding is ASCII
char szMidiGlb[9][MACRO_LENGTH]; // Global MIDI macros
char szMidiSFXExt[16][MACRO_LENGTH]; // Parametric MIDI macros
char szMidiZXXExt[128][MACRO_LENGTH]; // Fixed MIDI macros
};
MPT_BINARY_STRUCT(MIDIMacroConfigData, 4896) // this is directly written to files, so the size must be correct!
class MIDIMacroConfig : public MIDIMacroConfigData
{
public:
MIDIMacroConfig() { Reset(); };
// Get macro type from a macro string
parameteredMacroType GetParameteredMacroType(uint32 macroIndex) const;
fixedMacroType GetFixedMacroType() const;
// Create a new macro
protected:
void CreateParameteredMacro(char (¶meteredMacro)[MACRO_LENGTH], parameteredMacroType macroType, int subType) const;
public:
void CreateParameteredMacro(uint32 macroIndex, parameteredMacroType macroType, int subType = 0)
{
CreateParameteredMacro(szMidiSFXExt[macroIndex], macroType, subType);
};
std::string CreateParameteredMacro(parameteredMacroType macroType, int subType = 0) const
{
char parameteredMacro[MACRO_LENGTH];
CreateParameteredMacro(parameteredMacro, macroType, subType);
return std::string(parameteredMacro);
};
protected:
void CreateFixedMacro(char (&fixedMacros)[128][MACRO_LENGTH], fixedMacroType macroType) const;
public:
void CreateFixedMacro(fixedMacroType macroType)
{
CreateFixedMacro(szMidiZXXExt, macroType);
};
#ifdef MODPLUG_TRACKER
bool operator== (const MIDIMacroConfig &other) const;
bool operator!= (const MIDIMacroConfig &other) const { return !(*this == other); }
// Translate macro type or macro string to macro name
CString GetParameteredMacroName(uint32 macroIndex, IMixPlugin *plugin = nullptr) const;
CString GetParameteredMacroName(parameteredMacroType macroType) const;
CString GetFixedMacroName(fixedMacroType macroType) const;
// Extract information from a parametered macro string.
int MacroToPlugParam(uint32 macroIndex) const;
int MacroToMidiCC(uint32 macroIndex) const;
// Check if any macro can automate a given plugin parameter
int FindMacroForParam(PlugParamIndex param) const;
#endif // MODPLUG_TRACKER
// Check if a given set of macros is the default IT macro set.
bool IsMacroDefaultSetupUsed() const;
// Reset MIDI macro config to default values.
void Reset();
// Clear all Zxx macros so that they do nothing.
void ClearZxxMacros();
// Sanitize all macro config strings.
void Sanitize();
// Fix old-format (not conforming to IT's MIDI macro definitions) MIDI config strings.
void UpgradeMacros();
protected:
// Helper function for FixMacroFormat()
void UpgradeMacroString(char *macro) const;
// Remove blanks and other unwanted characters from macro strings for internal usage.
std::string GetSafeMacro(const char *macro) const;
};
STATIC_ASSERT(sizeof(MIDIMacroConfig) == sizeof(MIDIMacroConfigData)); // this is directly written to files, so the size must be correct!
OPENMPT_NAMESPACE_END
|
