lily/piano-pedal-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2011 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
  54 /* Ugh: This declaration is duplicated in piano-pedal-performer */
  55 enum Pedal_type {
  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   DECLARE_ACKNOWLEDGER (note_column);
 130   void stop_translation_timestep ();
 131   void process_music ();
 132
 133 private:
 134   Pedal_info info_list_[NUM_PEDAL_TYPES + 1];
 135
 136   void create_text_grobs (Pedal_info *p, bool);
 137   void create_bracket_grobs (Pedal_info *p, bool);
 138   void typeset_all (Pedal_info *p);
 139 };
 140
 141
 142 static void
 143 init_pedal_types ()
 144 {
 145   const char *names [NUM_PEDAL_TYPES];
 146   names[SOSTENUTO] = "Sostenuto";
 147   names[SUSTAIN] = "Sustain";
 148   names[UNA_CORDA] = "UnaCorda";
 149
 150   for (int i = 0; i < NUM_PEDAL_TYPES; i++)
 151     {
 152       const char *name = names[i];
 153       /* FooBar */
 154       string base_name = name;
 155       /* foo-bar */
 156       string base_ident = "";
 157       int prev_pos=0;
 158       int cur_pos;
 159       for (cur_pos = 1; name[cur_pos]; cur_pos++)
 160         if (isupper (name[cur_pos]))
 161           {
 162             base_ident = base_ident + String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos)) + "-";
 163             prev_pos = cur_pos;
 164           }
 165       base_ident += String_convert::to_lower (string (name, prev_pos, cur_pos - prev_pos));
 166
 167       /*
 168         be careful, as we don't want to loose references to the _sym_ members.
 169        */
 170       Pedal_type_info info;
 171       info.event_class_sym_ = scm_from_locale_symbol ((base_ident + "-event").c_str ());
 172       info.style_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Style").c_str ());
 173       info.strings_sym_ = scm_from_locale_symbol (("pedal" + base_name + "Strings").c_str ());
 174
 175       info.base_name_ = name;
 176       info.pedal_c_str_ = strdup ((base_name + "Pedal").c_str ());
 177
 178       info.protect ();
 179
 180       pedal_types_[i] = info;
 181     }
 182 }
 183
 184 ADD_SCM_INIT_FUNC (Piano_pedal_engraver_init_pedal_types_, init_pedal_types);
 185
 186 Piano_pedal_engraver::Piano_pedal_engraver ()
 187 {
 188 }
 189
 190 void
 191 Piano_pedal_engraver::initialize ()
 192 {
 193   for (int i = 0; i < NUM_PEDAL_TYPES; i++)
 194     {
 195       Pedal_type_info *s = &pedal_types_[i];
 196       Pedal_info *info = &info_list_[i];
 197
 198       info->type_ = s;
 199       info->item_ = 0;
 200       info->bracket_ = 0;
 201       info->finished_bracket_ = 0;
 202       info->current_bracket_ev_ = 0;
 203       info->event_drul_[START] = 0;
 204       info->event_drul_[STOP] = 0;
 205       info->start_ev_ = 0;
 206     }
 207   info_list_[NUM_PEDAL_TYPES].type_ = 0;
 208 }
 209
 210
 211 /*
 212   Urg: Code dup
 213   I'm a script
 214 */
 215 void
 216 Piano_pedal_engraver::acknowledge_note_column (Grob_info info)
 217 {
 218   for (Pedal_info *p = info_list_; p->type_; p++)
 219     {
 220       if (p->bracket_)
 221         add_bound_item (p->bracket_, info.grob ());
 222       if (p->finished_bracket_)
 223         add_bound_item (p->finished_bracket_, info.grob ());
 224     }
 225 }
 226
 227 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sostenuto);
 228 void
 229 Piano_pedal_engraver::listen_sostenuto (Stream_event *ev)
 230 {
 231   Direction d = to_dir (ev->get_property ("span-direction"));
 232   ASSIGN_EVENT_ONCE (info_list_[SOSTENUTO].event_drul_[d], ev);
 233 }
 234
 235 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, sustain);
 236 void
 237 Piano_pedal_engraver::listen_sustain (Stream_event *ev)
 238 {
 239   Direction d = to_dir (ev->get_property ("span-direction"));
 240   ASSIGN_EVENT_ONCE (info_list_[SUSTAIN].event_drul_[d], ev);
 241 }
 242
 243 IMPLEMENT_TRANSLATOR_LISTENER (Piano_pedal_engraver, una_corda);
 244 void
 245 Piano_pedal_engraver::listen_una_corda (Stream_event *ev)
 246 {
 247   Direction d = to_dir (ev->get_property ("span-direction"));
 248   ASSIGN_EVENT_ONCE (info_list_[UNA_CORDA].event_drul_[d], ev);
 249 }
 250
 251 void
 252 Piano_pedal_engraver::process_music ()
 253 {
 254   for (Pedal_info *p = info_list_; p->type_; p++)
 255     {
 256       if (p->event_drul_[STOP] || p->event_drul_[START])
 257         {
 258           /* Choose the appropriate grobs to add to the line spanner
 259              These can be text items or text-spanners
 260           */
 261
 262           /*
 263             ugh, code dup, should read grob to create from other
 264             property.
 265
 266             bracket: |_________/\____|
 267             text:    Ped.     *Ped.  *
 268             mixed:   Ped. _____/\____|
 269           */
 270
 271           SCM style = internal_get_property (p->type_->style_sym_);
 272
 273           bool mixed = style == ly_symbol2scm ("mixed");
 274           bool bracket = (mixed
 275                           || style == ly_symbol2scm ("bracket"));
 276           bool text = (style == ly_symbol2scm ("text")
 277                        || mixed);
 278
 279           if (text && !p->item_)
 280             create_text_grobs (p, mixed);
 281           if (bracket)
 282             create_bracket_grobs (p, mixed);
 283         }
 284     }
 285 }
 286
 287 void
 288 Piano_pedal_engraver::create_text_grobs (Pedal_info *p, bool mixed)
 289 {
 290   SCM s = SCM_EOL;
 291   SCM strings = internal_get_property (p->type_->strings_sym_);
 292
 293   if (scm_ilength (strings) < 3)
 294     {
 295       Stream_event *m = p->event_drul_[START];
 296       if (!m) m = p->event_drul_ [STOP];
 297
 298       string msg = _f ("expect 3 strings for piano pedals, found: %ld",
 299                        scm_ilength (strings));
 300       if (m)
 301         m->origin ()->warning (msg);
 302       else
 303         warning (msg);
 304
 305       return;
 306     }
 307
 308   if (p->event_drul_[STOP] && p->event_drul_[START])
 309     {
 310       if (!mixed)
 311         {
 312           if (!p->start_ev_)
 313             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 314           else
 315             s = scm_cadr (strings);
 316           p->start_ev_ = p->event_drul_[START];
 317         }
 318     }
 319   else if (p->event_drul_[STOP])
 320     {
 321       if (!mixed)
 322         {
 323           if (!p->start_ev_)
 324             p->event_drul_[STOP]->origin ()->warning (_f ("cannot find start of piano pedal: `%s'", p->type_->base_name_.c_str ()));
 325           else
 326             s = scm_caddr (strings);
 327           p->start_ev_ = 0;
 328         }
 329     }
 330   else if (p->event_drul_[START])
 331     {
 332       p->start_ev_ = p->event_drul_[START];
 333       s = scm_car (strings);
 334       }
 335
 336   if (scm_is_string (s))
 337     {
 338       const char *propname = p->type_->pedal_c_str_;
 339
 340       p->item_ = make_item (propname, (p->event_drul_[START]
 341                                        ? p->event_drul_[START]
 342                                        : p->event_drul_[STOP])->self_scm ());
 343
 344       p->item_->set_property ("text", s);
 345     }
 346
 347   if (!mixed)
 348     {
 349       p->event_drul_[START] = 0;
 350       p->event_drul_[STOP] = 0;
 351     }
 352 }
 353
 354 void
 355 Piano_pedal_engraver::create_bracket_grobs (Pedal_info *p, bool mixed)
 356 {
 357   if (!p->bracket_ && p->event_drul_[STOP])
 358     {
 359       string msg = _f ("cannot find start of piano pedal bracket: `%s'", p->type_->base_name_.c_str ());
 360       p->event_drul_[STOP]->origin ()->warning (msg);
 361       p->event_drul_[STOP] = 0;
 362     }
 363
 364   if (p->event_drul_[STOP])
 365     {
 366       assert (!p->finished_bracket_);
 367
 368       Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
 369
 370       if (!p->bracket_->get_bound (RIGHT))
 371         p->bracket_->set_bound (RIGHT, cmc);
 372
 373       /*
 374         Set properties so that the stencil-creating function will
 375         know whether the right edge should be flared ___/
 376       */
 377
 378       if (!p->event_drul_[START])
 379         {
 380           SCM flare = p->bracket_->get_property ("bracket-flare");
 381           if (scm_is_pair (flare))
 382             p->bracket_->set_property ("bracket-flare", scm_cons (scm_car (flare),
 383                                                                   scm_from_double (0)));
 384         }
 385
 386       p->finished_bracket_ = p->bracket_;
 387       p->bracket_ = 0;
 388
 389       announce_end_grob (p->finished_bracket_, p->event_drul_[STOP]->self_scm ());
 390
 391       p->current_bracket_ev_ = 0;
 392     }
 393
 394   if (p->event_drul_[START])
 395     {
 396       p->start_ev_ = p->event_drul_[START];
 397       p->current_bracket_ev_ = p->event_drul_[START];
 398
 399       p->bracket_ = make_spanner ("PianoPedalBracket", p->event_drul_[START]->self_scm ());
 400
 401       /*
 402         Set properties so that the stencil-creating function will
 403         know whether the left edge should be flared \___
 404       */
 405
 406       if (!p->finished_bracket_)
 407         {
 408           SCM flare = p->bracket_->get_property ("bracket-flare");
 409           p->bracket_->set_property ("bracket-flare", scm_cons (scm_from_double (0), scm_cdr (flare)));
 410         }
 411
 412       /* Set this property for 'mixed style' pedals,    Ped._______/\ ,
 413          so the stencil function will shorten the ____ line by the length of the Ped. text.
 414       */
 415
 416       if (mixed)
 417         {
 418           /*
 419             Mixed style: Store a pointer to the preceding text for use in
 420             calculating the length of the line
 421
 422
 423             TODO:
 424
 425             WTF is pedal-text not the bound of the object? --hwn
 426           */
 427           if (p->item_)
 428             p->bracket_->set_object ("pedal-text", p->item_->self_scm ());
 429         }
 430     }
 431
 432   p->event_drul_[START] = 0;
 433   p->event_drul_[STOP] = 0;
 434 }
 435
 436 void
 437 Piano_pedal_engraver::finalize ()
 438 {
 439   for (Pedal_info *p = info_list_; p->type_; p++)
 440     {
 441       if (p->bracket_
 442           && !p->bracket_->is_live ())
 443         p->bracket_ = 0;
 444
 445       if (p->bracket_)
 446         {
 447           SCM cc = get_property ("currentCommandColumn");
 448           Item *c = unsmob_item (cc);
 449           p->bracket_->set_bound (RIGHT, c);
 450
 451           p->finished_bracket_ = p->bracket_;
 452           p->bracket_ = 0;
 453           typeset_all (p);
 454         }
 455
 456     }
 457 }
 458
 459 void
 460 Piano_pedal_engraver::stop_translation_timestep ()
 461 {
 462   for (Pedal_info *p = info_list_; p->type_; p++)
 463     {
 464
 465       typeset_all (p);
 466       if (p->bracket_ && !p->bracket_->get_bound (LEFT))
 467         {
 468           Grob *cmc = unsmob_grob (get_property ("currentMusicalColumn"));
 469
 470           if (!p->bracket_->get_bound (LEFT))
 471             p->bracket_->set_bound (LEFT, cmc);
 472         }
 473     }
 474
 475   for (Pedal_info *p = info_list_; p->type_; p++)
 476     {
 477       p->event_drul_[STOP] = 0;
 478       p->event_drul_[START] = 0;
 479     }
 480 }
 481
 482 void
 483 Piano_pedal_engraver::typeset_all (Pedal_info *p)
 484 {
 485   /*
 486     Handle suicide.
 487   */
 488   if (p->finished_bracket_
 489       && !p->finished_bracket_->is_live ())
 490     p->finished_bracket_ = 0;
 491
 492   if (p->item_)
 493     p->item_ = 0;
 494
 495   if (p->finished_bracket_)
 496     {
 497       Grob *r = p->finished_bracket_->get_bound (RIGHT);
 498       if (!r)
 499         p->finished_bracket_->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
 500
 501       p->finished_bracket_ = 0;
 502     }
 503 }
 504
 505 ADD_ACKNOWLEDGER (Piano_pedal_engraver, note_column);
 506
 507 ADD_TRANSLATOR (Piano_pedal_engraver,
 508                 /* doc */
 509                 "Engrave piano pedal symbols and brackets.",
 510
 511                 /* create */
 512                 "PianoPedalBracket "
 513                 "SostenutoPedal "
 514                 "SustainPedal "
 515                 "UnaCordaPedal ",
 516
 517                 /* read */
 518                 "currentCommandColumn "
 519                 "pedalSostenutoStrings "
 520                 "pedalSostenutoStyle "
 521                 "pedalSustainStrings "
 522                 "pedalSustainStyle "
 523                 "pedalUnaCordaStrings "
 524                 "pedalUnaCordaStyle ",
 525
 526                 /* write */
 527                 ""
 528                 );