lily/include/pitch.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef PITCH_HH
  21 #define PITCH_HH
  22
  23 #include "lily-proto.hh"
  24 #include "smobs.hh"
  25 #include "rational.hh"
  26
  27 /*
  28   A "tonal" pitch.  This is a pitch used in diatonal western music
  29   (24 quartertones in an octave), as opposed to a frequency in Hz or a
  30   integer number of semitones.
  31
  32   Pitch is lexicographically ordered by (octave, notename, alteration).
  33 */
  34
  35 class Pitch
  36 {
  37 private:
  38   int octave_;
  39   int notename_;
  40   Rational alteration_;
  41   Scale *scale_;
  42
  43   void transpose (Pitch);
  44   void up_to (int);
  45   void down_to (int);
  46   void normalize_octave ();
  47   void normalize_alteration ();
  48   void normalize ();
  49
  50 public:
  51   int get_octave () const;
  52   int get_notename () const;
  53   Rational get_alteration () const;
  54
  55   Pitch (int octave, int notename, Rational accidental);
  56   Pitch (int octave, int notename);
  57   Pitch ();
  58
  59   Pitch transposed (Pitch) const;
  60   Pitch to_relative_octave (Pitch) const;
  61
  62   Pitch normalized () const;
  63
  64   static int compare (Pitch const &, Pitch const &);
  65
  66   int steps () const;
  67   Rational tone_pitch () const;
  68   int rounded_semitone_pitch () const;
  69   int rounded_quartertone_pitch () const;
  70   Pitch negated () const;
  71   string to_string () const;
  72
  73   DECLARE_SCHEME_CALLBACK (less_p, (SCM a, SCM b));
  74   DECLARE_SIMPLE_SMOBS (Pitch);
  75 };
  76
  77 enum
  78 {
  79   DOUBLE_FLAT = -4,
  80   THREE_Q_FLAT,
  81   FLAT,
  82   SEMI_FLAT,
  83   NATURAL,
  84   SEMI_SHARP,
  85   SHARP,
  86   THREE_Q_SHARP,
  87   DOUBLE_SHARP,
  88 };
  89
  90 extern Rational DOUBLE_FLAT_ALTERATION;
  91 extern Rational THREE_Q_FLAT_ALTERATION;
  92 extern Rational FLAT_ALTERATION;
  93 extern Rational SEMI_FLAT_ALTERATION;
  94 extern Rational NATURAL_ALTERATION;
  95 extern Rational SEMI_SHARP_ALTERATION;
  96 extern Rational SHARP_ALTERATION;
  97 extern Rational THREE_Q_SHARP_ALTERATION;
  98 extern Rational DOUBLE_SHARP_ALTERATION;
  99
 100 SCM ly_pitch_diff (SCM pitch, SCM root);
 101 SCM ly_pitch_transpose (SCM p, SCM delta);
 102 DECLARE_UNSMOB (Pitch, pitch);
 103
 104 INSTANTIATE_COMPARE (Pitch, Pitch::compare);
 105
 106 extern SCM pitch_less_proc;
 107 Pitch pitch_interval (Pitch const &from, Pitch const &to);
 108 extern SCM Pitch_type_p_proc;
 109
 110 #endif /* PITCH_HH */