lily/dynamic-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2008--2015 Han-Wen Nienhuys <hanwen@lilypond.org>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "engraver.hh"
  21 #include "hairpin.hh"
  22 #include "international.hh"
  23 #include "item.hh"
  24 #include "note-column.hh"
  25 #include "pointer-group-interface.hh"
  26 #include "self-alignment-interface.hh"
  27 #include "spanner.hh"
  28 #include "stream-event.hh"
  29 #include "text-interface.hh"
  30
  31 #include "translator.icc"
  32
  33 class Dynamic_engraver : public Engraver
  34 {
  35   TRANSLATOR_DECLARATIONS (Dynamic_engraver);
  36   DECLARE_ACKNOWLEDGER (note_column);
  37   DECLARE_TRANSLATOR_LISTENER (absolute_dynamic);
  38   DECLARE_TRANSLATOR_LISTENER (span_dynamic);
  39   DECLARE_TRANSLATOR_LISTENER (break_span);
  40
  41 protected:
  42   virtual void process_music ();
  43   virtual void stop_translation_timestep ();
  44   virtual void finalize ();
  45
  46 private:
  47   SCM get_property_setting (Stream_event *evt, char const *evprop,
  48                             char const *ctxprop);
  49   string get_spanner_type (Stream_event *ev);
  50
  51   Drul_array<Stream_event *> accepted_spanevents_drul_;
  52   Spanner *current_spanner_;
  53   Spanner *finished_spanner_;
  54
  55   Item *script_;
  56   Stream_event *script_event_;
  57   Stream_event *current_span_event_;
  58   bool end_new_spanner_;
  59 };
  60
  61 Dynamic_engraver::Dynamic_engraver ()
  62 {
  63   script_event_ = 0;
  64   current_span_event_ = 0;
  65   script_ = 0;
  66   finished_spanner_ = 0;
  67   current_spanner_ = 0;
  68   accepted_spanevents_drul_.set (0, 0);
  69   end_new_spanner_ = false;
  70 }
  71
  72 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, absolute_dynamic);
  73 void
  74 Dynamic_engraver::listen_absolute_dynamic (Stream_event *ev)
  75 {
  76   ASSIGN_EVENT_ONCE (script_event_, ev);
  77 }
  78
  79 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, span_dynamic);
  80 void
  81 Dynamic_engraver::listen_span_dynamic (Stream_event *ev)
  82 {
  83   Direction d = to_dir (ev->get_property ("span-direction"));
  84
  85   ASSIGN_EVENT_ONCE (accepted_spanevents_drul_[d], ev);
  86 }
  87
  88 IMPLEMENT_TRANSLATOR_LISTENER (Dynamic_engraver, break_span);
  89 void
  90 Dynamic_engraver::listen_break_span (Stream_event *event)
  91 {
  92   if (event->in_event_class ("break-dynamic-span-event"))
  93     {
  94       // Case 1: Already have a start dynamic event -> break applies to new
  95       //         spanner (created later) -> set a flag
  96       // Case 2: no new spanner, but spanner already active -> break it now
  97       if (accepted_spanevents_drul_[START])
  98         end_new_spanner_ = true;
  99       else if (current_spanner_)
 100         current_spanner_->set_property ("spanner-broken", SCM_BOOL_T);
 101     }
 102 }
 103
 104 SCM
 105 Dynamic_engraver::get_property_setting (Stream_event *evt,
 106                                         char const *evprop,
 107                                         char const *ctxprop)
 108 {
 109   SCM spanner_type = evt->get_property (evprop);
 110   if (scm_is_null (spanner_type))
 111     spanner_type = get_property (ctxprop);
 112   return spanner_type;
 113 }
 114
 115 void
 116 Dynamic_engraver::process_music ()
 117 {
 118   if (current_spanner_
 119       && (accepted_spanevents_drul_[STOP]
 120           || script_event_
 121           || accepted_spanevents_drul_[START]))
 122     {
 123       Stream_event *ender = accepted_spanevents_drul_[STOP];
 124       if (!ender)
 125         ender = script_event_;
 126
 127       if (!ender)
 128         ender = accepted_spanevents_drul_[START];
 129
 130       finished_spanner_ = current_spanner_;
 131       announce_end_grob (finished_spanner_, ender->self_scm ());
 132       current_spanner_ = 0;
 133       current_span_event_ = 0;
 134     }
 135
 136   if (accepted_spanevents_drul_[START])
 137     {
 138       current_span_event_ = accepted_spanevents_drul_[START];
 139
 140       string start_type = get_spanner_type (current_span_event_);
 141       SCM cresc_type = get_property_setting (current_span_event_, "span-type",
 142                                              (start_type + "Spanner").c_str ());
 143
 144       if (scm_is_eq (cresc_type, ly_symbol2scm ("text")))
 145         {
 146           current_spanner_
 147             = make_spanner ("DynamicTextSpanner",
 148                             accepted_spanevents_drul_[START]->self_scm ());
 149
 150           SCM text = get_property_setting (current_span_event_, "span-text",
 151                                            (start_type + "Text").c_str ());
 152           if (Text_interface::is_markup (text))
 153             current_spanner_->set_property ("text", text);
 154           /*
 155             If the line of a text spanner is hidden, end the alignment spanner
 156             early: this allows dynamics to be spaced individually instead of
 157             being linked together.
 158           */
 159           if (scm_is_eq (current_spanner_->get_property ("style"),
 160                          ly_symbol2scm ("none")))
 161             current_spanner_->set_property ("spanner-broken", SCM_BOOL_T);
 162         }
 163       else
 164         {
 165           if (!scm_is_eq (cresc_type, ly_symbol2scm ("hairpin")))
 166             {
 167               string as_string = ly_scm_write_string (cresc_type);
 168               current_span_event_
 169               ->origin ()->warning (_f ("unknown crescendo style: %s\ndefaulting to hairpin.", as_string.c_str ()));
 170             }
 171           current_spanner_ = make_spanner ("Hairpin",
 172                                            current_span_event_->self_scm ());
 173         }
 174       // if we have a break-dynamic-span event right after the start dynamic, break the new spanner immediately
 175       if (end_new_spanner_)
 176         {
 177           current_spanner_->set_property ("spanner-broken", SCM_BOOL_T);
 178           end_new_spanner_ = false;
 179         }
 180       if (finished_spanner_)
 181         {
 182           if (Hairpin::has_interface (finished_spanner_))
 183             Pointer_group_interface::add_grob (finished_spanner_,
 184                                                ly_symbol2scm ("adjacent-spanners"),
 185                                                current_spanner_);
 186           if (Hairpin::has_interface (current_spanner_))
 187             Pointer_group_interface::add_grob (current_spanner_,
 188                                                ly_symbol2scm ("adjacent-spanners"),
 189                                                finished_spanner_);
 190         }
 191     }
 192
 193   if (script_event_)
 194     {
 195       script_ = make_item ("DynamicText", script_event_->self_scm ());
 196       script_->set_property ("text",
 197                              script_event_->get_property ("text"));
 198
 199       if (finished_spanner_)
 200         finished_spanner_->set_bound (RIGHT, script_);
 201       if (current_spanner_)
 202         current_spanner_->set_bound (LEFT, script_);
 203     }
 204 }
 205
 206 void
 207 Dynamic_engraver::stop_translation_timestep ()
 208 {
 209   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 210     finished_spanner_
 211     ->set_bound (RIGHT,
 212                  Grob::unsmob (get_property ("currentMusicalColumn")));
 213
 214   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 215     current_spanner_
 216     ->set_bound (LEFT,
 217                  Grob::unsmob (get_property ("currentMusicalColumn")));
 218   script_ = 0;
 219   script_event_ = 0;
 220   accepted_spanevents_drul_.set (0, 0);
 221   finished_spanner_ = 0;
 222   end_new_spanner_ = false;
 223 }
 224
 225 void
 226 Dynamic_engraver::finalize ()
 227 {
 228   if (current_spanner_
 229       && !current_spanner_->is_live ())
 230     current_spanner_ = 0;
 231   if (current_spanner_)
 232     {
 233       current_span_event_
 234       ->origin ()->warning (_f ("unterminated %s",
 235                                 get_spanner_type (current_span_event_)
 236                                 .c_str ()));
 237       current_spanner_->suicide ();
 238       current_spanner_ = 0;
 239     }
 240 }
 241
 242 string
 243 Dynamic_engraver::get_spanner_type (Stream_event *ev)
 244 {
 245   string type;
 246   SCM start_sym = scm_car (ev->get_property ("class"));
 247
 248   if (scm_is_eq (start_sym, ly_symbol2scm ("decrescendo-event")))
 249     type = "decrescendo";
 250   else if (scm_is_eq (start_sym, ly_symbol2scm ("crescendo-event")))
 251     type = "crescendo";
 252   else
 253     programming_error ("unknown dynamic spanner type");
 254
 255   return type;
 256 }
 257
 258 void
 259 Dynamic_engraver::acknowledge_note_column (Grob_info info)
 260 {
 261   if (script_ && !script_->get_parent (X_AXIS))
 262     {
 263       extract_grob_set (info.grob (), "note-heads", heads);
 264       /*
 265         Spacing constraints may require dynamics to be attached to rests,
 266         so check for a rest if this note column has no note heads.
 267       */
 268       Grob *x_parent = (heads.size ()
 269                         ? info.grob ()
 270                         : Grob::unsmob (info.grob ()->get_object ("rest")));
 271       if (x_parent)
 272         script_->set_parent (x_parent, X_AXIS);
 273     }
 274
 275   if (current_spanner_ && !current_spanner_->get_bound (LEFT))
 276     current_spanner_->set_bound (LEFT, info.grob ());
 277   if (finished_spanner_ && !finished_spanner_->get_bound (RIGHT))
 278     finished_spanner_->set_bound (RIGHT, info.grob ());
 279 }
 280
 281 ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
 282 ADD_TRANSLATOR (Dynamic_engraver,
 283                 /* doc */
 284                 "Create hairpins, dynamic texts and dynamic text spanners.",
 285
 286                 /* create */
 287                 "DynamicTextSpanner "
 288                 "DynamicText "
 289                 "Hairpin ",
 290
 291                 /* read */
 292                 "crescendoSpanner "
 293                 "crescendoText "
 294                 "currentMusicalColumn "
 295                 "decrescendoSpanner "
 296                 "decrescendoText ",
 297
 298                 /* write */
 299                 ""
 300                );