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