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/amp.h"
23 #include "ardour/io.h"
24 #include "ardour/route.h"
25 #include "ardour/route_group.h"
26 #include "ardour/session.h"
27 #include "ardour/session_route.h"
28 #include "ardour/dB.h"
30 #include <gtkmm/style.h>
31 #include <gdkmm/color.h>
32 #include <gtkmm2ext/utils.h>
33 #include <gtkmm2ext/fastmeter.h>
34 #include <gtkmm2ext/stop_signal.h>
35 #include <gtkmm2ext/barcontroller.h>
36 #include <gtkmm2ext/gtk_ui.h>
37 #include "midi++/manager.h"
38 #include "pbd/fastlog.h"
39 #include "pbd/stacktrace.h"
41 #include "ardour_ui.h"
42 #include "gain_meter.h"
45 #include "gui_thread.h"
47 #include "public_editor.h"
49 #include "ardour/session.h"
50 #include "ardour/route.h"
51 #include "ardour/meter.h"
55 using namespace ARDOUR;
57 using namespace Gtkmm2ext;
62 sigc::signal<void> GainMeterBase::ResetAllPeakDisplays;
63 sigc::signal<void,RouteGroup*> GainMeterBase::ResetGroupPeakDisplays;
65 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
66 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
70 GainMeter::setup_slider_pix ()
72 if ((slider = ::get_icon ("fader_belt")) == 0) {
73 throw failed_constructor();
77 GainMeterBase::GainMeterBase (Session& s,
78 const Glib::RefPtr<Gdk::Pixbuf>& pix,
81 // 0.781787 is the value needed for gain to be set to 0.
82 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
83 gain_automation_style_button (""),
84 gain_automation_state_button (""),
88 using namespace Menu_Helpers;
90 ignore_toggle = false;
92 next_release_selects = false;
97 gain_slider = manage (new HSliderController (pix,
101 gain_slider = manage (new VSliderController (pix,
106 level_meter = new LevelMeter(_session);
108 gain_slider->signal_button_press_event().connect (mem_fun(*this, &GainMeter::start_gain_touch));
109 gain_slider->signal_button_release_event().connect (mem_fun(*this, &GainMeter::end_gain_touch));
110 gain_slider->set_name ("GainFader");
112 gain_display.set_name ("MixerStripGainDisplay");
113 gain_display.set_has_frame (false);
114 set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
115 gain_display.signal_activate().connect (mem_fun (*this, &GainMeter::gain_activated));
116 gain_display.signal_focus_in_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
117 gain_display.signal_focus_out_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
119 peak_display.set_name ("MixerStripPeakDisplay");
120 // peak_display.set_has_frame (false);
121 // peak_display.set_editable (false);
122 set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
123 max_peak = minus_infinity();
124 peak_display.set_label (_("-inf"));
125 peak_display.unset_flags (Gtk::CAN_FOCUS);
127 gain_automation_style_button.set_name ("MixerAutomationModeButton");
128 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
130 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
131 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
133 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
134 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
136 gain_automation_state_button.set_size_request(15, 15);
137 gain_automation_style_button.set_size_request(15, 15);
139 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
140 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
142 gain_astate_menu.set_name ("ArdourContextMenu");
143 gain_astyle_menu.set_name ("ArdourContextMenu");
145 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeterBase::gain_adjusted));
146 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeterBase::peak_button_release), false);
147 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeterBase::gain_key_press), false);
149 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_peak_display));
150 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_group_peak_display));
152 UI::instance()->theme_changed.connect (mem_fun(*this, &GainMeterBase::on_theme_changed));
153 ColorsChanged.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), false));
154 DPIReset.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), true));
157 GainMeterBase::~GainMeterBase ()
164 GainMeterBase::set_controls (boost::shared_ptr<Route> r,
165 boost::shared_ptr<PeakMeter> pm,
166 boost::shared_ptr<Amp> amp)
168 connections.clear ();
171 level_meter->set_meter (0);
172 gain_slider->set_controllable (boost::shared_ptr<PBD::Controllable>());
183 level_meter->set_meter (pm.get());
184 gain_slider->set_controllable (amp->gain_control());
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 (*(amp.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 (*(amp.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 (*(amp.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 (*(amp.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 boost::shared_ptr<AutomationControl> gc = amp->gain_control();
210 connections.push_back (gc->alist()->automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed)));
211 connections.push_back (gc->alist()->automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed)));
213 gain_automation_state_changed ();
216 connections.push_back (amp->gain_control()->Changed.connect (mem_fun (*this, &GainMeterBase::gain_changed)));
220 update_gain_sensitive ();
224 GainMeterBase::hide_all_meters ()
226 level_meter->hide_meters();
230 GainMeter::hide_all_meters ()
232 bool remove_metric_area = false;
234 GainMeterBase::hide_all_meters ();
236 if (remove_metric_area) {
237 if (meter_metric_area.get_parent()) {
238 level_meter->remove (meter_metric_area);
244 GainMeterBase::setup_meters (int len)
246 level_meter->setup_meters(len, 5);
250 GainMeter::setup_meters (int len)
252 if (!meter_metric_area.get_parent()) {
253 level_meter->pack_end (meter_metric_area, false, false);
254 meter_metric_area.show_all ();
256 GainMeterBase::setup_meters (len);
260 GainMeterBase::gain_key_press (GdkEventKey* ev)
262 if (key_is_legal_for_numeric_entry (ev->keyval)) {
263 /* drop through to normal handling */
266 /* illegal key for gain entry */
271 GainMeterBase::peak_button_release (GdkEventButton* ev)
273 /* reset peak label */
275 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
276 ResetAllPeakDisplays ();
277 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
279 ResetGroupPeakDisplays (_route->route_group());
282 reset_peak_display ();
289 GainMeterBase::reset_peak_display ()
292 level_meter->clear_meters();
293 max_peak = -INFINITY;
294 peak_display.set_label (_("-Inf"));
295 peak_display.set_name ("MixerStripPeakDisplay");
299 GainMeterBase::reset_group_peak_display (RouteGroup* group)
301 if (_route && group == _route->route_group()) {
302 reset_peak_display ();
307 GainMeterBase::popup_meter_menu (GdkEventButton *ev)
309 using namespace Menu_Helpers;
311 if (meter_menu == 0) {
312 meter_menu = new Gtk::Menu;
313 MenuList& items = meter_menu->items();
315 items.push_back (MenuElem ("-inf .. +0dBFS"));
316 items.push_back (MenuElem ("-10dB .. +0dBFS"));
317 items.push_back (MenuElem ("-4 .. +0dBFS"));
318 items.push_back (SeparatorElem());
319 items.push_back (MenuElem ("-inf .. -2dBFS"));
320 items.push_back (MenuElem ("-10dB .. -2dBFS"));
321 items.push_back (MenuElem ("-4 .. -2dBFS"));
324 meter_menu->popup (1, ev->time);
328 GainMeterBase::gain_focused (GdkEventFocus* ev)
331 gain_display.select_region (0, -1);
333 gain_display.select_region (0, 0);
339 GainMeterBase::gain_activated ()
343 if (sscanf (gain_display.get_text().c_str(), "%f", &f) == 1) {
345 /* clamp to displayable values */
349 _amp->set_gain (dB_to_coefficient(f), this);
351 if (gain_display.has_focus()) {
352 PublicEditor::instance().reset_focus();
358 GainMeterBase::show_gain ()
362 float v = gain_adjustment.get_value();
365 strcpy (buf, _("-inf"));
367 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
370 gain_display.set_text (buf);
374 GainMeterBase::gain_adjusted ()
376 if (!ignore_toggle) {
378 if (_route->amp() == _amp) {
379 _route->set_gain (slider_position_to_gain (gain_adjustment.get_value()), this);
381 _amp->set_gain (slider_position_to_gain (gain_adjustment.get_value()), this);
390 GainMeterBase::effective_gain_display ()
392 gfloat value = gain_to_slider_position (_amp->gain());
394 //cerr << this << " for " << _io->name() << " EGAIN = " << value
395 // << " AGAIN = " << gain_adjustment.get_value () << endl;
396 // stacktrace (cerr, 20);
398 if (gain_adjustment.get_value() != value) {
399 ignore_toggle = true;
400 gain_adjustment.set_value (value);
401 ignore_toggle = false;
406 GainMeterBase::gain_changed ()
408 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeterBase::effective_gain_display));
412 GainMeterBase::set_meter_strip_name (const char * name)
414 meter_metric_area.set_name (name);
418 GainMeterBase::set_fader_name (const char * name)
420 gain_slider->set_name (name);
424 GainMeterBase::update_gain_sensitive ()
426 bool x = !(_amp->gain_control()->alist()->automation_state() & Play);
427 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (x);
431 next_meter_point (MeterPoint mp)
435 return MeterPreFader;
439 return MeterPostFader;
451 GainMeterBase::meter_press(GdkEventButton* ev)
453 wait_for_release = false;
459 if (!ignore_toggle) {
461 if (Keyboard::is_context_menu_event (ev)) {
463 // no menu at this time.
467 if (Keyboard::is_button2_event(ev)) {
469 // Primary-button2 click is the midi binding click
470 // button2-click is "momentary"
472 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
473 wait_for_release = true;
474 old_meter_point = _route->meter_point ();
478 if (_route && (ev->button == 1 || Keyboard::is_button2_event (ev))) {
480 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
482 /* Primary+Tertiary-click applies change to all routes */
484 _session.begin_reversible_command (_("meter point change"));
485 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
486 _session.foreach_route (this, &GainMeterBase::set_meter_point, next_meter_point (_route->meter_point()));
488 _session.add_command (cmd);
489 _session.commit_reversible_command ();
492 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
494 /* Primary-click: solo mix group.
495 NOTE: Primary-button2 is MIDI learn.
498 if (ev->button == 1) {
499 _session.begin_reversible_command (_("meter point change"));
500 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
501 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
503 _session.add_command (cmd);
504 _session.commit_reversible_command ();
509 /* click: change just this route */
513 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
524 GainMeterBase::meter_release(GdkEventButton* ev)
527 if (wait_for_release){
528 wait_for_release = false;
531 set_meter_point (*_route, old_meter_point);
540 GainMeterBase::set_meter_point (Route& route, MeterPoint mp)
542 route.set_meter_point (mp, this);
546 GainMeterBase::set_mix_group_meter_point (Route& route, MeterPoint mp)
548 RouteGroup* mix_group;
550 if((mix_group = route.route_group()) != 0){
551 mix_group->apply (&Route::set_meter_point, mp, this);
553 route.set_meter_point (mp, this);
558 GainMeterBase::meter_point_clicked ()
566 GainMeterBase::start_gain_touch (GdkEventButton* ev)
568 _amp->gain_control()->start_touch ();
573 GainMeterBase::end_gain_touch (GdkEventButton* ev)
575 _amp->gain_control()->stop_touch ();
580 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
582 if (ev->type == GDK_BUTTON_RELEASE) {
586 switch (ev->button) {
588 gain_astate_menu.popup (1, ev->time);
598 GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
600 if (ev->type == GDK_BUTTON_RELEASE) {
604 switch (ev->button) {
606 gain_astyle_menu.popup (1, ev->time);
615 GainMeterBase::astate_string (AutoState state)
617 return _astate_string (state, false);
621 GainMeterBase::short_astate_string (AutoState state)
623 return _astate_string (state, true);
627 GainMeterBase::_astate_string (AutoState state, bool shrt)
633 sstr = (shrt ? "M" : _("M"));
636 sstr = (shrt ? "P" : _("P"));
639 sstr = (shrt ? "T" : _("T"));
642 sstr = (shrt ? "W" : _("W"));
650 GainMeterBase::astyle_string (AutoStyle style)
652 return _astyle_string (style, false);
656 GainMeterBase::short_astyle_string (AutoStyle style)
658 return _astyle_string (style, true);
662 GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
667 /* XXX it might different in different languages */
669 return (shrt ? _("Abs") : _("Abs"));
674 GainMeterBase::gain_automation_style_changed ()
678 gain_automation_style_button.set_label (astyle_string(_amp->gain_control()->alist()->automation_style()));
681 gain_automation_style_button.set_label (short_astyle_string(_amp->gain_control()->alist()->automation_style()));
687 GainMeterBase::gain_automation_state_changed ()
689 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeterBase::gain_automation_state_changed));
695 gain_automation_state_button.set_label (astate_string(_amp->gain_control()->alist()->automation_state()));
698 gain_automation_state_button.set_label (short_astate_string(_amp->gain_control()->alist()->automation_state()));
702 x = (_amp->gain_control()->alist()->automation_state() != Off);
704 if (gain_automation_state_button.get_active() != x) {
705 ignore_toggle = true;
706 gain_automation_state_button.set_active (x);
707 ignore_toggle = false;
710 update_gain_sensitive ();
712 /* start watching automation so that things move */
714 gain_watching.disconnect();
717 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeterBase::effective_gain_display));
722 GainMeterBase::update_meters()
725 float mpeak = level_meter->update_meters();
727 if (mpeak > max_peak) {
729 if (mpeak <= -200.0f) {
730 peak_display.set_label (_("-inf"));
732 snprintf (buf, sizeof(buf), "%.1f", mpeak);
733 peak_display.set_label (buf);
737 peak_display.set_name ("MixerStripPeakDisplayPeak");
742 void GainMeterBase::color_handler(bool dpi)
744 color_changed = true;
745 dpi_changed = (dpi) ? true : false;
750 GainMeterBase::set_width (Width w, int len)
753 level_meter->setup_meters (len);
758 GainMeterBase::on_theme_changed()
760 style_changed = true;
763 GainMeter::GainMeter (Session& s)
764 : GainMeterBase (s, slider, false)
766 gain_display_box.set_homogeneous (true);
767 gain_display_box.set_spacing (2);
768 gain_display_box.pack_start (gain_display, true, true);
770 meter_metric_area.set_name ("AudioTrackMetrics");
771 set_size_request_to_display_given_text (meter_metric_area, "-50", 0, 0);
773 gain_automation_style_button.set_name ("MixerAutomationModeButton");
774 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
776 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
777 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
779 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
780 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
782 gain_automation_state_button.set_size_request(15, 15);
783 gain_automation_style_button.set_size_request(15, 15);
785 HBox* fader_centering_box = manage (new HBox);
786 fader_centering_box->pack_start (*gain_slider, true, false);
788 fader_vbox = manage (new Gtk::VBox());
789 fader_vbox->set_spacing (0);
790 fader_vbox->pack_start (*fader_centering_box, false, false, 0);
792 hbox.set_spacing (2);
793 hbox.pack_start (*fader_vbox, true, true);
797 pack_start (gain_display_box, Gtk::PACK_SHRINK);
798 pack_start (hbox, Gtk::PACK_SHRINK);
800 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
804 GainMeter::set_controls (boost::shared_ptr<Route> r,
805 boost::shared_ptr<PeakMeter> meter,
806 boost::shared_ptr<Amp> amp)
808 if (level_meter->get_parent()) {
809 hbox.remove (*level_meter);
812 if (peak_display.get_parent()) {
813 gain_display_box.remove (peak_display);
816 if (gain_automation_state_button.get_parent()) {
817 fader_vbox->remove (gain_automation_state_button);
820 GainMeterBase::set_controls (r, meter, amp);
823 if we have a non-hidden route (ie. we're not the click or the auditioner),
824 pack some route-dependent stuff.
827 gain_display_box.pack_end (peak_display, true, true);
828 hbox.pack_end (*level_meter, true, true);
830 if (!r->is_hidden()) {
831 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
839 GainMeter::get_gm_width ()
842 hbox.size_request (sz);
846 Glib::RefPtr<Gdk::Pixmap>
847 GainMeter::render_metrics (Gtk::Widget& w)
849 Glib::RefPtr<Gdk::Window> win (w.get_window());
850 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
851 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
853 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
856 win->get_size (width, height);
858 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
860 metric_pixmaps[w.get_name()] = pixmap;
862 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
864 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
866 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
868 float fraction = log_meter (db_points[i]);
869 gint pos = height - (gint) floor (height * fraction);
871 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
873 layout->set_text (buf);
875 /* we want logical extents, not ink extents here */
878 layout->get_pixel_size (width, height);
880 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
881 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
888 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
890 static Glib::RefPtr<Gtk::Style> meter_style;
892 meter_style = meter_metric_area.get_style();
894 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
895 Glib::RefPtr<Gdk::GC> bg_gc (meter_style->get_bg_gc (Gtk::STATE_INSENSITIVE));
896 GdkRectangle base_rect;
897 GdkRectangle draw_rect;
900 win->get_size (width, height);
902 base_rect.width = width;
903 base_rect.height = height;
907 Glib::RefPtr<Gdk::Pixmap> pixmap;
908 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
910 if (i == metric_pixmaps.end() || style_changed || dpi_changed) {
911 pixmap = render_metrics (meter_metric_area);
916 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
917 win->draw_drawable (bg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
918 style_changed = false;
922 boost::shared_ptr<PBD::Controllable>
923 GainMeterBase::get_controllable()
926 return _amp->gain_control();
928 return boost::shared_ptr<PBD::Controllable>();