Merge pull request #3571 from rism-digital/develop-facsimile-neume-line

Add support for neumes encoded line by line

include/vrv/adjustyrelfortranscriptionfunctor.h

@@ -0,0 +1,56 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        adjustyrelfortranscriptionfunctor.h
+// Author:      Yinan Zhou
+// Created:     2024
+// Copyright (c) Authors and others. All rights reserved.
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef __VRV_ADJUSTYRELFORTRANSCRIPTIONFUNCTOR_H__
+#define __VRV_ADJUSTYRELFORTRANSCRIPTIONFUNCTOR_H__
+
+#include "functor.h"
+
+namespace vrv {
+
+//----------------------------------------------------------------------------
+// AdjustYRelForTranscriptionFunctor
+//----------------------------------------------------------------------------
+
+/**
+ * This class adjusts the YRel positions taking into account the bounding boxes.
+ */
+class AdjustYRelForTranscriptionFunctor : public Functor {
+public:
+    /**
+     * @name Constructors, destructors
+     */
+    ///@{
+    AdjustYRelForTranscriptionFunctor();
+    virtual ~AdjustYRelForTranscriptionFunctor() = default;
+    ///@}
+
+    /*
+     * Abstract base implementation
+     */
+    bool ImplementsEndInterface() const override { return false; }
+
+    /*
+     * Functor interface
+     */
+    ///@{
+    FunctorCode VisitLayerElement(LayerElement *layerElement) override;
+    ///@}
+
+protected:
+    //
+private:
+    //
+public:
+    //
+private:
+    //
+};
+
+} // namespace vrv
+
+#endif // __VRV_ADJUSTYRELFORTRANSCRIPTIONFUNCTOR_H__

include/vrv/devicecontext.h

@@ -74,6 +74,7 @@ class DeviceContext {
         m_baseWidth = 0;
         m_baseHeight = 0;
         m_pushBack = false;
+        m_viewBoxFactor = (double)DEFINITION_FACTOR;
     }
     DeviceContext(ClassId classId)
     {
@@ -89,6 +90,7 @@ class DeviceContext {
         m_baseWidth = 0;
         m_baseHeight = 0;
         m_pushBack = false;
+        m_viewBoxFactor = (double)DEFINITION_FACTOR;
     }
     virtual ~DeviceContext(){};
     ClassId GetClassId() const { return m_classId; }
@@ -124,12 +126,14 @@ class DeviceContext {
         m_baseWidth = width;
         m_baseHeight = height;
     }
+    void SetViewBoxFactor(double ppuFactor);
     int GetWidth() const { return m_width; }
     int GetHeight() const { return m_height; }
     int GetContentHeight() const { return m_contentHeight; }
     double GetUserScaleX() { return m_userScaleX; }
     double GetUserScaleY() { return m_userScaleY; }
     std::pair<int, int> GetBaseSize() const { return std::make_pair(m_baseWidth, m_baseHeight); }
+    double GetViewBoxFactor() const { return m_viewBoxFactor; }
     ///@}
 
     /**
@@ -365,6 +369,9 @@ class DeviceContext {
     /** stores the scale as requested by the used */
     double m_userScaleX;
     double m_userScaleY;
+
+    /** stores the viewbox factor taking into account the DEFINTION_FACTOR and the PPU */
+    double m_viewBoxFactor;
 };
 
 } // namespace vrv

include/vrv/doc.h

@@ -451,6 +451,14 @@ class Doc : public Object {
     bool IsMensuralMusicOnly() const { return m_isMensuralMusicOnly; }
     ///@}
 
+    /**
+     * @name Setter for and getter for neume-line flag
+     */
+    ///@{
+    void SetNeumeLines(bool isNeumeLines) { m_isNeumeLines = isNeumeLines; }
+    bool IsNeumeLines() const { return m_isNeumeLines; }
+    ///@}
+
     /**
      * @name Setter and getter for facsimile
      */
@@ -660,6 +668,12 @@ class Doc : public Object {
      */
     bool m_isMensuralMusicOnly;
 
+    /**
+     * A flag to indicate that the document contains neume lines.
+     * This is a special document type where neume lines are encoded with <section type="neon-neume-line">
+     */
+    bool m_isNeumeLines;
+
     /** Page width (MEI [email protected]) - currently not saved */
     int m_pageWidth;
     /** Page height (MEI [email protected]) - currently not saved */

include/vrv/editortoolkit_neume.h

@@ -16,6 +16,7 @@
 
 #include "doc.h"
 #include "editortoolkit.h"
+#include "measure.h"
 #include "view.h"
 #include "vrv.h"
 #include "zone.h"
@@ -50,6 +51,8 @@ class EditorToolkitNeume : public EditorToolkit {
     bool Set(std::string elementId, std::string attrType, std::string attrValue);
     bool SetText(std::string elementId, const std::string &text);
     bool SetClef(std::string elementId, std::string shape);
+    bool SetLiquescent(std::string elementId, std::string shape);
+    bool SortStaves();
     bool Split(std::string elementId, int x);
     bool SplitNeume(std::string elementId, std::string ncId);
     bool Remove(std::string elementId);
@@ -80,6 +83,7 @@ class EditorToolkitNeume : public EditorToolkit {
     bool ParseSetAction(jsonxx::Object param, std::string *elementId, std::string *attrType, std::string *attrValue);
     bool ParseSetTextAction(jsonxx::Object param, std::string *elementId, std::string *text);
     bool ParseSetClefAction(jsonxx::Object param, std::string *elementId, std::string *shape);
+    bool ParseSetLiquescentAction(jsonxx::Object param, std::string *elementId, std::string *shape);
     bool ParseSplitAction(jsonxx::Object param, std::string *elementId, int *x);
     bool ParseSplitNeumeAction(jsonxx::Object param, std::string *elementId, std::string *ncId);
     bool ParseRemoveAction(jsonxx::Object param, std::string *elementId);
@@ -177,11 +181,26 @@ struct ClosestNeume {
 struct StaffSort {
     // Sort staves left-to-right and top-to-bottom
     // Sort by y if there is no intersection, by x if there is x intersection is smaller than half length of staff line
+
+    // Update 2024-04:
+    // Used only in neume lines,
+    // System->(Measure->Staff)
+    // Need to sort Measure to sort staff
     bool operator()(Object *a, Object *b)
     {
-        if (!a->GetFacsimileInterface() || !b->GetFacsimileInterface()) return true;
-        Zone *zoneA = a->GetFacsimileInterface()->GetZone();
-        Zone *zoneB = b->GetFacsimileInterface()->GetZone();
+        if (!a->Is(SYSTEM) || !b->Is(SYSTEM)) return false;
+        if (!a->FindDescendantByType(MEASURE) || !b->FindDescendantByType(MEASURE)) return false;
+        Measure *measureA = dynamic_cast<Measure *>(a->FindDescendantByType(MEASURE));
+        Measure *measureB = dynamic_cast<Measure *>(b->FindDescendantByType(MEASURE));
+        if (!measureA->IsNeumeLine() || !measureB->IsNeumeLine()) return true;
+        Object *staffA = a->FindDescendantByType(STAFF);
+        Object *staffB = b->FindDescendantByType(STAFF);
+        assert(staffA);
+        assert(staffB);
+        Zone *zoneA = staffA->GetFacsimileInterface()->GetZone();
+        Zone *zoneB = staffB->GetFacsimileInterface()->GetZone();
+        assert(zoneA);
+        assert(zoneB);
 
         int aLowest, bLowest, aHighest, bHighest;
 

include/vrv/facsimilefunctor.h

@@ -42,7 +42,7 @@ class SyncFromFacsimileFunctor : public Functor {
     /*
      * Abstract base implementation
      */
-    bool ImplementsEndInterface() const override { return false; }
+    bool ImplementsEndInterface() const override { return true; }
 
     /*
      * Functor interface
@@ -51,6 +51,7 @@ class SyncFromFacsimileFunctor : public Functor {
     FunctorCode VisitLayerElement(LayerElement *layerElement) override;
     FunctorCode VisitMeasure(Measure *measure) override;
     FunctorCode VisitPage(Page *page) override;
+    FunctorCode VisitPageEnd(Page *page) override;
     FunctorCode VisitPb(Pb *pb) override;
     FunctorCode VisitSb(Sb *sb) override;
     FunctorCode VisitStaff(Staff *staff) override;
@@ -71,6 +72,9 @@ class SyncFromFacsimileFunctor : public Functor {
     //
     Page *m_currentPage;
     System *m_currentSystem;
+    Measure *m_currentNeumeLine;
+    /** map to store the zone corresponding to a staff */
+    std::map<Staff *, Zone *> m_staffZones;
 };
 
 //----------------------------------------------------------------------------

include/vrv/facsimileinterface.h

@@ -58,6 +58,13 @@ class FacsimileInterface : public Interface, public AttFacsimile {
     Zone *GetZone() { return m_zone; }
     const Zone *GetZone() const { return m_zone; }
     ///@}
+    ///
+
+    /** Get the surface */
+    ///@{
+    Surface *GetSurface() { return m_surface; }
+    const Surface *GetSurface() const { return m_surface; }
+    ///@}
 
     //-----------------//
     // Pseudo functors //

include/vrv/layerelement.h

@@ -387,6 +387,7 @@ class LayerElement : public Object,
 public:
     /** Absolute position X. This is used for facsimile (transcription) encoding */
     int m_drawingFacsX;
+    int m_drawingFacsY; // This is used only for accid, syl
     /**
      * This stores a pointer to the cross-staff (if any) and the appropriate layer
      * See PrepareCrossStaffFunctor

include/vrv/measure.h

@@ -53,7 +53,7 @@ class Measure : public Object,
      * Reset method resets all attribute classes
      */
     ///@{
-    Measure(bool measuredMusic = true, int logMeasureNb = -1);
+    Measure(MeasureType measuredMusic = MEASURED, int logMeasureNb = -1);
     virtual ~Measure();
     Object *Clone() const override { return new Measure(*this); };
     void Reset() override;
@@ -79,7 +79,12 @@ class Measure : public Object,
     /**
      * Return true if measured music (otherwise we have fake measures)
      */
-    bool IsMeasuredMusic() const { return m_measuredMusic; }
+    bool IsMeasuredMusic() const { return (m_measureType == MEASURED); }
+
+    /**
+     * Return true if the measure represents a neume (section) line
+     */
+    bool IsNeumeLine() const { return (m_measureType == NEUMELINE); }
 
     /**
      * Get and set the measure index
@@ -404,9 +409,10 @@ class Measure : public Object,
 
 private:
     /**
-     * Indicates measured music (otherwise we have fake measures)
+     * Indicate measured music (CMN), unmeasured (fake measures for mensural or neumes) or neume lines
+     * Neume line measure are created from <section type="neon-neume-line">
      */
-    bool m_measuredMusic;
+    MeasureType m_measureType;
 
     /**
      * The unique measure index

include/vrv/staff.h

@@ -112,6 +112,17 @@ class Staff : public Object,
     }
     ///@}
 
+    /**
+     * @name Getters and setters for the rotation.
+     * Used only with facsimile rendering.
+     */
+    ///@{
+    void SetDrawingRotation(double drawingRotation) { m_drawingRotation = drawingRotation; }
+    double GetDrawingRotation() const { return m_drawingRotation; }
+    bool HasDrawingRotation() const { return (m_drawingRotation != 0.0); }
+    int GetDrawingRotationOffsetFor(int x);
+    ///@}
+
     /**
      * Delete all the legder line arrays.
      */
@@ -290,6 +301,12 @@ class Staff : public Object,
     ArrayOfLedgerLines m_ledgerLinesAboveCue;
     ArrayOfLedgerLines m_ledgerLinesBelowCue;
     ///@}
+
+    /**
+     * The drawing rotation.
+     * Used only with facsimile rendering
+     */
+    double m_drawingRotation;
 };
 
 } // namespace vrv

include/vrv/view.h

@@ -416,6 +416,7 @@ class View {
     ///@{
     void DrawDivLine(DeviceContext *dc, LayerElement *element, Layer *layer, Staff *staff, Measure *measure);
     void DrawSyllable(DeviceContext *dc, LayerElement *element, Layer *layer, Staff *staff, Measure *measure);
+    void DrawLiquescent(DeviceContext *dc, LayerElement *element, Layer *layer, Staff *staff, Measure *measure);
     void DrawNc(DeviceContext *dc, LayerElement *element, Layer *layer, Staff *staff, Measure *measure);
     void DrawNeume(DeviceContext *dc, LayerElement *element, Layer *layer, Staff *staff, Measure *measure);
     ///@}

include/vrv/vrvdef.h

@@ -661,6 +661,14 @@ enum SmuflTextFont { SMUFL_NONE = 0, SMUFL_FONT_SELECTED, SMUFL_FONT_FALLBACK };
 
 enum GraphicID { PRIMARY = 0, SPANNING, SYMBOLREF };
 
+//----------------------------------------------------------------------------
+// Measure type
+//----------------------------------------------------------------------------
+
+enum MeasureType { MEASURED = 0, UNMEASURED, NEUMELINE };
+
+#define NEUME_LINE_TYPE "neon-neume-line"
+
 //----------------------------------------------------------------------------
 // Legacy Wolfgang defines
 //----------------------------------------------------------------------------

src/adjustyrelfortranscriptionfunctor.cpp

@@ -0,0 +1,35 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        adjustyrelfortranscriptionfunctor.cpp
+// Author:      Yinan Zhou
+// Created:     2024
+// Copyright (c) Authors and others. All rights reserved.
+/////////////////////////////////////////////////////////////////////////////
+
+#include "adjustyrelfortranscriptionfunctor.h"
+
+//----------------------------------------------------------------------------
+
+//----------------------------------------------------------------------------
+
+namespace vrv {
+
+//----------------------------------------------------------------------------
+// AdjustYRelForTranscriptionFunctor
+//----------------------------------------------------------------------------
+
+AdjustYRelForTranscriptionFunctor::AdjustYRelForTranscriptionFunctor() : Functor() {}
+
+FunctorCode AdjustYRelForTranscriptionFunctor::VisitLayerElement(LayerElement *layerElement)
+{
+    if (layerElement->m_drawingFacsY == VRV_UNSET) return FUNCTOR_CONTINUE;
+
+    if (layerElement->IsScoreDefElement()) return FUNCTOR_SIBLINGS;
+
+    if (!layerElement->HasSelfBB()) return FUNCTOR_CONTINUE;
+
+    layerElement->SetDrawingYRel(-layerElement->GetSelfY1());
+
+    return FUNCTOR_CONTINUE;
+}
+
+} // namespace vrv