How to access lyrics programmatically?

nbr

• Nov 1, 2012 - 13:48

Hi,

is there any way to access the text objects that are already in the score? I couldn't find anything in the API.

I thought I'd quickly write a plugin that would work around the problem of placing lyrics above/below the staff. The plugin could eg. have a functionality "On each line, move all lyrics syllables associated with this voice vertically to the same position where the first one is".

Thanks for your help!

Comments

[DELETED] 5

• Nov 2, 2012 - 07:15

Unfortunatly the current plugin framework in MuseScore 1.2 doesn't give access to Lyrics elements.

nbr

• Nov 2, 2012 - 12:20

Thanks for the reply. Is there any hope that this could be possible in eg. 2.0?

Or is there / could there be access to the "raw" data, something like the xml contents of a saved file?

[DELETED] 5

• Nov 2, 2012 - 12:31

Using the raw data is technically possible but not really great since that can change...

Lyric elements are accessible in 2.0. You can check a nightly build and Plugin -> Plugin Editor, click on the help icon to access the documentation.

Jojo-Schmitz

• Nov 2, 2012 - 12:37

That plugin documentation access still doesn't work, at least not in the Windows version...
See #17688: Plugin documentation not available in the nightly builds

nbr

• Nov 21, 2012 - 21:26

Thanks for the answers so far! One more question: how do I actually access Lyrics elements in a 2.0 plugin? I tried to find them as a property of a Chord or a Note, but couldn't find anything.

[DELETED] 5

• Nov 26, 2012 - 15:05

I'm not sure it's the best way to solve the problem for lyrics below and above the staff. If you need this, you should probably use odd and even lyrics text style and use the Y property to move the lyrics. See attached file.

Starting from c56fa93212, you can read lyrics (read only) from a chord. it will give you the list of lyrics for a chord, "vertically". I tested with

import QtQuick 1.0
import MuseScore 1.0

MuseScore {
      menuPath: "Plugins.pluginName"
      onRun: {
            var cursor = curScore.newCursor();
            for (var track = 0; track < curScore.ntracks; ++track) {
                  cursor.track = track;
                  cursor.rewind(0);  // set cursor to first chord/rest

                  while (cursor.segment) {
                        if (cursor.element && cursor.element.type == Element.CHORD) {
                              var lyrics = cursor.element.lyrics;
                              for (var i = 0; i < lyrics.length; i++) {
                                    var l = lyrics[i];
                                    console.log("Lyric " + l.text);
                                    }
                              }
                        cursor.next();
                        }
                  }
            Qt.quit();
            }
      }

Attachment	Size
lyricsAboveBelow.mscz	1.98 KB

Jojo-Schmitz

• Nov 27, 2012 - 10:12

Problem with this implementation: you get the raw sylabels only with no indication whether they form a word on their own or belong together with other sylables, information about the dash is lost. Melisma are lost too.

[DELETED] 5

• Dec 4, 2012 - 10:38

Sure. It's a start ;) pull requests to expose more information about lyrics is welcome.

Jojo-Schmitz

• Dec 4, 2012 - 12:39

Haven't yet found the place where - and _ in lyrics entry are handled and how they are stored in the score.
No problem with Ctrl- and Ctrl_ (they are just part of the sylable), but that's not what we'd need here.

[DELETED] 5

• Dec 7, 2012 - 15:44

I added support for syllabic in 451404f6e0

import QtQuick 1.0
import MuseScore 1.0

MuseScore {
      menuPath: "Plugins.pluginName"
      onRun: {
            var cursor = curScore.newCursor();
            var sArray= new Array();
            for (var track = 0; track < curScore.ntracks; ++track) {
                  cursor.track = track;
                  cursor.rewind(0);  // set cursor to first chord/rest
                  while (cursor.segment) {
                        if (cursor.element && cursor.element.type == Element.CHORD) {
                              var lyrics = cursor.element.lyrics;
                              for (var i = 0; i < lyrics.length; i++) {
                                    var l = lyrics[i];
                                    if(!l)
                                      continue;
                                    if(sArray[i] == undefined)
                                         sArray[i] = "";
                                    if(l.syllabic == Lyrics.SINGLE || l.syllabic == Lyrics.END)
                                         sArray[i] += l.text + " ";
                                    if(l.syllabic == Lyrics.MIDDLE || l.syllabic == Lyrics.BEGIN)
                                         sArray[i] += l.text;
                                    }
                              }
                        cursor.next();
                        }
                  }
            for (var i = 0; i < sArray.length; i++) {
                  console.log(sArray[i]);
                  }
            Qt.quit();
            }
      }

DrNoes

• Dec 12, 2012 - 13:06

Hi!

Is ther a similar way to access other text elements (i added some programatically via addStaffText())?

I need to remove them again before the plugin runs a second time...
(Could you implement something like tagged texts, so a text can be annotated with the plugin name or some arbitary string to identify it again for removal?)

Best Regards!

Dr Noes