lily/dynamic-engraver.cc

   1 /*
   2   dynamic-engraver.cc -- implement Dynamic_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8 #include "warn.hh"
   9 #include "dimensions.hh"
  10 #include "hairpin.hh"
  11 #include "event.hh"
  12 #include "paper-column.hh"
  13 #include "note-column.hh"
  14 #include "item.hh"
  15 #include "side-position-interface.hh"
  16 #include "engraver.hh"
  17 #include "group-interface.hh"
  18 #include "directional-element-interface.hh"
  19 #include "context.hh"
  20 #include "axis-group-interface.hh"
  21 #include "script.hh"
  22
  23 /*
  24   TODO:
  25
  26   * direction of text-dynamic-event if not equal to direction of
  27   line-spanner
  28
  29   - TODO: this engraver is too complicated. We should split it into
  30   the handling of the basic grobs and the  linespanner
  31
  32   - TODO: the line-spanner is not killed after the (de)crescs are
  33   finished.
  34
  35 */
  36
  37 /**
  38    print text & hairpin dynamics.
  39  */
  40 class Dynamic_engraver : public Engraver
  41 {
  42   Item * script_;
  43   Spanner * finished_cresc_;
  44   Spanner * cresc_;
  45
  46   Music* script_ev_;
  47
  48   Music * current_cresc_ev_;
  49   Drul_array<Music*> accepted_spanreqs_drul_;
  50
  51   Spanner* line_spanner_;
  52   Spanner* finished_line_spanner_;
  53
  54   Link_array<Note_column> pending_columns_;
  55   Link_array<Grob> pending_elements_;
  56
  57   void typeset_all ();
  58
  59   TRANSLATOR_DECLARATIONS (Dynamic_engraver);
  60
  61 protected:
  62   virtual void finalize ();
  63   virtual void acknowledge_grob (Grob_info);
  64   virtual bool try_music (Music *req);
  65   virtual void stop_translation_timestep ();
  66   virtual void process_music ();
  67 };
  68
  69
  70
  71
  72 Dynamic_engraver::Dynamic_engraver ()
  73 {
  74   script_ = 0;
  75   finished_cresc_ = 0;
  76   line_spanner_ = 0;
  77   finished_line_spanner_ = 0;
  78   current_cresc_ev_ = 0;
  79   cresc_ =0;
  80
  81   script_ev_ = 0;
  82   accepted_spanreqs_drul_[START] = 0;
  83   accepted_spanreqs_drul_[STOP] = 0;
  84 }
  85
  86 bool
  87 Dynamic_engraver::try_music (Music * m)
  88 {
  89   if (m->is_mus_type ("absolute-dynamic-event"))
  90     {
  91       /*
  92         TODO: probably broken.
  93       */
  94       script_ev_ = m;
  95       return true;
  96     }
  97   else if (m->is_mus_type ("decrescendo-event")
  98            || m->is_mus_type ("crescendo-event"))
  99     {
 100       Direction d = to_dir (m->get_property ("span-direction"));
 101
 102       accepted_spanreqs_drul_[d] = m;
 103       if (current_cresc_ev_ && d == START)
 104         accepted_spanreqs_drul_[STOP] = m;
 105       return true;
 106     }
 107   return false;
 108 }
 109
 110 void
 111 Dynamic_engraver::process_music ()
 112 {
 113   if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
 114     {
 115       if (!line_spanner_)
 116         {
 117           Music * rq = accepted_spanreqs_drul_[START];
 118           line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm (): SCM_EOL );
 119
 120           if (script_ev_)
 121             rq =  script_ev_;
 122         }
 123     }
 124
 125   /*
 126     During a (de)crescendo, pending event will not be cleared,
 127     and a line-spanner will always be created, as \< \! are already
 128     two events.
 129
 130     Note: line-spanner must always have at least same duration
 131     as (de)crecsendo, b.o. line-breaking.
 132   */
 133
 134
 135
 136   /*
 137     maybe we should leave dynamic texts to the text-engraver and
 138     simply acknowledge them?
 139   */
 140   if (script_ev_)
 141     {
 142       script_ = make_item ("DynamicText", script_ev_->self_scm ());
 143       script_->set_property ("text",
 144                                    script_ev_->get_property ("text"));
 145
 146
 147       if (Direction d = to_dir (script_ev_->get_property ("direction")))
 148         set_grob_direction (line_spanner_, d);
 149
 150       Axis_group_interface::add_element (line_spanner_, script_);
 151
 152     }
 153
 154   Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
 155     accepted_spanreqs_drul_[STOP] : script_ev_;
 156
 157   if (accepted_spanreqs_drul_[STOP] || script_ev_)
 158     {
 159       /*
 160         finish side position alignment if the (de)cresc ends here, and
 161         there are no new dynamics.
 162        */
 163
 164
 165       if (cresc_)
 166         {
 167           assert (!finished_cresc_ && cresc_);
 168
 169           cresc_->set_bound (RIGHT, script_
 170                                ? script_
 171                                : unsmob_grob (get_property ("currentMusicalColumn")));
 172           add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
 173
 174
 175           finished_cresc_ = cresc_;
 176           cresc_ = 0;
 177           current_cresc_ev_ = 0;
 178         }
 179       else if (accepted_spanreqs_drul_[STOP])
 180         {
 181           accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
 182           stop_ev = 0;
 183         }
 184
 185     }
 186
 187   if (accepted_spanreqs_drul_[START])
 188     {
 189       if (current_cresc_ev_)
 190         {
 191           String msg = _ ("already have a decrescendo");
 192           if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
 193             msg = _ ("already have a crescendo");
 194
 195           accepted_spanreqs_drul_[START]->origin ()->warning (msg);
 196           current_cresc_ev_->origin ()->warning (_("Cresc started here"));
 197         }
 198       else
 199         {
 200           current_cresc_ev_ = accepted_spanreqs_drul_[START];
 201
 202           if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
 203             set_grob_direction (line_spanner_, d);
 204
 205           /*
 206             TODO: Use symbols.
 207           */
 208
 209           String start_type =
 210             ly_symbol2string (current_cresc_ev_->get_property ("name"));
 211
 212           /*
 213             ugh. Use push/pop?
 214           */
 215           if (start_type == "DecrescendoEvent")
 216             start_type = "decrescendo";
 217           else if (start_type == "CrescendoEvent")
 218             start_type = "crescendo";
 219
 220           SCM s = get_property ((start_type + "Spanner").to_str0 ());
 221           if (!ly_c_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
 222             {
 223               cresc_  = make_spanner ("Hairpin", accepted_spanreqs_drul_[START]->self_scm ());
 224               cresc_->set_property ("grow-direction",
 225                                            scm_int2num ((start_type == "crescendo")
 226                                                        ? BIGGER : SMALLER));
 227
 228             }
 229
 230
 231           /*
 232             This is a convenient (and legacy) interface to TextSpanners
 233             for use in (de)crescendi.
 234             Hmm.
 235           */
 236           else
 237             {
 238               cresc_  = make_spanner ("TextSpanner", accepted_spanreqs_drul_[START]->self_scm ());
 239               cresc_->set_property ("style", s);
 240               context ()->set_property ((start_type
 241                                             + "Spanner").to_str0 (), SCM_EOL);
 242               s = get_property ((start_type + "Text").to_str0 ());
 243               /*
 244                 FIXME: use get_markup () to check type.
 245               */
 246               if (ly_c_string_p (s) || ly_c_pair_p (s))
 247                 {
 248                   cresc_->set_property ("edge-text",
 249                                              scm_cons (s, scm_makfrom0str ("")));
 250                   context ()->set_property ((start_type + "Text").to_str0 (),
 251                                                 SCM_EOL);
 252                 }
 253             }
 254
 255           cresc_->set_bound (LEFT, script_
 256                                ? script_
 257                                : unsmob_grob (get_property ("currentMusicalColumn")));
 258
 259           Axis_group_interface::add_element (line_spanner_, cresc_);
 260
 261           add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
 262
 263         }
 264     }
 265 }
 266
 267 void
 268 Dynamic_engraver::stop_translation_timestep ()
 269 {
 270   typeset_all ();
 271   if (!current_cresc_ev_)
 272     {
 273       finished_line_spanner_ = line_spanner_;
 274       line_spanner_ =0;
 275       typeset_all ();
 276     }
 277
 278   script_ev_ = 0;
 279   accepted_spanreqs_drul_[START] = 0;
 280   accepted_spanreqs_drul_[STOP] = 0;
 281 }
 282
 283 void
 284 Dynamic_engraver::finalize ()
 285 {
 286   typeset_all ();
 287
 288   if (line_spanner_
 289       && !line_spanner_->is_live ())
 290     line_spanner_ = 0;
 291   if (line_spanner_)
 292     {
 293       finished_line_spanner_ = line_spanner_;
 294       typeset_all ();
 295     }
 296
 297   if (cresc_
 298       && !cresc_->is_live ())
 299     cresc_ = 0;
 300   if (cresc_)
 301     {
 302       current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
 303       cresc_->suicide ();
 304       cresc_ = 0;
 305     }
 306 }
 307
 308 void
 309 Dynamic_engraver::typeset_all ()
 310 {
 311   /*
 312     remove suicided spanners,
 313     ugh: we'll need this for every spanner, beam, slur
 314     Hmm, how to do this, cleanly?
 315     Maybe just check at typeset_grob ()?
 316   */
 317   if (finished_cresc_
 318       && !finished_cresc_->is_live ())
 319     finished_cresc_ = 0;
 320   if (finished_line_spanner_
 321       && !finished_line_spanner_->is_live ())
 322     finished_line_spanner_ = 0;
 323
 324   if (finished_cresc_)
 325     {
 326       if (!finished_cresc_->get_bound (RIGHT))
 327         {
 328           finished_cresc_->set_bound (RIGHT, script_
 329                                         ? script_
 330                                         : unsmob_grob (get_property ("currentMusicalColumn")));
 331
 332           if (finished_line_spanner_)
 333             add_bound_item (finished_line_spanner_,
 334                             finished_cresc_->get_bound (RIGHT));
 335         }
 336       finished_cresc_ =0;
 337     }
 338
 339       script_ = 0;
 340   if (finished_line_spanner_)
 341     {
 342       /*
 343         We used to have
 344
 345              extend-spanner-over-elements (finished_line_spanner_);
 346
 347         but this is rather kludgy, since finished_line_spanner_
 348         typically has a staff-symbol field set , extending it over the
 349         entire staff.
 350
 351       */
 352
 353       Grob * l = finished_line_spanner_->get_bound (LEFT );
 354       Grob * r = finished_line_spanner_->get_bound (RIGHT);
 355       if (!r && l)
 356         finished_line_spanner_->set_bound (RIGHT, l);
 357       else if (!l && r)
 358         finished_line_spanner_->set_bound (LEFT, r);
 359       else if (!r && !l)
 360         {
 361           /*
 362             This is a isolated dynamic apparently, and does not even have
 363             any interesting support item.
 364            */
 365           Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
 366           Item * ci = dynamic_cast<Item*>(cc);
 367           finished_line_spanner_->set_bound (RIGHT, ci);
 368           finished_line_spanner_->set_bound (LEFT, ci);
 369         }
 370
 371       finished_line_spanner_ = 0;
 372     }
 373 }
 374
 375 void
 376 Dynamic_engraver::acknowledge_grob (Grob_info i)
 377 {
 378   if (!line_spanner_)
 379     return ;
 380
 381   if (Note_column::has_interface (i.grob_))
 382     {
 383       if (line_spanner_
 384           /* Don't refill killed spanner */
 385           && line_spanner_->is_live ())
 386         {
 387           Side_position_interface::add_support (line_spanner_,i.grob_);
 388           add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
 389         }
 390
 391       if (script_ && !script_->get_parent (X_AXIS))
 392         {
 393           SCM head = scm_last_pair (i.grob_->get_property ("note-heads"));
 394           if (ly_c_pair_p (head))
 395             script_->set_parent (unsmob_grob (ly_car (head)),  X_AXIS);
 396         }
 397
 398     }
 399   else if (Script_interface::has_interface (i.grob_) && script_)
 400     {
 401       SCM p = i.grob_->get_property ("script-priority");
 402
 403       /*
 404         UGH.
 405
 406         DynamicText doesn't really have a script-priority field.
 407        */
 408       if (ly_c_number_p (p)
 409           && ly_scm2int (p) < ly_scm2int (script_->get_property ("script-priority")))
 410         {
 411           Side_position_interface::add_support (line_spanner_, i.grob_);
 412
 413         }
 414     }
 415 }
 416 ENTER_DESCRIPTION (Dynamic_engraver,
 417 /* descr */
 418 "This engraver creates hairpins, dynamic texts, and their vertical\n"
 419 "alignments.  The symbols are collected onto a DynamicLineSpanner grob\n"
 420 "which takes care of vertical positioning.  "
 421 ,
 422
 423 /* creats*/       "DynamicLineSpanner DynamicText Hairpin TextSpanner",
 424 /* accepts */     "absolute-dynamic-event crescendo-event decrescendo-event",
 425 /* acks  */      "note-column-interface script-interface",
 426 /* reads */       "",
 427 /* write */       "");