source file of the GNU LilyPond music typesetter
- (c) 1998--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#include "pitch.hh"
-#include "debug.hh"
+#include "warn.hh"
#include "main.hh"
#include "ly-smobs.icc"
Pitch::Pitch (int o, int n, int a)
{
- notename_i_ = n;
- alteration_i_ = a;
- octave_i_ = o;
-
- if (n < 0 || n >= 7 ||
- a < -2 || a > 2)
- {
- String s = _("Pitch arguments out of range");
- s += ": alteration = " + to_str (a);
- s += ", notename = " + to_str (n);
- warning (s);
- }
+ notename_ = n;
+ alteration_ = a;
+ octave_ = o;
+ normalise ();
}
Pitch::Pitch ()
{
- notename_i_ = 0;
- alteration_i_ = 0;
- octave_i_ = 0;
+ notename_ = 0;
+ alteration_ = 0;
+ octave_ = 0;
}
int
Pitch::compare (Pitch const &m1, Pitch const &m2)
{
- int o= m1.octave_i_ - m2.octave_i_;
- int n = m1.notename_i_ - m2.notename_i_;
- int a = m1.alteration_i_ - m2.alteration_i_;
+ int o= m1.octave_ - m2.octave_;
+ int n = m1.notename_ - m2.notename_;
+ int a = m1.alteration_ - m2.alteration_;
if (o)
return o;
int
Pitch::steps () const
{
- return notename_i_ + octave_i_*7;
+ return notename_ + octave_*7;
}
/*
should be settable from input?
*/
-static Byte pitch_byte_a[ ] = { 0, 2, 4, 5, 7, 9, 11 };
+static Byte diatonic_scale_semitones[ ] = { 0, 2, 4, 5, 7, 9, 11 };
+
+/* Calculate pitch height in 12th octave steps. Don't assume
+ normalised pitch as this function is used to normalise the pitch. */
int
Pitch::semitone_pitch () const
{
- return pitch_byte_a[ notename_i_ % 7 ] + alteration_i_ + octave_i_ * 12;
+ int o = octave_;
+ int n = notename_;
+ while (n < 0)
+ {
+ n += 7;
+ o --;
+ }
+
+ if (alteration_ % 2)
+ {
+ programming_error ("Calling semitone_pitch() for quarter tone alterations.");
+
+ }
+
+ return (o + n / 7) * 12 + diatonic_scale_semitones[n % 7] + (alteration_/2);
}
-/* WHugh, wat een intervaas */
-void
-Pitch::transpose (Pitch delta)
+int
+Pitch::quartertone_pitch () const
{
- int old_pitch = semitone_pitch ();
- int delta_pitch = delta.semitone_pitch ();
- octave_i_ += delta.octave_i_;
- notename_i_ += delta.notename_i_;
+ int o = octave_;
+ int n = notename_;
+ while (n < 0)
+ {
+ n += 7;
+ o --;
+ }
+
+ return (o + n / 7) * 24 + 2* diatonic_scale_semitones[n % 7] + (alteration_);
+}
+void
+Pitch::normalise ()
+{
+ int pitch = quartertone_pitch ();
+ while (notename_ >= 7)
+ {
+ notename_ -= 7;
+ octave_++;
+ alteration_ -= quartertone_pitch () - pitch;
+ }
+ while (notename_ < 0)
+ {
+ notename_ += 7;
+ octave_--;
+ alteration_ -= quartertone_pitch () - pitch;
+ }
+ while (alteration_ > DOUBLE_SHARP)
+ {
+ if (notename_ == 6)
+ {
+ notename_ = 0;
+ octave_++;
+ }
+ else
+ notename_++;
+
+ alteration_ = 0;
+ alteration_ -= quartertone_pitch () - pitch;
+ }
- while (notename_i_ >= 7)
+ while (alteration_ < DOUBLE_FLAT)
{
- notename_i_ -= 7;
- octave_i_ ++;
+ if (notename_ == 0)
+ {
+ notename_ = 6;
+ octave_--;
+ }
+ else
+ notename_--;
+
+ alteration_ = 0;
+ alteration_ -= quartertone_pitch () - pitch;
}
+}
+
+/* WHugh, wat een intervaas */
+void
+Pitch::transpose (Pitch delta)
+{
+ int new_semi = quartertone_pitch () +delta.quartertone_pitch();
+ octave_ += delta.octave_;
+ notename_ += delta.notename_;
+ alteration_ += new_semi - quartertone_pitch();
- int new_pitch = semitone_pitch ();
- int delta_acc = new_pitch - old_pitch - delta_pitch;
- alteration_i_ -= delta_acc;
+ normalise ();
}
+Pitch
+interval (Pitch const & from , Pitch const & to )
+{
+ int sound = to.quartertone_pitch() - from.quartertone_pitch ();
+ Pitch pt (to.get_octave () - from.get_octave (),
+ to.get_notename() - from.get_notename(),
+
+ to.get_alteration() - from.get_alteration());
+ return pt.transposed (Pitch(0,0,sound - pt.quartertone_pitch()));
+}
-/* FIXME */
-#if 0
-// nice test for internationalisation strings
-char const *accname[] = {"double flat", "flat", "natural",
- "sharp" , "double sharp"};
-#else
-char const *accname[] = {"eses", "es", "", "is" , "isis"};
-#endif
+/* FIXME
+ Merge with *pitch->text* funcs in chord-name.scm
+ */
+char const *accname[] = {"eses", "eseh", "es", "eh", "",
+ "ih", "is" , "isih", "isis"};
String
-Pitch::str () const
+Pitch::to_string () const
{
- int n = (notename_i_ + 2) % 7;
- String s = to_str (char(n + 'a'));
- if (alteration_i_)
- s += String (accname[alteration_i_ + 2]);
+ int n = (notename_ + 2) % 7;
+ String s = ::to_string (char (n + 'a'));
+ if (alteration_)
+ s += String (accname[alteration_ - DOUBLE_FLAT]);
- if (octave_i_ > 0)
+ if (octave_ >= 0)
{
- int o = octave_i_ + 1;
+ int o = octave_ + 1;
while (o--)
s += "'";
}
- else if (octave_i_ <0)
+ else if (octave_ < 0)
{
- int o = (-octave_i_) - 1;
+ int o = (-octave_) - 1;
while (o--)
- s += to_str (',');
+ s += ::to_string (',');
}
-
return s;
}
return copy of resulting pitch
*/
Pitch
-Pitch::to_relative_octave (Pitch p)
+Pitch::to_relative_octave (Pitch p) const
{
- int oct_mod = octave_i_ + 1; // account for c' = octave 1 iso. 0 4
+ int oct_mod = octave_ + 1; // account for c' = octave 1 iso. 0 4
Pitch up_pitch (p);
Pitch down_pitch (p);
- up_pitch.alteration_i_ = alteration_i_;
- down_pitch.alteration_i_ = alteration_i_;
+ up_pitch.alteration_ = alteration_;
+ down_pitch.alteration_ = alteration_;
Pitch n = *this;
- up_pitch.up_to (notename_i_);
- down_pitch.down_to (notename_i_);
+ up_pitch.up_to (notename_);
+ down_pitch.down_to (notename_);
int h = p.steps ();
if (abs (up_pitch.steps () - h) < abs (down_pitch.steps () - h))
else
n = down_pitch;
- n.octave_i_ += oct_mod;
-
- *this = n;
- return *this;
+ n.octave_ += oct_mod;
+ return n;
}
void
Pitch::up_to (int notename)
{
- if (notename_i_ > notename)
+ if (notename_ > notename)
{
- octave_i_ ++;
+ octave_ ++;
}
- notename_i_ = notename;
+ notename_ = notename;
}
void
Pitch::down_to (int notename)
{
- if (notename_i_ < notename)
+ if (notename_ < notename)
{
- octave_i_ --;
+ octave_ --;
}
- notename_i_ = notename;
+ notename_ = notename;
}
-
-///MAKE_SCHEME_CALLBACK (Pitch, transpose, 2);
-///transpose_proc?
-SCM
-Pitch::transpose (SCM p, SCM delta)
+
+LY_DEFINE(ly_pitch_transpose,
+ "ly:pitch-transpose", 2, 0, 0,
+ (SCM p, SCM delta),
+ "Transpose @var{p} by the amount @var{delta}, where @var{delta} is the "
+" pitch that central C is transposed to.")
{
- Pitch t = *unsmob_pitch (p);
- t.transpose (*unsmob_pitch (delta));
- return t.smobbed_copy ();
-}
+ Pitch* t = unsmob_pitch (p);
+ Pitch *d = unsmob_pitch (delta);
+ SCM_ASSERT_TYPE(t, p, SCM_ARG1, __FUNCTION__, "pitch") ;
+ SCM_ASSERT_TYPE(d, delta, SCM_ARG1, __FUNCTION__, "pitch") ;
-static SCM
-pitch_transpose (SCM p, SCM delta)
-{
- return Pitch::transpose (p, delta);
+ return t->transposed (*d).smobbed_copy ();
}
/****************************************************************/
-IMPLEMENT_TYPE_P(Pitch, "pitch?");
-IMPLEMENT_UNSMOB(Pitch, pitch);
+IMPLEMENT_TYPE_P (Pitch, "ly:pitch?");
+
SCM
-Pitch::mark_smob (SCM )
+Pitch::mark_smob (SCM)
{
return SCM_EOL;
}
-IMPLEMENT_SIMPLE_SMOBS(Pitch);
-
-
+IMPLEMENT_SIMPLE_SMOBS (Pitch);
int
Pitch::print_smob (SCM s, SCM port, scm_print_state *)
{
- Pitch *r = (Pitch *) gh_cdr (s);
+ Pitch *r = (Pitch *) ly_cdr (s);
scm_puts ("#<Pitch ", port);
- scm_display (gh_str02scm ((char*)r->str().ch_C()), port);
+ scm_display (scm_makfrom0str (r->to_string ().to_str0 ()), port);
scm_puts (" >", port);
return 1;
SCM
Pitch::equal_p (SCM a , SCM b)
{
- Pitch *p = (Pitch *) gh_cdr (a);
- Pitch *q = (Pitch *) gh_cdr (b);
+ Pitch *p = (Pitch *) ly_cdr (a);
+ Pitch *q = (Pitch *) ly_cdr (b);
- bool eq = p->notename_i_ == q->notename_i_
- && p->octave_i_ == q->octave_i_
- && p->alteration_i_ == q->alteration_i_;
+ bool eq = p->notename_ == q->notename_
+ && p->octave_ == q->octave_
+ && p->alteration_ == q->alteration_;
return eq ? SCM_BOOL_T : SCM_BOOL_F;
}
-MAKE_SCHEME_CALLBACK(Pitch, less_p, 2);
+MAKE_SCHEME_CALLBACK (Pitch, less_p, 2);
SCM
Pitch::less_p (SCM p1, SCM p2)
{
Pitch *a = unsmob_pitch (p1);
Pitch *b = unsmob_pitch (p2);
- if (compare(*a, *b) < 0 )
+ if (compare (*a, *b) < 0)
return SCM_BOOL_T;
else
return SCM_BOOL_F;
should add optional args
*/
-static SCM
-make_pitch (SCM o, SCM n, SCM a)
+LY_DEFINE(make_pitch, "ly:make-pitch", 3, 0, 0,
+ (SCM o, SCM n, SCM a),
+ "@var{octave} is specified by an integer, zero for the octave containing "
+ "middle C. @var{note} is a number from 0 to 6, with 0 corresponding to C "
+ "and 6 corresponding to B. The shift is zero for a natural, negative for "
+ "flats, or positive for sharps. ")
{
- Pitch p;
- p.octave_i_ = gh_scm2int (o);
- p.notename_i_ = gh_scm2int (n);
- p.alteration_i_ = gh_scm2int (a);
+ SCM_ASSERT_TYPE(gh_number_p (o), o, SCM_ARG1, __FUNCTION__, "number");
+ SCM_ASSERT_TYPE(gh_number_p (n), n, SCM_ARG2, __FUNCTION__, "number");
+ SCM_ASSERT_TYPE(gh_number_p (a), a, SCM_ARG3, __FUNCTION__, "number");
+
+ Pitch p (gh_scm2int (o), gh_scm2int (n), gh_scm2int (a));
return p.smobbed_copy ();
}
-static SCM
-pitch_octave (SCM pp)
+LY_DEFINE(pitch_steps, "ly:pitch-steps", 1, 0,0,
+ (SCM p),
+ "Number of steps counted from central C of the pitch @var{p}.")
+{
+ Pitch *pp = unsmob_pitch (p);
+ SCM_ASSERT_TYPE(pp, p, SCM_ARG1, __FUNCTION__, "Pitch");
+
+ return gh_int2scm (pp->steps());
+}
+
+LY_DEFINE(pitch_octave, "ly:pitch-octave", 1, 0, 0,
+ (SCM pp),
+ "extract the octave from pitch @var{p}.")
{
Pitch *p = unsmob_pitch (pp);
- int q = 0;
- if (!p)
- warning ("Not a pitch");
- else
- q = p->octave_i();
+ SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
+ int q = p->get_octave ();
return gh_int2scm (q);
}
-static SCM
-pitch_alteration (SCM pp)
+LY_DEFINE(pitch_alteration, "ly:pitch-alteration", 1, 0, 0,
+ (SCM pp),
+ "extract the alteration from pitch @var{p}.")
{
Pitch *p = unsmob_pitch (pp);
- int q = 0;
- if (!p)
- warning ("Not a pitch");
- else
- q = p->alteration_i();
+ SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
+ int q = p->get_alteration ();
return gh_int2scm (q);
}
-static SCM
-pitch_notename (SCM pp)
+LY_DEFINE(pitch_notename, "ly:pitch-notename", 1, 0, 0,
+ (SCM pp),
+ "extract the note name from pitch @var{pp}.")
{
Pitch *p = unsmob_pitch (pp);
- int q = 0;
- if (!p)
- warning ("Not a pitch");
- else
- q = p->notename_i();
+ SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
+ int q = p->get_notename ();
return gh_int2scm (q);
}
-static SCM
-pitch_semitones (SCM pp)
+LY_DEFINE(ly_pitch_quartertones, "ly:pitch-quartertones", 1, 0, 0,
+ (SCM pp),
+ "calculate the number of semitones of @var{p} from central C.")
{
Pitch *p = unsmob_pitch (pp);
- int q = 0;
- if (!p)
- warning ("Not a pitch");
- else
- q = p->steps();
+ SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
+
+ int q = p->quartertone_pitch ();
+
+ return gh_int2scm (q);
+}
+LY_DEFINE(ly_pitch_semitones, "ly:pitch-semitones", 1, 0, 0,
+ (SCM pp),
+ "calculate the number of semitones of @var{p} from central C.")
+{
+ Pitch *p = unsmob_pitch (pp);
+ SCM_ASSERT_TYPE(p, pp, SCM_ARG1, __FUNCTION__, "Pitch");
+
+ int q = p->semitone_pitch ();
+
return gh_int2scm (q);
}
-static void
-add_funcs()
+LY_DEFINE(pitch_less, "ly:pitch<?", 2,0,0, (SCM p1, SCM p2),
+ "Is @var{p1} lower than @var{p2}? This uses lexicographic ordening.")
{
- // should take list?: (make-pitch '(octave name accidental))
- scm_make_gsubr ("make-pitch", 3, 0, 0, (Scheme_function_unknown)make_pitch);
+ Pitch *a = unsmob_pitch (p1);
+ Pitch *b = unsmob_pitch (p2);
+
+ SCM_ASSERT_TYPE(a, p1, SCM_ARG1, __FUNCTION__, "Pitch");
+ SCM_ASSERT_TYPE(b, p2, SCM_ARG2, __FUNCTION__, "Pitch");
- scm_make_gsubr ("pitch-octave", 1, 0, 0, (Scheme_function_unknown)pitch_octave);
- scm_make_gsubr ("pitch-notename", 1, 0, 0, (Scheme_function_unknown)pitch_notename);
- scm_make_gsubr ("pitch-alteration", 1, 0, 0, (Scheme_function_unknown)pitch_alteration);
- scm_make_gsubr ("pitch-semitones", 1, 0, 0, (Scheme_function_unknown)pitch_semitones);
- scm_make_gsubr ("Pitch::transpose", 2, 0, 0, (Scheme_function_unknown) pitch_transpose);
+ if (Pitch::compare (*a, *b) < 0)
+ return SCM_BOOL_T;
+ else
+ return SCM_BOOL_F;
}
-ADD_SCM_INIT_FUNC(pitch, add_funcs);
+LY_DEFINE(ly_pitch_diff, "ly:pitch-diff", 2 ,0 ,0,
+ (SCM pitch, SCM root),
+ "Return pitch with value DELTA = PITCH - ROOT, ie, "
+ "ROOT == (ly:pitch-transpose root delta).")
+{
+ Pitch *p = unsmob_pitch (pitch);
+ Pitch *r = unsmob_pitch (root);
+ SCM_ASSERT_TYPE(p, pitch, SCM_ARG1, __FUNCTION__, "Pitch");
+ SCM_ASSERT_TYPE(r, root, SCM_ARG2, __FUNCTION__, "Pitch");
+
+ return interval (*r, *p).smobbed_copy();
+}
SCM
Pitch::smobbed_copy ()const
}
int
-Pitch::octave_i ()const
+Pitch::get_octave ()const
{
- return octave_i_;
+ return octave_;
}
int
-Pitch::notename_i () const
+Pitch::get_notename () const
{
- return notename_i_;
+ return notename_;
}
int
-Pitch::alteration_i () const
+Pitch::get_alteration () const
+{
+ return alteration_;
+}
+
+Pitch
+Pitch::transposed (Pitch d) const
{
- return alteration_i_;
+ Pitch p =*this;
+ p.transpose (d);
+ return p;
}