lily/piano-pedal-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2014 Jan Nieuwenhuizen <janneke@gnu.org>,
   5                  Erik Sandberg <mandolaerik@gmail.com>
   6
   7   Chris Jackson <chris@fluffhouse.org.uk> - extended to support
   8   bracketed pedals.
   9
  10   LilyPond is free software: you can redistribute it and/or modify
  11   it under the terms of the GNU General Public License as published by
  12   the Free Software Foundation, either version 3 of the License, or
  13   (at your option) any later version.
  14
  15   LilyPond is distributed in the hope that it will be useful,
  16   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18   GNU General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "engraver.hh"
  25
  26 #include "axis-group-interface.hh"
  27 #include "context.hh"
  28 #include "directional-element-interface.hh"
  29 #include "international.hh"
  30 #include "lily-guile.hh"
  31 #include "note-column.hh"
  32 #include "side-position-interface.hh"
  33 #include "staff-symbol-referencer.hh"
  34 #include "stream-event.hh"
  35 #include "string-convert.hh"
  36 #include "warn.hh"
  37 #include "spanner.hh"
  38 #include "item.hh"
  39
  40 #include "translator.icc"
  41
  42 #include <string.h>
  43
  44 /*
  45   TODO:
  46
  47   * Junk hardcoded sustain/sostenuto/una_corda distinction;
  48     Softcode using (list (sustain-event SustainPedal PianoPedalBracket) ... )
  49
  50   * Try to use same engraver for dynamics.
  51 */
  52
  53 /* Ugh: This declaration is duplicated in piano-pedal-performer */
  54 enum Pedal_type
  55 {
  56   SOSTENUTO,
  57   SUSTAIN,
  58   UNA_CORDA,
  59   NUM_PEDAL_TYPES
  60 };
  61
  62 /*
  63   Static precalculated data (symbols and strings) for the different
  64   pedal types
  65 */
  66 struct Pedal_type_info
  67 {
  68   string base_name_;
  69   SCM event_class_sym_;
  70   SCM style_sym_;
  71   SCM strings_sym_;
  72
  73   const char *pedal_c_str_;
  74
  75   Pedal_type_info ()
  76   {
  77     event_class_sym_ = SCM_EOL;
  78     style_sym_ = SCM_EOL;
  79     strings_sym_ = SCM_EOL;
  80     pedal_c_str_ = 0;
  81   }
  82   void protect ()
  83   {
  84     scm_gc_protect_object (event_class_sym_);
  85     scm_gc_protect_object (style_sym_);
  86     scm_gc_protect_object (strings_sym_);
  87   }
  88 };
  89
  90 struct Pedal_info
  91 {
  92   const Pedal_type_info *type_;
  93
  94   /*
  95     Event for currently running pedal.
  96   */
  97   Stream_event *current_bracket_ev_;
  98
  99   /*
 100     Event for currently starting pedal, (necessary?
 101
 102     distinct from current_bracket_ev_, since current_bracket_ev_ only
 103     necessary for brackets, not for text style.
 104   */
 105   Stream_event *start_ev_;
 106
 107   /*
 108     Events that were found in this timestep.
 109   */
 110   Drul_array<Stream_event *> event_drul_;
 111   Item *item_;
 112   Spanner *bracket_; // A single portion of a pedal bracket
 113   Spanner *finished_bracket_;
 114 };
 115
 116 static Pedal_type_info pedal_types_[NUM_PEDAL_TYPES];
 117
 118 class Piano_pedal_engraver : public Engraver
 119 {
 120 public:
 121   TRANSLATOR_DECLARATIONS (Piano_pedal_engraver);
 122
 123 protected:
 124   virtual void initialize ();
 125   virtual void finalize ();
 126   DECLARE_TRANSLATOR_LISTENER (sustain);
 127   DECLARE_TRANSLATOR_LISTENER (una_corda);
 128   DECLARE_TRANSLATOR_LISTENER (sostenuto);
 129   void stop_translation_timestep ();
 130   void process_music ();
 131
 132 private:
 133   Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
 134
 135   void create_text_grobs (Pedal_info *p, bool);
 136   void create_bracket_grobs (Pedal_info *p, bool);
 137   void typeset_all (Pedal_info *p);
 138 };
 139
 140 static void
 141 init_pedal_types ()
 142 {
 143   const char *names [NUM_PEDAL_TYPES];
 144   names[SOSTENUTO] = "Sostenuto";
 145   names[SUSTAIN] = "Sustain";
 146   names[UNA_CORDA] = "UnaCorda";
 147
 148   for (int i = 0; i < NUM_PEDAL_TYPES; i++)
 149     {
 150       const char *name = names[i];
 151       /* FooBar */
 152       string base_name = name;
 153       /* foo-bar */
 154       string base_ident = "";
 155       int prev_pos = 0;
 156       int cur_pos;
 157       for (cur_pos = 1; name[cur_pos]; cur_pos++)
 158         if (isupper (name[cur_pos]))
 159           {
 160             base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-";
 161             prev_pos = cur_pos;
 162           }
 163       base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos));
 164
 165       /*
 166         be careful, as we don't want to loose references to the _sym_ members.
 167        */
 168       Pedal_type_info info;
 169       info.event_class_sym_ = scm_from_locale_symbol ((base_ident + "-event").c_str ());
 170       info.style_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Style").c_str ());
 171       info.strings_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Strings").c_str ());
 172
 173       info.base_name_ = name;
 174       info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ());
 175
 176       info.protect ();
 177
 178       pedal_types_[i] = info;
 179     }
 180 }
 181
 182 ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types);
 183
 184 Piano_pedal_engraver::Piano_pedal_engraver ()
 185 {
 186 }
 187
 188 void
 189 Piano_pedal_engraver::initialize ()
 190 {
 191   for (int i = 0; i < NUM_PEDAL_TYPES; i++)
 192     {
 193       Pedal_type_info *s = &pedal_types_[i];
 194       Pedal_info *info = &info_list_[i];
 195
 196       info->type_ = s;
 197       info->item_ = 0;
 198       info->bracket_ = 0;
 199       info->finished_bracket_ = 0;
 200       info->current_bracket_ev_ = 0;
 201       info->event_drul_[START] = 0;
 202       info->event_drul_[STOP] = 0;
 203       info->start_ev_ = 0;
 204     }
 205   info_list_[NUM_PEDAL_TYPES].type_ = 0;
 206 }
 207
 208 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
 209 void
 210 Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
 211 {
 212   Direction d = to_dir (ev->get_property ("span-direction"));
 213   ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
 214 }
 215
 216 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
 217 void
 218 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
 219 {
 220   Direction d = to_dir (ev->get_property ("span-direction"));
 221   ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
 222 }
 223
 224 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda);
 225 void
 226 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
 227 {
 228   Direction d = to_dir (ev->get_property ("span-direction"));
 229   ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
 230 }
 231
 232 void
 233 Piano_pedal_engraver::process_music ()
 234 {
 235   for (Pedal_info *p = info_list_; p->type_; p++)
 236     {
 237       if (p->event_drul_[STOP] || p->event_drul_[START])
 238         {
 239           /* Choose the appropriate grobs to add to the line spanner
 240              These can be text items or text-spanners
 241           */
 242
 243           /*
 244             ugh, code dup, should read grob to create from other
 245             property.
 246
 247             bracket: |_________/\____|
 248             text:    Ped.     *Ped.  *
 249             mixed:   Ped. _____/\____|
 250           */
 251
 252           SCM style = internal_get_property (p->type_->style_sym_);
 253
 254           bool mixed = style == ly_symbol2scm ("mixed");
 255           bool bracket = (mixed
 256                           || style == ly_symbol2scm ("bracket"));
 257           bool text = (style == ly_symbol2scm ("text")
 258                        || mixed);
 259
 260           if (text && !p->item_)
 261             create_text_grobs (p, mixed);
 262           if (bracket)
 263             create_bracket_grobs (p, mixed);
 264         }
 265     }
 266 }
 267
 268 void
 269 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
 270 {
 271   SCM s = SCM_EOL;
 272   SCM strings = internal_get_property (p->type_->strings_sym_);
 273
 274   if (scm_ilength (strings) < 3)
 275     {
 276       Stream_event *m = p->event_drul_[START];
 277       if (!m) m = p->event_drul_ [STOP];
 278
 279       string msg = _f ("expect 3 strings for piano pedals, found: %ld",
 280                        scm_ilength (strings));
 281       if (m)
 282         m->origin ()->warning (msg);
 283       else
 284         warning (msg);
 285
 286       return;
 287     }
 288
 289   if (p->event_drul_[STOP] && p->event_drul_[START])
 290     {
 291       if (!mixed)
 292         {
 293           if (!p->start_ev_)
 294             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 295           else
 296             s = scm_cadr (strings);
 297           p->start_ev_ = p->event_drul_[START];
 298         }
 299     }
 300   else if (p->event_drul_[STOP])
 301     {
 302       if (!mixed)
 303         {
 304           if (!p->start_ev_)
 305             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 306           else
 307             s = scm_caddr (strings);
 308           p->start_ev_ = 0;
 309         }
 310     }
 311   else if (p->event_drul_[START])
 312     {
 313       p->start_ev_ = p->event_drul_[START];
 314       s = scm_car (strings);
 315     }
 316
 317   if (scm_is_string (s))
 318     {
 319       const char *propname = p->type_->pedal_c_str_;
 320
 321       p->item_ = make_item (propname, (p->event_drul_[START]
 322                                        ? p->event_drul_[START]
 323                                        : p->event_drul_[STOP])->self_scm ());
 324
 325       p->item_->set_property ("text", s);
 326     }
 327
 328   if (!mixed)
 329     {
 330       p->event_drul_[START] = 0;
 331       p->event_drul_[STOP] = 0;
 332     }
 333 }
 334
 335 void
 336 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 337 {
 338   if (!p->bracket_ && p->event_drul_[STOP])
 339     {
 340       string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
 341       p->event_drul_[STOP]->origin ()->warning (msg);
 342       p->event_drul_[STOP] = 0;
 343     }
 344
 345   if (p->event_drul_[STOP])
 346     {
 347       assert (!p->finished_bracket_);
 348
 349       Grob *cmc = Grob::unsmob (get_property ("currentMusicalColumn"));
 350       p->bracket_->set_bound (RIGHT, cmc);
 351
 352       /*
 353         Set properties so that the stencil-creating function will
 354         know whether the right edge should be flared ___/
 355       */
 356
 357       if (!p->event_drul_[START])
 358         {
 359           SCM flare = p->bracket_->get_property ("bracket-flare");
 360           if (scm_is_pair (flare))
 361             p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
 362                                                                   scm_from_double (0)));
 363         }
 364
 365       p->finished_bracket_ = p->bracket_;
 366       p->bracket_ = 0;
 367
 368       announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
 369
 370       p->current_bracket_ev_ = 0;
 371     }
 372
 373   if (p->event_drul_[START])
 374     {
 375       p->start_ev_ = p->event_drul_[START];
 376       p->current_bracket_ev_ = p->event_drul_[START];
 377
 378       p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
 379
 380       /*
 381         Set properties so that the stencil-creating function will
 382         know whether the left edge should be flared \___
 383       */
 384
 385       if (!p->finished_bracket_)
 386         {
 387           SCM flare = p->bracket_->get_property ("bracket-flare");
 388           p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
 389         }
 390
 391       /* Set this property for 'mixed style' pedals,    Ped._______/\ ,
 392          so the stencil function will shorten the ____ line by the length of the Ped. text.
 393       */
 394
 395       if (mixed)
 396         {
 397           /*
 398             Mixed style: Store a pointer to the preceding text for use in
 399             calculating the length of the line
 400
 401
 402             TODO:
 403
 404             WTF is pedal-text not the bound of the object? --hwn
 405           */
 406           if (p->item_)
 407             p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
 408         }
 409     }
 410
 411   p->event_drul_[START] = 0;
 412   p->event_drul_[STOP] = 0;
 413 }
 414
 415 void
 416 Piano_pedal_engraver::finalize ()
 417 {
 418   for (Pedal_info *p = info_list_; p->type_; p++)
 419     {
 420       if (p->bracket_
 421           && !p->bracket_->is_live ())
 422         p->bracket_ = 0;
 423
 424       if (p->bracket_)
 425         {
 426           SCM cc = get_property ("currentCommandColumn");
 427           Item *c = unsmob_item (cc);
 428           p->bracket_->set_bound (RIGHT, c);
 429
 430           p->finished_bracket_ = p->bracket_;
 431           p->bracket_ = 0;
 432           typeset_all (p);
 433         }
 434
 435     }
 436 }
 437
 438 void
 439 Piano_pedal_engraver::stop_translation_timestep ()
 440 {
 441   for (Pedal_info *p = info_list_; p->type_; p++)
 442     {
 443
 444       typeset_all (p);
 445       if (p->bracket_ && !p->bracket_->get_bound (LEFT))
 446         {
 447           Grob *cmc = Grob::unsmob (get_property ("currentMusicalColumn"));
 448           p->bracket_->set_bound (LEFT, cmc);
 449         }
 450     }
 451
 452   for (Pedal_info *p = info_list_; p->type_; p++)
 453     {
 454       p->event_drul_[STOP] = 0;
 455       p->event_drul_[START] = 0;
 456     }
 457 }
 458
 459 void
 460 Piano_pedal_engraver::typeset_all (Pedal_info *p)
 461 {
 462   /*
 463     Handle suicide.
 464   */
 465   if (p->finished_bracket_
 466       && !p->finished_bracket_->is_live ())
 467     p->finished_bracket_ = 0;
 468
 469   if (p->item_)
 470     p->item_ = 0;
 471
 472   if (p->finished_bracket_)
 473     {
 474       Grob *r = p->finished_bracket_->get_bound (RIGHT);
 475       if (!r)
 476         p->finished_bracket_->set_bound (RIGHT, Grob::unsmob (get_property ("currentMusicalColumn")));
 477
 478       p->finished_bracket_ = 0;
 479     }
 480 }
 481
 482 ADD_TRANSLATOR (Piano_pedal_engraver,
 483                 /* doc */
 484                 "Engrave piano pedal symbols and brackets.",
 485
 486                 /* create */
 487                 "PianoPedalBracket "
 488                 "SostenutoPedal "
 489                 "SustainPedal "
 490                 "UnaCordaPedal ",
 491
 492                 /* read */
 493                 "currentCommandColumn "
 494                 "pedalSostenutoStrings "
 495                 "pedalSostenutoStyle "
 496                 "pedalSustainStrings "
 497                 "pedalSustainStyle "
 498                 "pedalUnaCordaStrings "
 499                 "pedalUnaCordaStyle ",
 500
 501                 /* write */
 502                 ""
 503                );