lily/part-combine-iterator.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2015 Han-Wen Nienhuys
   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 "context.hh"
  21 #include "dispatcher.hh"
  22 #include "lily-guile.hh"
  23 #include "music.hh"
  24 #include "music-iterator.hh"
  25 #include "music-sequence.hh"
  26 #include "warn.hh"
  27
  28 enum Outlet_type
  29 {
  30   CONTEXT_ONE, CONTEXT_TWO,
  31   CONTEXT_SHARED, CONTEXT_SOLO,
  32   CONTEXT_NULL, NUM_OUTLETS
  33 };
  34
  35 static const char *outlet_names_[NUM_OUTLETS]
  36   = {"one", "two", "shared", "solo", "null"};
  37
  38 class Part_combine_iterator : public Music_iterator
  39 {
  40 public:
  41   Part_combine_iterator ();
  42
  43   DECLARE_SCHEME_CALLBACK (constructor, ());
  44 protected:
  45   virtual void derived_substitute (Context *f, Context *t);
  46   virtual void derived_mark () const;
  47
  48   virtual void construct_children ();
  49   virtual Moment pending_moment () const;
  50   virtual void do_quit ();
  51   virtual void process (Moment);
  52
  53   virtual bool ok () const;
  54
  55 private:
  56   /* used by try_process */
  57   void set_busy (SCM);
  58   bool busy_;
  59   bool notice_busy_;
  60
  61   bool try_process (Music_iterator *i, Moment m);
  62
  63   Music_iterator *first_iter_;
  64   Music_iterator *second_iter_;
  65   Moment start_moment_;
  66
  67   SCM split_list_;
  68
  69   Stream_event *mmrest_event_;
  70
  71   enum Status
  72   {
  73     APART,
  74     TOGETHER,
  75     SOLO,
  76     UNISONO,
  77     UNISILENCE,
  78   };
  79   Status state_;
  80
  81   // For states in which it matters, this is the relevant part,
  82   // e.g. 1 for Solo I, 2 for Solo II.
  83   int chosen_part_;
  84
  85   // States for generating partcombine text.
  86   enum PlayingState
  87   {
  88     PLAYING_OTHER,
  89     PLAYING_UNISONO,
  90     PLAYING_SOLO1,
  91     PLAYING_SOLO2,
  92   } playing_state_;
  93
  94   int last_playing_;
  95
  96   /*
  97     TODO: this is getting off hand...
  98   */
  99   Context_handle handles_[NUM_OUTLETS];
 100
 101   void substitute_both (Outlet_type to1,
 102                         Outlet_type to2);
 103
 104   /* parameter is really Outlet_type */
 105   void kill_mmrest (int in);
 106   void chords_together ();
 107   void solo1 ();
 108   void solo2 ();
 109   void apart (bool silent);
 110   void unisono (bool silent, int newpart);
 111 };
 112
 113 void
 114 Part_combine_iterator::do_quit ()
 115 {
 116   if (first_iter_)
 117     first_iter_->quit ();
 118   if (second_iter_)
 119     second_iter_->quit ();
 120
 121   // Add listeners to all contexts except Devnull.
 122   for (int i = 0; i < NUM_OUTLETS; i++)
 123     {
 124       Context *c = handles_[i].get_context ();
 125       if (c->is_alias (ly_symbol2scm ("Voice")))
 126         c->event_source ()->remove_listener (GET_LISTENER (Part_combine_iterator, set_busy), ly_symbol2scm ("music-event"));
 127       handles_[i].set_context (0);
 128     }
 129 }
 130
 131 Part_combine_iterator::Part_combine_iterator ()
 132 {
 133   mmrest_event_ = 0;
 134
 135   first_iter_ = 0;
 136   second_iter_ = 0;
 137   split_list_ = SCM_EOL;
 138   state_ = APART;
 139   chosen_part_ = 1;
 140   playing_state_ = PLAYING_OTHER;
 141   last_playing_ = 0;
 142
 143   busy_ = false;
 144   notice_busy_ = false;
 145 }
 146
 147 void
 148 Part_combine_iterator::derived_mark () const
 149 {
 150   if (first_iter_)
 151     scm_gc_mark (first_iter_->self_scm ());
 152   if (second_iter_)
 153     scm_gc_mark (second_iter_->self_scm ());
 154   if (mmrest_event_)
 155     scm_gc_mark (mmrest_event_->self_scm ());
 156 }
 157
 158 void
 159 Part_combine_iterator::derived_substitute (Context *f,
 160                                            Context *t)
 161 {
 162   if (first_iter_)
 163     first_iter_->substitute_outlet (f, t);
 164 }
 165
 166 Moment
 167 Part_combine_iterator::pending_moment () const
 168 {
 169   Moment p;
 170   p.set_infinite (1);
 171   if (first_iter_->ok ())
 172     p = min (p, first_iter_->pending_moment ());
 173
 174   if (second_iter_->ok ())
 175     p = min (p, second_iter_->pending_moment ());
 176   return p;
 177 }
 178
 179 bool
 180 Part_combine_iterator::ok () const
 181 {
 182   return first_iter_->ok () || second_iter_->ok ();
 183 }
 184
 185 void
 186 Part_combine_iterator::substitute_both (Outlet_type to1,
 187                                         Outlet_type to2)
 188 {
 189   first_iter_->substitute_outlet (first_iter_->get_outlet (),
 190                                   handles_[to1].get_context ());
 191   second_iter_->substitute_outlet (second_iter_->get_outlet (),
 192                                    handles_[to2].get_context ());
 193
 194   for (int j = 0; j < NUM_OUTLETS; j++)
 195     {
 196       if (j != to1 && j != to2)
 197         kill_mmrest (j);
 198     }
 199 }
 200
 201 void
 202 Part_combine_iterator::kill_mmrest (int in)
 203 {
 204
 205   if (!mmrest_event_)
 206     {
 207       mmrest_event_ = new Stream_event
 208         (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
 209                      ly_symbol2scm ("multi-measure-rest-event")));
 210       mmrest_event_->set_property ("duration", SCM_EOL);
 211       mmrest_event_->unprotect ();
 212     }
 213
 214   handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
 215 }
 216
 217 void
 218 Part_combine_iterator::unisono (bool silent, int newpart)
 219 {
 220   Status newstate = (silent) ? UNISILENCE : UNISONO;
 221
 222   if ((newstate == state_) and (newpart == chosen_part_))
 223     return;
 224   else
 225     {
 226       Outlet_type c1 = (newpart == 2) ? CONTEXT_NULL : CONTEXT_SHARED;
 227       Outlet_type c2 = (newpart == 2) ? CONTEXT_SHARED : CONTEXT_NULL;
 228       substitute_both (c1, c2);
 229       kill_mmrest ((newpart == 2) ? CONTEXT_ONE : CONTEXT_TWO);
 230       kill_mmrest (CONTEXT_SHARED);
 231
 232       if (playing_state_ != PLAYING_UNISONO
 233           && newstate == UNISONO)
 234         {
 235           playing_state_ = PLAYING_UNISONO;
 236         }
 237       state_ = newstate;
 238       chosen_part_ = newpart;
 239     }
 240 }
 241
 242 void
 243 Part_combine_iterator::solo1 ()
 244 {
 245   if ((state_ == SOLO) && (chosen_part_ == 1))
 246     return;
 247   else
 248     {
 249       state_ = SOLO;
 250       chosen_part_ = 1;
 251       substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
 252
 253       kill_mmrest (CONTEXT_TWO);
 254       kill_mmrest (CONTEXT_SHARED);
 255
 256       playing_state_ = PLAYING_SOLO1;
 257     }
 258 }
 259
 260 void
 261 Part_combine_iterator::solo2 ()
 262 {
 263   if ((state_ == SOLO) and (chosen_part_ == 2))
 264     return;
 265   else
 266     {
 267       state_ = SOLO;
 268       chosen_part_ = 2;
 269       substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
 270
 271       playing_state_ = PLAYING_SOLO2;
 272     }
 273 }
 274
 275 void
 276 Part_combine_iterator::chords_together ()
 277 {
 278   if (state_ == TOGETHER)
 279     return;
 280   else
 281     {
 282       playing_state_ = PLAYING_OTHER;
 283       state_ = TOGETHER;
 284
 285       substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
 286     }
 287 }
 288
 289 void
 290 Part_combine_iterator::apart (bool silent)
 291 {
 292   if (!silent)
 293     playing_state_ = PLAYING_OTHER;
 294
 295   if (state_ == APART)
 296     return;
 297   else
 298     {
 299       state_ = APART;
 300       substitute_both (CONTEXT_ONE, CONTEXT_TWO);
 301     }
 302 }
 303
 304 void
 305 Part_combine_iterator::construct_children ()
 306 {
 307   start_moment_ = get_outlet ()->now_mom ();
 308   split_list_ = get_music ()->get_property ("split-list");
 309
 310   Context *c = get_outlet ();
 311
 312   for (int i = 0; i < NUM_OUTLETS; i++)
 313     {
 314       SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
 315       /* find context below c: otherwise we may create new staff for each voice */
 316       c = c->find_create_context (type, outlet_names_[i], SCM_EOL);
 317       handles_[i].set_context (c);
 318       if (c->is_alias (ly_symbol2scm ("Voice")))
 319         c->event_source ()->add_listener (GET_LISTENER (Part_combine_iterator, set_busy), ly_symbol2scm ("music-event"));
 320     }
 321
 322   SCM lst = get_music ()->get_property ("elements");
 323   Context *one = handles_[CONTEXT_ONE].get_context ();
 324   set_context (one);
 325   first_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_car (lst))));
 326   Context *two = handles_[CONTEXT_TWO].get_context ();
 327   set_context (two);
 328   second_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_cadr (lst))));
 329   Context *shared = handles_[CONTEXT_SHARED].get_context ();
 330   set_context (shared);
 331 }
 332
 333 void
 334 Part_combine_iterator::set_busy (SCM se)
 335 {
 336   if (!notice_busy_)
 337     return;
 338
 339   Stream_event *e = Stream_event::unsmob (se);
 340
 341   if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
 342     busy_ = true;
 343 }
 344
 345 /*
 346   Processes a moment in an iterator, and returns whether any new music
 347   was reported.
 348 */
 349 bool
 350 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
 351 {
 352   busy_ = false;
 353   notice_busy_ = true;
 354
 355   i->process (m);
 356
 357   notice_busy_ = false;
 358   return busy_;
 359 }
 360
 361 void
 362 Part_combine_iterator::process (Moment m)
 363 {
 364   Moment now = get_outlet ()->now_mom ();
 365   Moment *splitm = 0;
 366
 367   /* This is needed if construct_children was called before iteration
 368      started */
 369   if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
 370     start_moment_ = now;
 371
 372   for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
 373     {
 374       splitm = Moment::unsmob (scm_caar (split_list_));
 375       if (splitm && *splitm + start_moment_ > now)
 376         break;
 377
 378       SCM tag = scm_cdar (split_list_);
 379
 380       if (scm_is_eq (tag, ly_symbol2scm ("chords")))
 381         chords_together ();
 382       else if (scm_is_eq (tag, ly_symbol2scm ("apart"))
 383                || scm_is_eq (tag, ly_symbol2scm ("apart-silence"))
 384                || scm_is_eq (tag, ly_symbol2scm ("apart-spanner")))
 385         apart (scm_is_eq (tag, ly_symbol2scm ("apart-silence")));
 386       else if (scm_is_eq (tag, ly_symbol2scm ("unisono")))
 387         {
 388           // Continue to use the most recently used part because we might have
 389           // killed mmrests in the other part.
 390           unisono (false, (last_playing_ == 2) ? 2 : 1);
 391         }
 392       else if (scm_is_eq (tag, ly_symbol2scm ("unisilence")))
 393         {
 394           // as for unisono
 395           unisono (true, (last_playing_ == 2) ? 2 : 1);
 396         }
 397       else if (scm_is_eq (tag, ly_symbol2scm ("silence1")))
 398         unisono (true, 1);
 399       else if (scm_is_eq (tag, ly_symbol2scm ("silence2")))
 400         unisono (true, 2);
 401       else if (scm_is_eq (tag, ly_symbol2scm ("solo1")))
 402         solo1 ();
 403       else if (scm_is_eq (tag, ly_symbol2scm ("solo2")))
 404         solo2 ();
 405       else if (scm_is_symbol (tag))
 406         {
 407           string s = "Unknown split directive: "
 408                      + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
 409           programming_error (s);
 410         }
 411     }
 412
 413   if (first_iter_->ok ())
 414     {
 415       if (try_process (first_iter_, m))
 416         last_playing_ = 1;
 417     }
 418
 419   if (second_iter_->ok ())
 420     {
 421       if (try_process (second_iter_, m))
 422         last_playing_ = 2;
 423     }
 424 }
 425
 426 IMPLEMENT_CTOR_CALLBACK (Part_combine_iterator);