]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/stem-tremolo.cc
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / stem-tremolo.cc
index c8fbd63d18d3ec037f5fe3c8ed030622ffee6710..9d58275e7611753bf86adc62961aaf2a0e9b6683 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  stem-tremolo.cc -- implement Stem_tremolo
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "stem-tremolo.hh"
@@ -13,6 +24,8 @@
 #include "directional-element-interface.hh"
 #include "item.hh"
 #include "lookup.hh"
+#include "note-collision.hh"
+#include "note-column.hh"
 #include "output-def.hh"
 #include "staff-symbol-referencer.hh"
 #include "stem.hh"
@@ -22,8 +35,8 @@ MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_slope, 1)
 SCM
 Stem_tremolo::calc_slope (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Grob *me = Grob::unsmob (smob);
+  Grob *stem = Grob::unsmob (me->get_object ("stem"));
   Spanner *beam = Stem::get_beam (stem);
 
   if (beam)
@@ -31,64 +44,65 @@ Stem_tremolo::calc_slope (SCM smob)
       Real dy = 0;
       SCM s = beam->get_property ("quantized-positions");
       if (is_number_pair (s))
-       dy = - scm_to_double (scm_car (s)) + scm_to_double (scm_cdr (s));
+        dy = - scm_to_double (scm_car (s)) + scm_to_double (scm_cdr (s));
 
       Grob *s2 = Beam::last_normal_stem (beam);
       Grob *s1 = Beam::first_normal_stem (beam);
-      
+
       Grob *common = s1->common_refpoint (s2, X_AXIS);
-      Real dx = s2->relative_coordinate (common, X_AXIS) -
-       s1->relative_coordinate (common, X_AXIS);
+      Real dx = s2->relative_coordinate (common, X_AXIS)
+                - s1->relative_coordinate (common, X_AXIS);
 
       return scm_from_double (dx ? dy / dx : 0);
     }
   else
     /* down stems with flags should have more sloped trems (helps avoid
        flag/stem collisions without making the stem very long) */
-    return scm_from_double (
-        (Stem::duration_log (stem) >= 3 && get_grob_direction (stem) == DOWN) ?
-          0.40 : 0.25);
+    return scm_from_double ((Stem::duration_log (stem) >= 3 && get_grob_direction (me) == DOWN)
+                            ? 0.40 : 0.25);
 }
 
 MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_width, 1)
 SCM
 Stem_tremolo::calc_width (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
-  Direction stemdir = get_grob_direction (stem);
+  Grob *me = Grob::unsmob (smob);
+  Grob *stem = Grob::unsmob (me->get_object ("stem"));
+  Direction dir = get_grob_direction (me);
   bool beam = Stem::get_beam (stem);
   bool flag = Stem::duration_log (stem) >= 3 && !beam;
 
   /* beamed stems and up-stems with flags have shorter tremolos */
-  return scm_from_double (((stemdir == UP && flag) || beam)? 1.0 : 1.5);
+  return scm_from_double (((dir == UP && flag) || beam) ? 1.0 : 1.5);
 }
 
 MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_style, 1)
 SCM
 Stem_tremolo::calc_style (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
-  Direction stemdir = get_grob_direction (stem);
+  Grob *me = Grob::unsmob (smob);
+  Grob *stem = Grob::unsmob (me->get_object ("stem"));
+  Direction dir = get_grob_direction (me);
   bool beam = Stem::get_beam (stem);
   bool flag = Stem::duration_log (stem) >= 3 && !beam;
 
-  return ly_symbol2scm (((stemdir == UP && flag) || beam) ? "rectangle" : "default");
+  return ly_symbol2scm (((dir == UP && flag) || beam) ? "rectangle" : "default");
 }
 
 Real
 Stem_tremolo::get_beam_translation (Grob *me)
 {
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Grob *stem = Grob::unsmob (me->get_object ("stem"));
   Spanner *beam = Stem::get_beam (stem);
 
   return (beam && beam->is_live ())
-    ? Beam::get_beam_translation (beam) : 0.81;
+         ? Beam::get_beam_translation (beam)
+         : (Staff_symbol_referencer::staff_space (me)
+            * robust_scm2double (me->get_property ("length-fraction"), 1.0) * 0.81);
 }
 
 Stencil
-Stem_tremolo::raw_stencil (Grob *me, Real slope, Direction stemdir)
+Stem_tremolo::raw_stencil (Grob *me, Real slope, Direction dir)
 {
   Real ss = Staff_symbol_referencer::staff_space (me);
   Real thick = robust_scm2double (me->get_property ("beam-thickness"), 1);
@@ -125,26 +139,57 @@ Stem_tremolo::raw_stencil (Grob *me, Real slope, Direction stemdir)
   for (int i = 0; i < tremolo_flags; i++)
     {
       Stencil b (a);
-      b.translate_axis (beam_translation * i * stemdir * -1, Y_AXIS);
+      b.translate_axis (beam_translation * i * dir * -1, Y_AXIS);
       mol.add_stencil (b);
     }
   return mol;
 }
 
+MAKE_SCHEME_CALLBACK (Stem_tremolo, pure_height, 3);
+SCM
+Stem_tremolo::pure_height (SCM smob, SCM, SCM)
+{
+  Item *me = unsmob_item (smob);
+
+  /*
+    Cannot use the real slope, since it looks at the Beam.
+   */
+  Stencil s1 (untranslated_stencil (me, 0.35));
+  Item *stem = unsmob_item (me->get_object ("stem"));
+  if (!stem)
+    return ly_interval2scm (s1.extent (Y_AXIS));
+
+  Direction dir = get_grob_direction (me);
 
+  Spanner *beam = Stem::get_beam (stem);
 
-MAKE_SCHEME_CALLBACK (Stem_tremolo, height, 1);
+  if (!beam)
+    return ly_interval2scm (s1.extent (Y_AXIS));
+
+  Interval ph = stem->pure_height (stem, 0, INT_MAX);
+  Stem_info si = Stem::get_stem_info (stem);
+  ph[-dir] = si.shortest_y_;
+  int beam_count = Stem::beam_multiplicity (stem).length () + 1;
+  Real beam_translation = get_beam_translation (me);
+
+  ph = ph - dir * max (beam_count, 1) * beam_translation;
+  ph = ph - ph.center ();
+
+  return ly_interval2scm (ph);
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, width, 1);
 SCM
-Stem_tremolo::height (SCM smob)
+Stem_tremolo::width (SCM smob)
 {
-  Grob *me = unsmob_grob (smob);
+  Grob *me = Grob::unsmob (smob);
 
   /*
     Cannot use the real slope, since it looks at the Beam.
    */
-  Stencil s1 (translated_stencil (me, 0.35));
+  Stencil s1 (untranslated_stencil (me, 0.35));
 
-  return ly_interval2scm (s1.extent (Y_AXIS));
+  return ly_interval2scm (s1.extent (X_AXIS));
 }
 
 Real
@@ -152,91 +197,157 @@ Stem_tremolo::vertical_length (Grob *me)
 {
   return untranslated_stencil (me, 0.35).extent (Y_AXIS).length ();
 }
-  
+
 Stencil
 Stem_tremolo::untranslated_stencil (Grob *me, Real slope)
 {
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
+  Grob *stem = Grob::unsmob (me->get_object ("stem"));
   if (!stem)
     {
       programming_error ("no stem for stem-tremolo");
-      return Stencil();
+      return Stencil ();
     }
 
-  Direction stemdir = get_grob_direction (stem);
-  if (!stemdir)
-    stemdir = UP;
+  Direction dir = get_grob_direction (me);
 
   bool whole_note = Stem::duration_log (stem) <= 0;
 
   /* for a whole note, we position relative to the notehead, so we want the
      stencil aligned on the flag closest to the head */
-  Direction stencil_dir = whole_note ? -stemdir : stemdir;
+  Direction stencil_dir = whole_note ? -dir : dir;
   return raw_stencil (me, slope, stencil_dir);
 }
 
-  
-Stencil
-Stem_tremolo::translated_stencil (Grob *me, Real slope)
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_y_offset, 1);
+SCM
+Stem_tremolo::calc_y_offset (SCM smob)
+{
+  Grob *me = Grob::unsmob (smob);
+  return scm_from_double (y_offset (me, false));
+}
+
+MAKE_SCHEME_CALLBACK (Stem_tremolo, pure_calc_y_offset, 3);
+SCM
+Stem_tremolo::pure_calc_y_offset (SCM smob,
+                                  SCM, /* start */
+                                  SCM /* end */)
 {
-  Stencil mol = untranslated_stencil (me, slope);
+  Grob *me = Grob::unsmob (smob);
+  return scm_from_double (y_offset (me, true));
+}
 
-  Grob *stem = unsmob_grob (me->get_object ("stem"));
+MAKE_SCHEME_CALLBACK (Stem_tremolo, calc_direction, 1);
+SCM
+Stem_tremolo::calc_direction (SCM smob)
+{
+  Item *me = unsmob_item (smob);
+
+  Item *stem = unsmob_item (me->get_object ("stem"));
   if (!stem)
-    return Stencil ();
-  
+    return scm_from_int (CENTER);
+
   Direction stemdir = get_grob_direction (stem);
-  if (stemdir == 0)
-    stemdir = UP;
+
+  vector<int> nhp = Stem::note_head_positions (stem);
+  /*
+   * We re-decide stem-dir if there may be collisions with other
+   * note heads in the staff.
+   */
+  Grob *maybe_nc = stem->get_parent (X_AXIS)->get_parent (X_AXIS);
+  bool whole_note = Stem::duration_log (stem) <= 0;
+  if (whole_note && Note_collision_interface::has_interface (maybe_nc))
+    {
+      Drul_array<bool> avoid_me (false, false);
+      vector<int> all_nhps = Note_collision_interface::note_head_positions (maybe_nc);
+      if (all_nhps[0] < nhp[0])
+        avoid_me[DOWN] = true;
+      if (all_nhps.back () > nhp.back ())
+        avoid_me[UP] = true;
+      if (avoid_me[stemdir])
+        {
+          stemdir = -stemdir;
+          if (avoid_me[stemdir])
+            {
+              me->warning ("Whole-note tremolo may collide with simultaneous notes.");
+              stemdir = -stemdir;
+            }
+        }
+    }
+  return scm_from_int (stemdir);
+}
+
+Real
+Stem_tremolo::y_offset (Grob *me, bool pure)
+{
+  Item *stem = unsmob_item (me->get_object ("stem"));
+  if (!stem)
+    return 0.0;
+
+  Direction dir = get_grob_direction (me);
 
   Spanner *beam = Stem::get_beam (stem);
   Real beam_translation = get_beam_translation (me);
 
   int beam_count = beam ? (Stem::beam_multiplicity (stem).length () + 1) : 0;
-  Real ss = Staff_symbol_referencer::staff_space (me);
+
+  if (pure && beam)
+    {
+      Interval ph = stem->pure_height (stem, 0, INT_MAX);
+      Stem_info si = Stem::get_stem_info (stem);
+      ph[-dir] = si.shortest_y_;
+
+      return (ph - dir * max (beam_count, 1) * beam_translation)[dir] - dir * 0.5 * me->pure_height (me, 0, INT_MAX).length ();
+    }
 
   Real end_y
-    = Stem::stem_end_position (stem) * ss / 2
-    - stemdir * max (beam_count, 1) * beam_translation;
+    = (pure
+       ? stem->pure_height (stem, 0, INT_MAX)[dir]
+       : stem->extent (stem, Y_AXIS)[dir])
+      - dir * max (beam_count, 1) * beam_translation
+      - Stem::beam_end_corrective (stem);
 
   if (!beam && Stem::duration_log (stem) >= 3)
     {
-      end_y -= stemdir * (Stem::duration_log (stem) - 2) * beam_translation;
-      if (stemdir == UP)
-        end_y -= stemdir * beam_translation * 0.5;
+      end_y -= dir * (Stem::duration_log (stem) - 2) * beam_translation;
+      if (dir == UP)
+        end_y -= dir * beam_translation * 0.5;
     }
 
   bool whole_note = Stem::duration_log (stem) <= 0;
-  if (whole_note)
+  if (whole_note || isinf(end_y))
     {
       /* we shouldn't position relative to the end of the stem since the stem
          is invisible */
+      Real ss = Staff_symbol_referencer::staff_space (me);
       vector<int> nhp = Stem::note_head_positions (stem);
-      Real note_head = (stemdir == UP ? nhp.back () : nhp[0]) * ss / 2;
-      end_y = note_head + stemdir * 1.5;
+      Real note_head = (dir == UP ? nhp.back () : nhp[0]) * ss / 2;
+      end_y = note_head + dir * 1.5;
     }
-  mol.translate_axis (end_y, Y_AXIS);
 
-  return mol;
+  return end_y;
 }
 
 MAKE_SCHEME_CALLBACK (Stem_tremolo, print, 1);
 SCM
 Stem_tremolo::print (SCM grob)
 {
-  Grob *me = unsmob_grob (grob);
-  
-  Stencil s = translated_stencil (me, robust_scm2double (me->get_property ("slope"), 0.25));
+  Grob *me = Grob::unsmob (grob);
+
+  Stencil s = untranslated_stencil (me, robust_scm2double (me->get_property ("slope"), 0.25));
   return s.smobbed_copy ();
 }
 
 ADD_INTERFACE (Stem_tremolo,
-              "A beam slashing a stem to indicate a tremolo.",
-
-              "beam-thickness "
-              "beam-width "
-              "flag-count "
-              "stem "
+               "A beam slashing a stem to indicate a tremolo.  The property"
+               " @code{style} can be @code{default} or @code{rectangle}.",
+
+               /* properties */
+               "beam-thickness "
+               "beam-width "
+               "direction "
+               "flag-count "
+               "length-fraction "
+               "stem "
                "style "
-              "slope "
-              );
+               "slope "
+              );