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>
39 #include "ardour_ui.h"
40 #include "gain_meter.h"
43 #include "gui_thread.h"
45 #include "public_editor.h"
47 #include <ardour/session.h>
48 #include <ardour/route.h>
49 #include <ardour/meter.h>
53 using namespace ARDOUR;
55 using namespace Gtkmm2ext;
60 sigc::signal<void> GainMeterBase::ResetAllPeakDisplays;
61 sigc::signal<void,RouteGroup*> GainMeterBase::ResetGroupPeakDisplays;
63 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
64 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
68 GainMeter::setup_slider_pix ()
70 if ((slider = ::get_icon ("fader_belt")) == 0) {
71 throw failed_constructor();
75 GainMeterBase::GainMeterBase (Session& s,
76 const Glib::RefPtr<Gdk::Pixbuf>& pix,
79 // 0.781787 is the value needed for gain to be set to 0.
80 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
81 gain_automation_style_button (""),
82 gain_automation_state_button ("")
85 using namespace Menu_Helpers;
87 ignore_toggle = false;
89 next_release_selects = false;
94 gain_slider = manage (new HSliderController (pix,
98 gain_slider = manage (new VSliderController (pix,
103 level_meter = new LevelMeter(_session);
105 gain_slider->signal_button_press_event().connect (mem_fun(*this, &GainMeter::start_gain_touch));
106 gain_slider->signal_button_release_event().connect (mem_fun(*this, &GainMeter::end_gain_touch));
107 gain_slider->set_name ("GainFader");
109 gain_display.set_name ("MixerStripGainDisplay");
110 gain_display.set_has_frame (false);
111 set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
112 gain_display.signal_activate().connect (mem_fun (*this, &GainMeter::gain_activated));
113 gain_display.signal_focus_in_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
114 gain_display.signal_focus_out_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
116 peak_display.set_name ("MixerStripPeakDisplay");
117 // peak_display.set_has_frame (false);
118 // peak_display.set_editable (false);
119 set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
120 max_peak = minus_infinity();
121 peak_display.set_label (_("-inf"));
122 peak_display.unset_flags (Gtk::CAN_FOCUS);
124 gain_automation_style_button.set_name ("MixerAutomationModeButton");
125 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
127 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
128 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
130 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
131 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
133 gain_automation_state_button.set_size_request(15, 15);
134 gain_automation_style_button.set_size_request(15, 15);
136 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
137 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
139 gain_astate_menu.set_name ("ArdourContextMenu");
140 gain_astyle_menu.set_name ("ArdourContextMenu");
142 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeterBase::gain_adjusted));
143 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeterBase::peak_button_release), false);
144 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeterBase::gain_key_press), false);
146 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_peak_display));
147 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeterBase::reset_group_peak_display));
149 UI::instance()->theme_changed.connect (mem_fun(*this, &GainMeterBase::on_theme_changed));
150 ColorsChanged.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), false));
151 DPIReset.connect (bind(mem_fun (*this, &GainMeterBase::color_handler), true));
154 GainMeterBase::~GainMeterBase ()
161 GainMeterBase::set_io (boost::shared_ptr<IO> io)
163 connections.clear ();
167 level_meter->set_io (_io);
168 gain_slider->set_controllable (_io->gain_control());
170 boost::shared_ptr<Route> r;
172 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
174 if (!r->is_hidden()) {
176 using namespace Menu_Helpers;
178 gain_astate_menu.items().clear ();
180 gain_astate_menu.items().push_back (MenuElem (_("Manual"),
181 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
182 Evoral::Parameter(GainAutomation), (AutoState) Off)));
183 gain_astate_menu.items().push_back (MenuElem (_("Play"),
184 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
185 Evoral::Parameter(GainAutomation), (AutoState) Play)));
186 gain_astate_menu.items().push_back (MenuElem (_("Write"),
187 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
188 Evoral::Parameter(GainAutomation), (AutoState) Write)));
189 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
190 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
191 Evoral::Parameter(GainAutomation), (AutoState) Touch)));
193 connections.push_back (gain_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &GainMeterBase::gain_automation_style_button_event), false));
194 connections.push_back (gain_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &GainMeterBase::gain_automation_state_button_event), false));
196 connections.push_back (r->gain_control()->alist()->automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed)));
197 connections.push_back (r->gain_control()->alist()->automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed)));
199 gain_automation_state_changed ();
203 connections.push_back (_io->gain_control()->Changed.connect (mem_fun(*this, &GainMeterBase::gain_changed)));
207 update_gain_sensitive ();
211 GainMeterBase::hide_all_meters ()
213 level_meter->hide_meters();
217 GainMeter::hide_all_meters ()
219 bool remove_metric_area = false;
221 GainMeterBase::hide_all_meters ();
223 if (remove_metric_area) {
224 if (meter_metric_area.get_parent()) {
225 level_meter->remove (meter_metric_area);
231 GainMeterBase::setup_meters (int len)
233 level_meter->setup_meters(len, 5);
237 GainMeter::setup_meters (int len)
239 if (!meter_metric_area.get_parent()) {
240 level_meter->pack_end (meter_metric_area, false, false);
241 meter_metric_area.show_all ();
243 GainMeterBase::setup_meters (len);
247 GainMeterBase::gain_key_press (GdkEventKey* ev)
249 if (key_is_legal_for_numeric_entry (ev->keyval)) {
250 /* drop through to normal handling */
253 /* illegal key for gain entry */
258 GainMeterBase::peak_button_release (GdkEventButton* ev)
260 /* reset peak label */
262 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
263 ResetAllPeakDisplays ();
264 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
265 boost::shared_ptr<Route> r;
267 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
268 ResetGroupPeakDisplays (r->mix_group());
271 reset_peak_display ();
278 GainMeterBase::reset_peak_display ()
280 boost::shared_ptr<Route> r;
282 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
283 r->peak_meter().reset_max();
286 level_meter->clear_meters();
287 max_peak = -INFINITY;
288 peak_display.set_label (_("-Inf"));
289 peak_display.set_name ("MixerStripPeakDisplay");
293 GainMeterBase::reset_group_peak_display (RouteGroup* group)
295 boost::shared_ptr<Route> r;
297 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
298 if (group == r->mix_group()) {
299 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 _io->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 _io->gain_control()->set_value (slider_position_to_gain (gain_adjustment.get_value()));
381 GainMeterBase::effective_gain_display ()
383 gfloat value = gain_to_slider_position (_io->effective_gain());
385 if (gain_adjustment.get_value() != value) {
386 ignore_toggle = true;
387 gain_adjustment.set_value (value);
388 ignore_toggle = false;
393 GainMeterBase::gain_changed ()
395 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeterBase::effective_gain_display));
399 GainMeterBase::set_meter_strip_name (const char * name)
401 meter_metric_area.set_name (name);
405 GainMeterBase::set_fader_name (const char * name)
407 gain_slider->set_name (name);
411 GainMeterBase::update_gain_sensitive ()
413 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (
414 !(_io->gain_control()->alist()->automation_state() & Play));
419 next_meter_point (MeterPoint mp)
423 return MeterPreFader;
427 return MeterPostFader;
439 GainMeterBase::meter_press(GdkEventButton* ev)
441 boost::shared_ptr<Route> _route;
443 wait_for_release = false;
445 if ((_route = boost::dynamic_pointer_cast<Route>(_io)) == 0) {
449 if (!ignore_toggle) {
451 if (Keyboard::is_context_menu_event (ev)) {
453 // no menu at this time.
457 if (Keyboard::is_button2_event(ev)) {
459 // Primary-button2 click is the midi binding click
460 // button2-click is "momentary"
462 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier))) {
463 wait_for_release = true;
464 old_meter_point = _route->meter_point ();
468 if (ev->button == 1 || Keyboard::is_button2_event (ev)) {
470 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::PrimaryModifier|Keyboard::TertiaryModifier))) {
472 /* Primary+Tertiary-click applies change to all routes */
474 _session.begin_reversible_command (_("meter point change"));
475 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
476 _session.foreach_route (this, &GainMeterBase::set_meter_point, next_meter_point (_route->meter_point()));
478 _session.add_command (cmd);
479 _session.commit_reversible_command ();
482 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
484 /* Primary-click: solo mix group.
485 NOTE: Primary-button2 is MIDI learn.
488 if (ev->button == 1) {
489 _session.begin_reversible_command (_("meter point change"));
490 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
491 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
493 _session.add_command (cmd);
494 _session.commit_reversible_command ();
499 /* click: change just this route */
503 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
514 GainMeterBase::meter_release(GdkEventButton* ev)
517 if (wait_for_release){
518 wait_for_release = false;
520 boost::shared_ptr<Route> r;
522 if ((r = boost::dynamic_pointer_cast<Route>(_io)) != 0) {
523 set_meter_point (*r, 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.mix_group()) != 0){
543 mix_group->apply (&Route::set_meter_point, mp, this);
545 route.set_meter_point (mp, this);
550 GainMeterBase::meter_point_clicked ()
552 boost::shared_ptr<Route> r;
554 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
560 GainMeterBase::start_gain_touch (GdkEventButton* ev)
562 _io->gain_control()->alist()->start_touch ();
567 GainMeterBase::end_gain_touch (GdkEventButton* ev)
569 _io->gain_control()->alist()->stop_touch ();
574 GainMeterBase::gain_automation_state_button_event (GdkEventButton *ev)
576 if (ev->type == GDK_BUTTON_RELEASE) {
580 switch (ev->button) {
582 gain_astate_menu.popup (1, ev->time);
592 GainMeterBase::gain_automation_style_button_event (GdkEventButton *ev)
594 if (ev->type == GDK_BUTTON_RELEASE) {
598 switch (ev->button) {
600 gain_astyle_menu.popup (1, ev->time);
609 GainMeterBase::astate_string (AutoState state)
611 return _astate_string (state, false);
615 GainMeterBase::short_astate_string (AutoState state)
617 return _astate_string (state, true);
621 GainMeterBase::_astate_string (AutoState state, bool shrt)
627 sstr = (shrt ? "M" : _("M"));
630 sstr = (shrt ? "P" : _("P"));
633 sstr = (shrt ? "T" : _("T"));
636 sstr = (shrt ? "W" : _("W"));
644 GainMeterBase::astyle_string (AutoStyle style)
646 return _astyle_string (style, false);
650 GainMeterBase::short_astyle_string (AutoStyle style)
652 return _astyle_string (style, true);
656 GainMeterBase::_astyle_string (AutoStyle style, bool shrt)
661 /* XXX it might different in different languages */
663 return (shrt ? _("Abs") : _("Abs"));
668 GainMeterBase::gain_automation_style_changed ()
672 gain_automation_style_button.set_label (astyle_string(_io->gain_control()->alist()->automation_style()));
675 gain_automation_style_button.set_label (short_astyle_string(_io->gain_control()->alist()->automation_style()));
681 GainMeterBase::gain_automation_state_changed ()
683 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeterBase::gain_automation_state_changed));
689 gain_automation_state_button.set_label (astate_string(_io->gain_control()->alist()->automation_state()));
692 gain_automation_state_button.set_label (short_astate_string(_io->gain_control()->alist()->automation_state()));
696 x = (_io->gain_control()->alist()->automation_state() != Off);
698 if (gain_automation_state_button.get_active() != x) {
699 ignore_toggle = true;
700 gain_automation_state_button.set_active (x);
701 ignore_toggle = false;
704 update_gain_sensitive ();
706 /* start watching automation so that things move */
708 gain_watching.disconnect();
711 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeterBase::effective_gain_display));
716 GainMeterBase::update_meters()
719 float mpeak = level_meter->update_meters();
721 if (mpeak > max_peak) {
723 if (mpeak <= -200.0f) {
724 peak_display.set_label (_("-inf"));
726 snprintf (buf, sizeof(buf), "%.1f", mpeak);
727 peak_display.set_label (buf);
731 peak_display.set_name ("MixerStripPeakDisplayPeak");
736 void GainMeterBase::color_handler(bool dpi)
738 color_changed = true;
739 dpi_changed = (dpi) ? true : false;
744 GainMeterBase::set_width (Width w, int len)
747 level_meter->setup_meters (len);
752 GainMeterBase::on_theme_changed()
754 style_changed = true;
757 GainMeter::GainMeter (Session& s)
758 : GainMeterBase (s, slider, false)
760 gain_display_box.set_homogeneous (true);
761 gain_display_box.set_spacing (2);
762 gain_display_box.pack_start (gain_display, true, true);
764 meter_metric_area.set_name ("AudioTrackMetrics");
765 set_size_request_to_display_given_text (meter_metric_area, "-50", 0, 0);
767 gain_automation_style_button.set_name ("MixerAutomationModeButton");
768 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
770 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
771 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
773 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
774 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
776 gain_automation_state_button.set_size_request(15, 15);
777 gain_automation_style_button.set_size_request(15, 15);
779 HBox* fader_centering_box = manage (new HBox);
780 fader_centering_box->pack_start (*gain_slider, true, false);
782 fader_vbox = manage (new Gtk::VBox());
783 fader_vbox->set_spacing (0);
784 fader_vbox->pack_start (*fader_centering_box, false, false, 0);
786 hbox.set_spacing (2);
787 hbox.pack_start (*fader_vbox, true, true);
791 pack_start (gain_display_box, Gtk::PACK_SHRINK);
792 pack_start (hbox, Gtk::PACK_SHRINK);
794 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
798 GainMeter::set_io (boost::shared_ptr<IO> io)
800 if (level_meter->get_parent()) {
801 hbox.remove (*level_meter);
804 if (peak_display.get_parent()) {
805 gain_display_box.remove (peak_display);
808 if (gain_automation_state_button.get_parent()) {
809 fader_vbox->remove (gain_automation_state_button);
812 GainMeterBase::set_io (io);
814 boost::shared_ptr<Route> r;
816 if ((r = boost::dynamic_pointer_cast<Route> (_io)) != 0) {
819 if we have a non-hidden route (ie. we're not the click or the auditioner),
820 pack some route-dependent stuff.
823 gain_display_box.pack_end (peak_display, true, true);
824 hbox.pack_end (*level_meter, true, true);
826 if (!r->is_hidden()) {
827 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
833 GainMeter::get_gm_width ()
836 hbox.size_request (sz);
840 Glib::RefPtr<Gdk::Pixmap>
841 GainMeter::render_metrics (Gtk::Widget& w)
843 Glib::RefPtr<Gdk::Window> win (w.get_window());
844 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
845 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
847 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
850 win->get_size (width, height);
852 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
854 metric_pixmaps[w.get_name()] = pixmap;
856 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
858 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
860 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
862 float fraction = log_meter (db_points[i]);
863 gint pos = height - (gint) floor (height * fraction);
865 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
867 layout->set_text (buf);
869 /* we want logical extents, not ink extents here */
872 layout->get_pixel_size (width, height);
874 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
875 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
882 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
884 static Glib::RefPtr<Gtk::Style> meter_style;
886 meter_style = meter_metric_area.get_style();
888 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
889 Glib::RefPtr<Gdk::GC> bg_gc (meter_style->get_bg_gc (Gtk::STATE_INSENSITIVE));
890 GdkRectangle base_rect;
891 GdkRectangle draw_rect;
894 win->get_size (width, height);
896 base_rect.width = width;
897 base_rect.height = height;
901 Glib::RefPtr<Gdk::Pixmap> pixmap;
902 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
904 if (i == metric_pixmaps.end() || style_changed || dpi_changed) {
905 pixmap = render_metrics (meter_metric_area);
910 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
911 win->draw_drawable (bg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
912 style_changed = false;