X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fauto-beam-engraver.cc;h=42e3935d8de364475545a473d8ad6fff3931cadb;hb=01378c85f23e4bdbc07cd1f3b06ddfd573377bb9;hp=f80d36ec651f5de949ea5fffa7347a2f05b52119;hpb=434da79e9d7684b2b05fa92a6d808d4ea7933046;p=lilypond.git diff --git a/lily/auto-beam-engraver.cc b/lily/auto-beam-engraver.cc index f80d36ec65..42e3935d8d 100644 --- a/lily/auto-beam-engraver.cc +++ b/lily/auto-beam-engraver.cc @@ -3,356 +3,510 @@ source file of the GNU LilyPond music typesetter - (c) 1999 Jan Nieuwenhuizen + (c) 1999--2003 Jan Nieuwenhuizen */ -#include "new-beaming.hh" -#include "auto-beam-engraver.hh" -#include "musical-request.hh" -#include "bar.hh" + +#include "beaming.hh" +#include "event.hh" #include "beam.hh" -#include "rest.hh" #include "stem.hh" -#include "debug.hh" -#include "timing-engraver.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 "duration.hh" -ADD_THIS_TRANSLATOR (Auto_beam_engraver); +/* + TODO: figure what to do in grace? -Auto_beam_engraver::Auto_beam_engraver () + TODO: documentme. + */ +class Auto_beam_engraver : public Engraver { - stem_l_arr_p_ = 0; - shortest_mom_ = Moment (1, 8); - finished_beam_p_ = 0; - finished_grouping_p_ = 0; - grouping_p_ = 0; - timer_l_ =0; -} + TRANSLATOR_DECLARATIONS(Auto_beam_engraver); +protected: + virtual void stop_translation_timestep (); + virtual void start_translation_timestep (); + virtual void process_music (); + 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_; +}; void -Auto_beam_engraver::do_creation_processing () +Auto_beam_engraver::process_music () { - Translator * t = daddy_grav_l ()->get_simple_translator ("Timing_engraver"); - timer_l_ = dynamic_cast (t); + if (gh_string_p (get_property ("whichBar"))) + { + consider_end (shortest_mom_); + junk_beam (); + } } -void -Auto_beam_engraver::do_process_requests () + +Auto_beam_engraver::Auto_beam_engraver () { - consider_end_and_begin (); + count_ = 0; + stems_ = 0; + shortest_mom_ = Moment (Rational (1, 8)); + finished_beam_ = 0; + finished_grouping_ = 0; + grouping_ = 0; + beam_settings_ = SCM_EOL; } -void -Auto_beam_engraver::consider_end_and_begin () +/* + 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) { - if (!timer_l_) - return; + Moment now = now_mom(); + if (dir == START + && now.grace_part_) + { + return false; + } - Time_description const *time = &timer_l_->time_; - int num = time->whole_per_measure_ / time->one_beat_; - int den = time->one_beat_.den_i (); - String time_str = String ("time") + to_str (num) + "_" + to_str (den); - String type_str; - if (shortest_mom_.num () != 1) - type_str = to_str (shortest_mom_.num ()); - if (shortest_mom_.den () != 1) - type_str = type_str + "_" + to_str (shortest_mom_.den ()); - - /* - Determine end moment for auto beaming (and begin, mostly 0==anywhere) - In order of increasing priority: - - i. every beat - ii. time_beamAutoEnd - iii. time_beamAutoEnd - iv. beamAutoEnd - v. beamAutoEnd - + 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); - Rationale: + 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 (scm_int2num (num), scm_int2num (den), SCM_UNDEFINED); - [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 + SCM type = scm_list_n (scm_int2num (test_mom.num ()), + scm_int2num (test_mom.den ()), SCM_UNDEFINED); - [user override] - iv. generic override - v. override for specific duration type + 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); + } - The user overrides should be required for common cases. - */ + /* second guess: property generic time exception */ + SCM m = scm_assoc (gh_append3 (function, wild, time), settings); - /* - first guess: begin beam at any position - */ - Moment begin_mom (0); - /* - first guess: end beam at end of beat - */ - Moment end_mom = time->one_beat_; + 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 = scm_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 = scm_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 = scm_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; + } - /* - second guess: property generic time exception - */ - Scalar begin = get_property (time_str + "beamAutoBegin", 0); - if (begin.length_i ()) - begin_mom = begin.to_rat (); + return !r; +} - Scalar end = get_property (time_str + "beamAutoEnd", 0); - if (end.length_i ()) - end_mom = end.to_rat (); +void +Auto_beam_engraver::consider_begin (Moment test_mom) +{ + bool on = to_boolean (get_property ("autoBeaming")); + if (!stems_ && on) + { + bool b = test_moment (START, test_mom); + if (b) + begin_beam (); + } +} - /* - third guess: property time exception, specific for duration type - */ - if (type_str.length_i ()) +void +Auto_beam_engraver::consider_end (Moment test_mom) +{ + if (stems_) { - Scalar end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0); - if (end_mult.length_i ()) - end_mom = end_mult.to_rat (); - Scalar begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0); - if (begin_mult.length_i ()) - begin_mom = begin_mult.to_rat (); + /* Allow already started autobeam to end: + don't check for autoBeaming */ + bool b = test_moment (STOP, test_mom); + if (b) + end_beam (); } +} - /* - fourth guess [user override]: property plain generic - */ - begin = get_property ("beamAutoBegin", 0); - if (begin.length_i ()) - begin_mom = begin.to_rat (); +Spanner* +Auto_beam_engraver::create_beam () +{ + if (to_boolean (get_property ("skipTypesetting"))) + { + return 0; + } - end = get_property ("beamAutoEnd", 0); - if (end.length_i ()) - end_mom = end.to_rat (); - - /* - fifth guess [user override]: property plain, specific for duration type - */ - if (type_str.length_i ()) + Spanner* beam = new Spanner (beam_settings_); + for (int i = 0; i < stems_->size (); i++) { - Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0); - if (end_mult.length_i ()) - end_mom = end_mult.to_rat (); - Scalar begin_mult = get_property (String ("beamAutoBegin") + type_str, 0); - if (begin_mult.length_i ()) - begin_mom = begin_mult.to_rat (); + /* + 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); - Rational r; - if (end_mom) - r = time->whole_in_measure_.mod_rat (end_mom); - else - r = Moment (1); - - if (stem_l_arr_p_ && !r) - end_beam (); - - /* - Allow already started autobeam to end - */ - Scalar on = get_property ("beamAuto", 0); - if (!on.to_bool ()) - return; - - if (begin_mom) - r = time->whole_in_measure_.mod_rat (begin_mom); - if (!stem_l_arr_p_ && (!begin_mom || !r)) - begin_beam (); + return beam; } - void Auto_beam_engraver::begin_beam () { - assert (!stem_l_arr_p_); - stem_l_arr_p_ = new 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_ = get_property ("Beam"); + beam_start_moment_ = now_mom (); - beam_start_location_ = timer_l_->time_.whole_in_measure_; + beam_start_location_ = *unsmob_moment (get_property ("measurePosition")); + subdivide_beams_ = gh_scm2bool(get_property("subdivideBeams")); + beat_length_ = *unsmob_moment (get_property ("beatLength")); } -Beam* -Auto_beam_engraver::create_beam_p () +void +Auto_beam_engraver::junk_beam () { - Beam* beam_p = new Beam; - - for (int i = 0; i < stem_l_arr_p_->size (); i++) - beam_p->add_stem ((*stem_l_arr_p_)[i]); - - /* urg, copied from Beam_engraver */ - Scalar prop = get_property ("beamslopedamping", 0); - if (prop.isnum_b ()) - beam_p->set_elt_property (damping_scm_sym, gh_int2scm( prop)); - - prop = get_property ("beamquantisation", 0); - if (prop.isnum_b ()) - beam_p->quantisation_ = (Beam::Quantisation)(int)prop; - - announce_element (Score_element_info (beam_p, 0)); - return beam_p; + 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 () { - if (stem_l_arr_p_->size () < 2) + if (stems_->size () < 2) { junk_beam (); } else { - finished_beam_p_ = create_beam_p (); - finished_grouping_p_ = grouping_p_; - delete stem_l_arr_p_; - stem_l_arr_p_ = 0; - grouping_p_ = 0; - shortest_mom_ = Moment (1, 8); + 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_) { - finished_grouping_p_->beamify (); - finished_beam_p_->set_beaming (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 () { - if (stem_l_arr_p_) - end_beam (); + /* finished beams may be typeset */ typeset_beam (); + /* but unfinished may need another announce/acknowledge pass */ + if (stems_) + junk_beam (); } -bool -Auto_beam_engraver::same_grace_state_b (Score_element* e) -{ - bool gr = (e->get_elt_property (grace_scm_sym) != SCM_BOOL_F) ; - - return gr == get_property ("weAreGraceContext",0).to_bool (); -} void -Auto_beam_engraver::acknowledge_element (Score_element_info info) +Auto_beam_engraver::acknowledge_grob (Grob_info info) { - if (!same_grace_state_b (info.elem_l_) || !timer_l_) - return; - - if (stem_l_arr_p_) + if (stems_) { - if (Beam *b = dynamic_cast (info.elem_l_)) + if (Beam::has_interface (info.grob_)) { - junk_beam (); + end_beam (); } - else if (Bar *b = dynamic_cast (info.elem_l_)) + else if (Bar_line::has_interface (info.grob_)) { - junk_beam (); + end_beam (); } - else if (Rest* rest_l = dynamic_cast (info.elem_l_)) + else if (Rest::has_interface (info.grob_)) { end_beam (); } - else if (Stem* stem_l = dynamic_cast (info.elem_l_)) + } + + if (Stem::has_interface (info.grob_)) + { + Item* stem = dynamic_cast (info.grob_); + Music* m = info.music_cause (); + if (!m->is_mus_type ("rhythmic-event")) { - Rhythmic_req *rhythmic_req = dynamic_cast (info.req_l_); - if (!rhythmic_req) - { - programming_error ("Stem must have rhythmic structure"); - return; - } - - if (stem_l->beam_l_) - { - junk_beam (); - return ; - } - - /* - now that we have last_add_mom_, perhaps we can (should) do away - with these individual junk_beams - */ + programming_error ("Stem must have rhythmic structure"); + return; + } + + /* + Don't (start) auto-beam over empty stems; skips or rests + */ + if (!Stem::head_count (stem)) + { + if (stems_) + end_beam (); + return; + } - int durlog =rhythmic_req->duration_.durlog_i_; - if (durlog <= 2) + if (Stem::get_beam (stem)) + { + if (stems_) + junk_beam (); + return ; + } + + int durlog = unsmob_duration (m->get_mus_property ("duration"))->duration_log (); + + if (durlog <= 2) + { + if (stems_) end_beam (); - else - { - /* - if shortest duration would change - reconsider ending/starting beam first. - */ - Moment mom = rhythmic_req->duration_.length_mom (); - if (mom < shortest_mom_) - { - if (stem_l_arr_p_->size ()) - { - shortest_mom_ = mom; - consider_end_and_begin (); - if (!stem_l_arr_p_) - return; - } - shortest_mom_ = mom; - } - 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 (); - } + return; } - } -} -void -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; - shortest_mom_ = Moment (1, 8); + + /* + ignore grace notes. + */ + if (bool (beam_start_location_.grace_part_) != bool (now_mom ().grace_part_)) + return ; + + + Moment dur = unsmob_duration (m->get_mus_property ("duration"))->get_length (); + /* 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_) + { + 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) + m->get_length (); + } } void -Auto_beam_engraver::process_acknowledged () +Auto_beam_engraver::process_acknowledged_grobs () { - if (stem_l_arr_p_) + if (!count_) { - Moment now = now_mom (); - if ((extend_mom_ < now) - || ((extend_mom_ == now) && (last_add_mom_ != now ))) - { - end_beam (); - } - else if (!stem_l_arr_p_->size ()) + consider_end (shortest_mom_); + consider_begin (shortest_mom_); + } + else if (count_ > 1) + { + if (stems_) { - 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_ ++; } + +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", +/* accepts */ "", +/* acks */ "stem-interface rest-interface beam-interface bar-line-interface", +/* reads */ "autoBeaming autoBeamSettings beatLength subdivideBeams", +/* write */ "");