2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2012 Jan Nieuwenhuizen <janneke@gnu.org>
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/>.
20 #include "beaming-pattern.hh"
23 #include "context-handle.hh"
24 #include "duration.hh"
25 #include "engraver.hh"
29 #include "stream-event.hh"
33 #include "translator.icc"
35 class Auto_beam_engraver : public Engraver
37 TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
40 void stop_translation_timestep ();
41 void process_music ();
42 virtual void finalize ();
43 virtual void derived_mark () const;
45 DECLARE_ACKNOWLEDGER (rest);
46 DECLARE_ACKNOWLEDGER (beam);
47 DECLARE_ACKNOWLEDGER (bar_line);
48 DECLARE_ACKNOWLEDGER (breathing_sign);
49 DECLARE_ACKNOWLEDGER (stem);
50 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
52 void process_acknowledged ();
55 bool test_moment (Direction, Moment, Moment);
56 void consider_begin (Moment, Moment);
57 void consider_end (Moment, Moment);
58 Spanner *create_beam ();
62 bool is_same_grace_state (Grob *e);
65 vector<Item *> *remove_end_stems (vsize);
67 Stream_event *forbid_;
69 shortest_mom_ is the shortest note in the beam.
72 Spanner *finished_beam_;
73 vector<Item *> *stems_;
75 int process_acknowledged_count_;
78 Projected ending of the beam we're working on.
81 Moment beam_start_moment_;
82 Moment beam_start_location_;
84 Handle on the starting staff keeps it alive until beam is comlete
86 Context_handle beam_start_context_;
88 // We act as if beam were created, and start a grouping anyway.
89 Beaming_pattern *grouping_;
92 Beaming_pattern *finished_grouping_;
94 Beaming_options beaming_options_;
95 Beaming_options finished_beaming_options_;
97 void check_bar_property ();
101 Auto_beam_engraver::derived_mark () const
103 scm_gc_mark (beam_settings_);
107 Auto_beam_engraver::check_bar_property ()
109 /* Duplicated from process_music (), since
110 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
112 Moment now = now_mom ();
113 if (scm_is_string (get_property ("whichBar"))
114 && beam_start_moment_ < now)
116 consider_end (measure_position (context ()), shortest_mom_);
122 Auto_beam_engraver::process_music ()
124 Moment now = now_mom ();
126 don't beam over skips
130 if (extend_mom_ < now)
134 if (scm_is_string (get_property ("whichBar")))
136 consider_end (measure_position (context ()), shortest_mom_);
149 Auto_beam_engraver::Auto_beam_engraver ()
152 process_acknowledged_count_ = 0;
154 shortest_mom_ = Moment (Rational (1, 4));
156 finished_grouping_ = 0;
158 beam_settings_ = SCM_EOL;
161 IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
163 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
165 ASSIGN_EVENT_ONCE (forbid_, ev);
169 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
171 return scm_call_4 (get_property ("autoBeamCheck"),
172 context ()->self_scm (),
174 test_mom.smobbed_copy (),
180 Auto_beam_engraver::consider_begin (Moment test_mom, Moment dur)
182 bool on = to_boolean (get_property ("autoBeaming"));
186 bool b = test_moment (START, test_mom, dur);
193 Auto_beam_engraver::consider_end (Moment test_mom, Moment dur)
197 /* Allow already started autobeam to end:
198 don't check for autoBeaming */
199 bool b = test_moment (STOP, test_mom, dur);
206 Auto_beam_engraver::create_beam ()
208 if (to_boolean (get_property ("skipTypesetting")))
211 for (vsize i = 0; i < stems_->size (); i++)
212 if (Stem::get_beam ((*stems_)[i]))
216 Can't use make_spanner () because we have to use
219 Spanner *beam = new Spanner (beam_settings_);
221 for (vsize i = 0; i < stems_->size (); i++)
222 Beam::add_stem (beam, (*stems_)[i]);
224 Grob_info i = make_grob_info (beam, (*stems_)[0]->self_scm ());
225 i.rerouting_daddy_context_ = beam_start_context_.get_context ();
232 Auto_beam_engraver::begin_beam ()
234 if (stems_ || grouping_)
236 programming_error ("already have autobeam");
240 stems_ = new vector<Item *>;
241 grouping_ = new Beaming_pattern ();
242 beaming_options_.from_context (context ());
243 beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
245 beam_start_context_.set_context (context ()->get_parent_context ());
246 beam_start_moment_ = now_mom ();
248 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
252 Auto_beam_engraver::junk_beam ()
261 beam_settings_ = SCM_EOL;
263 shortest_mom_ = Moment (Rational (1, 4));
267 Auto_beam_engraver::end_beam ()
269 if (stems_->size () < 2)
273 finished_beam_ = create_beam ();
277 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
278 i.rerouting_daddy_context_ = beam_start_context_.get_context ();
280 announce_end_grob (i);
281 finished_grouping_ = grouping_;
282 finished_beaming_options_ = beaming_options_;
287 beam_settings_ = SCM_EOL;
290 beam_start_context_.set_context (NULL);
291 shortest_mom_ = Moment (Rational (1, 4));
295 Auto_beam_engraver::typeset_beam ()
299 if (!finished_beam_->get_bound (RIGHT))
300 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
302 finished_grouping_->beamify (finished_beaming_options_);
303 Beam::set_beaming (finished_beam_, finished_grouping_);
306 delete finished_grouping_;
307 finished_grouping_ = 0;
312 Auto_beam_engraver::stop_translation_timestep ()
315 process_acknowledged_count_ = 0;
320 Auto_beam_engraver::finalize ()
322 /* finished beams may be typeset */
324 /* but unfinished may need another announce/acknowledge pass */
330 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
332 check_bar_property ();
338 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
340 check_bar_property ();
346 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
348 check_bar_property ();
354 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
356 check_bar_property ();
362 Auto_beam_engraver::acknowledge_stem (Grob_info info)
364 check_bar_property ();
365 Item *stem = dynamic_cast<Item *> (info.grob ());
366 Stream_event *ev = info.ultimate_event_cause ();
367 if (!ev->in_event_class ("rhythmic-event"))
369 programming_error ("stem must have rhythmic structure");
374 Don't (start) auto-beam over empty stems; skips or rests
376 if (!Stem::head_count (stem))
383 if (Stem::get_beam (stem))
390 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
402 Moment now = now_mom ();
403 if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
406 Duration *stem_duration = unsmob_duration (ev->get_property ("duration"));
407 Moment dur = stem_duration->get_length ();
409 //Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
410 Moment measure_now = measure_position (context ());
411 bool recheck_needed = false;
413 if (dur < shortest_mom_)
415 /* new shortest moment, so store it and set recheck_needed */
417 recheck_needed = true;
420 /* end should be based on shortest_mom_, begin should be
421 based on current duration */
422 consider_end (measure_now, shortest_mom_);
423 consider_begin (measure_now, dur);
428 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
430 Stem::is_invisible (stem),
431 stem_duration->factor (),
432 (stem->get_property ("tuplet-start") == SCM_BOOL_T));
433 stems_->push_back (stem);
435 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
441 Auto_beam_engraver::recheck_beam ()
444 Recheck the beam after the shortest duration has changed
445 If shorter duration has created a new break, typeset the
446 first part of the beam and reset the current beam to just
447 the last part of the beam
449 Beaming_pattern *new_grouping_ = 0;
450 vector<Item *> *new_stems_ = 0;
451 Moment temporary_shortest_mom;
452 SCM temporary_beam_settings;
456 for (vsize i = 0; i < stems_->size () - 1;)
458 found_end = test_moment (STOP,
459 grouping_->end_moment (i),
466 Save the current beam settings and shortest_mom_
467 Necessary because end_beam destroys them
469 temporary_shortest_mom = shortest_mom_;
470 temporary_beam_settings = beam_settings_;
472 /* Eliminate (and save) the items no longer part of the first beam */
474 new_grouping_ = grouping_->split_pattern (i);
475 new_stems_ = remove_end_stems (i);
480 /* now recreate the unbeamed data structures */
482 grouping_ = new_grouping_;
483 shortest_mom_ = temporary_shortest_mom;
484 beam_settings_ = temporary_beam_settings;
494 Remove all stems with an index greater than split_index
495 from stems_, and return a vector containing all of the
499 Auto_beam_engraver::remove_end_stems (vsize split_index)
501 vector <Item *> *removed_stems = 0;
502 removed_stems = new vector <Item *>;
504 for (vsize j = split_index + 1; j < stems_->size (); j++)
505 removed_stems->push_back ((*stems_).at (j));
506 for (vsize j = split_index + 1; j < stems_->size ();)
508 return removed_stems;
512 Auto_beam_engraver::process_acknowledged ()
514 Moment now = now_mom ();
515 if (extend_mom_ > now)
518 if (!process_acknowledged_count_)
520 Moment measure_now = measure_position (context ());
521 consider_end (measure_now, shortest_mom_);
523 else if (process_acknowledged_count_ > 1)
527 if ((extend_mom_ < now)
528 || ((extend_mom_ == now) && (last_add_mom_ != now)))
530 else if (!stems_->size ())
535 process_acknowledged_count_++;
538 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
539 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
540 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
541 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
542 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
543 ADD_TRANSLATOR (Auto_beam_engraver,
545 "Generate beams based on measure characteristics and observed"
546 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
547 " @code{beamExceptions}, @code{measureLength}, and"
548 " @code{measurePosition} to decide when to start and stop a"
549 " beam. Overriding beaming is done through"
550 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
551 " @code{stemRightBeamCount}.",