fix mistaken "do not roll" conclusion in TransportFSM::compute_should_roll()
[ardour.git] / gtk2_ardour / gain_meter.cc
index 0a66784a938247df63b67ca29210ae60ddf0b14d..4196409692aa3c78cfd9b58601f22711cb72c7ac 100644 (file)
@@ -1,23 +1,37 @@
 /*
-  Copyright (C) 2002 Paul Davis
+ * Copyright (C) 2005-2006 Nick Mainsbridge <mainsbridge@gmail.com>
+ * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
+ * Copyright (C) 2006-2007 Doug McLain <doug@nostar.net>
+ * Copyright (C) 2006-2014 David Robillard <d@drobilla.net>
+ * Copyright (C) 2007-2016 Tim Mayberry <mojofunk@gmail.com>
+ * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2014-2015 Ben Loftis <ben@harrisonconsoles.com>
+ * Copyright (C) 2016 Julien "_FrnchFrgg_" RIVAUD <frnchfrgg@free.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
-  This program is free software; you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
-  (at your option) any later version.
-
-  This program is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-  You should have received a copy of the GNU General Public License
-  along with this program; if not, write to the Free Software
-  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#include <limits.h>
 
-*/
+#include <pangomm.h>
 
-#include <limits.h>
+#include <gtkmm/alignment.h>
+#include <gdkmm/color.h>
+#include <gtkmm/style.h>
 
 #include "ardour/amp.h"
 #include "ardour/logmeter.h"
 #include "ardour/dB.h"
 #include "ardour/utils.h"
 
-#include <pangomm.h>
-#include <gtkmm/style.h>
-#include <gdkmm/color.h>
-#include <gtkmm2ext/utils.h>
-#include <gtkmm2ext/fastmeter.h>
-#include <gtkmm2ext/gtk_ui.h>
+#include "gtkmm2ext/utils.h"
+#include "gtkmm2ext/gtk_ui.h"
+
+#include "widgets/tooltips.h"
+
 #include "pbd/fastlog.h"
 #include "pbd/stacktrace.h"
 
@@ -42,7 +55,6 @@
 #include "utils.h"
 #include "meter_patterns.h"
 #include "timers.h"
-#include "tooltips.h"
 #include "ui_config.h"
 
 #include "ardour/session.h"
@@ -55,7 +67,7 @@
 #include "pbd/i18n.h"
 
 using namespace ARDOUR;
-using namespace ARDOUR_UI_UTILS;
+using namespace ArdourWidgets;
 using namespace PBD;
 using namespace Gtkmm2ext;
 using namespace Gtk;
@@ -90,7 +102,6 @@ GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int
                           1.0,  // upper
                           dB_coeff_step(Config->get_max_gain()) / 10.0,  // step increment
                           dB_coeff_step(Config->get_max_gain()))  // page increment
-       , gain_automation_style_button ("")
        , gain_automation_state_button ("")
        , meter_point_button (_("pre"))
        , gain_astate_propagate (false)
@@ -110,8 +121,10 @@ GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int
 
        if (horizontal) {
                gain_slider = manage (new HSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
+               gain_slider->set_tweaks (ArdourFader::Tweaks(ArdourFader::NoButtonForward | ArdourFader::NoVerticalScroll));
        } else {
                gain_slider = manage (new VSliderController (&gain_adjustment, boost::shared_ptr<PBD::Controllable>(), fader_length, fader_girth));
+               gain_slider->set_tweaks (ArdourFader::NoButtonForward);
        }
 
        level_meter = new LevelMeterHBox(_session);
@@ -120,7 +133,6 @@ GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int
        meter_metric_area.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeterBase::level_meter_button_press));
        meter_metric_area.add_events (Gdk::BUTTON_PRESS_MASK);
 
-       gain_slider->set_tweaks (PixFader::Tweaks(PixFader::NoButtonForward | PixFader::NoVerticalScroll));
        gain_slider->StartGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_start_touch));
        gain_slider->StopGesture.connect (sigc::mem_fun (*this, &GainMeter::amp_stop_touch));
        gain_slider->set_name ("GainFader");
@@ -147,24 +159,17 @@ GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int
        peak_display.unset_flags (Gtk::CAN_FOCUS);
        peak_display.set_editable (false);
 
-       gain_automation_style_button.set_name ("mixer strip button");
        gain_automation_state_button.set_name ("mixer strip button");
 
        set_tooltip (gain_automation_state_button, _("Fader automation mode"));
-       set_tooltip (gain_automation_style_button, _("Fader automation type"));
+       set_tooltip (peak_display, _("dBFS - Digital Peak Hold. Click to reset."));
 
-       gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
        gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 
        gain_automation_state_button.set_size_request(15, 15);
-       gain_automation_style_button.set_size_request(15, 15);
-
-       gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
-       gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
 
        gain_astate_menu.set_name ("ArdourContextMenu");
        gain_astate_menu.set_reserve_toggle_size(false);
-       gain_astyle_menu.set_name ("ArdourContextMenu");
 
        meter_point_button.set_name ("mixer strip button");
 
@@ -178,24 +183,26 @@ GainMeterBase::GainMeterBase (Session* s, bool horizontal, int fader_length, int
        meter_point_menu.set_reserve_toggle_size(false);
 
        meter_point_menu.items().clear ();
-       meter_point_menu.items().push_back (MenuElem(_("Input"),
+       meter_point_menu.items().push_back (MenuElem(meterpt_string(MeterInput),
         sigc::bind (sigc::mem_fun (*this,
         &GainMeterBase::meter_point_clicked), (MeterPoint) MeterInput)));
-       meter_point_menu.items().push_back (MenuElem(_("Pre Fader"),
+       meter_point_menu.items().push_back (MenuElem(meterpt_string(MeterPreFader),
         sigc::bind (sigc::mem_fun (*this,
         &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPreFader)));
-       meter_point_menu.items().push_back (MenuElem(_("Post Fader"),
+       meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterPostFader),
         sigc::bind (sigc::mem_fun (*this,
         &GainMeterBase::meter_point_clicked), (MeterPoint) MeterPostFader)));
-       meter_point_menu.items().push_back (MenuElem(_("Output"),
+       meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterOutput),
         sigc::bind (sigc::mem_fun (*this,
         &GainMeterBase::meter_point_clicked), (MeterPoint) MeterOutput)));
-       meter_point_menu.items().push_back (MenuElem(_("Custom"),
+       meter_point_menu.items().push_back (MenuElem(meterpt_string (MeterCustom),
         sigc::bind (sigc::mem_fun (*this,
         &GainMeterBase::meter_point_clicked), (MeterPoint) MeterCustom)));
+
        meter_point_button.signal_button_press_event().connect (sigc::mem_fun (*this, &GainMeter::meter_press), false);
 
        gain_adjustment.signal_value_changed().connect (sigc::mem_fun(*this, &GainMeterBase::fader_moved));
+       peak_display.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_press), false);
        peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &GainMeterBase::peak_button_release), false);
        gain_display.signal_key_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_key_press), false);
 
@@ -258,21 +265,21 @@ GainMeterBase::set_controls (boost::shared_ptr<Route> r,
 
                gain_astate_menu.items().clear ();
 
-               gain_astate_menu.items().push_back (MenuElem (S_("Automation|Manual"),
+               gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Off),
                                                              sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Off)));
-               gain_astate_menu.items().push_back (MenuElem (_("Play"),
+               gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Play),
                                                              sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Play)));
-               gain_astate_menu.items().push_back (MenuElem (_("Write"),
+               gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Write),
                                                              sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Write)));
-               gain_astate_menu.items().push_back (MenuElem (_("Touch"),
+               gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Touch),
                                                              sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Touch)));
+               gain_astate_menu.items().push_back (MenuElem (astate_string (ARDOUR::Latch),
+                                                             sigc::bind (sigc::mem_fun (*this, &GainMeterBase::set_gain_astate), (AutoState) ARDOUR::Latch)));
 
-               connections.push_back (gain_automation_style_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_style_button_event), false));
                connections.push_back (gain_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
                connections.push_back (ChangeGainAutomationState.connect (sigc::mem_fun(*this, &GainMeterBase::set_gain_astate)));
 
                _control->alist()->automation_state_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_state_changed, this), gui_context());
-               _control->alist()->automation_style_changed.connect (model_connections, invalidator (*this), boost::bind (&GainMeter::gain_automation_style_changed, this), gui_context());
 
                gain_automation_state_changed ();
        }
@@ -298,7 +305,12 @@ GainMeterBase::set_gain_astate (AutoState as)
                ChangeGainAutomationState (as);
                return;
        }
-       _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
+       if (_amp) {
+               _amp->set_parameter_automation_state (Evoral::Parameter (GainAutomation), as);
+       } else if (_control) {
+               _control->set_automation_state (as);
+               _session->set_dirty ();
+       }
 }
 
 void
@@ -320,7 +332,7 @@ GainMeterBase::setup_gain_adjustment ()
                gain_adjustment.set_upper (GAIN_COEFF_UNITY);
                gain_adjustment.set_step_increment (dB_coeff_step(Config->get_max_gain()) / 10.0);
                gain_adjustment.set_page_increment (dB_coeff_step(Config->get_max_gain()));
-               gain_slider->set_default_value (gain_to_slider_position (GAIN_COEFF_UNITY));
+               gain_slider->set_default_value (gain_to_slider_position_with_max (GAIN_COEFF_UNITY, Config->get_max_gain()));
        } else {
                _data_type = DataType::MIDI;
                gain_adjustment.set_lower (0.0);
@@ -381,12 +393,6 @@ GainMeterBase::setup_meters (int len)
        level_meter->setup_meters(len, meter_width);
 }
 
-void
-GainMeterBase::set_type (MeterType t)
-{
-       level_meter->set_meter_type(t);
-}
-
 void
 GainMeter::setup_meters (int len)
 {
@@ -409,16 +415,10 @@ GainMeter::setup_meters (int len)
        GainMeterBase::setup_meters (len);
 }
 
-void
-GainMeter::set_type (MeterType t)
-{
-       GainMeterBase::set_type (t);
-}
-
 bool
 GainMeterBase::gain_key_press (GdkEventKey* ev)
 {
-       if (key_is_legal_for_numeric_entry (ev->keyval)) {
+       if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
                /* drop through to normal handling */
                return false;
        }
@@ -426,6 +426,12 @@ GainMeterBase::gain_key_press (GdkEventKey* ev)
        return true;
 }
 
+bool
+GainMeterBase::peak_button_press (GdkEventButton* ev)
+{
+       return true;
+}
+
 bool
 GainMeterBase::peak_button_release (GdkEventButton* ev)
 {
@@ -581,7 +587,14 @@ GainMeterBase::fader_moved ()
                        value = gain_adjustment.get_value();
                }
 
-               _control->set_value (value, Controllable::UseGroup);
+               // XXX hack allow to override group
+               // (this breaks group'ed  shift+click reset)
+               if (Keyboard::the_keyboard().key_is_down (GDK_Shift_R)
+                               || Keyboard::the_keyboard().key_is_down (GDK_Shift_L)) {
+                       _control->set_value (value, Controllable::InverseGroup);
+               } else {
+                       _control->set_value (value, Controllable::UseGroup);
+               }
        }
 
        show_gain ();
@@ -614,7 +627,8 @@ GainMeterBase::effective_gain_display ()
 void
 GainMeterBase::gain_changed ()
 {
-       Gtkmm2ext::UI::instance()->call_slot (invalidator (*this), boost::bind (&GainMeterBase::effective_gain_display, this));
+       ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
+       effective_gain_display ();
 }
 
 void
@@ -638,7 +652,7 @@ void
 GainMeterBase::update_gain_sensitive ()
 {
        bool x = !(_control->alist()->automation_state() & Play);
-       static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (x);
+       static_cast<ArdourWidgets::SliderController*>(gain_slider)->set_sensitive (x);
 }
 
 gint
@@ -669,8 +683,9 @@ GainMeterBase::meter_press(GdkEventButton* ev)
                                        meter_point_change_target = MeterPointChangeSingle;
                                }
                                Gtkmm2ext::anchored_menu_popup(&meter_point_menu,
-                                                            &meter_point_button,
-                                                          "", 1, ev->time);
+                                                              &meter_point_button,
+                                                              meterpt_string (_route->meter_point()),
+                                                              1, ev->time);
                                break;
                        default:
                                break;
@@ -718,13 +733,14 @@ GainMeterBase::meter_point_clicked (MeterPoint mp)
 void
 GainMeterBase::amp_start_touch ()
 {
-       _control->start_touch (_control->session().transport_frame());
+       _control->start_touch (_control->session().transport_sample());
 }
 
 void
 GainMeterBase::amp_stop_touch ()
 {
-       _control->stop_touch (false, _control->session().transport_frame());
+       _control->stop_touch (_control->session().transport_sample());
+       effective_gain_display ();
 }
 
 gint
@@ -739,7 +755,8 @@ GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
                        gain_astate_propagate = Keyboard::modifier_state_contains (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier | Keyboard::TertiaryModifier));
                        Gtkmm2ext::anchored_menu_popup(&gain_astate_menu,
                                                       &gain_automation_state_button,
-                                                      "", 1, ev->time);
+                                                      astate_string(_control->alist()->automation_state()),
+                                                      1, ev->time);
                        break;
                default:
                        break;
@@ -748,22 +765,6 @@ GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
        return TRUE;
 }
 
-gint
-GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
-{
-       if (ev->type == GDK_BUTTON_RELEASE) {
-               return TRUE;
-       }
-
-       switch (ev->button) {
-       case 1:
-               gain_astyle_menu.popup (1, ev->time);
-               break;
-       default:
-               break;
-       }
-       return TRUE;
-}
 
 string
 GainMeterBase::astate_string (AutoState state)
@@ -780,76 +781,46 @@ GainMeterBase::short_astate_string (AutoState state)
 string
 GainMeterBase::_astate_string (AutoState state, bool shrt)
 {
-       string sstr;
-
        switch (state) {
-       case ARDOUR::Off:
-               sstr = (shrt ? "M" : _("M"));
-               break;
-       case Play:
-               sstr = (shrt ? "P" : _("P"));
-               break;
-       case Touch:
-               sstr = (shrt ? "T" : _("T"));
-               break;
-       case Write:
-               sstr = (shrt ? "W" : _("W"));
-               break;
+               case ARDOUR::Off:
+                       return shrt ? S_("Manual|M") : S_("Automation|Manual");
+               case Play:
+                       return shrt ? S_("Play|P") : _("Play");
+               case Touch:
+                       return shrt ? S_("Touch|T") : _("Touch");
+               case Latch:
+                       return shrt ? S_("Latch|L") : _("Latch");
+               case Write:
+                       return shrt ? S_("Write|W"): _("Write");
        }
-
-       return sstr;
-}
-
-string
-GainMeterBase::astyle_string (AutoStyle style)
-{
-       return _astyle_string (style, false);
-}
-
-string
-GainMeterBase::short_astyle_string (AutoStyle style)
-{
-       return _astyle_string (style, true);
+       assert (0);
+       return "???";
 }
 
 string
-GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
+GainMeterBase::meterpt_string (MeterPoint mp)
 {
-       if (style & Trim) {
-               return _("Trim");
-       } else {
-               /* XXX it might different in different languages */
-
-               return (shrt ? _("Abs") : _("Abs"));
-       }
-}
-
-void
-GainMeterBase::gain_automation_style_changed ()
-{
-       switch (_width) {
-       case Wide:
-               gain_automation_style_button.set_text (astyle_string(_control->alist()->automation_style()));
-               break;
-       case Narrow:
-               gain_automation_style_button.set_text  (short_astyle_string(_control->alist()->automation_style()));
-               break;
+       switch (mp) {
+               case MeterInput:
+                       return _("Input");
+               case MeterPreFader:
+                       return _("Pre Fader");
+               case MeterPostFader:
+                       return _("Post Fader");
+               case MeterOutput:
+                       return _("Output");
+               case MeterCustom:
+                       return _("Custom");
        }
+       assert (0);
+       return "???"; // make gcc and _FrnchFrgg_ happy
 }
 
 void
 GainMeterBase::gain_automation_state_changed ()
 {
        ENSURE_GUI_THREAD (*this, &GainMeterBase::gain_automation_state_changed);
-
-       switch (_width) {
-       case Wide:
-               gain_automation_state_button.set_text (astate_string(_control->alist()->automation_state()));
-               break;
-       case Narrow:
-               gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
-               break;
-       }
+       gain_automation_state_button.set_text (short_astate_string(_control->alist()->automation_state()));
 
        const bool automation_watch_required = (_control->alist()->automation_state() != ARDOUR::Off);
 
@@ -862,14 +833,6 @@ GainMeterBase::gain_automation_state_changed ()
        update_gain_sensitive ();
 
        gain_watching.disconnect();
-
-       if (automation_watch_required) {
-               /* start watching automation so that things move */
-               gain_watching = Timers::rapid_connect (sigc::mem_fun (*this, &GainMeterBase::effective_gain_display));
-       } else {
-               /* update once to get the correct value shown as we re-enter off/manual mode */
-               effective_gain_display();
-       }
 }
 
 const ChanCount
@@ -948,17 +911,13 @@ GainMeter::GainMeter (Session* s, int fader_length)
        meter_metric_area.set_name ("AudioTrackMetrics");
        meter_metric_area.set_size_request(PX_SCALE(24, 24), -1);
 
-       gain_automation_style_button.set_name ("mixer strip button");
        gain_automation_state_button.set_name ("mixer strip button");
 
        set_tooltip (gain_automation_state_button, _("Fader automation mode"));
-       set_tooltip (gain_automation_style_button, _("Fader automation type"));
 
-       gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
        gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
 
        gain_automation_state_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
-       gain_automation_style_button.set_size_request (PX_SCALE(12, 15), PX_SCALE(12, 15));
 
        fader_vbox.set_spacing (0);
        fader_vbox.pack_start (*gain_slider, true, true);
@@ -991,6 +950,8 @@ GainMeter::GainMeter (Session* s, int fader_length)
        meter_hbox.pack_start (meter_alignment, false, false);
        meter_hbox.pack_start (meter_ticks2_area, false, false);
        meter_hbox.pack_start (meter_metric_area, false, false);
+
+       meter_metric_area.set_no_show_all ();
 }
 #undef PX_SCALE
 
@@ -1016,8 +977,8 @@ GainMeter::set_controls (boost::shared_ptr<Route> r,
                _meter->ConfigurationChanged.connect (
                        model_connections, invalidator (*this), boost::bind (&GainMeter::meter_configuration_changed, this, _1), gui_context()
                        );
-               _meter->TypeChanged.connect (
-                       model_connections, invalidator (*this), boost::bind (&GainMeter::meter_type_changed, this, _1), gui_context()
+               _meter->MeterTypeChanged.connect (
+                       model_connections, invalidator (*this), boost::bind (&GainMeter::redraw_metrics, this), gui_context()
                        );
 
                meter_configuration_changed (_meter->input_streams ());
@@ -1176,8 +1137,7 @@ GainMeter::route_active_changed ()
 }
 
 void
-GainMeter::meter_type_changed (MeterType t)
+GainMeter::redraw_metrics ()
 {
-       _route->set_meter_type(t);
-       RedrawMetrics();
+       GainMeterBase::redraw_metrics ();
 }