Refactoring for making the --use-facsimile more generic

[lpugin]

This PR integrates a SyncFromFacsimileFunctor for applying the information provided in the facsimile in one place rather than in different places.

The functor is called from Toolkit::LoadData if the document as a <facsimile type="transcription">

https://github.com/rism-digital/verovio/blob/0b9ca33b0e4144dff2eb68438f3cbe3169d10515/src/toolkit.cpp#L795-L797

Eventually, the goal will be to call it when --use-facsimile is set. However, this will be changed only when it will work for neon too.

Another change brought by the PR is that the neon MEI need to have each <staff> wrapped into a <section type="neon-neume-line">. That way, the MEI also makes sense without facsimile.

Example:
https://gist.github.com/lpugin/dcf63d0c43c61df55486ce16030f6402

Rendering with --header none --footer none --page-margin-top 0 --page-margin-left 0 --use-facsimile (with the facsimile applied as in neon)

Rendering with --header none --footer none --page-margin-top 0 --page-margin-left 0 (with the new SyncFromFacsimileFunctor)

Rendering with @type="transcription" removed on <facsimile> (without applying the facsimile information)

As you can see, there is only a different with the horizontal placement of clef and the vertical placement of the custos. I haven't figured out what the issue is with the clef. For the custos, you can see that the placement is also wrong without the facsimile layout.

Once these two issues are fixed, we can proceed to the opposite functor (SyncToFacsimile).

[lpugin]

I fixed the custos issue. It is now looking good (as as before) without --use-facsimile with both the facsimile applied with the functor or without applying the facsimile information

(PS some clefs appear twice without applying the facsimile information because they are given in the encoding and also in the staffDef. This is expected)

[lpugin]

Output without --use-facsimile but with the facsimile applied throught @type="transcription"

[lpugin]

I tested with neon and it works with the following adjustments

DDMAL/Neon@develop...lpugin:Neon:develop

[yinanazhou]

I've confirmed that it works in Neon (https://github.com/DDMAL/Neon/tree/neume-line)

@lpugin could you merge this PR when it's ready?

[lpugin]

Great. Did you check editing? I think the editor_neume.cpp needs to be adjusted to call SyncFromFacsimileDoc at the end of every editing action (before the page is re-rendered).

I will also remove the various places where the drawing position retrieved from the facsimile since these are not used any more. For example this will be removed:

https://github.com/rism-digital/verovio/blob/7fc81987554928670028784054b760a492ec3338/src/layerelement.cpp#L399-L406

Since the drawing x position has been previously synced from the facsimile and is retrieved from:

https://github.com/rism-digital/verovio/blob/7fc81987554928670028784054b760a492ec3338/src/layerelement.cpp#L408-L409

[yinanazhou]

Hi @lpugin, I've been pushing changes to this branch. I'm a bit confused about the drawingY and logicalY/DeviceContextY in Verovio because I noticed that the coordinate is changed (?) somewhere in Verovio.

When I first load the page (no editor actions made), I had to remove or add ToLogicalY() or ToDeviceContextY() in DrawAccid(), DrawDivLine(), and DrawSyl() to fix their position on the page (they are flipped against the page).

But as soon as I drag an element, the coordinate is change: if the element is at the top of the page, it will jump to the bottom. I was wondering if you might know what is happening? Or where I should look into?

[lpugin]

Yes, the coordinates in MEI facsimile is reverse from the Verovio internal. That is, from top to bottom in facsimile, while Verovio coordinates are from bottom to top. It is very important not to mixed them up So the rule is:

• convert them ToLogicalX/Y in the SyncFromFacsimileFunctor
• convert them ToDeviceContextX/Y in the SyncToFacsimileFunctor

This is another reason why we need to remove the facsimile interaction in the drawing code

[lpugin]

Also, you should convert the facsimile coordinates in the editor using the EditorToolkit::m_view.ToLogicalX/Y. That way, all the calculations are done in Verovio coordinates.