lily/piano-pedal-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2015 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   void listen_sustain (Stream_event *);
 127   void listen_una_corda (Stream_event *);
 128   void listen_sostenuto (Stream_event *);
 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_ascii_symbol ((base_ident + "-event").c_str ());
 170       info.style_sym_ = scm_from_ascii_symbol (("pedal" + base_name + "Style").c_str ());
 171       info.strings_sym_ = scm_from_ascii_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 (Context *c)
 185   : Engraver (c)
 186 {
 187 }
 188
 189 void
 190 Piano_pedal_engraver::initialize ()
 191 {
 192   for (int i = 0; i < NUM_PEDAL_TYPES; i++)
 193     {
 194       Pedal_type_info *s = &pedal_types_[i];
 195       Pedal_info *info = &info_list_[i];
 196
 197       info->type_ = s;
 198       info->item_ = 0;
 199       info->bracket_ = 0;
 200       info->finished_bracket_ = 0;
 201       info->current_bracket_ev_ = 0;
 202       info->event_drul_[START] = 0;
 203       info->event_drul_[STOP] = 0;
 204       info->start_ev_ = 0;
 205     }
 206   info_list_[NUM_PEDAL_TYPES].type_ = 0;
 207 }
 208
 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 void
 217 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
 218 {
 219   Direction d = to_dir (ev->get_property ("span-direction"));
 220   ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
 221 }
 222
 223 void
 224 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
 225 {
 226   Direction d = to_dir (ev->get_property ("span-direction"));
 227   ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
 228 }
 229
 230 void
 231 Piano_pedal_engraver::process_music ()
 232 {
 233   for (Pedal_info *p = info_list_; p->type_; p++)
 234     {
 235       if (p->event_drul_[STOP] || p->event_drul_[START])
 236         {
 237           /* Choose the appropriate grobs to add to the line spanner
 238              These can be text items or text-spanners
 239           */
 240
 241           /*
 242             ugh, code dup, should read grob to create from other
 243             property.
 244
 245             bracket: |_________/\____|
 246             text:    Ped.     *Ped.  *
 247             mixed:   Ped. _____/\____|
 248           */
 249
 250           SCM style = get_property (p->type_->style_sym_);
 251
 252           bool mixed = scm_is_eq (style, ly_symbol2scm ("mixed"));
 253           bool bracket = (mixed
 254                           || scm_is_eq (style, ly_symbol2scm ("bracket")));
 255           bool text = (mixed
 256                        || scm_is_eq (style, ly_symbol2scm ("text")));
 257
 258           if (text && !p->item_)
 259             create_text_grobs (p, mixed);
 260           if (bracket)
 261             create_bracket_grobs (p, mixed);
 262         }
 263     }
 264 }
 265
 266 void
 267 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
 268 {
 269   SCM s = SCM_EOL;
 270   SCM strings = get_property (p->type_->strings_sym_);
 271
 272   if (scm_ilength (strings) < 3)
 273     {
 274       Stream_event *m = p->event_drul_[START];
 275       if (!m) m = p->event_drul_ [STOP];
 276
 277       string msg = _f ("expect 3 strings for piano pedals, found: %ld",
 278                        scm_ilength (strings));
 279       if (m)
 280         m->origin ()->warning (msg);
 281       else
 282         warning (msg);
 283
 284       return;
 285     }
 286
 287   if (p->event_drul_[STOP] && p->event_drul_[START])
 288     {
 289       if (!mixed)
 290         {
 291           if (!p->start_ev_)
 292             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 293           else
 294             s = scm_cadr (strings);
 295           p->start_ev_ = p->event_drul_[START];
 296         }
 297     }
 298   else if (p->event_drul_[STOP])
 299     {
 300       if (!mixed)
 301         {
 302           if (!p->start_ev_)
 303             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 304           else
 305             s = scm_caddr (strings);
 306           p->start_ev_ = 0;
 307         }
 308     }
 309   else if (p->event_drul_[START])
 310     {
 311       p->start_ev_ = p->event_drul_[START];
 312       s = scm_car (strings);
 313     }
 314
 315   if (scm_is_string (s))
 316     {
 317       const char *propname = p->type_->pedal_c_str_;
 318
 319       p->item_ = make_item (propname, (p->event_drul_[START]
 320                                        ? p->event_drul_[START]
 321                                        : p->event_drul_[STOP])->self_scm ());
 322
 323       p->item_->set_property ("text", s);
 324     }
 325
 326   if (!mixed)
 327     {
 328       p->event_drul_[START] = 0;
 329       p->event_drul_[STOP] = 0;
 330     }
 331 }
 332
 333 void
 334 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 335 {
 336   if (!p->bracket_ && p->event_drul_[STOP])
 337     {
 338       string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
 339       p->event_drul_[STOP]->origin ()->warning (msg);
 340       p->event_drul_[STOP] = 0;
 341     }
 342
 343   if (p->event_drul_[STOP])
 344     {
 345       assert (!p->finished_bracket_);
 346
 347       Grob *cmc = unsmob<Grob> (get_property ("currentMusicalColumn"));
 348       p->bracket_->set_bound (RIGHT, cmc);
 349
 350       /*
 351         Set properties so that the stencil-creating function will
 352         know whether the right edge should be flared ___/
 353       */
 354
 355       if (!p->event_drul_[START])
 356         {
 357           SCM flare = p->bracket_->get_property ("bracket-flare");
 358           if (scm_is_pair (flare))
 359             p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
 360                                                                   scm_from_double (0)));
 361         }
 362
 363       p->finished_bracket_ = p->bracket_;
 364       p->bracket_ = 0;
 365
 366       announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
 367
 368       p->current_bracket_ev_ = 0;
 369     }
 370
 371   if (p->event_drul_[START])
 372     {
 373       p->start_ev_ = p->event_drul_[START];
 374       p->current_bracket_ev_ = p->event_drul_[START];
 375
 376       p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
 377
 378       /*
 379         Set properties so that the stencil-creating function will
 380         know whether the left edge should be flared \___
 381       */
 382
 383       if (!p->finished_bracket_)
 384         {
 385           SCM flare = p->bracket_->get_property ("bracket-flare");
 386           p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
 387         }
 388
 389       /* Set this property for 'mixed style' pedals,    Ped._______/\ ,
 390          so the stencil function will shorten the ____ line by the length of the Ped. text.
 391       */
 392
 393       if (mixed)
 394         {
 395           /*
 396             Mixed style: Store a pointer to the preceding text for use in
 397             calculating the length of the line
 398
 399
 400             TODO:
 401
 402             WTF is pedal-text not the bound of the object? --hwn
 403           */
 404           if (p->item_)
 405             p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
 406         }
 407     }
 408
 409   p->event_drul_[START] = 0;
 410   p->event_drul_[STOP] = 0;
 411 }
 412
 413 void
 414 Piano_pedal_engraver::finalize ()
 415 {
 416   for (Pedal_info *p = info_list_; p->type_; p++)
 417     {
 418       if (p->bracket_
 419           && !p->bracket_->is_live ())
 420         p->bracket_ = 0;
 421
 422       if (p->bracket_)
 423         {
 424           SCM cc = get_property ("currentCommandColumn");
 425           Item *c = unsmob<Item> (cc);
 426           p->bracket_->set_bound (RIGHT, c);
 427
 428           p->finished_bracket_ = p->bracket_;
 429           p->bracket_ = 0;
 430           typeset_all (p);
 431         }
 432
 433     }
 434 }
 435
 436 void
 437 Piano_pedal_engraver::stop_translation_timestep ()
 438 {
 439   for (Pedal_info *p = info_list_; p->type_; p++)
 440     {
 441
 442       typeset_all (p);
 443       if (p->bracket_ && !p->bracket_->get_bound (LEFT))
 444         {
 445           Grob *cmc = unsmob<Grob> (get_property ("currentMusicalColumn"));
 446           p->bracket_->set_bound (LEFT, cmc);
 447         }
 448     }
 449
 450   for (Pedal_info *p = info_list_; p->type_; p++)
 451     {
 452       p->event_drul_[STOP] = 0;
 453       p->event_drul_[START] = 0;
 454     }
 455 }
 456
 457 void
 458 Piano_pedal_engraver::typeset_all (Pedal_info *p)
 459 {
 460   /*
 461     Handle suicide.
 462   */
 463   if (p->finished_bracket_
 464       && !p->finished_bracket_->is_live ())
 465     p->finished_bracket_ = 0;
 466
 467   if (p->item_)
 468     p->item_ = 0;
 469
 470   if (p->finished_bracket_)
 471     {
 472       Grob *r = p->finished_bracket_->get_bound (RIGHT);
 473       if (!r)
 474         p->finished_bracket_->set_bound (RIGHT, unsmob<Grob> (get_property ("currentMusicalColumn")));
 475
 476       p->finished_bracket_ = 0;
 477     }
 478 }
 479
 480 void
 481 Piano_pedal_engraver::boot ()
 482 {
 483   ADD_LISTENER (Piano_pedal_engraver, sostenuto);
 484   ADD_LISTENER (Piano_pedal_engraver, sustain);
 485   ADD_LISTENER (Piano_pedal_engraver, una_corda);
 486 }
 487
 488 ADD_TRANSLATOR (Piano_pedal_engraver,
 489                 /* doc */
 490                 "Engrave piano pedal symbols and brackets.",
 491
 492                 /* create */
 493                 "PianoPedalBracket "
 494                 "SostenutoPedal "
 495                 "SustainPedal "
 496                 "UnaCordaPedal ",
 497
 498                 /* read */
 499                 "currentCommandColumn "
 500                 "pedalSostenutoStrings "
 501                 "pedalSostenutoStyle "
 502                 "pedalSustainStrings "
 503                 "pedalSustainStyle "
 504                 "pedalUnaCordaStrings "
 505                 "pedalUnaCordaStyle ",
 506
 507                 /* write */
 508                 ""
 509                );