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_acknowledged ();
43 virtual void process_music ();
44 virtual void finalize ();
45 virtual void derived_mark () const;
47 DECLARE_ACKNOWLEDGER (rest);
48 DECLARE_ACKNOWLEDGER (beam);
49 DECLARE_ACKNOWLEDGER (bar_line);
50 DECLARE_ACKNOWLEDGER (breathing_sign);
51 DECLARE_ACKNOWLEDGER (stem);
52 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
55 virtual bool test_moment (Direction, Moment, Moment);
56 void consider_begin (Moment, Moment);
57 void consider_end (Moment, Moment);
58 Spanner *create_beam ();
62 virtual bool is_same_grace_state (Moment, Moment);
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::is_same_grace_state (Moment start, Moment now)
269 return bool (start.grace_part_) == bool (now.grace_part_);
274 Auto_beam_engraver::end_beam ()
276 if (stems_->size () < 2)
280 finished_beam_ = create_beam ();
284 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
285 i.rerouting_daddy_context_ = beam_start_context_.get_context ();
287 announce_end_grob (i);
288 finished_grouping_ = grouping_;
289 finished_beaming_options_ = beaming_options_;
294 beam_settings_ = SCM_EOL;
297 beam_start_context_.set_context (NULL);
298 shortest_mom_ = Moment (Rational (1, 4));
302 Auto_beam_engraver::typeset_beam ()
306 if (!finished_beam_->get_bound (RIGHT))
307 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
309 finished_grouping_->beamify (finished_beaming_options_);
310 Beam::set_beaming (finished_beam_, finished_grouping_);
313 delete finished_grouping_;
314 finished_grouping_ = 0;
319 Auto_beam_engraver::stop_translation_timestep ()
322 process_acknowledged_count_ = 0;
327 Auto_beam_engraver::finalize ()
329 /* finished beams may be typeset */
331 /* but unfinished may need another announce/acknowledge pass */
337 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
339 check_bar_property ();
345 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
347 check_bar_property ();
353 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
355 check_bar_property ();
361 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
363 check_bar_property ();
369 Auto_beam_engraver::acknowledge_stem (Grob_info info)
371 check_bar_property ();
372 Item *stem = dynamic_cast<Item *> (info.grob ());
373 Stream_event *ev = info.ultimate_event_cause ();
374 if (!ev->in_event_class ("rhythmic-event"))
376 programming_error ("stem must have rhythmic structure");
381 Don't (start) auto-beam over empty stems; skips or rests
383 if (!Stem::head_count (stem))
390 if (Stem::get_beam (stem))
397 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
407 ignore interspersed grace notes.
409 Moment now = now_mom ();
410 if (!is_same_grace_state (beam_start_location_, now))
413 Duration *stem_duration = unsmob_duration (ev->get_property ("duration"));
414 Moment dur = stem_duration->get_length ();
416 //Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
417 Moment measure_now = measure_position (context ());
418 bool recheck_needed = false;
420 if (dur < shortest_mom_)
422 /* new shortest moment, so store it and set recheck_needed */
424 recheck_needed = true;
427 /* end should be based on shortest_mom_, begin should be
428 based on current duration */
429 consider_end (measure_now, shortest_mom_);
430 consider_begin (measure_now, dur);
435 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
437 Stem::is_invisible (stem),
438 stem_duration->factor (),
439 (stem->get_property ("tuplet-start") == SCM_BOOL_T));
440 stems_->push_back (stem);
442 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
448 Auto_beam_engraver::recheck_beam ()
451 Recheck the beam after the shortest duration has changed
452 If shorter duration has created a new break, typeset the
453 first part of the beam and reset the current beam to just
454 the last part of the beam
456 Beaming_pattern *new_grouping_ = 0;
457 vector<Item *> *new_stems_ = 0;
458 Moment temporary_shortest_mom;
459 SCM temporary_beam_settings;
463 for (vsize i = 0; i < stems_->size () - 1;)
465 found_end = test_moment (STOP,
466 grouping_->end_moment (i),
473 Save the current beam settings and shortest_mom_
474 Necessary because end_beam destroys them
476 temporary_shortest_mom = shortest_mom_;
477 temporary_beam_settings = beam_settings_;
479 /* Eliminate (and save) the items no longer part of the first beam */
481 new_grouping_ = grouping_->split_pattern (i);
482 new_stems_ = remove_end_stems (i);
487 /* now recreate the unbeamed data structures */
489 grouping_ = new_grouping_;
490 shortest_mom_ = temporary_shortest_mom;
491 beam_settings_ = temporary_beam_settings;
501 Remove all stems with an index greater than split_index
502 from stems_, and return a vector containing all of the
506 Auto_beam_engraver::remove_end_stems (vsize split_index)
508 vector <Item *> *removed_stems = 0;
509 removed_stems = new vector <Item *>;
511 for (vsize j = split_index + 1; j < stems_->size (); j++)
512 removed_stems->push_back ((*stems_).at (j));
513 for (vsize j = split_index + 1; j < stems_->size ();)
515 return removed_stems;
519 Auto_beam_engraver::process_acknowledged ()
521 Moment now = now_mom ();
522 if (extend_mom_ > now)
525 if (!process_acknowledged_count_)
527 Moment measure_now = measure_position (context ());
528 consider_end (measure_now, shortest_mom_);
530 else if (process_acknowledged_count_ > 1)
534 if ((extend_mom_ < now)
535 || ((extend_mom_ == now) && (last_add_mom_ != now)))
537 else if (!stems_->size ())
542 process_acknowledged_count_++;
545 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
546 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
547 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
548 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
549 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
550 ADD_TRANSLATOR (Auto_beam_engraver,
552 "Generate beams based on measure characteristics and observed"
553 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
554 " @code{beamExceptions}, @code{measureLength}, and"
555 " @code{measurePosition} to decide when to start and stop a"
556 " beam. Overriding beaming is done through"
557 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
558 " @code{stemRightBeamCount}.",
575 class Grace_auto_beam_engraver : public Auto_beam_engraver
577 TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
578 DECLARE_TRANSLATOR_LISTENER (beam_forbid);
581 Moment last_grace_start_; // Full starting time of last grace group
582 Moment last_grace_position_; // Measure position of same
583 virtual void process_music ();
584 virtual bool is_same_grace_state (Moment, Moment);
585 virtual bool test_moment (Direction, Moment, Moment);
588 Grace_auto_beam_engraver::Grace_auto_beam_engraver ()
590 last_grace_start_.main_part_.set_infinite (-1);
591 // grace_part_ is zero -> test_moment is false, last_grace_position_
595 IMPLEMENT_TRANSLATOR_LISTENER (Grace_auto_beam_engraver, beam_forbid);
597 Grace_auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
599 Auto_beam_engraver::listen_beam_forbid (ev);
603 Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
605 // This is for ignoring interspersed grace notes in main note
606 // beaming. We never want to ignore something inside of grace note
607 // beaming, so return true.
612 Grace_auto_beam_engraver::process_music ()
614 Moment now = now_mom ();
615 // Update last_grace_start_ and last_grace_position_ only when the
616 // main time advances.
617 if (now.main_part_ > last_grace_start_.main_part_)
619 last_grace_start_ = now;
620 last_grace_position_ = measure_position (context ());
623 Auto_beam_engraver::process_music ();
627 Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
629 // If no grace group started this main moment, we have no business
630 // beaming. Same if we have left the original main time step.
631 if (!last_grace_start_.grace_part_
632 || last_grace_position_.main_part_ != test_mom.main_part_)
634 // Autobeam start only when at the start of the grace group.
636 return last_grace_position_ == test_mom;
637 // Autobeam end only when the grace part is finished.
638 return !test_mom.grace_part_;
641 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, stem);
642 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, bar_line);
643 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, beam);
644 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, breathing_sign);
645 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, rest);
646 ADD_TRANSLATOR (Grace_auto_beam_engraver,
648 "Generates one autobeam group across an entire grace phrase. "
649 " As usual, any manual beaming or @code{\\noBeam} will block"
650 " autobeaming, just like setting the context property"
651 " @samp{autoBeaming} to @code{##f}.",