X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=13dd0466b622e3c37c63d0d7d3cb0787f886c18f;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=0f8bf698bd35b61575d4508c7c1c996a099eafe3;hpb=8e300d9598c6f54cb18d8bc8cd0458fa1028d8b9;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index 0f8bf698bd..f86edaecc8 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -1,199 +1,168 @@ -/* - 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--2001 Jan Nieuwenhuizen - - */ -#include "beaming.hh" -#include "musical-request.hh" + (c) 1999--2008 Jan Nieuwenhuizen +*/ + +#include "bar-line.hh" +#include "beaming-pattern.hh" #include "beam.hh" -#include "stem.hh" -#include "debug.hh" -#include "engraver-group-engraver.hh" -#include "bar.hh" -#include "rest.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 "warn.hh" -/* - TODO: figure what to do in grace? +#include "translator.icc" - TODO: documentme. - */ class Auto_beam_engraver : public Engraver { -public: - Auto_beam_engraver (); - VIRTUAL_COPY_CONS (Translator); + TRANSLATOR_DECLARATIONS (Auto_beam_engraver); protected: - virtual void stop_translation_timestep (); - virtual void start_translation_timestep (); + void stop_translation_timestep (); + void process_music (); virtual void finalize (); - virtual void acknowledge_grob (Grob_info); - virtual void create_grobs (); + 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_p (); + Spanner *create_beam (); void begin_beam (); void end_beam (); void junk_beam (); - bool same_grace_state_b (Grob* e); + 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_p_; - Link_array* stem_l_arr_p_; + Spanner *finished_beam_; + vector *stems_; - - int count_i_; + 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_; - + // We act as if beam were created, and start a grouping anyway. - Beaming_info_list*grouping_p_; - Beaming_info_list*finished_grouping_p_; -}; + Beaming_pattern *grouping_; + SCM beam_settings_; -ADD_THIS_TRANSLATOR (Auto_beam_engraver); + Beaming_pattern *finished_grouping_; -Auto_beam_engraver::Auto_beam_engraver () -{ - count_i_ = 0; - stem_l_arr_p_ = 0; - shortest_mom_ = Moment (Rational (1, 8)); - finished_beam_p_ = 0; - finished_grouping_p_ = 0; - grouping_p_ = 0; -} -/* - Determine end moment for auto beaming (or begin moment, but mostly - 0==anywhere) In order of increasing priority: - - i. begin anywhere, end at every beat - ii. end * - iii. end - - iv. end * * * - v. end * * - - - Rationale: - - [to be defined in config file] - i. easy catch-all rule - ii. exceptions for time signature - iii. exceptions for time signature, for specific duration type + Beaming_options beaming_options_; + Beaming_options finished_beaming_options_; - [user override] - iv. generic override - v. override for specific duration type -*/ -bool -Auto_beam_engraver::test_moment (Direction dir, Moment test_mom) + void check_bar_property (); +}; + +void +Auto_beam_engraver::derived_mark () const { - SCM wild = gh_list (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED); - SCM function; - if (dir == START) - function = gh_list (ly_symbol2scm ("begin"), SCM_UNDEFINED); - else - function = gh_list (ly_symbol2scm ("end"), SCM_UNDEFINED); + scm_gc_mark (beam_settings_); +} - Moment one_beat = *unsmob_moment (get_property ("beatLength")); - int num = int ((*unsmob_moment (get_property ("measureLength")) / one_beat).main_part_); - int den = one_beat.den (); - SCM time = gh_list (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED); +void +Auto_beam_engraver::check_bar_property () +{ + /* Duplicated from process_music (), since + Repeat_acknowledge_engraver::process_music () may also set whichBar. */ - SCM type = gh_list (gh_int2scm (test_mom.num ()), - gh_int2scm (test_mom.den ()), SCM_UNDEFINED); + Moment now = now_mom (); + if (scm_is_string (get_property ("whichBar")) + && beam_start_moment_ < now) + { + consider_end (shortest_mom_); + junk_beam (); + } +} - SCM settings = get_property ("autoBeamSettings"); - - /* first guess */ - - /* begin beam at any position - (and fallback for end) */ - Moment moment (0); - - /* end beam at end of beat */ - if (dir == STOP) +void +Auto_beam_engraver::process_music () +{ + /* + don't beam over skips + */ + if (stems_) { - SCM beat (get_property ("beatLength")); - - if (unsmob_moment (beat)) - moment = *unsmob_moment (beat); + Moment now = now_mom (); + if (extend_mom_ < now) + end_beam (); } - /* second guess: property generic time exception */ - SCM m = gh_assoc (gh_append3 (function, wild, time), settings); - - if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m))) - moment = * unsmob_moment (gh_cdr (m)); - - /* third guess: property time exception, specific for duration type */ - m = gh_assoc (gh_append3 (function, type, time), settings); - if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m))) - moment = * unsmob_moment (gh_cdr (m)); - - /* fourth guess [user override]: property plain generic */ - m = gh_assoc (gh_append3 (function, wild, wild), settings); - if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m))) - moment = * unsmob_moment (gh_cdr (m)); - - /* fifth guess [user override]: property plain, specific for duration type */ - m = gh_assoc (gh_append3 (function, type, wild), settings); - if (m != SCM_BOOL_F && unsmob_moment (gh_cdr (m))) - moment = * unsmob_moment (gh_cdr (m)); - - Rational r; - if (moment.to_bool ()) + if (scm_is_string (get_property ("whichBar"))) { - /* Ugh? measurePosition can be negative, when \partial - We may have to fix this elsewhere (timing translator) - r = unsmob_moment (get_property ("measurePosition"))->mod_rat (moment); - */ - Moment pos = * unsmob_moment (get_property ("measurePosition")); - if (pos < Moment (0)) - { - Moment length = * unsmob_moment (get_property ("measureLength")); - pos = length - pos; - } - r = pos.main_part_.mod_rat (moment.main_part_); + consider_end (shortest_mom_); + junk_beam (); } - else + + if (forbid_) { - if (dir == START) - /* if undefined, starting is ok */ - r = 0; - else - /* but ending is not */ - r = 1; + consider_end (shortest_mom_); + junk_beam (); } - return !r; +} + +Auto_beam_engraver::Auto_beam_engraver () +{ + 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::listen_beam_forbid (Stream_event *ev) +{ + ASSIGN_EVENT_ONCE (forbid_, ev); +} + +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 off = to_boolean (get_property ("noAutoBeaming")); - if (!stem_l_arr_p_ && ! off) + bool on = to_boolean (get_property ("autoBeaming")); + if (!stems_ && on + && !forbid_) { bool b = test_moment (START, test_mom); if (b) @@ -204,66 +173,70 @@ Auto_beam_engraver::consider_begin (Moment test_mom) void Auto_beam_engraver::consider_end (Moment test_mom) { - if (stem_l_arr_p_) + if (stems_) { /* Allow already started autobeam to end: - don't check for noAutoBeaming */ + don't check for autoBeaming */ bool b = test_moment (STOP, test_mom); if (b) end_beam (); } } -Spanner* -Auto_beam_engraver::create_beam_p () +Spanner * +Auto_beam_engraver::create_beam () { if (to_boolean (get_property ("skipTypesetting"))) - { - return 0; - } - - Spanner* beam_p = new Spanner (get_property ("Beam")); - for (int i = 0; i < stem_l_arr_p_->size (); i++) - { - /* - watch out for stem tremolos and abbreviation beams - */ - if (Stem::beam_l ((*stem_l_arr_p_)[i])) - { - scm_gc_unprotect_object (beam_p->self_scm ()); - return 0; - } - Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]); - } - - announce_grob (beam_p, 0); + return 0; + + for (vsize i = 0; i < stems_->size (); i++) + if (Stem::get_beam ((*stems_)[i])) + return 0; + + /* + Can't use make_spanner_from_properties () because we have to use + beam_settings_. + */ + Spanner *beam = new Spanner (beam_settings_); - return beam_p; + for (vsize i = 0; i < stems_->size (); i++) + Beam::add_stem (beam, (*stems_)[i]); + + announce_grob (beam, (*stems_)[0]->self_scm ()); + + return beam; } void Auto_beam_engraver::begin_beam () { - assert (!stem_l_arr_p_); - stem_l_arr_p_ = new Link_array; - assert (!grouping_p_); - grouping_p_ = new Beaming_info_list; - beam_start_moment_ = now_mom (); - beam_start_location_ = *unsmob_moment (get_property ("measurePosition")); + if (stems_ || grouping_) + { + programming_error ("already have autobeam"); + return; + } + stems_ = new vector; + grouping_ = new Beaming_pattern (); + beaming_options_.from_context (context ()); + 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 () +Auto_beam_engraver::junk_beam () { - assert (stem_l_arr_p_); - - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - delete grouping_p_; - grouping_p_ = 0; + if (!stems_) + return; + + delete stems_; + stems_ = 0; + delete grouping_; + grouping_ = 0; + beam_settings_ = SCM_EOL; shortest_mom_ = Moment (Rational (1, 8)); } @@ -271,19 +244,22 @@ Auto_beam_engraver::junk_beam () void Auto_beam_engraver::end_beam () { - if (stem_l_arr_p_->size () < 2) - { - junk_beam (); - } + if (stems_->size () < 2) + junk_beam (); else - { - finished_beam_p_ = create_beam_p (); - if (finished_beam_p_) - finished_grouping_p_ = grouping_p_; - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - grouping_p_ = 0; + finished_beam_ = create_beam (); + + if (finished_beam_) + { + announce_end_grob (finished_beam_, SCM_EOL); + finished_grouping_ = grouping_; + finished_beaming_options_ = beaming_options_; + } + delete stems_; + stems_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; } shortest_mom_ = Moment (Rational (1, 8)); @@ -292,40 +268,26 @@ Auto_beam_engraver::end_beam () void Auto_beam_engraver::typeset_beam () { - if (finished_beam_p_) + if (finished_beam_) { - finished_grouping_p_->beamify (); - Beam::set_beaming (finished_beam_p_, finished_grouping_p_); - typeset_grob (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 (finished_beaming_options_); + Beam::set_beaming (finished_beam_, finished_grouping_); + finished_beam_ = 0; -void -Auto_beam_engraver::start_translation_timestep () -{ - count_i_ = 0; - /* - don't beam over skips - */ - if (stem_l_arr_p_) - { - Moment now = now_mom (); - if (extend_mom_ < now) - { - end_beam (); - } + delete finished_grouping_; + finished_grouping_ = 0; } } void Auto_beam_engraver::stop_translation_timestep () { - typeset_beam (); + process_acknowledged_count_ = 0; + forbid_ = 0; } void @@ -334,143 +296,151 @@ Auto_beam_engraver::finalize () /* finished beams may be typeset */ typeset_beam (); /* but unfinished may need another announce/acknowledge pass */ - if (stem_l_arr_p_) + if (stems_) junk_beam (); } void -Auto_beam_engraver::acknowledge_grob (Grob_info info) +Auto_beam_engraver::acknowledge_beam (Grob_info info) +{ + (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) { - if (stem_l_arr_p_) + (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 (info.grob ()); + Stream_event *ev = info.ultimate_event_cause (); + if (!ev->in_event_class ("rhythmic-event")) { - if (Beam::has_interface (info.elem_l_)) - { - end_beam (); - } - else if (Bar::has_interface (info.elem_l_)) - { - end_beam (); - } - else if (Rest::has_interface (info.elem_l_)) - { - end_beam (); - } + programming_error ("stem must have rhythmic structure"); + return; } - - if (Stem::has_interface (info.elem_l_)) + + /* + Don't (start) auto-beam over empty stems; skips or rests + */ + if (!Stem::head_count (stem)) { - Item* stem_l = dynamic_cast (info.elem_l_); - - Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); - if (!rhythmic_req) - { - programming_error ("Stem must have rhythmic structure"); - return; - } - - /* - Don't (start) auto-beam over empty stems; skips or rests - */ - if (!Stem::heads_i (stem_l)) - { - if (stem_l_arr_p_) - end_beam (); - return; - } + if (stems_) + end_beam (); + return; + } - if (Stem::beam_l (stem_l)) - { - if (stem_l_arr_p_) - junk_beam (); - return ; - } - - int durlog = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log (); - - if (durlog <= 2) - { - if (stem_l_arr_p_) - end_beam (); - return; - } + if (Stem::get_beam (stem)) + { + if (stems_) + junk_beam (); + return; + } + int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log (); - /* - ignore grace notes. - */ - if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_)) - return ; - - - Moment dur = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->length_mom (); - /* FIXME: + if (durlog <= 2) + { + if (stems_) + end_beam (); + return; + } - This comment has been here since long: + /* + ignore grace notes. + */ + Moment now = now_mom (); + if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_)) + return; - if shortest duration would change - consider ending and beginning beam first. + Moment dur = unsmob_duration (ev->get_property ("duration"))->get_length (); - but the code didn't match: */ -#if 1 - consider_end (dur); - consider_begin (dur); + consider_end (dur); + consider_begin (dur); - if (dur < shortest_mom_) - shortest_mom_ = dur; -#else - /* I very much suspect that we wanted: */ + if (dur < shortest_mom_) + shortest_mom_ = dur; - consider_end (shortest_mom_); - if (dur < shortest_mom_) - { - shortest_mom_ = dur; - consider_end (shortest_mom_); - } - consider_begin (shortest_mom_); -#endif + if (!stems_) + return; - if (!stem_l_arr_p_) - return; - - Moment now = now_mom (); - - grouping_p_->add_stem (now - beam_start_moment_ + beam_start_location_, - durlog - 2); - stem_l_arr_p_->push (stem_l); - last_add_mom_ = now; - extend_mom_ = (extend_mom_ >? now) + rhythmic_req->length_mom (); - } + grouping_->add_stem (now - beam_start_moment_ + beam_start_location_, + durlog - 2, + Stem::is_invisible (stem)); + stems_->push_back (stem); + last_add_mom_ = now; + extend_mom_ = max (extend_mom_, now) + get_event_length (ev, now); } void -Auto_beam_engraver::create_grobs () +Auto_beam_engraver::process_acknowledged () { - if (!count_i_) + if (extend_mom_ > now_mom ()) + return; + + if (!process_acknowledged_count_) { consider_end (shortest_mom_); consider_begin (shortest_mom_); } - else if (count_i_ > 1) + else if (process_acknowledged_count_ > 1) { - if (stem_l_arr_p_) + if (stems_) { Moment now = now_mom (); if ((extend_mom_ < now) || ((extend_mom_ == now) && (last_add_mom_ != now))) - { - end_beam (); - } - else if (!stem_l_arr_p_->size ()) - { - junk_beam (); - } - } + end_beam (); + else if (!stems_->size ()) + junk_beam (); + } } - /* - count_i_++ -> - - auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */ - count_i_ = count_i_ + 1; + 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 @code{beatLength}, @code{measureLength}, and" + " @code{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 ", + + /* read */ + "autoBeaming " + "autoBeamSettings " + "beatLength " + "subdivideBeams ", + + /* write */ + "" + );