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--2002 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 "translator-group.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   virtual void start_translation_timestep ();
  68 };
  69
  70
  71
  72
  73 Dynamic_engraver::Dynamic_engraver ()
  74 {
  75   script_ = 0;
  76   finished_cresc_ = 0;
  77   line_spanner_ = 0;
  78   finished_line_spanner_ = 0;
  79   current_cresc_ev_ = 0;
  80   cresc_ =0;
  81
  82   script_ev_ = 0;
  83   accepted_spanreqs_drul_[START] = 0;
  84   accepted_spanreqs_drul_[STOP] = 0;
  85 }
  86
  87 void
  88 Dynamic_engraver::start_translation_timestep ()
  89 {
  90   script_ev_ = 0;
  91   accepted_spanreqs_drul_[START] = 0;
  92   accepted_spanreqs_drul_[STOP] = 0;
  93 }
  94
  95 bool
  96 Dynamic_engraver::try_music (Music * m)
  97 {
  98   if (m->is_mus_type ("absolute-dynamic-event"))
  99     {
 100       /*
 101         TODO: probably broken.
 102       */
 103       script_ev_ = m;
 104       return true;
 105     }
 106   else if (m->is_mus_type ("abort-event"))
 107     {
 108       accepted_spanreqs_drul_[LEFT] = 0;
 109       accepted_spanreqs_drul_[RIGHT] = 0;
 110       /*
 111         Let's not kill the line spanner, since that would fuck up
 112         earlier, not-to-be-terminated stuff.
 113
 114         It will disappear by itself when stop_translation_timestep
 115         () finds that there is nothing to support anymore.  */
 116
 117       if (cresc_)
 118         cresc_->suicide ();
 119       cresc_ = 0;
 120     }
 121   else if (m->is_mus_type ("decrescendo-event")
 122            || m->is_mus_type ("crescendo-event"))
 123     {
 124       Direction d = to_dir (m->get_mus_property ("span-direction"));
 125       accepted_spanreqs_drul_[d] = m;
 126       return true;
 127     }
 128   return false;
 129 }
 130
 131 void
 132 Dynamic_engraver::process_music ()
 133 {
 134   if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
 135     {
 136       if (!line_spanner_)
 137         {
 138           line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
 139
 140           Music * rq = accepted_spanreqs_drul_[START];
 141           if (script_ev_)
 142             rq =  script_ev_ ;
 143           announce_grob(line_spanner_, rq ? rq->self_scm(): SCM_EOL);
 144         }
 145     }
 146
 147   /*
 148     During a (de)crescendo, pending event will not be cleared,
 149     and a line-spanner will always be created, as \< \! are already
 150     two events.
 151
 152     Note: line-spanner must always have at least same duration
 153     as (de)crecsendo, b.o. line-breaking.
 154   */
 155
 156
 157
 158   /*
 159     maybe we should leave dynamic texts to the text-engraver and
 160     simply acknowledge them?
 161   */
 162   if (script_ev_)
 163     {
 164       script_ = new Item (get_property ("DynamicText"));
 165       script_->set_grob_property ("text",
 166                                    script_ev_->get_mus_property ("text"));
 167
 168
 169       if (Direction d = to_dir (script_ev_->get_mus_property ("direction")))
 170         Directional_element_interface::set (line_spanner_, d);
 171
 172       Axis_group_interface::add_element (line_spanner_, script_);
 173
 174       announce_grob(script_, script_ev_->self_scm());
 175     }
 176
 177   Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
 178     accepted_spanreqs_drul_[STOP] : script_ev_;
 179
 180   if (accepted_spanreqs_drul_[STOP] || script_ev_)
 181     {
 182       /*
 183         finish side position alignment if the (de)cresc ends here, and
 184         there are no new dynamics.
 185        */
 186
 187
 188       if (cresc_)
 189         {
 190           assert (!finished_cresc_ && cresc_);
 191
 192           cresc_->set_bound (RIGHT, script_
 193                                ? script_
 194                                : unsmob_grob (get_property ("currentMusicalColumn")));
 195           add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
 196
 197
 198           finished_cresc_ = cresc_;
 199           cresc_ = 0;
 200           current_cresc_ev_ = 0;
 201         }
 202       else if (accepted_spanreqs_drul_[STOP] )
 203         {
 204           accepted_spanreqs_drul_[STOP]->origin ()->warning(_ ("can't find start of (de)crescendo"));
 205           stop_ev = 0;
 206         }
 207
 208     }
 209
 210   if (accepted_spanreqs_drul_[START])
 211     {
 212       if (current_cresc_ev_)
 213         {
 214           Direction sd = to_dir (current_cresc_ev_->get_mus_property ("span-direction"));
 215           String msg = sd == 1
 216             ? _ ("already have a crescendo")
 217             : _ ("already have a decrescendo");
 218
 219           accepted_spanreqs_drul_[START]->origin ()->warning (msg);
 220           current_cresc_ev_->origin ()->warning (_("Cresc started here"));
 221         }
 222       else
 223         {
 224           current_cresc_ev_ = accepted_spanreqs_drul_[START];
 225
 226           if (Direction d = to_dir (current_cresc_ev_->get_mus_property ("direction")))
 227             Directional_element_interface::set (line_spanner_, d);
 228
 229           /*
 230             TODO: Use symbols.
 231           */
 232
 233           String start_type =
 234             ly_symbol2string (current_cresc_ev_->get_mus_property ("name"));
 235
 236           /*
 237             ugh. Use push/pop?
 238           */
 239           if (start_type == "DecrescendoEvent")
 240             start_type = "decrescendo";
 241           else if (start_type == "CrescendoEvent")
 242             start_type = "crescendo";
 243
 244           SCM s = get_property ((start_type + "Spanner").to_str0 ());
 245           if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
 246             {
 247               cresc_  = new Spanner (get_property ("Hairpin"));
 248               cresc_->set_grob_property ("grow-direction",
 249                                            gh_int2scm ((start_type == "crescendo")
 250                                                        ? BIGGER : SMALLER));
 251
 252             }
 253
 254
 255
 256           /*
 257             This is a convenient (and legacy) interface to TextSpanners
 258             for use in (de)crescendi.
 259             Hmm.
 260           */
 261           else
 262             {
 263               cresc_  = new Spanner (get_property ("TextSpanner"));
 264               cresc_->set_grob_property ("type", s);
 265               daddy_trans_->set_property ((start_type
 266                                             + "Spanner").to_str0 (), SCM_EOL);
 267               s = get_property ((start_type + "Text").to_str0 ());
 268               /*
 269                 FIXME: use get_markup () to check type.
 270               */
 271               if (gh_string_p (s) || gh_pair_p (s))
 272                 {
 273                   cresc_->set_grob_property ("edge-text",
 274                                                gh_cons (s, scm_makfrom0str ("")));
 275                   daddy_trans_->set_property ((start_type + "Text").to_str0 (),
 276                                                 SCM_EOL);
 277                 }
 278             }
 279
 280           cresc_->set_bound (LEFT, script_
 281                                ? script_
 282                                : unsmob_grob (get_property ("currentMusicalColumn")));
 283
 284           Axis_group_interface::add_element (line_spanner_, cresc_);
 285
 286           add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
 287
 288           announce_grob(cresc_, accepted_spanreqs_drul_[START]->self_scm());
 289         }
 290     }
 291 }
 292
 293 void
 294 Dynamic_engraver::stop_translation_timestep ()
 295 {
 296   typeset_all ();
 297   if (!current_cresc_ev_)
 298     {
 299       finished_line_spanner_ = line_spanner_;
 300       line_spanner_ =0;
 301       typeset_all ();
 302     }
 303 }
 304
 305 void
 306 Dynamic_engraver::finalize ()
 307 {
 308   typeset_all ();
 309
 310   if (line_spanner_
 311       && !line_spanner_->live())
 312     line_spanner_ = 0;
 313   if (line_spanner_)
 314     {
 315       finished_line_spanner_ = line_spanner_;
 316       typeset_all ();
 317     }
 318
 319   if (cresc_
 320       && !cresc_->live())
 321     cresc_ = 0;
 322   if (cresc_)
 323     {
 324       current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
 325       cresc_->suicide ();
 326       cresc_ = 0;
 327     }
 328 }
 329
 330 void
 331 Dynamic_engraver::typeset_all ()
 332 {
 333   /*
 334     remove suicided spanners,
 335     ugh: we'll need this for every spanner, beam, slur
 336     Hmm, how to do this, cleanly?
 337     Maybe just check at typeset_grob ()?
 338   */
 339   if (finished_cresc_
 340       && !finished_cresc_->live())
 341     finished_cresc_ = 0;
 342   if (finished_line_spanner_
 343       && !finished_line_spanner_->live())
 344     finished_line_spanner_ = 0;
 345
 346   if (finished_cresc_)
 347     {
 348       if (!finished_cresc_->get_bound (RIGHT))
 349         {
 350           finished_cresc_->set_bound (RIGHT, script_
 351                                         ? script_
 352                                         : unsmob_grob (get_property ("currentMusicalColumn")));
 353
 354           if (finished_line_spanner_)
 355             add_bound_item (finished_line_spanner_,
 356                             finished_cresc_->get_bound (RIGHT));
 357         }
 358       typeset_grob (finished_cresc_);
 359       finished_cresc_ =0;
 360     }
 361
 362   if (script_)
 363     {
 364       typeset_grob (script_);
 365       script_ = 0;
 366     }
 367   if (finished_line_spanner_)
 368     {
 369       /* To make sure that this works */
 370       Side_position_interface::add_staff_support (finished_line_spanner_);
 371
 372       /*
 373         We used to have
 374
 375              extend-spanner-over-elements (finished_line_spanner_);
 376
 377         but this is rather kludgy, since finished_line_spanner_
 378         typically has a staff-symbol field set , extending it over the
 379         entire staff.
 380
 381       */
 382
 383       Grob * l = finished_line_spanner_->get_bound (LEFT );
 384       Grob * r = finished_line_spanner_->get_bound (RIGHT);
 385       if (!r && l)
 386         finished_line_spanner_->set_bound (RIGHT, l);
 387       else if (!l && r)
 388         finished_line_spanner_->set_bound (LEFT, r);
 389       else if (!r && !l)
 390         {
 391           /*
 392             This is a isolated dynamic apparently, and does not even have
 393             any interesting support item.
 394            */
 395           Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
 396           Item * ci = dynamic_cast<Item*>(cc);
 397           finished_line_spanner_->set_bound (RIGHT, ci);
 398           finished_line_spanner_->set_bound (LEFT, ci);
 399         }
 400
 401       typeset_grob (finished_line_spanner_);
 402       finished_line_spanner_ = 0;
 403     }
 404 }
 405
 406 void
 407 Dynamic_engraver::acknowledge_grob (Grob_info i)
 408 {
 409   if (!line_spanner_)
 410     return ;
 411
 412   if (Note_column::has_interface (i.grob_))
 413     {
 414       if (line_spanner_
 415           /* Don't refill killed spanner */
 416           && line_spanner_->live())
 417         {
 418           Side_position_interface::add_support (line_spanner_,i.grob_);
 419           add_bound_item (line_spanner_,dynamic_cast<Item*> (i.grob_));
 420         }
 421
 422       if (script_ && !script_->get_parent (X_AXIS))
 423         {
 424           script_->set_parent (i.grob_,  X_AXIS);
 425         }
 426
 427     }
 428   else if (Script_interface::has_interface (i.grob_) && script_)
 429     {
 430       SCM p = i.grob_->get_grob_property ("script-priority");
 431
 432       /*
 433         UGH.
 434
 435         DynamicText doesn't really have a script-priority field.
 436        */
 437       if (gh_number_p (p)
 438           && gh_scm2int (p) < gh_scm2int (script_->get_grob_property ("script-priority")))
 439         {
 440           Side_position_interface::add_support (line_spanner_, i.grob_);
 441
 442         }
 443     }
 444 }
 445 ENTER_DESCRIPTION(Dynamic_engraver,
 446 /* descr */       "
 447 This engraver creates hairpins, dynamic texts, and their vertical
 448 alignments.  The symbols are collected onto a DynamicLineSpanner grob
 449 which takes care of vertical positioning.
 450 ",
 451
 452 /* creats*/       "DynamicLineSpanner DynamicText Hairpin TextSpanner",
 453 /* accepts */     "absolute-dynamic-event crescendo-event decrescendo-event",
 454 /* acks  */      "note-column-interface script-interface",
 455 /* reads */       "",
 456 /* write */       "");