Import left hand fingerings from .gp files.

cameronwhite · cameronwhite · commit b99f56e19dda · 2020-06-06T19:00:39.000-04:00
The thumb is not supported, which is probably something we should add to our file format. #290
diff --git a/source/formats/gp7/converter.cpp b/source/formats/gp7/converter.cpp
@@ -23,6 +23,7 @@
 
 #include <formats/fileformat.h>
 #include <score/keysignature.h>
+#include <score/note.h>
 #include <score/playerchange.h>
 #include <score/position.h>
 #include <score/rehearsalsign.h>
@@ -209,6 +210,37 @@ convertNote(Position &position, const Gp7::Beat &gp_beat,
                             tuning.getNote(note.getString(), false));
     }
 
+    if (gp_note.myLeftFinger)
+    {
+        using FingerType = Gp7::Note::FingerType;
+        switch (*gp_note.myLeftFinger)
+        {
+            case FingerType::Open:
+                note.setLeftHandFingering(
+                    LeftHandFingering(LeftHandFingering::None));
+                break;
+            case FingerType::C:
+                note.setLeftHandFingering(
+                    LeftHandFingering(LeftHandFingering::Little));
+                break;
+            case FingerType::A:
+                note.setLeftHandFingering(
+                    LeftHandFingering(LeftHandFingering::Ring));
+                break;
+            case FingerType::M:
+                note.setLeftHandFingering(
+                    LeftHandFingering(LeftHandFingering::Middle));
+                break;
+            case FingerType::I:
+                note.setLeftHandFingering(
+                    LeftHandFingering(LeftHandFingering::Index));
+                break;
+            case FingerType::P:
+                // TODO - thumb is not currently support for fingerings.
+                break;
+        }
+    }
+
     return note;
 }
 
diff --git a/source/formats/gp7/parser.cpp b/source/formats/gp7/parser.cpp
@@ -471,7 +471,28 @@ parseNotes(const pugi::xml_node &notes_node)
         if (node.child("LetRing"))
             note.myLetRing = true;
 
-        // TODO - import bends and left hand fingerings.
+        if (auto fingering = node.child("LeftFingering"))
+        {
+            using FingerType = Gp7::Note::FingerType;
+
+            std::string_view text = fingering.text().as_string();
+            if (text == "Open")
+                note.myLeftFinger = FingerType::Open;
+            else if (text == "C")
+                note.myLeftFinger = FingerType::C;
+            else if (text == "A")
+                note.myLeftFinger = FingerType::A;
+            else if (text == "M")
+                note.myLeftFinger = FingerType::M;
+            else if (text == "I")
+                note.myLeftFinger = FingerType::I;
+            else if (text == "P")
+                note.myLeftFinger = FingerType::P;
+            else
+                throw FileFormatException("Unexpected finger type.");
+        }
+
+        // TODO - import bends.
 
         const int id = node.attribute("id").as_int();
         notes.emplace(id, note);
diff --git a/source/formats/gp7/parser.h b/source/formats/gp7/parser.h
@@ -230,6 +230,16 @@ struct Note
         NumTypes
     };
 
+    enum class FingerType
+    {
+        Open,
+        C,
+        A,
+        M,
+        I,
+        P
+    };
+
     int myString = 0;
     int myFret = 0;
     bool myPalmMuted = false;
@@ -249,6 +259,7 @@ struct Note
     /// Flags for various combinations of slide types.
     std::bitset<size_t(SlideType::NumTypes)> mySlideTypes;
     std::optional<int> myTrillNote;
+    std::optional<FingerType> myLeftFinger;
 };
 
 /// Container for a Guitar Pro 7 document.
diff --git a/test/formats/gp7/data/notes.gp b/test/formats/gp7/data/notes.gp
diff --git a/test/formats/gp7/test_gp7.cpp b/test/formats/gp7/test_gp7.cpp
@@ -21,6 +21,7 @@
 #include <formats/gp7/gp7importer.h>
 #include <score/generalmidi.h>
 #include <score/keysignature.h>
+#include <score/note.h>
 #include <score/playerchange.h>
 #include <score/score.h>
 #include <score/scoreinfo.h>
@@ -206,6 +207,7 @@ TEST_CASE("Formats/Gp7Import/Notes", "")
         REQUIRE(!note.hasArtificialHarmonic());
         REQUIRE(!note.hasTappedHarmonic());
         REQUIRE(!note.hasTrill());
+        REQUIRE(!note.hasLeftHandFingering());
     }
 
     {
@@ -295,6 +297,13 @@ TEST_CASE("Formats/Gp7Import/Notes", "")
         REQUIRE(note.hasProperty(Note::SlideOutOfUpwards));
     }
 
+    {
+        const Note &note = voice.getPositions()[14].getNotes()[0];
+        REQUIRE(note.hasLeftHandFingering());
+        REQUIRE(note.getLeftHandFingering().getFingerNumber() ==
+                LeftHandFingering::None);
+    }
+
     const Voice &voice2 = score.getSystems()[1].getStaves()[0].getVoices()[0];
     {
         const Note &note = voice2.getPositions()[0].getNotes()[0];
@@ -305,11 +314,31 @@ TEST_CASE("Formats/Gp7Import/Notes", "")
     {
         const Note &note = voice2.getPositions()[1].getNotes()[0];
         REQUIRE(note.hasProperty(Note::LegatoSlide));
+        REQUIRE(note.hasLeftHandFingering());
+        REQUIRE(note.getLeftHandFingering().getFingerNumber() ==
+                LeftHandFingering::Little);
     }
 
     {
         const Note &note = voice2.getPositions()[2].getNotes()[0];
         REQUIRE(note.hasProperty(Note::ShiftSlide));
+        REQUIRE(note.hasLeftHandFingering());
+        REQUIRE(note.getLeftHandFingering().getFingerNumber() ==
+                LeftHandFingering::Ring);
+    }
+
+    {
+        const Note &note = voice2.getPositions()[3].getNotes()[0];
+        REQUIRE(note.hasLeftHandFingering());
+        REQUIRE(note.getLeftHandFingering().getFingerNumber() ==
+                LeftHandFingering::Middle);
+    }
+
+    {
+        const Note &note = voice2.getPositions()[4].getNotes()[0];
+        REQUIRE(note.hasLeftHandFingering());
+        REQUIRE(note.getLeftHandFingering().getFingerNumber() ==
+                LeftHandFingering::Index);
     }
 
     {
@@ -322,6 +351,8 @@ TEST_CASE("Formats/Gp7Import/Notes", "")
         const Position &pos = voice2.getPositions()[6];
         REQUIRE(pos.hasProperty(Position::Acciaccatura));
         REQUIRE(pos.hasProperty(Position::PickStrokeDown));
+        // Left hand fingerings currently don't support thumbs.
+        REQUIRE(!pos.getNotes()[0].hasLeftHandFingering());
     }
 
     {
