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_negate, "ly:pitch-negate", 1, 0, 0,
  44            (SCM p),
  45            "Negate @var{p}.")
  46 {
  47   Pitch *pp = unsmob_pitch (p);
  48   SCM_ASSERT_TYPE (pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
  49   return pp->negated ().smobbed_copy ();
  50 }
  51
  52 LY_DEFINE (ly_pitch_steps, "ly:pitch-steps", 1, 0, 0,
  53            (SCM p),
  54            "Number of steps counted from middle C of the pitch @var{p}.")
  55 {
  56   Pitch *pp = unsmob_pitch (p);
  57   SCM_ASSERT_TYPE (pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
  58   return scm_from_int (pp->steps ());
  59 }
  60
  61 LY_DEFINE (ly_pitch_octave, "ly:pitch-octave",
  62            1, 0, 0, (SCM pp),
  63            "Extract the octave from pitch @var{p}.")
  64 {
  65   Pitch *p = unsmob_pitch (pp);
  66   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  67   int q = p->get_octave ();
  68   return scm_from_int (q);
  69 }
  70
  71 LY_DEFINE (ly_pitch_alteration, "ly:pitch-alteration",
  72            1, 0, 0, (SCM pp),
  73            "Extract the alteration from pitch  @var{p}.")
  74 {
  75   Pitch *p = unsmob_pitch (pp);
  76   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  77   Rational q = p->get_alteration ();
  78
  79   return ly_rational2scm (q);
  80 }
  81
  82 LY_DEFINE (pitch_notename, "ly:pitch-notename",
  83            1, 0, 0, (SCM pp),
  84            "Extract the note name from pitch  @var{pp}.")
  85 {
  86   Pitch *p = unsmob_pitch (pp);
  87   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  88   int q = p->get_notename ();
  89   return scm_from_int (q);
  90 }
  91
  92 LY_DEFINE (ly_pitch_quartertones, "ly:pitch-quartertones",
  93            1, 0, 0, (SCM pp),
  94            "Calculate the number of quarter tones of @var{p} from middle C.")
  95 {
  96   Pitch *p = unsmob_pitch (pp);
  97   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
  98   int q = p->rounded_quartertone_pitch ();
  99   return scm_from_int (q);
 100 }
 101
 102 LY_DEFINE (ly_pitch_semitones, "ly:pitch-semitones",
 103            1, 0, 0, (SCM pp),
 104            "calculate the number of semitones of @var{p} from middle C.")
 105 {
 106   Pitch *p = unsmob_pitch (pp);
 107   SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
 108   int q = p->rounded_semitone_pitch ();
 109   return scm_from_int (q);
 110 }
 111
 112 LY_DEFINE (ly_pitch_less_p, "ly:pitch<?",
 113            2, 0, 0, (SCM p1, SCM p2),
 114            "Is @var{p1} lexicographically smaller than @var{p2}?")
 115 {
 116   Pitch *a = unsmob_pitch (p1);
 117   Pitch *b = unsmob_pitch (p2);
 118
 119   SCM_ASSERT_TYPE (a, p1, SCM_ARG1, __FUNCTION__, "Pitch");
 120   SCM_ASSERT_TYPE (b, p2, SCM_ARG2, __FUNCTION__, "Pitch");
 121
 122   if (Pitch::compare (*a, *b) < 0)
 123     return SCM_BOOL_T;
 124   else
 125     return SCM_BOOL_F;
 126 }
 127
 128 LY_DEFINE (ly_pitch_diff, "ly:pitch-diff",
 129            2, 0, 0, (SCM pitch, SCM root),
 130            "Return pitch @var{delta} such that @code{pitch} transposed by "
 131            "@var{delta} equals @var{root}")
 132 {
 133   Pitch *p = unsmob_pitch (pitch);
 134   Pitch *r = unsmob_pitch (root);
 135   SCM_ASSERT_TYPE (p, pitch, SCM_ARG1, __FUNCTION__, "Pitch");
 136   SCM_ASSERT_TYPE (r, root, SCM_ARG2, __FUNCTION__, "Pitch");
 137
 138   return pitch_interval (*r, *p).smobbed_copy ();
 139 }