2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 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_;
69 Stream_event *unisono_event_;
70 Stream_event *solo_one_event_;
71 Stream_event *solo_two_event_;
72 Stream_event *mmrest_event_;
84 // For states in which it matters, this is the relevant part,
85 // e.g. 1 for Solo I, 2 for Solo II.
88 // States for generating partcombine text.
100 TODO: this is getting off hand...
102 Context_handle handles_[NUM_OUTLETS];
104 void substitute_both (Outlet_type to1,
107 /* parameter is really Outlet_type */
108 void kill_mmrest (int in);
109 void chords_together ();
112 void apart (bool silent);
113 void unisono (bool silent, int newpart);
117 Part_combine_iterator::do_quit ()
120 first_iter_->quit ();
122 second_iter_->quit ();
124 // Add listeners to all contexts except Devnull.
125 for (int i = 0; i < NUM_OUTLETS; i++)
127 Context *c = handles_[i].get_context ();
128 if (c->is_alias (ly_symbol2scm ("Voice")))
129 c->event_source ()->remove_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
130 handles_[i].set_context (0);
134 Part_combine_iterator::Part_combine_iterator ()
143 split_list_ = SCM_EOL;
146 playing_state_ = PLAYING_OTHER;
150 notice_busy_ = false;
154 Part_combine_iterator::derived_mark () const
157 scm_gc_mark (first_iter_->self_scm ());
159 scm_gc_mark (second_iter_->self_scm ());
161 scm_gc_mark (unisono_event_->self_scm ());
163 scm_gc_mark (mmrest_event_->self_scm ());
165 scm_gc_mark (solo_one_event_->self_scm ());
167 scm_gc_mark (solo_two_event_->self_scm ());
171 Part_combine_iterator::derived_substitute (Context *f,
175 first_iter_->substitute_outlet (f, t);
179 Part_combine_iterator::pending_moment () const
183 if (first_iter_->ok ())
184 p = min (p, first_iter_->pending_moment ());
186 if (second_iter_->ok ())
187 p = min (p, second_iter_->pending_moment ());
192 Part_combine_iterator::ok () const
194 return first_iter_->ok () || second_iter_->ok ();
198 Part_combine_iterator::substitute_both (Outlet_type to1,
201 Outlet_type tos[] = {to1, to2};
203 Music_iterator *mis[] = {first_iter_, second_iter_};
205 for (int i = 0; i < 2; i++)
207 for (int j = 0; j < NUM_OUTLETS; j++)
209 mis[i]->substitute_outlet (handles_[j].get_context (), handles_[tos[i]].get_context ());
212 for (int j = 0; j < NUM_OUTLETS; j++)
214 if (j != to1 && j != to2)
220 Part_combine_iterator::kill_mmrest (int in)
225 mmrest_event_ = new Stream_event
226 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
227 ly_symbol2scm ("multi-measure-rest-event")));
228 mmrest_event_->set_property ("duration", SCM_EOL);
229 mmrest_event_->unprotect ();
232 handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
236 Part_combine_iterator::unisono (bool silent, int newpart)
238 Status newstate = (silent) ? UNISILENCE : UNISONO;
240 if ((newstate == state_) and (newpart == chosen_part_))
244 Outlet_type c1 = (newpart == 2) ? CONTEXT_NULL : CONTEXT_SHARED;
245 Outlet_type c2 = (newpart == 2) ? CONTEXT_SHARED : CONTEXT_NULL;
246 substitute_both (c1, c2);
247 kill_mmrest ((newpart == 2) ? CONTEXT_ONE : CONTEXT_TWO);
248 kill_mmrest (CONTEXT_SHARED);
250 if (playing_state_ != PLAYING_UNISONO
251 && newstate == UNISONO)
255 unisono_event_ = new Stream_event
256 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
257 ly_symbol2scm ("unisono-event")));
258 unisono_event_->unprotect ();
261 Context *out = (newpart == 2 ? second_iter_ : first_iter_)
263 out->event_source ()->broadcast (unisono_event_);
264 playing_state_ = PLAYING_UNISONO;
267 chosen_part_ = newpart;
272 Part_combine_iterator::solo1 ()
274 if ((state_ == SOLO) && (chosen_part_ == 1))
280 substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
282 kill_mmrest (CONTEXT_TWO);
283 kill_mmrest (CONTEXT_SHARED);
285 if (playing_state_ != PLAYING_SOLO1)
287 if (!solo_one_event_)
289 solo_one_event_ = new Stream_event
290 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
291 ly_symbol2scm ("solo-one-event")));
292 solo_one_event_->unprotect ();
295 first_iter_->get_outlet ()->event_source ()->broadcast (solo_one_event_);
297 playing_state_ = PLAYING_SOLO1;
302 Part_combine_iterator::solo2 ()
304 if ((state_ == SOLO) and (chosen_part_ == 2))
310 substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
312 if (playing_state_ != PLAYING_SOLO2)
314 if (!solo_two_event_)
316 solo_two_event_ = new Stream_event
317 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
318 ly_symbol2scm ("solo-two-event")));
319 solo_two_event_->unprotect ();
322 second_iter_->get_outlet ()->event_source ()->broadcast (solo_two_event_);
323 playing_state_ = PLAYING_SOLO2;
329 Part_combine_iterator::chords_together ()
331 if (state_ == TOGETHER)
335 playing_state_ = PLAYING_OTHER;
338 substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
343 Part_combine_iterator::apart (bool silent)
346 playing_state_ = PLAYING_OTHER;
353 substitute_both (CONTEXT_ONE, CONTEXT_TWO);
358 Part_combine_iterator::construct_children ()
360 start_moment_ = get_outlet ()->now_mom ();
361 split_list_ = get_music ()->get_property ("split-list");
363 Context *c = get_outlet ();
365 for (int i = 0; i < NUM_OUTLETS; i++)
367 SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
368 /* find context below c: otherwise we may create new staff for each voice */
369 c = c->find_create_context (type, outlet_names_[i], SCM_EOL);
370 handles_[i].set_context (c);
371 if (c->is_alias (ly_symbol2scm ("Voice")))
372 c->event_source ()->add_listener (GET_LISTENER (set_busy), ly_symbol2scm ("music-event"));
375 SCM lst = get_music ()->get_property ("elements");
376 Context *one = handles_[CONTEXT_ONE].get_context ();
378 first_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_car (lst))));
379 Context *two = handles_[CONTEXT_TWO].get_context ();
381 second_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_cadr (lst))));
382 Context *shared = handles_[CONTEXT_SHARED].get_context ();
383 set_context (shared);
386 IMPLEMENT_LISTENER (Part_combine_iterator, set_busy);
388 Part_combine_iterator::set_busy (SCM se)
393 Stream_event *e = Stream_event::unsmob (se);
395 if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
400 Processes a moment in an iterator, and returns whether any new music
404 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
411 notice_busy_ = false;
416 Part_combine_iterator::process (Moment m)
418 Moment now = get_outlet ()->now_mom ();
421 /* This is needed if construct_children was called before iteration
423 if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
426 for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
428 splitm = Moment::unsmob (scm_caar (split_list_));
429 if (splitm && *splitm + start_moment_ > now)
432 SCM tag = scm_cdar (split_list_);
434 if (scm_is_eq (tag, ly_symbol2scm ("chords")))
436 else if (scm_is_eq (tag, ly_symbol2scm ("apart"))
437 || scm_is_eq (tag, ly_symbol2scm ("apart-silence"))
438 || scm_is_eq (tag, ly_symbol2scm ("apart-spanner")))
439 apart (scm_is_eq (tag, ly_symbol2scm ("apart-silence")));
440 else if (scm_is_eq (tag, ly_symbol2scm ("unisono")))
442 // Continue to use the most recently used part because we might have
443 // killed mmrests in the other part.
444 unisono (false, (last_playing_ == 2) ? 2 : 1);
446 else if (scm_is_eq (tag, ly_symbol2scm ("unisilence")))
449 unisono (true, (last_playing_ == 2) ? 2 : 1);
451 else if (scm_is_eq (tag, ly_symbol2scm ("silence1")))
453 else if (scm_is_eq (tag, ly_symbol2scm ("silence2")))
455 else if (scm_is_eq (tag, ly_symbol2scm ("solo1")))
457 else if (scm_is_eq (tag, ly_symbol2scm ("solo2")))
459 else if (scm_is_symbol (tag))
461 string s = "Unknown split directive: "
462 + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
463 programming_error (s);
467 if (first_iter_->ok ())
469 if (try_process (first_iter_, m))
473 if (second_iter_->ok ())
475 if (try_process (second_iter_, m))
480 IMPLEMENT_CTOR_CALLBACK (Part_combine_iterator);