-/*
- auto-beam-engraver.cc -- implement Auto_beam_engraver
-
+/*
+ auto-beam-engraver.cc -- implement Auto_beam_engraver
+
source file of the GNU LilyPond music typesetter
-
- (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
-
- */
-
-#include "auto-beam-engraver.hh"
-#include "musical-request.hh"
-#include "bar.hh"
+
+ (c) 1999--2006 Jan Nieuwenhuizen <janneke@gnu.org>
+*/
+
+#include "bar-line.hh"
+#include "beaming-pattern.hh"
#include "beam.hh"
-#include "rhythmic-grouping.hh"
+#include "context.hh"
+#include "duration.hh"
+#include "engraver.hh"
+#include "item.hh"
#include "rest.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
#include "stem.hh"
-#include "debug.hh"
-#include "time-description.hh"
+#include "warn.hh"
-ADD_THIS_TRANSLATOR (Auto_beam_engraver);
+#include "translator.icc"
-Auto_beam_engraver::Auto_beam_engraver ()
+class Auto_beam_engraver : public Engraver
{
- beam_p_ = 0;
- finished_beam_p_ = 0;
- finished_grouping_p_ = 0;
- grouping_p_ = 0;
+ TRANSLATOR_DECLARATIONS (Auto_beam_engraver);
+
+protected:
+ void stop_translation_timestep ();
+ void start_translation_timestep ();
+ void process_music ();
+ virtual void finalize ();
+ virtual void derived_mark () const;
+
+ DECLARE_ACKNOWLEDGER (rest);
+ DECLARE_ACKNOWLEDGER (beam);
+ DECLARE_ACKNOWLEDGER (bar_line);
+ DECLARE_ACKNOWLEDGER (stem);
+ DECLARE_TRANSLATOR_LISTENER (beam_forbid);
+
+ void process_acknowledged ();
+
+private:
+ bool test_moment (Direction, Moment);
+ void consider_begin (Moment);
+ void consider_end (Moment);
+ Spanner *create_beam ();
+ void begin_beam ();
+ void end_beam ();
+ void junk_beam ();
+ bool is_same_grace_state (Grob *e);
+ void typeset_beam ();
+
+ Stream_event *forbid_;
+ /*
+ shortest_mom is the shortest note in the beam.
+ */
+ Moment shortest_mom_;
+ Spanner *finished_beam_;
+ vector<Item*> *stems_;
+
+ int process_acknowledged_count_;
+ Moment last_add_mom_;
+ /*
+ Projected ending of the beam we're working on.
+ */
+ Moment extend_mom_;
+ Moment beam_start_moment_;
+ Moment beam_start_location_;
+
+ bool subdivide_beams_;
+ Moment beat_length_;
+
+ // We act as if beam were created, and start a grouping anyway.
+ Beaming_pattern *grouping_;
+ SCM beam_settings_;
+
+ Beaming_pattern *finished_grouping_;
+
+ void check_bar_property ();
+};
+
+void
+Auto_beam_engraver::derived_mark () const
+{
+ scm_gc_mark (beam_settings_);
+}
+
+void
+Auto_beam_engraver::check_bar_property ()
+{
+ /* Duplicated from process_music (), since
+ Repeat_acknowledge_engraver::process_music () may also set whichBar. */
+
+ Moment now = now_mom ();
+ if (scm_is_string (get_property ("whichBar"))
+ && beam_start_moment_ < now)
+ {
+ consider_end (shortest_mom_);
+ junk_beam ();
+ }
}
void
-Auto_beam_engraver::do_process_requests ()
+Auto_beam_engraver::process_music ()
+{
+ if (scm_is_string (get_property ("whichBar")))
+ {
+ consider_end (shortest_mom_);
+ junk_beam ();
+ }
+
+ if (forbid_)
+ {
+ consider_end (shortest_mom_);
+ junk_beam ();
+ }
+}
+
+Auto_beam_engraver::Auto_beam_engraver ()
{
- consider_end_and_begin ();
+ forbid_ = 0;
+ process_acknowledged_count_ = 0;
+ stems_ = 0;
+ shortest_mom_ = Moment (Rational (1, 8));
+ finished_beam_ = 0;
+ finished_grouping_ = 0;
+ grouping_ = 0;
+ beam_settings_ = SCM_EOL;
}
+IMPLEMENT_TRANSLATOR_LISTENER (Auto_beam_engraver, beam_forbid);
void
-Auto_beam_engraver::consider_end_and_begin ()
+Auto_beam_engraver::listen_beam_forbid (Stream_event *ev)
{
- Time_description const *time = get_staff_info().time_C_;
+ ASSIGN_EVENT_ONCE (forbid_, ev);
+}
- Scalar begin = get_property ("beamAutoBegin", 0);
- Moment begin_mom = begin.to_rat ();
-
- Scalar end = get_property ("beamAutoEnd", 0);
- Moment end_mom = end.to_rat ();
+bool
+Auto_beam_engraver::test_moment (Direction dir, Moment test)
+{
+ return scm_call_3 (get_property ("autoBeamCheck"),
+ context ()->self_scm (),
+ scm_from_int (dir),
+ test.smobbed_copy ())
+ != SCM_BOOL_F;
+}
+
+void
+Auto_beam_engraver::consider_begin (Moment test_mom)
+{
+ bool on = to_boolean (get_property ("autoBeaming"));
+ if (!stems_ && on
+ && !forbid_)
+ {
+ bool b = test_moment (START, test_mom);
+ if (b)
+ begin_beam ();
+ }
+}
- if (mult_i_)
+void
+Auto_beam_engraver::consider_end (Moment test_mom)
+{
+ if (stems_)
{
- int type = 1 << (mult_i_ + 2);
- Scalar end_mult = get_property (String ("beamAutoEnd")
- + to_str (type), 0);
- if (end_mult.length_i ())
- end_mom = end_mult.to_rat ();
- else if (Moment (type, 4) / end_mom > Moment (4))
- end_mom /= Moment (type, 8);
+ /* Allow already started autobeam to end:
+ don't check for autoBeaming */
+ bool b = test_moment (STOP, test_mom);
+ if (b)
+ end_beam ();
}
+}
- Real f;
- if (end_mom)
- f = fmod (time->whole_in_measure_, end_mom);
- else
- f = Moment (1);
+Spanner *
+Auto_beam_engraver::create_beam ()
+{
+ if (to_boolean (get_property ("skipTypesetting")))
+ return 0;
+
+ for (vsize i = 0; i < stems_->size (); i++)
+ if (Stem::get_beam ((*stems_)[i]))
+ return 0;
- // enge floots
- Real epsilon_f = Moment (1, 512);
- if (beam_p_ && (abs (f) < epsilon_f))
- end_beam ();
-
/*
- Allow already started autobeam to end
- */
- Scalar on = get_property ("beamAuto", 0);
- if (!on.to_bool ())
- return;
+ Can't use make_spanner_from_properties() because we have to use
+ beam_settings_.
+ */
+ Spanner *beam = new Spanner (beam_settings_,
+ context ()->get_grob_key ("Beam"));
+
+ for (vsize i = 0; i < stems_->size (); i++)
+ Beam::add_stem (beam, (*stems_)[i]);
- if (begin_mom)
- f = fmod (time->whole_in_measure_, begin_mom);
- if (!beam_p_ && (!begin_mom || (abs (f) < epsilon_f)))
- begin_beam ();
+ announce_grob (beam, (*stems_)[0]->self_scm ());
+
+ return beam;
}
-
void
Auto_beam_engraver::begin_beam ()
{
- DOUT << String ("starting autobeam at: ") + now_mom ().str () + "\n";
- beam_p_ = new Beam;
- grouping_p_ = new Rhythmic_grouping;
-
- /* urg, copied from Beam_engraver */
- Scalar prop = get_property ("beamslopedamping", 0);
- if (prop.isnum_b ())
- beam_p_->damping_i_ = prop;
-
- prop = get_property ("beamquantisation", 0);
- if (prop.isnum_b ())
- beam_p_->quantisation_ = (Beam::Quantisation)(int)prop;
-
- // must set minVerticalAlign = = maxVerticalAlign to get sane results
- // see input/test/beam-interstaff.ly
- prop = get_property ("minVerticalAlign", 0);
- if (prop.isnum_b ())
- beam_p_->vertical_align_drul_[MIN] = prop;
-
- prop = get_property ("maxVerticalAlign", 0);
- if (prop.isnum_b ())
- beam_p_->vertical_align_drul_[MAX] = prop;
-
- announce_element (Score_element_info (beam_p_, 0));
+ if (stems_ || grouping_)
+ {
+ programming_error ("already have autobeam");
+ return;
+ }
+
+ stems_ = new vector<Item*>;
+ grouping_ = new Beaming_pattern ();
+ beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam"));
+
+ beam_start_moment_ = now_mom ();
+ beam_start_location_
+ = robust_scm2moment (get_property ("measurePosition"), Moment (0));
+}
+
+void
+Auto_beam_engraver::junk_beam ()
+{
+ if (!stems_)
+ return;
+
+ delete stems_;
+ stems_ = 0;
+ delete grouping_;
+ grouping_ = 0;
+ beam_settings_ = SCM_EOL;
+
+ shortest_mom_ = Moment (Rational (1, 8));
}
void
Auto_beam_engraver::end_beam ()
{
- DOUT << String ("ending autobeam at: ") + now_mom ().str () + "\n";
- if (beam_p_->stems_.size () < 2)
- {
- DOUT << "junking autombeam: less than two stems\n";
- junk_beam ();
- }
+ if (stems_->size () < 2)
+ junk_beam ();
else
{
- finished_beam_p_ = beam_p_;
- finished_grouping_p_ = grouping_p_;
- beam_p_ = 0;
- grouping_p_ = 0;
- mult_i_ = 0;
+ finished_beam_ = create_beam ();
+ if (finished_beam_)
+ finished_grouping_ = grouping_;
+ delete stems_;
+ stems_ = 0;
+ grouping_ = 0;
+ beam_settings_ = SCM_EOL;
}
+
+ shortest_mom_ = Moment (Rational (1, 8));
}
-
+
void
Auto_beam_engraver::typeset_beam ()
{
- if (finished_beam_p_)
+ if (finished_beam_)
{
- Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
- rg_C->extend (finished_grouping_p_->interval());
- finished_beam_p_->set_grouping (*rg_C, *finished_grouping_p_);
- typeset_element (finished_beam_p_);
- finished_beam_p_ = 0;
-
- delete finished_grouping_p_;
- finished_grouping_p_= 0;
+ if (!finished_beam_->get_bound (RIGHT))
+ finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
+
+ finished_grouping_->beamify (context ());
+ Beam::set_beaming (finished_beam_, finished_grouping_);
+ finished_beam_ = 0;
+
+ delete finished_grouping_;
+ finished_grouping_ = 0;
}
}
void
-Auto_beam_engraver::do_post_move_processing ()
+Auto_beam_engraver::start_translation_timestep ()
{
+ process_acknowledged_count_ = 0;
+ /*
+ don't beam over skips
+ */
+ if (stems_)
+ {
+ Moment now = now_mom ();
+ if (extend_mom_ < now)
+ end_beam ();
+ }
+ forbid_ = 0;
}
void
-Auto_beam_engraver::do_pre_move_processing ()
+Auto_beam_engraver::stop_translation_timestep ()
{
typeset_beam ();
}
void
-Auto_beam_engraver::do_removal_processing ()
+Auto_beam_engraver::finalize ()
{
+ /* finished beams may be typeset */
typeset_beam ();
- if (beam_p_)
- {
- DOUT << "Unfinished beam\n";
- junk_beam ();
- }
+ /* but unfinished may need another announce/acknowledge pass */
+ if (stems_)
+ junk_beam ();
}
+
void
-Auto_beam_engraver::acknowledge_element (Score_element_info info)
+Auto_beam_engraver::acknowledge_beam (Grob_info info)
{
- if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
+ (void)info;
+ check_bar_property ();
+ if (stems_)
+ end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_bar_line (Grob_info info)
+{
+ (void)info;
+ check_bar_property ();
+ if (stems_)
+ end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_rest (Grob_info info)
+{
+ (void)info;
+ check_bar_property ();
+ if (stems_)
+ end_beam ();
+}
+
+void
+Auto_beam_engraver::acknowledge_stem (Grob_info info)
+{
+ check_bar_property ();
+ Item *stem = dynamic_cast<Item *> (info.grob ());
+ Stream_event *ev = info.ultimate_event_cause ();
+ if (!ev->in_event_class ("rhythmic-event"))
{
- if (beam_p_)
- {
- DOUT << "junking autobeam: beam encountered\n";
- junk_beam ();
- }
+ programming_error ("stem must have rhythmic structure");
+ return;
}
- if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
+
+ /*
+ Don't (start) auto-beam over empty stems; skips or rests
+ */
+ if (!Stem::head_count (stem))
{
- if (beam_p_)
- {
- DOUT << "junking autobeam: bar encountered\n";
- junk_beam ();
- }
+ if (stems_)
+ end_beam ();
+ return;
}
- if (beam_p_)
+ if (Stem::get_beam (stem))
{
- Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
- if (!rhythmic_req)
- return;
+ if (stems_)
+ junk_beam ();
+ return;
+ }
- if (dynamic_cast<Rest *> (info.elem_l_))
- {
- DOUT << "junking autobeam: rest encountered\n";
- end_beam ();
- return;
- }
+ int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
- Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_);
- if (!stem_l)
- return;
+ if (durlog <= 2)
+ {
+ if (stems_)
+ end_beam ();
+ return;
+ }
- if (stem_l->beam_l_ && (stem_l->beam_l_ != beam_p_))
- {
- DOUT << "junking autobeam: beamed stem encountered\n";
- junk_beam ();
- return;
- }
-
+ /*
+ ignore grace notes.
+ */
+ Moment now = now_mom ();
+ if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_))
+ return;
- /*
- now that we have last_add_mom_, perhaps we can (should) do away
- with these individual junk_beams
- */
- if (rhythmic_req->duration_.durlog_i_<= 2)
- {
- DOUT << "ending autobeam: stem doesn't fit in beam\n";
- end_beam ();
- return;
- }
+ Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length ();
- Moment start = get_staff_info().time_C_->whole_in_measure_;
- if (!grouping_p_->child_fit_b (start))
- {
- DOUT << "ending autobeam: stem doesn't fit in group\n";
- end_beam ();
- }
- else
- {
- int m = (rhythmic_req->duration_.durlog_i_ - 2);
- /*
- if multiplicity would become greater,
- reconsider ending/starting beam first.
- */
- if (m > mult_i_)
- {
- mult_i_ = m;
- consider_end_and_begin ();
- }
- mult_i_ = m;
- grouping_p_->add_child (start, rhythmic_req->length_mom ());
- stem_l->flag_i_ = rhythmic_req->duration_.durlog_i_;
- beam_p_->add_stem (stem_l);
- Moment now = now_mom ();
- last_add_mom_ = now;
- extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
- }
- }
-}
+ consider_end (dur);
+ consider_begin (dur);
-void
-Auto_beam_engraver::junk_beam ()
-{
- assert (beam_p_);
- for (int i=0; i < beam_p_->stems_.size (); i++)
- {
- Stem* s = beam_p_->stems_[i];
- s->beams_i_drul_[LEFT] = 0;
- s->beams_i_drul_[RIGHT] = 0;
- s->mult_i_ = 0;
- s->beam_l_ = 0;
- }
-
- beam_p_->unlink ();
- beam_p_ = 0;
- delete grouping_p_;
- grouping_p_ = 0;
- mult_i_ = 0;
+ if (dur < shortest_mom_)
+ shortest_mom_ = dur;
+
+ if (!stems_)
+ return;
+
+ grouping_->add_stem (now - beam_start_moment_ + beam_start_location_,
+ durlog - 2);
+ stems_->push_back (stem);
+ last_add_mom_ = now;
+ extend_mom_ = max (extend_mom_, now) + get_event_length (ev);
}
void
Auto_beam_engraver::process_acknowledged ()
{
- if (beam_p_)
+ if (extend_mom_ > now_mom ())
+ return;
+
+ if (!process_acknowledged_count_)
{
- Moment now = now_mom ();
- if ((extend_mom_ < now)
- || ((extend_mom_ == now) && (last_add_mom_ != now )))
- {
- DOUT << String ("junking autobeam: no stem added since: ")
- + last_add_mom_.str () + "\n";
- end_beam ();
- }
- else if (!beam_p_->stems_.size ())
+ consider_end (shortest_mom_);
+ consider_begin (shortest_mom_);
+ }
+ else if (process_acknowledged_count_ > 1)
+ {
+ if (stems_)
{
- DOUT << "junking started autobeam: no stems\n";
- junk_beam ();
+ Moment now = now_mom ();
+ if ((extend_mom_ < now)
+ || ((extend_mom_ == now) && (last_add_mom_ != now)))
+ end_beam ();
+ else if (!stems_->size ())
+ junk_beam ();
}
}
+
+ process_acknowledged_count_++;
}
+
+ADD_ACKNOWLEDGER (Auto_beam_engraver, stem);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, bar_line);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, beam);
+ADD_ACKNOWLEDGER (Auto_beam_engraver, rest);
+ADD_TRANSLATOR (Auto_beam_engraver,
+ /* doc */ "Generate beams based on measure characteristics and observed "
+ "Stems. Uses beatLength, measureLength and measurePosition to decide "
+ "when to start and stop a beam. Overriding beaming is done through "
+ "@ref{Stem_engraver} properties @code{stemLeftBeamCount} and "
+ "@code{stemRightBeamCount}. ",
+ /* create */ "Beam",
+ /* accept */ "beam-forbid-event",
+ /* read */ "autoBeaming autoBeamSettings beatLength subdivideBeams",
+ /* write */ "");
projects / lilypond.git / blobdiff