lily/include/musical-pitch.hh

   1 /*
   2   musical-pitch.hh -- declare Musical_pitch
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #ifndef MUSICAL_PITCH_HH
  11 #define MUSICAL_PITCH_HH
  12
  13 #include "lily-proto.hh"
  14 #include "input.hh"
  15 #include "lily-guile.hh" // we need SCM
  16
  17 /** A "tonal" pitch. This is a pitch as it figures in diatonal western
  18    music (12 semitones in an octave), as opposed to a frequence in Hz
  19    or a integer number of semitones.
  20
  21    It is not Music because, it has no duration associated.
  22 */
  23 struct Musical_pitch : public Input
  24 {
  25   Musical_pitch (int notename=0, int accidental=0, int octave=0);
  26   Musical_pitch (SCM);
  27
  28   /// 0 is c, 6 is b
  29   int notename_i_;
  30   /// 0 natural, 1 sharp, etc
  31   int accidental_i_;
  32   /// 0 is central c
  33   int octave_i_;
  34
  35   Musical_pitch to_relative_octave (Musical_pitch);
  36   void transpose (Musical_pitch);
  37   static int compare (Musical_pitch const&,Musical_pitch const&);
  38   /// return large part of interval from central c
  39   int steps() const;
  40   /// return pitch from central c (in halfnotes)
  41   int semitone_pitch() const;
  42   void up_to (int);
  43   void down_to (int);
  44   String str () const;
  45   void print () const;
  46   SCM to_scm () const;
  47 };
  48
  49 #include "compare.hh"
  50 INSTANTIATE_COMPARE(Musical_pitch, Musical_pitch::compare);
  51
  52 #endif /* MUSICAL_PITCH_HH */
  53