X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Flyric-combine-music-iterator.cc;h=bf5d02d8b2876a2b1d154c2064cbab0f9d17bff9;hb=ba824abf873d98c5afa9f8236beb85929cec0c03;hp=639cbaae25e61e17b9b3f156a77f518633bef6ea;hpb=339ea28cd7e4f8a1c1ca7c1d4dfe803a3f4c03e6;p=lilypond.git diff --git a/lily/lyric-combine-music-iterator.cc b/lily/lyric-combine-music-iterator.cc index 639cbaae25..bf5d02d8b2 100644 --- a/lily/lyric-combine-music-iterator.cc +++ b/lily/lyric-combine-music-iterator.cc @@ -1,109 +1,335 @@ -/* - lyric-combine-music-iterator.cc -- implement Lyric_combine_music_iterator - +/* + new-lyric-combine-iterator.cc -- implement Lyric_combine_music_iterator + source file of the GNU LilyPond music typesetter - - (c) 1999 Han-Wen Nienhuys - - */ -#include "translator-group.hh" -#include "lyric-combine-music-iterator.hh" -#include "lyric-combine-music.hh" -#include "musical-request.hh" + (c) 2004--2007 Han-Wen Nienhuys +*/ + +#include "dispatcher.hh" +#include "global-context.hh" +#include "grob.hh" +#include "input.hh" +#include "international.hh" +#include "listener.hh" +#include "music-iterator.hh" +#include "music.hh" + +/* + This iterator is hairy. It tracks both lyric and melody contexts, + and has a complicated communication route, reading/writing + properties in both. + + In the future, this should rather be done with + + \interpretAsMelodyFor { MUSIC } { LYRICS LYRICS LYRICS } + + This can run an interpret step on MUSIC, generating a stream. Then + the stream can be perused at leisure to apply durations to all of + the LYRICS. +*/ + +class Lyric_combine_music_iterator : public Music_iterator +{ +public: + Lyric_combine_music_iterator (); + Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src); + DECLARE_SCHEME_CALLBACK (constructor, ()); +protected: + virtual void construct_children (); + virtual Moment pending_moment () const; + virtual void do_quit (); + virtual void process (Moment); + virtual bool run_always ()const; + virtual bool ok () const; + virtual void derived_mark () const; + virtual void derived_substitute (Context *, Context *); + void set_music_context (Context *to); +private: + bool start_new_syllable () const; + Context *find_voice (); + DECLARE_LISTENER (set_busy); + DECLARE_LISTENER (check_new_context); -Busy_playing_req busy_req; -Melisma_req melisma_start_req; -Melisma_req melisma_stop_req; -Melisma_playing_req melisma_playing_req; + bool music_found_; + Context *lyrics_context_; + Context *music_context_; + SCM lyricsto_voice_name_; + Moment busy_moment_; + Moment pending_grace_moment_; + + Music_iterator *lyric_iter_; +}; Lyric_combine_music_iterator::Lyric_combine_music_iterator () { - melisma_start_req.span_dir_ = START; - melisma_stop_req.span_dir_ = STOP; + music_found_ = false; + pending_grace_moment_.set_infinite (1); + lyric_iter_ = 0; + music_context_ = 0; + lyrics_context_ = 0; + busy_moment_.set_infinite (-1); +} + + +/* + It's dubious whether we can ever make this fully work. Due to + associatedVoice switching, this routine may be triggered for + the wrong music_context_ + */ +IMPLEMENT_LISTENER (Lyric_combine_music_iterator, set_busy) +void +Lyric_combine_music_iterator::set_busy (SCM se) +{ + Stream_event *e = unsmob_stream_event (se); + + if ((e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event")) + && music_context_) + + busy_moment_ = max (music_context_->now_mom (), + busy_moment_); - melisma_started_b_ = false; - music_iter_p_ =0; - lyric_iter_p_ =0; +} + +void +Lyric_combine_music_iterator::set_music_context (Context *to) +{ + if (music_context_) + { + music_context_->event_source ()->remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event")); + } + + music_context_ = to; + if (to) + { + to->event_source ()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event")); + } +} + +bool +Lyric_combine_music_iterator::start_new_syllable () const +{ + if (busy_moment_ < music_context_->now_mom ()) + return false; + + if (!lyrics_context_) + return false; + + if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata"))) + { + bool m = melisma_busy (music_context_); + if (m) + return false; + } + + return true; } Moment -Lyric_combine_music_iterator::next_moment () const +Lyric_combine_music_iterator::pending_moment () const { - Moment musnext = music_iter_p_->next_moment (); - return musnext; + Moment m; + + m.set_infinite (1); + + return m; +} + +bool +Lyric_combine_music_iterator::run_always () const +{ + return true; } bool Lyric_combine_music_iterator::ok () const { - return music_iter_p_->ok (); + return lyric_iter_ && lyric_iter_->ok (); } void -Lyric_combine_music_iterator::do_print () const +Lyric_combine_music_iterator::derived_mark ()const { - music_iter_p_->print (); - lyric_iter_p_->print (); + if (lyric_iter_) + scm_gc_mark (lyric_iter_->self_scm ()); + if (lyrics_context_) + scm_gc_mark (lyrics_context_->self_scm ()); + if (music_context_) + scm_gc_mark (music_context_->self_scm ()); } void -Lyric_combine_music_iterator::construct_children () +Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t) { - Lyric_combine_music const * m = dynamic_cast (music_l_); - - music_iter_p_ = get_iterator_p (m->music_l ()); - lyric_iter_p_ = get_iterator_p (m->lyrics_l ()); + if (lyric_iter_) + lyric_iter_->substitute_outlet (f, t); + if (lyrics_context_ && lyrics_context_ == f) + lyrics_context_ = t; + if (music_context_ && music_context_ == f) + set_music_context (t); } void -Lyric_combine_music_iterator::do_process_and_next (Moment m) +Lyric_combine_music_iterator::construct_children () { - Moment my_next = music_iter_p_->next_moment (); - if (my_next > m) + Music *m = unsmob_music (get_music ()->get_property ("element")); + lyric_iter_ = unsmob_iterator (get_iterator (m)); + if (!lyric_iter_) return; - - music_iter_p_->process_and_next (m); + lyrics_context_ = find_context_below (lyric_iter_->get_outlet (), + ly_symbol2scm ("Lyrics"), ""); - bool busy = try_music (&busy_req); - if (busy) + if (!lyrics_context_) { - bool melisma_b = try_music (&melisma_playing_req); - if (!melisma_started_b_ || !melisma_b) - { - if (lyric_iter_p_->ok ()) - { - if (melisma_b && !melisma_started_b_) - lyric_iter_p_->try_music (&melisma_start_req); - else if (melisma_started_b_) - lyric_iter_p_->try_music (&melisma_stop_req); - - Moment m= lyric_iter_p_->next_moment (); - lyric_iter_p_->process_and_next (m); - } - } - melisma_started_b_ = melisma_b; + m->origin ()->warning ("argument of \\lyricsto should contain Lyrics context"); } + lyricsto_voice_name_ = get_music ()->get_property ("associated-context"); + + Context *voice = find_voice (); + if (voice) + set_music_context (voice); + + /* + Wait for a Create_context event. If this isn't done, lyrics can be + delayed when voices are created implicitly. + */ + Global_context *g = get_outlet ()->get_global_context (); + g->events_below ()->add_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext")); + + /* + We do not create a Lyrics context, because the user might + create one with a different name, and then we will not find that + one. + */ +} +IMPLEMENT_LISTENER (Lyric_combine_music_iterator, check_new_context) +void +Lyric_combine_music_iterator::check_new_context (SCM sev) +{ + if (!ok ()) + return ; - Music_iterator::do_process_and_next (m); + // TODO: Check first if type=Voice and if id matches + Stream_event * ev = unsmob_stream_event (sev); + if (ev->get_property ("type") != ly_symbol2scm ("Voice")) + return ; + + Context *voice = find_voice (); + + if (voice) + { + set_music_context (voice); + } +} + +/* + Look for a suitable voice to align lyrics to. + + Returns 0 if nothing should change; i.e., if we already listen to the + right voice, or if we don't yet listen to a voice but no appropriate + voice could be found. +*/ +Context * +Lyric_combine_music_iterator::find_voice () +{ + SCM voice_name = lyricsto_voice_name_; + SCM running = lyrics_context_ + ? lyrics_context_->get_property ("associatedVoice") + : SCM_EOL; + + if (scm_is_string (running)) + voice_name = running; + + if (scm_is_string (voice_name) + && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ())) + { + Context *t = get_outlet (); + while (t && t->get_parent_context ()) + t = t->get_parent_context (); + + string name = ly_scm2string (voice_name); + return find_context_below (t, ly_symbol2scm ("Voice"), name); + } + + return 0; } -Lyric_combine_music_iterator::~Lyric_combine_music_iterator () +void +Lyric_combine_music_iterator::process (Moment when) { - delete lyric_iter_p_; - delete music_iter_p_; + (void) when; + + /* see if associatedVoice has been changed */ + Context *new_voice = find_voice (); + if (new_voice) + set_music_context (new_voice); + + if (!music_context_) + return; + + if (!music_context_->get_parent_context ()) + { + /* + The melody has died. + We die too. + */ + if (lyrics_context_) + lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext")); + lyric_iter_ = 0; + set_music_context (0); + } + + + if (music_context_ + && (start_new_syllable () || + (busy_moment_ >= pending_grace_moment_)) + && lyric_iter_->ok ()) + { + Moment now = music_context_->now_mom (); + if (now.grace_part_) + { + pending_grace_moment_ = now; + pending_grace_moment_.grace_part_ = Rational (0); + return; + } + else + { + pending_grace_moment_.set_infinite (1); + } + + Moment m = lyric_iter_->pending_moment (); + lyrics_context_->set_property (ly_symbol2scm ("associatedVoiceContext"), + music_context_->self_scm ()); + lyric_iter_->process (m); + + music_found_ = true; + } + + new_voice = find_voice (); + if (new_voice) + set_music_context (new_voice); } -Music_iterator* -Lyric_combine_music_iterator::try_music_in_children (Music const *m) const +void +Lyric_combine_music_iterator::do_quit () { - Music_iterator * i = music_iter_p_->try_music (m); - if (i) - return i; - else - return lyric_iter_p_->try_music (m); + if (!music_found_) + { + SCM voice_name = get_music ()->get_property ("associated-context"); + + string name; + if (scm_is_string (voice_name)) + name = ly_scm2string (voice_name); + + get_music ()->origin ()->warning (_f ("cannot find Voice `%s'", + name.c_str ()) + "\n"); + } + + if (lyric_iter_) + lyric_iter_->quit (); } +IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);