Correct a namespace typo
[ardour.git] / gtk2_ardour / mini_timeline.cc
1 /*
2  * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
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.
13  *
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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17  */
18
19 #include "ardour/audioengine.h"
20 #include "ardour/session.h"
21 #include "ardour/tempo.h"
22
23 #include "gtkmm2ext/gui_thread.h"
24 #include "gtkmm2ext/keyboard.h"
25
26 #include "canvas/colors.h"
27 #include "canvas/utils.h"
28
29 #include "ardour_ui.h"
30 #include "public_editor.h"
31 #include "main_clock.h"
32 #include "mini_timeline.h"
33 #include "timers.h"
34 #include "tooltips.h"
35 #include "ui_config.h"
36
37 #include "pbd/i18n.h"
38
39 #define PADDING 3
40 #define BBT_BAR_CHAR "|"
41
42 using namespace ARDOUR;
43
44 MiniTimeline::MiniTimeline ()
45         : _last_update_frame (-1)
46         , _clock_mode (AudioClock::Timecode)
47         , _time_width (0)
48         , _time_height (0)
49         , _n_labels (0)
50         , _px_per_sample (0)
51         , _time_granularity (0)
52         , _time_span_samples (0)
53         , _marker_height (0)
54         , _pointer_x (-1)
55         , _pointer_y (-1)
56         , _minitl_context_menu (0)
57 {
58         add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::POINTER_MOTION_MASK|Gdk::SCROLL_MASK);
59
60         _layout = Pango::Layout::create (get_pango_context());
61
62         UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &MiniTimeline::set_colors));
63         UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
64         UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
65
66         set_name ("minitimeline");
67
68         Location::name_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
69         Location::end_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
70         Location::start_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
71         Location::flags_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
72
73         ARDOUR_UI_UTILS::set_tooltip (*this,
74                         string_compose (_("<b>Navigation Timeline</b>. Use left-click to locate to time position or marker; scroll-wheel to jump, hold %1 for fine gained and %2 + %3 for extra-fine grained control. Right-click to set display range. The display unit is defined by the primary clock."),
75                                 Gtkmm2ext::Keyboard::primary_modifier_name(),
76                                 Gtkmm2ext::Keyboard::primary_modifier_name (),
77                                 Gtkmm2ext::Keyboard::secondary_modifier_name ()));
78 }
79
80 MiniTimeline::~MiniTimeline ()
81 {
82         delete _minitl_context_menu;
83         _minitl_context_menu = 0;
84 }
85
86 void
87 MiniTimeline::session_going_away ()
88 {
89         super_rapid_connection.disconnect ();
90         session_connection.drop_connections ();
91         SessionHandlePtr::session_going_away ();
92         _jumplist.clear ();
93         delete _minitl_context_menu;
94         _minitl_context_menu = 0;
95 }
96
97 void
98 MiniTimeline::set_session (Session* s)
99 {
100         SessionHandlePtr::set_session (s);
101         if (!s) {
102                 return;
103         }
104
105         assert (!super_rapid_connection.connected ());
106         super_rapid_connection = Timers::super_rapid_connect (
107                         sigc::mem_fun (*this, &MiniTimeline::super_rapid_update)
108                         );
109
110         _session->config.ParameterChanged.connect (session_connection,
111                         invalidator (*this),
112                         boost::bind (&MiniTimeline::parameter_changed, this, _1), gui_context()
113                         );
114         _session->locations()->added.connect (session_connection,
115                         invalidator (*this),
116                         boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
117                         );
118         _session->locations()->removed.connect (session_connection,
119                         invalidator (*this),
120                         boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
121                         );
122         _session->locations()->changed.connect (session_connection,
123                         invalidator (*this),
124                         boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
125                         );
126
127         _jumplist.clear ();
128         calculate_time_spacing ();
129         update_minitimeline ();
130 }
131
132 void
133 MiniTimeline::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
134 {
135         CairoWidget::on_style_changed (old_style);
136         set_colors ();
137         calculate_time_width ();
138 }
139
140 void
141 MiniTimeline::on_name_changed ()
142 {
143         set_colors ();
144         calculate_time_width ();
145
146         if (is_realized()) {
147                 queue_resize ();
148         }
149 }
150
151 void
152 MiniTimeline::set_colors ()
153 {
154         // TODO  UIConfiguration::instance().color & font
155 }
156
157 void
158 MiniTimeline::parameter_changed (std::string const& p)
159 {
160         if (p == "minitimeline-span") {
161                 calculate_time_spacing ();
162                 update_minitimeline ();
163         }
164 }
165
166 void
167 MiniTimeline::on_size_request (Gtk::Requisition* req)
168 {
169         req->width = req->height = 0;
170         CairoWidget::on_size_request (req);
171
172         req->width = std::max (req->width, 1);
173         req->height = std::max (req->height, 20);
174 }
175
176 void
177 MiniTimeline::on_size_allocate (Gtk::Allocation& alloc)
178 {
179         CairoWidget::on_size_allocate (alloc);
180         calculate_time_spacing ();
181 }
182
183 void
184 MiniTimeline::set_span (framecnt_t ts)
185 {
186         assert (_session);
187         if (_session->config.get_minitimeline_span () == ts) {
188                 return;
189         }
190
191         _session->config.set_minitimeline_span (ts);
192         calculate_time_spacing ();
193         update_minitimeline ();
194 }
195
196 void
197 MiniTimeline::super_rapid_update ()
198 {
199         if (!_session || !_session->engine().running() || !is_mapped ()) {
200                 return;
201         }
202         framepos_t const frame = PublicEditor::instance().playhead_cursor_sample ();
203         AudioClock::Mode m = ARDOUR_UI::instance()->primary_clock->mode();
204
205         bool change = false;
206         if (fabs ((_last_update_frame - frame) * _px_per_sample) >= 1.0) {
207                 change = true;
208         }
209
210         if (m != _clock_mode) {
211                 _clock_mode = m;
212                 calculate_time_width ();
213                 change = true;
214         }
215
216         if (_clock_mode == AudioClock::BBT) {
217                 // TODO check if tempo-map changed
218                 change = true;
219         }
220
221         if (change) {
222                 _last_update_frame = frame;
223                 update_minitimeline ();
224         }
225 }
226
227 void
228 MiniTimeline::update_minitimeline ()
229 {
230         CairoWidget::set_dirty ();
231 }
232
233 void
234 MiniTimeline::calculate_time_width ()
235 {
236         switch (_clock_mode) {
237                 case AudioClock::Timecode:
238                         _layout->set_text (" 88:88:88,888 ");
239                         break;
240                 case AudioClock::BBT:
241                         _layout->set_text ("888|88|8888");
242                         break;
243                 case AudioClock::MinSec:
244                         _layout->set_text ("88:88:88,88");
245                         break;
246                 case AudioClock::Frames:
247                         _layout->set_text ("8888888888");
248                         break;
249         }
250         _layout->get_pixel_size (_time_width, _time_height);
251 }
252
253 void
254 MiniTimeline::calculate_time_spacing ()
255 {
256         _n_labels = floor (get_width () / (_time_width * 1.15));
257
258         if (_n_labels == 0 || !_session) {
259                 return;
260         }
261
262         const framecnt_t time_span = _session->config.get_minitimeline_span () / 2;
263         _time_span_samples = time_span * _session->nominal_frame_rate ();
264         _time_granularity = _session->nominal_frame_rate () * ceil (2. * time_span / _n_labels);
265         _px_per_sample = get_width () / (2. * _time_span_samples);
266         //_px_per_sample = 1.0 / round (1.0 / _px_per_sample);
267 }
268
269 void
270 MiniTimeline::format_time (framepos_t when)
271 {
272         switch (_clock_mode) {
273                 case AudioClock::Timecode:
274                         {
275                                 Timecode::Time TC;
276                                 _session->timecode_time (when, TC);
277                                 // chop of leading space or minus.
278                                 _layout->set_text (Timecode::timecode_format_time (TC).substr(1));
279                         }
280                         break;
281                 case AudioClock::BBT:
282                         {
283                                 char buf[64];
284                                 Timecode::BBT_Time BBT = _session->tempo_map().bbt_at_frame (when);
285                                 snprintf (buf, sizeof (buf), "%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
286                                                 BBT.bars, BBT.beats, BBT.ticks);
287                                 _layout->set_text (buf);
288                         }
289                         break;
290                 case AudioClock::MinSec:
291                         {
292                                 char buf[32];
293                                 AudioClock::print_minsec (when, buf, sizeof (buf), _session->frame_rate());
294                                 _layout->set_text (std::string(buf).substr(1));
295                         }
296                         break;
297                 case AudioClock::Frames:
298                         {
299                                 char buf[32];
300                                 snprintf (buf, sizeof (buf), "%" PRId64, when);
301                                 _layout->set_text (buf);
302                         }
303                         break;
304         }
305 }
306
307 void
308 MiniTimeline::draw_dots (cairo_t* cr, int left, int right, int y, ArdourCanvas::Color color)
309 {
310         if (left + 1 >= right) {
311                 return;
312         }
313         cairo_move_to (cr, left + .5, y + .5);
314         cairo_line_to (cr, right - .5, y + .5);
315         ArdourCanvas::set_source_rgb_a(cr, color, 0.3);
316         const double dashes[] = { 0, 1 };
317         cairo_set_dash (cr, dashes, 2, 1);
318         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
319         cairo_set_line_width (cr, 1.0);
320         cairo_stroke (cr);
321         cairo_set_dash (cr, 0, 0, 0);
322 }
323
324 int
325 MiniTimeline::draw_mark (cairo_t* cr, int x0, int x1, const std::string& label, bool& prelight)
326 {
327         int h = _marker_height;
328         /* ArdourMarker shape
329          * MH = 13
330          *
331          * Mark:
332          *
333          *  (0,0)   --  (6,0)
334          *    |           |
335          *    |           |
336          * (0,MH*.4)  (6,MH*.4)
337          *     \         /
338          *        (3,MH)
339          */
340
341         const int y = PADDING;
342         int w2 = (h - 1) / 4;
343         double h0 = h * .4;
344         double h1 = h - h0;
345
346         int lw, lh;
347         _layout->set_text (label);
348         _layout->get_pixel_size (lw, lh);
349         int rw = std::min (x1, x0 + w2 + lw + 2);
350
351         if (_pointer_y >= 0 && _pointer_y <= y + h && _pointer_x >= x0 && _pointer_x <= rw) {
352                 prelight = true;
353         }
354
355         // TODO cache in set_colors()
356         uint32_t color = UIConfiguration::instance().color (
357                         prelight ? "entered marker" : "location marker");
358
359         double r, g, b, a;
360         ArdourCanvas::color_to_rgba (color, r, g, b, a);
361
362         if (rw < x0) {
363                 rw = x1;
364         } else {
365                 cairo_save (cr);
366                 cairo_rectangle (cr, x0, y, rw - x0, h);
367                 cairo_set_source_rgba (cr, r, g, b, 0.5); // this should use a shaded color
368                 cairo_fill_preserve (cr);
369                 cairo_clip (cr);
370
371                 // marker label
372                 cairo_move_to (cr, x0 + w2, y + .5 * (h - lh));
373                 cairo_set_source_rgb (cr, 0, 0, 0);
374                 pango_cairo_show_layout (cr, _layout->gobj());
375                 cairo_restore (cr);
376         }
377
378         // draw marker on top
379         cairo_move_to (cr, x0 - .5, y + .5);
380         cairo_rel_line_to (cr, -w2 , 0 );
381         cairo_rel_line_to (cr, 0, h0);
382         cairo_rel_line_to (cr, w2, h1);
383         cairo_rel_line_to (cr, w2, -h1);
384         cairo_rel_line_to (cr, 0, -h0);
385         cairo_close_path (cr);
386         cairo_set_source_rgba (cr, r, g, b, 1.0);
387         cairo_set_line_width (cr, 1.0);
388         cairo_stroke_preserve (cr);
389         cairo_fill (cr);
390
391         return rw;
392 }
393
394 struct LocationMarker {
395         LocationMarker (const std::string& l, framepos_t w)
396                 : label (l), when (w) {}
397         std::string label;
398         framepos_t  when;
399 };
400
401 struct LocationMarkerSort {
402         bool operator() (const LocationMarker& a, const LocationMarker& b) {
403                 return (a.when < b.when);
404         }
405 };
406
407 void
408 MiniTimeline::render (cairo_t* cr, cairo_rectangle_t*)
409 {
410         // TODO cache, set_colors()
411         ArdourCanvas::Color base = UIConfiguration::instance().color ("ruler base");
412         ArdourCanvas::Color text = UIConfiguration::instance().color ("ruler text");
413
414         if (_n_labels == 0) {
415                 return;
416         }
417
418         Gtkmm2ext::rounded_rectangle (cr, 0, 0, get_width(), get_height(), 4);
419         ArdourCanvas::set_source_rgba(cr, base);
420         cairo_fill (cr);
421
422         Gtkmm2ext::rounded_rectangle (cr, PADDING, PADDING, get_width() - PADDING - PADDING, get_height() - PADDING - PADDING, 4);
423         cairo_clip (cr);
424
425         if (_session == 0) {
426                 return;
427         }
428
429
430         /* time */
431         const framepos_t p = _last_update_frame;
432         const framepos_t lower = (std::max ((framepos_t)0, (p - _time_span_samples)) / _time_granularity) * _time_granularity;
433
434         int dot_left = get_width() * .5 + (lower - p) * _px_per_sample;
435         for (int i = 0; i < 2 + _n_labels; ++i) {
436                 framepos_t when = lower + i * _time_granularity;
437                 double xpos = get_width() * .5 + (when - p) * _px_per_sample;
438
439                 // TODO round to nearest display TC in +/- 1px
440                 // prefer to display BBT |0  or .0
441
442                 int lw, lh;
443                 format_time (when);
444                 _layout->get_pixel_size (lw, lh);
445
446                 int x0 = xpos - lw / 2.0;
447                 int y0 = get_height() - PADDING - _time_height;
448
449                 draw_dots (cr, dot_left, x0, y0 + _time_height * .5, text);
450
451                 cairo_move_to (cr, x0, y0);
452                 ArdourCanvas::set_source_rgba(cr, text);
453                 pango_cairo_show_layout (cr, _layout->gobj());
454                 dot_left = x0 + lw;
455         }
456         draw_dots (cr, dot_left, get_width(), get_height() - PADDING - _time_height * .5, text);
457
458         /* locations */
459         framepos_t lmin = std::max ((framepos_t)0, (p - _time_span_samples));
460         framepos_t lmax = p + _time_span_samples;
461
462         int tw, th;
463         _layout->set_text (X_("Marker@"));
464         _layout->get_pixel_size (tw, th);
465
466         _marker_height = th + 2;
467         assert (_marker_height > 4);
468         const int mw = (_marker_height - 1) / 4;
469
470         lmin -= mw / _px_per_sample;
471         lmax += mw / _px_per_sample;
472
473         std::vector<LocationMarker> lm;
474
475         const Locations::LocationList& ll (_session->locations ()->list ());
476         for (Locations::LocationList::const_iterator l = ll.begin(); l != ll.end(); ++l) {
477                 if ((*l)->is_session_range ()) {
478                         framepos_t when = (*l)->start ();
479                         if (when >= lmin && when <= lmax) {
480                                 lm.push_back (LocationMarker(_("start"), when));
481                         }
482                         when = (*l)->end ();
483                         if (when >= lmin && when <= lmax) {
484                                 lm.push_back (LocationMarker(_("end"), when));
485                         }
486                         continue;
487                 }
488
489                 if (!(*l)->is_mark () || (*l)->name().substr (0, 4) == "xrun") {
490                         continue;
491                 }
492
493                 framepos_t when = (*l)->start ();
494                 if (when < lmin || when > lmax) {
495                         continue;
496                 }
497                 lm.push_back (LocationMarker((*l)->name(), when));
498         }
499
500         _jumplist.clear ();
501
502         LocationMarkerSort location_marker_sort;
503         std::sort (lm.begin(), lm.end(), location_marker_sort);
504
505         int id = 0;
506         for (std::vector<LocationMarker>::const_iterator l = lm.begin(); l != lm.end(); ++id) {
507                 framepos_t when = (*l).when;
508                 int x0 = floor (get_width() * .5 + (when - p) * _px_per_sample);
509                 int x1 = get_width();
510                 const std::string& label = (*l).label;
511                 if (++l != lm.end()) {
512                         x1 = floor (get_width() * .5 + ((*l).when - p) * _px_per_sample) - 1 - mw;
513                 }
514                 bool prelight = false;
515                 x1 = draw_mark (cr, x0, x1, label, prelight);
516                 _jumplist.push_back (JumpRange (x0 - mw, x1, when, prelight));
517         }
518
519         /* playhead on top */
520         int xc = get_width () * 0.5f;
521         cairo_set_line_width (cr, 1.0);
522         cairo_set_source_rgb (cr, 1, 0, 0); // playhead color
523         cairo_move_to (cr, xc - .5, 0);
524         cairo_rel_line_to (cr, 0, get_height ());
525         cairo_stroke (cr);
526         cairo_move_to (cr, xc - .5, get_height ());
527         cairo_rel_line_to (cr, -3,  0);
528         cairo_rel_line_to (cr,  3, -4);
529         cairo_rel_line_to (cr,  3,  4);
530         cairo_close_path (cr);
531         cairo_fill (cr);
532 }
533
534 void
535 MiniTimeline::build_minitl_context_menu ()
536 {
537         using namespace Gtk;
538         using namespace Gtk::Menu_Helpers;
539
540         assert (_session);
541
542         const framecnt_t time_span = _session->config.get_minitimeline_span ();
543
544         _minitl_context_menu = new Gtk::Menu();
545         MenuList& items = _minitl_context_menu->items();
546
547         // ideally this would have a heading (or rather be a sub-menu to "Visible Time")
548         std::map<framecnt_t, std::string> spans;
549         spans[30]   = _("30 sec");
550         spans[60]   = _("1 min");
551         spans[120]  = _("2 mins");
552         spans[300]  = _("5 mins");
553         spans[600]  = _("10 mins");
554         spans[1200] = _("20 mins");
555
556         RadioMenuItem::Group span_group;
557         for (std::map<framecnt_t, std::string>::const_iterator i = spans.begin (); i != spans.end (); ++i) {
558                 items.push_back (RadioMenuElem (span_group, i->second, sigc::bind (sigc::mem_fun (*this, &MiniTimeline::set_span), i->first)));
559                 if (time_span == i->first) {
560                         static_cast<RadioMenuItem*>(&items.back())->set_active ();
561                 }
562         }
563 }
564
565 void
566 MiniTimeline::show_minitl_context_menu ()
567 {
568         if (_minitl_context_menu == 0) {
569                 build_minitl_context_menu ();
570         }
571         _minitl_context_menu->popup (1, gtk_get_current_event_time());
572 }
573
574 bool
575 MiniTimeline::on_button_press_event (GdkEventButton *ev)
576 {
577         if (Gtkmm2ext::Keyboard::is_context_menu_event (ev)) {
578                 if (_session) {
579                         show_minitl_context_menu ();
580                 }
581                 return true;
582         }
583         return true;
584 }
585
586 bool
587 MiniTimeline::on_button_release_event (GdkEventButton *ev)
588 {
589         if (!_session) { return true; }
590         if (ev->y < 0 || ev->y > get_height () || ev->x < 0 || ev->x > get_width ()) {
591                 return true;
592         }
593
594         if (ev->y <= PADDING + _marker_height) {
595                 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
596                         if (i->left < ev->x && ev->x < i->right) {
597                                 _session->request_locate (i->to, _session->transport_rolling ());
598                                 return true;
599                         }
600                 }
601         }
602
603         if (ev->button == 1) {
604                 framepos_t when = _last_update_frame + (ev->x - get_width() * .5) / _px_per_sample;
605                 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());
606         }
607
608         return true;
609 }
610
611 bool
612 MiniTimeline::on_motion_notify_event (GdkEventMotion *ev)
613 {
614         if (!_session) { return true; }
615
616         _pointer_x = ev->x;
617         _pointer_y = ev->y;
618
619         bool need_expose = false;
620
621         for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
622                 if (i->left < ev->x && ev->x < i->right && ev->y <= PADDING + _marker_height) {
623                         if (!(*i).prelight) {
624                                 need_expose = true;
625                                 break;
626                         }
627                 } else {
628                         if ((*i).prelight) {
629                                 need_expose = true;
630                                 break;
631                         }
632                 }
633         }
634         if (need_expose) {
635                 update_minitimeline ();
636         }
637
638         return true;
639 }
640
641 bool
642 MiniTimeline::on_leave_notify_event (GdkEventCrossing *ev)
643 {
644         CairoWidget::on_leave_notify_event (ev);
645         _pointer_x = _pointer_y = -1;
646         for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
647                 if ((*i).prelight) {
648                         update_minitimeline ();
649                         break;
650                 }
651         }
652         return true;
653 }
654
655 bool
656 MiniTimeline::on_scroll_event (GdkEventScroll *ev)
657 {
658         if (!_session) { return true; }
659         const framecnt_t time_span = _session->config.get_minitimeline_span ();
660         framepos_t when = _session->audible_frame ();
661
662         double scale = time_span / 60.0;
663
664         if (ev->state & Gtkmm2ext::Keyboard::GainFineScaleModifier) {
665                 if (ev->state & Gtkmm2ext::Keyboard::GainExtraFineScaleModifier) {
666                         scale = 0.1;
667                 } else {
668                         scale = 0.5;
669                 }
670         }
671
672         switch (ev->direction) {
673                 case GDK_SCROLL_UP:
674                 case GDK_SCROLL_RIGHT:
675                         when += scale * _session->nominal_frame_rate ();
676                         break;
677                 case GDK_SCROLL_DOWN:
678                 case GDK_SCROLL_LEFT:
679                         when -= scale * _session->nominal_frame_rate ();
680                         break;
681                 default:
682                         return true;
683                         break;
684         }
685         _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());
686         return true;
687 }