ENG-25: Bolster placement defaults

This commit adds some context-aware placement defaults for text and
dynamics (in the case that neither "placement" nor "default-y" nor
"relative-y" are specified). Namely, both expression text and dynamics
are placed below the staff unless it is a vocal staff.

To this end, there are some simple checks added to discern whether a
part is a vocal part, which is currently a simple check against the
name of the staff and a check for the presence of lyrics. Additionally,
the "expression text" is currently defined by the presence of italics in
the _wordsText, and an absence of _tempoText.

Duplicate of musescore#8325, plus fixing a compiler warning, see musescore#8554

Author: iveshenry18

importexport/musicxml/importmxmlpass1.cpp

@@ -3216,6 +3216,7 @@ void MusicXMLParserPass1::note(const QString& partId,
             else if (_e.name() == "lyric") {
                   const auto number = _e.attributes().value("number").toString();
                   _parts[partId].lyricNumberHandler().addNumber(number);
+                  _parts[partId].hasLyrics(true);
                   _e.skipCurrentElement();
                   }
             else if (_e.name() == "notations")

importexport/musicxml/importmxmlpass1.h

@@ -166,6 +166,7 @@ class MusicXMLParserPass1 {
       int octaveShift(const QString& id, const int staff, const Fraction f) const;
       const CreditWordsList& credits() const { return _credits; }
       bool hasBeamingInfo() const { return _hasBeamingInfo; }
+      bool isVocalStaff(const QString& id) const { return _parts[id].isVocalStaff(); }
       static VBox* createAndAddVBoxForCreditWords(Score* const score, const int miny = 0, const int maxy = 75);
       QString supportsTranspose() const { return _supportsTranspose; }
       void addInferredTranspose(const QString& partId);

importexport/musicxml/importmxmlpass2.cpp

@@ -859,8 +859,11 @@ static void addElemOffset(Element* el, int track, const QString& placement, Meas
             el->setPlacement(placement == "above" ? Placement::ABOVE : Placement::BELOW);
             }
 #endif
-      el->setPlacement(placement == "above" ? Placement::ABOVE : Placement::BELOW);
-      el->setPropertyFlags(Pid::PLACEMENT, PropertyFlags::UNSTYLED);
+      if (placement != "") {
+            el->setPlacement(placement == "above" ? Placement::ABOVE : Placement::BELOW);
+            el->setPropertyFlags(Pid::PLACEMENT, PropertyFlags::UNSTYLED);
+      }
+
 
       el->setTrack(el->isTempoText() ? 0 : track);    // TempoText must be in track 0
       Segment* s = measure->getSegment(SegmentType::ChordRest, tick);
@@ -2490,6 +2493,8 @@ void MusicXMLParserDirection::direction(const QString& partId,
 
       _placement = _e.attributes().value("placement").toString();
       int track = _pass1.trackForPart(partId);
+      bool isVocalStaff = _pass1.isVocalStaff(partId);
+      bool isExpressionText = false;
       //qDebug("direction track %d", track);
       QList<MusicXmlSpannerDesc> starts;
       QList<MusicXmlSpannerDesc> stops;
@@ -2574,6 +2579,7 @@ void MusicXMLParserDirection::direction(const QString& partId,
                   if (_wordsText != "" || _metroText != "") {
                         t = new StaffText(_score);
                         t->setXmlText(_wordsText + _metroText);
+                        isExpressionText = _wordsText.contains("<i>") && _metroText.isEmpty();
                         }
                   else {
                         t = new RehearsalMark(_score);
@@ -2598,10 +2604,17 @@ void MusicXMLParserDirection::direction(const QString& partId,
                         t->setFrameType(FrameType::SQUARE);
                         t->setFrameRound(0);
                         }
+
+                  QString wordsPlacement = placement();
+                  // Case-based defaults
+                  if (wordsPlacement.isEmpty()) {
+                        if (isVocalStaff) wordsPlacement = "above";
+                        else if (isExpressionText) wordsPlacement = "below";
+                        }
 
                   if (isLikelyFingering()) {
                         _logger->logDebugInfo(QString("Inferring fingering: %1").arg(_wordsText));
-                        MusicXMLInferredFingering* inferredFingering = new MusicXMLInferredFingering(totalY(), t, _wordsText, track, placement(), measure, tick + _offset);
+                        MusicXMLInferredFingering* inferredFingering = new MusicXMLInferredFingering(totalY(), t, _wordsText, track, wordsPlacement, measure, tick + _offset);
                         inferredFingerings.push_back(inferredFingering);
                         }
                   else if (directionToDynamic()) {
@@ -2610,7 +2623,7 @@ void MusicXMLParserDirection::direction(const QString& partId,
                   else {
                         // Add element to score later, after collecting all the others and sorting by default-y
                         // This allows default-y to be at least respected by the order of elements
-                        MusicXMLDelayedDirectionElement* delayedDirection = new MusicXMLDelayedDirectionElement(hasTotalY() ? totalY() : 100, t, track, placement(), measure, tick + _offset);
+                        MusicXMLDelayedDirectionElement* delayedDirection = new MusicXMLDelayedDirectionElement(hasTotalY() ? totalY() : 100, t, track, wordsPlacement, measure, tick + _offset);
                         delayedDirections.push_back(delayedDirection);
                         }
                   }
@@ -2650,9 +2663,14 @@ void MusicXMLParserDirection::direction(const QString& partId,
                   dyn->setVelocity( dynaValue );
                   }
 
+            QString dynamicsPlacement = placement();
+            // Case-based defaults
+            if (dynamicsPlacement.isEmpty())
+                  dynamicsPlacement = isVocalStaff ? "above" : "below";
+
             // Add element to score later, after collecting all the others and sorting by default-y
             // This allows default-y to be at least respected by the order of elements
-            MusicXMLDelayedDirectionElement* delayedDirection = new MusicXMLDelayedDirectionElement(hasTotalY() ? totalY() : 100, dyn, track, placement(), measure, tick + _offset);
+            MusicXMLDelayedDirectionElement* delayedDirection = new MusicXMLDelayedDirectionElement(hasTotalY() ? totalY() : 100, dyn, track, dynamicsPlacement, measure, tick + _offset);
             delayedDirections.push_back(delayedDirection);
             }
 

importexport/musicxml/importxmlfirstpass.cpp

@@ -16,6 +16,16 @@ namespace Ms {
 
 // TODO: move somewhere else
 
+static const std::vector<QString> vocalInstrumentNames({"Voice",
+                                                        "Soprano",
+                                                        "Mezzo-Soprano",
+                                                        "Alto",
+                                                        "Tenor",
+                                                        "Baritone",
+                                                        "Bass",
+                                                        "Women",
+                                                        "Men"});
+
 MusicXmlPart::MusicXmlPart(QString id, QString name)
       : id(id), name(name)
       {
@@ -92,6 +102,12 @@ void MusicXmlPart::calcOctaveShifts()
             }
       }
 
+bool MusicXmlPart::isVocalStaff() const
+      {
+      return (std::find(vocalInstrumentNames.begin(), vocalInstrumentNames.end(), name) != vocalInstrumentNames.end()
+              || _hasLyrics);
+      }
+      
 //---------------------------------------------------------
 //   interval
 //---------------------------------------------------------

importexport/musicxml/importxmlfirstpass.h

@@ -84,6 +84,8 @@ class MusicXmlPart {
       const LyricNumberHandler& lyricNumberHandler() const { return _lyricNumberHandler; }
       void setMaxStaff(const int staff);
       int maxStaff() const { return _maxStaff; }
+      bool isVocalStaff() const;
+      void hasLyrics(bool b) { _hasLyrics = b; }
 private:
       QString id;
       QString name;
@@ -96,6 +98,7 @@ class MusicXmlPart {
       QVector<MusicXmlOctaveShiftList> octaveShifts; // octave shift list for every staff
       LyricNumberHandler _lyricNumberHandler;
       int _maxStaff = 0;                      // maximum staff value found (1 based), 0 = none
+      bool _hasLyrics = false;
       };
 
 } // namespace Ms