X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=81231018524668ec1ba6a3e71fa2976e95d87933;hb=f2c2c5c43858f323e4708f83fd97e0f38017c275;hp=15e931c7cb6a69550bde20959dff22d3f22d2889;hpb=675533acf58b9b863adc830f175696735ca6dc95;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index 15e931c7cb..8123101852 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -1,199 +1,156 @@ -/* - 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--2002 Jan Nieuwenhuizen - - */ + (c) 1999--2005 Jan Nieuwenhuizen +*/ + +#include "engraver.hh" #include "beaming.hh" -#include "musical-request.hh" #include "beam.hh" #include "stem.hh" #include "warn.hh" -#include "engraver-group-engraver.hh" #include "bar-line.hh" #include "rest.hh" -#include "engraver.hh" #include "item.hh" #include "spanner.hh" +#include "context.hh" +#include "duration.hh" + +#include "translator.icc" -/* - TODO: figure what to do in grace? - TODO: documentme. - */ class Auto_beam_engraver : public Engraver { - TRANSLATOR_DECLARATIONS(Auto_beam_engraver); + TRANSLATOR_DECLARATIONS (Auto_beam_engraver); + protected: - virtual void stop_translation_timestep (); - virtual void start_translation_timestep (); + PRECOMPUTED_VIRTUAL void stop_translation_timestep (); + PRECOMPUTED_VIRTUAL void start_translation_timestep (); + PRECOMPUTED_VIRTUAL void process_music (); + virtual bool try_music (Music *); virtual void finalize (); - virtual void acknowledge_grob (Grob_info); - virtual void process_acknowledged_grobs (); + + DECLARE_ACKNOWLEDGER(rest); + DECLARE_ACKNOWLEDGER(beam); + DECLARE_ACKNOWLEDGER(bar_line); + DECLARE_ACKNOWLEDGER(stem); + + PRECOMPUTED_VIRTUAL 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 (); + Music *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_; + Link_array *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_; bool subdivide_beams_; Moment beat_length_; - + // We act as if beam were created, and start a grouping anyway. - Beaming_info_list*grouping_p_; - Beaming_info_list*finished_grouping_p_; -}; + Beaming_info_list *grouping_; + SCM beam_settings_; // ugh. should protect ? + Beaming_info_list *finished_grouping_; + void check_bar_property (); +}; -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 - - [user override] - iv. generic override - v. override for specific duration type - -*/ -bool -Auto_beam_engraver::test_moment (Direction dir, Moment test_mom) +void +Auto_beam_engraver::check_bar_property () { - SCM wild = scm_list_n (ly_symbol2scm ("*"), ly_symbol2scm ("*"), SCM_UNDEFINED); - SCM function; - if (dir == START) - function = scm_list_n (ly_symbol2scm ("begin"), SCM_UNDEFINED); - else - function = scm_list_n (ly_symbol2scm ("end"), SCM_UNDEFINED); + /* Duplicated from process_music (), since + Repeat_acknowledge_engraver::process_music () may also set whichBar. */ - 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 = scm_list_n (gh_int2scm (num), gh_int2scm (den), SCM_UNDEFINED); - - SCM type = scm_list_n (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 () +{ + if (scm_is_string (get_property ("whichBar"))) { - SCM beat (get_property ("beatLength")); - - if (unsmob_moment (beat)) - moment = *unsmob_moment (beat); + consider_end (shortest_mom_); + junk_beam (); } - /* second guess: property generic time exception */ - SCM m = gh_assoc (gh_append3 (function, wild, time), settings); - - if (m != SCM_BOOL_F && unsmob_moment (ly_cdr (m))) - moment = * unsmob_moment (ly_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 (ly_cdr (m))) - moment = * unsmob_moment (ly_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 (ly_cdr (m))) - moment = * unsmob_moment (ly_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 (ly_cdr (m))) - moment = * unsmob_moment (ly_cdr (m)); - - Rational r; - if (moment.to_bool ()) + if (forbid_) { - /* 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 +} + +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; +} + +bool +Auto_beam_engraver::try_music (Music *m) +{ + if (m->is_mus_type ("beam-forbid-event")) { - if (dir == START) - /* if undefined, starting is ok */ - r = 0; - else - /* but ending is not */ - r = 1; + forbid_ = m; + return true; } - return !r; + + return false; } +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 (!stem_l_arr_p_ && on) + if (!stems_ && on + && !forbid_) { bool b = test_moment (START, test_mom); if (b) @@ -204,7 +161,7 @@ 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 autoBeaming */ @@ -214,56 +171,62 @@ Auto_beam_engraver::consider_end (Moment test_mom) } } -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++) + return 0; + + Spanner *beam = new Spanner (beam_settings_, context ()->get_grob_key ("Beam")); + for (int i = 0; i < stems_->size (); i++) { /* watch out for stem tremolos and abbreviation beams - */ - if (Stem::beam_l ((*stem_l_arr_p_)[i])) + */ + if (Stem::get_beam ((*stems_)[i])) { - scm_gc_unprotect_object (beam_p->self_scm ()); + scm_gc_unprotect_object (beam->self_scm ()); return 0; } - Beam::add_stem (beam_p, (*stem_l_arr_p_)[i]); + Beam::add_stem (beam, (*stems_)[i]); } - - announce_grob(beam_p, SCM_EOL); - return beam_p; + 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; + if (stems_ || grouping_) + { + programming_error ("already have autobeam"); + return; + } + + stems_ = new Link_array; + grouping_ = new Beaming_info_list; + beam_settings_ = updated_grob_properties (context (), ly_symbol2scm ("Beam")); + beam_start_moment_ = now_mom (); - beam_start_location_ = *unsmob_moment (get_property ("measurePosition")); - subdivide_beams_ = gh_scm2bool(get_property("subdivideBeams")); - beat_length_ = *unsmob_moment (get_property ("beatLength")); + beam_start_location_ + = robust_scm2moment (get_property ("measurePosition"), Moment (0)); + subdivide_beams_ = ly_scm2bool (get_property ("subdivideBeams")); + beat_length_ = robust_scm2moment (get_property ("beatLength"), Moment (1, 4)); } - 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 +234,19 @@ Auto_beam_engraver::junk_beam () void Auto_beam_engraver::end_beam () { - if (stem_l_arr_p_->size () < 2) + 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_) + finished_grouping_ = grouping_; + delete stems_; + stems_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; } shortest_mom_ = Moment (Rational (1, 8)); @@ -292,26 +255,25 @@ Auto_beam_engraver::end_beam () void Auto_beam_engraver::typeset_beam () { - if (finished_beam_p_) + if (finished_beam_) { - finished_grouping_p_->beamify(beat_length_, subdivide_beams_); - 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; + finished_grouping_->beamify (beat_length_, subdivide_beams_); + Beam::set_beaming (finished_beam_, finished_grouping_); + finished_beam_ = 0; + + delete finished_grouping_; + finished_grouping_ = 0; } } void Auto_beam_engraver::start_translation_timestep () { - count_i_ = 0; + process_acknowledged_count_ = 0; /* don't beam over skips - */ - if (stem_l_arr_p_) + */ + if (stems_) { Moment now = now_mom (); if (extend_mom_ < now) @@ -319,6 +281,7 @@ Auto_beam_engraver::start_translation_timestep () end_beam (); } } + forbid_ = 0; } void @@ -333,126 +296,116 @@ 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) { - if (stem_l_arr_p_) + check_bar_property (); + if (stems_) { - if (Beam::has_interface (info.grob_l_)) - { - end_beam (); - } - else if (Bar_line::has_interface (info.grob_l_)) - { - end_beam (); - } - else if (Rest::has_interface (info.grob_l_)) - { - end_beam (); - } + end_beam (); } - - if (Stem::has_interface (info.grob_l_)) - { - Item* stem_l = dynamic_cast (info.grob_l_); - - Rhythmic_req *rhythmic_req = dynamic_cast (info.music_cause ()); - if (!rhythmic_req) - { - programming_error ("Stem must have rhythmic structure"); - return; - } - - /* - Don't (start) auto-beam over empty stems; skips or rests - */ - if (!Stem::head_count (stem_l)) - { - if (stem_l_arr_p_) - end_beam (); - return; - } +} + +void +Auto_beam_engraver::acknowledge_bar_line (Grob_info info) +{ + check_bar_property (); + if (stems_) + end_beam (); +} - 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; - } +void +Auto_beam_engraver::acknowledge_rest (Grob_info 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 ()); + Music *m = info.music_cause (); + if (!m->is_mus_type ("rhythmic-event")) + { + programming_error ("stem must have rhythmic structure"); + return; + } - /* - 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: - - This comment has been here since long: - - if shortest duration would change - consider ending and beginning beam first. - - but the code didn't match: */ -#if 1 - consider_end (dur); - consider_begin (dur); - - if (dur < shortest_mom_) - shortest_mom_ = dur; -#else - /* I very much suspect that we wanted: */ + /* + Don't (start) auto-beam over empty stems; skips or rests + */ + if (!Stem::head_count (stem)) + { + if (stems_) + end_beam (); + return; + } - consider_end (shortest_mom_); - if (dur < shortest_mom_) - { - shortest_mom_ = dur; - consider_end (shortest_mom_); - } - consider_begin (shortest_mom_); -#endif + if (Stem::get_beam (stem)) + { + if (stems_) + junk_beam (); + 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 (); + int durlog = unsmob_duration (m->get_property ("duration"))->duration_log (); + + if (durlog <= 2) + { + if (stems_) + end_beam (); + return; } + + /* + ignore grace notes. + */ + Moment now = now_mom (); + if (bool (beam_start_location_.grace_part_) != bool (now.grace_part_)) + return; + + Moment dur = unsmob_duration (m->get_property ("duration"))->get_length (); + + consider_end (dur); + consider_begin (dur); + + if (dur < shortest_mom_) + shortest_mom_ = dur; + + if (!stems_) + return; + + grouping_->add_stem (now - beam_start_moment_ + beam_start_location_, + durlog - 2); + stems_->push (stem); + last_add_mom_ = now; + extend_mom_ = max (extend_mom_, now) + m->get_length (); } void -Auto_beam_engraver::process_acknowledged_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) @@ -460,27 +413,27 @@ Auto_beam_engraver::process_acknowledged_grobs () { end_beam (); } - else if (!stem_l_arr_p_->size ()) + 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_++; } -ENTER_DESCRIPTION(Auto_beam_engraver, -/* descr */ "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 stemLeftBeamCount and -stemRightBeamCount. -", -/* creats*/ "Beam", -/* acks */ "stem-interface rest-interface beam-interface bar-line-interface", -/* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams", -/* write */ ""); + +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, + /* descr */ "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}. ", + /* creats*/ "Beam", + /* accepts */ "beam-forbid-event", + /* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams", + /* write */ "");