lily/dynamic-performer.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
   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 "performer.hh"
  21 #include "audio-item.hh"
  22 #include "stream-event.hh"
  23 #include "international.hh"
  24
  25 #include "translator.icc"
  26
  27 class Dynamic_performer : public Performer
  28 {
  29 public:
  30   TRANSLATOR_DECLARATIONS (Dynamic_performer);
  31 protected:
  32   void stop_translation_timestep ();
  33   void process_music ();
  34   Real equalize_volume (Real);
  35
  36   void listen_decrescendo (Stream_event *);
  37   void listen_crescendo (Stream_event *);
  38   void listen_absolute_dynamic (Stream_event *);
  39 private:
  40   Stream_event *script_event_;
  41   Drul_array<Stream_event *> span_events_;
  42   Drul_array<Direction> grow_dir_;
  43   Real last_volume_;
  44   Audio_dynamic *absolute_;
  45   Audio_span_dynamic *span_dynamic_;
  46   Audio_span_dynamic *finished_span_dynamic_;
  47 };
  48
  49 Dynamic_performer::Dynamic_performer ()
  50 {
  51   last_volume_ = -1;
  52   script_event_ = 0;
  53   absolute_ = 0;
  54   span_events_[LEFT]
  55     = span_events_[RIGHT] = 0;
  56   span_dynamic_ = 0;
  57   finished_span_dynamic_ = 0;
  58 }
  59
  60 Real
  61 Dynamic_performer::equalize_volume (Real volume)
  62 {
  63   /*
  64     properties override default equaliser setting
  65   */
  66   SCM min = get_property ("midiMinimumVolume");
  67   SCM max = get_property ("midiMaximumVolume");
  68   if (scm_is_number (min) || scm_is_number (max))
  69     {
  70       Interval iv (0, 1);
  71       if (scm_is_number (min))
  72         iv[MIN] = scm_to_double (min);
  73       if (scm_is_number (max))
  74         iv[MAX] = scm_to_double (max);
  75       volume = iv[MIN] + iv.length () * volume;
  76     }
  77   else
  78     {
  79       /*
  80         urg, code duplication:: staff_performer
  81       */
  82       SCM s = get_property ("midiInstrument");
  83
  84       if (!scm_is_string (s))
  85         s = get_property ("instrumentName");
  86
  87       if (!scm_is_string (s))
  88         s = scm_from_ascii_string ("piano");
  89
  90       SCM eq = get_property ("instrumentEqualizer");
  91       if (ly_is_procedure (eq))
  92         s = scm_call_1 (eq, s);
  93
  94       if (is_number_pair (s))
  95         {
  96           Interval iv = ly_scm2interval (s);
  97           volume = iv[MIN] + iv.length () * volume;
  98         }
  99     }
 100   return volume;
 101 }
 102
 103 void
 104 Dynamic_performer::process_music ()
 105 {
 106   if (span_events_[STOP] || script_event_)
 107     {
 108       // End of a dynamic spanner, or an explicit dynamic script event.
 109       finished_span_dynamic_ = span_dynamic_;
 110       span_dynamic_ = 0;
 111     }
 112
 113   if (span_events_[START])
 114     {
 115       // Start of a dynamic spanner.  Create a new Audio_span_dynamic for
 116       // collecting changes in dynamics within this spanner.
 117       span_dynamic_ = new Audio_span_dynamic (equalize_volume (0.1), equalize_volume (1.0));
 118       announce_element (Audio_element_info (span_dynamic_, span_events_[START]));
 119
 120       span_dynamic_->grow_dir_ = grow_dir_[START];
 121     }
 122
 123   if (script_event_
 124       || span_dynamic_
 125       || finished_span_dynamic_)
 126     {
 127       // New change in dynamics.
 128       absolute_ = new Audio_dynamic ();
 129
 130       if (script_event_)
 131         {
 132           // Explicit dynamic script event: determine the volume.
 133           SCM proc = get_property ("dynamicAbsoluteVolumeFunction");
 134
 135           SCM svolume = SCM_EOL;
 136           if (ly_is_procedure (proc))
 137             {
 138               // urg
 139               svolume = scm_call_1 (proc, script_event_->get_property ("text"));
 140             }
 141
 142           Real volume = robust_scm2double (svolume, 0.5);
 143
 144           last_volume_
 145             = absolute_->volume_ = equalize_volume (volume);
 146         }
 147
 148       Audio_element_info info (absolute_, script_event_);
 149       announce_element (info);
 150     }
 151
 152   if (last_volume_ < 0)
 153     {
 154       absolute_ = new Audio_dynamic ();
 155
 156       last_volume_
 157         = absolute_->volume_ = equalize_volume (0.71); // Backward compatible
 158
 159       Audio_element_info info (absolute_, script_event_);
 160       announce_element (info);
 161     }
 162
 163   if (span_dynamic_)
 164     span_dynamic_->add_absolute (absolute_);
 165
 166   if (finished_span_dynamic_)
 167     finished_span_dynamic_->add_absolute (absolute_);
 168 }
 169
 170 void
 171 Dynamic_performer::stop_translation_timestep ()
 172 {
 173   if (finished_span_dynamic_)
 174     {
 175       finished_span_dynamic_->render ();
 176       finished_span_dynamic_ = 0;
 177     }
 178
 179   if (absolute_)
 180     {
 181       if (absolute_->volume_ < 0)
 182         {
 183           absolute_->volume_ = last_volume_;
 184         }
 185       else
 186         {
 187           last_volume_ = absolute_->volume_;
 188         }
 189     }
 190
 191   absolute_ = 0;
 192   script_event_ = 0;
 193   span_events_[LEFT]
 194     = span_events_[RIGHT] = 0;
 195 }
 196
 197 void
 198 Dynamic_performer::listen_decrescendo (Stream_event *r)
 199 {
 200   Direction d = to_dir (r->get_property ("span-direction"));
 201   span_events_[d] = r;
 202   grow_dir_[d] = SMALLER;
 203 }
 204
 205 void
 206 Dynamic_performer::listen_crescendo (Stream_event *r)
 207 {
 208   Direction d = to_dir (r->get_property ("span-direction"));
 209   span_events_[d] = r;
 210   grow_dir_[d] = BIGGER;
 211 }
 212
 213 void
 214 Dynamic_performer::listen_absolute_dynamic (Stream_event *r)
 215 {
 216   if (!script_event_)
 217     script_event_ = r;
 218 }
 219
 220 void
 221 Dynamic_performer::boot ()
 222 {
 223   ADD_LISTENER (Dynamic_performer, decrescendo);
 224   ADD_LISTENER (Dynamic_performer, crescendo);
 225   ADD_LISTENER (Dynamic_performer, absolute_dynamic);
 226 }
 227
 228 ADD_TRANSLATOR (Dynamic_performer,
 229                 /* doc */
 230                 "",
 231
 232                 /* create */
 233                 "",
 234
 235                 /* read */
 236                 "dynamicAbsoluteVolumeFunction "
 237                 "instrumentEqualizer "
 238                 "midiMaximumVolume "
 239                 "midiMinimumVolume "
 240                 "midiInstrument ",
 241
 242                 /* write */
 243                 ""
 244                );