2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2015 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"
26 #include "grob-properties.hh"
30 #include "stream-event.hh"
34 #include "translator.icc"
36 class Auto_beam_engraver : public Engraver
38 TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
41 void stop_translation_timestep ();
42 void process_acknowledged ();
44 virtual void process_music ();
45 virtual void finalize ();
46 virtual void derived_mark () const;
48 void acknowledge_rest (Grob_info);
49 void acknowledge_beam (Grob_info);
50 void acknowledge_bar_line (Grob_info);
51 void acknowledge_breathing_sign (Grob_info);
52 void acknowledge_stem (Grob_info);
53 void listen_beam_forbid (Stream_event *);
56 virtual bool test_moment (Direction, Moment, Moment);
57 void consider_begin (Moment, Moment);
58 void consider_end (Moment, Moment);
59 Spanner *create_beam ();
63 virtual bool is_same_grace_state (Moment, Moment);
66 vector<Item *> *remove_end_stems (vsize);
68 Stream_event *forbid_;
70 shortest_mom_ is the shortest note in the beam.
73 Spanner *finished_beam_;
74 vector<Item *> *stems_;
76 int process_acknowledged_count_;
79 Projected ending of the beam we're working on.
82 Moment beam_start_moment_;
83 Moment beam_start_location_;
85 Handle on the starting staff keeps it alive until beam is comlete
87 Context_handle beam_start_context_;
89 // We act as if beam were created, and start a grouping anyway.
90 Beaming_pattern *grouping_;
93 Beaming_pattern *finished_grouping_;
95 Beaming_options beaming_options_;
96 Beaming_options finished_beaming_options_;
98 void check_bar_property ();
102 Auto_beam_engraver::derived_mark () const
104 scm_gc_mark (beam_settings_);
108 Auto_beam_engraver::check_bar_property ()
110 /* Duplicated from process_music (), since
111 Repeat_acknowledge_engraver::process_music () may also set whichBar. */
113 Moment now = now_mom ();
114 if (scm_is_string (get_property ("whichBar"))
115 && beam_start_moment_ < now)
117 consider_end (measure_position (context ()), shortest_mom_);
123 Auto_beam_engraver::process_music ()
125 Moment now = now_mom ();
127 don't beam over skips
131 if (extend_mom_ < now)
135 if (scm_is_string (get_property ("whichBar")))
137 consider_end (measure_position (context ()), shortest_mom_);
150 Auto_beam_engraver::Auto_beam_engraver ()
153 process_acknowledged_count_ = 0;
155 shortest_mom_ = Moment (Rational (1, 4));
156 extend_mom_ = Moment (-1);
158 finished_grouping_ = 0;
160 beam_settings_ = SCM_EOL;
164 Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
166 ASSIGN_EVENT_ONCE (forbid_, ev);
170 Auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment dur)
172 return scm_is_true (scm_call_4 (get_property ("autoBeamCheck"),
173 context ()->self_scm (),
175 test_mom.smobbed_copy (),
176 dur.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 announce_grob (i, beam_start_context_.get_context ());
231 Auto_beam_engraver::begin_beam ()
233 if (stems_ || grouping_)
235 programming_error ("already have autobeam");
239 stems_ = new vector<Item *>;
240 grouping_ = new Beaming_pattern ();
241 beaming_options_.from_context (context ());
242 beam_settings_ = Grob_property_info (context (), ly_symbol2scm ("Beam")).updated ();
244 beam_start_context_.set_context (context ()->get_parent_context ());
245 beam_start_moment_ = now_mom ();
247 = robust_scm2moment (get_property ("measurePosition"), Moment (0));
251 Auto_beam_engraver::junk_beam ()
260 beam_settings_ = SCM_EOL;
262 shortest_mom_ = Moment (Rational (1, 4));
266 Auto_beam_engraver::is_same_grace_state (Moment start, Moment now)
268 return bool (start.grace_part_) == bool (now.grace_part_);
273 Auto_beam_engraver::end_beam ()
275 if (stems_->size () < 2)
279 finished_beam_ = create_beam ();
283 Grob_info i = make_grob_info (finished_beam_, SCM_EOL);
285 announce_end_grob (i, beam_start_context_.get_context ());
286 finished_grouping_ = grouping_;
287 finished_beaming_options_ = beaming_options_;
292 beam_settings_ = SCM_EOL;
295 beam_start_context_.set_context (NULL);
296 shortest_mom_ = Moment (Rational (1, 4));
300 Auto_beam_engraver::typeset_beam ()
304 if (!finished_beam_->get_bound (RIGHT))
305 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
307 finished_grouping_->beamify (finished_beaming_options_);
308 Beam::set_beaming (finished_beam_, finished_grouping_);
311 delete finished_grouping_;
312 finished_grouping_ = 0;
317 Auto_beam_engraver::stop_translation_timestep ()
320 process_acknowledged_count_ = 0;
325 Auto_beam_engraver::finalize ()
327 /* finished beams may be typeset */
329 /* but unfinished may need another announce/acknowledge pass */
335 Auto_beam_engraver::acknowledge_beam (Grob_info /* info */)
337 check_bar_property ();
343 Auto_beam_engraver::acknowledge_bar_line (Grob_info /* info */)
345 check_bar_property ();
351 Auto_beam_engraver::acknowledge_breathing_sign (Grob_info /* info */)
353 check_bar_property ();
359 Auto_beam_engraver::acknowledge_rest (Grob_info /* info */)
361 check_bar_property ();
367 Auto_beam_engraver::acknowledge_stem (Grob_info info)
369 check_bar_property ();
370 Item *stem = dynamic_cast<Item *> (info.grob ());
371 Stream_event *ev = info.ultimate_event_cause ();
372 if (!ev->in_event_class ("rhythmic-event"))
374 programming_error ("stem must have rhythmic structure");
379 Don't (start) auto-beam over empty stems; skips or rests
381 if (!Stem::head_count (stem))
388 if (Stem::get_beam (stem))
395 int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
405 ignore interspersed grace notes.
407 Moment now = now_mom ();
408 if (!is_same_grace_state (beam_start_location_, now))
411 Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
412 Moment dur = stem_duration->get_length ();
414 //Moment dur = unsmob<Duration> (ev->get_property ("duration"))->get_length ();
415 Moment measure_now = measure_position (context ());
416 bool recheck_needed = false;
418 if (dur < shortest_mom_)
420 /* new shortest moment, so store it and set recheck_needed */
422 recheck_needed = true;
425 /* end should be based on shortest_mom_, begin should be
426 based on current duration */
427 consider_end (measure_now, shortest_mom_);
428 consider_begin (measure_now, dur);
433 grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
435 Stem::is_invisible (stem),
436 stem_duration->factor (),
437 (to_boolean (stem->get_property ("tuplet-start"))));
438 stems_->push_back (stem);
440 extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now);
446 Auto_beam_engraver::recheck_beam ()
449 Recheck the beam after the shortest duration has changed
450 If shorter duration has created a new break, typeset the
451 first part of the beam and reset the current beam to just
452 the last part of the beam
454 Beaming_pattern *new_grouping_ = 0;
455 vector<Item *> *new_stems_ = 0;
456 Moment temporary_shortest_mom;
457 SCM temporary_beam_settings;
461 for (vsize i = 0; i < stems_->size () - 1;)
463 found_end = test_moment (STOP,
464 grouping_->end_moment (i),
471 Save the current beam settings and shortest_mom_
472 Necessary because end_beam destroys them
474 temporary_shortest_mom = shortest_mom_;
475 temporary_beam_settings = beam_settings_;
477 /* Eliminate (and save) the items no longer part of the first beam */
479 new_grouping_ = grouping_->split_pattern (i);
480 new_stems_ = remove_end_stems (i);
485 /* now recreate the unbeamed data structures */
487 grouping_ = new_grouping_;
488 shortest_mom_ = temporary_shortest_mom;
489 beam_settings_ = temporary_beam_settings;
499 Remove all stems with an index greater than split_index
500 from stems_, and return a vector containing all of the
504 Auto_beam_engraver::remove_end_stems (vsize split_index)
506 vector <Item *> *removed_stems = 0;
507 removed_stems = new vector <Item *>;
509 for (vsize j = split_index + 1; j < stems_->size (); j++)
510 removed_stems->push_back ((*stems_).at (j));
511 for (vsize j = split_index + 1; j < stems_->size ();)
513 return removed_stems;
517 Auto_beam_engraver::process_acknowledged ()
519 Moment now = now_mom ();
520 if (extend_mom_ > now)
523 if (!process_acknowledged_count_)
525 Moment measure_now = measure_position (context ());
526 consider_end (measure_now, shortest_mom_);
528 else if (process_acknowledged_count_ > 1)
532 if ((extend_mom_ < now)
533 || ((extend_mom_ == now) && (last_add_mom_ != now)))
535 else if (!stems_->size ())
540 process_acknowledged_count_++;
544 Auto_beam_engraver::boot ()
546 ADD_LISTENER (Auto_beam_engraver, beam_forbid);
547 ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
548 ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
549 ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
550 ADD_ACKNOWLEDGER (Auto_beam_engraver, breathing_sign);
551 ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
554 ADD_TRANSLATOR (Auto_beam_engraver,
556 "Generate beams based on measure characteristics and observed"
557 " Stems. Uses @code{baseMoment}, @code{beatStructure},"
558 " @code{beamExceptions}, @code{measureLength}, and"
559 " @code{measurePosition} to decide when to start and stop a"
560 " beam. Overriding beaming is done through"
561 " @ref{Stem_engraver} properties @code{stemLeftBeamCount} and"
562 " @code{stemRightBeamCount}.",
579 class Grace_auto_beam_engraver : public Auto_beam_engraver
581 TRANSLATOR_DECLARATIONS (Grace_auto_beam_engraver);
582 TRANSLATOR_INHERIT (Auto_beam_engraver);
585 Moment last_grace_start_; // Full starting time of last grace group
586 Moment last_grace_position_; // Measure position of same
587 virtual void process_music ();
588 virtual bool is_same_grace_state (Moment, Moment);
589 virtual bool test_moment (Direction, Moment, Moment);
592 Grace_auto_beam_engraver::Grace_auto_beam_engraver ()
594 last_grace_start_.main_part_.set_infinite (-1);
595 // grace_part_ is zero -> test_moment is false, last_grace_position_
600 Grace_auto_beam_engraver::is_same_grace_state (Moment, Moment)
602 // This is for ignoring interspersed grace notes in main note
603 // beaming. We never want to ignore something inside of grace note
604 // beaming, so return true.
609 Grace_auto_beam_engraver::process_music ()
611 Moment now = now_mom ();
612 // Update last_grace_start_ and last_grace_position_ only when the
613 // main time advances.
614 if (now.main_part_ > last_grace_start_.main_part_)
616 last_grace_start_ = now;
617 last_grace_position_ = measure_position (context ());
620 Auto_beam_engraver::process_music ();
624 Grace_auto_beam_engraver::test_moment (Direction dir, Moment test_mom, Moment)
626 // If no grace group started this main moment, we have no business
627 // beaming. Same if we have left the original main time step.
628 if (!last_grace_start_.grace_part_
629 || last_grace_position_.main_part_ != test_mom.main_part_)
631 // Autobeam start only when at the start of the grace group.
633 return last_grace_position_ == test_mom;
634 // Autobeam end only when the grace part is finished.
635 return !test_mom.grace_part_;
639 Grace_auto_beam_engraver::boot ()
641 ADD_LISTENER (Grace_auto_beam_engraver, beam_forbid);
642 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, stem);
643 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, bar_line);
644 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, beam);
645 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, breathing_sign);
646 ADD_ACKNOWLEDGER (Grace_auto_beam_engraver, rest);
649 ADD_TRANSLATOR (Grace_auto_beam_engraver,
651 "Generates one autobeam group across an entire grace phrase. "
652 " As usual, any manual beaming or @code{\\noBeam} will block"
653 " autobeaming, just like setting the context property"
654 " @samp{autoBeaming} to @code{##f}.",