2 Copyright (C) 2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include "ardour/io.h"
23 #include "ardour/route.h"
24 #include "ardour/route_group.h"
25 #include "ardour/session.h"
26 #include "ardour/session_route.h"
27 #include "ardour/dB.h"
29 #include <gtkmm/style.h>
30 #include <gdkmm/color.h>
31 #include <gtkmm2ext/utils.h>
32 #include <gtkmm2ext/fastmeter.h>
33 #include <gtkmm2ext/stop_signal.h>
34 #include <gtkmm2ext/barcontroller.h>
35 #include <gtkmm2ext/gtk_ui.h>
36 #include "midi++/manager.h"
37 #include "pbd/fastlog.h"
38 #include "pbd/stacktrace.h"
40 #include "ardour_ui.h"
41 #include "gain_meter.h"
44 #include "gui_thread.h"
46 #include "public_editor.h"
48 #include "ardour/session.h"
49 #include "ardour/route.h"
50 #include "ardour/meter.h"
54 using namespace ARDOUR;
56 using namespace Gtkmm2ext;
61 sigc::signal<void> GainMeterBase::ResetAllPeakDisplays;
62 sigc::signal<void,RouteGroup*> GainMeterBase::ResetGroupPeakDisplays;
64 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
65 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
69 GainMeter::setup_slider_pix ()
71 if ((slider = ::get_icon ("fader_belt")) == 0) {
72 throw failed_constructor();
76 GainMeterBase::GainMeterBase (Session& s,
77 const Glib::RefPtr<Gdk::Pixbuf>& pix,
80 // 0.781787 is the value needed for gain to be set to 0.
81 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
82 gain_automation_style_button (""),
83 gain_automation_state_button (""),
87 using namespace Menu_Helpers;
89 ignore_toggle = false;
91 next_release_selects = false;
96 gain_slider = manage (new HSliderController (pix,
100 gain_slider = manage (new VSliderController (pix,
105 level_meter = new LevelMeter(_session);
107 gain_slider->signal_button_press_event().connect (mem_fun(*this, &GainMeter::start_gain_touch));
108 gain_slider->signal_button_release_event().connect (mem_fun(*this, &GainMeter::end_gain_touch));
109 gain_slider->set_name ("GainFader");
111 gain_display.set_name ("MixerStripGainDisplay");
112 gain_display.set_has_frame (false);
113 set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
114 gain_display.signal_activate().connect (mem_fun (*this, &GainMeter::gain_activated));
115 gain_display.signal_focus_in_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
116 gain_display.signal_focus_out_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
118 peak_display.set_name ("MixerStripPeakDisplay");
119 // peak_display.set_has_frame (false);
120 // peak_display.set_editable (false);
121 set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
122 max_peak = minus_infinity();
123 peak_display.set_label (_("-inf"));
124 peak_display.unset_flags (Gtk::CAN_FOCUS);
126 gain_automation_style_button.set_name ("MixerAutomationModeButton");
127 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
129 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
130 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
132 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
133 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
135 gain_automation_state_button.set_size_request(15, 15);
136 gain_automation_style_button.set_size_request(15, 15);
138 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
139 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
141 gain_astate_menu.set_name ("ArdourContextMenu");
142 gain_astyle_menu.set_name ("ArdourContextMenu");
144 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeterBase::gain_adjusted));
145 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeterBase::peak_button_release), false);
146 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeterBase::gain_key_press), false);
148 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_peak_display));
149 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_group_peak_display));
151 UI::instance()->theme_changed.connect (mem_fun(*this, &GainMeterBase::on_theme_changed));
152 ColorsChanged.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), false));
153 DPIReset.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), true));
156 GainMeterBase::~GainMeterBase ()
163 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
164 boost::shared_ptr<PeakMeter> pm,
165 boost::shared_ptr<AutomationControl> gc,
166 boost::shared_ptr<Automatable> gc_owner)
168 connections.clear ();
171 level_meter->set_meter (0);
172 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
174 _gain_control.reset ();
183 level_meter->set_meter (pm.get());
184 gain_slider->set_controllable (gc);
186 if (!_route || !_route->is_hidden()) {
188 using namespace Menu_Helpers;
190 gain_astate_menu.items().clear ();
192 gain_astate_menu.items().push_back (MenuElem (_("Manual"),
193 bind (mem_fun (*(gc_owner.get()), &Automatable::set_parameter_automation_state),
194 Evoral::Parameter(GainAutomation), (AutoState) Off)));
195 gain_astate_menu.items().push_back (MenuElem (_("Play"),
196 bind (mem_fun (*(gc_owner.get()), &Automatable::set_parameter_automation_state),
197 Evoral::Parameter(GainAutomation), (AutoState) Play)));
198 gain_astate_menu.items().push_back (MenuElem (_("Write"),
199 bind (mem_fun (*(gc_owner.get()), &Automatable::set_parameter_automation_state),
200 Evoral::Parameter(GainAutomation), (AutoState) Write)));
201 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
202 bind (mem_fun (*(gc_owner.get()), &Automatable::set_parameter_automation_state),
203 Evoral::Parameter(GainAutomation), (AutoState) Touch)));
205 connections.push_back (gain_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &GainMeterBase::gain_automation_style_button_event), false));
206 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
208 connections.push_back (gc->alist()->automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed)));
209 connections.push_back (gc->alist()->automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed)));
211 gain_automation_state_changed ();
214 connections.push_back (gc->Changed.connect (mem_fun (*this, &GainMeterBase::gain_changed)));
218 update_gain_sensitive ();
222 GainMeterBase::hide_all_meters ()
224 level_meter->hide_meters();
228 GainMeter::hide_all_meters ()
230 bool remove_metric_area = false;
232 GainMeterBase::hide_all_meters ();
234 if (remove_metric_area) {
235 if (meter_metric_area.get_parent()) {
236 level_meter->remove (meter_metric_area);
242 GainMeterBase::setup_meters (int len)
244 level_meter->setup_meters(len, 5);
248 GainMeter::setup_meters (int len)
250 if (!meter_metric_area.get_parent()) {
251 level_meter->pack_end (meter_metric_area, false, false);
252 meter_metric_area.show_all ();
254 GainMeterBase::setup_meters (len);
258 GainMeterBase::gain_key_press (GdkEventKey* ev)
260 if (key_is_legal_for_numeric_entry (ev->keyval)) {
261 /* drop through to normal handling */
264 /* illegal key for gain entry */
269 GainMeterBase::peak_button_release (GdkEventButton* ev)
271 /* reset peak label */
273 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
274 ResetAllPeakDisplays ();
275 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
277 ResetGroupPeakDisplays (_route->route_group());
280 reset_peak_display ();
287 GainMeterBase::reset_peak_display ()
290 level_meter->clear_meters();
291 max_peak = -INFINITY;
292 peak_display.set_label (_("-Inf"));
293 peak_display.set_name ("MixerStripPeakDisplay");
297 GainMeterBase::reset_group_peak_display (RouteGroup* group)
299 if (_route && group == _route->route_group()) {
300 reset_peak_display ();
305 GainMeterBase::popup_meter_menu (GdkEventButton *ev)
307 using namespace Menu_Helpers;
309 if (meter_menu == 0) {
310 meter_menu = new Gtk::Menu;
311 MenuList& items = meter_menu->items();
313 items.push_back (MenuElem ("-inf .. +0dBFS"));
314 items.push_back (MenuElem ("-10dB .. +0dBFS"));
315 items.push_back (MenuElem ("-4 .. +0dBFS"));
316 items.push_back (SeparatorElem());
317 items.push_back (MenuElem ("-inf .. -2dBFS"));
318 items.push_back (MenuElem ("-10dB .. -2dBFS"));
319 items.push_back (MenuElem ("-4 .. -2dBFS"));
322 meter_menu->popup (1, ev->time);
326 GainMeterBase::gain_focused (GdkEventFocus* ev)
329 gain_display.select_region (0, -1);
331 gain_display.select_region (0, 0);
337 GainMeterBase::gain_activated ()
341 if (sscanf (gain_display.get_text().c_str(), "%f", &f) == 1) {
343 /* clamp to displayable values */
347 _gain_control->set_value (dB_to_coefficient(f));
349 if (gain_display.has_focus()) {
350 PublicEditor::instance().reset_focus();
356 GainMeterBase::show_gain ()
360 float v = gain_adjustment.get_value();
363 strcpy (buf, _("-inf"));
365 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
368 gain_display.set_text (buf);
372 GainMeterBase::gain_adjusted ()
374 if (!ignore_toggle) {
375 _gain_control->set_value (slider_position_to_gain (gain_adjustment.get_value()));
382 GainMeterBase::effective_gain_display ()
384 gfloat value = gain_to_slider_position (_gain_control->get_value());
386 //cerr << this << " for " << _io->name() << " EGAIN = " << value
387 // << " AGAIN = " << gain_adjustment.get_value () << endl;
388 // stacktrace (cerr, 20);
390 if (gain_adjustment.get_value() != value) {
391 ignore_toggle = true;
392 gain_adjustment.set_value (value);
393 ignore_toggle = false;
398 GainMeterBase::gain_changed ()
400 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeterBase::effective_gain_display));
404 GainMeterBase::set_meter_strip_name (const char * name)
406 meter_metric_area.set_name (name);
410 GainMeterBase::set_fader_name (const char * name)
412 gain_slider->set_name (name);
416 GainMeterBase::update_gain_sensitive ()
418 bool x = !(_gain_control->alist()->automation_state() & Play);
419 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (x);
423 next_meter_point (MeterPoint mp)
427 return MeterPreFader;
431 return MeterPostFader;
443 GainMeterBase::meter_press(GdkEventButton* ev)
445 wait_for_release = false;
451 if (!ignore_toggle) {
453 if (Keyboard::is_context_menu_event (ev)) {
455 // no menu at this time.
459 if (Keyboard::is_button2_event(ev)) {
461 // Primary-button2 click is the midi binding click
462 // button2-click is "momentary"
464 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
465 wait_for_release = true;
466 old_meter_point = _route->meter_point ();
470 if (_route && (ev->button == 1 || Keyboard::is_button2_event (ev))) {
472 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
474 /* Primary+Tertiary-click applies change to all routes */
476 _session.begin_reversible_command (_("meter point change"));
477 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
478 _session.foreach_route (this, &GainMeterBase::set_meter_point, next_meter_point (_route->meter_point()));
480 _session.add_command (cmd);
481 _session.commit_reversible_command ();
484 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
486 /* Primary-click: solo mix group.
487 NOTE: Primary-button2 is MIDI learn.
490 if (ev->button == 1) {
491 _session.begin_reversible_command (_("meter point change"));
492 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
493 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
495 _session.add_command (cmd);
496 _session.commit_reversible_command ();
501 /* click: change just this route */
505 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
516 GainMeterBase::meter_release(GdkEventButton* ev)
519 if (wait_for_release){
520 wait_for_release = false;
523 set_meter_point (*_route, old_meter_point);
532 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
534 route.set_meter_point (mp, this);
538 GainMeterBase::set_mix_group_meter_point (Route& route, MeterPoint mp)
540 RouteGroup* mix_group;
542 if((mix_group = route.route_group()) != 0){
543 mix_group->apply (&Route::set_meter_point, mp, this);
545 route.set_meter_point (mp, this);
550 GainMeterBase::meter_point_clicked ()
558 GainMeterBase::start_gain_touch (GdkEventButton* ev)
560 _gain_control->start_touch ();
565 GainMeterBase::end_gain_touch (GdkEventButton* ev)
567 _gain_control->stop_touch ();
572 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
574 if (ev->type == GDK_BUTTON_RELEASE) {
578 switch (ev->button) {
580 gain_astate_menu.popup (1, ev->time);
590 GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
592 if (ev->type == GDK_BUTTON_RELEASE) {
596 switch (ev->button) {
598 gain_astyle_menu.popup (1, ev->time);
607 GainMeterBase::astate_string (AutoState state)
609 return _astate_string (state, false);
613 GainMeterBase::short_astate_string (AutoState state)
615 return _astate_string (state, true);
619 GainMeterBase::_astate_string (AutoState state, bool shrt)
625 sstr = (shrt ? "M" : _("M"));
628 sstr = (shrt ? "P" : _("P"));
631 sstr = (shrt ? "T" : _("T"));
634 sstr = (shrt ? "W" : _("W"));
642 GainMeterBase::astyle_string (AutoStyle style)
644 return _astyle_string (style, false);
648 GainMeterBase::short_astyle_string (AutoStyle style)
650 return _astyle_string (style, true);
654 GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
659 /* XXX it might different in different languages */
661 return (shrt ? _("Abs") : _("Abs"));
666 GainMeterBase::gain_automation_style_changed ()
670 gain_automation_style_button.set_label (astyle_string(_gain_control->alist()->automation_style()));
673 gain_automation_style_button.set_label (short_astyle_string(_gain_control->alist()->automation_style()));
679 GainMeterBase::gain_automation_state_changed ()
681 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeterBase::gain_automation_state_changed));
687 gain_automation_state_button.set_label (astate_string(_gain_control->alist()->automation_state()));
690 gain_automation_state_button.set_label (short_astate_string(_gain_control->alist()->automation_state()));
694 x = (_gain_control->alist()->automation_state() != Off);
696 if (gain_automation_state_button.get_active() != x) {
697 ignore_toggle = true;
698 gain_automation_state_button.set_active (x);
699 ignore_toggle = false;
702 update_gain_sensitive ();
704 /* start watching automation so that things move */
706 gain_watching.disconnect();
709 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeterBase::effective_gain_display));
714 GainMeterBase::update_meters()
717 float mpeak = level_meter->update_meters();
719 if (mpeak > max_peak) {
721 if (mpeak <= -200.0f) {
722 peak_display.set_label (_("-inf"));
724 snprintf (buf, sizeof(buf), "%.1f", mpeak);
725 peak_display.set_label (buf);
729 peak_display.set_name ("MixerStripPeakDisplayPeak");
734 void GainMeterBase::color_handler(bool dpi)
736 color_changed = true;
737 dpi_changed = (dpi) ? true : false;
742 GainMeterBase::set_width (Width w, int len)
745 level_meter->setup_meters (len);
750 GainMeterBase::on_theme_changed()
752 style_changed = true;
755 GainMeter::GainMeter (Session& s)
756 : GainMeterBase (s, slider, false)
758 gain_display_box.set_homogeneous (true);
759 gain_display_box.set_spacing (2);
760 gain_display_box.pack_start (gain_display, true, true);
762 meter_metric_area.set_name ("AudioTrackMetrics");
763 set_size_request_to_display_given_text (meter_metric_area, "-50", 0, 0);
765 gain_automation_style_button.set_name ("MixerAutomationModeButton");
766 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
768 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
769 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
771 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
772 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
774 gain_automation_state_button.set_size_request(15, 15);
775 gain_automation_style_button.set_size_request(15, 15);
777 HBox* fader_centering_box = manage (new HBox);
778 fader_centering_box->pack_start (*gain_slider, true, false);
780 fader_vbox = manage (new Gtk::VBox());
781 fader_vbox->set_spacing (0);
782 fader_vbox->pack_start (*fader_centering_box, false, false, 0);
784 hbox.set_spacing (2);
785 hbox.pack_start (*fader_vbox, true, true);
789 pack_start (gain_display_box, Gtk::PACK_SHRINK);
790 pack_start (hbox, Gtk::PACK_SHRINK);
792 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
796 GainMeter::set_controls (boost::shared_ptr<Route> r,
797 boost::shared_ptr<PeakMeter> meter,
798 boost::shared_ptr<AutomationControl> gain_control,
799 boost::shared_ptr<Automatable> gc_owner)
801 if (level_meter->get_parent()) {
802 hbox.remove (*level_meter);
805 if (peak_display.get_parent()) {
806 gain_display_box.remove (peak_display);
809 if (gain_automation_state_button.get_parent()) {
810 fader_vbox->remove (gain_automation_state_button);
813 GainMeterBase::set_controls (r, meter, gain_control, gc_owner);
816 if we have a non-hidden route (ie. we're not the click or the auditioner),
817 pack some route-dependent stuff.
820 gain_display_box.pack_end (peak_display, true, true);
821 hbox.pack_end (*level_meter, true, true);
823 if (!r->is_hidden()) {
824 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
832 GainMeter::get_gm_width ()
835 hbox.size_request (sz);
839 Glib::RefPtr<Gdk::Pixmap>
840 GainMeter::render_metrics (Gtk::Widget& w)
842 Glib::RefPtr<Gdk::Window> win (w.get_window());
843 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
844 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
846 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
849 win->get_size (width, height);
851 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
853 metric_pixmaps[w.get_name()] = pixmap;
855 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
857 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
859 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
861 float fraction = log_meter (db_points[i]);
862 gint pos = height - (gint) floor (height * fraction);
864 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
866 layout->set_text (buf);
868 /* we want logical extents, not ink extents here */
871 layout->get_pixel_size (width, height);
873 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
874 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
881 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
883 static Glib::RefPtr<Gtk::Style> meter_style;
885 meter_style = meter_metric_area.get_style();
887 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
888 Glib::RefPtr<Gdk::GC> bg_gc (meter_style->get_bg_gc (Gtk::STATE_INSENSITIVE));
889 GdkRectangle base_rect;
890 GdkRectangle draw_rect;
893 win->get_size (width, height);
895 base_rect.width = width;
896 base_rect.height = height;
900 Glib::RefPtr<Gdk::Pixmap> pixmap;
901 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
903 if (i == metric_pixmaps.end() || style_changed || dpi_changed) {
904 pixmap = render_metrics (meter_metric_area);
909 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
910 win->draw_drawable (bg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
911 style_changed = false;
915 boost::shared_ptr<PBD::Controllable>
916 GainMeterBase::get_controllable()
918 return _gain_control;