297 lines
8.9 KiB
C++
297 lines
8.9 KiB
C++
/*
|
|
* SPDX-License-Identifier: GPL-3.0-only
|
|
* MuseScore-CLA-applies
|
|
*
|
|
* MuseScore
|
|
* Music Composition & Notation
|
|
*
|
|
* Copyright (C) 2021 MuseScore BVBA and others
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License version 3 as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* 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 <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "key.h"
|
|
#include "io/xml.h"
|
|
#include "utils.h"
|
|
#include "score.h"
|
|
#include "pitchspelling.h"
|
|
#include "keylist.h"
|
|
#include "accidental.h"
|
|
#include "part.h"
|
|
|
|
using namespace mu;
|
|
|
|
namespace Ms {
|
|
//---------------------------------------------------------
|
|
// enforceLimits - ensure _key
|
|
// is within acceptable limits (-7 .. +7).
|
|
// see KeySig::layout()
|
|
//---------------------------------------------------------
|
|
|
|
void KeySigEvent::enforceLimits()
|
|
{
|
|
if (_key < Key::MIN) {
|
|
_key = Key::MIN;
|
|
qDebug("key < -7");
|
|
} else if (_key > Key::MAX) {
|
|
_key = Key::MAX;
|
|
qDebug("key > 7");
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// print
|
|
//---------------------------------------------------------
|
|
|
|
void KeySigEvent::print() const
|
|
{
|
|
qDebug("<KeySigEvent: ");
|
|
if (!isValid()) {
|
|
qDebug("invalid>");
|
|
} else {
|
|
if (isAtonal()) {
|
|
qDebug("atonal>");
|
|
} else if (custom()) {
|
|
qDebug("custom>");
|
|
} else {
|
|
qDebug("accidental %d>", int(_key));
|
|
}
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// setKey
|
|
//---------------------------------------------------------
|
|
|
|
void KeySigEvent::setKey(Key v)
|
|
{
|
|
_key = v;
|
|
_custom = false;
|
|
enforceLimits();
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// KeySigEvent::operator==
|
|
//---------------------------------------------------------
|
|
|
|
bool KeySigEvent::operator==(const KeySigEvent& e) const
|
|
{
|
|
if (e._custom != _custom || e._mode != _mode || e._forInstrumentChange != _forInstrumentChange) {
|
|
return false;
|
|
}
|
|
if (_custom && !isAtonal()) {
|
|
if (e._keySymbols.size() != _keySymbols.size()) {
|
|
return false;
|
|
}
|
|
for (int i = 0; i < _keySymbols.size(); ++i) {
|
|
if (e._keySymbols[i].sym != _keySymbols[i].sym) {
|
|
return false;
|
|
}
|
|
// TODO: position matters
|
|
}
|
|
return true;
|
|
}
|
|
return e._key == _key;
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// transposeKey
|
|
//---------------------------------------------------------
|
|
|
|
Key transposeKey(Key key, const Interval& interval, PreferSharpFlat prefer)
|
|
{
|
|
int tpc = int(key) + 14;
|
|
tpc = transposeTpc(tpc, interval, false);
|
|
|
|
// change between 5/6/7 sharps and 7/6/5 flats
|
|
// other key signatures cannot be changed enharmonically
|
|
// without causing double-sharp/flat
|
|
// (-7 <=) tpc-14 <= -5, which has Cb, Gb, Db
|
|
if (tpc <= 9 && prefer == PreferSharpFlat::SHARPS) {
|
|
tpc += 12;
|
|
}
|
|
|
|
// 5 <= tpc-14 <= 7, which has B, F#, C#, enharmonic with Cb, Gb, Db respectively
|
|
if (tpc >= 19 && tpc <= 21 && prefer == PreferSharpFlat::FLATS) {
|
|
tpc -= 12;
|
|
}
|
|
|
|
// check for valid key sigs
|
|
if (tpc > 21) {
|
|
tpc -= 12; // no more than 7 sharps in keysig
|
|
}
|
|
if (tpc < 7) {
|
|
tpc += 12; // no more than 7 flats in keysig
|
|
}
|
|
return Key(tpc - 14);
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// calculateInterval
|
|
// Calculates the interval to move from one key to another
|
|
//---------------------------------------------------------
|
|
|
|
Interval calculateInterval(Key key1, Key key2)
|
|
{
|
|
int chromatic = 7 * ((int)key2 - (int)key1);
|
|
chromatic = chromatic % 12;
|
|
if (chromatic < 0) {
|
|
chromatic += 12;
|
|
}
|
|
return Interval(chromatic);
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// initFromSubtype
|
|
// for backward compatibility
|
|
//---------------------------------------------------------
|
|
|
|
void KeySigEvent::initFromSubtype(int st)
|
|
{
|
|
//anatoly-os: legacy code. I don't understand why it is so overcomplicated.
|
|
//Did refactoring to avoid exception on MSVC, but left the same logic.
|
|
struct {
|
|
int _key : 4;
|
|
int _naturalType : 4;
|
|
unsigned _customType : 16;
|
|
bool _custom : 1;
|
|
bool _invalid : 1;
|
|
} a;
|
|
|
|
a._key = (st & 0xf);
|
|
a._naturalType = (st >> 4) & 0xf;
|
|
a._customType = (st >> 8) & 0xffff;
|
|
a._custom = (st >> 24) & 0x1;
|
|
a._invalid = (st >> 25) & 0x1;
|
|
//end of legacy code
|
|
|
|
_key = Key(a._key);
|
|
// _customType = a._customType;
|
|
_custom = a._custom;
|
|
if (a._invalid) {
|
|
_key = Key::INVALID;
|
|
}
|
|
enforceLimits();
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// accidentalVal
|
|
//---------------------------------------------------------
|
|
|
|
AccidentalVal AccidentalState::accidentalVal(int line, bool& error) const
|
|
{
|
|
if (line < MIN_ACC_STATE || line >= MAX_ACC_STATE) {
|
|
error = true;
|
|
return AccidentalVal::NATURAL;
|
|
}
|
|
return AccidentalVal((state[line] & 0x0f) + int(AccidentalVal::MIN));
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// init
|
|
// preset lines list with accidentals for given key
|
|
//---------------------------------------------------------
|
|
|
|
static const int ACC_STATE_NATURAL = int(AccidentalVal::NATURAL) - int(AccidentalVal::MIN);
|
|
static const int ACC_STATE_FLAT = int(AccidentalVal::FLAT) - int(AccidentalVal::MIN);
|
|
static const int ACC_STATE_SHARP = int(AccidentalVal::SHARP) - int(AccidentalVal::MIN);
|
|
|
|
void AccidentalState::init(Key key)
|
|
{
|
|
memset(state, ACC_STATE_NATURAL, MAX_ACC_STATE);
|
|
// The numerical value of key tells us the number of sharps (or flats, if negative) in the key signature
|
|
if (key > 0) {
|
|
for (int i = 0; i < int(key); ++i) {
|
|
// First F#, then C#, then G#, etc.
|
|
int idx = tpc2step(Tpc::TPC_F_S + i);
|
|
for (int octave = 0; octave < (11 * 7); octave += 7) {
|
|
int j = idx + octave;
|
|
if (j >= MAX_ACC_STATE) {
|
|
break;
|
|
}
|
|
state[j] = ACC_STATE_SHARP;
|
|
}
|
|
}
|
|
} else {
|
|
for (int i = 0; i > int(key); --i) {
|
|
// First Bb, then Eb, then Ab, etc.
|
|
int idx = tpc2step(Tpc::TPC_B_B + i);
|
|
for (int octave = 0; octave < (11 * 7); octave += 7) {
|
|
int j = idx + octave;
|
|
if (j >= MAX_ACC_STATE) {
|
|
break;
|
|
}
|
|
state[j] = ACC_STATE_FLAT;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// init
|
|
//---------------------------------------------------------
|
|
|
|
void AccidentalState::init(const KeySigEvent& keySig, ClefType clef)
|
|
{
|
|
if (keySig.custom()) {
|
|
memset(state, ACC_STATE_NATURAL, MAX_ACC_STATE);
|
|
for (const KeySym& s : keySig.keySymbols()) {
|
|
AccidentalVal a = sym2accidentalVal(s.sym);
|
|
int line = int(s.spos.y() * 2);
|
|
int idx = relStep(line, clef) % 7;
|
|
for (int octave = 0; octave < (11 * 7); octave += 7) {
|
|
int i = idx + octave;
|
|
if (i >= MAX_ACC_STATE) {
|
|
break;
|
|
}
|
|
state[i] = int(a) - int(AccidentalVal::MIN);
|
|
}
|
|
}
|
|
} else {
|
|
init(keySig.key());
|
|
}
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// accidentalVal
|
|
//---------------------------------------------------------
|
|
|
|
AccidentalVal AccidentalState::accidentalVal(int line) const
|
|
{
|
|
Q_ASSERT(line >= MIN_ACC_STATE && line < MAX_ACC_STATE);
|
|
return AccidentalVal((state[line] & 0x0f) + int(AccidentalVal::MIN));
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// tieContext
|
|
//---------------------------------------------------------
|
|
|
|
bool AccidentalState::tieContext(int line) const
|
|
{
|
|
Q_ASSERT(line >= MIN_ACC_STATE && line < MAX_ACC_STATE);
|
|
return state[line] & TIE_CONTEXT;
|
|
}
|
|
|
|
//---------------------------------------------------------
|
|
// setAccidentalVal
|
|
//---------------------------------------------------------
|
|
|
|
void AccidentalState::setAccidentalVal(int line, AccidentalVal val, bool tieContext)
|
|
{
|
|
Q_ASSERT(line >= MIN_ACC_STATE && line < MAX_ACC_STATE);
|
|
// casts needed to work around a bug in Xcode 4.2 on Mac, see #25910
|
|
Q_ASSERT(int(val) >= int(AccidentalVal::MIN) && int(val) <= int(AccidentalVal::MAX));
|
|
state[line] = (int(val) - int(AccidentalVal::MIN)) | (tieContext ? TIE_CONTEXT : 0);
|
|
}
|
|
}
|