2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "dispatcher.hh"
21 #include "global-context.hh"
24 #include "international.hh"
25 #include "listener.hh"
26 #include "music-iterator.hh"
30 This iterator is hairy. It tracks both lyric and melody contexts,
31 and has a complicated communication route, reading/writing
34 In the future, this should rather be done with
36 \interpretAsMelodyFor { MUSIC } { LYRICS LYRICS LYRICS }
38 This can run an interpret step on MUSIC, generating a stream. Then
39 the stream can be perused at leisure to apply durations to all of
43 class Lyric_combine_music_iterator : public Music_iterator
46 Lyric_combine_music_iterator ();
47 Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
48 DECLARE_SCHEME_CALLBACK (constructor, ());
50 virtual void construct_children ();
51 virtual Moment pending_moment () const;
52 virtual void do_quit ();
53 virtual void process (Moment);
54 virtual bool run_always ()const;
55 virtual bool ok () const;
56 virtual void derived_mark () const;
57 virtual void derived_substitute (Context *, Context *);
58 void set_music_context (Context *to);
60 bool start_new_syllable () const;
61 Context *find_voice ();
62 DECLARE_LISTENER (set_busy);
63 DECLARE_LISTENER (check_new_context);
67 Context *lyrics_context_;
68 Context *music_context_;
69 SCM lyricsto_voice_name_;
72 Moment pending_grace_moment_;
74 Music_iterator *lyric_iter_;
77 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
80 lyrics_found_ = false;
81 pending_grace_moment_.set_infinite (1);
85 busy_moment_.set_infinite (-1);
89 It's dubious whether we can ever make this fully work. Due to
90 associatedVoice switching, this routine may be triggered for
91 the wrong music_context_
93 IMPLEMENT_LISTENER (Lyric_combine_music_iterator, set_busy)
95 Lyric_combine_music_iterator::set_busy (SCM se)
97 Stream_event *e = unsmob_stream_event (se);
99 if ((e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
102 busy_moment_ = max (music_context_->now_mom (),
108 Lyric_combine_music_iterator::set_music_context (Context *to)
112 music_context_->event_source ()->
113 remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
119 to->event_source ()->add_listener (GET_LISTENER (set_busy),
120 ly_symbol2scm ("music-event"));
125 Lyric_combine_music_iterator::start_new_syllable () const
127 if (busy_moment_ < music_context_->now_mom ())
130 if (!lyrics_context_)
133 if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
135 bool m = melisma_busy (music_context_);
144 Lyric_combine_music_iterator::pending_moment () const
154 Lyric_combine_music_iterator::run_always () const
160 Lyric_combine_music_iterator::ok () const
162 return lyric_iter_ && lyric_iter_->ok ();
166 Lyric_combine_music_iterator::derived_mark ()const
169 scm_gc_mark (lyric_iter_->self_scm ());
171 scm_gc_mark (lyrics_context_->self_scm ());
173 scm_gc_mark (music_context_->self_scm ());
177 Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
180 lyric_iter_->substitute_outlet (f, t);
181 if (lyrics_context_ && lyrics_context_ == f)
183 if (music_context_ && music_context_ == f)
184 set_music_context (t);
188 Lyric_combine_music_iterator::construct_children ()
190 Music *m = unsmob_music (get_music ()->get_property ("element"));
191 lyric_iter_ = unsmob_iterator (get_iterator (m));
194 lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
195 ly_symbol2scm ("Lyrics"), "");
197 if (!lyrics_context_)
199 m->origin ()->warning (_ ("argument of \\lyricsto should contain Lyrics context"));
202 lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
204 Context *voice = find_voice ();
206 set_music_context (voice);
209 Wait for a Create_context event. If this isn't done, lyrics can be
210 delayed when voices are created implicitly.
212 Global_context *g = get_outlet ()->get_global_context ();
213 g->events_below ()->add_listener (GET_LISTENER (check_new_context), ly_symbol2scm ("CreateContext"));
216 We do not create a Lyrics context, because the user might
217 create one with a different name, and then we will not find that
222 IMPLEMENT_LISTENER (Lyric_combine_music_iterator, check_new_context)
224 Lyric_combine_music_iterator::check_new_context (SCM /*sev*/)
229 // Search for a possible candidate voice to attach the lyrics to. If none
230 // is found, we'll try next time again.
231 Context *voice = find_voice ();
234 set_music_context (voice);
239 Look for a suitable voice to align lyrics to.
241 Returns 0 if nothing should change; i.e., if we already listen to the
242 right voice, or if we don't yet listen to a voice but no appropriate
243 voice could be found.
246 Lyric_combine_music_iterator::find_voice ()
248 SCM voice_name = lyricsto_voice_name_;
249 SCM running = lyrics_context_
250 ? lyrics_context_->get_property ("associatedVoice")
253 if (scm_is_string (running))
254 voice_name = running;
256 if (scm_is_string (voice_name)
257 && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ()))
259 Context *t = get_outlet ();
260 while (t && t->get_parent_context ())
261 t = t->get_parent_context ();
263 string name = ly_scm2string (voice_name);
264 return find_context_below (t, ly_symbol2scm ("Voice"), name);
271 Lyric_combine_music_iterator::process (Moment /* when */)
273 /* see if associatedVoice has been changed */
274 Context *new_voice = find_voice ();
276 set_music_context (new_voice);
278 lyrics_found_ = true;
282 if (!music_context_->get_parent_context ())
289 lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
291 set_music_context (0);
295 && (start_new_syllable ()
296 || (busy_moment_ >= pending_grace_moment_))
297 && lyric_iter_->ok ())
299 Moment now = music_context_->now_mom ();
300 if (now.grace_part_ && !to_boolean (lyrics_context_->get_property ("includeGraceNotes")))
302 pending_grace_moment_ = now;
303 pending_grace_moment_.grace_part_ = Rational (0);
308 pending_grace_moment_.set_infinite (1);
311 Moment m = lyric_iter_->pending_moment ();
312 lyrics_context_->set_property (ly_symbol2scm ("associatedVoiceContext"),
313 music_context_->self_scm ());
314 lyric_iter_->process (m);
319 new_voice = find_voice ();
321 set_music_context (new_voice);
325 Lyric_combine_music_iterator::do_quit ()
329 SCM voice_name = get_music ()->get_property ("associated-context");
332 if (scm_is_string (voice_name))
333 name = ly_scm2string (voice_name);
334 /* Don't print a warning for empty lyrics (in which case we don't try
335 to find the proper voice, so it will not be found) */
337 get_music ()->origin ()->warning (_f ("cannot find Voice `%s'",
338 name.c_str ()) + "\n");
342 lyric_iter_->quit ();
345 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);