2 pitch-scheme.cc -- implement scheme functions for Pitch
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
12 LY_DEFINE (ly_pitch_transpose, "ly:pitch-transpose",
13 2, 0, 0, (SCM p, SCM delta),
14 "Transpose @var{p} by the amount @var{delta}, "
15 "where @var{delta} is relative to middle C.")
17 Pitch* t = unsmob_pitch (p);
18 Pitch *d = unsmob_pitch (delta);
19 SCM_ASSERT_TYPE (t, p, SCM_ARG1, __FUNCTION__, "pitch");
20 SCM_ASSERT_TYPE (d, delta, SCM_ARG1, __FUNCTION__, "pitch");
21 return t->transposed (*d).smobbed_copy ();
24 /* Should add optional args. */
25 LY_DEFINE (ly_make_pitch, "ly:make-pitch",
26 3, 0, 0, (SCM octave, SCM note, SCM alter),
27 "@var{octave} is specified by an integer, "
28 "zero for the octave containing middle C. "
29 "@var{note} is a number from 0 to 6, "
30 "with 0 corresponding to C and 6 corresponding to B. "
31 "The @var{alter} is zero for a natural, negative for "
32 "flats, or positive for sharps. ")
34 SCM_ASSERT_TYPE (scm_integer_p (octave)== SCM_BOOL_T , octave, SCM_ARG1, __FUNCTION__, "integer");
35 SCM_ASSERT_TYPE (scm_integer_p (note)== SCM_BOOL_T, note, SCM_ARG2, __FUNCTION__, "integer");
36 SCM_ASSERT_TYPE (scm_integer_p (alter)== SCM_BOOL_T, alter, SCM_ARG3, __FUNCTION__, "integer");
38 Pitch p (scm_to_int (octave), scm_to_int (note), scm_to_int (alter));
39 return p.smobbed_copy ();
42 LY_DEFINE (ly_pitch_steps, "ly:pitch-steps", 1, 0, 0,
44 "Number of steps counted from middle C of the pitch @var{p}.")
46 Pitch *pp = unsmob_pitch (p);
47 SCM_ASSERT_TYPE (pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
48 return scm_int2num (pp->steps ());
51 LY_DEFINE (ly_pitch_octave, "ly:pitch-octave",
53 "Extract the octave from pitch @var{p}.")
55 Pitch *p = unsmob_pitch (pp);
56 SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
57 int q = p->get_octave ();
58 return scm_int2num (q);
61 LY_DEFINE (ly_pitch_alteration, "ly:pitch-alteration",
63 "Extract the alteration from pitch @var{p}.")
65 Pitch *p = unsmob_pitch (pp);
66 SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
67 int q = p->get_alteration ();
69 return scm_int2num (q);
72 LY_DEFINE (pitch_notename, "ly:pitch-notename",
74 "Extract the note name from pitch @var{pp}.")
76 Pitch *p = unsmob_pitch (pp);
77 SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
78 int q = p->get_notename ();
79 return scm_int2num (q);
82 LY_DEFINE (ly_pitch_quartertones, "ly:pitch-quartertones",
84 "Calculate the number of quarter tones of @var{p} from middle C.")
86 Pitch *p = unsmob_pitch (pp);
87 SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
88 int q = p->quartertone_pitch ();
89 return scm_int2num (q);
92 LY_DEFINE (ly_pitch_semitones, "ly:pitch-semitones",
94 "calculate the number of semitones of @var{p} from middle C.")
96 Pitch *p = unsmob_pitch (pp);
97 SCM_ASSERT_TYPE (p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
98 int q = p->semitone_pitch ();
99 return scm_int2num (q);
102 LY_DEFINE (ly_pitch_less_p, "ly:pitch<?",
103 2, 0, 0, (SCM p1, SCM p2),
104 "Is @var{p1} lexicographically smaller than @var{p2}?")
106 Pitch *a = unsmob_pitch (p1);
107 Pitch *b = unsmob_pitch (p2);
109 SCM_ASSERT_TYPE (a, p1, SCM_ARG1, __FUNCTION__, "Pitch");
110 SCM_ASSERT_TYPE (b, p2, SCM_ARG2, __FUNCTION__, "Pitch");
112 if (Pitch::compare (*a, *b) < 0)
118 LY_DEFINE (ly_pitch_diff, "ly:pitch-diff",
119 2 , 0, 0, (SCM pitch, SCM root),
120 "Return pitch @var{delta} such that @code{pitch} transposed by "
121 "@var{delta} equals @var{root}" )
123 Pitch *p = unsmob_pitch (pitch);
124 Pitch *r = unsmob_pitch (root);
125 SCM_ASSERT_TYPE (p, pitch, SCM_ARG1, __FUNCTION__, "Pitch");
126 SCM_ASSERT_TYPE (r, root, SCM_ARG2, __FUNCTION__, "Pitch");
128 return pitch_interval (*r, *p).smobbed_copy ();