]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/pitch.hh
Run grand replace for 2015.
[lilypond.git] / lily / include / pitch.hh
index 2ebbb71a4179ada0835ba590eb20fbd03583aae8..90b4317f685e66fb72d4d20dd0c912285c4f4477 100644 (file)
 /*
-  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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1998--2006 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"
 
-#include "std-vector.hh"
-
-struct Scale
-{
-  vector<int> step_semitones_;
-  Scale ();
-  Scale (Scale const&);
-  DECLARE_SMOBS(Scale,);
-};
-
-
-/** 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).
-
-
-    TODO:
+/*
+  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.
 
-    - add indeterminate octaves, so it can be used as a key in keySigature
+  Pitch is lexicographically ordered by (octave, notename, alteration).
 */
-class Pitch
-{
-private:                               // fixme
-  /*
-    TODO: use SCM
-  */
 
-  int notename_;
-  int alteration_;
+class Pitch : public Simple_smob<Pitch>
+{
+public:
+  static SCM equal_p (SCM, SCM);
+  int print_smob (SCM, scm_print_state *);
+  SCM mark_smob ();
+  static const char type_p_name_[];
+private:
   int octave_;
+  int notename_;
+  Rational alteration_;
   Scale *scale_;
-  
+
   void transpose (Pitch);
   void up_to (int);
   void down_to (int);
-  void normalise ();
+  void normalize_octave ();
+  void normalize_alteration ();
+  void normalize ();
 
 public:
-
   int get_octave () const;
   int get_notename () const;
-  int get_alteration () const;
+  Rational get_alteration () const;
 
-  Pitch (int octave, int notename, int accidental);
+  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;
-  int semitone_pitch () const;
-  int quartertone_pitch () const;
+  Rational tone_pitch () const;
+  int rounded_semitone_pitch () const;
+  int rounded_quartertone_pitch () const;
+  Pitch negated () const;
   string to_string () const;
 
   DECLARE_SCHEME_CALLBACK (less_p, (SCM a, SCM b));
-  DECLARE_SIMPLE_SMOBS (Pitch,);
 };
 
 enum
-  {
-    DOUBLE_FLAT = -4,
-    THREE_Q_FLAT,
-    FLAT,
-    SEMI_FLAT,
-    NATURAL,
-    SEMI_SHARP,
-    SHARP,
-    THREE_Q_SHARP,
-    DOUBLE_SHARP,
-  };
+{
+  DOUBLE_FLAT = -4,
+  THREE_Q_FLAT,
+  FLAT,
+  SEMI_FLAT,
+  NATURAL,
+  SEMI_SHARP,
+  SHARP,
+  THREE_Q_SHARP,
+  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;
 
 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 Scale *default_global_scale;
-
-#endif /* MUSICAL_PITCH_HH */
+extern SCM Pitch_type_p_proc;
 
+#endif /* PITCH_HH */