2 music-scheme.cc -- implement Music bindings
4 source file of the GNU LilyPond music typesetter
6 (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "duration.hh"
15 LY_DEFINE (ly_music_length, "ly:music-length",
17 "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
19 Music *sc = unsmob_music (mus);
20 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
21 return sc->get_length ().smobbed_copy ();
24 LY_DEFINE (ly_music_property,
25 "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
26 "Get the property @var{sym} of music expression @var{mus}.\n"
27 "If @var{sym} is undefined, return @code{' ()}.\n" )
29 Music * sc = unsmob_music (mus);
30 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
31 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
33 return sc->internal_get_property (sym);
36 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
37 3, 0, 0, (SCM mus, SCM sym, SCM val),
38 "Set property @var{sym} in music expression @var{mus} to @var{val}.")
40 Music * sc = unsmob_music (mus);
41 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
42 SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
44 bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
47 sc->internal_set_property (sym, val);
50 return SCM_UNSPECIFIED;
53 LY_DEFINE (ly_music_name, "ly:music-name",
55 "Return the name of @var{music}.")
57 Music *m = unsmob_music (mus);
58 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ , "music");
60 char const *nm = classname (m);
61 return scm_makfrom0str (nm);
64 /* todo: property args */
65 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
66 2, 0, 0, (SCM type, SCM props),
67 "Make a C++ music object of type @var{type}, initialize with\n"
70 "This function is for internal use, and is only called by "
71 "@code{make-music}, which is the preferred interface "
72 "for creating music objects. "
75 SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
76 SCM s = make_music (ly_scm2string (type), props)->self_scm ();
77 scm_gc_unprotect_object (s);
81 /* todo: property args */
82 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
84 "Return an alist containing the mutable properties of @var{mus}.\n"
85 "The immutable properties are not available, since "
86 "they are constant and initialized by the "
87 "@code{make-music} function.\n")
89 Music *m = unsmob_music (mus);
90 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
91 return m->get_property_alist (true);
94 LY_DEFINE (ly_music_list_p, "ly:music-list?",
96 "Type predicate: return true if @var{lst} is a list "
99 if (scm_list_p (lst) == SCM_BOOL_T)
100 while (scm_is_pair (lst))
102 if (!unsmob_music (scm_car (lst)))
110 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
112 "Copy @var{m} and all sub expressions of @var{m}")
115 if (unsmob_music (m))
117 copy = unsmob_music (m)->clone ()->self_scm ();
118 scm_gc_unprotect_object (copy);
120 else if (scm_is_pair (m))
121 copy = scm_cons (ly_music_deep_copy (scm_car (m)),
122 ly_music_deep_copy (scm_cdr (m)));
126 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
127 2, 0, 0, (SCM m, SCM p),
128 "Transpose @var{m} such that central C is mapped to @var{p}. "
131 Music * sc = unsmob_music (m);
132 Pitch * sp = unsmob_pitch (p);
133 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
134 SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
138 return sc->self_scm ();
142 TODO: should take moment factor?
144 LY_DEFINE (ly_music_compress, "ly:music-compress",
145 2, 0, 0, (SCM m, SCM factor),
146 "Compress music object @var{m} by moment @var{factor}."
149 Music * sc = unsmob_music (m);
151 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
152 SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
154 sc->compress (*unsmob_moment (factor));
155 return sc->self_scm ();
158 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
160 "Extract the duration field from @var{mus}, and return the length.")
162 Music* m = unsmob_music (mus);
163 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
165 Duration *d = unsmob_duration (m->get_property ("duration"));
171 l = d->get_length ();
174 programming_error ("Music has no duration");
175 return l.smobbed_copy ();
180 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
182 "Compress @var{mus} by factor @var{fact}, which is a @code{Moment}.")
184 Music* m = unsmob_music (mus);
185 Moment * f = unsmob_moment (fact);
186 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
187 SCM_ASSERT_TYPE (f, fact, SCM_ARG2, __FUNCTION__, "Moment");
189 Duration *d = unsmob_duration (m->get_property ("duration"));
191 m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
192 return SCM_UNSPECIFIED;
198 This is hairy, since the scale in a key-change event may contain
202 TODO: this should use ly:pitch.
204 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
205 2, 0, 0, (SCM l, SCM pit),
206 "Make a new key alist of @var{l} transposed by pitch @var{pit}")
208 SCM newlist = SCM_EOL;
209 Pitch *p = unsmob_pitch (pit);
211 for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
213 SCM key = scm_caar (s);
214 SCM alter = scm_cdar (s);
215 if (scm_is_pair (key))
217 Pitch orig (scm_to_int (scm_car (key)),
218 scm_to_int (scm_cdr (key)),
221 orig = orig.transposed (*p);
223 SCM key = scm_cons (scm_int2num (orig.get_octave ()),
224 scm_int2num (orig.get_notename ()));
226 newlist = scm_cons (scm_cons (key, scm_int2num (orig.get_alteration ())),
229 else if (scm_is_number (key))
231 Pitch orig (0, scm_to_int (key), scm_to_int (alter));
232 orig = orig.transposed (*p);
234 key = scm_int2num (orig.get_notename ());
235 alter = scm_int2num (orig.get_alteration ());
236 newlist = scm_cons (scm_cons (key, alter), newlist);
239 return scm_reverse_x (newlist, SCM_EOL);