gtk2_ardour/automation_controller.cc

   1 /*
   2     Copyright (C) 2007 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <iomanip>
  22 #include <cmath>
  23
  24 #include "pbd/compose.h"
  25 #include "pbd/error.h"
  26
  27 #include "ardour/automatable.h"
  28 #include "ardour/automation_control.h"
  29 #include "ardour/session.h"
  30 #include "ardour/tempo.h"
  31
  32 #include "ardour_button.h"
  33 #include "ardour_ui.h"
  34 #include "automation_controller.h"
  35 #include "gui_thread.h"
  36 #include "note_select_dialog.h"
  37
  38 #include "i18n.h"
  39
  40 using namespace ARDOUR;
  41 using namespace Gtk;
  42
  43 AutomationBarController::AutomationBarController (
  44                 boost::shared_ptr<Automatable>       printer,
  45                 boost::shared_ptr<AutomationControl> ac,
  46                 Adjustment*                          adj)
  47         : Gtkmm2ext::BarController(*adj, ac)
  48         , _printer(printer)
  49         , _controllable(ac)
  50 {
  51 }
  52
  53 std::string
  54 AutomationBarController::get_label (double& xpos)
  55 {
  56         xpos = 0.5;
  57         return _printer->value_as_string (_controllable);
  58 }
  59
  60 AutomationBarController::~AutomationBarController()
  61 {
  62 }
  63
  64 AutomationController::AutomationController(boost::shared_ptr<Automatable>       printer,
  65                                            boost::shared_ptr<AutomationControl> ac,
  66                                            Adjustment*                          adj)
  67         : _widget(NULL)
  68         , _printer (printer)
  69         , _controllable(ac)
  70         , _adjustment(adj)
  71         , _ignore_change(false)
  72 {
  73         assert (_printer);
  74
  75         if (ac->toggled()) {
  76                 ArdourButton* but = manage(new ArdourButton());
  77
  78                 // Apply styles for special types
  79                 if (ac->parameter().type() == MuteAutomation) {
  80                         but->set_name("mute button");
  81                 } else if (ac->parameter().type() == SoloAutomation) {
  82                         but->set_name("solo button");
  83                 } else {
  84                         but->set_name("generic button");
  85                 }
  86                 but->signal_clicked.connect(
  87                         sigc::mem_fun(*this, &AutomationController::toggled));
  88
  89                 _widget = but;
  90         } else {
  91                 AutomationBarController* bar = manage(new AutomationBarController(_printer, ac, adj));
  92
  93                 bar->set_name(X_("ProcessorControlSlider"));
  94                 bar->StartGesture.connect(
  95                         sigc::mem_fun(*this, &AutomationController::start_touch));
  96                 bar->StopGesture.connect(
  97                         sigc::mem_fun(*this, &AutomationController::end_touch));
  98                 bar->signal_button_release_event().connect(
  99                         sigc::mem_fun(*this, &AutomationController::on_button_release));
 100
 101                 _widget = bar;
 102         }
 103
 104         _adjustment->signal_value_changed().connect(
 105                 sigc::mem_fun(*this, &AutomationController::value_adjusted));
 106
 107         _screen_update_connection = ARDOUR_UI::RapidScreenUpdate.connect (
 108                         sigc::mem_fun (*this, &AutomationController::display_effective_value));
 109
 110         ac->Changed.connect (_changed_connection, invalidator (*this), boost::bind (&AutomationController::value_changed, this), gui_context());
 111
 112         add(*_widget);
 113         show_all();
 114 }
 115
 116 AutomationController::~AutomationController()
 117 {
 118 }
 119
 120 boost::shared_ptr<AutomationController>
 121 AutomationController::create(boost::shared_ptr<Automatable>       printer,
 122                              const Evoral::Parameter&             param,
 123                              const ParameterDescriptor&           desc,
 124                              boost::shared_ptr<AutomationControl> ac)
 125 {
 126         const double lo        = ac->internal_to_interface(desc.lower);
 127         const double up        = ac->internal_to_interface(desc.upper);
 128         const double normal    = ac->internal_to_interface(desc.normal);
 129         double       smallstep = desc.smallstep;
 130         double       largestep = desc.largestep;
 131         if (smallstep == 0.0) {
 132                 smallstep = up / 1000.;
 133         } else {
 134                 smallstep = ac->internal_to_interface(desc.lower + smallstep);
 135         }
 136
 137         if (largestep == 0.0) {
 138                 largestep = up / 40.;
 139         } else {
 140                 largestep = ac->internal_to_interface(desc.lower + largestep);
 141         }
 142
 143         Gtk::Adjustment* adjustment = manage (
 144                 new Gtk::Adjustment (normal, lo, up, smallstep, largestep));
 145
 146         assert (ac);
 147         assert(ac->parameter() == param);
 148         return boost::shared_ptr<AutomationController>(new AutomationController(printer, ac, adjustment));
 149 }
 150
 151 void
 152 AutomationController::display_effective_value()
 153 {
 154         double const interface_value = _controllable->internal_to_interface(_controllable->get_value());
 155
 156         if (_adjustment->get_value () != interface_value) {
 157                 _ignore_change = true;
 158                 _adjustment->set_value (interface_value);
 159                 _ignore_change = false;
 160         }
 161 }
 162
 163 void
 164 AutomationController::value_adjusted ()
 165 {
 166         if (!_ignore_change) {
 167                 _controllable->set_value (_controllable->interface_to_internal(_adjustment->get_value()));
 168         }
 169
 170         /* A bar controller will automatically follow the adjustment, but for a
 171            button we have to do it manually. */
 172         ArdourButton* but = dynamic_cast<ArdourButton*>(_widget);
 173         if (but) {
 174                 const bool active = _adjustment->get_value() >= 0.5;
 175                 if (but->get_active() != active) {
 176                         but->set_active(active);
 177                 }
 178         }
 179 }
 180
 181 void
 182 AutomationController::start_touch()
 183 {
 184         _controllable->start_touch (_controllable->session().transport_frame());
 185         StartGesture.emit();  /* EMIT SIGNAL */
 186 }
 187
 188 void
 189 AutomationController::end_touch ()
 190 {
 191         if (_controllable->automation_state() == Touch) {
 192
 193                 bool mark = false;
 194                 double when = 0;
 195
 196                 if (_controllable->session().transport_rolling()) {
 197                         mark = true;
 198                         when = _controllable->session().transport_frame();
 199                 }
 200
 201                 _controllable->stop_touch (mark, when);
 202         }
 203         StopGesture.emit();  /* EMIT SIGNAL */
 204 }
 205
 206 void
 207 AutomationController::toggled ()
 208 {
 209         ArdourButton* but = dynamic_cast<ArdourButton*>(_widget);
 210         if (but) {
 211                 if (_controllable->session().transport_rolling()) {
 212                         if (_controllable->automation_state() == Touch) {
 213                                 _controllable->set_automation_state(Write);
 214                         }
 215                         if (_controllable->list()) {
 216                                 _controllable->list()->set_in_write_pass(true, false, _controllable->session().audible_frame());
 217                         }
 218                 }
 219                 const bool was_active = _controllable->get_value() >= 0.5;
 220                 if (was_active && but->get_active()) {
 221                         _adjustment->set_value(0.0);
 222                         but->set_active(false);
 223                 } else if (!was_active && !but->get_active()) {
 224                         _adjustment->set_value(1.0);
 225                         but->set_active(true);
 226                 }
 227         }
 228 }
 229
 230 static double
 231 midi_note_to_hz(int note)
 232 {
 233         const double tuning = 440.0;
 234         return tuning * pow(2, (note - 69.0) / 12.0);
 235 }
 236
 237 static double
 238 clamp(double val, double min, double max)
 239 {
 240         if (val < min) {
 241                 return min;
 242         } else if (val > max) {
 243                 return max;
 244         }
 245         return val;
 246 }
 247
 248 void
 249 AutomationController::run_note_select_dialog()
 250 {
 251         const ARDOUR::ParameterDescriptor& desc   = _controllable->desc();
 252         NoteSelectDialog*                  dialog = new NoteSelectDialog();
 253         if (dialog->run() == Gtk::RESPONSE_ACCEPT) {
 254                 const double value = ((_controllable->desc().unit == ARDOUR::ParameterDescriptor::HZ)
 255                                       ? midi_note_to_hz(dialog->note_number())
 256                                       : dialog->note_number());
 257                 _controllable->set_value(clamp(value, desc.lower, desc.upper));
 258         }
 259         delete dialog;
 260 }
 261
 262 void
 263 AutomationController::set_freq_beats(double beats)
 264 {
 265         const ARDOUR::ParameterDescriptor& desc    = _controllable->desc();
 266         const ARDOUR::Session&             session = _controllable->session();
 267         const framepos_t                   pos     = session.transport_frame();
 268         const ARDOUR::Tempo&               tempo   = session.tempo_map().tempo_at(pos);
 269         const double                       bpm     = tempo.beats_per_minute();
 270         const double                       bps     = bpm / 60.0;
 271         const double                       freq    = bps / beats;
 272         _controllable->set_value(clamp(freq, desc.lower, desc.upper));
 273 }
 274
 275 void
 276 AutomationController::set_ratio(double ratio)
 277 {
 278         const ARDOUR::ParameterDescriptor& desc  = _controllable->desc();
 279         const double                       value = _controllable->get_value() * ratio;
 280         _controllable->set_value(clamp(value, desc.lower, desc.upper));
 281 }
 282
 283 bool
 284 AutomationController::on_button_release(GdkEventButton* ev)
 285 {
 286         using namespace Gtk::Menu_Helpers;
 287
 288         if (ev->button != 3) {
 289                 return false;
 290         }
 291
 292         const ARDOUR::ParameterDescriptor& desc = _controllable->desc();
 293         if (desc.unit == ARDOUR::ParameterDescriptor::MIDI_NOTE) {
 294                 Gtk::Menu* menu  = manage(new Menu());
 295                 MenuList&  items = menu->items();
 296                 items.push_back(MenuElem(_("Select Note..."),
 297                                          sigc::mem_fun(*this, &AutomationController::run_note_select_dialog)));
 298                 menu->popup(1, ev->time);
 299                 return true;
 300         } else if (desc.unit == ARDOUR::ParameterDescriptor::HZ) {
 301                 Gtk::Menu* menu  = manage(new Menu());
 302                 MenuList&  items = menu->items();
 303                 items.push_back(MenuElem(_("Halve"),
 304                                          sigc::bind(sigc::mem_fun(*this, &AutomationController::set_ratio),
 305                                                     0.5)));
 306                 items.push_back(MenuElem(_("Double"),
 307                                          sigc::bind(sigc::mem_fun(*this, &AutomationController::set_ratio),
 308                                                     2.0)));
 309                 const bool is_audible = desc.upper > 40.0;
 310                 const bool is_low     = desc.lower < 1.0;
 311                 if (is_audible) {
 312                         items.push_back(MenuElem(_("Select Note..."),
 313                                                  sigc::mem_fun(*this, &AutomationController::run_note_select_dialog)));
 314                 }
 315                 if (is_low) {
 316                         for (double beats = 1.0; beats <= 16; ++beats) {
 317                                 items.push_back(MenuElem(string_compose(_("Set to %1 beat(s)"), (int)beats),
 318                                                          sigc::bind(sigc::mem_fun(*this, &AutomationController::set_freq_beats),
 319                                                                     beats)));
 320                         }
 321                 }
 322                 menu->popup(1, ev->time);
 323                 return true;
 324         }
 325
 326         return false;
 327 }
 328
 329 void
 330 AutomationController::value_changed ()
 331 {
 332         Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&AutomationController::display_effective_value, this));
 333 }
 334
 335 /** Stop updating our value from our controllable */
 336 void
 337 AutomationController::stop_updating ()
 338 {
 339         _screen_update_connection.disconnect ();
 340 }
 341
 342 void
 343 AutomationController::disable_vertical_scroll ()
 344 {
 345         AutomationBarController* bar = dynamic_cast<AutomationBarController*>(_widget);
 346         if (bar) {
 347                 bar->set_tweaks (
 348                         Gtkmm2ext::PixFader::Tweaks(bar->tweaks() |
 349                                                     Gtkmm2ext::PixFader::NoVerticalScroll));
 350         }
 351 }