X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=55d8ab3e66f5320fc13ed5d528b8ceeb4d85fdd4;hb=3c64b04040ae18b98bed7b9b95f156aae1cf4420;hp=9536e17aceeaf50aa0d0eb2fc9a9914471925751;hpb=3a46c107cba4b3d2dba74e21f9046cc399c8baf1;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index 9536e17ace..55d8ab3e66 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -3,291 +3,499 @@ source file of the GNU LilyPond music typesetter - (c) 1999 Jan Nieuwenhuizen + (c) 1999--2002 Jan Nieuwenhuizen */ -#include "auto-beam-engraver.hh" +#include "beaming.hh" #include "musical-request.hh" -#include "bar.hh" #include "beam.hh" -#include "rhythmic-grouping.hh" -#include "rest.hh" #include "stem.hh" -#include "debug.hh" -#include "time-description.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" + +/* + TODO: figure what to do in grace? + + TODO: documentme. + */ +class Auto_beam_engraver : public Engraver +{ + TRANSLATOR_DECLARATIONS(Auto_beam_engraver); +protected: + virtual void stop_translation_timestep (); + virtual void start_translation_timestep (); + virtual void finalize (); + virtual void acknowledge_grob (Grob_info); + virtual void process_acknowledged_grobs (); + +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 same_grace_state_b (Grob* e); + void typeset_beam (); + + /* + shortest_mom is the shortest note in the beam. + */ + Moment shortest_mom_; + Spanner *finished_beam_; + Link_array* stems_; + + + int 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_; + SCM beam_settings_ ; // ugh. should protect ? + + Beaming_info_list*finished_grouping_; +}; + -ADD_THIS_TRANSLATOR (Auto_beam_engraver); Auto_beam_engraver::Auto_beam_engraver () { - beam_p_ = 0; - finished_beam_p_ = 0; - finished_grouping_p_ = 0; - grouping_p_ = 0; + count_ = 0; + stems_ = 0; + shortest_mom_ = Moment (Rational (1, 8)); + finished_beam_ = 0; + finished_grouping_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; +} + +/* + 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) +{ + Moment now = now_mom(); + if (dir == START + && now.grace_part_) + { + return false; + } + + 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); + + 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); + + 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) + { + SCM beat (get_property ("beatLength")); + + if (unsmob_moment (beat)) + moment = *unsmob_moment (beat); + } + + /* 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 ()) + { + /* 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_); + } + else + { + if (dir == START) + /* if undefined, starting is ok */ + r = 0; + else + /* but ending is not */ + r = 1; + } + + return !r; } void -Auto_beam_engraver::do_process_requests () +Auto_beam_engraver::consider_begin (Moment test_mom) { - consider_end_and_begin (); + bool on = to_boolean (get_property ("autoBeaming")); + if (!stems_ && on) + { + bool b = test_moment (START, test_mom); + if (b) + begin_beam (); + } } void -Auto_beam_engraver::consider_end_and_begin () +Auto_beam_engraver::consider_end (Moment test_mom) { - Time_description const *time = get_staff_info().time_C_; + if (stems_) + { + /* Allow already started autobeam to end: + don't check for autoBeaming */ + bool b = test_moment (STOP, test_mom); + if (b) + end_beam (); + } +} - Scalar begin = get_property ("beamAutoBegin", 0); - Moment begin_mom = begin.to_rat (); +Spanner* +Auto_beam_engraver::create_beam () +{ + if (to_boolean (get_property ("skipTypesetting"))) + { + return 0; + } - Scalar end = get_property ("beamAutoEnd", 0); - Moment end_mom = end.to_rat (); - - if (mult_i_) + Spanner* beam = new Spanner (beam_settings_); + for (int i = 0; i < stems_->size (); i++) { - 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); + /* + watch out for stem tremolos and abbreviation beams + */ + if (Stem::get_beam ((*stems_)[i])) + { + scm_gc_unprotect_object (beam->self_scm ()); + return 0; + } + Beam::add_stem (beam, (*stems_)[i]); } + + announce_grob(beam, SCM_EOL); - Real f; - if (end_mom) - f = fmod (time->whole_in_measure_, end_mom); - else - f = Moment (1); - - // 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; - - if (begin_mom) - f = fmod (time->whole_in_measure_, begin_mom); - if (!beam_p_ && (!begin_mom || (abs (f) < epsilon_f))) - begin_beam (); + 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)); + assert (!stems_); + stems_ = new Link_array; + assert (!grouping_); + grouping_ = new Beaming_info_list; + beam_settings_ = get_property ("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")); +} + + +void +Auto_beam_engraver::junk_beam () +{ + assert (stems_); + + 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) + if (stems_->size () < 2) { - DOUT << "junking autombeam: less than two stems\n"; 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; + finished_grouping_->beamify(beat_length_, subdivide_beams_); + Beam::set_beaming (finished_beam_, finished_grouping_); + typeset_grob (finished_beam_); + finished_beam_ = 0; - delete finished_grouping_p_; - finished_grouping_p_= 0; + delete finished_grouping_; + finished_grouping_= 0; } } void -Auto_beam_engraver::do_post_move_processing () +Auto_beam_engraver::start_translation_timestep () { + count_ = 0; + /* + don't beam over skips + */ + if (stems_) + { + Moment now = now_mom (); + if (extend_mom_ < now) + { + end_beam (); + } + } } 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_grob (Grob_info info) { - if (Beam *b = dynamic_cast (info.elem_l_)) + if (stems_) { - if (beam_p_) + if (Beam::has_interface (info.grob_)) { - DOUT << "junking autobeam: beam encountered\n"; - junk_beam (); + end_beam (); } - } - if (Bar *b = dynamic_cast (info.elem_l_)) - { - if (beam_p_) + else if (Bar_line::has_interface (info.grob_)) { - DOUT << "junking autobeam: bar encountered\n"; - junk_beam (); + end_beam (); + } + else if (Rest::has_interface (info.grob_)) + { + end_beam (); } } - - if (beam_p_) + + if (Stem::has_interface (info.grob_)) { - Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); + Item* stem = dynamic_cast (info.grob_); + + Rhythmic_req *rhythmic_req = dynamic_cast (info.music_cause ()); if (!rhythmic_req) - return; - - if (dynamic_cast (info.elem_l_)) { - DOUT << "junking autobeam: rest encountered\n"; - end_beam (); + programming_error ("Stem must have rhythmic structure"); return; } - - Stem* stem_l = dynamic_cast (info.elem_l_); - if (!stem_l) - return; - - if (stem_l->beam_l_ && (stem_l->beam_l_ != beam_p_)) + + /* + Don't (start) auto-beam over empty stems; skips or rests + */ + if (!Stem::head_count (stem)) { - DOUT << "junking autobeam: beamed stem encountered\n"; - junk_beam (); + if (stems_) + end_beam (); 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) + if (Stem::get_beam (stem)) { - DOUT << "ending autobeam: stem doesn't fit in beam\n"; - end_beam (); - return; + if (stems_) + junk_beam (); + return ; } - - Moment start = get_staff_info().time_C_->whole_in_measure_; - if (!grouping_p_->child_fit_b (start)) + + int durlog = unsmob_duration (rhythmic_req->get_mus_property ("duration"))->duration_log (); + + if (durlog <= 2) { - DOUT << "ending autobeam: stem doesn't fit in group\n"; - end_beam (); + if (stems_) + end_beam (); + return; } - else + + + /* + 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: */ + + consider_end (shortest_mom_); + if (dur < shortest_mom_) { - 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 (); + shortest_mom_ = dur; + consider_end (shortest_mom_); } + consider_begin (shortest_mom_); +#endif + + if (!stems_) + return; + + Moment now = now_mom (); + + grouping_->add_stem (now - beam_start_moment_ + beam_start_location_, + durlog - 2); + stems_->push (stem); + last_add_mom_ = now; + extend_mom_ = (extend_mom_ >? now) + rhythmic_req->length_mom (); } } void -Auto_beam_engraver::junk_beam () +Auto_beam_engraver::process_acknowledged_grobs () { - assert (beam_p_); - for (int i=0; i < beam_p_->stems_.size (); i++) + if (!count_) { - 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; + consider_end (shortest_mom_); + consider_begin (shortest_mom_); } - - beam_p_->unlink (); - beam_p_ = 0; - delete grouping_p_; - grouping_p_ = 0; - mult_i_ = 0; -} - -void -Auto_beam_engraver::process_acknowledged () -{ - if (beam_p_) + else if (count_ > 1) { - 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 ()) + 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 (); + } + } } + + /* + count_++ -> + + auto-beam-engraver.cc:459: warning: value computed is not used (gcc: 2.96) */ + count_ = count_ + 1; } +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 */ "");