-/*
- lyric-phrasing-engraver.cc -- implement Lyric_phrasing_engraver
+/*
+ new-phrasing-engraver.cc -- implement New_phrasing_engraver
- source file of the GNU LilyPond music typesetter
+source file of the GNU LilyPond music typesetter
- (c) 2000 Glen Prideaux <glenprideaux@iname.com>
-*/
-#include <string.h>
-
-#include "lyric-phrasing-engraver.hh"
-#include "note-head.hh"
-#include "translator-group.hh"
-#include "spanner.hh"
-
-
-String get_context_id(Translator_group * ancestor, const char * type);
-String trim_suffix(String &id);
-
-ADD_THIS_TRANSLATOR (Lyric_phrasing_engraver);
-
-/*
- TODO: this code is too hairy, and does things that should be in the
- backend. Fixme.
-*/
-
-/*
- TODO:
-
- shared lyrics should be vertically centered:
-
-
-
-> About lyrics, it happens that there are common words for many bars, like
-> for a refrain say. When there is an even number of lyrics lines, I do not
-> know how to force the positioning of the common lyric line in the plain
-> middle of the others, because this is in between lines. Not a big matter,
-> but it would be a bit nicer if this was doable.
+(c) 2003--2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-/*
- We find start and end of phrases, and align lyrics accordingly.
- Also, lyrics at start of melismata should be left aligned.
-
- Alignment and melismata
- I've taken [a different] approach:
- | |
- | |
- O O <-- second note throws a melisma score element
- \____/
-
- ^ ^
- | |
- Lyric (None)
+#include "translator-group.hh"
+#include "engraver.hh"
+#include "note-head.hh"
+#include "lyric-extender.hh"
+#include "item.hh"
+#include "group-interface.hh"
- Lyric_phrasing_engraver keeps track of the current and previous notes and
- lyrics for each voice, and when it catches a melisma, it adjusts the
- alignment of the lyrics of the previous note. I hope this isn't
- unnecessarily convoluted.
- */
+struct Phrasing_association
+{
+ String name_;
+ Link_array<Grob> lyrics_;
+ Link_array<Grob> heads_;
+ Link_array<Spanner> past_extenders_;
+ Link_array<Spanner> new_extenders_;
+
+ bool melisma_;
+
+ Phrasing_association()
+ {
+ melisma_ = false;
+ }
+};
-Lyric_phrasing_engraver::Lyric_phrasing_engraver()
+class Lyric_phrasing_engraver : public Engraver
{
- voice_alist_ = SCM_EOL;
- any_notehead_l_ = 0;
-}
+public:
+ ~Lyric_phrasing_engraver ();
+ TRANSLATOR_DECLARATIONS(Lyric_phrasing_engraver);
+protected:
+ virtual void acknowledge_grob (Grob_info);
+ virtual void process_acknowledged_grobs ();
+ virtual void stop_translation_timestep ();
+
+private:
+ void add_lyric_phrasing (Grob_info);
+ void add_voice_phrasing (Grob_info);
+ void add_lyric_extender (Grob_info);
+ Phrasing_association *get_phrasing_assoc (String nm);
+ String get_voice_name_for_lyric (Translator_group*tr);
+ Link_array<Phrasing_association> assocs_;
+};
-Lyric_phrasing_engraver::~Lyric_phrasing_engraver()
+Lyric_phrasing_engraver::Lyric_phrasing_engraver()
{
- /*
- No need to delete alist_; that's what Garbage collection is for.
- */
}
void
-Lyric_phrasing_engraver::finalize ()
+Lyric_phrasing_engraver::acknowledge_grob (Grob_info i)
{
- /*
- but do need to unprotect alist_, since Engravers are gc'd now.
- */
-
- voice_alist_ = SCM_EOL;
+ Grob *h = i.grob_;
+
+ if (Note_head::has_interface (h))
+ add_voice_phrasing (i);
+ else if (h->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
+ add_lyric_phrasing (i);
+ else if (Lyric_extender::has_interface (h))
+ add_lyric_extender (i);
}
-
-Syllable_group *
-Lyric_phrasing_engraver::lookup_context_id(const String &context_id)
+Phrasing_association *
+Lyric_phrasing_engraver::get_phrasing_assoc (String nm)
{
- SCM key = ly_str02scm(context_id.ch_C());
- if( ! gh_null_p(voice_alist_) ) {
- SCM s = scm_assoc(key, voice_alist_);
- if(! (gh_boolean_p(s) && !to_boolean(s))) {
- /* match found */
- // ( key . ( (alist_entry . old_entry) . previous_entry) )
- if(to_boolean(gh_cdadr(s))) { // it's an old entry ... make it a new one
- SCM val = gh_cons(gh_cons(gh_caadr(s), SCM_BOOL_F), gh_cddr(s));
- voice_alist_ = scm_assoc_set_x(voice_alist_, gh_car(s), val);
- return unsmob_voice_entry (gh_caar(val));
- }
- else { // the entry is current ... return it.
- SCM entry_scm = gh_caadr(s);
- return unsmob_voice_entry(entry_scm);
- }
+ Phrasing_association * a=0;
+ for (int i=0 ; !a && i < assocs_.size (); i++)
+ {
+ if (assocs_[i]->name_ == nm)
+ a = assocs_[i];
}
- }
- // ( ( alist_entry . old_entry ) . previous_entry )
- SCM val = gh_cons(gh_cons(Syllable_group::make_entry (), SCM_BOOL_F),
- Syllable_group::make_entry ());
- voice_alist_ = scm_acons(key, val, voice_alist_);
- return unsmob_voice_entry (gh_caar(val));
+ if (!a)
+ {
+ a = new Phrasing_association ;
+ a->name_ = nm;
+ assocs_.push (a);
+ }
+ return a;
}
-void
-Lyric_phrasing_engraver::record_notehead(const String &context_id,
- Grob * notehead)
-{
- Syllable_group * v = lookup_context_id(context_id);
- v->set_notehead(notehead);
- if(!any_notehead_l_)
- any_notehead_l_ = notehead;
-}
-
-void
-Lyric_phrasing_engraver::record_lyric(const String &context_id, Grob * lyric)
-{
- Syllable_group * v = lookup_context_id(context_id);
- v->add_lyric(lyric);
-}
-void
-Lyric_phrasing_engraver::record_extender(const String &context_id, Grob * extender)
+String
+Lyric_phrasing_engraver::get_voice_name_for_lyric (Translator_group*tr)
{
- SCM key = ly_str02scm(context_id.ch_C());
- if( ! gh_null_p(voice_alist_) ) {
- SCM s = scm_assoc(key, voice_alist_);
- if(! (gh_boolean_p(s) && !to_boolean(s))) {
- /* match found */
- // ( key . ( (alist_entry . old_entry) . previous_entry) )
- SCM previous_scm = gh_cddr(s);
- if(previous_scm != SCM_EOL) {
- Syllable_group * v = unsmob_voice_entry(previous_scm);
- v->add_extender(extender);
- }
+ SCM voice_context = tr->get_property ("associatedVoiceContext");
+ if (Translator *vc = unsmob_translator (voice_context))
+ {
+ return dynamic_cast<Translator_group*> (vc)->id_string_;
+ }
+
+ SCM voice = tr->get_property ("associatedVoice");
+ String nm = tr->id_string_;
+ if (gh_string_p (voice))
+ nm = ly_scm2string (voice);
+ else
+ {
+ int idx = nm.index_last ('-');
+ if (idx >= 0)
+ nm = nm.left_string (idx);
}
- }
-}
-void
-Lyric_phrasing_engraver::record_melisma(const String &context_id)
-{
- Syllable_group * v = lookup_context_id(context_id);
- v->set_melisma();
+ return nm;
}
-
+
+
void
-Lyric_phrasing_engraver::acknowledge_grob(Grob_info i)
+Lyric_phrasing_engraver::add_lyric_extender (Grob_info inf)
{
- SCM p = get_property("automaticPhrasing");
- if(!to_boolean(p))
- return;
+ Translator_group * tr = inf.origin_trans_->daddy_trans_;
+ while (tr && !tr->is_alias (ly_symbol2scm ("LyricsVoice")))
+ tr = tr->daddy_trans_;
+ if (!tr)
+ return;
- Grob *h = i.elem_l_;
-
- if (Note_head::has_interface(h)) {
- /* caught a note head ... do something with it */
- /* ... but not if it's a grace note ... */
- bool grace= to_boolean (i.elem_l_->get_grob_property ("grace"));
- SCM wg = get_property ("weAreGraceContext");
- bool wgb = to_boolean (wg);
- if (grace != wgb)
- return;
+
+ Phrasing_association *a = get_phrasing_assoc (get_voice_name_for_lyric (tr));
+ a->new_extenders_.push (dynamic_cast<Spanner*> (inf.grob_));
+}
- /* what's its Voice context name? */
- String voice_context_id = get_context_id(i.origin_trans_l_->daddy_trans_l_, "Voice");
- record_notehead(voice_context_id, h);
- /* is it in a melisma ? */
- if(to_boolean(i.origin_trans_l_->get_property("melismaEngraverBusy"))) {
- record_melisma(voice_context_id);
- }
- return;
- }
-
- /* now try for a lyric */
- if (h->has_interface (ly_symbol2scm ("lyric-syllable-interface"))) {
+void
+Lyric_phrasing_engraver::add_voice_phrasing (Grob_info inf)
+{
+ Translator_group * tr = inf.origin_trans_->daddy_trans_;
+ while (tr && !tr->is_alias (ly_symbol2scm ("Voice")))
+ tr = tr->daddy_trans_;
- /* what's its LyricsVoice context name? */
- String voice_context_id;
- SCM voice_context_scm = i.origin_trans_l_->get_property("associatedVoice");
- if (gh_string_p (voice_context_scm)) {
- voice_context_id = ly_scm2string(voice_context_scm);
- }
- else {
- voice_context_id = get_context_id(i.origin_trans_l_->daddy_trans_l_, "LyricsVoice");
- voice_context_id = trim_suffix(voice_context_id);
- }
- record_lyric(voice_context_id, h);
+ if (!tr)
return;
- }
- /* Catch any extender items and then if we have a melisma,
- set the RIGHT item of the extender spanner to the melismatic note in
- the corresponding context (if any).
- This has the effect of finishing the extender under the last note
- of the melisma, instead of extending it to the next lyric.
-
- Problem: the extender request is thrown at the same moment as the next lyric,
- by which time we have already passed the last note of the melisma.
- However, the Lyric_phrasing_engraver remembers the last note, so just
- attach it to that, provided it was melismatic. If it was not melismatic,
- then ignore it and let the Extender_engraver take care of it (i.e. finish at next
- lyric).
- */
- if(h->has_interface (ly_symbol2scm ("lyric-extender-interface"))) {
- String voice_context_id = get_context_id(i.origin_trans_l_->daddy_trans_l_, "LyricsVoice");
- record_extender(trim_suffix(voice_context_id), h);
- return;
- }
+ Phrasing_association *a = get_phrasing_assoc (tr->id_string_);
+ a->heads_.push (inf.grob_);
+ a->melisma_ = melisma_busy (inf.origin_trans_);
}
-String
-get_context_id(Translator_group * ancestor, const char *type)
+void
+Lyric_phrasing_engraver::add_lyric_phrasing (Grob_info inf)
{
- while(ancestor != 0 && ancestor->type_str_ != type) {
- ancestor = ancestor->daddy_trans_l_;
- }
+ Translator_group * tr = inf.origin_trans_->daddy_trans_;
+ while (tr && !tr->is_alias (ly_symbol2scm ("LyricsVoice")))
+ tr = tr->daddy_trans_;
- if(ancestor != 0) {
- return ancestor->id_str_;
- }
+ if (!tr)
+ return;
- return "";
-}
-String
-trim_suffix(String &id)
-{
- int index = id.index_i('-');
- if(index >= 0) {
- return id.left_str(index);
- }
- return id;
+ Phrasing_association *a = get_phrasing_assoc (get_voice_name_for_lyric (tr));
+ a->lyrics_.push (inf.grob_);
+ a->past_extenders_.clear ();
}
-
-void Lyric_phrasing_engraver::create_grobs ()
+void
+Lyric_phrasing_engraver::stop_translation_timestep ()
{
- /* iterate through entries in voice_alist_
- for each, call set_lyric_align(alignment). Issue a warning if this returns false.
- */
- String punc;
- SCM sp = get_property("phrasingPunctuation");
- punc = gh_string_p(sp) ? ly_scm2string(sp) : ".,;:?!\"";
-
- for(SCM v=voice_alist_; gh_pair_p(v); v = gh_cdr(v)) {
- SCM v_entry = gh_cdar(v);
- // ((current . oldflag) . previous)
- if(!to_boolean(gh_cdar(v_entry))) { // not an old entry left over from a prior note ...
- Syllable_group *entry = unsmob_voice_entry(gh_caar(v_entry));
-
- /*
- TODO: give context for warning.
- */
- if(! entry->set_lyric_align(punc.ch_C(), any_notehead_l_))
- warning (_ ("lyrics found without any matching notehead"));
-
- // is this note melismatic? If so adjust alignment of previous one.
- if(entry->get_melisma()) {
- if(entry->lyric_count())
- warning (_ ("Huh? Melismatic note found to have associated lyrics."));
- SCM previous_scm = gh_cdr(v_entry);
- if(previous_scm != SCM_EOL) {
- Syllable_group *previous = unsmob_voice_entry(previous_scm);
- if (previous->lyric_count())
- previous->adjust_melisma_align();
- }
- }
+ for (int i = assocs_.size (); i--; )
+ {
+ assocs_[i]->heads_.clear ();
+ assocs_[i]->lyrics_.clear ();
+ assocs_[i]->past_extenders_.concat (assocs_[i]->new_extenders_) ;
+ assocs_[i]->new_extenders_.clear ();
}
- }
}
-
void
-Lyric_phrasing_engraver::stop_translation_timestep ()
+Lyric_phrasing_engraver::process_acknowledged_grobs ()
{
- for(SCM v=voice_alist_; gh_pair_p(v); v = gh_cdr(v)) {
- SCM entry_scm = gh_cdar(v);
- // ((alist_entry . entry_is_old) . previous_entry)
- Syllable_group * entry = unsmob_voice_entry(gh_caar(entry_scm));
-
- // set previous_entry, set entry_is_old, and resave it to alist_
- // but only change if this current was not old.
- if(! to_boolean(gh_cdar(entry_scm))) {
- Syllable_group * previous_entry = unsmob_voice_entry(gh_cdr(entry_scm));
- previous_entry->copy(entry);
- entry_scm = gh_cons(gh_cons(gh_caar(entry_scm), SCM_BOOL_T), gh_cdr(entry_scm));
- voice_alist_ = scm_assoc_set_x(voice_alist_, gh_caar(v), entry_scm);
+ for (int i = 0; i < assocs_.size (); i++)
+ {
+ Phrasing_association * a = assocs_[i];
+ if (! (a->heads_.size() && (a->lyrics_.size () || a->past_extenders_.size ())))
+ continue;
+
+ Grob *h = a->heads_[0];
+ Direction alignment = CENTER;
+ if (a->melisma_)
+ alignment = LEFT;
+
+ for (int j = 0; j < a->lyrics_.size (); j++)
+ {
+ Grob *l = a->lyrics_[j];
+ if (!l->get_parent (X_AXIS))
+ {
+ l->set_parent (h, X_AXIS);
+ if (alignment)
+ l->set_grob_property ("self-alignment-X", gh_int2scm (alignment));
+ }
+ }
+
+ for (int j = a->past_extenders_.size(); j--;)
+ Pointer_group_interface::add_grob (a->past_extenders_[j],ly_symbol2scm ("heads"), h);
}
- entry->next_lyric();
- }
- any_notehead_l_ = 0;
}
+Lyric_phrasing_engraver::~Lyric_phrasing_engraver ()
+{
+ for (int i =assocs_.size(); i--;)
+ delete assocs_[i];
+}
+ENTER_DESCRIPTION(Lyric_phrasing_engraver,
+ "This engraver combines note heads and lyrics for alignment. ",
+ "",
+ "",
+ "lyric-syllable-interface note-head-interface lyric-extender-interface",
+ "associatedVoice",
+ "");
projects / lilypond.git / blobdiff