lily/stem.cc

   1 /*
   2   stem.cc -- implement Stem
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1996, 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8   TODO: This is way too hairy
   9 */
  10
  11 #include "stem.hh"
  12 #include "debug.hh"
  13 #include "paper-def.hh"
  14 #include "note-head.hh"
  15 #include "lookup.hh"
  16 #include "molecule.hh"
  17 #include "p-col.hh"
  18 #include "misc.hh"
  19 #include "beam.hh"
  20 #include "rest.hh"
  21
  22 void
  23 Stem::set_direction (Direction d)
  24 {
  25   if  (!dir_)
  26     warning ("Stem direction set already!");
  27
  28   dir_ = d;
  29
  30   /*
  31     todo
  32   */
  33 }
  34
  35 Stem::Stem ()
  36 {
  37   beams_i_drul_[LEFT] = beams_i_drul_[RIGHT] = -1;
  38   yextent_drul_[DOWN] = yextent_drul_[UP] = 0;
  39   flag_i_ = 2;
  40   dir_ = CENTER;
  41   beam_l_ = 0;
  42 }
  43
  44 Interval_t<int>
  45 Stem::head_positions () const
  46 {
  47   /*
  48     Mysterious FreeBSD fix by John Galbraith.  Somehow, the empty intervals
  49     trigger FP exceptions on FreeBSD.  Fix: do not return infinity
  50
  51    */
  52   if (!head_l_arr_.size ())
  53     {
  54       return Interval_t<int> (100,-100);
  55     }
  56
  57   Interval_t<int> r;
  58   for (int i =0; i < head_l_arr_.size (); i++)
  59     {
  60       int p = head_l_arr_[i]->position_i_;
  61       r[BIGGER] = r[BIGGER] >? p;
  62       r[SMALLER] = r[SMALLER] <? p;
  63     }
  64   return r;
  65 }
  66
  67 void
  68 Stem::do_print () const
  69 {
  70 #ifndef NPRINT
  71   DOUT << "flag "<< flag_i_;
  72   if (beam_l_)
  73     DOUT << "beamed";
  74 #endif
  75 }
  76
  77 Real
  78 Stem::stem_length_f () const
  79 {
  80   return yextent_drul_[UP]-yextent_drul_[DOWN] ;
  81 }
  82
  83 Real
  84 Stem::stem_begin_f () const
  85 {
  86   return yextent_drul_[Direction(-dir_)];
  87 }
  88
  89 Real
  90 Stem::chord_start_f () const
  91 {
  92   return head_positions()[dir_] * staff_line_leading_f ()/2.0;
  93 }
  94
  95 Real
  96 Stem::stem_end_f () const
  97 {
  98   return yextent_drul_[dir_];
  99 }
 100
 101 void
 102 Stem::set_stemend (Real se)
 103 {
 104   // todo: margins
 105   if (dir_ && dir_ * head_positions()[dir_] >= se*dir_)
 106     warning (_ ("weird stem size; check for narrow beams"));
 107
 108
 109   yextent_drul_[dir_]  =  se;
 110   yextent_drul_[Direction(-dir_)] = head_positions()[-dir_];
 111 }
 112
 113 int
 114 Stem::type_i () const
 115 {
 116   return head_l_arr_[0]->balltype_i_;
 117 }
 118
 119 void
 120 Stem::add_head (Rhythmic_head *n)
 121 {
 122   n->stem_l_ = this;
 123   n->add_dependency (this);     // ?
 124   if (Note_head *nh = dynamic_cast<Note_head *> (n))
 125     {
 126       head_l_arr_.push (nh);
 127     }
 128   else if (Rest *r = dynamic_cast<Rest *> (n))
 129     {
 130       rest_l_arr_.push (r);
 131     }
 132 }
 133
 134 bool
 135 Stem::invisible_b () const
 136 {
 137   return (!head_l_arr_.size () ||
 138     head_l_arr_[0]->balltype_i_ <= 0);
 139 }
 140
 141 int
 142 Stem::get_center_distance (Direction d) const
 143 {
 144   int staff_center = 0;
 145   int distance = d*(head_positions()[d] - staff_center);
 146   return distance >? 0;
 147 }
 148
 149 Direction
 150 Stem::get_default_dir () const
 151 {
 152   return (get_center_distance (UP) >
 153           get_center_distance (DOWN))
 154     ? DOWN
 155     : UP;
 156 }
 157
 158 Direction
 159 Stem::get_dir () const
 160 {
 161   return dir_;
 162 }
 163
 164
 165 void
 166 Stem::set_default_stemlen ()
 167 {
 168   Real length_f = 0.;
 169   SCM scm_len = get_elt_property(length_scm_sym);
 170   if (scm_len != SCM_BOOL_F)
 171     {
 172       length_f = gh_scm2double (SCM_CDR(scm_len));
 173     }
 174   else
 175     length_f = paper_l ()->get_var ("stem_length0");
 176
 177   Real shorten_f = paper_l ()->get_var ("forced_stem_shorten0");
 178
 179   if (!dir_)
 180     dir_ = get_default_dir ();
 181
 182   /*
 183     stems in unnatural (forced) direction should be shortened,
 184     according to [Roush & Gourlay]
 185    */
 186   if (((int)chord_start_f ())
 187       && (dir_ != get_default_dir ()))
 188     length_f -= shorten_f;
 189
 190   if (flag_i_ >= 5)
 191     length_f += 2.0;
 192   if (flag_i_ >= 6)
 193     length_f += 1.0;
 194
 195   set_stemend ((dir_ > 0) ? head_positions()[BIGGER] + length_f:
 196                head_positions()[SMALLER] - length_f);
 197
 198   if (dir_ * stem_end_f () < 0)
 199     set_stemend (0);
 200 }
 201
 202 //xxx
 203 void
 204 Stem::set_default_extents ()
 205 {
 206   if (!stem_length_f ())
 207     set_default_stemlen ();
 208
 209 }
 210
 211 void
 212 Stem::set_noteheads ()
 213 {
 214   if (!head_l_arr_.size ())
 215     return;
 216   head_l_arr_.sort (Note_head::compare);
 217   if (dir_ < 0)
 218     head_l_arr_.reverse ();
 219
 220   Note_head * beginhead =   head_l_arr_[0];
 221   beginhead->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 222   if  (beginhead !=   head_l_arr_.top ())
 223     head_l_arr_.top ()->set_elt_property (extremal_scm_sym, SCM_BOOL_T);
 224
 225   int parity=1;
 226   int lastpos = beginhead->position_i_;
 227   for (int i=1; i < head_l_arr_.size (); i ++)
 228     {
 229       int dy =abs (lastpos- head_l_arr_[i]->position_i_);
 230
 231       if (dy <= 1)
 232         {
 233           if (parity)
 234             head_l_arr_[i]->flip_around_stem (dir_);
 235           parity = !parity;
 236         }
 237       else
 238         parity = 1;
 239       lastpos = head_l_arr_[i]->position_i_;
 240     }
 241 }
 242
 243 void
 244 Stem::do_pre_processing ()
 245 {
 246   if (yextent_drul_[DOWN]== yextent_drul_[UP])
 247     set_default_extents ();
 248   set_noteheads ();
 249
 250   if (invisible_b ())
 251     {
 252       set_elt_property (transparent_scm_sym, SCM_BOOL_T);
 253     }
 254   set_empty (invisible_b ());
 255   set_spacing_hints ();
 256 }
 257
 258
 259
 260 /**
 261    set stem directions for hinting the optical spacing correction.
 262
 263    Modifies DIR_LIST property of the Stem's Score_column
 264
 265    TODO: more advanced: supply height of noteheads as well, for more advanced spacing possibilities
 266  */
 267 void
 268 Stem::set_spacing_hints ()
 269 {
 270   if (!invisible_b ())
 271     {
 272       SCM scmdir  = gh_int2scm (dir_);
 273       SCM dirlist = column_l ()->get_elt_property (dir_list_scm_sym);
 274       if (dirlist == SCM_BOOL_F)
 275         dirlist = SCM_EOL;
 276       else
 277         dirlist = SCM_CDR (dirlist);
 278
 279       if (scm_sloppy_memq (scmdir, dirlist) == SCM_EOL)
 280         {
 281           dirlist = gh_cons (scmdir, dirlist);
 282           column_l ()->set_elt_property (dir_list_scm_sym, dirlist);
 283         }
 284     }
 285 }
 286
 287
 288 Interval
 289 Stem::do_width () const
 290 {
 291   Interval r (0, 0);
 292   if (beam_l_ || abs (flag_i_) <= 2)
 293     ;   // TODO!
 294   else
 295     {
 296       r = lookup_l ()->flag (flag_i_, dir_).dim_.x ();
 297       r += note_delta_f ();
 298     }
 299   return r;
 300 }
 301
 302
 303
 304
 305 const Real ANGLE = 20* (2.0*M_PI/360.0); // ugh!
 306
 307 Molecule*
 308 Stem::do_brew_molecule_p () const
 309 {
 310   Molecule *mol_p =new Molecule;
 311   Drul_array<Real> stem_y = yextent_drul_;
 312   Real dy = staff_line_leading_f ()/2.0;
 313
 314   Real head_wid = 0;
 315   if (head_l_arr_.size ())
 316     head_wid = head_l_arr_[0]->extent (X_AXIS).length ();
 317   stem_y[Direction(-dir_)] += dir_ * head_wid * tan(ANGLE)/(2*dy);
 318
 319   if (!invisible_b ())
 320     {
 321       Real stem_width = paper_l ()->get_var ("stemthickness");
 322       Molecule ss =lookup_l ()->filledbox (Box (Interval (-stem_width/2, stem_width/2),
 323                                                  Interval (stem_y[DOWN]*dy, stem_y[UP]*dy)));
 324       mol_p->add_molecule (ss);
 325     }
 326
 327   if (!beam_l_ && abs (flag_i_) > 2)
 328     {
 329       Molecule fl = lookup_l ()->flag (flag_i_, dir_);
 330       fl.translate_axis(stem_y[dir_]*dy, Y_AXIS);
 331       mol_p->add_molecule (fl);
 332     }
 333
 334   if (head_l_arr_.size())
 335     {
 336       mol_p->translate_axis (note_delta_f (), X_AXIS);
 337     }
 338   return mol_p;
 339 }
 340
 341 Real
 342 Stem::note_delta_f () const
 343 {
 344   Real r=0;
 345   if (head_l_arr_.size())
 346     {
 347       Interval head_wid(0,  head_l_arr_[0]->extent (X_AXIS).length ());
 348       Real rule_thick(paper_l ()->rule_thickness ());
 349       Interval stem_wid(-rule_thick/2, rule_thick/2);
 350       if (dir_ == CENTER)
 351         r = head_wid.center ();
 352       else
 353         r = head_wid[dir_] - stem_wid[dir_];
 354     }
 355   return r;
 356 }
 357
 358 Real
 359 Stem::hpos_f () const
 360 {
 361   return note_delta_f () + Item::hpos_f ();
 362 }
 363
 364 void
 365 Stem::do_substitute_element_pointer (Score_element*o,Score_element*n)
 366 {
 367   if (Note_head*h=dynamic_cast<Note_head*> (o))
 368     head_l_arr_.substitute (h, dynamic_cast<Note_head*>(n));
 369   if (Rest *r=dynamic_cast<Rest*> (o))
 370     rest_l_arr_.substitute (r, dynamic_cast<Rest*>(n));
 371   if (Beam* b = dynamic_cast<Beam*> (o))
 372     {
 373       if (b == beam_l_)
 374         beam_l_ = dynamic_cast<Beam*> (n);
 375     }
 376   Staff_symbol_referencer::do_substitute_element_pointer (o,n);
 377 }