lily/piano-pedal-engraver.cc

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