Introduced MEI ornament expansions and their conversion to MPM ornamentation by LarsEngeln · Pull Request #33 · cemfi/meico

LarsEngeln · 2026-08-10T14:20:20Z

v0.11.15

Introduced MEI ornament expansions and their conversion to MPM ornamentation.

adds Helper functions to create Element, find childs where Attribute has a certain value, find sibling, simple way to add a short UUID, remove all Attributes except given list, get halfsteps between notes, shift the given note diatonicly by a given number of semitones
ntroduces RichElement as object-oriented wrapper of the Helper functions, being the base class for MeiElement and MsmElement
adds the possibility to expand ornaments a MEI by adding notes to be played as . Mainly this is for rendering via MPM.
introduces an ornaments.dict(ionary) (congruent with the instruments.dict) that is used by the MeiInstructifier
extends ornamentData to match MPM's ornament model
adds possibility to not set a namespace for the id (important for MSM)
adds note generation for ornaments in ornamentMap-processing
adds TemporalValue as class that interfaces temporal domains to handle dates and durations
adds standard OrnamentDef's for basic ornaments
adds graces as likewise the other ornaments
adds the use of relative framestart and framelength for temporalSpread of ornaments
adds support for (measured) tremolo rendering
adds support for multiple ornaments applied to the same principal note with options to place (render) these at the start or at the end of the principal note
adds a guard that an exported midi files have no negative date occur, as this could result with an ornament at the very beginning, which may lead to a midi files that cannot be interpreted by other software
adds preventing leftovers notes if they are too short (e.g. due to numeric/rounding)
adds expanding ornaments into the export function, with flag to prevent this
prevents expanding ornaments multiple times
adds returning added notes while ornamentation rendering
adds articulations to generated notes of the rendered ornaments
applies ornament rendering to be fully "measured" (in ms) after Tempo-rendering
adds support for fioritura's (ornamental runs), in MEI these are displayed as besides a

…has a certain value, find sibling, including a simple way to add a short UUID

…s to Helper

…nctions, where MeiElement is more abstract

…o be played as <supplied>. Mainly this is for rendering via MPM.

…dict) that is used by the MeiInstructifier

…ion of halfsteps between two note. "intm" is now in halfsteps, not interval anymore

…re added

…ssing

axelberndt · 2026-08-11T14:20:23Z

In class Mei2MsmMpmConverter lines 2985 and 3003: The ornament's ID should be the ID it has in the MEI.

axelberndt · 2026-08-11T14:26:02Z

For what is method getRptString() meant to be a helper method? Not for barlines, right? But for ornaments? Please clarify in the method description.

axelberndt · 2026-08-11T14:27:44Z

There is a TODO comment in line 3082. Is it still valid?

axelberndt · 2026-08-11T14:42:25Z

Line 3565: Is it necessary to add a rest to the hashmap? Please test what happens when a slur ends on a rest. Esp. is there an effect to the articulation of subsequent notes?

axelberndt · 2026-08-11T14:49:59Z

Rename method MeiNote2MsmNote() to meiNote2MsmNote(). All methohd names sould start lower case.
Lines 3832-3839: replace by

MsmElement msmElement = meiNote2MsmNote(new MeiElement(note));
if (msmElement == null)
    return;
Element s = msmElement.getElement();

…g a Context interface and renaming Mei/MsmElement to more precise Mei/Msm/NoteElement

…es only), and changes the OrnamentProcessor to only use MeiElementHelper (instead of Helper./XOM directly)

axelberndt · 2026-08-19T14:02:35Z

     * @param chord an mei chord, bTrem or fTrem element
     */
-    private void processChord(Element chord) {
+    public void processChord(Element chord) {


Not public. If private is too strict use protected.

axelberndt · 2026-08-19T14:06:55Z

        }
    }

+    public MsmNoteElement meiNote2MsmNote(MeiElementHelper meiNote) {


Not public!
Missing documentationen above method header.

axelberndt · 2026-08-19T14:09:05Z

+import java.util.ArrayList;
+import java.util.HashMap;
+
+public interface Context {


Missing documentation

axelberndt · 2026-08-19T14:10:03Z


 public class Mei extends meico.xml.XmlBase implements Cloneable {
+
+    boolean areOrnamentsExpanded = false;


Still, this should be removed.

axelberndt · 2026-08-19T14:11:54Z

+     * @return 'this' Mei for chaining
+     */
+    public Mei expandOrnaments() {
+        if(areOrnamentsExpanded)


Unnecessary. If the application wants this to be done twice, it should be allowed.

axelberndt · 2026-08-19T14:53:34Z

+ * This class interfaces temporal domain with a value
+ * @author Lars Engeln
+ */
+public class TemporalValue {


Lots of missing documentation in this class. What is the meaning of the class variables? Please also document all methods.

axelberndt · 2026-08-19T14:55:51Z

@@ -0,0 +1,549 @@
+package meico.mpm.elements;


This is the wrong place for this class. We need to discuss this.

axelberndt · 2026-08-19T14:56:52Z

+        return getDomain() == Domain.Ticks;
+    }
+
+    /** TODO


axelberndt · 2026-08-19T14:59:39Z

+
+        double greaterValue = getValue();
+        double lesserValue = value;
+        if(getValue() < value) {


Put the above two lines in an else, so the value assignments are done only once.

axelberndt · 2026-08-19T15:00:30Z

+    }
+    /**
+     * returns if the relation stack has an absolute root
+     */


Copilot

Pull request overview

This PR introduces an end-to-end pipeline for expanding MEI ornaments into explicit note material (<supplied>/<graceGrp>) and converting that information into MPM ornamentation data, including new temporal-domain handling for ornament timing/spread.

Changes:

Added MEI ornament expansion/preprocessing (meico.mei.ornament) plus conversion support into MPM ornamentationMap.
Introduced new XML helper abstractions (RichElement, MeiElementHelper, MsmNoteElement) and additional MEI helper utilities.
Extended ornamentation/temporal rendering capabilities (relative/ticks/ms domains, alignment “at start/end”, tremolo support, multi-ornament distribution).

Reviewed changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
src/resources/ornaments.dict	Adds ornament name → pitch-alteration patterns used for ornament expansion/matching.
src/meico/xml/RichElement.java	Introduces an OO wrapper around XOM `Element` with attribute/child/id utilities.
src/meico/supplementary/Stopwatch.java	Adds a simple stopwatch utility for console timing output.
src/meico/msm/MsmNoteElement.java	Adds MSM-focused `RichElement` wrapper utilities for note access/comparison.
src/meico/msm/Msm.java	Extends expressive MIDI export API and clamps negative dates during MIDI event creation.
src/meico/mpm/elements/TemporalValue.java	Adds temporal value abstraction with unit/domain parsing and relative/absolute operations.
src/meico/mpm/elements/styles/defs/OrnamentDef.java	Extends ornament temporal spread model (TemporalValue, alignment) and render logic.
src/meico/mpm/elements/Performance.java	Wires ornament expansion/rendering into performance pipeline; attempts map cloning.
src/meico/mpm/elements/maps/OrnamentationMap.java	Major rework: supports child notes/repetitions, note generation, grouping/spacing logic.
src/meico/mpm/elements/maps/GenericMap.java	Adds `removeElement(String id)` convenience removal by xml:id.
src/meico/mpm/elements/maps/data/OrnamentData.java	Extends ornament data to include correspondence, notes, repetitions, and new apply API.
src/meico/mpm/elements/maps/ArticulationMap.java	Adds articulation lookup/copy helper for ornament-generated notes.
src/meico/mei/ornament/package-info.java	Adds package docs for new ornament subpackage.
src/meico/mei/ornament/OrnamentProcessor.java	Implements MEI→MPM ornament extraction from generated `<supplied>` expansions.
src/meico/mei/ornament/OrnamentExpansion.java	Defines the in-memory model for generated ornament expansions and merge behavior.
src/meico/mei/ornament/OrnamentExpander.java	Adds MEI preprocessing step that generates `<supplied>` ornament expansions.
src/meico/mei/NoteProcessor.java	Introduces interface to decouple note/chord processing for ornament processors.
src/meico/mei/MeiElementHelper.java	Adds MEI-specific wrapper over `RichElement` (namespace + `.ges` fallback).
src/meico/mei/Mei2MsmMpmConverter.java	Integrates ornament processor; exposes context/hooks for ornament conversion.
src/meico/mei/Mei.java	Adds `expandOrnaments()` and export flag to optionally bypass ornament expansion.
src/meico/mei/Helper.java	Adds multiple MEI XML utilities and pitch/interval helper functions.
src/meico/mei/Context.java	Adds context interface used by ornament processing to access converter state.
src/meico/mei/AttributesWithIds.java	Adjusts visibility (package-private).
README.md	Updates contributors and adds CLI flag `--ignore-ornaments`; updates formatting/content.
MEI2MSM_Coverage_Documentation.md	Updates documentation to reflect new ornament/grace/tremolo preprocessing behavior.
history.md	Adds v0.11.15 changelog documenting the ornament/temporal spread feature set.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

+        Pattern pattern = Pattern.compile("^(\\d+)(ms|th|%|ticks|\\?)$");  // checks string if it is a valid value + unit string
+        Matcher m = pattern.matcher(valueDomain.trim());
+        if (m.matches()) {
+            setValue(Double.parseDouble(m.group(1)));
+            setDomain(fromDomainString(m.group(2)));
+            return;
+        }


+            dateAttName = "ornament.milliseconds.date.offset";
+            durAttName = "ornament.milliseconds.duration";


+            ornament.copyValue("date", principalNote);
+            ArrayList<MsmNoteElement> children = ornament.getChildrenAsMsmElements();
+            ArrayList<String> noteOrder = new ArrayList<>(Arrays.asList(ornament.get("note.order").replaceAll(":\\|:", ":| |:").split(" ")));
+            Map<Integer, Integer> repeats = new HashMap<>();


+        this.notes = new ArrayList<>();
+        xml.getChildElements("ornamentNote").forEach(note -> { this.notes.add(note); });


+                try {
+                    ornamentationMap = OrnamentationMap.createOrnamentationMap((OrnamentationMap) mpmPart.getDated().getMap(Mpm.ORNAMENTATION_MAP));                 // get ornamentationMap
+                }
+                catch (Exception e) {
+                    String exc = e.getLocalizedMessage();
+                }


+        String ornamFullName = getOrnamentFullName(ornament);
+        if(ornamFullName == null || ornamFullName.equals(""))
+            return;     // if I am not yet supported


+            od.xmlId = correspId != null ? correspId : UUID.randomUUID().toString();
+            od.correspondence = elementId;
+            od.date = (Double) timingData.get(0);
+            od.ornamentDefName = segmentLabels.get(s);


+    /**
+     * returns halfsteps between pname1 and pname2 (always positive)
+     * @param pname1
+     * @param pname2
+     * @return
+     */
+    public static int getHalfstepsBetween(String pname1, String pname2) {
+        return Math.abs(getHalfstepsFromC(pname2) - getHalfstepsFromC(pname1));
+    }


                    dateEnd = Math.round(Double.parseDouble(endAtt.getValue()));
+                    if(dateEnd < 0) {
+                        dateEnd = -(date-dateEnd);
+                    }


+    public Map<String, ArrayList<String>> renderGlobalOrnamentationMap(ArrayList<GenericMap> maps) {
        if ((maps == null) || maps.isEmpty())
-            return;
+            return new HashMap<>();

-        this.apply(maps);
+        return new HashMap<>(); // this.apply(maps);
    }


LarsEngeln added 30 commits May 6, 2026 17:04

adds Helper functions to create Element, find childs where Attribute …

2b6f713

…has a certain value, find sibling, including a simple way to add a short UUID

adds shifting the given note diatonicly by a given number of semitone…

b7d957f

…s to Helper

adds the MeiElement class as object-oriented wrapper of the Helper fu…

b067993

…nctions, where MeiElement is more abstract

adds the possibility to instructify ornaments a MEI by adding notes t…

7832007

…o be played as <supplied>. Mainly this is for rendering via MPM.

adds class descriptions

8bf5542

introduces an ornaments.dict(ionary) (congruent with the instruments.…

7817d76

…dict) that is used by the MeiInstructifier

removes beams and stems of the instruction notes

d7f7e31

adds relative intervall to instruction notes

5207e78

adds mei Helper to remove all Attributes except given list

26bf4a9

adds mei Helper to get halfsteps between notes

e9cd0ca

renames "note"-related vars in Instruction to element

dafd608

adds processing of accids to MeiInstructifier for having the calculat…

66b4a4d

…ion of halfsteps between two note. "intm" is now in halfsteps, not interval anymore

fixes nullptr-exc if no document is available

1409bb3

adds ornament processing to converter, so that in MPM the ornaments a…

611695a

…re added

adds getChildren to MeiElement

7528640

extends ornamentData to have notes (children)

209f040

removes "display"-option from Instructifier

56d93e6

adds deep clone to clone all children too

702e8f7

adds handling of grace notes/chords & graceGrps in the ornament proce…

9bf473b

…ssing

adds deep copy and parent handling to MeiElement

2c8f5af

fixes ornamentData (nullptr exc)

0adf847

breaks up beams as graceGrp

f2830ad

adds setting staff number for adding an ornament to local scope

ec6ed16

removes repetition element, und moves repetition String

40dd2a2

adds converting from MEI to MSM notes

fe47fd7

applies ornaments by adding note (quite early)

c727d73

adds possibility to not set a namespace for the id (important for MSM)

85fdcad

moves note generation for ornaments into ornamentMap-processing

8e25e30

introduces RichElement as base class for MeiElement and MsmElement

079c4ed

adds repeating ornament notes

5012a28

LarsEngeln added 4 commits August 12, 2026 11:02

fixes naming to lowerCamelCase

4e37382

changes ornament's xmlId to be the original MEI-ornam Id

be67934

adds comments

219a3e9

simplifies code (rm unnecessary code)

0515279

axelberndt requested changes Aug 12, 2026

View reviewed changes

LarsEngeln added 8 commits August 13, 2026 13:49

refactors Ornament code into .mei.ornament sub-package bei introducin…

71005b7

…g a Context interface and renaming Mei/MsmElement to more precise Mei/Msm/NoteElement

simplifies if cascade

9305630

adds more precise description

9bf3400

changes to package private

3e4d0b1

fixes comments

4c19773

rm unnecessary override

42a9014

changes to element's namespace instead of hardcoded MEI namespace

03930b3

simplifies break if ignored

030e02b

LarsEngeln requested a review from axelberndt August 13, 2026 13:14

LarsEngeln added 4 commits August 14, 2026 11:58

adds more explicit comments

8ac0d81

renames MeiNoteElement to MeiElementHelper (as it is not used for not…

5615b92

…es only), and changes the OrnamentProcessor to only use MeiElementHelper (instead of Helper./XOM directly)

unifies parameter naming

a7c48b5

prettify

80c1102

axelberndt reviewed Aug 19, 2026

View reviewed changes

adds comments to TemporalValue

dcdefb9

Copilot AI lite review requested due to automatic review settings August 20, 2026 12:04

Copilot started reviewing on behalf of LarsEngeln August 20, 2026 12:05 View session

Copilot AI reviewed Aug 20, 2026

View reviewed changes

LarsEngeln added 2 commits August 20, 2026 15:06

uses more precise RichElement where it is not an MsmNote

d184016

fixes creation of Ornaments, correct reference was lost

00e6148


		public class Mei extends meico.xml.XmlBase implements Cloneable {

		boolean areOrnamentsExpanded = false;

		dateAttName = "ornament.milliseconds.date.offset";
		durAttName = "ornament.milliseconds.duration";

		this.notes = new ArrayList<>();
		xml.getChildElements("ornamentNote").forEach(note -> { this.notes.add(note); });

Uh oh!

Conversation

LarsEngeln commented Aug 10, 2026

Uh oh!

axelberndt commented Aug 11, 2026

Uh oh!

axelberndt commented Aug 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

axelberndt commented Aug 11, 2026

Uh oh!

axelberndt commented Aug 11, 2026

Uh oh!

axelberndt commented Aug 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

axelberndt commented Aug 11, 2026 •

edited

Loading

axelberndt commented Aug 11, 2026 •

edited

Loading