Merge pull request #3588 from rism-digital/develop-tab

Merge `develop-tab` into `develop`

include/vrv/note.h

@@ -13,6 +13,7 @@
 //----------------------------------------------------------------------------
 
 #include "accid.h"
+#include "altsyminterface.h"
 #include "atts_analytical.h"
 #include "atts_externalsymbols.h"
 #include "atts_frettab.h"
@@ -45,6 +46,7 @@ class Verse;
  */
 class Note : public LayerElement,
              public StemmedDrawingInterface,
+             public AltSymInterface,
              public DurationInterface,
              public PitchInterface,
              public PositionInterface,
@@ -80,6 +82,8 @@ class Note : public LayerElement,
      * @name Getter to interfaces
      */
     ///@{
+    AltSymInterface *GetAltSymInterface() override { return vrv_cast<AltSymInterface *>(this); }
+    const AltSymInterface *GetAltSymInterface() const override { return vrv_cast<const AltSymInterface *>(this); }
     DurationInterface *GetDurationInterface() override { return vrv_cast<DurationInterface *>(this); }
     const DurationInterface *GetDurationInterface() const override { return vrv_cast<const DurationInterface *>(this); }
     PitchInterface *GetPitchInterface() override { return vrv_cast<PitchInterface *>(this); }
@@ -145,7 +149,7 @@ class Note : public LayerElement,
      * @name Return the smufl string to use for a note give the notation type
      */
     ///@{
-    std::u32string GetTabFretString(data_NOTATIONTYPE notationType) const;
+    std::u32string GetTabFretString(data_NOTATIONTYPE notationType, int &overline, int &strike, int &underline) const;
     ///@}
 
     /**

include/vrv/rest.h

@@ -8,6 +8,7 @@
 #ifndef __VRV_REST_H__
 #define __VRV_REST_H__
 
+#include "altsyminterface.h"
 #include "atts_externalsymbols.h"
 #include "atts_mensural.h"
 #include "durationinterface.h"
@@ -34,6 +35,7 @@ enum RestNotePlace { RNP_UNSET = -1, RNP_noteInSpace, RNP_noteOnLine };
  * This class models the MEI <rest> element.
  */
 class Rest : public LayerElement,
+             public AltSymInterface,
              public DurationInterface,
              public PositionInterface,
              public AttColor,
@@ -69,6 +71,7 @@ class Rest : public LayerElement,
      * @name Getter to interfaces
      */
     ///@{
+    AltSymInterface *GetAltSymInterface() override { return vrv_cast<AltSymInterface *>(this); }
     PositionInterface *GetPositionInterface() override { return vrv_cast<PositionInterface *>(this); }
     const PositionInterface *GetPositionInterface() const override { return vrv_cast<const PositionInterface *>(this); }
     DurationInterface *GetDurationInterface() override { return vrv_cast<DurationInterface *>(this); }

include/vrv/staffdef.h

@@ -32,7 +32,8 @@ class StaffDef : public ScoreDefElement,
                  public AttStaffDefLog,
                  public AttStaffDefVis,
                  public AttTimeBase,
-                 public AttTransposition {
+                 public AttTransposition,
+                 public AttVerticalAlign {
 public:
     /**
      * @name Constructors, destructors, and other standard methods

include/vrv/tabdursym.h

@@ -21,7 +21,7 @@ namespace vrv {
 /**
  * This class models the MEI <tabDurSym> element.
  */
-class TabDurSym : public LayerElement, public StemmedDrawingInterface, public AttNNumberLike {
+class TabDurSym : public LayerElement, public StemmedDrawingInterface, public AttNNumberLike, public AttStaffLoc {
 public:
     /**
      * @name Constructors, destructors, and other standard methods
@@ -30,6 +30,7 @@ class TabDurSym : public LayerElement, public StemmedDrawingInterface, public At
     ///@{
     TabDurSym();
     virtual ~TabDurSym();
+    Object *Clone() const override { return new TabDurSym(*this); }
     void Reset() override;
     std::string GetClassName() const override { return "TabDurSym"; }
     ///@}

include/vrv/tabgrp.h

@@ -29,6 +29,7 @@ class TabGrp : public LayerElement, public ObjectListInterface, public DurationI
     ///@{
     TabGrp();
     virtual ~TabGrp();
+    Object *Clone() const override { return new TabGrp(*this); }
     void Reset() override;
     std::string GetClassName() const override { return "TabGrp"; }
     ///@}

include/vrv/tuning.h

@@ -40,9 +40,22 @@ class Tuning : public Object, public AttCourseLog {
     bool IsSupportedChild(Object *object) override;
 
     /**
-     * Return the line for a the tuning and a given course and a notation type
+     * Return the line for a note according to tablature type.
+     * Guitar, french and italian tablature: the line is based on the course.
+     * German tablature: the line is based on the note's index in the note list
+     * or by explicit @loc.
+     *
+     * @param[in] course
+     * @param[in] notationType
+     * @param[in] lines
+     * @param[in] listSize
+     * @param[in] index - 0 based from the bottom of the chord
+     * @param[in] loc - German tablature: note@loc if specified, 0 at the bottom
+     * @param[in] topAlign - German tablature: true => align at the top, false => align at the bottom
+     * @return position in staff half lines
      */
-    int CalcPitchPos(int course, data_NOTATIONTYPE notationType, int lines) const;
+    int CalcPitchPos(
+        int course, data_NOTATIONTYPE notationType, int lines, int listSize, int index, int loc, bool topAlign) const;
 
     /**
      * Calculate the MIDI note number for course/fret

include/vrv/view.h

@@ -232,7 +232,7 @@ class View {
     void DrawMeterSigGrp(DeviceContext *dc, Layer *layer, Staff *staff);
     void DrawMNum(DeviceContext *dc, MNum *mnum, Measure *measure, System *system, int yOffset);
     void DrawStaff(DeviceContext *dc, Staff *staff, Measure *measure, System *system);
-    void DrawStaffLines(DeviceContext *dc, Staff *staff, Measure *measure, System *system);
+    void DrawStaffLines(DeviceContext *dc, Staff *staff, StaffDef *staffDef, Measure *measure, System *system);
     void DrawLayer(DeviceContext *dc, Layer *layer, Staff *staff, Measure *measure);
     void DrawLayerList(DeviceContext *dc, Layer *layer, Staff *staff, Measure *measure, const ClassId classId);
     void DrawLayerDefLabels(

include/vrv/vrvdef.h

@@ -695,6 +695,7 @@ enum MeasureType { MEASURED = 0, UNMEASURED, NEUMELINE };
 //----------------------------------------------------------------------------
 
 #define TABLATURE_STAFF_RATIO 1.75
+#define GERMAN_TAB_STAFF_RATIO 2.2
 
 #define SUPER_SCRIPT_FACTOR 0.58
 #define SUPER_SCRIPT_POSITION -0.20 // lowered down from the midline

src/beam.cpp

@@ -602,8 +602,8 @@ void BeamSegment::CalcBeamInit(
         beamInterface->m_beamWidthBlack /= 2;
         beamInterface->m_beamWidthWhite /= 2;
 
-        // Adjust it further for tab.lute.french and tab.lute.italian
-        if (staff->IsTabLuteFrench() || staff->IsTabLuteItalian()) {
+        // Adjust it further for tab.lute.french, tab.lute.german and tab.lute.italian
+        if (staff->IsTabLuteFrench() || staff->IsTabLuteGerman() || staff->IsTabLuteItalian()) {
             beamInterface->m_beamWidthBlack = beamInterface->m_beamWidthBlack * 2 / 5;
             beamInterface->m_beamWidthWhite = beamInterface->m_beamWidthWhite * 3 / 5;
         }

src/calcalignmentpitchposfunctor.cpp

@@ -17,6 +17,7 @@
 #include "rest.h"
 #include "score.h"
 #include "staff.h"
+#include "tabgrp.h"
 #include "tuning.h"
 
 //----------------------------------------------------------------------------
@@ -105,8 +106,10 @@ FunctorCode CalcAlignmentPitchPosFunctor::VisitLayerElement(LayerElement *layerE
         TabGrp *tabGrp = note->IsTabGrpNote();
         if (tabGrp) {
             assert(staffY->m_drawingTuning);
-            loc = staffY->m_drawingTuning->CalcPitchPos(
-                note->GetTabCourse(), staffY->m_drawingNotationType, staffY->m_drawingLines);
+            assert(staffY->m_drawingStaffDef);
+            loc = staffY->m_drawingTuning->CalcPitchPos(note->GetTabCourse(), staffY->m_drawingNotationType,
+                staffY->m_drawingLines, tabGrp->GetListSize(), tabGrp->GetListIndex(note), note->GetLoc(),
+                staffY->m_drawingStaffDef->GetValign() != VERTICALALIGNMENT_bottom);
         }
         else if ((note->HasPname() && (note->HasOct() || note->HasOctDefault())) || note->HasLoc()) {
             loc = PitchInterface::CalcLoc(note, layerY, layerElementY);
@@ -307,7 +310,7 @@ FunctorCode CalcAlignmentPitchPosFunctor::VisitLayerElement(LayerElement *layerE
     else if (layerElement->Is(TABDURSYM)) {
         int yRel = 0;
         if (staffY->IsTabWithStemsOutside()) {
-            double spacingRatio = (staffY->IsTabLuteFrench()) ? 2.0 : 1.0;
+            double spacingRatio = (staffY->IsTabLuteFrench() || staffY->IsTabLuteGerman()) ? 2.0 : 1.0;
             yRel += m_doc->GetDrawingUnit(staffY->m_drawingStaffSize) * spacingRatio;
         }
         layerElement->SetDrawingYRel(yRel);

src/iomei.cpp

@@ -1840,6 +1840,7 @@ void MEIOutput::WriteStaffDef(pugi::xml_node currentNode, StaffDef *staffDef)
     staffDef->WriteStaffDefVis(currentNode);
     staffDef->WriteTimeBase(currentNode);
     staffDef->WriteTransposition(currentNode);
+    staffDef->WriteVerticalAlign(currentNode);
 }
 
 void MEIOutput::WriteInstrDef(pugi::xml_node currentNode, InstrDef *instrDef)
@@ -2763,6 +2764,7 @@ void MEIOutput::WriteNote(pugi::xml_node currentNode, Note *note)
     assert(note);
 
     this->WriteLayerElement(currentNode, note);
+    this->WriteAltSymInterface(currentNode, note);
     this->WriteDurationInterface(currentNode, note);
     this->WritePitchInterface(currentNode, note);
     this->WritePositionInterface(currentNode, note);
@@ -2823,6 +2825,7 @@ void MEIOutput::WriteRest(pugi::xml_node currentNode, Rest *rest)
     assert(rest);
 
     this->WriteLayerElement(currentNode, rest);
+    this->WriteAltSymInterface(currentNode, rest);
     this->WriteDurationInterface(currentNode, rest);
     this->WritePositionInterface(currentNode, rest);
     rest->WriteColor(currentNode);
@@ -2856,6 +2859,7 @@ void MEIOutput::WriteTabDurSym(pugi::xml_node currentNode, TabDurSym *tabDurSym)
 
     this->WriteLayerElement(currentNode, tabDurSym);
     tabDurSym->WriteNNumberLike(currentNode);
+    tabDurSym->WriteStaffLoc(currentNode);
 }
 
 void MEIOutput::WriteTabGrp(pugi::xml_node currentNode, TabGrp *tabGrp)
@@ -3842,6 +3846,9 @@ bool MEIInput::IsAllowed(std::string element, Object *filterParent)
         if (element == "note") {
             return true;
         }
+        if (element == "rest") {
+            return true;
+        }
         else {
             return false;
         }
@@ -5207,6 +5214,7 @@ bool MEIInput::ReadStaffDef(Object *parent, pugi::xml_node staffDef)
     vrvStaffDef->ReadStaffDefVis(staffDef);
     vrvStaffDef->ReadTimeBase(staffDef);
     vrvStaffDef->ReadTransposition(staffDef);
+    vrvStaffDef->ReadVerticalAlign(staffDef);
 
     if (!vrvStaffDef->HasN()) {
         LogWarning("No @n on <staffDef> might yield unpredictable results");
@@ -6967,6 +6975,7 @@ bool MEIInput::ReadNote(Object *parent, pugi::xml_node note)
         }
     }
 
+    this->ReadAltSymInterface(note, vrvNote);
     this->ReadDurationInterface(note, vrvNote);
     this->ReadPitchInterface(note, vrvNote);
     this->ReadPositionInterface(note, vrvNote);
@@ -7021,6 +7030,7 @@ bool MEIInput::ReadRest(Object *parent, pugi::xml_node rest)
         }
     }
 
+    this->ReadAltSymInterface(rest, vrvRest);
     this->ReadDurationInterface(rest, vrvRest);
     this->ReadPositionInterface(rest, vrvRest);
     vrvRest->ReadColor(rest);
@@ -7150,6 +7160,7 @@ bool MEIInput::ReadTabDurSym(Object *parent, pugi::xml_node tabRhyhtm)
     this->ReadLayerElement(tabRhyhtm, vrvTabDurSym);
 
     vrvTabDurSym->ReadNNumberLike(tabRhyhtm);
+    vrvTabDurSym->ReadStaffLoc(tabRhyhtm);
 
     parent->AddChild(vrvTabDurSym);
     this->ReadUnsupportedAttr(tabRhyhtm, vrvTabDurSym);
@@ -7287,6 +7298,9 @@ bool MEIInput::ReadSymbolDefChildren(Object *parent, pugi::xml_node parentNode,
         else if (elementName == "svg") {
             success = this->ReadSvg(parent, xmlElement);
         }
+        else if (elementName == "symbol") {
+            success = this->ReadSymbol(parent, xmlElement);
+        }
         // xml comment
         else if (elementName == "") {
             success = this->ReadXMLComment(parent, xmlElement);