]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/pitch.hh
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / include / pitch.hh
index e711fc0d579b138b91355414bf3b91d3e8134d4c..91c527455712cb4f6a1f388921d1328fc23d7530 100644 (file)
@@ -1,27 +1,37 @@
 /*
-  pitch.hh -- declare Pitch
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1998--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/>.
 */
 
-#ifndef MUSICAL_PITCH_HH
-#define MUSICAL_PITCH_HH
+#ifndef PITCH_HH
+#define PITCH_HH
 
 #include "lily-proto.hh"
 #include "smobs.hh"
 #include "rational.hh"
 
+/*
+  A "tonal" pitch.  This is a pitch used in diatonal western music
+  (24 quartertones in an octave), as opposed to a frequency in Hz or a
+  integer number of semitones.
 
-/** A "tonal" pitch. This is a pitch used in diatonal western music
-    (24 quartertones in an octave), as opposed to a frequency in Hz or a
-    integer number of semitones.
-
-    Pitch is lexicographically ordered by (octave, notename,
-    alteration).
-
+  Pitch is lexicographically ordered by (octave, notename, alteration).
 */
+
 class Pitch
 {
 private:
@@ -33,6 +43,8 @@ private:
   void transpose (Pitch);
   void up_to (int);
   void down_to (int);
+  void normalize_octave ();
+  void normalize_alteration ();
   void normalize ();
 
 public:
@@ -40,13 +52,14 @@ public:
   int get_notename () const;
   Rational get_alteration () const;
 
-  Pitch (int octave, int notename, Rational accidental);
-  Pitch (int octave, int notename);
+  Pitch (int octave, int notename, Rational accidental = 0);
   Pitch ();
 
   Pitch transposed (Pitch) const;
   Pitch to_relative_octave (Pitch) const;
 
+  Pitch normalized () const;
+
   static int compare (Pitch const &, Pitch const &);
 
   int steps () const;
@@ -60,8 +73,8 @@ public:
   DECLARE_SIMPLE_SMOBS (Pitch);
 };
 
-
-enum {
+enum
+{
   DOUBLE_FLAT = -4,
   THREE_Q_FLAT,
   FLAT,
@@ -73,24 +86,23 @@ enum {
   DOUBLE_SHARP,
 };
 
-extern Rational  DOUBLE_FLAT_ALTERATION;
-extern Rational  THREE_Q_FLAT_ALTERATION;
-extern Rational  FLAT_ALTERATION;
-extern Rational  SEMI_FLAT_ALTERATION;
-extern Rational  NATURAL_ALTERATION;
-extern Rational  SEMI_SHARP_ALTERATION;
-extern Rational  SHARP_ALTERATION;
-extern Rational  THREE_Q_SHARP_ALTERATION;
-extern Rational  DOUBLE_SHARP_ALTERATION;
+extern Rational DOUBLE_FLAT_ALTERATION;
+extern Rational THREE_Q_FLAT_ALTERATION;
+extern Rational FLAT_ALTERATION;
+extern Rational SEMI_FLAT_ALTERATION;
+extern Rational NATURAL_ALTERATION;
+extern Rational SEMI_SHARP_ALTERATION;
+extern Rational SHARP_ALTERATION;
+extern Rational THREE_Q_SHARP_ALTERATION;
+extern Rational DOUBLE_SHARP_ALTERATION;
 
 SCM ly_pitch_diff (SCM pitch, SCM root);
 SCM ly_pitch_transpose (SCM p, SCM delta);
-DECLARE_UNSMOB (Pitch, pitch);
 
 INSTANTIATE_COMPARE (Pitch, Pitch::compare);
 
 extern SCM pitch_less_proc;
 Pitch pitch_interval (Pitch const &from, Pitch const &to);
+extern SCM Pitch_type_p_proc;
 
-#endif /* MUSICAL_PITCH_HH */
-
+#endif /* PITCH_HH */