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--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "axis-group-interface.hh"
  10 #include "context.hh"
  11 #include "dimensions.hh"
  12 #include "directional-element-interface.hh"
  13 #include "engraver.hh"
  14 #include "hairpin.hh"
  15 #include "international.hh"
  16 #include "interval.hh"
  17 #include "note-column.hh"
  18 #include "paper-column.hh"
  19 #include "pointer-group-interface.hh"
  20 #include "script-interface.hh"
  21 #include "self-alignment-interface.hh"
  22 #include "side-position-interface.hh"
  23 #include "staff-symbol-referencer.hh"
  24 #include "stream-event.hh"
  25 #include "warn.hh"
  26 #include "spanner.hh"
  27 #include "text-interface.hh"
  28
  29 #include "translator.icc"
  30
  31 /*
  32   TODO:
  33
  34   * direction of text-dynamic-event if not equal to direction of
  35   line-spanner
  36
  37   - TODO: this engraver is too complicated. We should split it into
  38   the handling of the basic grobs and the linespanner
  39
  40   - TODO: the line-spanner is not killed after the (de)crescs are
  41   finished.
  42 */
  43
  44 /**
  45    print text & hairpin dynamics.
  46 */
  47 class Dynamic_engraver : public Engraver
  48 {
  49   Item *script_;
  50   Spanner *line_spanner_;
  51   Spanner *cresc_;
  52
  53   Spanner *finished_line_spanner_;
  54   Spanner *finished_cresc_;
  55
  56   Stream_event *script_ev_;
  57   Stream_event *current_cresc_ev_;
  58
  59   Drul_array<Stream_event *> accepted_spanevents_drul_;
  60
  61   vector<Note_column*> pending_columns_;
  62   vector<Grob*> pending_elements_;
  63
  64   void typeset_all ();
  65
  66   TRANSLATOR_DECLARATIONS (Dynamic_engraver);
  67   DECLARE_ACKNOWLEDGER (note_column);
  68   DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
  69   DECLARE_TRANSLATOR_LISTENER (span_dynamic);
  70
  71 protected:
  72   virtual void finalize ();
  73   void stop_translation_timestep ();
  74   void process_music ();
  75 };
  76
  77 Dynamic_engraver::Dynamic_engraver ()
  78 {
  79   script_ = 0;
  80   finished_cresc_ = 0;
  81   line_spanner_ = 0;
  82   finished_line_spanner_ = 0;
  83   current_cresc_ev_ = 0;
  84   cresc_ = 0;
  85
  86   script_ev_ = 0;
  87   accepted_spanevents_drul_[START] = 0;
  88   accepted_spanevents_drul_[STOP] = 0;
  89 }
  90
  91 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
  92 void
  93 Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
  94 {
  95   /*
  96     TODO: probably broken.
  97   */
  98   ASSIGN_EVENT_ONCE (script_ev_, ev);
  99 }
 100
 101 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
 102 void
 103 Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
 104 {
 105   Direction d = to_dir (ev->get_property ("span-direction"));
 106
 107   if (d == START)
 108     ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[START], ev);
 109
 110   /* Cancel any ongoing crescendo, either explicitly by \! or
 111      implicitly by a new crescendo. Also avoid warning if cresc is
 112      cancelled both implicitly and explicitly. */
 113   if ((d == STOP || current_cresc_ev_) && !accepted_spanevents_drul_[STOP])
 114     ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[STOP], ev);
 115 }
 116
 117 void
 118 Dynamic_engraver::process_music ()
 119 {
 120   if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
 121     {
 122       if (!line_spanner_)
 123         {
 124           Stream_event *rq = accepted_spanevents_drul_[START];
 125           line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
 126           if (script_ev_)
 127             rq = script_ev_;
 128         }
 129     }
 130
 131   /*
 132     During a (de)crescendo, pending event will not be cleared,
 133     and a line-spanner will always be created, as \< \! are already
 134     two events.
 135
 136     Note: line-spanner must always have at least same duration
 137     as (de)crecsendo, b.o. line-breaking.
 138   */
 139
 140   /*
 141     maybe we should leave dynamic texts to the text-engraver and
 142     simply acknowledge them?
 143   */
 144   if (script_ev_)
 145     {
 146       script_ = make_item ("DynamicText", script_ev_->self_scm ());
 147       script_->set_property ("text",
 148                              script_ev_->get_property ("text"));
 149
 150       if (Direction d = to_dir (script_ev_->get_property ("direction")))
 151         set_grob_direction (line_spanner_, d);
 152       else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
 153         set_grob_direction (script_, d);
 154
 155       Axis_group_interface::add_element (line_spanner_, script_);
 156     }
 157
 158   Stream_event *stop_ev = accepted_spanevents_drul_ [STOP]
 159     ? accepted_spanevents_drul_[STOP] : script_ev_;
 160
 161   if (accepted_spanevents_drul_[STOP] || script_ev_)
 162     {
 163       /*
 164         finish side position alignment if the (de)cresc ends here, and
 165         there are no new dynamics.
 166       */
 167
 168       if (cresc_)
 169         {
 170           assert (!finished_cresc_ && cresc_);
 171
 172           if (script_)
 173             {
 174               cresc_->set_bound (RIGHT, script_);
 175               add_bound_item (line_spanner_, script_);
 176             }
 177
 178           finished_cresc_ = cresc_;
 179
 180           /* backwards compatibility with hairpinToBarline */
 181           bool use_bar = to_boolean (get_property ("hairpinToBarline"))
 182             && scm_is_string (get_property ("whichBar"));
 183
 184           finished_cresc_->set_property ("to-barline", scm_from_bool (use_bar));
 185
 186           announce_end_grob (finished_cresc_, SCM_EOL);
 187           cresc_ = 0;
 188           current_cresc_ev_ = 0;
 189         }
 190       else if (accepted_spanevents_drul_[STOP])
 191         {
 192           accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("cannot find start of (de)crescendo"));
 193           stop_ev = 0;
 194         }
 195     }
 196
 197   if (accepted_spanevents_drul_[START])
 198     {
 199       if (current_cresc_ev_)
 200         {
 201           string msg = _ ("already have a decrescendo");
 202           if (current_cresc_ev_->in_event_class ("crescendo-event"))
 203             msg = _ ("already have a crescendo");
 204
 205           accepted_spanevents_drul_[START]->origin ()->warning (msg);
 206           current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
 207         }
 208       else
 209         {
 210           current_cresc_ev_ = accepted_spanevents_drul_[START];
 211
 212           if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
 213             set_grob_direction (line_spanner_, d);
 214
 215           /*
 216             TODO: Use symbols.
 217           */
 218
 219           SCM start_sym = current_cresc_ev_->get_property ("class");
 220           string start_type;
 221
 222           if (start_sym == ly_symbol2scm ("decrescendo-event"))
 223             start_type = "decrescendo";
 224           else if (start_sym == ly_symbol2scm ("crescendo-event"))
 225             start_type = "crescendo";
 226           else
 227             {
 228               programming_error ("unknown dynamic spanner type");
 229               return;
 230             }
 231
 232           /*
 233             UGH. TODO: should read from original event, so appearance
 234             may be altered with \tweak.
 235            */
 236           SCM s = get_property ((start_type + "Spanner").c_str ());
 237           if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
 238             {
 239               cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
 240               if (finished_cresc_)
 241                 {
 242                   Pointer_group_interface::add_grob (finished_cresc_,
 243                                                      ly_symbol2scm ("adjacent-hairpins"),
 244                                                      cresc_);
 245
 246                   Pointer_group_interface::add_grob (cresc_,
 247                                                      ly_symbol2scm ("adjacent-hairpins"),
 248                                                      finished_cresc_);
 249                 }
 250             }
 251
 252           /*
 253             This is a convenient (and legacy) interface to TextSpanners
 254             for use in (de)crescendi.
 255             Hmm.
 256           */
 257           else
 258             {
 259               cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
 260               cresc_->set_property ("style", s);
 261               context ()->set_property ((start_type
 262                                          + "Spanner").c_str (), SCM_EOL);
 263               s = get_property ((start_type + "Text").c_str ());
 264               if (Text_interface::is_markup (s))
 265                 {
 266                   cresc_->set_property ("text", s);
 267                   context ()->set_property ((start_type + "Text").c_str (),
 268                                             SCM_EOL);
 269                 }
 270
 271               if (script_)
 272                 {
 273                   set_nested_property (cresc_,
 274                                        scm_list_3 (ly_symbol2scm ("bound-details"),
 275                                                    ly_symbol2scm ("left"),
 276                                                    ly_symbol2scm ("attach-dir")
 277                                                    ),
 278                                        scm_from_int (RIGHT));
 279                 }
 280             }
 281
 282           if (script_)
 283             {
 284               cresc_->set_bound (LEFT, script_);
 285               add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
 286             }
 287
 288           Axis_group_interface::add_element (line_spanner_, cresc_);
 289         }
 290     }
 291 }
 292
 293 void
 294 Dynamic_engraver::stop_translation_timestep ()
 295 {
 296   if (!current_cresc_ev_ && line_spanner_)
 297     {
 298       assert (!finished_line_spanner_);
 299       finished_line_spanner_ = line_spanner_;
 300       line_spanner_ = 0;
 301     }
 302
 303   typeset_all ();
 304
 305   if (cresc_ && !cresc_->get_bound (LEFT))
 306     {
 307       cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
 308       add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
 309     }
 310
 311   script_ev_ = 0;
 312   accepted_spanevents_drul_[START] = 0;
 313   accepted_spanevents_drul_[STOP] = 0;
 314 }
 315
 316 void
 317 Dynamic_engraver::finalize ()
 318 {
 319   typeset_all ();
 320
 321   if (line_spanner_
 322       && !line_spanner_->is_live ())
 323     line_spanner_ = 0;
 324   if (line_spanner_)
 325     {
 326       finished_line_spanner_ = line_spanner_;
 327       typeset_all ();
 328     }
 329
 330   if (cresc_
 331       && !cresc_->is_live ())
 332     cresc_ = 0;
 333   if (cresc_)
 334     {
 335       current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
 336       cresc_->suicide ();
 337       cresc_ = 0;
 338     }
 339 }
 340
 341 void
 342 Dynamic_engraver::typeset_all ()
 343 {
 344   if (finished_cresc_)
 345     {
 346       if (!finished_cresc_->get_bound (RIGHT))
 347         {
 348
 349           Grob *column_bound = unsmob_grob (get_property ("currentMusicalColumn"));
 350
 351           finished_cresc_->set_bound (RIGHT, script_
 352                                       ? script_
 353                                       : column_bound);
 354
 355           if (finished_line_spanner_)
 356             add_bound_item (finished_line_spanner_,
 357                             finished_cresc_->get_bound (RIGHT));
 358         }
 359       finished_cresc_ = 0;
 360     }
 361
 362   script_ = 0;
 363   if (finished_line_spanner_)
 364     {
 365       /*
 366         We used to have
 367
 368         extend-spanner-over-elements (finished_line_spanner_);
 369
 370         but this is rather kludgy, since finished_line_spanner_
 371         typically has a staff-symbol field set , extending it over the
 372         entire staff.
 373
 374       */
 375
 376       Grob *l = finished_line_spanner_->get_bound (LEFT);
 377       Grob *r = finished_line_spanner_->get_bound (RIGHT);
 378       if (!r && l)
 379         finished_line_spanner_->set_bound (RIGHT, l);
 380       else if (!l && r)
 381         finished_line_spanner_->set_bound (LEFT, r);
 382       else if (!r && !l)
 383         {
 384           /*
 385             This is a isolated dynamic apparently, and does not even have
 386             any interesting support item.
 387           */
 388           Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
 389           Item *ci = dynamic_cast<Item *> (cc);
 390           finished_line_spanner_->set_bound (RIGHT, ci);
 391           finished_line_spanner_->set_bound (LEFT, ci);
 392         }
 393       finished_line_spanner_ = 0;
 394     }
 395 }
 396
 397 void
 398 Dynamic_engraver::acknowledge_note_column (Grob_info info)
 399 {
 400   if (!line_spanner_)
 401     return;
 402
 403   if (line_spanner_
 404       /* Don't refill killed spanner */
 405       && line_spanner_->is_live ())
 406     {
 407       Side_position_interface::add_support (line_spanner_, info.grob ());
 408       add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
 409     }
 410
 411   if (script_ && !script_->get_parent (X_AXIS))
 412     {
 413       extract_grob_set (info.grob (), "note-heads", heads);
 414       if (heads.size ())
 415         {
 416           Grob *head = heads[0];
 417           script_->set_parent (head, X_AXIS);
 418           Self_alignment_interface::set_center_parent (script_, X_AXIS);
 419         }
 420     }
 421
 422   if (cresc_)
 423     {
 424       if (!cresc_->get_bound (LEFT))
 425         {
 426           cresc_->set_bound (LEFT, info.grob ());
 427           add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
 428         }
 429     }
 430
 431   if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
 432     finished_cresc_->set_bound (RIGHT, info.grob ());
 433 }
 434
 435 ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
 436
 437 ADD_TRANSLATOR (Dynamic_engraver,
 438                 /* doc */
 439                 "This engraver creates hairpins, dynamic texts, and their vertical\n"
 440                 "alignments.  The symbols are collected onto a DynamicLineSpanner grob\n"
 441                 "which takes care of vertical positioning.  ",
 442
 443                 /* create */
 444                 "DynamicLineSpanner "
 445                 "DynamicTextSpanner "
 446                 "DynamicText "
 447                 "Hairpin "
 448                 "TextSpanner ",
 449
 450                 /* read */ "",
 451                 /* write */ "");