add convenience functions to switch meter-types.. (maybe too much?!)
[ardour.git] / gtk2_ardour / meter_strip.cc
1 /*
2     Copyright (C) 2013 Paul Davis
3     Author: Robin Gareus
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <list>
21
22 #include <sigc++/bind.h>
23
24 #include "ardour/session.h"
25 #include "ardour/route.h"
26 #include "ardour/route_group.h"
27 #include "ardour/meter.h"
28
29 #include "ardour/audio_track.h"
30 #include "ardour/midi_track.h"
31
32 #include <gtkmm2ext/gtk_ui.h>
33 #include <gtkmm2ext/keyboard.h>
34 #include <gtkmm2ext/utils.h>
35 #include <gtkmm2ext/rgb_macros.h>
36
37 #include "ardour_ui.h"
38 #include "global_signals.h"
39 #include "logmeter.h"
40 #include "gui_thread.h"
41 #include "ardour_window.h"
42 #include "utils.h"
43
44 #include "meterbridge.h"
45 #include "meter_strip.h"
46 #include "meter_patterns.h"
47
48 #include "i18n.h"
49
50 using namespace ARDOUR;
51 using namespace PBD;
52 using namespace Gtk;
53 using namespace Gtkmm2ext;
54 using namespace std;
55
56 PBD::Signal1<void,MeterStrip*> MeterStrip::CatchDeletion;
57 PBD::Signal0<void> MeterStrip::MetricChanged;
58
59 MeterStrip::MeterStrip (int metricmode)
60         : AxisView(0)
61         , RouteUI(0)
62 {
63         level_meter = 0;
64         _strip_type = 0;
65         set_spacing(2);
66         peakbx.set_size_request(-1, 14);
67         btnbox.set_size_request(-1, 16);
68         namebx.set_size_request(18, 52);
69
70         set_metric_mode(metricmode);
71
72         set_size_request_to_display_given_text (meter_metric_area, "-8888", 1, 0);
73         meter_metric_area.signal_expose_event().connect (
74                         sigc::mem_fun(*this, &MeterStrip::meter_metrics_expose));
75         RedrawMetrics.connect (sigc::mem_fun(*this, &MeterStrip::redraw_metrics));
76
77         meterbox.pack_start(meter_metric_area, true, false);
78
79         pack_start (peakbx, false, false);
80         pack_start (meterbox, true, true);
81         pack_start (btnbox, false, false);
82         pack_start (namebx, false, false);
83
84         peakbx.show();
85         btnbox.show();
86         meter_metric_area.show();
87         meterbox.show();
88         namebx.show();
89
90         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &MeterStrip::on_theme_changed));
91         ColorsChanged.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
92         DPIReset.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
93 }
94
95 MeterStrip::MeterStrip (Session* sess, boost::shared_ptr<ARDOUR::Route> rt)
96         : AxisView(sess)
97         , RouteUI(sess)
98         , _route(rt)
99         , peak_display()
100 {
101         set_spacing(2);
102         RouteUI::set_route (rt);
103
104         _has_midi = false;
105
106         int meter_width = 6;
107         if (_route->shared_peak_meter()->input_streams().n_total() == 1) {
108                 meter_width = 12;
109         }
110
111         // level meter + ticks
112         level_meter = new LevelMeter(sess);
113         level_meter->set_meter (_route->shared_peak_meter().get());
114         level_meter->clear_meters();
115         level_meter->setup_meters (220, meter_width, 6);
116         level_meter->set_type (_route->meter_type());
117         level_meter->ButtonPress.connect_same_thread (level_meter_connection, boost::bind (&MeterStrip::level_meter_button_press, this, _1));
118         level_meter->MeterTypeChanged.connect_same_thread (level_meter_connection, boost::bind (&MeterStrip::meter_type_changed, this, _1));
119
120         meter_align.set(0.5, 0.5, 0.0, 1.0);
121         meter_align.add(*level_meter);
122
123         meterbox.pack_start(meter_ticks1_area, true, false);
124         meterbox.pack_start(meter_align, true, true);
125         meterbox.pack_start(meter_ticks2_area, true, false);
126
127         // peak display
128         peak_display.set_name ("meterbridge peakindicator");
129         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
130         max_peak = minus_infinity();
131         peak_display.unset_flags (Gtk::CAN_FOCUS);
132         peak_display.set_size_request(12, 8);
133         peak_display.set_corner_radius(2);
134
135         peak_align.set(0.5, 1.0, 1.0, 0.8);
136         peak_align.add(peak_display);
137         peakbx.pack_start(peak_align, true, true, 3);
138         peakbx.set_size_request(-1, 14);
139
140         // add track-name label
141         name_label.set_text(_route->name().c_str());
142         name_label.set_corner_radius(2);
143         name_label.set_name("meterbridge label");
144         name_label.set_angle(-90.0);
145         name_label.layout()->set_ellipsize (Pango::ELLIPSIZE_END);
146         name_label.layout()->set_width(48 * PANGO_SCALE);
147         name_label.set_size_request(18, 50);
148         name_label.set_alignment(-1.0, .5);
149
150         namebx.set_size_request(18, 52);
151         namebx.pack_start(name_label, true, false, 3);
152
153         // rec-enable button
154         btnbox.pack_start(*rec_enable_button, true, false);
155         rec_enable_button->set_corner_radius(2);
156         btnbox.set_size_request(-1, 16);
157
158         pack_start (peakbx, false, false);
159         pack_start (meterbox, true, true);
160         pack_start (btnbox, false, false);
161         pack_start (namebx, false, false);
162
163         peak_display.show();
164         peakbx.show();
165         meter_ticks1_area.show();
166         meter_ticks2_area.show();
167         meterbox.show();
168         level_meter->show();
169         meter_align.show();
170         peak_align.show();
171         btnbox.show();
172         name_label.show();
173         namebx.show();
174
175         _route->shared_peak_meter()->ConfigurationChanged.connect (
176                         route_connections, invalidator (*this), boost::bind (&MeterStrip::meter_configuration_changed, this, _1), gui_context()
177                         );
178
179         ResetAllPeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_peak_display));
180         ResetRoutePeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_route_peak_display));
181         ResetGroupPeakDisplays.connect (sigc::mem_fun(*this, &MeterStrip::reset_group_peak_display));
182         RedrawMetrics.connect (sigc::mem_fun(*this, &MeterStrip::redraw_metrics));
183         SetMeterTypeMulti.connect (sigc::mem_fun(*this, &MeterStrip::set_meter_type_multi));
184
185         meter_configuration_changed (_route->shared_peak_meter()->input_streams ());
186
187         meter_ticks1_area.set_size_request(3,-1);
188         meter_ticks2_area.set_size_request(3,-1);
189         meter_ticks1_area.signal_expose_event().connect (sigc::mem_fun(*this, &MeterStrip::meter_ticks1_expose));
190         meter_ticks2_area.signal_expose_event().connect (sigc::mem_fun(*this, &MeterStrip::meter_ticks2_expose));
191
192         _route->DropReferences.connect (route_connections, invalidator (*this), boost::bind (&MeterStrip::self_delete, this), gui_context());
193         _route->PropertyChanged.connect (route_connections, invalidator (*this), boost::bind (&MeterStrip::strip_property_changed, this, _1), gui_context());
194
195         peak_display.signal_button_release_event().connect (sigc::mem_fun(*this, &MeterStrip::peak_button_release), false);
196
197         UI::instance()->theme_changed.connect (sigc::mem_fun(*this, &MeterStrip::on_theme_changed));
198         ColorsChanged.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
199         DPIReset.connect (sigc::mem_fun (*this, &MeterStrip::on_theme_changed));
200         Config->ParameterChanged.connect (*this, invalidator (*this), ui_bind (&MeterStrip::parameter_changed, this, _1), gui_context());
201
202         if (_route->is_master()) {
203                 _strip_type = 4;
204         }
205         else if (boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
206                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0) {
207                 /* non-master bus */
208                 _strip_type = 3;
209         }
210         else if (boost::dynamic_pointer_cast<MidiTrack>(_route)) {
211                 _strip_type = 2;
212         }
213         else {
214                 _strip_type = 1;
215         }
216 }
217
218 MeterStrip::~MeterStrip ()
219 {
220         delete level_meter;
221         CatchDeletion (this);
222 }
223
224 void
225 MeterStrip::self_delete ()
226 {
227         delete this;
228 }
229
230 void
231 MeterStrip::update_rec_display ()
232 {
233         RouteUI::update_rec_display ();
234 }
235
236 std::string
237 MeterStrip::state_id() const
238 {
239         return string_compose ("mtrs %1", _route->id().to_s());
240 }
241
242 void
243 MeterStrip::set_button_names()
244 {
245         rec_enable_button->set_text ("");
246         rec_enable_button->set_image (::get_icon (X_("record_normal_red")));
247 }
248
249 void
250 MeterStrip::strip_property_changed (const PropertyChange& what_changed)
251 {
252         if (!what_changed.contains (ARDOUR::Properties::name)) {
253                 return;
254         }
255         ENSURE_GUI_THREAD (*this, &MeterStrip::strip_name_changed, what_changed)
256         name_label.set_text(_route->name());
257 }
258
259 void
260 MeterStrip::fast_update ()
261 {
262         float mpeak = level_meter->update_meters();
263         if (mpeak > max_peak) {
264                 max_peak = mpeak;
265                 if (mpeak >= Config->get_meter_peak()) {
266                         peak_display.set_name ("meterbridge peakindicator on");
267                         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
268                 }
269         }
270 }
271
272 void
273 MeterStrip::on_theme_changed()
274 {
275         if (level_meter && _route) {
276                 int meter_width = 6;
277                 if (_route->shared_peak_meter()->input_streams().n_total() == 1) {
278                         meter_width = 12;
279                 }
280                 level_meter->setup_meters (220, meter_width, 6);
281         }
282 }
283
284 void
285 MeterStrip::meter_configuration_changed (ChanCount c)
286 {
287         int type = 0;
288         _types.clear ();
289         bool old_has_midi = _has_midi;
290
291         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
292                 if (c.get (*i) > 0) {
293                         _types.push_back (*i);
294                         type |= 1 << (*i);
295                 }
296         }
297
298         // TODO draw Inactive routes or busses with different styles
299         if (boost::dynamic_pointer_cast<AudioTrack>(_route) == 0
300                         && boost::dynamic_pointer_cast<MidiTrack>(_route) == 0
301                         ) {
302                 meter_ticks1_area.set_name ("AudioBusMetricsLeft");
303                 meter_ticks2_area.set_name ("AudioBusMetricsRight");
304                 _has_midi = false;
305         }
306         else if (type == (1 << DataType::AUDIO)) {
307                 meter_ticks1_area.set_name ("AudioTrackMetricsLeft");
308                 meter_ticks2_area.set_name ("AudioTrackMetricsRight");
309                 _has_midi = false;
310         }
311         else if (type == (1 << DataType::MIDI)) {
312                 meter_ticks1_area.set_name ("MidiTrackMetricsLeft");
313                 meter_ticks2_area.set_name ("MidiTrackMetricsRight");
314                 _has_midi = true;
315         } else {
316                 meter_ticks1_area.set_name ("AudioMidiTrackMetricsLeft");
317                 meter_ticks2_area.set_name ("AudioMidiTrackMetricsRight");
318                 _has_midi = true;
319         }
320
321         if (old_has_midi != _has_midi) MetricChanged();
322         on_theme_changed();
323 }
324
325 void
326 MeterStrip::on_size_request (Gtk::Requisition* r)
327 {
328         meter_clear_pattern_cache();
329         VBox::on_size_request(r);
330 }
331
332 void
333 MeterStrip::on_size_allocate (Gtk::Allocation& a)
334 {
335         meter_clear_pattern_cache();
336         const int wh = a.get_height();
337         int nh = ceilf(wh * .11f);
338         if (nh < 52) nh = 52;
339         if (nh > 148) nh = 148;
340         namebx.set_size_request(18, nh);
341         if (_route) {
342                 name_label.set_size_request(18, nh-2);
343                 name_label.layout()->set_width((nh-4) * PANGO_SCALE);
344         }
345         VBox::on_size_allocate(a);
346 }
347
348 gint
349 MeterStrip::meter_metrics_expose (GdkEventExpose *ev)
350 {
351         return meter_expose_metrics(ev, _types, &meter_metric_area);
352 }
353
354 void
355 MeterStrip::set_metric_mode (int metricmode)
356 {
357         _types.clear ();
358         switch(metricmode) {
359                 case 0:
360                         meter_metric_area.set_name ("MidiTrackMetricsLeft");
361                         _types.push_back (DataType::MIDI);
362                         break;
363                 case 1:
364                         meter_metric_area.set_name ("AudioTrackMetricsLeft");
365                         _types.push_back (DataType::AUDIO);
366                         break;
367                 case 2:
368                         meter_metric_area.set_name ("MidiTrackMetricsRight");
369                         _types.push_back (DataType::MIDI);
370                         break;
371                 case 3:
372                 default:
373                         meter_metric_area.set_name ("AudioTrackMetricsRight");
374                         _types.push_back (DataType::AUDIO);
375                         break;
376         }
377
378         meter_metric_area.queue_draw ();
379 }
380
381 gint
382 MeterStrip::meter_ticks1_expose (GdkEventExpose *ev)
383 {
384         return meter_expose_ticks(ev, _types, &meter_ticks1_area);
385 }
386
387 gint
388 MeterStrip::meter_ticks2_expose (GdkEventExpose *ev)
389 {
390         return meter_expose_ticks(ev, _types, &meter_ticks2_area);
391 }
392
393 void
394 MeterStrip::reset_route_peak_display (Route* route)
395 {
396         if (_route && _route.get() == route) {
397                 reset_peak_display ();
398         }
399 }
400
401 void
402 MeterStrip::reset_group_peak_display (RouteGroup* group)
403 {
404         if (_route && group == _route->route_group()) {
405                 reset_peak_display ();
406         }
407 }
408
409 void
410 MeterStrip::reset_peak_display ()
411 {
412         _route->shared_peak_meter()->reset_max();
413         level_meter->clear_meters();
414         max_peak = -INFINITY;
415         peak_display.set_name ("meterbridge peakindicator");
416         peak_display.set_elements((ArdourButton::Element) (ArdourButton::Edge|ArdourButton::Body));
417 }
418
419 bool
420 MeterStrip::peak_button_release (GdkEventButton* ev)
421 {
422         if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier|Keyboard::TertiaryModifier)) {
423                 ResetAllPeakDisplays ();
424         } else if (ev->button == 1 && Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
425                 if (_route) {
426                         ResetGroupPeakDisplays (_route->route_group());
427                 }
428         } else {
429                 ResetRoutePeakDisplays (_route.get());
430         }
431         return true;
432 }
433
434 void
435 MeterStrip::redraw_metrics ()
436 {
437         meter_metric_area.queue_draw();
438         meter_ticks1_area.queue_draw();
439         meter_ticks2_area.queue_draw();
440 }
441
442 void
443 MeterStrip::parameter_changed (std::string const & p)
444 {
445         if (p == "meter-peak") {
446                 max_peak = -INFINITY;
447         }
448 }
449
450
451 bool
452 MeterStrip::level_meter_button_press (GdkEventButton* ev)
453 {
454         if (ev->button == 3) {
455                 popup_level_meter_menu (ev);
456                 return true;
457         }
458
459         return false;
460 }
461
462 void
463 MeterStrip::popup_level_meter_menu (GdkEventButton* ev)
464 {
465         using namespace Gtk::Menu_Helpers;
466
467         Gtk::Menu* m = manage (new Menu);
468         MenuList& items = m->items ();
469
470         RadioMenuItem::Group group;
471
472         _suspend_menu_callbacks = true;
473         add_level_meter_item (items, group, _("Peak"), MeterPeak);
474         add_level_meter_item (items, group, _("RMS + Peak"), MeterKrms);
475
476         items.push_back (SeparatorElem());
477         items.push_back (MenuElem (_("Change all in Group to Peak"), sigc::bind (SetMeterTypeMulti, -1, _route->route_group(), MeterPeak)));
478         items.push_back (MenuElem (_("Change all in Group to RMS + Peak"), sigc::bind (SetMeterTypeMulti, -1, _route->route_group(), MeterKrms)));
479         items.push_back (MenuElem (_("Change all to Peak"), sigc::bind (SetMeterTypeMulti, 0, _route->route_group(), MeterPeak)));
480         items.push_back (MenuElem (_("Change all to RMS + Peak"), sigc::bind (SetMeterTypeMulti, 0, _route->route_group(), MeterKrms)));
481         items.push_back (MenuElem (_("Change same track-type to Peak"), sigc::bind (SetMeterTypeMulti, _strip_type, _route->route_group(), MeterPeak)));
482         items.push_back (MenuElem (_("Change same track-type to RMS + Peak"), sigc::bind (SetMeterTypeMulti, _strip_type, _route->route_group(), MeterKrms)));
483
484         m->popup (ev->button, ev->time);
485         _suspend_menu_callbacks = false;
486 }
487
488 void
489 MeterStrip::add_level_meter_item (Menu_Helpers::MenuList& items, RadioMenuItem::Group& group, string const & name, MeterType type)
490 {
491         using namespace Menu_Helpers;
492
493         items.push_back (RadioMenuElem (group, name, sigc::bind (sigc::mem_fun (*this, &MeterStrip::set_meter_type), type)));
494         RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
495         i->set_active (_route->meter_type() == type);
496 }
497
498 void
499 MeterStrip::set_meter_type (MeterType type)
500 {
501         if (_suspend_menu_callbacks) return;
502         level_meter->set_type (type);
503 }
504
505 void
506 MeterStrip::meter_type_changed (MeterType type)
507 {
508         _route->set_meter_type(type);
509 }
510
511 void
512 MeterStrip::set_meter_type_multi (int what, RouteGroup* group, MeterType type)
513 {
514         switch (what) {
515                 case -1:
516                         if (_route && group == _route->route_group()) {
517                                 level_meter->set_type (type);
518                         }
519                         break;
520                 case 0:
521                         level_meter->set_type (type);
522                 default:
523                         if (what == _strip_type) {
524                                 level_meter->set_type (type);
525                         }
526                         break;
527         }
528 }