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> GainMeter::ResetAllPeakDisplays;
61 sigc::signal<void,RouteGroup*> GainMeter::ResetGroupPeakDisplays;
62 Glib::RefPtr<Gdk::Pixbuf> GainMeter::slider;
63 Glib::RefPtr<Gdk::Pixbuf> GainMeter::rail;
64 map<string,Glib::RefPtr<Gdk::Pixmap> > GainMeter::metric_pixmaps;
67 GainMeter::setup_slider_pix ()
69 slider = ::get_icon ("fader_belt");
73 GainMeter::GainMeter (boost::shared_ptr<IO> io, Session& s)
77 // 0.781787 is the value needed for gain to be set to 0.
78 gain_adjustment (0.781787, 0.0, 1.0, 0.01, 0.1),
79 gain_automation_style_button (""),
80 gain_automation_state_button ("")
87 ignore_toggle = false;
89 next_release_selects = false;
92 gain_slider = manage (new VSliderController (slider,
94 *_io->gain_control().get(),
97 gain_slider->signal_button_press_event().connect (mem_fun(*this, &GainMeter::start_gain_touch));
98 gain_slider->signal_button_release_event().connect (mem_fun(*this, &GainMeter::end_gain_touch));
99 gain_slider->set_name ("GainFader");
101 gain_display.set_name ("MixerStripGainDisplay");
102 gain_display.set_has_frame (false);
103 set_size_request_to_display_given_text (gain_display, "-80.g", 2, 6); /* note the descender */
104 gain_display.signal_activate().connect (mem_fun (*this, &GainMeter::gain_activated));
105 gain_display.signal_focus_in_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
106 gain_display.signal_focus_out_event().connect (mem_fun (*this, &GainMeter::gain_focused), false);
108 gain_display_box.set_name ("MeterMetricsStrip");
109 gain_display_box.set_homogeneous (true);
110 gain_display_box.set_spacing (2);
111 gain_display_box.pack_start (gain_display, true, true);
113 peak_display.set_name ("MixerStripPeakDisplay");
114 // peak_display.set_has_frame (false);
115 // peak_display.set_editable (false);
116 set_size_request_to_display_given_text (peak_display, "-80.g", 2, 6); /* note the descender */
117 max_peak = minus_infinity();
118 peak_display.set_label (_("-inf"));
119 peak_display.unset_flags (Gtk::CAN_FOCUS);
121 meter_metric_area.set_name ("MeterMetricsStrip");
122 set_size_request_to_display_given_text (meter_metric_area, "-50", 0, 0);
124 meter_packer.set_spacing (2);
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 HBox* fader_centering_box = manage (new HBox);
139 fader_centering_box->pack_start (*gain_slider, true, false);
141 fader_vbox = manage (new Gtk::VBox());
142 fader_vbox->set_spacing (0);
143 fader_vbox->pack_start (*fader_centering_box, false, false, 0);
145 hbox.set_spacing (2);
147 if (_io->default_type() == ARDOUR::DataType::AUDIO) {
148 hbox.pack_start (*fader_vbox, true, true);
155 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
158 if we have a route (ie. we're not the click),
159 pack some route-dependent stuff.
162 gain_display_box.pack_end (peak_display, true, true);
164 hbox.pack_end (meter_packer, true, true);
166 using namespace Menu_Helpers;
168 gain_astate_menu.items().push_back (MenuElem (_("Manual"),
169 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
170 Parameter(GainAutomation), (AutoState) Off)));
171 gain_astate_menu.items().push_back (MenuElem (_("Play"),
172 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
173 Parameter(GainAutomation), (AutoState) Play)));
174 gain_astate_menu.items().push_back (MenuElem (_("Write"),
175 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
176 Parameter(GainAutomation), (AutoState) Write)));
177 gain_astate_menu.items().push_back (MenuElem (_("Touch"),
178 bind (mem_fun (*_io, &IO::set_parameter_automation_state),
179 Parameter(GainAutomation), (AutoState) Touch)));
181 gain_astyle_menu.items().push_back (MenuElem (_("Trim")));
182 gain_astyle_menu.items().push_back (MenuElem (_("Abs")));
184 gain_astate_menu.set_name ("ArdourContextMenu");
185 gain_astyle_menu.set_name ("ArdourContextMenu");
187 gain_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_style_button_event), false);
188 gain_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &GainMeter::gain_automation_state_button_event), false);
190 r->gain_control()->list()->automation_state_changed.connect (mem_fun(*this, &GainMeter::gain_automation_state_changed));
191 r->gain_control()->list()->automation_style_changed.connect (mem_fun(*this, &GainMeter::gain_automation_style_changed));
192 fader_vbox->pack_start (gain_automation_state_button, false, false, 0);
194 gain_automation_state_changed ();
199 pack_start (gain_display_box, Gtk::PACK_SHRINK);
200 pack_start (hbox, Gtk::PACK_SHRINK);
202 _io->gain_control()->Changed.connect (mem_fun(*this, &GainMeter::gain_changed));
204 meter_metric_area.signal_expose_event().connect (mem_fun(*this, &GainMeter::meter_metrics_expose));
205 gain_adjustment.signal_value_changed().connect (mem_fun(*this, &GainMeter::gain_adjusted));
206 peak_display.signal_button_release_event().connect (mem_fun(*this, &GainMeter::peak_button_release), false);
207 gain_display.signal_key_press_event().connect (mem_fun(*this, &GainMeter::gain_key_press), false);
209 Config->ParameterChanged.connect (mem_fun (*this, &GainMeter::parameter_changed));
214 update_gain_sensitive ();
216 ResetAllPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_peak_display));
217 ResetGroupPeakDisplays.connect (mem_fun(*this, &GainMeter::reset_group_peak_display));
219 UI::instance()->theme_changed.connect (mem_fun(*this, &GainMeter::on_theme_changed));
223 GainMeter::set_width (Width w)
238 Glib::RefPtr<Gdk::Pixmap>
239 GainMeter::render_metrics (Gtk::Widget& w)
241 //cerr << "GainMeter::render_metrics() called, red = " << w.get_style()->get_bg(Gtk::STATE_NORMAL).get_red() << endl;//DEBUG
242 Glib::RefPtr<Gdk::Window> win (w.get_window());
243 Glib::RefPtr<Gdk::GC> fg_gc (w.get_style()->get_fg_gc (Gtk::STATE_NORMAL));
244 Glib::RefPtr<Gdk::GC> bg_gc (w.get_style()->get_bg_gc (Gtk::STATE_NORMAL));
246 int db_points[] = { -50, -40, -20, -30, -10, -3, 0, 4 };
249 win->get_size (width, height);
251 Glib::RefPtr<Gdk::Pixmap> pixmap = Gdk::Pixmap::create (win, width, height);
253 metric_pixmaps[w.get_name()] = pixmap;
255 pixmap->draw_rectangle (bg_gc, true, 0, 0, width, height);
257 Glib::RefPtr<Pango::Layout> layout = w.create_pango_layout("");
259 for (uint32_t i = 0; i < sizeof (db_points)/sizeof (db_points[0]); ++i) {
261 float fraction = log_meter (db_points[i]);
262 gint pos = height - (gint) floor (height * fraction);
264 snprintf (buf, sizeof (buf), "%d", abs (db_points[i]));
266 layout->set_text (buf);
268 /* we want logical extents, not ink extents here */
271 layout->get_pixel_size (width, height);
273 pixmap->draw_line (fg_gc, 0, pos, 4, pos);
274 pixmap->draw_layout (fg_gc, 6, pos - (height/2), layout);
281 GainMeter::meter_metrics_expose (GdkEventExpose *ev)
283 /* Only draw dB scale if we're metering audio */
284 if (_io->n_inputs().n_audio() + _io->n_outputs().n_audio() == 0)
287 static Glib::RefPtr<Gtk::Style> meter_style;
290 meter_style = meter_metric_area.get_style();
293 Glib::RefPtr<Gdk::Window> win (meter_metric_area.get_window());
294 Glib::RefPtr<Gdk::GC> fg_gc (meter_style->get_fg_gc (Gtk::STATE_NORMAL));
295 Glib::RefPtr<Gdk::GC> bg_gc (meter_style->get_bg_gc (Gtk::STATE_NORMAL));
297 GdkRectangle base_rect;
298 GdkRectangle draw_rect;
301 win->get_size (width, height);
303 base_rect.width = width;
304 base_rect.height = height;
308 Glib::RefPtr<Gdk::Pixmap> pixmap;
309 std::map<string,Glib::RefPtr<Gdk::Pixmap> >::iterator i = metric_pixmaps.find (meter_metric_area.get_name());
311 if (i == metric_pixmaps.end() || style_changed) {
312 pixmap = render_metrics (meter_metric_area);
317 gdk_rectangle_intersect (&ev->area, &base_rect, &draw_rect);
318 win->draw_rectangle (bg_gc, true, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
319 win->draw_drawable (fg_gc, pixmap, draw_rect.x, draw_rect.y, draw_rect.x, draw_rect.y, draw_rect.width, draw_rect.height);
321 style_changed = false;
326 GainMeter::on_theme_changed()
328 style_changed = true;
331 GainMeter::~GainMeter ()
337 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); i++) {
345 GainMeter::update_meters ()
347 vector<MeterInfo>::iterator i;
352 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
354 peak = _io->peak_meter().peak_power (n);
356 (*i).meter->set (log_meter (peak));
358 mpeak = _io->peak_meter().max_peak_power(n);
360 if (mpeak > max_peak) {
362 /* set peak display */
363 if (max_peak <= -200.0f) {
364 peak_display.set_label (_("-inf"));
366 snprintf (buf, sizeof(buf), "%.1f", max_peak);
367 peak_display.set_label (buf);
370 if (max_peak >= 0.0f) {
371 peak_display.set_name ("MixerStripPeakDisplayPeak");
379 GainMeter::parameter_changed(const char* parameter_name)
381 #define PARAM_IS(x) (!strcmp (parameter_name, (x)))
383 ENSURE_GUI_THREAD (bind (mem_fun(*this, &GainMeter::parameter_changed), parameter_name));
385 if (PARAM_IS ("meter-hold")) {
387 vector<MeterInfo>::iterator i;
390 for (n = 0, i = meters.begin(); i != meters.end(); ++i, ++n) {
392 (*i).meter->set_hold_count ((uint32_t) floor(Config->get_meter_hold()));
400 GainMeter::hide_all_meters ()
402 bool remove_metric_area = false;
404 for (vector<MeterInfo>::iterator i = meters.begin(); i != meters.end(); ++i) {
406 remove_metric_area = true;
407 meter_packer.remove (*((*i).meter));
412 if (remove_metric_area) {
413 if (meter_metric_area.get_parent()) {
414 meter_packer.remove (meter_metric_area);
420 GainMeter::setup_meters ()
422 uint32_t nmeters = _io->n_outputs().n_total();
429 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
431 switch (r->meter_point()) {
433 nmeters = r->n_inputs().n_total();
436 nmeters = r->pre_fader_streams().n_total();
439 nmeters = r->n_outputs().n_total();
445 nmeters = _io->n_outputs().n_total();
454 width = regular_meter_width;
456 width = thin_meter_width;
459 while (meters.size() < nmeters) {
460 meters.push_back (MeterInfo());
463 /* pack them backwards */
465 if (_width == Wide) {
466 meter_packer.pack_end (meter_metric_area, false, false);
467 meter_metric_area.show_all ();
470 for (int32_t n = nmeters-1; nmeters && n >= 0 ; --n) {
471 if (meters[n].width != width) {
472 delete meters[n].meter;
473 meters[n].meter = new FastMeter ((uint32_t) floor (Config->get_meter_hold()), width, FastMeter::Vertical);
474 meters[n].width = width;
476 meters[n].meter->add_events (Gdk::BUTTON_RELEASE_MASK);
477 meters[n].meter->signal_button_release_event().connect (bind (mem_fun(*this, &GainMeter::meter_button_release), n));
480 meter_packer.pack_end (*meters[n].meter, false, false);
481 meters[n].meter->show_all ();
482 meters[n].packed = true;
487 GainMeter::get_gm_width ()
489 Gtk::Requisition sz = hbox.size_request ();
494 GainMeter::gain_key_press (GdkEventKey* ev)
496 if (key_is_legal_for_numeric_entry (ev->keyval)) {
497 /* drop through to normal handling */
500 /* illegal key for gain entry */
505 GainMeter::peak_button_release (GdkEventButton* ev)
507 /* reset peak label */
509 if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control|Keyboard::Shift)) {
510 ResetAllPeakDisplays ();
511 } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
513 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
514 ResetGroupPeakDisplays (r->mix_group());
517 reset_peak_display ();
524 GainMeter::reset_peak_display ()
527 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
528 r->peak_meter().reset_max();
531 max_peak = -INFINITY;
532 peak_display.set_label (_("-Inf"));
533 peak_display.set_name ("MixerStripPeakDisplay");
537 GainMeter::reset_group_peak_display (RouteGroup* group)
540 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
541 if (group == r->mix_group()) {
542 reset_peak_display ();
548 GainMeter::meter_button_release (GdkEventButton* ev, uint32_t which)
550 switch (ev->button) {
552 meters[which].meter->clear();
553 max_peak = minus_infinity();
554 peak_display.set_label (_("-inf"));
555 peak_display.set_name ("MixerStripPeakDisplay");
559 // popup_meter_menu (ev);
567 GainMeter::popup_meter_menu (GdkEventButton *ev)
569 using namespace Menu_Helpers;
571 if (meter_menu == 0) {
572 meter_menu = new Gtk::Menu;
573 MenuList& items = meter_menu->items();
575 items.push_back (MenuElem ("-inf .. +0dBFS"));
576 items.push_back (MenuElem ("-10dB .. +0dBFS"));
577 items.push_back (MenuElem ("-4 .. +0dBFS"));
578 items.push_back (SeparatorElem());
579 items.push_back (MenuElem ("-inf .. -2dBFS"));
580 items.push_back (MenuElem ("-10dB .. -2dBFS"));
581 items.push_back (MenuElem ("-4 .. -2dBFS"));
584 meter_menu->popup (1, ev->time);
588 GainMeter::gain_focused (GdkEventFocus* ev)
591 gain_display.select_region (0, -1);
593 gain_display.select_region (0, 0);
599 GainMeter::gain_activated ()
603 if (sscanf (gain_display.get_text().c_str(), "%f", &f) == 1) {
605 /* clamp to displayable values */
609 _io->gain_control()->set_value (dB_to_coefficient(f));
611 if (gain_display.has_focus()) {
612 PublicEditor::instance().reset_focus();
618 GainMeter::show_gain ()
622 float v = gain_adjustment.get_value();
625 strcpy (buf, _("-inf"));
627 snprintf (buf, 32, "%.1f", coefficient_to_dB (slider_position_to_gain (v)));
630 gain_display.set_text (buf);
634 GainMeter::gain_adjusted ()
636 if (!ignore_toggle) {
637 _io->gain_control()->set_value (slider_position_to_gain (gain_adjustment.get_value()));
643 GainMeter::effective_gain_display ()
645 gfloat value = gain_to_slider_position (_io->effective_gain());
647 if (gain_adjustment.get_value() != value) {
648 ignore_toggle = true;
649 gain_adjustment.set_value (value);
650 ignore_toggle = false;
655 GainMeter::gain_changed ()
657 Gtkmm2ext::UI::instance()->call_slot (mem_fun(*this, &GainMeter::effective_gain_display));
661 GainMeter::set_meter_strip_name (const char * name)
663 meter_metric_area.set_name (name);
667 GainMeter::set_fader_name (const char * name)
669 gain_slider->set_name (name);
673 GainMeter::update_gain_sensitive ()
675 static_cast<Gtkmm2ext::SliderController*>(gain_slider)->set_sensitive (!(_io->gain_control()->list()->automation_state() & Play));
680 next_meter_point (MeterPoint mp)
684 return MeterPreFader;
688 return MeterPostFader;
700 GainMeter::meter_press(GdkEventButton* ev)
704 wait_for_release = false;
706 if ((_route = dynamic_cast<Route*>(_io.get())) == 0) {
710 if (!ignore_toggle) {
712 if (Keyboard::is_context_menu_event (ev)) {
714 // no menu at this time.
718 if (ev->button == 2) {
720 // ctrl-button2 click is the midi binding click
721 // button2-click is "momentary"
723 if (!Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control))) {
724 wait_for_release = true;
725 old_meter_point = _route->meter_point ();
729 if (ev->button == 1 || ev->button == 2) {
731 if (Keyboard::modifier_state_equals (ev->state, Keyboard::ModifierMask (Keyboard::Control|Keyboard::Shift))) {
733 /* ctrl-shift-click applies change to all routes */
735 _session.begin_reversible_command (_("meter point change"));
736 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
737 _session.foreach_route (this, &GainMeter::set_meter_point, next_meter_point (_route->meter_point()));
739 _session.add_command (cmd);
740 _session.commit_reversible_command ();
743 } else if (Keyboard::modifier_state_equals (ev->state, Keyboard::Control)) {
745 /* ctrl-click: solo mix group.
746 ctrl-button2 is MIDI learn.
749 if (ev->button == 1) {
750 _session.begin_reversible_command (_("meter point change"));
751 Session::GlobalMeteringStateCommand *cmd = new Session::GlobalMeteringStateCommand (_session, this);
752 set_mix_group_meter_point (*_route, next_meter_point (_route->meter_point()));
754 _session.add_command (cmd);
755 _session.commit_reversible_command ();
760 /* click: change just this route */
764 _route->set_meter_point (next_meter_point (_route->meter_point()), this);
775 GainMeter::meter_release(GdkEventButton* ev)
779 if (wait_for_release){
780 wait_for_release = false;
781 set_meter_point (*(dynamic_cast<Route*>(_io.get())), old_meter_point);
788 GainMeter::set_meter_point (Route& route, MeterPoint mp)
790 route.set_meter_point (mp, this);
794 GainMeter::set_mix_group_meter_point (Route& route, MeterPoint mp)
796 RouteGroup* mix_group;
798 if((mix_group = route.mix_group()) != 0){
799 mix_group->apply (&Route::set_meter_point, mp, this);
801 route.set_meter_point (mp, this);
806 GainMeter::meter_point_clicked ()
810 if ((r = dynamic_cast<Route*> (_io.get())) != 0) {
816 GainMeter::start_gain_touch (GdkEventButton* ev)
818 _io->gain_control()->list()->start_touch ();
823 GainMeter::end_gain_touch (GdkEventButton* ev)
825 _io->gain_control()->list()->stop_touch ();
830 GainMeter::gain_automation_state_button_event (GdkEventButton *ev)
832 if (ev->type == GDK_BUTTON_RELEASE) {
836 switch (ev->button) {
838 gain_astate_menu.popup (1, ev->time);
848 GainMeter::gain_automation_style_button_event (GdkEventButton *ev)
850 if (ev->type == GDK_BUTTON_RELEASE) {
854 switch (ev->button) {
856 gain_astyle_menu.popup (1, ev->time);
865 GainMeter::astate_string (AutoState state)
867 return _astate_string (state, false);
871 GainMeter::short_astate_string (AutoState state)
873 return _astate_string (state, true);
877 GainMeter::_astate_string (AutoState state, bool shrt)
883 sstr = (shrt ? "M" : _("M"));
886 sstr = (shrt ? "P" : _("P"));
889 sstr = (shrt ? "T" : _("T"));
892 sstr = (shrt ? "W" : _("W"));
900 GainMeter::astyle_string (AutoStyle style)
902 return _astyle_string (style, false);
906 GainMeter::short_astyle_string (AutoStyle style)
908 return _astyle_string (style, true);
912 GainMeter::_astyle_string (AutoStyle style, bool shrt)
917 /* XXX it might different in different languages */
919 return (shrt ? _("Abs") : _("Abs"));
924 GainMeter::gain_automation_style_changed ()
926 // Route* _route = dynamic_cast<Route*>(&_io);
929 gain_automation_style_button.set_label (astyle_string(_io->gain_control()->list()->automation_style()));
932 gain_automation_style_button.set_label (short_astyle_string(_io->gain_control()->list()->automation_style()));
938 GainMeter::gain_automation_state_changed ()
940 ENSURE_GUI_THREAD(mem_fun(*this, &GainMeter::gain_automation_state_changed));
941 //Route* _route = dynamic_cast<Route*>(&_io);
947 gain_automation_state_button.set_label (astate_string(_io->gain_control()->list()->automation_state()));
950 gain_automation_state_button.set_label (short_astate_string(_io->gain_control()->list()->automation_state()));
954 x = (_io->gain_control()->list()->automation_state() != Off);
956 if (gain_automation_state_button.get_active() != x) {
957 ignore_toggle = true;
958 gain_automation_state_button.set_active (x);
959 ignore_toggle = false;
962 update_gain_sensitive ();
964 /* start watching automation so that things move */
966 gain_watching.disconnect();
969 gain_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &GainMeter::effective_gain_display));