lily/pitch-scheme.cc

   1 /*
   2   pitch-scheme.cc -- implement scheme functions for Pitch
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "pitch.hh"
  10
  11 LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
  12            2, 0, 0, (SCM p, SCM delta),
  13            "Transpose @var{p} by the amount @var{delta}, "
  14            "where @var{delta} is relative to middle C.")
  15 {
  16   Pitch *t = unsmob_pitch (p);
  17   Pitch *d = unsmob_pitch (delta);
  18   SCM_ASSERT_TYPE (t, p, SCM_ARG1, __FUNCTION__, "pitch");
  19   SCM_ASSERT_TYPE (d, delta, SCM_ARG1, __FUNCTION__, "pitch");
  20   return t->transposed (*d).smobbed_copy ();
  21 }
  22
  23 /* Should add optional args.  */
  24 LY_DEFINE (ly_make_pitch, "ly:make-pitch",
  25            2, 1, 0, (SCM octave, SCM note, SCM alter),
  26            "@var{octave} is specified by an integer, "
  27            "zero for the octave containing middle C.  "
  28            "@var{note} is a number from 0 to 6, "
  29            "with 0 corresponding to C and 6 corresponding to B.  "
  30            "The @var{alter} is a rational number of whole tones for alteration.")
  31 {
  32   SCM_ASSERT_TYPE (scm_is_integer (octave), octave, SCM_ARG1, __FUNCTION__, "integer");
  33   SCM_ASSERT_TYPE (scm_is_integer (note), note, SCM_ARG2, __FUNCTION__, "integer");
  34   SCM_ASSERT_TYPE (scm_is_rational (alter),
  35                    alter, SCM_ARG3, __FUNCTION__, "rational");
  36
  37   Pitch p (scm_to_int (octave), scm_to_int (note),
  38            ly_scm2rational (alter));
  39
  40   return p.smobbed_copy ();
  41 }
  42
  43 LY_DEFINE (ly_pitch_steps, "ly:pitch-steps", 1, 0, 0,
  44            (SCM p),
  45            "Number of steps counted from middle C of the pitch @var{p}.")
  46 {
  47   Pitch *pp = unsmob_pitch (p);
  48   SCM_ASSERT_TYPE (pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
  49   return scm_from_int (pp->steps ());
  50 }
  51
  52 LY_DEFINE (ly_pitch_octave, "ly:pitch-octave",
  53            1, 0, 0, (SCM pp),
  54            "Extract the octave from pitch @var{p}.")
  55 {
  56   Pitch *p = unsmob_pitch (pp);
  57   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  58   int q = p->get_octave ();
  59   return scm_from_int (q);
  60 }
  61
  62 LY_DEFINE (ly_pitch_alteration, "ly:pitch-alteration",
  63            1, 0, 0, (SCM pp),
  64            "Extract the alteration from pitch  @var{p}.")
  65 {
  66   Pitch *p = unsmob_pitch (pp);
  67   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  68   Rational q = p->get_alteration ();
  69
  70   return ly_rational2scm (q);
  71 }
  72
  73 LY_DEFINE (pitch_notename, "ly:pitch-notename",
  74            1, 0, 0, (SCM pp),
  75            "Extract the note name from pitch  @var{pp}.")
  76 {
  77   Pitch *p = unsmob_pitch (pp);
  78   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  79   int q = p->get_notename ();
  80   return scm_from_int (q);
  81 }
  82
  83 LY_DEFINE (ly_pitch_quartertones, "ly:pitch-quartertones",
  84            1, 0, 0, (SCM pp),
  85            "Calculate the number of quarter tones of @var{p} from middle C.")
  86 {
  87   Pitch *p = unsmob_pitch (pp);
  88   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  89   int q = p->rounded_quartertone_pitch ();
  90   return scm_from_int (q);
  91 }
  92
  93 LY_DEFINE (ly_pitch_semitones, "ly:pitch-semitones",
  94            1, 0, 0, (SCM pp),
  95            "calculate the number of semitones of @var{p} from middle C.")
  96 {
  97   Pitch *p = unsmob_pitch (pp);
  98   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  99   int q = p->rounded_semitone_pitch ();
 100   return scm_from_int (q);
 101 }
 102
 103 LY_DEFINE (ly_pitch_less_p, "ly:pitch<?",
 104            2, 0, 0, (SCM p1, SCM p2),
 105            "Is @var{p1} lexicographically smaller than @var{p2}?")
 106 {
 107   Pitch *a = unsmob_pitch (p1);
 108   Pitch *b = unsmob_pitch (p2);
 109
 110   SCM_ASSERT_TYPE (a, p1, SCM_ARG1, __FUNCTION__, "Pitch");
 111   SCM_ASSERT_TYPE (b, p2, SCM_ARG2, __FUNCTION__, "Pitch");
 112
 113   if (Pitch::compare (*a, *b) < 0)
 114     return SCM_BOOL_T;
 115   else
 116     return SCM_BOOL_F;
 117 }
 118
 119 LY_DEFINE (ly_pitch_diff, "ly:pitch-diff",
 120            2, 0, 0, (SCM pitch, SCM root),
 121            "Return pitch @var{delta} such that @code{pitch} transposed by "
 122            "@var{delta} equals @var{root}")
 123 {
 124   Pitch *p = unsmob_pitch (pitch);
 125   Pitch *r = unsmob_pitch (root);
 126   SCM_ASSERT_TYPE (p, pitch, SCM_ARG1, __FUNCTION__, "Pitch");
 127   SCM_ASSERT_TYPE (r, root, SCM_ARG2, __FUNCTION__, "Pitch");
 128
 129   return pitch_interval (*r, *p).smobbed_copy ();
 130 }