lily/music-scheme.cc

   1 /*
   2   music-scheme.cc -- implement Music bindings
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "duration.hh"
  10 #include "warn.hh"
  11 #include "music.hh"
  12 #include "pitch.hh"
  13
  14 LY_DEFINE (ly_music_length, "ly:music-length",
  15            1, 0, 0, (SCM mus),
  16            "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
  17 {
  18   Music *sc = unsmob_music (mus);
  19   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  20   return sc->get_length ().smobbed_copy ();
  21 }
  22
  23 LY_DEFINE (ly_music_property,
  24            "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
  25            "Get the property @var{sym} of music expression @var{mus}.\n"
  26            "If @var{sym} is undefined, return @code{' ()}.\n")
  27 {
  28   Music *sc = unsmob_music (mus);
  29   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  30   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  31
  32   return sc->internal_get_property (sym);
  33 }
  34
  35 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
  36            3, 0, 0, (SCM mus, SCM sym, SCM val),
  37            "Set property @var{sym} in music expression @var{mus} to @var{val}.")
  38 {
  39   Music *sc = unsmob_music (mus);
  40   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  41   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  42
  43   bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
  44   if (ok)
  45     {
  46       sc->internal_set_property (sym, val);
  47     }
  48
  49   return SCM_UNSPECIFIED;
  50 }
  51
  52 LY_DEFINE (ly_music_name, "ly:music-name",
  53            1, 0, 0, (SCM mus),
  54            "Return the name of @var{music}.")
  55 {
  56   Music *m = unsmob_music (mus);
  57   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
  58
  59   char const *nm = classname (m);
  60   return scm_makfrom0str (nm);
  61 }
  62
  63 /* todo:  property args */
  64 LY_DEFINE (ly_make_music, "ly:make-music",
  65            1, 0, 0, (SCM props),
  66            "Make a C++ Music object, initialize with\n"
  67            "@var{props}. \n\n"
  68            ""
  69            "This function is for internal use, and is only called by "
  70            "@code{make-music}, which is the preferred interface "
  71            "for creating music objects. ")
  72 {
  73   Music *ms = new Music (props);
  74   return ms->unprotect ();
  75 }
  76
  77 /* todo: property args */
  78 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
  79            1, 0, 0, (SCM mus),
  80            "Return an alist containing the mutable properties of @var{mus}.\n"
  81            "The immutable properties are not available, since "
  82            "they are constant and initialized by the "
  83            "@code{make-music} function.\n")
  84 {
  85   Music *m = unsmob_music (mus);
  86   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
  87   return m->get_property_alist (true);
  88 }
  89
  90 LY_DEFINE (ly_music_list_p, "ly:music-list?",
  91            1, 0, 0, (SCM lst),
  92            "Type predicate: return true if @var{lst} is a list "
  93            "of music objects.")
  94 {
  95   if (scm_list_p (lst) == SCM_BOOL_T)
  96     while (scm_is_pair (lst))
  97       {
  98         if (!unsmob_music (scm_car (lst)))
  99           return SCM_BOOL_F;
 100         lst = scm_cdr (lst);
 101       }
 102
 103   return SCM_BOOL_T;
 104 }
 105
 106 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
 107            1, 0, 0, (SCM m),
 108            "Copy @var{m} and all sub expressions of @var{m}")
 109 {
 110   SCM copy = m;
 111   if (unsmob_music (m))
 112     {
 113       Music *mcopy = unsmob_music (m)->clone ();
 114       copy = mcopy->unprotect ();
 115     }
 116   else if (scm_is_pair (m))
 117     copy = scm_cons (ly_music_deep_copy (scm_car (m)),
 118                      ly_music_deep_copy (scm_cdr (m)));
 119   return copy;
 120 }
 121
 122 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
 123            2, 0, 0, (SCM m, SCM p),
 124            "Transpose @var{m} such that central C is mapped to @var{p}. "
 125            "Return @var{m}.")
 126 {
 127   Music *sc = unsmob_music (m);
 128   Pitch *sp = unsmob_pitch (p);
 129   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 130   SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
 131
 132   sc->transpose (*sp);
 133   // SCM_UNDEFINED ?
 134   return sc->self_scm ();
 135 }
 136
 137 /*
 138   TODO: should take moment factor?
 139 */
 140 LY_DEFINE (ly_music_compress, "ly:music-compress",
 141            2, 0, 0, (SCM m, SCM factor),
 142            "Compress music object @var{m} by moment @var{factor}.")
 143 {
 144   Music *sc = unsmob_music (m);
 145
 146   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 147   SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
 148
 149   sc->compress (*unsmob_moment (factor));
 150   return sc->self_scm ();
 151 }
 152
 153 LY_DEFINE (ly_music_duration_length, "ly:music-duration-length", 1, 0, 0,
 154            (SCM mus),
 155            "Extract the duration field from @var{mus}, and return the length.")
 156 {
 157   Music *m = unsmob_music (mus);
 158   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
 159
 160   Duration *d = unsmob_duration (m->get_property ("duration"));
 161   Moment len;
 162
 163   if (d)
 164     len = d->get_length ();
 165   else
 166     programming_error ("music has no duration");
 167   return len.smobbed_copy ();
 168 }
 169
 170 LY_DEFINE (ly_music_duration_compress, "ly:music-duration-compress", 2, 0, 0,
 171            (SCM mus, SCM fact),
 172            "Compress @var{mus} by factor @var{fact}, which is a @code{Moment}.")
 173 {
 174   Music *m = unsmob_music (mus);
 175   Moment *f = unsmob_moment (fact);
 176   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "Music");
 177   SCM_ASSERT_TYPE (f, fact, SCM_ARG2, __FUNCTION__, "Moment");
 178
 179   Duration *d = unsmob_duration (m->get_property ("duration"));
 180   if (d)
 181     m->set_property ("duration", d->compressed (f->main_part_).smobbed_copy ());
 182   return SCM_UNSPECIFIED;
 183 }
 184
 185 /*
 186   This is hairy, since the scale in a key-change event may contain
 187   octaveless notes.
 188
 189
 190   TODO: this should use ly:pitch.
 191 */
 192 LY_DEFINE (ly_transpose_key_alist, "ly:transpose-key-alist",
 193            2, 0, 0, (SCM l, SCM pit),
 194            "Make a new key alist of @var{l} transposed by pitch @var{pit}")
 195 {
 196   SCM newlist = SCM_EOL;
 197   Pitch *p = unsmob_pitch (pit);
 198
 199   for (SCM s = l; scm_is_pair (s); s = scm_cdr (s))
 200     {
 201       SCM key = scm_caar (s);
 202       SCM alter = scm_cdar (s);
 203       if (scm_is_pair (key))
 204         {
 205           Pitch orig (scm_to_int (scm_car (key)),
 206                       scm_to_int (scm_cdr (key)),
 207                       scm_to_int (alter));
 208
 209           orig = orig.transposed (*p);
 210
 211           SCM key = scm_cons (scm_from_int (orig.get_octave ()),
 212                               scm_from_int (orig.get_notename ()));
 213
 214           newlist = scm_cons (scm_cons (key, scm_from_int (orig.get_alteration ())),
 215                               newlist);
 216         }
 217       else if (scm_is_number (key))
 218         {
 219           Pitch orig (0, scm_to_int (key), scm_to_int (alter));
 220           orig = orig.transposed (*p);
 221
 222           key = scm_from_int (orig.get_notename ());
 223           alter = scm_from_int (orig.get_alteration ());
 224           newlist = scm_cons (scm_cons (key, alter), newlist);
 225         }
 226     }
 227   return scm_reverse_x (newlist, SCM_EOL);
 228 }