-
Notifications
You must be signed in to change notification settings - Fork 1
/
removeCourtesyAccidentals.qml
314 lines (267 loc) · 12 KB
/
removeCourtesyAccidentals.qml
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
//==============================================
// remove courtesy accidentals v1.0
//
// Copyright (C)2012-2019 Jörn Eichler (heuchi)
//
// 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 3 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, see <http://www.gnu.org/licenses/>.
//==============================================
import QtQuick 2.0
import QtQuick.Dialogs 1.2
import MuseScore 3.0
MuseScore {
version: "1.0"
description: "This plugin removes courtesy accidentals"
menuPath: "Plugins.Accidentals.Remove Courtesy Accidentals"
//pluginType: "dock"
requiresScore: true
// if nothing is selected process whole score
property bool processAll: false
MessageDialog {
id: versionError
visible: false
title: "Unsupported MuseScore Version"
text: "This plugin needs MuseScore v3.0.5 or higher"
onAccepted: { Qt.quit() }
}
// function tpcName
//
// return name of note
function tpcName(tpc) {
var tpcNames = new Array(
"Fbb", "Cbb", "Gbb", "Dbb", "Abb", "Ebb", "Bbb",
"Fb", "Cb", "Gb", "Db", "Ab", "Eb", "Bb",
"F", "C", "G", "D", "A", "E", "B",
"F#", "C#", "G#", "D#", "A#", "E#", "B#",
"F##", "C##", "G##", "D##", "A##", "E##", "B##"
);
return(tpcNames[tpc+1]);
}
// function processNote
//
// for each measure we create a table that contains
// the actual 'noteName' of each 'noteClass'
//
// a 'noteClass' is the natural name of a space
// or line of the staff and the octave:
// C5, F6, B3 are 'noteClass'
//
// a 'noteName' would be C, F#, Bb for example
// (we don't need the octave here)
//
// curMeasureArray[<noteClass>] = <noteName>
function processNote(note,curMeasureArray,keySig) {
var octave=Math.floor(note.pitch/12);
// correct octave for Cb and Cbb
if(note.tpc1 == 7 || note.tpc1 == 0) {
octave++; // belongs to higher octave
}
// correct octave for B# and B##
if(note.tpc1 == 26 || note.tpc1 == 33) {
octave--; // belongs to lower octave
}
var noteName = tpcName(note.tpc);
var noteClass = noteName.charAt(0)+octave;
// a tied back note never needs an accidental
if (note.tieBack != null) {
if(note.accidental != null) {
// security checks
var thisPitch = note.pitch;
var thisAcc = note.accidentalType;
// remove
note.accidentalType = Accidental.NONE;
// if pitch changed, we were wrong...
if(note.pitch != thisPitch) {
console.log("ERROR1: pitch of note changed!");
//note.color = "#ff0000";
note.accidentalType = thisAcc;
}
}
// if the tied back note is not part of
// the current key sig, we need to remeber it.
//if( ! (note.tpc > keySig+12 && note.tpc < keySig+20)) {
// curMeasureArray[noteClass]=noteName;
//}
// we're done for a tied back note.
return;
}
// check if current note needs acc
if(typeof curMeasureArray[noteClass] !== 'undefined') {
// we have information on the previous note
// in the same measure:
// if this note is the same noteClass and noteName
// it doesn't need an accidental
if(curMeasureArray[noteClass] == noteName) {
// remove accidental if present
if(note.accidental != null) {
// security checks
var thisPitch = note.pitch;
var thisAcc = note.accidentalType;
// remove
note.accidentalType = Accidental.NONE;
// if pitch changed, we were wrong...
if(note.pitch != thisPitch) {
console.log("ERROR2: pitch of note changed!");
//note.color = "#ff0000";
note.accidentalType = thisAcc;
}
}
}
} else {
// we don't have this note in the current measure
// so it depends on the current key signature
if(note.tpc > keySig+12 && note.tpc < keySig+20) {
// we don't need an accidental in the current key sig
// remove accidental if present
if(note.accidental != null) {
// security checks
var thisPitch = note.pitch;
var thisAcc = note.accidentalType;
// remove
note.accidentalType = Accidental.NONE;
// if pitch changed, we were wrong...
if(note.pitch != thisPitch) {
console.log("ERROR3: pitch of note changed!");
//note.color = "#ff0000";
note.accidentalType = thisAcc;
console.log("KeySig="+keySig+", tpc="+note.tpc);
}
}
}
}
curMeasureArray[noteClass]=noteName;
}
// function processPart
//
// do the actual work: process all given tracks in parallel
// add courtesy accidentals where needed.
//
// We go through all tracks simultaneously, because we also want courtesy
// accidentals for notes across different staves when they are in the
// same octave and for notes of different voices in the same octave
function processPart(cursor,endTick,startTrack,endTrack) {
if(processAll) {
// we need to reset track first, otherwise
// rewind(0) doesn't work correctly
// we need to set staffIdx and voice to
// get correct key signature.
cursor.staffIdx = startTrack / 4;
cursor.voice = 0;
cursor.rewind(0);
} else {
cursor.rewind(1);
// we need to set staffIdx and voice to
// get correct key signature.
cursor.staffIdx = startTrack / 4;
cursor.voice = 0;
}
var segment = cursor.segment;
// we use the cursor to know measure boundaries
// and to get the current key signature
var keySig = cursor.keySignature;
cursor.nextMeasure();
var curMeasureArray = new Array();
// we use a segment, because the cursor always proceeds to
// the next element in the given track and we don't know
// in which track the element is.
var inLastMeasure=false;
while(segment && (processAll || segment.tick < endTick)) {
// check if still inside same measure
if(!inLastMeasure && !(segment.tick < cursor.tick)) {
// new measure
curMeasureArray = new Array();
keySig = cursor.keySignature;
if(!cursor.nextMeasure()) {
inLastMeasure=true;
}
}
for(var track=startTrack; track<endTrack; track++) {
if(segment.elementAt(track) && segment.elementAt(track).type == Element.CHORD) {
// process graceNotes if present
if(segment.elementAt(track).graceNotes.length > 0) {
var graceChords = segment.elementAt(track).graceNotes;
for(var j=0;j<graceChords.length;j++) {
var notes = graceChords[j].notes;
for(var i=0;i<notes.length;i++) {
processNote(notes[i],curMeasureArray,keySig);
}
}
}
// process notes
var notes = segment.elementAt(track).notes;
for(var i=0;i<notes.length;i++) {
processNote(notes[i],curMeasureArray,keySig);
}
}
}
segment=segment.next;
}
}
function removeAcc() {
console.log("start remove courtesy accidentals");
//curScore.startCmd();
if (typeof curScore === 'undefined' || curScore == null) {
console.log("error: no score!");
Qt.quit();
}
// find selection
var startStaff;
var endStaff;
var endTick;
var cursor = curScore.newCursor();
cursor.rewind(1);
if(!cursor.segment) {
// no selection
console.log("no selection: processing whole score");
processAll = true;
startStaff = 0;
endStaff = curScore.nstaves;
} else {
startStaff = cursor.staffIdx;
cursor.rewind(2);
endStaff = cursor.staffIdx+1;
endTick = cursor.tick;
if(endTick == 0) {
// selection includes end of score
// calculate tick from last score segment
endTick = curScore.lastSegment.tick + 1;
}
cursor.rewind(1);
console.log("Selection is: Staves("+startStaff+"-"+endStaff+") Ticks("+cursor.tick+"-"+endTick+")");
}
console.log("ProcessAll is "+processAll);
// go through all staves of a part simultaneously
// find staves that belong to the same part
var curStartStaff = startStaff;
while(curStartStaff < endStaff) {
// to remove we need to parse staff by staff
var curEndStaff = curStartStaff+1;
// do the work
processPart(cursor,endTick,curStartStaff*4,curEndStaff*4);
// next part
curStartStaff = curEndStaff;
}
//curScore.endCmd();
//curScore.doLayout();
console.log("end remove courtesy accidentals");
Qt.quit();
}
onRun: {
if(mscoreMajorVersion == 3 && mscoreMinorVersion == 0
&& mscoreUpdateVersion < 5) {
versionError.open();
} else {
removeAcc();
}
}
}