2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2012 Han-Wen Nienhuys
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/>.
21 #include "dispatcher.hh"
22 #include "lily-guile.hh"
24 #include "music-iterator.hh"
25 #include "music-sequence.hh"
30 CONTEXT_ONE, CONTEXT_TWO,
31 CONTEXT_SHARED, CONTEXT_SOLO,
32 CONTEXT_NULL, NUM_OUTLETS
35 static const char *outlet_names_[NUM_OUTLETS]
36 = {"one", "two", "shared", "solo", "null"};
38 class Part_combine_iterator : public Music_iterator
41 Part_combine_iterator ();
43 DECLARE_SCHEME_CALLBACK (constructor, ());
45 virtual void derived_substitute (Context *f, Context *t);
46 virtual void derived_mark () const;
48 virtual void construct_children ();
49 virtual Moment pending_moment () const;
50 virtual void do_quit ();
51 virtual void process (Moment);
53 virtual bool ok () const;
56 /* used by try_process */
57 DECLARE_LISTENER (set_busy);
61 bool try_process (Music_iterator *i, Moment m);
63 Music_iterator *first_iter_;
64 Music_iterator *second_iter_;
71 SCM horizontalShiftOne_;
72 SCM horizontalShiftTwo_;
74 Stream_event *unisono_event_;
75 Stream_event *solo_one_event_;
76 Stream_event *solo_two_event_;
77 Stream_event *mmrest_event_;
89 Status playing_state_;
92 Should be SOLO1 or SOLO2
97 TODO: this is getting off hand...
99 Context_handle handles_[NUM_OUTLETS];
101 void substitute_both (Outlet_type to1,
104 /* parameter is really Outlet_type */
105 void kill_mmrest (int in);
106 void chords_together ();
109 void apart (bool silent);
110 void unisono (bool silent);
114 Part_combine_iterator::do_quit ()
117 first_iter_->quit ();
119 second_iter_->quit ();
121 // Add listeners to all contexts except Devnull.
122 for (int i = 0; i < NUM_OUTLETS; i++)
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);
131 Part_combine_iterator::Part_combine_iterator ()
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);
147 playing_state_ = APART;
148 last_playing_ = APART;
151 notice_busy_ = false;
155 Part_combine_iterator::derived_mark () const
158 scm_gc_mark (first_iter_->self_scm ());
160 scm_gc_mark (second_iter_->self_scm ());
162 scm_gc_mark (unisono_event_->self_scm ());
164 scm_gc_mark (mmrest_event_->self_scm ());
166 scm_gc_mark (solo_one_event_->self_scm ());
168 scm_gc_mark (solo_two_event_->self_scm ());
172 Part_combine_iterator::derived_substitute (Context *f,
176 first_iter_->substitute_outlet (f, t);
180 Part_combine_iterator::pending_moment () const
184 if (first_iter_->ok ())
185 p = min (p, first_iter_->pending_moment ());
187 if (second_iter_->ok ())
188 p = min (p, second_iter_->pending_moment ());
193 Part_combine_iterator::ok () const
195 return first_iter_->ok () || second_iter_->ok ();
199 Part_combine_iterator::substitute_both (Outlet_type to1,
202 Outlet_type tos[] = {to1, to2};
204 Music_iterator *mis[] = {first_iter_, second_iter_};
206 for (int i = 0; i < 2; i++)
208 for (int j = 0; j < NUM_OUTLETS; j++)
210 mis[i]->substitute_outlet (handles_[j].get_context (), handles_[tos[i]].get_context ());
213 for (int j = 0; j < NUM_OUTLETS; j++)
215 if (j != to1 && j != to2)
221 Part_combine_iterator::kill_mmrest (int in)
226 mmrest_event_ = new Stream_event (ly_symbol2scm ("multi-measure-rest-event"));
227 mmrest_event_->set_property ("duration", SCM_EOL);
228 mmrest_event_->unprotect ();
231 handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
235 Part_combine_iterator::unisono (bool silent)
237 Status newstate = (silent) ? UNISILENCE : UNISONO;
239 if (newstate == state_)
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.
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);
254 if (playing_state_ != UNISONO
255 && newstate == UNISONO)
259 unisono_event_ = new Stream_event (ly_symbol2scm ("unisono-event"));
260 unisono_event_->unprotect ();
263 Context *out = (last_playing_ == SOLO2 ? second_iter_ : first_iter_)
265 out->event_source ()->broadcast (unisono_event_);
266 playing_state_ = UNISONO;
273 Part_combine_iterator::solo1 ()
280 substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
282 kill_mmrest (CONTEXT_TWO);
283 kill_mmrest (CONTEXT_SHARED);
285 if (playing_state_ != SOLO1)
287 if (!solo_one_event_)
289 solo_one_event_ = new Stream_event (ly_symbol2scm ("solo-one-event"));
290 solo_one_event_->unprotect ();
293 first_iter_->get_outlet ()->event_source ()->broadcast (solo_one_event_);
295 playing_state_ = SOLO1;
300 Part_combine_iterator::solo2 ()
308 substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
310 if (playing_state_ != SOLO2)
312 if (!solo_two_event_)
314 solo_two_event_ = new Stream_event (ly_symbol2scm ("solo-two-event"));
315 solo_two_event_->unprotect ();
318 second_iter_->get_outlet ()->event_source ()->broadcast (solo_two_event_);
319 playing_state_ = SOLO2;
325 Part_combine_iterator::chords_together ()
327 if (state_ == TOGETHER)
331 playing_state_ = TOGETHER;
334 substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
339 Part_combine_iterator::apart (bool silent)
342 playing_state_ = APART;
349 substitute_both (CONTEXT_ONE, CONTEXT_TWO);
354 Part_combine_iterator::construct_children ()
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_))
361 directionOne_ = direction_;
362 directionTwo_ = direction_;
363 if (scm_is_true (scm_negative_p (direction_)))
365 horizontalShiftOne_ = scm_from_int (1);
366 horizontalShiftTwo_ = scm_from_int (0);
370 Context *c = get_outlet ();
372 for (int i = 0; i < NUM_OUTLETS; i++)
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"));
382 SCM lst = get_music ()->get_property ("elements");
383 Context *one = handles_[CONTEXT_ONE].get_context ();
385 first_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_car (lst))));
386 Context *two = handles_[CONTEXT_TWO].get_context ();
388 second_iter_ = unsmob_iterator (get_iterator (unsmob_music (scm_cadr (lst))));
389 Context *shared = handles_[CONTEXT_SHARED].get_context ();
390 set_context (shared);
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
399 "DynamicLineSpanner",
409 for (char const **p = syms; *p; p++)
411 SCM sym = ly_symbol2scm (*p);
412 execute_pushpop_property (one, sym,
413 ly_symbol2scm ("direction"), directionOne_);
415 execute_pushpop_property (two, sym,
416 ly_symbol2scm ("direction"), directionTwo_);
418 if (scm_is_number (direction_))
419 execute_pushpop_property (shared, sym,
420 ly_symbol2scm ("direction"), direction_);
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));
435 IMPLEMENT_LISTENER (Part_combine_iterator, set_busy);
437 Part_combine_iterator::set_busy (SCM se)
442 Stream_event *e = unsmob_stream_event (se);
444 if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
449 Processes a moment in an iterator, and returns whether any new music
453 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
460 notice_busy_ = false;
465 Part_combine_iterator::process (Moment m)
467 Moment now = get_outlet ()->now_mom ();
470 /* This is needed if construct_children was called before iteration
472 if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
475 for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
477 splitm = unsmob_moment (scm_caar (split_list_));
478 if (splitm && *splitm + start_moment_ > now)
481 SCM tag = scm_cdar (split_list_);
483 if (tag == ly_symbol2scm ("chords"))
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"))
491 else if (tag == ly_symbol2scm ("unisilence"))
493 else if (tag == ly_symbol2scm ("solo1"))
495 else if (tag == ly_symbol2scm ("solo2"))
497 else if (scm_is_symbol (tag))
499 string s = "Unknown split directive: "
500 + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
501 programming_error (s);
505 if (first_iter_->ok ())
507 if (try_process (first_iter_, m))
508 last_playing_ = SOLO1;
511 if (second_iter_->ok ())
513 if (try_process (second_iter_, m))
514 last_playing_ = SOLO2;
518 IMPLEMENT_CTOR_CALLBACK (Part_combine_iterator);