lily/lyric-combine-music-iterator.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "dispatcher.hh"
  21 #include "global-context.hh"
  22 #include "grob.hh"
  23 #include "input.hh"
  24 #include "international.hh"
  25 #include "listener.hh"
  26 #include "music-iterator.hh"
  27 #include "music.hh"
  28
  29 /*
  30   This iterator is hairy.  It tracks both lyric and melody contexts,
  31   and has a complicated communication route, reading/writing
  32   properties in both.
  33
  34   In the future, this should rather be done with
  35
  36      \interpretAsMelodyFor { MUSIC } { LYRICS LYRICS LYRICS }
  37
  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
  40   the LYRICS.
  41 */
  42
  43 class Lyric_combine_music_iterator : public Music_iterator
  44 {
  45 public:
  46   Lyric_combine_music_iterator ();
  47   Lyric_combine_music_iterator (Lyric_combine_music_iterator const &src);
  48   DECLARE_SCHEME_CALLBACK (constructor, ());
  49 protected:
  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);
  59 private:
  60   bool start_new_syllable () const;
  61   Context *find_voice ();
  62   void set_busy (SCM);
  63   void check_new_context (SCM);
  64
  65   bool music_found_;
  66   bool lyrics_found_;
  67   Context *lyrics_context_;
  68   Context *music_context_;
  69   SCM lyricsto_voice_name_;
  70   SCM lyricsto_voice_type_;
  71
  72   Moment busy_moment_;
  73   Moment pending_grace_moment_;
  74
  75   Music_iterator *lyric_iter_;
  76 };
  77
  78 Lyric_combine_music_iterator::Lyric_combine_music_iterator ()
  79 {
  80   music_found_ = false;
  81   lyrics_found_ = false;
  82   pending_grace_moment_.set_infinite (1);
  83   lyric_iter_ = 0;
  84   music_context_ = 0;
  85   lyrics_context_ = 0;
  86   busy_moment_.set_infinite (-1);
  87   lyricsto_voice_name_ = SCM_UNDEFINED;
  88   lyricsto_voice_type_ = SCM_UNDEFINED;
  89 }
  90
  91 /*
  92   It's dubious whether we can ever make this fully work.  Due to
  93   associatedVoice switching, this routine may be triggered for
  94   the wrong music_context_
  95  */
  96 void
  97 Lyric_combine_music_iterator::set_busy (SCM se)
  98 {
  99   Stream_event *e = Stream_event::unsmob (se);
 100
 101   if ((e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
 102       && music_context_)
 103
 104     busy_moment_ = max (music_context_->now_mom (),
 105                         busy_moment_);
 106
 107 }
 108
 109 void
 110 Lyric_combine_music_iterator::set_music_context (Context *to)
 111 {
 112   if (music_context_)
 113     {
 114       music_context_->events_below ()->
 115       remove_listener (GET_LISTENER (Lyric_combine_music_iterator, set_busy), ly_symbol2scm ("rhythmic-event"));
 116     }
 117
 118   music_context_ = to;
 119   if (to)
 120     {
 121       to->events_below ()->add_listener (GET_LISTENER (Lyric_combine_music_iterator, set_busy),
 122                                          ly_symbol2scm ("rhythmic-event"));
 123     }
 124 }
 125
 126 bool
 127 Lyric_combine_music_iterator::start_new_syllable () const
 128 {
 129   if (busy_moment_ < music_context_->now_mom ())
 130     return false;
 131
 132   if (!lyrics_context_)
 133     return false;
 134
 135   if (!to_boolean (lyrics_context_->get_property ("ignoreMelismata")))
 136     {
 137       bool m = melisma_busy (music_context_);
 138       if (m)
 139         return false;
 140     }
 141
 142   return true;
 143 }
 144
 145 Moment
 146 Lyric_combine_music_iterator::pending_moment () const
 147 {
 148   Moment m;
 149
 150   m.set_infinite (1);
 151
 152   return m;
 153 }
 154
 155 bool
 156 Lyric_combine_music_iterator::run_always () const
 157 {
 158   return true;
 159 }
 160
 161 bool
 162 Lyric_combine_music_iterator::ok () const
 163 {
 164   return lyric_iter_ && lyric_iter_->ok ();
 165 }
 166
 167 void
 168 Lyric_combine_music_iterator::derived_mark ()const
 169 {
 170   if (lyric_iter_)
 171     scm_gc_mark (lyric_iter_->self_scm ());
 172   if (lyrics_context_)
 173     scm_gc_mark (lyrics_context_->self_scm ());
 174   if (music_context_)
 175     scm_gc_mark (music_context_->self_scm ());
 176   scm_gc_mark (lyricsto_voice_name_);
 177   scm_gc_mark (lyricsto_voice_type_);
 178 }
 179
 180 void
 181 Lyric_combine_music_iterator::derived_substitute (Context *f, Context *t)
 182 {
 183   if (lyric_iter_)
 184     lyric_iter_->substitute_outlet (f, t);
 185   if (lyrics_context_ && lyrics_context_ == f)
 186     lyrics_context_ = t;
 187   if (music_context_ && music_context_ == f)
 188     set_music_context (t);
 189 }
 190
 191 void
 192 Lyric_combine_music_iterator::construct_children ()
 193 {
 194   Music *m = Music::unsmob (get_music ()->get_property ("element"));
 195   lyric_iter_ = Music_iterator::unsmob (get_iterator (m));
 196   if (!lyric_iter_)
 197     return;
 198   lyrics_context_ = find_context_below (lyric_iter_->get_outlet (),
 199                                         ly_symbol2scm ("Lyrics"), "");
 200
 201   if (!lyrics_context_)
 202     {
 203       m->origin ()->warning (_ ("argument of \\lyricsto should contain Lyrics context"));
 204     }
 205
 206   lyricsto_voice_name_ = get_music ()->get_property ("associated-context");
 207   lyricsto_voice_type_ = get_music ()->get_property ("associated-context-type");
 208   if (!scm_is_symbol (lyricsto_voice_type_))
 209     lyricsto_voice_type_ = ly_symbol2scm ("Voice");
 210
 211   Context *voice = find_voice ();
 212   if (voice)
 213     set_music_context (voice);
 214
 215   /*
 216     Wait for a Create_context event. If this isn't done, lyrics can be
 217     delayed when voices are created implicitly.
 218   */
 219   Global_context *g = get_outlet ()->get_global_context ();
 220   g->events_below ()->add_listener (GET_LISTENER (Lyric_combine_music_iterator, check_new_context), ly_symbol2scm ("CreateContext"));
 221
 222   /*
 223     We do not create a Lyrics context, because the user might
 224     create one with a different name, and then we will not find that
 225     one.
 226   */
 227 }
 228
 229 void
 230 Lyric_combine_music_iterator::check_new_context (SCM /*sev*/)
 231 {
 232   if (!ok ())
 233     return;
 234
 235   // Search for a possible candidate voice to attach the lyrics to. If none
 236   // is found, we'll try next time again.
 237   Context *voice = find_voice ();
 238   if (voice)
 239     {
 240       set_music_context (voice);
 241     }
 242 }
 243
 244 /*
 245   Look for a suitable voice to align lyrics to.
 246
 247   Returns 0 if nothing should change; i.e., if we already listen to the
 248   right voice, or if we don't yet listen to a voice but no appropriate
 249   voice could be found.
 250 */
 251 Context *
 252 Lyric_combine_music_iterator::find_voice ()
 253 {
 254   SCM voice_name = lyricsto_voice_name_;
 255   SCM running = lyrics_context_
 256                 ? lyrics_context_->get_property ("associatedVoice")
 257                 : SCM_EOL;
 258   SCM voice_type = lyricsto_voice_type_;
 259   if (scm_is_string (running)) {
 260     voice_name = running;
 261     voice_type = lyrics_context_->get_property ("associatedVoiceType");
 262   }
 263
 264   if (scm_is_string (voice_name)
 265       && (!music_context_ || ly_scm2string (voice_name) != music_context_->id_string ())
 266       && scm_is_symbol (voice_type))
 267     {
 268       Context *t = get_outlet ();
 269       while (t && t->get_parent_context ())
 270         t = t->get_parent_context ();
 271
 272       string name = ly_scm2string (voice_name);
 273       return find_context_below (t, voice_type, name);
 274     }
 275
 276   return 0;
 277 }
 278
 279 void
 280 Lyric_combine_music_iterator::process (Moment /* when */)
 281 {
 282   /* see if associatedVoice has been changed */
 283   Context *new_voice = find_voice ();
 284   if (new_voice)
 285     set_music_context (new_voice);
 286
 287   lyrics_found_ = true;
 288   if (!music_context_)
 289     return;
 290
 291   if (!music_context_->get_parent_context ())
 292     {
 293       /*
 294         The melody has died.
 295         We die too.
 296       */
 297       if (lyrics_context_)
 298         lyrics_context_->unset_property (ly_symbol2scm ("associatedVoiceContext"));
 299       lyric_iter_ = 0;
 300       set_music_context (0);
 301     }
 302
 303   if (music_context_
 304       && (start_new_syllable ()
 305           || (busy_moment_ >= pending_grace_moment_))
 306       && lyric_iter_->ok ())
 307     {
 308       Moment now = music_context_->now_mom ();
 309       if (now.grace_part_ && !to_boolean (lyrics_context_->get_property ("includeGraceNotes")))
 310         {
 311           pending_grace_moment_ = now;
 312           pending_grace_moment_.grace_part_ = Rational (0);
 313           return;
 314         }
 315       else
 316         {
 317           pending_grace_moment_.set_infinite (1);
 318         }
 319
 320       Moment m = lyric_iter_->pending_moment ();
 321       lyrics_context_->set_property (ly_symbol2scm ("associatedVoiceContext"),
 322                                      music_context_->self_scm ());
 323       lyric_iter_->process (m);
 324
 325       music_found_ = true;
 326     }
 327
 328   new_voice = find_voice ();
 329   if (new_voice)
 330     set_music_context (new_voice);
 331 }
 332
 333 void
 334 Lyric_combine_music_iterator::do_quit ()
 335 {
 336   if (!music_found_)
 337     {
 338       SCM voice_name = get_music ()->get_property ("associated-context");
 339       SCM voice_type = get_music ()->get_property ("associated-context-type");
 340       string name, type;
 341       if (scm_is_string (voice_name))
 342         name = ly_scm2string (voice_name);
 343       type = robust_symbol2string (voice_type, "Voice");
 344       /* Don't print a warning for empty lyrics (in which case we don't try
 345          to find the proper voice, so it will not be found) */
 346       if (lyrics_found_)
 347         get_music ()->origin ()->warning (_f ("cannot find %s `%s'",
 348                                               type.c_str (), name.c_str ()) + "\n");
 349     }
 350
 351   if (lyric_iter_)
 352     lyric_iter_->quit ();
 353 }
 354
 355 IMPLEMENT_CTOR_CALLBACK (Lyric_combine_music_iterator);