looptailg / musescore-31edo-tuner

31EDO Tuner plugin for Musescore

31EDO Tuner

A Musescore plugin for tuning scores to 31EDO.

Features

This plugin can be used to tune the whole score, or only a portion of it, to 31EDO.

Accidentals

This plugin is compatible with the following notation systems:

• Circle of fifths notation, using double sharps and flats. In this system, a sharp or a flat indicates an alteration of 2 EDO steps, and a double sharp or a double flat an alteration of 4 EDO steps. For example, a chromatic scale between C and D would be written as:

• Neutral circle of fifths notation, using half and sesqui sharps and flats. In this system, a half sharp or a half flat indicates an alteration of 1 EDO step, and a sesqui sharp or a sesqui flat an alteration of 3 EDO steps. For example, a chromatic scale between C and D would be written as:

• Sagittal notation, using quarter tone and half tone arrows. In this system, a quarter tone arrow indicates an alteration of 1 EDO step, and a half tone arrow indicates an alteration of 2 EDO steps. For example, a chromatic scale between C and D would be written as:

These notation systems are not mutually exclusive, the plugin can correctly tune a score which uses a mixture of them.

See here for a list of every supported accidental.

This plugin remembers which accidental is applied to any given note, and will automatically apply the correct tuning offset to the following notes within the same measure. This is also true for microtonal accidentals, for which this is usually not automatically done in Musescore. A limitation of this is that the plugin only checks for accidentals for each voice individually, so if there are multiple voices with microtonal accidentals, it might be necessary to add an extra accidental for the first modified note in each voice. This extra accidental can be safely made invisible, as that won't affect the plugin, as in the following example:

Key Signatures

This plugin supports custom key signatures. If the custom key signatures only contain standard accidentals, no extra action is required other than inserting the custom key signaturs into the score.

If the key signature contains microtonal accidentals, then it is necessary to also add a text (System Text for a regular key signature, or Staff Text for a local key signature) to inform the plugin about the accidentals present in the key signature. This text has to be formatted as X.X.X.X.X.X.X, where X are the accidental applied to each note, arranged according to the circle of fifths: F.C.G.D.A.E.B. These accidentals are written using ASCII characters only in the following way:

Accidental	Text
	bb
	db
	b
	d
	t
	#
	t#
	x

If a note does not have an accidental in the custom key signature, you can leave the text for that note empty.

The text describing the custom key signature can be safely made invisible, as that won't affect the plugin, as in the following example:

Usage

• If the score contains transposing instruments, ensure that the score is being displayed at concert pitch. If it's not, the notes of transposing instruments will not be tuned correctly.
• If you want to tune only a portion of the score, select it before running the plugin. If nothing is selected, the entire score will be tuned.
• Launch the plugin:
  • Musescore3: Plugins → Tuner → 31EDO
  • Musescore4: Plugins → Playback → 31EDO Tuner

If the score contains transposing instruments, you can safely turn off concert pitch after running the plugin, as the tuning of the notes will not be affected.

See here for a known issue regarding transposing instruments.

Installing

Musescore3

• Download the file 31edo_tuner_x.y.z.zip, where x.y.z is the version of the plugin. You can find the latest version here.
• Extract the file 31EdoTuner.qml, and move it to Musescore's plugin folder.
• Follow the steps listed here to enable the plugin.

Musescore4

• Download the file 31edo_tuner_x.y.z.zip, where x.y.z is the version of the plugin. You can find the latest version here.
• Extract the folder 31edo_tuner and move it to Musescore's plugin folder.
• Follow the steps listed here to enable the plugin.

musescore-31edo-tuner's Issues

Remove positiveModulo()

That function is used only in one place, and instead you can simply use more than one case for a code block to achieve the same result.

Fix the behaviour of transposing instruments

Transposing instruments don't work correctly when a note have a microtonal note applied to it.

Remember accidentals which were previously used in the measure

Remember the last accidental that was used for each note in the current measure, and apply it to the current note if necessary.

Only necessary for microtonal accidentals, the other ones are automatically handled by the tpc property.

Add the octave in `calculateNoteName()`

When implemented also port the changes to the 22EDO and the Fifth Generated plugin.

Improve naming consistency

Name the plugin 31edo everywhere, and not 31_edo or 31-edo.

Add support for selection

If a range is selected when the plugin is run, tune only the notes in that range.

Improve TPC handling

Improve the handling of the TPC property, it probably can be handled in a dynamic way by checking its modulo / remainder, instead of using a series of hardcoded cases.

Improve check for key signature change

Improve the code for checking for key signature change.

When implemented, also port the change to the 22EDO plugin.

Update supported accidentals

The wiki page about supported accidentals is missing some accidentals.

Add support for custom key signatures

Update README

Update the README file, to reflect the new functionality of tuning only the notes within the selection.

getPosistiveAccidentalType() output check

In getPosistiveAccidentalType() add a check on the output value, to ensure it is in the expected range.

Use getAccidental()

Use the function getAccidental() wherever the number of edo step displacement is calculated. Rename it to have a more descriptive name.

Incorrect readme images

The example image for custom key signatures is wrong, the text has the wrong number of dots.

The example image for sagittal notation should have a natural sign on the last note.

Replace the hardcoded values with the corresponding enums

• AccidentalType
• RewindMode.

Remove TPC property

Remove the TPC property from supportedAccidentals, as every accidental that has a false value for it also has the property DEFAULT_OFFSET. Rework the logic to check this value instead.

Improve key signature text parsing

Add a trim when validating/splitting the key signature text, to avoid the checks failing because of an invisible character.