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>
49 using namespace ARDOUR;
51 using namespace Gtkmm2ext;
56 sigc::signal<void> GainMeter::ResetAllPeakDisplays;
57 sigc::signal<void,RouteGroup*> GainMeter::ResetGroupPeakDisplays;
58 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
59 Glib::RefPtr<Gdk::Pixbuf> GainMeter::rail;
60 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
63 GainMeter::setup_slider_pix ()
65 slider = ::get_icon ("fader_belt");
69 GainMeter::GainMeter (boost::shared_ptr<IO> io, Session& s)
73 // 0.781787 is the value needed for gain to be set to 0.
74 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
75 gain_automation_style_button (""),
76 gain_automation_state_button ("")
83 ignore_toggle = false;
85 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 ("AudioTrackMetrics");
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);
141 hbox.pack_start (*fader_vbox, true, true);
147 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
150 if we have a route (ie. we're not the click),
151 pack some route-dependent stuff.
154 gain_display_box.pack_end (peak_display, true, true);
156 hbox.pack_end (meter_packer, true, true);
158 using namespace Menu_Helpers;
160 gain_astate_menu.items().push_back (MenuElem (_("Manual"),
161 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Off)));
162 gain_astate_menu.items().push_back (MenuElem (_("Play"),
163 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Play)));
164 gain_astate_menu.items().push_back (MenuElem (_("Write"),
165 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Write)));
166 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
167 bind (mem_fun (*_io, &IO::set_gain_automation_state), (AutoState) Touch)));
169 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
170 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
172 gain_astate_menu.set_name ("ArdourContextMenu");
173 gain_astyle_menu.set_name ("ArdourContextMenu");
175 gain_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_style_button_event), false);
176 gain_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_state_button_event), false);
178 r->gain_automation_curve().automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed));
179 r->gain_automation_curve().automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed));
180 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
182 gain_automation_state_changed ();
187 pack_start (gain_display_box, Gtk::PACK_SHRINK);
188 pack_start (hbox, Gtk::PACK_SHRINK);
190 _io->gain_changed.connect (mem_fun(*this, &GainMeter::gain_changed));
192 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
193 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeter::gain_adjusted));
194 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeter::peak_button_release), false);
195 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeter::gain_key_press), false);
197 Config->ParameterChanged.connect (mem_fun (*this, &GainMeter::parameter_changed));
202 update_gain_sensitive ();
204 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_peak_display));
205 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_group_peak_display));
207 UI::instance()->theme_changed.connect (mem_fun(*this, &GainMeter::on_theme_changed));
211 GainMeter::set_width (Width w)
226 Glib::RefPtr<Gdk::Pixmap>
227 GainMeter::render_metrics (Gtk::Widget& w)
229 //cerr << "name: " << w.get_name();//DEBUG
230 //cerr << " bg_red = " << w.get_style()->get_bg(Gtk::STATE_NORMAL).get_red();//DEBUG
231 //cerr << " fg_red = " << w.get_style()->get_fg(Gtk::STATE_NORMAL).get_red();//DEBUG
232 Glib::RefPtr<Gdk::Window> win (w.get_window());
233 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
234 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
236 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
239 win->get_size (width, height);
241 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
243 metric_pixmaps[w.get_name()] = pixmap;
245 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
247 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
249 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
251 float fraction = log_meter (db_points[i]);
252 gint pos = height - (gint) floor (height * fraction);
254 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
256 layout->set_text (buf);
258 /* we want logical extents, not ink extents here */
261 layout->get_pixel_size (width, height);
263 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
264 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
271 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
273 static Glib::RefPtr<Gtk::Style> meter_style;
274 //cerr << "GainMeter::meter_metrics_expose() called on " << meter_metric_area.get_name();//DEBUG
275 //cerr << " style_changed = " << style_changed;//DEBUG
277 meter_style = meter_metric_area.get_style();
278 // cerr << " get_style() called ";//DEBUG
280 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
281 //Glib::RefPtr<Gdk::GC> fg_gc (meter_style->get_fg_gc (Gtk::STATE_NORMAL));
282 Glib::RefPtr<Gdk::GC> bg_gc (meter_style->get_bg_gc (Gtk::STATE_INSENSITIVE));
283 GdkRectangle base_rect;
284 GdkRectangle draw_rect;
287 win->get_size (width, height);
289 base_rect.width = width;
290 base_rect.height = height;
294 Glib::RefPtr<Gdk::Pixmap> pixmap;
295 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
297 if (i == metric_pixmaps.end() || style_changed) {
298 pixmap = render_metrics (meter_metric_area);
301 // cerr << " re-used " << i->first;//DEBUG
304 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
305 //win->draw_rectangle (bg_gc, false, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
306 win->draw_drawable (bg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
307 //cerr << endl;//DEBUG
308 style_changed = false;
313 GainMeter::on_theme_changed()
315 style_changed = true;
318 GainMeter::~GainMeter ()
324 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
332 GainMeter::update_meters ()
334 vector<MeterInfo>::iterator i;
339 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
341 peak = _io->peak_input_power (n);
343 (*i).meter->set (log_meter (peak));
345 mpeak = _io->max_peak_power(n);
347 if (mpeak > max_peak) {
349 /* set peak display */
350 if (max_peak <= -200.0f) {
351 peak_display.set_label (_("-inf"));
353 snprintf (buf, sizeof(buf), "%.1f", max_peak);
354 peak_display.set_label (buf);
357 if (max_peak >= 0.0f) {
358 peak_display.set_name ("MixerStripPeakDisplayPeak");
366 GainMeter::parameter_changed(const char* parameter_name)
368 #define PARAM_IS(x) (!strcmp (parameter_name, (x)))
370 ENSURE_GUI_THREAD (bind (mem_fun(*this, &GainMeter::parameter_changed), parameter_name));
372 if (PARAM_IS ("meter-hold")) {
374 vector<MeterInfo>::iterator i;
377 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
379 (*i).meter->set_hold_count ((uint32_t) floor(Config->get_meter_hold()));
387 GainMeter::hide_all_meters ()
389 bool remove_metric_area = false;
391 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); ++i) {
393 remove_metric_area = true;
394 meter_packer.remove (*((*i).meter));
399 if (remove_metric_area) {
400 if (meter_metric_area.get_parent()) {
401 meter_packer.remove (meter_metric_area);
407 GainMeter::setup_meters ()
409 uint32_t nmeters = _io->n_outputs();
416 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
418 switch (r->meter_point()) {
421 nmeters = r->n_inputs();
424 nmeters = r->n_outputs();
430 nmeters = _io->n_outputs();
439 width = regular_meter_width;
441 width = thin_meter_width;
444 while (meters.size() < nmeters) {
445 meters.push_back (MeterInfo());
448 /* pack them backwards */
450 if (_width == Wide) {
451 meter_packer.pack_end (meter_metric_area, false, false);
452 meter_metric_area.show_all ();
455 for (int32_t n = nmeters-1; nmeters && n >= 0 ; --n) {
456 if (meters[n].width != width) {
457 delete meters[n].meter;
458 meters[n].meter = new FastMeter ((uint32_t) floor (Config->get_meter_hold()), width, FastMeter::Vertical);
459 meters[n].width = width;
461 meters[n].meter->add_events (Gdk::BUTTON_RELEASE_MASK);
462 meters[n].meter->signal_button_release_event().connect (bind (mem_fun(*this, &GainMeter::meter_button_release), n));
465 meter_packer.pack_end (*meters[n].meter, false, false);
466 meters[n].meter->show_all ();
467 meters[n].packed = true;
472 GainMeter::get_gm_width ()
475 hbox.size_request (sz);
480 GainMeter::gain_key_press (GdkEventKey* ev)
482 if (key_is_legal_for_numeric_entry (ev->keyval)) {
483 /* drop through to normal handling */
486 /* illegal key for gain entry */
491 GainMeter::peak_button_release (GdkEventButton* ev)
493 /* reset peak label */
495 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control|Keyboard::Shift)) {
496 ResetAllPeakDisplays ();
497 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
499 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
500 ResetGroupPeakDisplays (r->mix_group());
503 reset_peak_display ();
510 GainMeter::reset_peak_display ()
513 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
514 r->reset_max_peak_meters();
517 max_peak = -INFINITY;
518 peak_display.set_label (_("-Inf"));
519 peak_display.set_name ("MixerStripPeakDisplay");
523 GainMeter::reset_group_peak_display (RouteGroup* group)
526 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
527 if (group == r->mix_group()) {
528 reset_peak_display ();
534 GainMeter::meter_button_release (GdkEventButton* ev, uint32_t which)
536 switch (ev->button) {
538 meters[which].meter->clear();
539 max_peak = minus_infinity();
540 peak_display.set_label (_("-inf"));
541 peak_display.set_name ("MixerStripPeakDisplay");
545 // popup_meter_menu (ev);
553 GainMeter::popup_meter_menu (GdkEventButton *ev)
555 using namespace Menu_Helpers;
557 if (meter_menu == 0) {
558 meter_menu = new Gtk::Menu;
559 MenuList& items = meter_menu->items();
561 items.push_back (MenuElem ("-inf .. +0dBFS"));
562 items.push_back (MenuElem ("-10dB .. +0dBFS"));
563 items.push_back (MenuElem ("-4 .. +0dBFS"));
564 items.push_back (SeparatorElem());
565 items.push_back (MenuElem ("-inf .. -2dBFS"));
566 items.push_back (MenuElem ("-10dB .. -2dBFS"));
567 items.push_back (MenuElem ("-4 .. -2dBFS"));
570 meter_menu->popup (1, ev->time);
574 GainMeter::gain_focused (GdkEventFocus* ev)
577 gain_display.select_region (0, -1);
579 gain_display.select_region (0, 0);
585 GainMeter::gain_activated ()
589 if (sscanf (gain_display.get_text().c_str(), "%f", &f) == 1) {
591 /* clamp to displayable values */
595 _io->set_gain (dB_to_coefficient(f), this);
597 if (gain_display.has_focus()) {
598 PublicEditor::instance().reset_focus();
604 GainMeter::show_gain ()
608 float v = gain_adjustment.get_value();
611 strcpy (buf, _("-inf"));
613 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
616 gain_display.set_text (buf);
620 GainMeter::gain_adjusted ()
622 if (!ignore_toggle) {
623 _io->set_gain (slider_position_to_gain (gain_adjustment.get_value()), this);
629 GainMeter::effective_gain_display ()
631 gfloat value = gain_to_slider_position (_io->effective_gain());
633 if (gain_adjustment.get_value() != value) {
634 ignore_toggle = true;
635 gain_adjustment.set_value (value);
636 ignore_toggle = false;
641 GainMeter::gain_changed (void *src)
643 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeter::effective_gain_display));
647 GainMeter::set_meter_strip_name (const char * name)
649 meter_metric_area.set_name (name);
650 style_changed = true;
654 GainMeter::set_fader_name (const char * name)
656 gain_slider->set_name (name);
660 GainMeter::update_gain_sensitive ()
662 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (!(_io->gain_automation_state() & Play));
667 next_meter_point (MeterPoint mp)
671 return MeterPreFader;
675 return MeterPostFader;
687 GainMeter::meter_press(GdkEventButton* ev)
691 wait_for_release = false;
693 if ((_route = dynamic_cast<Route*>(_io.get())) == 0) {
697 if (!ignore_toggle) {
699 if (Keyboard::is_context_menu_event (ev)) {
701 // no menu at this time.
705 if (ev->button == 2) {
707 // ctrl-button2 click is the midi binding click
708 // button2-click is "momentary"
710 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control))) {
711 wait_for_release = true;
712 old_meter_point = _route->meter_point ();
716 if (ev->button == 1 || ev->button == 2) {
718 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control|Keyboard::Shift))) {
720 /* ctrl-shift-click applies change to all routes */
722 _session.begin_reversible_command (_("meter point change"));
723 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
724 _session.foreach_route (this, &GainMeter::set_meter_point, next_meter_point (_route->meter_point()));
726 _session.add_command (cmd);
727 _session.commit_reversible_command ();
730 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
732 /* ctrl-click: solo mix group.
733 ctrl-button2 is MIDI learn.
736 if (ev->button == 1) {
737 _session.begin_reversible_command (_("meter point change"));
738 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
739 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
741 _session.add_command (cmd);
742 _session.commit_reversible_command ();
747 /* click: change just this route */
751 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
762 GainMeter::meter_release(GdkEventButton* ev)
766 if (wait_for_release){
767 wait_for_release = false;
768 set_meter_point (*(dynamic_cast<Route*>(_io.get())), old_meter_point);
775 GainMeter::set_meter_point (Route& route, MeterPoint mp)
777 route.set_meter_point (mp, this);
781 GainMeter::set_mix_group_meter_point (Route& route, MeterPoint mp)
783 RouteGroup* mix_group;
785 if((mix_group = route.mix_group()) != 0){
786 mix_group->apply (&Route::set_meter_point, mp, this);
788 route.set_meter_point (mp, this);
793 GainMeter::meter_point_clicked ()
797 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
803 GainMeter::start_gain_touch (GdkEventButton* ev)
805 _io->start_gain_touch ();
810 GainMeter::end_gain_touch (GdkEventButton* ev)
812 _io->end_gain_touch ();
817 GainMeter::gain_automation_state_button_event (GdkEventButton *ev)
819 if (ev->type == GDK_BUTTON_RELEASE) {
823 switch (ev->button) {
825 gain_astate_menu.popup (1, ev->time);
835 GainMeter::gain_automation_style_button_event (GdkEventButton *ev)
837 if (ev->type == GDK_BUTTON_RELEASE) {
841 switch (ev->button) {
843 gain_astyle_menu.popup (1, ev->time);
852 GainMeter::astate_string (AutoState state)
854 return _astate_string (state, false);
858 GainMeter::short_astate_string (AutoState state)
860 return _astate_string (state, true);
864 GainMeter::_astate_string (AutoState state, bool shrt)
870 sstr = (shrt ? "M" : _("M"));
873 sstr = (shrt ? "P" : _("P"));
876 sstr = (shrt ? "T" : _("T"));
879 sstr = (shrt ? "W" : _("W"));
887 GainMeter::astyle_string (AutoStyle style)
889 return _astyle_string (style, false);
893 GainMeter::short_astyle_string (AutoStyle style)
895 return _astyle_string (style, true);
899 GainMeter::_astyle_string (AutoStyle style, bool shrt)
904 /* XXX it might different in different languages */
906 return (shrt ? _("Abs") : _("Abs"));
911 GainMeter::gain_automation_style_changed ()
913 // Route* _route = dynamic_cast<Route*>(&_io);
916 gain_automation_style_button.set_label (astyle_string(_io->gain_automation_curve().automation_style()));
919 gain_automation_style_button.set_label (short_astyle_string(_io->gain_automation_curve().automation_style()));
925 GainMeter::gain_automation_state_changed ()
927 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeter::gain_automation_state_changed));
928 //Route* _route = dynamic_cast<Route*>(&_io);
934 gain_automation_state_button.set_label (astate_string(_io->gain_automation_curve().automation_state()));
937 gain_automation_state_button.set_label (short_astate_string(_io->gain_automation_curve().automation_state()));
941 x = (_io->gain_automation_state() != Off);
943 if (gain_automation_state_button.get_active() != x) {
944 ignore_toggle = true;
945 gain_automation_state_button.set_active (x);
946 ignore_toggle = false;
949 update_gain_sensitive ();
951 /* start watching automation so that things move */
953 gain_watching.disconnect();
956 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeter::effective_gain_display));