]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/pitch.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / pitch.cc
index e01026da3dc764521dcf39ccdebd4459e1ce3dbb..bf2fd714ac4a61fb0aac0c9b057980f1cb8f413c 100644 (file)
-/*   
-  musical-pitch.cc --  implement Pitch
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+/*
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 1998--2014 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 "pitch.hh"
-#include "warn.hh"
-#include "main.hh"
-#include "ly-smobs.icc"
 
+#include "main.hh"
+#include "scale.hh"
+#include "string-convert.hh"
+#include "warn.hh"
 
+#include "ly-smobs.icc"
+#include <cmath>
 
-Pitch::Pitch (int o, int n, int a)
+Pitch::Pitch (int o, int n, Rational a)
 {
   notename_ = n;
   alteration_ = a;
   octave_ = o;
-  normalise ();
+  scale_ = default_global_scale;
+  normalize_octave ();
 }
 
+/* FIXME: why is octave == 0 and default not middleC ? */
 Pitch::Pitch ()
 {
   notename_ = 0;
-  alteration_ = 0;
+  scale_ = default_global_scale;
   octave_ = 0;
+  alteration_ = (Rational)0;
 }
 
 int
 Pitch::compare (Pitch const &m1, Pitch const &m2)
 {
-  int o m1.octave_ - m2.octave_;
+  int o = m1.octave_ - m2.octave_;
   int n = m1.notename_ - m2.notename_;
-  int a = m1.alteration_ - m2.alteration_;
+  Rational a = m1.alteration_ - m2.alteration_;
 
   if (o)
-       return o;
+    return o;
   if (n)
-       return n;
+    return n;
   if (a)
-       return a;
+    return a > (Rational)0 ? 1 : -1;
+
   return 0;
 }
 
 int
 Pitch::steps () const
 {
-  return  notename_ + octave_*7;
+  return notename_ + octave_ * scale_->step_count ();
 }
 
-/*
-  should be settable from input?
- */
-static Byte diatonic_scale_semitones[  ] = { 0, 2, 4, 5, 7, 9, 11 };
-
+Rational
+Pitch::tone_pitch () const
+{
+  return scale_->tones_at_step (notename_, octave_) + alteration_;
+}
 
 /* Calculate pitch height in 12th octave steps.  Don't assume
-   normalised pitch as this function is used to normalise the pitch.  */
+   normalized pitch as this function is used to normalize the pitch.  */
 int
-Pitch::semitone_pitch () const
+Pitch::rounded_semitone_pitch () const
 {
-  int o = octave_;
-  int n = notename_;
-  while (n < 0)
-    {
-      n += 7;
-      o --;
-    }
-
-  if (alteration_ % 2)
-    {
-      programming_error ("Calling semitone_pitch() for quarter tone alterations.");
-      
-    }
-  
-  return (o + n / 7) * 12 + diatonic_scale_semitones[n % 7] + (alteration_/2);
+  return int (floor (double (tone_pitch () * Rational (2) + Rational (1, 2))));
 }
 
 int
-Pitch::quartertone_pitch () const
+Pitch::rounded_quartertone_pitch () const
 {
-  int o = octave_;
-  int n = notename_;
-  while (n < 0)
-    {
-      n += 7;
-      o --;
-    }
-  
-  return (o + n / 7) * 24 +  2*  diatonic_scale_semitones[n % 7] + (alteration_);
+  return int (floor (double (tone_pitch () * Rational (4) + Rational (1, 2))));
 }
 
 void
-Pitch::normalise ()
+Pitch::normalize_octave ()
 {
-  int pitch = quartertone_pitch ();
-  while (notename_ >= 7)
-    {
-      notename_ -= 7;
-      octave_++;
-      alteration_ -= quartertone_pitch () - pitch;
-    }
-  while (notename_ < 0)
-    {
-      notename_ += 7;
-      octave_--;
-      alteration_ -= quartertone_pitch () - pitch;
-    }
-  while (alteration_ > DOUBLE_SHARP)
+  int normalized_step = notename_ % scale_->step_count ();
+  if (normalized_step < 0)
+    normalized_step += scale_->step_count ();
+
+  octave_ += (notename_ - normalized_step) / scale_->step_count ();
+  notename_ = normalized_step;
+}
+
+void
+Pitch::normalize_alteration ()
+{
+  while (alteration_ > Rational (1))
     {
-      if (notename_ == 6)
-       {
-         notename_ = 0;
-         octave_++;
-       }
-      else
-       notename_++;
-
-      alteration_ = 0;
-      alteration_ -= quartertone_pitch () - pitch;
+      alteration_ -= scale_->step_size (notename_);
+      notename_++;
     }
-  
-  while (alteration_ < DOUBLE_FLAT)
+  while (alteration_ < Rational (-1))
     {
-      if (notename_ == 0)
-       {
-         notename_ = 6;
-         octave_--;
-       }
-      else
-       notename_--;
-
-      alteration_ = 0;
-      alteration_ -= quartertone_pitch () - pitch;
+      notename_--;
+      alteration_ += scale_->step_size (notename_);
     }
 }
 
-/* WHugh, wat een intervaas */
+void
+Pitch::normalize ()
+{
+  normalize_alteration ();
+  normalize_octave ();
+}
+
 void
 Pitch::transpose (Pitch delta)
 {
-  int new_semi = quartertone_pitch ()  +delta.quartertone_pitch();
+  Rational new_alter = tone_pitch () + delta.tone_pitch ();
+
   octave_ += delta.octave_;
   notename_ += delta.notename_;
-  alteration_ += new_semi - quartertone_pitch();
+  alteration_ += new_alter - tone_pitch ();
 
-  normalise ();
+  normalize_octave ();
 }
 
 Pitch
-interval (Pitch const & from , Pitch const & to )
+pitch_interval (Pitch const &from, Pitch const &to)
 {
-  int sound = to.quartertone_pitch()  - from.quartertone_pitch ();
+  Rational sound = to.tone_pitch () - from.tone_pitch ();
   Pitch pt (to.get_octave () - from.get_octave (),
-           to.get_notename() - from.get_notename(),
+            to.get_notename () - from.get_notename (),
 
-           to.get_alteration() - from.get_alteration());
+            to.get_alteration () - from.get_alteration ());
 
-  return pt.transposed (Pitch(0,0,sound - pt.quartertone_pitch()));
+  return pt.transposed (Pitch (0, 0, sound - pt.tone_pitch ()));
 }
 
-
 /* FIXME
-   Merge with *pitch->text* funcs in chord-name.scm
- */
+   Merge with *pitch->text* funcs in chord-name.scm  */
 char const *accname[] = {"eses", "eseh", "es", "eh", "",
-                        "ih", "is" , "isih",  "isis"};
+                         "ih", "is", "isih", "isis"
+                        };
 
-String
+string
 Pitch::to_string () const
 {
-  int n = (notename_ + 2) % 7;
-  String s = ::to_string (char (n + 'a'));
-  if (alteration_)
-    s += String (accname[alteration_ - DOUBLE_FLAT]);
+  int n = (notename_ + 2) % scale_->step_count ();
+  string s = ::to_string (char (n + 'a'));
+  Rational qtones = alteration_ * Rational (4, 1);
+  int qt = int (rint (Real (qtones)));
 
+  s += string (accname[qt + 4]);
   if (octave_ >= 0)
     {
       int o = octave_ + 1;
       while (o--)
-       s += "'";
+        s += "'";
     }
   else if (octave_ < 0)
     {
       int o = (-octave_) - 1;
       while (o--)
-       s += ::to_string (',');
+        s += ::to_string (',');
     }
 
   return s;
 }
 
-/*
-  change me to relative, counting from last pitch p
-  return copy of resulting pitch
- */
+/* Change me to relative, counting from last pitch p
+   return copy of resulting pitch.  */
 Pitch
 Pitch::to_relative_octave (Pitch p) const
 {
-  int oct_mod = octave_  + 1;  // account for c' = octave 1 iso. 0 4
+  /* account for c' = octave 1 iso. 0 4 */
+  int oct_mod = octave_ + 1;
   Pitch up_pitch (p);
   Pitch down_pitch (p);
 
   up_pitch.alteration_ = alteration_;
   down_pitch.alteration_ = alteration_;
-  
+
   Pitch n = *this;
   up_pitch.up_to (notename_);
   down_pitch.down_to (notename_);
@@ -215,7 +198,7 @@ Pitch::to_relative_octave (Pitch p) const
     n = up_pitch;
   else
     n = down_pitch;
-  
+
   n.octave_ += oct_mod;
   return n;
 }
@@ -223,70 +206,47 @@ Pitch::to_relative_octave (Pitch p) const
 void
 Pitch::up_to (int notename)
 {
-  if (notename_  > notename)
-    {
-      octave_ ++;
-    }
-  notename_  = notename;
+  if (notename_ > notename)
+    octave_++;
+  notename_ = notename;
 }
 
 void
 Pitch::down_to (int notename)
 {
   if (notename_ < notename)
-    {
-      octave_ --;
-    }
+    octave_--;
   notename_ = notename;
 }
-LY_DEFINE(ly_pitch_transpose,
-         "ly:pitch-transpose", 2, 0, 0,
-         (SCM p, SCM delta),
-         "Transpose @var{p} by the amount @var{delta}, where @var{delta} is the "
-" pitch that central C is transposed to.")
-{
-  Pitch* t = unsmob_pitch (p);
-  Pitch *d = unsmob_pitch (delta);
-  SCM_ASSERT_TYPE(t, p, SCM_ARG1, __FUNCTION__, "pitch")  ;
-  SCM_ASSERT_TYPE(d, delta, SCM_ARG1, __FUNCTION__, "pitch")  ;
-
-  return t->transposed (*d).smobbed_copy ();
-}
-
-/****************************************************************/
-
 
 IMPLEMENT_TYPE_P (Pitch, "ly:pitch?");
-
 SCM
-Pitch::mark_smob (SCM)
+Pitch::mark_smob (SCM x)
 {
-  return SCM_EOL;
+  Pitch *p = (Pitch *) SCM_CELL_WORD_1 (x);
+  return p->scale_->self_scm ();
 }
 
 IMPLEMENT_SIMPLE_SMOBS (Pitch);
 int
 Pitch::print_smob (SCM s, SCM port, scm_print_state *)
 {
-  Pitch  *r = (Pitch *) ly_cdr (s);
-     
+  Pitch *r = (Pitch *) SCM_CELL_WORD_1 (s);
   scm_puts ("#<Pitch ", port);
-  scm_display (scm_makfrom0str (r->to_string ().to_str0 ()), port);
+  scm_display (ly_string2scm (r->to_string ()), port);
   scm_puts (" >", port);
-  
   return 1;
 }
 
 SCM
-Pitch::equal_p (SCM a , SCM b)
+Pitch::equal_p (SCM a, SCM b)
 {
-  Pitch  *p = (Pitch *) ly_cdr (a);
-  Pitch  *q = (Pitch *) ly_cdr (b);  
+  Pitch *p = (Pitch *) SCM_CELL_WORD_1 (a);
+  Pitch *q = (Pitch *) SCM_CELL_WORD_1 (b);
 
   bool eq = p->notename_ == q->notename_
-    && p->octave_ == q->octave_
-    && p->alteration_ == q->alteration_;
+            && p->octave_ == q->octave_
+            && p->alteration_ == q->alteration_;
 
   return eq ? SCM_BOOL_T : SCM_BOOL_F;
 }
@@ -304,130 +264,8 @@ Pitch::less_p (SCM p1, SCM p2)
     return SCM_BOOL_F;
 }
 
-/*
-  should add optional args
- */
-
-LY_DEFINE(make_pitch, "ly:make-pitch", 3, 0, 0, 
-         (SCM octave, SCM note, SCM alter),
-         "@var{octave} is specified by an integer, zero for the octave containing "
-         "middle C.  @var{note} is a number from 0 to 6, with 0 corresponding to C "
-         "and 6 corresponding to B.  The @var{alter} is zero for a natural, negative for "
-         "flats, or positive for sharps. ")
-{
-  SCM_ASSERT_TYPE(scm_integer_p (octave)== SCM_BOOL_T , octave, SCM_ARG1, __FUNCTION__, "integer");
-  SCM_ASSERT_TYPE(scm_integer_p (note)== SCM_BOOL_T, note, SCM_ARG2, __FUNCTION__, "integer");
-  SCM_ASSERT_TYPE(scm_integer_p (alter)== SCM_BOOL_T, alter, SCM_ARG3, __FUNCTION__, "integer");
-
-  Pitch p (gh_scm2int (octave), gh_scm2int (note), gh_scm2int (alter));
-  return p.smobbed_copy ();
-}
-
-LY_DEFINE(pitch_steps, "ly:pitch-steps", 1, 0,0,
-         (SCM p),
-         "Number of steps counted from central C of the pitch @var{p}.")
-{
-  Pitch *pp = unsmob_pitch (p);
-  SCM_ASSERT_TYPE(pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
-
-  return gh_int2scm (pp->steps());
-}
-
-LY_DEFINE(pitch_octave, "ly:pitch-octave", 1, 0, 0, 
-         (SCM pp),
-         "extract the octave from pitch @var{p}.")
-{
-  Pitch *p = unsmob_pitch (pp);
-  SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
-  int q = p->get_octave ();
-
-  return gh_int2scm (q);
-}
-
-LY_DEFINE(pitch_alteration, "ly:pitch-alteration", 1, 0, 0, 
-         (SCM pp),
-         "extract the alteration from pitch  @var{p}.")
-{
-  Pitch *p = unsmob_pitch (pp);
-  SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
-  int     q = p->get_alteration ();
-
-  return gh_int2scm (q);
-}
-
-LY_DEFINE(pitch_notename, "ly:pitch-notename", 1, 0, 0, 
-         (SCM pp),
-         "extract the note name from pitch  @var{pp}.")
-{
-  Pitch *p = unsmob_pitch (pp);
-  SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
-  int q  = p->get_notename ();
-
-  return gh_int2scm (q);
-}
-
-LY_DEFINE(ly_pitch_quartertones,  "ly:pitch-quartertones", 1, 0, 0, 
-         (SCM pp),
-         "calculate the number of semitones of @var{p} from central C.")
-{
-  Pitch *p = unsmob_pitch (pp);
-  SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
-  int q = p->quartertone_pitch ();
-  
-  return gh_int2scm (q);
-}
-
-LY_DEFINE(ly_pitch_semitones,  "ly:pitch-semitones", 1, 0, 0, 
-         (SCM pp),
-         "calculate the number of semitones of @var{p} from central C.")
-{
-  Pitch *p = unsmob_pitch (pp);
-  SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
-  int q = p->semitone_pitch ();
-  
-  return gh_int2scm (q);
-}
-
-LY_DEFINE(pitch_less, "ly:pitch<?", 2,0,0, (SCM p1, SCM p2),
-         "Is @var{p1} lower than @var{p2}? This uses lexicographic ordening.")
-{
-  Pitch *a = unsmob_pitch (p1);
-  Pitch *b = unsmob_pitch (p2);
-  
-  SCM_ASSERT_TYPE(a, p1, SCM_ARG1, __FUNCTION__, "Pitch");
-  SCM_ASSERT_TYPE(b, p2, SCM_ARG2, __FUNCTION__, "Pitch");
-
-  if (Pitch::compare (*a, *b) < 0)
-    return SCM_BOOL_T;
-  else
-    return SCM_BOOL_F;
-}
-
-LY_DEFINE(ly_pitch_diff, "ly:pitch-diff", 2 ,0 ,0,
-         (SCM pitch, SCM  root),
-         "Return pitch @var{delta} such that @code{pitch} transposed by "
-         "@var{delta} equals @var{root}"
-         )
-{
-  Pitch *p = unsmob_pitch (pitch);
-  Pitch *r = unsmob_pitch (root);
-  SCM_ASSERT_TYPE(p, pitch, SCM_ARG1, __FUNCTION__, "Pitch");
-  SCM_ASSERT_TYPE(r, root, SCM_ARG2, __FUNCTION__, "Pitch");
-
-  return interval (*r,  *p).smobbed_copy();
-}
-
-SCM
-Pitch::smobbed_copy ()const
-{
-  Pitch *  p = new Pitch (*this);
-  return p->smobbed_self ();
-}
-
 int
-Pitch::get_octave ()const
+Pitch::get_octave () const
 {
   return octave_;
 }
@@ -438,7 +276,7 @@ Pitch::get_notename () const
   return notename_;
 }
 
-int
+Rational
 Pitch::get_alteration () const
 {
   return alteration_;
@@ -447,7 +285,26 @@ Pitch::get_alteration () const
 Pitch
 Pitch::transposed (Pitch d) const
 {
-  Pitch p =*this;
+  Pitch p = *this;
   p.transpose (d);
   return p;
 }
+
+Pitch
+Pitch::normalized () const
+{
+  Pitch p = *this;
+  p.normalize ();
+  return p;
+}
+
+Rational NATURAL_ALTERATION (0);
+Rational FLAT_ALTERATION (-1, 2);
+Rational DOUBLE_FLAT_ALTERATION (-1);
+Rational SHARP_ALTERATION (1, 2);
+
+Pitch
+Pitch::negated () const
+{
+  return pitch_interval (*this, Pitch ());
+}