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 <gtkmm2ext/utils.h>
30 #include <gtkmm2ext/fastmeter.h>
31 #include <gtkmm2ext/stop_signal.h>
32 #include <gtkmm2ext/barcontroller.h>
33 #include <midi++/manager.h>
34 #include <pbd/fastlog.h>
36 #include "ardour_ui.h"
37 #include "gain_meter.h"
40 #include "gui_thread.h"
42 #include "public_editor.h"
44 #include <ardour/session.h>
45 #include <ardour/route.h>
46 #include <ardour/meter.h>
50 using namespace ARDOUR;
52 using namespace Gtkmm2ext;
57 sigc::signal<void> GainMeter::ResetAllPeakDisplays;
58 sigc::signal<void,RouteGroup*> GainMeter::ResetGroupPeakDisplays;
59 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
60 Glib::RefPtr<Gdk::Pixbuf> GainMeter::rail;
61 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
64 GainMeter::setup_slider_pix ()
66 slider = ::get_icon ("fader_belt");
70 GainMeter::GainMeter (boost::shared_ptr<IO> io, Session& s)
74 // 0.781787 is the value needed for gain to be set to 0.
75 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
76 gain_automation_style_button (""),
77 gain_automation_state_button ("")
84 ignore_toggle = false;
86 next_release_selects = false;
88 gain_slider = manage (new VSliderController (slider,
93 gain_slider->signal_button_press_event().connect (mem_fun(*this, &GainMeter::start_gain_touch));
94 gain_slider->signal_button_release_event().connect (mem_fun(*this, &GainMeter::end_gain_touch));
95 gain_slider->set_name ("GainFader");
97 gain_display.set_name ("MixerStripGainDisplay");
98 gain_display.set_has_frame (false);
99 set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
100 gain_display.signal_activate().connect (mem_fun (*this, &GainMeter::gain_activated));
101 gain_display.signal_focus_in_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
102 gain_display.signal_focus_out_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
104 gain_display_box.set_homogeneous (true);
105 gain_display_box.set_spacing (2);
106 gain_display_box.pack_start (gain_display, true, true);
108 peak_display.set_name ("MixerStripPeakDisplay");
109 // peak_display.set_has_frame (false);
110 // peak_display.set_editable (false);
111 set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
112 max_peak = minus_infinity();
113 peak_display.set_label (_("-inf"));
114 peak_display.unset_flags (Gtk::CAN_FOCUS);
116 meter_metric_area.set_name ("MeterMetricsStrip");
117 set_size_request_to_display_given_text (meter_metric_area, "-50", 0, 0);
119 meter_packer.set_spacing (2);
121 gain_automation_style_button.set_name ("MixerAutomationModeButton");
122 gain_automation_state_button.set_name ("MixerAutomationPlaybackButton");
124 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_state_button, _("Fader automation mode"));
125 ARDOUR_UI::instance()->tooltips().set_tip (gain_automation_style_button, _("Fader automation type"));
127 gain_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
128 gain_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
130 gain_automation_state_button.set_size_request(15, 15);
131 gain_automation_style_button.set_size_request(15, 15);
133 HBox* fader_centering_box = manage (new HBox);
134 fader_centering_box->pack_start (*gain_slider, true, false);
136 fader_vbox = manage (new Gtk::VBox());
137 fader_vbox->set_spacing (0);
138 fader_vbox->pack_start (*fader_centering_box, false, false, 0);
140 hbox.set_spacing (2);
142 if (_io->default_type() == ARDOUR::DataType::AUDIO) {
143 hbox.pack_start (*fader_vbox, true, true);
150 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
153 if we have a route (ie. we're not the click),
154 pack some route-dependent stuff.
157 gain_display_box.pack_end (peak_display, true, true);
159 hbox.pack_end (meter_packer, true, true);
161 using namespace Menu_Helpers;
163 gain_astate_menu.items().push_back (MenuElem (_("Manual"),
164 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Off)));
165 gain_astate_menu.items().push_back (MenuElem (_("Play"),
166 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Play)));
167 gain_astate_menu.items().push_back (MenuElem (_("Write"),
168 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Write)));
169 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
170 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Touch)));
172 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
173 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
175 gain_astate_menu.set_name ("ArdourContextMenu");
176 gain_astyle_menu.set_name ("ArdourContextMenu");
178 gain_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_style_button_event), false);
179 gain_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_state_button_event), false);
181 r->gain_automation_curve().automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed));
182 r->gain_automation_curve().automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed));
183 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
185 gain_automation_state_changed ();
190 pack_start (gain_display_box, Gtk::PACK_SHRINK);
191 pack_start (hbox, Gtk::PACK_SHRINK);
193 _io->gain_changed.connect (mem_fun(*this, &GainMeter::gain_changed));
195 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
196 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeter::gain_adjusted));
197 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeter::peak_button_release), false);
198 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeter::gain_key_press), false);
200 Config->ParameterChanged.connect (mem_fun (*this, &GainMeter::parameter_changed));
205 update_gain_sensitive ();
207 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_peak_display));
208 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_group_peak_display));
212 GainMeter::set_width (Width w)
227 Glib::RefPtr<Gdk::Pixmap>
228 GainMeter::render_metrics (Gtk::Widget& w)
230 Glib::RefPtr<Gdk::Window> win (w.get_window());
231 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
232 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
234 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
237 win->get_size (width, height);
239 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
241 metric_pixmaps[w.get_name()] = pixmap;
243 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
245 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
247 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
249 float fraction = log_meter (db_points[i]);
250 gint pos = height - (gint) floor (height * fraction);
252 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
254 layout->set_text (buf);
256 /* we want logical extents, not ink extents here */
259 layout->get_pixel_size (width, height);
261 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
262 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
269 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
271 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
272 Glib::RefPtr<Gdk::GC> fg_gc (meter_metric_area.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
273 Glib::RefPtr<Gdk::GC> bg_gc (meter_metric_area.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
274 GdkRectangle base_rect;
275 GdkRectangle draw_rect;
278 win->get_size (width, height);
280 base_rect.width = width;
281 base_rect.height = height;
285 Glib::RefPtr<Gdk::Pixmap> pixmap;
286 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
288 if (i == metric_pixmaps.end()) {
289 pixmap = render_metrics (meter_metric_area);
294 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
295 win->draw_rectangle (bg_gc, true, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
296 win->draw_drawable (bg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
301 GainMeter::~GainMeter ()
307 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
315 GainMeter::update_meters ()
317 vector<MeterInfo>::iterator i;
322 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
324 peak = _io->peak_meter().peak_power (n);
326 (*i).meter->set (log_meter (peak));
328 mpeak = _io->peak_meter().max_peak_power(n);
330 if (mpeak > max_peak) {
332 /* set peak display */
333 if (max_peak <= -200.0f) {
334 peak_display.set_label (_("-inf"));
336 snprintf (buf, sizeof(buf), "%.1f", max_peak);
337 peak_display.set_label (buf);
340 if (max_peak >= 0.0f) {
341 peak_display.set_name ("MixerStripPeakDisplayPeak");
349 GainMeter::parameter_changed(const char* parameter_name)
351 #define PARAM_IS(x) (!strcmp (parameter_name, (x)))
353 ENSURE_GUI_THREAD (bind (mem_fun(*this, &GainMeter::parameter_changed), parameter_name));
355 if (PARAM_IS ("meter-hold")) {
357 vector<MeterInfo>::iterator i;
360 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
362 (*i).meter->set_hold_count ((uint32_t) floor(Config->get_meter_hold()));
370 GainMeter::hide_all_meters ()
372 bool remove_metric_area = false;
374 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); ++i) {
376 remove_metric_area = true;
377 meter_packer.remove (*((*i).meter));
382 if (remove_metric_area) {
383 if (meter_metric_area.get_parent()) {
384 meter_packer.remove (meter_metric_area);
390 GainMeter::setup_meters ()
392 uint32_t nmeters = _io->n_outputs().n_audio();
399 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
401 switch (r->meter_point()) {
404 nmeters = r->n_inputs().n_audio();
407 nmeters = r->n_outputs().n_audio();
413 nmeters = _io->n_outputs().n_audio();
422 width = regular_meter_width;
424 width = thin_meter_width;
427 while (meters.size() < nmeters) {
428 meters.push_back (MeterInfo());
431 /* pack them backwards */
433 if (_width == Wide) {
434 meter_packer.pack_end (meter_metric_area, false, false);
435 meter_metric_area.show_all ();
438 for (int32_t n = nmeters-1; nmeters && n >= 0 ; --n) {
439 if (meters[n].width != width) {
440 delete meters[n].meter;
441 meters[n].meter = new FastMeter ((uint32_t) floor (Config->get_meter_hold()), width, FastMeter::Vertical);
442 meters[n].width = width;
444 meters[n].meter->add_events (Gdk::BUTTON_RELEASE_MASK);
445 meters[n].meter->signal_button_release_event().connect (bind (mem_fun(*this, &GainMeter::meter_button_release), n));
448 meter_packer.pack_end (*meters[n].meter, false, false);
449 meters[n].meter->show_all ();
450 meters[n].packed = true;
455 GainMeter::get_gm_width ()
457 Gtk::Requisition sz = hbox.size_request ();
462 GainMeter::gain_key_press (GdkEventKey* ev)
464 if (key_is_legal_for_numeric_entry (ev->keyval)) {
465 /* drop through to normal handling */
468 /* illegal key for gain entry */
473 GainMeter::peak_button_release (GdkEventButton* ev)
475 /* reset peak label */
477 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control|Keyboard::Shift)) {
478 ResetAllPeakDisplays ();
479 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
481 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
482 ResetGroupPeakDisplays (r->mix_group());
485 reset_peak_display ();
492 GainMeter::reset_peak_display ()
495 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
496 r->peak_meter().reset_max();
499 max_peak = -INFINITY;
500 peak_display.set_label (_("-Inf"));
501 peak_display.set_name ("MixerStripPeakDisplay");
505 GainMeter::reset_group_peak_display (RouteGroup* group)
508 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
509 if (group == r->mix_group()) {
510 reset_peak_display ();
516 GainMeter::meter_button_release (GdkEventButton* ev, uint32_t which)
518 switch (ev->button) {
520 meters[which].meter->clear();
521 max_peak = minus_infinity();
522 peak_display.set_label (_("-inf"));
523 peak_display.set_name ("MixerStripPeakDisplay");
527 // popup_meter_menu (ev);
535 GainMeter::popup_meter_menu (GdkEventButton *ev)
537 using namespace Menu_Helpers;
539 if (meter_menu == 0) {
540 meter_menu = new Gtk::Menu;
541 MenuList& items = meter_menu->items();
543 items.push_back (MenuElem ("-inf .. +0dBFS"));
544 items.push_back (MenuElem ("-10dB .. +0dBFS"));
545 items.push_back (MenuElem ("-4 .. +0dBFS"));
546 items.push_back (SeparatorElem());
547 items.push_back (MenuElem ("-inf .. -2dBFS"));
548 items.push_back (MenuElem ("-10dB .. -2dBFS"));
549 items.push_back (MenuElem ("-4 .. -2dBFS"));
552 meter_menu->popup (1, ev->time);
556 GainMeter::gain_focused (GdkEventFocus* ev)
559 gain_display.select_region (0, -1);
561 gain_display.select_region (0, 0);
567 GainMeter::gain_activated ()
571 if (sscanf (gain_display.get_text().c_str(), "%f", &f) == 1) {
573 /* clamp to displayable values */
577 _io->set_gain (dB_to_coefficient(f), this);
579 if (gain_display.has_focus()) {
580 PublicEditor::instance().reset_focus();
586 GainMeter::show_gain ()
590 float v = gain_adjustment.get_value();
593 strcpy (buf, _("-inf"));
595 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
598 gain_display.set_text (buf);
602 GainMeter::gain_adjusted ()
604 if (!ignore_toggle) {
605 _io->set_gain (slider_position_to_gain (gain_adjustment.get_value()), this);
611 GainMeter::effective_gain_display ()
613 gfloat value = gain_to_slider_position (_io->effective_gain());
615 if (gain_adjustment.get_value() != value) {
616 ignore_toggle = true;
617 gain_adjustment.set_value (value);
618 ignore_toggle = false;
623 GainMeter::gain_changed (void *src)
625 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeter::effective_gain_display));
629 GainMeter::set_meter_strip_name (const char * name)
631 meter_metric_area.set_name (name);
635 GainMeter::set_fader_name (const char * name)
637 gain_slider->set_name (name);
641 GainMeter::update_gain_sensitive ()
643 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (!(_io->gain_automation_state() & Play));
648 next_meter_point (MeterPoint mp)
652 return MeterPreFader;
656 return MeterPostFader;
668 GainMeter::meter_press(GdkEventButton* ev)
672 wait_for_release = false;
674 if ((_route = dynamic_cast<Route*>(_io.get())) == 0) {
678 if (!ignore_toggle) {
680 if (Keyboard::is_context_menu_event (ev)) {
682 // no menu at this time.
686 if (ev->button == 2) {
688 // ctrl-button2 click is the midi binding click
689 // button2-click is "momentary"
691 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control))) {
692 wait_for_release = true;
693 old_meter_point = _route->meter_point ();
697 if (ev->button == 1 || ev->button == 2) {
699 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control|Keyboard::Shift))) {
701 /* ctrl-shift-click applies change to all routes */
703 _session.begin_reversible_command (_("meter point change"));
704 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
705 _session.foreach_route (this, &GainMeter::set_meter_point, next_meter_point (_route->meter_point()));
707 _session.add_command (cmd);
708 _session.commit_reversible_command ();
711 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
713 /* ctrl-click: solo mix group.
714 ctrl-button2 is MIDI learn.
717 if (ev->button == 1) {
718 _session.begin_reversible_command (_("meter point change"));
719 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
720 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
722 _session.add_command (cmd);
723 _session.commit_reversible_command ();
728 /* click: change just this route */
732 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
743 GainMeter::meter_release(GdkEventButton* ev)
747 if (wait_for_release){
748 wait_for_release = false;
749 set_meter_point (*(dynamic_cast<Route*>(_io.get())), old_meter_point);
756 GainMeter::set_meter_point (Route& route, MeterPoint mp)
758 route.set_meter_point (mp, this);
762 GainMeter::set_mix_group_meter_point (Route& route, MeterPoint mp)
764 RouteGroup* mix_group;
766 if((mix_group = route.mix_group()) != 0){
767 mix_group->apply (&Route::set_meter_point, mp, this);
769 route.set_meter_point (mp, this);
774 GainMeter::meter_point_clicked ()
778 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
784 GainMeter::start_gain_touch (GdkEventButton* ev)
786 _io->start_gain_touch ();
791 GainMeter::end_gain_touch (GdkEventButton* ev)
793 _io->end_gain_touch ();
798 GainMeter::gain_automation_state_button_event (GdkEventButton *ev)
800 if (ev->type == GDK_BUTTON_RELEASE) {
804 switch (ev->button) {
806 gain_astate_menu.popup (1, ev->time);
816 GainMeter::gain_automation_style_button_event (GdkEventButton *ev)
818 if (ev->type == GDK_BUTTON_RELEASE) {
822 switch (ev->button) {
824 gain_astyle_menu.popup (1, ev->time);
833 GainMeter::astate_string (AutoState state)
835 return _astate_string (state, false);
839 GainMeter::short_astate_string (AutoState state)
841 return _astate_string (state, true);
845 GainMeter::_astate_string (AutoState state, bool shrt)
851 sstr = (shrt ? "M" : _("M"));
854 sstr = (shrt ? "P" : _("P"));
857 sstr = (shrt ? "T" : _("T"));
860 sstr = (shrt ? "W" : _("W"));
868 GainMeter::astyle_string (AutoStyle style)
870 return _astyle_string (style, false);
874 GainMeter::short_astyle_string (AutoStyle style)
876 return _astyle_string (style, true);
880 GainMeter::_astyle_string (AutoStyle style, bool shrt)
885 /* XXX it might different in different languages */
887 return (shrt ? _("Abs") : _("Abs"));
892 GainMeter::gain_automation_style_changed ()
894 // Route* _route = dynamic_cast<Route*>(&_io);
897 gain_automation_style_button.set_label (astyle_string(_io->gain_automation_curve().automation_style()));
900 gain_automation_style_button.set_label (short_astyle_string(_io->gain_automation_curve().automation_style()));
906 GainMeter::gain_automation_state_changed ()
908 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeter::gain_automation_state_changed));
909 //Route* _route = dynamic_cast<Route*>(&_io);
915 gain_automation_state_button.set_label (astate_string(_io->gain_automation_curve().automation_state()));
918 gain_automation_state_button.set_label (short_astate_string(_io->gain_automation_curve().automation_state()));
922 x = (_io->gain_automation_state() != Off);
924 if (gain_automation_state_button.get_active() != x) {
925 ignore_toggle = true;
926 gain_automation_state_button.set_active (x);
927 ignore_toggle = false;
930 update_gain_sensitive ();
932 /* start watching automation so that things move */
934 gain_watching.disconnect();
937 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeter::effective_gain_display));