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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
package org.bukkit;
import java.util.HashMap;
import java.util.Map;
/**
* A note class to store a specific note.
*/
public class Note {
/**
* An enum holding tones.
*/
public enum Tone {
F((byte) -0x1, true),
G((byte) 0x1, true),
A((byte) 0x3, true),
B((byte) 0x5, false),
C((byte) 0x6, true),
D((byte) 0x8, true),
E((byte) 0xA, false);
private final boolean sharpable;
private final byte id;
private static final Map<Byte, Note.Tone> tones = new HashMap<Byte, Note.Tone>();
/** The number of tones including sharped tones. */
public static final byte TONES_COUNT;
private Tone(byte id, boolean sharpable) {
this.id = id;
this.sharpable = sharpable;
}
/**
* Returns the not sharped id of this tone.
*
* @return the not sharped id of this tone.
*/
public byte getId() {
return getId(false);
}
/**
* Returns the id of this tone. These method allows to return the
* sharped id of the tone. If the tone couldn't be sharped it always
* return the not sharped id of this tone.
*
* @param sharped
* Set to true to return the sharped id.
* @return the id of this tone.
*/
public byte getId(boolean sharped) {
byte tempId = (byte) (sharped && sharpable ? id + 1 : id);
while (tempId < 0) {
tempId += TONES_COUNT;
}
return (byte) (tempId % TONES_COUNT);
}
/**
* Returns if this tone could be sharped.
*
* @return if this tone could be sharped.
*/
public boolean isSharpable() {
return sharpable;
}
/**
* Returns if this tone id is the sharped id of the tone.
*
* @param id
* the id of the tone.
* @return if the tone id is the sharped id of the tone.
* @throws IllegalArgumentException
* if neither the tone nor the semitone have the id.
*/
public boolean isSharped(byte id) {
if (id == getId(false)) {
return false;
} else if (id == getId(true)) {
return true;
} else {
// The id isn't matching to the tone!
throw new IllegalArgumentException("The id isn't matching to the tone.");
}
}
/**
* Returns the tone to id. Also returning the semitones.
*
* @param id
* the id of the tone.
* @return the tone to id.
*/
public static Tone getToneById(byte id) {
return tones.get(id);
}
static {
byte lowest = F.id;
byte highest = F.id;
for (Tone tone : Tone.values()) {
byte id = tone.id;
tones.put(id, tone);
if (id < lowest) {
lowest = id;
}
if (tone.isSharpable()) {
id++;
tones.put(id, tone);
}
if (id > highest) {
highest = id;
}
}
TONES_COUNT = (byte) (highest - lowest + 1);
tones.put((byte) (TONES_COUNT - 1), F);
}
}
private final byte note;
/**
* Creates a new note.
*
* @param note
* Internal note id. {@link #getId()} always return this value.
* The value has to be in the interval [0; 24].
*/
public Note(byte note) {
if (note < 0 || note > 24) {
throw new IllegalArgumentException("The note value has to be between 0 and 24.");
}
this.note = note;
}
/**
* Creates a new note.
*
* @param octave
* The octave where the note is in. Has to be 0 - 2.
* @param note
* The tone within the octave. If the octave is 2 the note has to
* be F#.
* @param sharped
* Set it the tone is sharped (e.g. for F#).
*/
public Note(byte octave, Tone note, boolean sharped) {
if (sharped && !note.isSharpable()) {
throw new IllegalArgumentException("This tone could not be sharped.");
}
if (octave < 0 || octave > 2 || (octave == 2 && !(note == Tone.F && sharped))) {
throw new IllegalArgumentException("Tone and octave have to be between F#0 and F#2");
}
this.note = (byte) (octave * Tone.TONES_COUNT + note.getId(sharped));
}
/**
* Returns the internal id of this note.
*
* @return the internal id of this note.
*/
public byte getId() {
return note;
}
/**
* Returns the octave of this note.
*
* @return the octave of this note.
*/
public int getOctave() {
return note / Tone.TONES_COUNT;
}
private byte getToneByte() {
return (byte) (note % Tone.TONES_COUNT);
}
/**
* Returns the tone of this note.
*
* @return the tone of this note.
*/
public Tone getTone() {
return Tone.getToneById(getToneByte());
}
/**
* Returns if this note is sharped.
*
* @return if this note is sharped.
*/
public boolean isSharped() {
byte note = getToneByte();
return Tone.getToneById(note).isSharped(note);
}
}
|
