lily/part-combine-iterator.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2012 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   DECLARE_LISTENER (set_busy);
  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   SCM direction_;
  69   SCM directionOne_;
  70   SCM directionTwo_;
  71   SCM horizontalShiftOne_;
  72   SCM horizontalShiftTwo_;
  73
  74   Stream_event *unisono_event_;
  75   Stream_event *solo_one_event_;
  76   Stream_event *solo_two_event_;
  77   Stream_event *mmrest_event_;
  78
  79   enum Status
  80   {
  81     APART,
  82     TOGETHER,
  83     SOLO1,
  84     SOLO2,
  85     UNISONO,
  86     UNISILENCE,
  87   };
  88   Status state_;
  89   Status playing_state_;
  90
  91   /*
  92     Should be SOLO1 or SOLO2
  93   */
  94   Status 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);
 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 (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   unisono_event_ = 0;
 135   solo_two_event_ = 0;
 136   solo_one_event_ = 0;
 137
 138   first_iter_ = 0;
 139   second_iter_ = 0;
 140   split_list_ = SCM_EOL;
 141   direction_ = SCM_BOOL_F;
 142   directionOne_ = scm_from_int (1);
 143   directionTwo_ = scm_from_int (-1);
 144   horizontalShiftOne_ = scm_from_int (0);
 145   horizontalShiftTwo_ = scm_from_int (1);
 146   state_ = APART;
 147   playing_state_ = APART;
 148   last_playing_ = APART;
 149
 150   busy_ = false;
 151   notice_busy_ = false;
 152 }
 153
 154 void
 155 Part_combine_iterator::derived_mark () const
 156 {
 157   if (first_iter_)
 158     scm_gc_mark (first_iter_->self_scm ());
 159   if (second_iter_)
 160     scm_gc_mark (second_iter_->self_scm ());
 161   if (unisono_event_)
 162     scm_gc_mark (unisono_event_->self_scm ());
 163   if (mmrest_event_)
 164     scm_gc_mark (mmrest_event_->self_scm ());
 165   if (solo_one_event_)
 166     scm_gc_mark (solo_one_event_->self_scm ());
 167   if (solo_two_event_)
 168     scm_gc_mark (solo_two_event_->self_scm ());
 169 }
 170
 171 void
 172 Part_combine_iterator::derived_substitute (Context *f,
 173                                            Context *t)
 174 {
 175   if (first_iter_)
 176     first_iter_->substitute_outlet (f, t);
 177 }
 178
 179 Moment
 180 Part_combine_iterator::pending_moment () const
 181 {
 182   Moment p;
 183   p.set_infinite (1);
 184   if (first_iter_->ok ())
 185     p = min (p, first_iter_->pending_moment ());
 186
 187   if (second_iter_->ok ())
 188     p = min (p, second_iter_->pending_moment ());
 189   return p;
 190 }
 191
 192 bool
 193 Part_combine_iterator::ok () const
 194 {
 195   return first_iter_->ok () || second_iter_->ok ();
 196 }
 197
 198 void
 199 Part_combine_iterator::substitute_both (Outlet_type to1,
 200                                         Outlet_type to2)
 201 {
 202   Outlet_type tos[] = {to1, to2};
 203
 204   Music_iterator *mis[] = {first_iter_, second_iter_};
 205
 206   for (int i = 0; i < 2; i++)
 207     {
 208       for (int j = 0; j < NUM_OUTLETS; j++)
 209         if (j != tos[i])
 210           mis[i]->substitute_outlet (handles_[j].get_context (), handles_[tos[i]].get_context ());
 211     }
 212
 213   for (int j = 0; j < NUM_OUTLETS; j++)
 214     {
 215       if (j != to1 && j != to2)
 216         kill_mmrest (j);
 217     }
 218 }
 219
 220 void
 221 Part_combine_iterator::kill_mmrest (int in)
 222 {
 223
 224   if (!mmrest_event_)
 225     {
 226       mmrest_event_ = new Stream_event (ly_symbol2scm ("multi-measure-rest-event"));
 227       mmrest_event_->set_property ("duration", SCM_EOL);
 228       mmrest_event_->unprotect ();
 229     }
 230
 231   handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
 232 }
 233
 234 void
 235 Part_combine_iterator::unisono (bool silent)
 236 {
 237   Status newstate = (silent) ? UNISILENCE : UNISONO;
 238
 239   if (newstate == state_)
 240     return;
 241   else
 242     {
 243       /*
 244         If we're coming from SOLO2 state, we might have kill mmrests
 245         in the 1st voice, so in that case, we use the second voice
 246         as a basis for events.
 247       */
 248       Outlet_type c1 = (last_playing_ == SOLO2) ? CONTEXT_NULL : CONTEXT_SHARED;
 249       Outlet_type c2 = (last_playing_ == SOLO2) ? CONTEXT_SHARED : CONTEXT_NULL;
 250       substitute_both (c1, c2);
 251       kill_mmrest ((last_playing_ == SOLO2) ? CONTEXT_ONE : CONTEXT_TWO);
 252       kill_mmrest (CONTEXT_SHARED);
 253
 254       if (playing_state_ != UNISONO
 255           && newstate == UNISONO)
 256         {
 257           if (!unisono_event_)
 258             {
 259               unisono_event_ = new Stream_event (ly_symbol2scm ("unisono-event"));
 260               unisono_event_->unprotect ();
 261             }
 262
 263           Context *out = (last_playing_ == SOLO2 ? second_iter_ : first_iter_)
 264                          ->get_outlet ();
 265           out->event_source ()->broadcast (unisono_event_);
 266           playing_state_ = UNISONO;
 267         }
 268       state_ = newstate;
 269     }
 270 }
 271
 272 void
 273 Part_combine_iterator::solo1 ()
 274 {
 275   if (state_ == SOLO1)
 276     return;
 277   else
 278     {
 279       state_ = SOLO1;
 280       substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
 281
 282       kill_mmrest (CONTEXT_TWO);
 283       kill_mmrest (CONTEXT_SHARED);
 284
 285       if (playing_state_ != SOLO1)
 286         {
 287           if (!solo_one_event_)
 288             {
 289               solo_one_event_ = new Stream_event (ly_symbol2scm ("solo-one-event"));
 290               solo_one_event_->unprotect ();
 291             }
 292
 293           first_iter_->get_outlet ()->event_source ()->broadcast (solo_one_event_);
 294         }
 295       playing_state_ = SOLO1;
 296     }
 297 }
 298
 299 void
 300 Part_combine_iterator::solo2 ()
 301 {
 302   if (state_ == SOLO2)
 303     return;
 304   else
 305     {
 306       state_ = SOLO2;
 307
 308       substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
 309
 310       if (playing_state_ != SOLO2)
 311         {
 312           if (!solo_two_event_)
 313             {
 314               solo_two_event_ = new Stream_event (ly_symbol2scm ("solo-two-event"));
 315               solo_two_event_->unprotect ();
 316             }
 317
 318           second_iter_->get_outlet ()->event_source ()->broadcast (solo_two_event_);
 319           playing_state_ = SOLO2;
 320         }
 321     }
 322 }
 323
 324 void
 325 Part_combine_iterator::chords_together ()
 326 {
 327   if (state_ == TOGETHER)
 328     return;
 329   else
 330     {
 331       playing_state_ = TOGETHER;
 332       state_ = TOGETHER;
 333
 334       substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
 335     }
 336 }
 337
 338 void
 339 Part_combine_iterator::apart (bool silent)
 340 {
 341   if (!silent)
 342     playing_state_ = APART;
 343
 344   if (state_ == APART)
 345     return;
 346   else
 347     {
 348       state_ = APART;
 349       substitute_both (CONTEXT_ONE, CONTEXT_TWO);
 350     }
 351 }
 352
 353 void
 354 Part_combine_iterator::construct_children ()
 355 {
 356   start_moment_ = get_outlet ()->now_mom ();
 357   split_list_ = get_music ()->get_property ("split-list");
 358   direction_ = get_music ()->get_property ("direction");
 359   if (is_direction (direction_))
 360     {
 361       directionOne_ = direction_;
 362       directionTwo_ = direction_;
 363       if (scm_is_true (scm_negative_p (direction_)))
 364         {
 365           horizontalShiftOne_ = scm_from_int (1);
 366           horizontalShiftTwo_ = scm_from_int (0);
 367         }
 368     }
 369
 370   Context *c = get_outlet ();
 371
 372   for (int i = 0; i < NUM_OUTLETS; i++)
 373     {
 374       SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
 375       /* find context below c: otherwise we may create new staff for each voice */
 376       c = c->find_create_context (type, outlet_names_[i], SCM_EOL);
 377       handles_[i].set_context (c);
 378       if (c->is_alias (ly_symbol2scm ("Voice")))
 379         c->event_source ()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
 380     }
 381
 382   SCM lst = get_music ()->get_property ("elements");
 383   Context *one = handles_[CONTEXT_ONE].get_context ();
 384   set_context (one);
 385   first_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_car (lst))));
 386   Context *two = handles_[CONTEXT_TWO].get_context ();
 387   set_context (two);
 388   second_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_cadr (lst))));
 389   Context *shared = handles_[CONTEXT_SHARED].get_context ();
 390   set_context (shared);
 391
 392   /* Mimic all settings of voiceOne/voiceTwo for the two separate voices...*/
 393   /* FIXME: Is there any way to use the definition of \voiceOne/\voiceTwo
 394             directly??? */
 395   char const *syms[]
 396   =
 397   {
 398     "Stem",
 399     "DynamicLineSpanner",
 400     "Tie",
 401     "Dots",
 402     "Rest",
 403     "Slur",
 404     "TextScript",
 405     "Script",
 406     0
 407   };
 408
 409   for (char const **p = syms; *p; p++)
 410     {
 411       SCM sym = ly_symbol2scm (*p);
 412       execute_pushpop_property (one, sym,
 413                                 ly_symbol2scm ("direction"), directionOne_);
 414
 415       execute_pushpop_property (two, sym,
 416                                 ly_symbol2scm ("direction"), directionTwo_);
 417
 418       if (scm_is_number (direction_))
 419         execute_pushpop_property (shared, sym,
 420                                   ly_symbol2scm ("direction"), direction_);
 421     }
 422   /* Handle horizontal shifts for crossing notes */
 423   execute_pushpop_property (one, ly_symbol2scm ("NoteColumn"),
 424                             ly_symbol2scm ("horizontal-shift"), horizontalShiftOne_);
 425   execute_pushpop_property (two, ly_symbol2scm ("NoteColumn"),
 426                             ly_symbol2scm ("horizontal-shift"), horizontalShiftTwo_);
 427   /* Also handle MultiMeasureRest positions for voice 1/2 */
 428   execute_pushpop_property (one, ly_symbol2scm ("MultiMeasureRest"),
 429                             ly_symbol2scm ("staff-position"), scm_from_int (4));
 430   execute_pushpop_property (two, ly_symbol2scm ("MultiMeasureRest"),
 431                             ly_symbol2scm ("staff-position"), scm_from_int (-4));
 432
 433 }
 434
 435 IMPLEMENT_LISTENER (Part_combine_iterator, set_busy);
 436 void
 437 Part_combine_iterator::set_busy (SCM se)
 438 {
 439   if (!notice_busy_)
 440     return;
 441
 442   Stream_event *e = unsmob_stream_event (se);
 443
 444   if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
 445     busy_ = true;
 446 }
 447
 448 /*
 449   Processes a moment in an iterator, and returns whether any new music
 450   was reported.
 451 */
 452 bool
 453 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
 454 {
 455   busy_ = false;
 456   notice_busy_ = true;
 457
 458   i->process (m);
 459
 460   notice_busy_ = false;
 461   return busy_;
 462 }
 463
 464 void
 465 Part_combine_iterator::process (Moment m)
 466 {
 467   Moment now = get_outlet ()->now_mom ();
 468   Moment *splitm = 0;
 469
 470   /* This is needed if construct_children was called before iteration
 471      started */
 472   if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
 473     start_moment_ = now;
 474
 475   for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
 476     {
 477       splitm = unsmob_moment (scm_caar (split_list_));
 478       if (splitm && *splitm + start_moment_ > now)
 479         break;
 480
 481       SCM tag = scm_cdar (split_list_);
 482
 483       if (tag == ly_symbol2scm ("chords"))
 484         chords_together ();
 485       else if (tag == ly_symbol2scm ("apart")
 486                || tag == ly_symbol2scm ("apart-silence")
 487                || tag == ly_symbol2scm ("apart-spanner"))
 488         apart (tag == ly_symbol2scm ("apart-silence"));
 489       else if (tag == ly_symbol2scm ("unisono"))
 490         unisono (false);
 491       else if (tag == ly_symbol2scm ("unisilence"))
 492         unisono (true);
 493       else if (tag == ly_symbol2scm ("solo1"))
 494         solo1 ();
 495       else if (tag == ly_symbol2scm ("solo2"))
 496         solo2 ();
 497       else if (scm_is_symbol (tag))
 498         {
 499           string s = "Unknown split directive: "
 500                      + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
 501           programming_error (s);
 502         }
 503     }
 504
 505   if (first_iter_->ok ())
 506     {
 507       if (try_process (first_iter_, m))
 508         last_playing_ = SOLO1;
 509     }
 510
 511   if (second_iter_->ok ())
 512     {
 513       if (try_process (second_iter_, m))
 514         last_playing_ = SOLO2;
 515     }
 516 }
 517
 518 IMPLEMENT_CTOR_CALLBACK (Part_combine_iterator);