lily/music.cc

   1 /*
   2   music.cc -- implement Music
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "music.hh"
  10
  11 #include "duration.hh"
  12 #include "input-smob.hh"
  13 #include "ly-smobs.icc"
  14 #include "main.hh"
  15 #include "music-list.hh"
  16 #include "pitch.hh"
  17 #include "score.hh"
  18 #include "warn.hh"
  19
  20 bool
  21 Music::internal_is_music_type (SCM k) const
  22 {
  23   SCM ifs = get_property ("types");
  24
  25   return scm_c_memq (k, ifs) != SCM_BOOL_F;
  26 }
  27
  28 String
  29 Music::name () const
  30 {
  31   SCM nm = get_property ("name");
  32   if (scm_is_symbol (nm))
  33     {
  34       return ly_symbol2string (nm);
  35     }
  36   else
  37     {
  38       return classname (this);
  39     }
  40 }
  41
  42 Music::Music ()
  43 {
  44   self_scm_ = SCM_EOL;
  45   immutable_property_alist_ = SCM_EOL;
  46   mutable_property_alist_ = SCM_EOL;
  47   smobify_self ();
  48 }
  49
  50 Music::Music (Music const &m)
  51 {
  52   immutable_property_alist_ = m.immutable_property_alist_;
  53   mutable_property_alist_ = SCM_EOL;
  54   self_scm_ = SCM_EOL;
  55
  56   /* First we smobify_self, then we copy over the stuff.  If we don't,
  57      stack vars that hold the copy might be optimized away, meaning
  58      that they won't be protected from GC. */
  59   smobify_self ();
  60   mutable_property_alist_ = ly_music_deep_copy (m.mutable_property_alist_);
  61   set_spot (*m.origin ());
  62 }
  63
  64 Music::~Music ()
  65 {
  66 }
  67
  68 ADD_MUSIC (Music);
  69
  70 SCM
  71 Music::get_property_alist (bool m) const
  72 {
  73   return (m) ? mutable_property_alist_ : immutable_property_alist_;
  74 }
  75
  76 SCM
  77 Music::mark_smob (SCM m)
  78 {
  79   Music *mus = (Music*) SCM_CELL_WORD_1 (m);
  80   scm_gc_mark (mus->immutable_property_alist_);
  81   scm_gc_mark (mus->mutable_property_alist_);
  82   return SCM_EOL;
  83 }
  84
  85 Moment
  86 Music::get_length () const
  87 {
  88   SCM lst = get_property ("length");
  89   if (unsmob_moment (lst))
  90     return *unsmob_moment (lst);
  91   else if (ly_c_procedure_p (lst))
  92     {
  93       SCM res = scm_call_1 (lst, self_scm ());
  94       return *unsmob_moment (res);
  95     }
  96
  97   return 0;
  98 }
  99
 100 Moment
 101 Music::start_mom () const
 102 {
 103   SCM lst = get_property ("start-moment-function");
 104   if (ly_c_procedure_p (lst))
 105     {
 106       SCM res = scm_call_1 (lst, self_scm ());
 107       return *unsmob_moment (res);
 108     }
 109
 110   Moment m;
 111   return m;
 112 }
 113
 114 void
 115 print_alist (SCM a, SCM port)
 116 {
 117   /* SCM_EOL  -> catch malformed lists.  */
 118   for (SCM s = a; scm_is_pair (s); s = scm_cdr (s))
 119     {
 120       scm_display (scm_caar (s), port);
 121       scm_puts (" = ", port);
 122       scm_write (scm_cdar (s), port);
 123       scm_puts ("\n", port);
 124     }
 125 }
 126
 127 int
 128 Music::print_smob (SCM s, SCM p, scm_print_state*)
 129 {
 130   scm_puts ("#<Music ", p);
 131   Music* m = unsmob_music (s);
 132
 133   SCM nm = m->get_property ("name");
 134   if (scm_is_symbol (nm) || scm_is_string (nm))
 135     scm_display (nm, p);
 136   else
 137     scm_puts (classname (m),p);
 138
 139   /* Printing properties takes a lot of time, especially during backtraces.
 140      For inspecting, it is better to explicitly use an inspection
 141      function.  */
 142
 143   scm_puts (">",p);
 144   return 1;
 145 }
 146
 147 Pitch
 148 Music::to_relative_octave (Pitch p)
 149 {
 150   SCM elt = get_property ("element");
 151
 152   if (Music *m = unsmob_music (elt))
 153     p = m->to_relative_octave (p);
 154
 155   p = music_list_to_relative (get_property ("elements"), p, false);
 156   return p;
 157 }
 158
 159 void
 160 Music::compress (Moment factor)
 161 {
 162   SCM elt = get_property ("element");
 163
 164   if (Music *m = unsmob_music (elt))
 165     m->compress (factor);
 166
 167   compress_music_list (get_property ("elements"), factor);
 168 }
 169
 170 void
 171 Music::transpose (Pitch delta)
 172 {
 173   for (SCM s = this->get_property_alist (true); scm_is_pair (s); s = scm_cdr (s))
 174     {
 175       SCM entry = scm_car (s);
 176       SCM val = scm_cdr (entry);
 177
 178       if (Pitch * p = unsmob_pitch (val))
 179         {
 180           Pitch transposed =  p->transposed (delta);
 181           scm_set_cdr_x (entry, transposed.smobbed_copy ());
 182
 183           if (abs (transposed.get_alteration ()) > DOUBLE_SHARP)
 184             {
 185               warning (_f ("Transposition by %s makes alteration larger than two",
 186                            delta.to_string ()));
 187             }
 188         }
 189     }
 190
 191   SCM elt = get_property ("element");
 192
 193   if (Music* m = unsmob_music (elt))
 194     m->transpose (delta);
 195
 196   transpose_music_list (get_property ("elements"), delta);
 197 }
 198
 199 IMPLEMENT_TYPE_P (Music, "ly:music?");
 200 IMPLEMENT_SMOBS (Music);
 201 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 202
 203 SCM
 204 Music::internal_get_property (SCM sym) const
 205 {
 206   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
 207   if (s != SCM_BOOL_F)
 208     return scm_cdr (s);
 209
 210   s = scm_sloppy_assq (sym, immutable_property_alist_);
 211   return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
 212 }
 213
 214 void
 215 Music::internal_set_property (SCM s, SCM v)
 216 {
 217   if (internal_type_checking_global_b)
 218     if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
 219       abort ();
 220
 221   mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
 222 }
 223
 224 void
 225 Music::set_spot (Input ip)
 226 {
 227   set_property ("origin", make_input (ip));
 228 }
 229
 230 Input*
 231 Music::origin () const
 232 {
 233   Input *ip = unsmob_input (get_property ("origin"));
 234   return ip ? ip : & dummy_input_global;
 235 }
 236
 237 int
 238 Music::duration_log () const
 239 {
 240   if (is_mus_type ("rhythmic-event"))
 241     return unsmob_duration (get_property ("duration"))->duration_log ();
 242   return 0;
 243 }
 244
 245 Music*
 246 make_music_by_name (SCM sym)
 247 {
 248   SCM make_music_proc = ly_lily_module_constant ("make-music");
 249   SCM rv = scm_call_1 (make_music_proc, sym);
 250
 251   /* UGH. */
 252   scm_gc_protect_object (rv);
 253   return unsmob_music (rv);
 254 }
 255
 256 LY_DEFINE (ly_music_length, "ly:music-length",
 257            1, 0, 0, (SCM mus),
 258           "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
 259 {
 260   Music *sc = unsmob_music (mus);
 261   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 262   return sc->get_length ().smobbed_copy ();
 263 }
 264
 265 LY_DEFINE (ly_music_property,
 266           "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
 267           "Get the property @var{sym} of music expression @var{mus}.\n"
 268           "If @var{sym} is undefined, return @code{' ()}.\n" )
 269 {
 270   Music * sc = unsmob_music (mus);
 271   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 272   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 273
 274   return sc->internal_get_property (sym);
 275 }
 276
 277 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
 278           3, 0, 0, (SCM mus, SCM sym, SCM val),
 279           "Set property @var{sym} in music expression @var{mus} to @var{val}.")
 280 {
 281   Music * sc = unsmob_music (mus);
 282   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
 283   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 284
 285   bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
 286   if (ok)
 287     {
 288       sc->internal_set_property (sym, val);
 289     }
 290
 291   return SCM_UNSPECIFIED;
 292 }
 293
 294 LY_DEFINE (ly_music_name, "ly:music-name",
 295            1, 0, 0, (SCM mus),
 296            "Return the name of @var{music}.")
 297 {
 298   Music *m = unsmob_music (mus);
 299   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ ,"music");
 300
 301   char const *nm = classname (m);
 302   return scm_makfrom0str (nm);
 303 }
 304
 305 /* todo:  property args */
 306 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
 307            2, 0, 0, (SCM type, SCM props),
 308           "Make a C++ music object of type @var{type}, initialize with\n"
 309           "@var{props}. \n\n"
 310           ""
 311           "This function is for internal use, and is only called by "
 312           "@code{make-music}, which is the preferred interface "
 313           "for creating music objects. "
 314           )
 315 {
 316   SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
 317   SCM s = make_music (ly_scm2string (type))->self_scm ();
 318   unsmob_music (s)->immutable_property_alist_ = props;
 319   scm_gc_unprotect_object (s);
 320   return s;
 321 }
 322
 323 /* todo: property args */
 324 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
 325           1, 0, 0, (SCM mus),
 326           "Return an alist containing the mutable properties of @var{mus}.\n"
 327           "The immutable properties are not available, since "
 328           "they are constant and initialized by the "
 329            "@code{make-music} function.\n")
 330 {
 331   Music *m = unsmob_music (mus);
 332   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
 333   return m->get_property_alist (true);
 334 }
 335
 336 LY_DEFINE (ly_music_list_p,"ly:music-list?",
 337            1, 0, 0, (SCM lst),
 338            "Type predicate: return true if @var{lst} is a list "
 339            "of music objects.")
 340 {
 341   if (scm_list_p (lst) == SCM_BOOL_T)
 342     while (scm_is_pair (lst))
 343       {
 344         if (!unsmob_music (scm_car (lst)))
 345           return SCM_BOOL_F;
 346         lst = scm_cdr (lst);
 347       }
 348
 349   return SCM_BOOL_T;
 350 }
 351
 352 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
 353           1, 0, 0, (SCM m),
 354           "Copy @var{m} and all sub expressions of @var{m}")
 355 {
 356   SCM copy = m;
 357   if (unsmob_music (m))
 358     {
 359       copy = unsmob_music (m)->clone ()->self_scm ();
 360       scm_gc_unprotect_object (copy);
 361     }
 362   else if (scm_is_pair (m))
 363     copy = scm_cons (ly_music_deep_copy (scm_car (m)),
 364                     ly_music_deep_copy (scm_cdr (m)));
 365   return copy;
 366 }
 367
 368 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
 369           2, 0, 0, (SCM m, SCM p),
 370           "Transpose @var{m} such that central C is mapped to @var{p}. "
 371           "Return @var{m}.")
 372 {
 373   Music * sc = unsmob_music (m);
 374   Pitch * sp = unsmob_pitch (p);
 375   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 376   SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
 377
 378   sc->transpose (*sp);
 379   // SCM_UNDEFINED ?
 380   return sc->self_scm ();
 381 }
 382
 383 /*
 384   TODO: should take moment factor?
 385  */
 386 LY_DEFINE (ly_music_compress, "ly:music-compress",
 387           2, 0, 0, (SCM m, SCM factor),
 388           "Compress music object @var{m} by moment @var{factor}."
 389            )
 390 {
 391   Music * sc = unsmob_music (m);
 392
 393   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 394   SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
 395
 396   sc->compress (*unsmob_moment (factor));
 397   return sc->self_scm ();
 398 }
 399
 400 LY_DEFINE (ly_music_scorify, "ly:music-scorify",
 401            2, 0, 0,
 402            (SCM music, SCM parser),
 403            "Return MUSIC encapsulated in SCORE.")
 404 {
 405 #if 0
 406   SCM_ASSERT_TYPE (ly_c_music_p (music), music, SCM_ARG1, __FUNCTION__, "music");
 407 #endif
 408   Score *score = new Score;
 409
 410   score->set_music (music, parser);
 411
 412   scm_gc_unprotect_object (score->self_scm ());
 413   return score->self_scm ();
 414 }