lily/auto-beam-engraver.cc

   1 /*
   2   auto-beam-engraver.cc --  implement Auto_beam_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1999 Jan Nieuwenhuizen <janneke@gnu.org>
   7
   8  */
   9
  10 #include "auto-beam-engraver.hh"
  11 #include "musical-request.hh"
  12 #include "bar.hh"
  13 #include "beam.hh"
  14 #include "rhythmic-grouping.hh"
  15 #include "rest.hh"
  16 #include "stem.hh"
  17 #include "debug.hh"
  18 #include "time-description.hh"
  19
  20 ADD_THIS_TRANSLATOR (Auto_beam_engraver);
  21
  22 Auto_beam_engraver::Auto_beam_engraver ()
  23 {
  24   beam_p_ = 0;
  25   shortest_mom_ = 1;
  26   finished_beam_p_ = 0;
  27   finished_grouping_p_ = 0;
  28   grouping_p_ = 0;
  29 }
  30
  31 void
  32 Auto_beam_engraver::do_process_requests ()
  33 {
  34   consider_end_and_begin ();
  35 }
  36
  37 void
  38 Auto_beam_engraver::consider_end_and_begin ()
  39 {
  40   Time_description const *time = get_staff_info().time_C_;
  41   int num = time->whole_per_measure_ / time->one_beat_;
  42   int den = time->one_beat_.den_i ();
  43   String time_str = String ("time") + to_str (num) + "_" + to_str (den);
  44   String type_str;
  45   if (shortest_mom_.num () != 1)
  46     type_str = to_str (shortest_mom_.num ());
  47   if (shortest_mom_.den () != 1)
  48     type_str = type_str + "_" + to_str (shortest_mom_.den ());
  49
  50   /*
  51     Determine end moment for auto beaming (and begin, mostly 0==anywhere)
  52     In order of increasing priority:
  53
  54     i.   every beat <den>
  55     ii.  time<num>_<den>beamAutoEnd
  56     iii. time<num>_<den>beamAutoEnd<type>
  57     iv.  beamAutoEnd
  58     v.   beamAutoEnd<type>
  59
  60
  61     Rationale:
  62
  63     [to be defined in config file]
  64     i.   easy catch-all rule
  65     ii.  exceptions for time signature
  66     iii. exceptions for time signature, for specific duration type
  67
  68     [user override]
  69     iv.  generic override
  70     v.   override for specific duration type
  71
  72     The user overrides should be required for common cases.
  73    */
  74
  75   /*
  76     first guess: begin beam at any position
  77   */
  78   Moment begin_mom (0);
  79   /*
  80     first guess: end beam at end of beat
  81   */
  82   Moment end_mom = time->one_beat_;
  83
  84   /*
  85     second guess: property generic time exception
  86   */
  87   Scalar begin = get_property (time_str + "beamAutoBegin", 0);
  88   if (begin.length_i ())
  89     begin_mom = begin.to_rat ();
  90
  91   Scalar end = get_property (time_str + "beamAutoEnd", 0);
  92   if (end.length_i ())
  93     end_mom = end.to_rat ();
  94
  95   /*
  96     third guess: property time exception, specific for duration type
  97   */
  98   if (type_str.length_i ())
  99     {
 100       Scalar end_mult = get_property (time_str + "beamAutoEnd" + type_str, 0);
 101       if (end_mult.length_i ())
 102         end_mom = end_mult.to_rat ();
 103       Scalar begin_mult = get_property (time_str + "beamAutoBegin" + type_str, 0);
 104       if (begin_mult.length_i ())
 105         begin_mom = begin_mult.to_rat ();
 106     }
 107
 108   /*
 109     fourth guess [user override]: property plain generic
 110   */
 111   begin = get_property ("beamAutoBegin", 0);
 112   if (begin.length_i ())
 113     begin_mom = begin.to_rat ();
 114
 115   end = get_property ("beamAutoEnd", 0);
 116   if (end.length_i ())
 117     end_mom = end.to_rat ();
 118
 119   /*
 120     fifth guess [user override]: property plain, specific for duration type
 121   */
 122   if (type_str.length_i ())
 123     {
 124       Scalar end_mult = get_property (String ("beamAutoEnd") + type_str, 0);
 125       if (end_mult.length_i ())
 126         end_mom = end_mult.to_rat ();
 127       Scalar begin_mult = get_property (String ("beamAutoBegin") + type_str, 0);
 128       if (begin_mult.length_i ())
 129         begin_mom = begin_mult.to_rat ();
 130     }
 131
 132   Rational r;
 133   if (end_mom)
 134     r = time->whole_in_measure_.mod_rat (end_mom);
 135   else
 136     r = Moment (1);
 137
 138   if (beam_p_ && !r)
 139     end_beam ();
 140
 141   /*
 142     Allow already started autobeam to end
 143    */
 144   Scalar on = get_property ("beamAuto", 0);
 145   if (!on.to_bool ())
 146     return;
 147
 148   if (begin_mom)
 149     r = time->whole_in_measure_.mod_rat (begin_mom);
 150   if (!beam_p_ && (!begin_mom || !r))
 151     begin_beam ();
 152 }
 153
 154
 155 void
 156 Auto_beam_engraver::begin_beam ()
 157 {
 158   DOUT << String ("starting autobeam at: ") + now_mom ().str () + "\n";
 159   assert (!beam_p_);
 160   beam_p_ = new Beam;
 161   grouping_p_ = new Rhythmic_grouping;
 162
 163       /* urg, copied from Beam_engraver */
 164   Scalar prop = get_property ("beamslopedamping", 0);
 165   if (prop.isnum_b ())
 166     beam_p_->damping_i_ = prop;
 167
 168   prop = get_property ("beamquantisation", 0);
 169   if (prop.isnum_b ())
 170     beam_p_->quantisation_ = (Beam::Quantisation)(int)prop;
 171
 172       // must set minVerticalAlign = = maxVerticalAlign to get sane results
 173       // see input/test/beam-interstaff.ly
 174   prop = get_property ("minVerticalAlign", 0);
 175   if (prop.isnum_b ())
 176     beam_p_->vertical_align_drul_[MIN] = prop;
 177
 178   prop = get_property ("maxVerticalAlign", 0);
 179   if (prop.isnum_b ())
 180     beam_p_->vertical_align_drul_[MAX] = prop;
 181
 182   announce_element (Score_element_info (beam_p_, 0));
 183 }
 184
 185 void
 186 Auto_beam_engraver::end_beam ()
 187 {
 188   DOUT << String ("ending autobeam at: ") + now_mom ().str () + "\n";
 189   if (beam_p_->stems_.size () < 2)
 190     {
 191       DOUT << "junking autombeam: less than two stems\n";
 192       junk_beam ();
 193     }
 194   else
 195     {
 196       finished_beam_p_ = beam_p_;
 197       finished_grouping_p_ = grouping_p_;
 198       beam_p_ = 0;
 199       grouping_p_ = 0;
 200       shortest_mom_ = 1;
 201     }
 202 }
 203
 204 void
 205 Auto_beam_engraver::typeset_beam ()
 206 {
 207   if (finished_beam_p_)
 208     {
 209       Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
 210       rg_C->extend (finished_grouping_p_->interval());
 211       finished_beam_p_->set_grouping (*rg_C, *finished_grouping_p_);
 212       typeset_element (finished_beam_p_);
 213       finished_beam_p_ = 0;
 214
 215       delete finished_grouping_p_;
 216       finished_grouping_p_= 0;
 217     }
 218 }
 219
 220 void
 221 Auto_beam_engraver::do_post_move_processing ()
 222 {
 223 }
 224
 225 void
 226 Auto_beam_engraver::do_pre_move_processing ()
 227 {
 228   typeset_beam ();
 229 }
 230
 231 void
 232 Auto_beam_engraver::do_removal_processing ()
 233 {
 234   typeset_beam ();
 235   if (beam_p_)
 236     {
 237       DOUT << "Unfinished beam\n";
 238       junk_beam ();
 239     }
 240 }
 241
 242 void
 243 Auto_beam_engraver::acknowledge_element (Score_element_info info)
 244 {
 245   if (Beam *b = dynamic_cast<Beam *> (info.elem_l_))
 246     {
 247       if (beam_p_)
 248         {
 249           DOUT << "junking autobeam: beam encountered\n";
 250           junk_beam ();
 251         }
 252     }
 253   if (Bar *b = dynamic_cast<Bar *> (info.elem_l_))
 254     {
 255       if (beam_p_)
 256         {
 257           DOUT << "junking autobeam: bar encountered\n";
 258           junk_beam ();
 259         }
 260     }
 261
 262   if (beam_p_)
 263     {
 264       Rhythmic_req *rhythmic_req = dynamic_cast <Rhythmic_req *> (info.req_l_);
 265       if (!rhythmic_req)
 266         return;
 267
 268       if (dynamic_cast<Rest *> (info.elem_l_))
 269         {
 270           DOUT << "junking autobeam: rest encountered\n";
 271           end_beam ();
 272           return;
 273         }
 274
 275       Stem* stem_l = dynamic_cast<Stem *> (info.elem_l_);
 276       if (!stem_l)
 277         return;
 278
 279       if (stem_l->beam_l_ && (stem_l->beam_l_ != beam_p_))
 280         {
 281           DOUT << "junking autobeam: beamed stem encountered\n";
 282           junk_beam ();
 283           return;
 284         }
 285
 286
 287       /*
 288         now that we have last_add_mom_, perhaps we can (should) do away
 289         with these individual junk_beams
 290        */
 291       if (rhythmic_req->duration_.durlog_i_<= 2)
 292         {
 293           DOUT << "ending autobeam: stem doesn't fit in beam\n";
 294           end_beam ();
 295           return;
 296         }
 297
 298       Moment start = get_staff_info().time_C_->whole_in_measure_;
 299       if (!grouping_p_->child_fit_b (start))
 300         {
 301           DOUT << "ending autobeam: stem doesn't fit in group\n";
 302           end_beam ();
 303         }
 304       else
 305         {
 306           /*
 307             if shortest duration would change
 308             reconsider ending/starting beam first.
 309            */
 310           Moment mom = rhythmic_req->duration_.length_mom ();
 311           if (mom < shortest_mom_)
 312             {
 313               shortest_mom_ = mom;
 314               consider_end_and_begin ();
 315             }
 316           grouping_p_->add_child (start, rhythmic_req->length_mom ());
 317           stem_l->flag_i_ = rhythmic_req->duration_.durlog_i_;
 318           beam_p_->add_stem (stem_l);
 319           Moment now = now_mom ();
 320           last_add_mom_ = now;
 321           extend_mom_ = extend_mom_ >? now + rhythmic_req->length_mom ();
 322         }
 323     }
 324 }
 325
 326 void
 327 Auto_beam_engraver::junk_beam ()
 328 {
 329   assert (beam_p_);
 330   beam_p_->unlink ();
 331   beam_p_ = 0;
 332   delete grouping_p_;
 333   grouping_p_ = 0;
 334   shortest_mom_ = 1;
 335 }
 336
 337 void
 338 Auto_beam_engraver::process_acknowledged ()
 339 {
 340   if (beam_p_)
 341     {
 342       Moment now = now_mom ();
 343       if ((extend_mom_ < now)
 344           || ((extend_mom_ == now) && (last_add_mom_ != now )))
 345         {
 346           DOUT << String ("junking autobeam: no stem added since: ")
 347             + last_add_mom_.str () + "\n";
 348           end_beam ();
 349         }
 350       else if (!beam_p_->stems_.size ())
 351         {
 352           DOUT << "junking started autobeam: no stems\n";
 353           junk_beam ();
 354         }
 355     }
 356 }