2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 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"
32 This iterator is hairy. It tracks both lyric and melody contexts,
33 and has a complicated communication route, reading/writing
36 In the future, this should rather be done with
38 \interpretAsMelodyFor { MUSIC } { LYRICS LYRICS LYRICS }
40 This can run an interpret step on MUSIC, generating a stream. Then
41 the stream can be perused at leisure to apply durations to all of
45 class Lyric_combine_music_iterator : public Music_iterator
48 Lyric_combine_music_iterator ();
49 Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
50 DECLARE_SCHEME_CALLBACK (constructor, ());
52 virtual void construct_children ();
53 virtual Moment pending_moment () const;
54 virtual void do_quit ();
55 virtual void process (Moment);
56 virtual bool run_always ()const;
57 virtual bool ok () const;
58 virtual void derived_mark () const;
59 virtual void derived_substitute (Context *, Context *);
60 void set_music_context (Context *to);
62 bool start_new_syllable () const;
63 Context *find_voice ();
65 void check_new_context (SCM);
69 Context *lyrics_context_;
70 Context *music_context_;
71 SCM lyricsto_voice_name_;
72 SCM lyricsto_voice_type_;
75 Moment pending_grace_moment_;
77 Music_iterator *lyric_iter_;
80 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
83 lyrics_found_ = false;
84 pending_grace_moment_.set_infinite (1);
88 busy_moment_.set_infinite (-1);
89 lyricsto_voice_name_ = SCM_UNDEFINED;
90 lyricsto_voice_type_ = SCM_UNDEFINED;
94 It's dubious whether we can ever make this fully work. Due to
95 associatedVoice switching, this routine may be triggered for
96 the wrong music_context_
99 Lyric_combine_music_iterator::set_busy (SCM se)
101 Stream_event *e = unsmob<Stream_event> (se);
103 if ((e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
106 busy_moment_ = std::max (music_context_->now_mom (),
112 Lyric_combine_music_iterator::set_music_context (Context *to)
116 music_context_->events_below ()->
117 remove_listener (GET_LISTENER (Lyric_combine_music_iterator, set_busy), ly_symbol2scm ("rhythmic-event"));
123 to->events_below ()->add_listener (GET_LISTENER (Lyric_combine_music_iterator, set_busy),
124 ly_symbol2scm ("rhythmic-event"));
129 Lyric_combine_music_iterator::start_new_syllable () const
131 if (busy_moment_ < music_context_->now_mom ())
134 if (!lyrics_context_)
137 if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
139 bool m = melisma_busy (music_context_);
148 Lyric_combine_music_iterator::pending_moment () const
158 Lyric_combine_music_iterator::run_always () const
164 Lyric_combine_music_iterator::ok () const
166 return lyric_iter_ && lyric_iter_->ok ()
167 && !(music_context_ && music_context_->is_removable ());
171 Lyric_combine_music_iterator::derived_mark ()const
174 scm_gc_mark (lyric_iter_->self_scm ());
176 scm_gc_mark (lyrics_context_->self_scm ());
178 scm_gc_mark (music_context_->self_scm ());
179 scm_gc_mark (lyricsto_voice_name_);
180 scm_gc_mark (lyricsto_voice_type_);
184 Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
187 lyric_iter_->substitute_outlet (f, t);
188 if (lyrics_context_ && lyrics_context_ == f)
190 if (music_context_ && music_context_ == f)
191 set_music_context (t);
195 Lyric_combine_music_iterator::construct_children ()
197 Music *m = unsmob<Music> (get_music ()->get_property ("element"));
198 lyric_iter_ = unsmob<Music_iterator> (get_iterator (m));
201 lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
202 ly_symbol2scm ("Lyrics"), "");
204 if (!lyrics_context_)
206 m->origin ()->warning (_ ("argument of \\lyricsto should contain Lyrics context"));
209 lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
210 lyricsto_voice_type_ = get_music ()->get_property ("associated-context-type");
211 if (!scm_is_symbol (lyricsto_voice_type_))
212 lyricsto_voice_type_ = ly_symbol2scm ("Voice");
214 Context *voice = find_voice ();
216 set_music_context (voice);
219 Wait for a Create_context event. If this isn't done, lyrics can be
220 delayed when voices are created implicitly.
222 Global_context *g = get_outlet ()->get_global_context ();
223 g->events_below ()->add_listener (GET_LISTENER (Lyric_combine_music_iterator, check_new_context), ly_symbol2scm ("CreateContext"));
226 We do not create a Lyrics context, because the user might
227 create one with a different name, and then we will not find that
233 Lyric_combine_music_iterator::check_new_context (SCM /*sev*/)
238 // Search for a possible candidate voice to attach the lyrics to. If none
239 // is found, we'll try next time again.
240 Context *voice = find_voice ();
243 set_music_context (voice);
248 Look for a suitable voice to align lyrics to.
250 Returns 0 if nothing should change; i.e., if we already listen to the
251 right voice, or if we don't yet listen to a voice but no appropriate
252 voice could be found.
255 Lyric_combine_music_iterator::find_voice ()
257 SCM voice_name = lyricsto_voice_name_;
258 SCM running = lyrics_context_
259 ? lyrics_context_->get_property ("associatedVoice")
261 SCM voice_type = lyricsto_voice_type_;
262 if (scm_is_string (running)) {
263 voice_name = running;
264 voice_type = lyrics_context_->get_property ("associatedVoiceType");
267 if (scm_is_string (voice_name)
268 && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ())
269 && scm_is_symbol (voice_type))
271 return find_context_below (find_top_context (get_outlet ()),
272 voice_type, ly_scm2string (voice_name));
279 Lyric_combine_music_iterator::process (Moment /* when */)
281 /* see if associatedVoice has been changed */
282 Context *new_voice = find_voice ();
284 set_music_context (new_voice);
286 lyrics_found_ = true;
290 if (!music_context_->get_parent_context ())
297 lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
299 set_music_context (0);
303 && (start_new_syllable ()
304 || (busy_moment_ >= pending_grace_moment_))
305 && lyric_iter_->ok ())
307 Moment now = music_context_->now_mom ();
308 if (now.grace_part_ && !to_boolean (lyrics_context_->get_property ("includeGraceNotes")))
310 pending_grace_moment_ = now;
311 pending_grace_moment_.grace_part_ = Rational (0);
316 pending_grace_moment_.set_infinite (1);
319 Moment m = lyric_iter_->pending_moment ();
320 lyrics_context_->set_property (ly_symbol2scm ("associatedVoiceContext"),
321 music_context_->self_scm ());
322 lyric_iter_->process (m);
327 new_voice = find_voice ();
329 set_music_context (new_voice);
333 Lyric_combine_music_iterator::do_quit ()
337 SCM voice_name = get_music ()->get_property ("associated-context");
338 SCM voice_type = get_music ()->get_property ("associated-context-type");
340 if (scm_is_string (voice_name))
341 name = ly_scm2string (voice_name);
342 type = robust_symbol2string (voice_type, "Voice");
343 /* Don't print a warning for empty lyrics (in which case we don't try
344 to find the proper voice, so it will not be found) */
346 get_music ()->origin ()->warning (_f ("cannot find %s `%s'",
347 type.c_str (), name.c_str ()) + "\n");
351 lyric_iter_->quit ();
354 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);