lily/music-scheme.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "music.hh"
  21
  22 #include "duration.hh"
  23 #include "program-option.hh"
  24 #include "warn.hh"
  25
  26 LY_DEFINE (ly_music_length, "ly:music-length",
  27            1, 0, 0, (SCM mus),
  28            "Get the length of music expression @var{mus} and return"
  29            " it as a @code{Moment} object.")
  30 {
  31   LY_ASSERT_TYPE (unsmob_music, mus, 1);
  32   Music *sc = unsmob_music (mus);
  33   return sc->get_length ().smobbed_copy ();
  34 }
  35
  36 LY_DEFINE (ly_music_property, "ly:music-property",
  37            2, 1, 0, (SCM mus, SCM sym, SCM val),
  38            "Return the value for property @var{sym} of music expression"
  39            " @var{mus}.  If no value is found, return @var{val} or"
  40            " @code{'()} if @var{val} is not specified.")
  41 {
  42   LY_ASSERT_TYPE (unsmob_music, mus, 1);
  43   return ly_prob_property (mus, sym, val);
  44 }
  45
  46 LY_DEFINE (ly_music_set_property_x, "ly:music-set-property!",
  47            3, 0, 0, (SCM mus, SCM sym, SCM val),
  48            "Set property @var{sym} in music expression @var{mus} to"
  49            " @var{val}.")
  50 {
  51   LY_ASSERT_TYPE (unsmob_music, mus, 1);
  52
  53   return ly_prob_set_property_x (mus, sym, val);
  54 }
  55
  56 /* todo:  property args */
  57 LY_DEFINE (ly_make_music, "ly:make-music",
  58            1, 0, 0, (SCM props),
  59            "Make a C++ @code{Music} object and initialize it with"
  60            " @var{props}.\n"
  61            "\n"
  62            "This function is for internal use and is only called by"
  63            " @code{make-music}, which is the preferred interface"
  64            " for creating music objects.")
  65 {
  66   Music *ms = new Music (props);
  67   return ms->unprotect ();
  68 }
  69
  70 LY_DEFINE (ly_music_p, "ly:music?",
  71            1, 0, 0, (SCM obj),
  72            "Is @var{obj} a music object?")
  73 {
  74   return scm_from_bool (unsmob_music (obj));
  75 }
  76
  77 LY_DEFINE (ly_event_p, "ly:event?",
  78            1, 0, 0, (SCM obj),
  79            "Is @var{obj} an event object?")
  80 {
  81   if (Music *m = unsmob_music (obj))
  82     {
  83       return scm_from_bool (m->is_mus_type ("event"));
  84     }
  85   return SCM_BOOL_F;
  86 }
  87
  88 /* todo: property args */
  89 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
  90            1, 0, 0, (SCM mus),
  91            "Return an alist containing the mutable properties of @var{mus}."
  92            "  The immutable properties are not available, since they are"
  93            " constant and initialized by the @code{make-music} function.")
  94 {
  95   LY_ASSERT_TYPE (unsmob_music, mus, 1);
  96   Music *m = unsmob_music (mus);
  97   return m->get_property_alist (true);
  98 }
  99
 100 LY_DEFINE (ly_music_list_p, "ly:music-list?",
 101            1, 0, 0, (SCM lst),
 102            "Is @var{lst} a list of music objects?")
 103 {
 104   if (scm_list_p (lst) == SCM_BOOL_T)
 105     while (scm_is_pair (lst))
 106       {
 107         if (!unsmob_music (scm_car (lst)))
 108           return SCM_BOOL_F;
 109         lst = scm_cdr (lst);
 110       }
 111
 112   return SCM_BOOL_T;
 113 }
 114
 115 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
 116            1, 0, 0, (SCM m),
 117            "Copy @var{m} and all sub expressions of@tie{}@var{m}.")
 118 {
 119   SCM copy = m;
 120   if (unsmob_music (m))
 121     {
 122       Music *mcopy = unsmob_music (m)->clone ();
 123       copy = mcopy->unprotect ();
 124     }
 125   else if (scm_is_pair (m))
 126     copy = scm_cons (ly_music_deep_copy (scm_car (m)),
 127                      ly_music_deep_copy (scm_cdr (m)));
 128   return copy;
 129 }
 130
 131 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
 132            2, 0, 0, (SCM m, SCM p),
 133            "Transpose @var{m} such that central@tie{}C is mapped"
 134            " to@tie{}@var{p}.  Return@tie{}@var{m}.")
 135 {
 136   LY_ASSERT_TYPE (unsmob_music, m, 1);
 137   LY_ASSERT_SMOB (Pitch, p, 2);
 138
 139   Music *sc = unsmob_music (m);
 140   Pitch *sp = unsmob_pitch (p);
 141
 142   sc->transpose (*sp);
 143   // SCM_UNDEFINED ?
 144   return sc->self_scm ();
 145 }
 146
 147 /*
 148   TODO: should take moment factor?
 149 */
 150 LY_DEFINE (ly_music_compress, "ly:music-compress",
 151            2, 0, 0, (SCM m, SCM factor),
 152            "Compress music object@tie{}@var{m} by moment @var{factor}.")
 153 {
 154   LY_ASSERT_TYPE (unsmob_music, m, 1);
 155   LY_ASSERT_TYPE (unsmob_moment, factor, 2);
 156
 157   Music *sc = unsmob_music (m);
 158   sc->compress (*unsmob_moment (factor));
 159   return sc->self_scm ();
 160 }
 161
 162 LY_DEFINE (ly_make_music_relative_x, "ly:make-music-relative!",
 163            2, 0, 0, (SCM music, SCM pitch),
 164            "Make @var{music} relative to @var{pitch},"
 165            " return final pitch.")
 166 {
 167   LY_ASSERT_TYPE (unsmob_music, music, 1);
 168   LY_ASSERT_TYPE (unsmob_pitch, pitch, 2);
 169
 170   Pitch start = *unsmob_pitch (pitch);
 171   Music *m = unsmob_music (music);
 172   Pitch last = m->to_relative_octave (start);
 173   if (lily_1_8_relative)
 174     m->set_property ("last-pitch", last.smobbed_copy ());
 175
 176   return last.smobbed_copy ();
 177 }
 178
 179 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
 180            (SCM mus),
 181            "Extract the duration field from @var{mus} and return the"
 182            " length.")
 183 {
 184   LY_ASSERT_TYPE (unsmob_music, mus, 1);
 185   Music *m = unsmob_music (mus);
 186
 187   Duration *d = unsmob_duration (m->get_property ("duration"));
 188   Moment len;
 189
 190   if (d)
 191     len = d->get_length ();
 192   else
 193     programming_error ("music has no duration");
 194   return len.smobbed_copy ();
 195 }
 196
 197 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
 198            (SCM mus, SCM fact),
 199            "Compress @var{mus} by factor @var{fact}, which is a"
 200            " @code{Moment}.")
 201 {
 202   LY_ASSERT_TYPE (unsmob_music, mus, 1);
 203   LY_ASSERT_SMOB (Moment, fact, 2);
 204
 205   Music *m = unsmob_music (mus);
 206   Moment *f = unsmob_moment (fact);
 207
 208   Duration *d = unsmob_duration (m->get_property ("duration"));
 209   if (d)
 210     m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
 211   return SCM_UNSPECIFIED;
 212 }
 213
 214 /*
 215   This is hairy, since the scale in a key-change event may contain
 216   octaveless notes.
 217
 218
 219   TODO: this should use ly:pitch.
 220 */
 221 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
 222            2, 0, 0, (SCM l, SCM pit),
 223            "Make a new key alist of@tie{}@var{l} transposed by"
 224            " pitch @var{pit}.")
 225 {
 226   SCM newlist = SCM_EOL;
 227   Pitch *p = unsmob_pitch (pit);
 228
 229   for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
 230     {
 231       SCM key = scm_caar (s);
 232       SCM alter = scm_cdar (s);
 233       if (scm_is_pair (key))
 234         {
 235           Pitch orig (scm_to_int (scm_car (key)),
 236                       scm_to_int (scm_cdr (key)),
 237                       ly_scm2rational (alter));
 238
 239           orig = orig.transposed (*p);
 240
 241           SCM key = scm_cons (scm_from_int (orig.get_octave ()),
 242                               scm_from_int (orig.get_notename ()));
 243
 244           newlist = scm_cons (scm_cons (key, ly_rational2scm (orig.get_alteration ())),
 245                               newlist);
 246         }
 247       else if (scm_is_number (key))
 248         {
 249           Pitch orig (0, scm_to_int (key), ly_scm2rational (alter));
 250           orig = orig.transposed (*p);
 251
 252           key = scm_from_int (orig.get_notename ());
 253           alter = ly_rational2scm (orig.get_alteration ());
 254           newlist = scm_cons (scm_cons (key, alter), newlist);
 255         }
 256     }
 257   return scm_reverse_x (newlist, SCM_EOL);
 258 }
 259