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 */
61 bool try_process (Music_iterator *i, Moment m);
63 Music_iterator *first_iter_;
64 Music_iterator *second_iter_;
69 Stream_event *mmrest_event_;
81 // For states in which it matters, this is the relevant part,
82 // e.g. 1 for Solo I, 2 for Solo II.
85 // States for generating partcombine text.
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, int newpart);
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 (Part_combine_iterator, set_busy), ly_symbol2scm ("music-event"));
127 handles_[i].set_context (0);
131 Part_combine_iterator::Part_combine_iterator ()
137 split_list_ = SCM_EOL;
140 playing_state_ = PLAYING_OTHER;
144 notice_busy_ = false;
148 Part_combine_iterator::derived_mark () const
151 scm_gc_mark (first_iter_->self_scm ());
153 scm_gc_mark (second_iter_->self_scm ());
155 scm_gc_mark (mmrest_event_->self_scm ());
159 Part_combine_iterator::derived_substitute (Context *f,
163 first_iter_->substitute_outlet (f, t);
167 Part_combine_iterator::pending_moment () const
171 if (first_iter_->ok ())
172 p = min (p, first_iter_->pending_moment ());
174 if (second_iter_->ok ())
175 p = min (p, second_iter_->pending_moment ());
180 Part_combine_iterator::ok () const
182 return first_iter_->ok () || second_iter_->ok ();
186 Part_combine_iterator::substitute_both (Outlet_type to1,
189 Outlet_type tos[] = {to1, to2};
191 Music_iterator *mis[] = {first_iter_, second_iter_};
193 for (int i = 0; i < 2; i++)
195 for (int j = 0; j < NUM_OUTLETS; j++)
197 mis[i]->substitute_outlet (handles_[j].get_context (), handles_[tos[i]].get_context ());
200 for (int j = 0; j < NUM_OUTLETS; j++)
202 if (j != to1 && j != to2)
208 Part_combine_iterator::kill_mmrest (int in)
213 mmrest_event_ = new Stream_event
214 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"),
215 ly_symbol2scm ("multi-measure-rest-event")));
216 mmrest_event_->set_property ("duration", SCM_EOL);
217 mmrest_event_->unprotect ();
220 handles_[in].get_context ()->event_source ()->broadcast (mmrest_event_);
224 Part_combine_iterator::unisono (bool silent, int newpart)
226 Status newstate = (silent) ? UNISILENCE : UNISONO;
228 if ((newstate == state_) and (newpart == chosen_part_))
232 Outlet_type c1 = (newpart == 2) ? CONTEXT_NULL : CONTEXT_SHARED;
233 Outlet_type c2 = (newpart == 2) ? CONTEXT_SHARED : CONTEXT_NULL;
234 substitute_both (c1, c2);
235 kill_mmrest ((newpart == 2) ? CONTEXT_ONE : CONTEXT_TWO);
236 kill_mmrest (CONTEXT_SHARED);
238 if (playing_state_ != PLAYING_UNISONO
239 && newstate == UNISONO)
241 playing_state_ = PLAYING_UNISONO;
244 chosen_part_ = newpart;
249 Part_combine_iterator::solo1 ()
251 if ((state_ == SOLO) && (chosen_part_ == 1))
257 substitute_both (CONTEXT_SOLO, CONTEXT_NULL);
259 kill_mmrest (CONTEXT_TWO);
260 kill_mmrest (CONTEXT_SHARED);
262 playing_state_ = PLAYING_SOLO1;
267 Part_combine_iterator::solo2 ()
269 if ((state_ == SOLO) and (chosen_part_ == 2))
275 substitute_both (CONTEXT_NULL, CONTEXT_SOLO);
277 playing_state_ = PLAYING_SOLO2;
282 Part_combine_iterator::chords_together ()
284 if (state_ == TOGETHER)
288 playing_state_ = PLAYING_OTHER;
291 substitute_both (CONTEXT_SHARED, CONTEXT_SHARED);
296 Part_combine_iterator::apart (bool silent)
299 playing_state_ = PLAYING_OTHER;
306 substitute_both (CONTEXT_ONE, CONTEXT_TWO);
311 Part_combine_iterator::construct_children ()
313 start_moment_ = get_outlet ()->now_mom ();
314 split_list_ = get_music ()->get_property ("split-list");
316 Context *c = get_outlet ();
318 for (int i = 0; i < NUM_OUTLETS; i++)
320 SCM type = (i == CONTEXT_NULL) ? ly_symbol2scm ("Devnull") : ly_symbol2scm ("Voice");
321 /* find context below c: otherwise we may create new staff for each voice */
322 c = c->find_create_context (type, outlet_names_[i], SCM_EOL);
323 handles_[i].set_context (c);
324 if (c->is_alias (ly_symbol2scm ("Voice")))
325 c->event_source ()->add_listener (GET_LISTENER (Part_combine_iterator, set_busy), ly_symbol2scm ("music-event"));
328 SCM lst = get_music ()->get_property ("elements");
329 Context *one = handles_[CONTEXT_ONE].get_context ();
331 first_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_car (lst))));
332 Context *two = handles_[CONTEXT_TWO].get_context ();
334 second_iter_ = Music_iterator::unsmob (get_iterator (Music::unsmob (scm_cadr (lst))));
335 Context *shared = handles_[CONTEXT_SHARED].get_context ();
336 set_context (shared);
340 Part_combine_iterator::set_busy (SCM se)
345 Stream_event *e = Stream_event::unsmob (se);
347 if (e->in_event_class ("note-event") || e->in_event_class ("cluster-note-event"))
352 Processes a moment in an iterator, and returns whether any new music
356 Part_combine_iterator::try_process (Music_iterator *i, Moment m)
363 notice_busy_ = false;
368 Part_combine_iterator::process (Moment m)
370 Moment now = get_outlet ()->now_mom ();
373 /* This is needed if construct_children was called before iteration
375 if (start_moment_.main_part_.is_infinity () && start_moment_ < 0)
378 for (; scm_is_pair (split_list_); split_list_ = scm_cdr (split_list_))
380 splitm = Moment::unsmob (scm_caar (split_list_));
381 if (splitm && *splitm + start_moment_ > now)
384 SCM tag = scm_cdar (split_list_);
386 if (scm_is_eq (tag, ly_symbol2scm ("chords")))
388 else if (scm_is_eq (tag, ly_symbol2scm ("apart"))
389 || scm_is_eq (tag, ly_symbol2scm ("apart-silence"))
390 || scm_is_eq (tag, ly_symbol2scm ("apart-spanner")))
391 apart (scm_is_eq (tag, ly_symbol2scm ("apart-silence")));
392 else if (scm_is_eq (tag, ly_symbol2scm ("unisono")))
394 // Continue to use the most recently used part because we might have
395 // killed mmrests in the other part.
396 unisono (false, (last_playing_ == 2) ? 2 : 1);
398 else if (scm_is_eq (tag, ly_symbol2scm ("unisilence")))
401 unisono (true, (last_playing_ == 2) ? 2 : 1);
403 else if (scm_is_eq (tag, ly_symbol2scm ("silence1")))
405 else if (scm_is_eq (tag, ly_symbol2scm ("silence2")))
407 else if (scm_is_eq (tag, ly_symbol2scm ("solo1")))
409 else if (scm_is_eq (tag, ly_symbol2scm ("solo2")))
411 else if (scm_is_symbol (tag))
413 string s = "Unknown split directive: "
414 + (scm_is_symbol (tag) ? ly_symbol2string (tag) : string ("not a symbol"));
415 programming_error (s);
419 if (first_iter_->ok ())
421 if (try_process (first_iter_, m))
425 if (second_iter_->ok ())
427 if (try_process (second_iter_, m))
432 IMPLEMENT_CTOR_CALLBACK (Part_combine_iterator);