2 * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 #include "ardour/audioengine.h"
20 #include "ardour/session.h"
21 #include "ardour/tempo.h"
23 #include "gtkmm2ext/gui_thread.h"
24 #include "gtkmm2ext/keyboard.h"
26 #include "canvas/colors.h"
27 #include "canvas/utils.h"
29 #include "ardour_ui.h"
30 #include "public_editor.h"
31 #include "main_clock.h"
32 #include "mini_timeline.h"
34 #include "ui_config.h"
39 #define BBT_BAR_CHAR "|"
41 using namespace ARDOUR;
43 MiniTimeline::MiniTimeline ()
44 : _last_update_frame (-1)
45 , _clock_mode (AudioClock::Timecode)
50 , _time_granularity (0)
51 , _time_span_samples (0)
55 , _minitl_context_menu (0)
57 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 _layout = Pango::Layout::create (get_pango_context());
61 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &MiniTimeline::set_colors));
62 UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
63 UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
65 set_name ("minitimeline");
67 Location::name_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
68 Location::end_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
69 Location::start_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
70 Location::flags_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
74 MiniTimeline::~MiniTimeline ()
76 delete _minitl_context_menu;
77 _minitl_context_menu = 0;
81 MiniTimeline::session_going_away ()
83 super_rapid_connection.disconnect ();
84 session_connection.drop_connections ();
85 SessionHandlePtr::session_going_away ();
87 delete _minitl_context_menu;
88 _minitl_context_menu = 0;
92 MiniTimeline::set_session (Session* s)
94 SessionHandlePtr::set_session (s);
99 assert (!super_rapid_connection.connected ());
100 super_rapid_connection = Timers::super_rapid_connect (
101 sigc::mem_fun (*this, &MiniTimeline::super_rapid_update)
104 _session->config.ParameterChanged.connect (session_connection,
106 boost::bind (&MiniTimeline::parameter_changed, this, _1), gui_context()
108 _session->locations()->added.connect (session_connection,
110 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
112 _session->locations()->removed.connect (session_connection,
114 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
116 _session->locations()->changed.connect (session_connection,
118 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
122 calculate_time_spacing ();
123 update_minitimeline ();
127 MiniTimeline::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
129 CairoWidget::on_style_changed (old_style);
131 calculate_time_width ();
135 MiniTimeline::on_name_changed ()
138 calculate_time_width ();
146 MiniTimeline::set_colors ()
148 // TODO UIConfiguration::instance().color & font
152 MiniTimeline::parameter_changed (std::string const& p)
154 if (p == "minitimeline-span") {
155 calculate_time_spacing ();
156 update_minitimeline ();
161 MiniTimeline::on_size_request (Gtk::Requisition* req)
163 req->width = req->height = 0;
164 CairoWidget::on_size_request (req);
166 req->width = std::max (req->width, 1);
167 req->height = std::max (req->height, 20);
171 MiniTimeline::on_size_allocate (Gtk::Allocation& alloc)
173 CairoWidget::on_size_allocate (alloc);
174 calculate_time_spacing ();
178 MiniTimeline::set_span (framecnt_t ts)
181 if (_session->config.get_minitimeline_span () == ts) {
185 _session->config.set_minitimeline_span (ts);
186 calculate_time_spacing ();
187 update_minitimeline ();
191 MiniTimeline::super_rapid_update ()
193 if (!_session || !_session->engine().running()) {
196 framepos_t const frame = PublicEditor::instance().playhead_cursor_sample ();
197 AudioClock::Mode m = ARDOUR_UI::instance()->primary_clock->mode();
200 if (fabs ((_last_update_frame - frame) * _px_per_sample) >= 1.0) {
204 if (m != _clock_mode) {
206 calculate_time_width ();
210 if (_clock_mode == AudioClock::BBT) {
211 // TODO check if tempo-map changed
216 _last_update_frame = frame;
217 update_minitimeline ();
222 MiniTimeline::update_minitimeline ()
224 CairoWidget::set_dirty ();
228 MiniTimeline::calculate_time_width ()
230 switch (_clock_mode) {
231 case AudioClock::Timecode:
232 _layout->set_text (" 88:88:88,888 ");
234 case AudioClock::BBT:
235 _layout->set_text ("888|88|8888");
237 case AudioClock::MinSec:
238 _layout->set_text ("88:88:88,88");
240 case AudioClock::Frames:
241 _layout->set_text ("8888888888");
244 _layout->get_pixel_size (_time_width, _time_height);
248 MiniTimeline::calculate_time_spacing ()
250 _n_labels = floor (get_width () / (_time_width * 1.15));
252 if (_n_labels == 0 || !_session) {
256 const framecnt_t time_span = _session->config.get_minitimeline_span () / 2;
257 _time_span_samples = time_span * _session->nominal_frame_rate ();
258 _time_granularity = _session->nominal_frame_rate () * ceil (2. * time_span / _n_labels);
259 _px_per_sample = get_width () / (2. * _time_span_samples);
260 //_px_per_sample = 1.0 / round (1.0 / _px_per_sample);
264 MiniTimeline::format_time (framepos_t when)
266 switch (_clock_mode) {
267 case AudioClock::Timecode:
270 _session->timecode_time (when, TC);
271 // chop of leading space or minus.
272 _layout->set_text (Timecode::timecode_format_time (TC).substr(1));
275 case AudioClock::BBT:
278 Timecode::BBT_Time BBT = _session->tempo_map().bbt_at_frame (when);
279 snprintf (buf, sizeof (buf), "%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
280 BBT.bars, BBT.beats, BBT.ticks);
281 _layout->set_text (buf);
284 case AudioClock::MinSec:
287 AudioClock::print_minsec (when, buf, sizeof (buf), _session->frame_rate());
288 _layout->set_text (std::string(buf).substr(1));
291 case AudioClock::Frames:
294 snprintf (buf, sizeof (buf), "%" PRId64, when);
295 _layout->set_text (buf);
302 MiniTimeline::draw_dots (cairo_t* cr, int left, int right, int y, ArdourCanvas::Color color)
304 if (left + 1 >= right) {
307 cairo_move_to (cr, left + .5, y + .5);
308 cairo_line_to (cr, right - .5, y + .5);
309 ArdourCanvas::set_source_rgb_a(cr, color, 0.3);
310 const double dashes[] = { 0, 1 };
311 cairo_set_dash (cr, dashes, 2, 1);
312 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
313 cairo_set_line_width (cr, 1.0);
315 cairo_set_dash (cr, 0, 0, 0);
319 MiniTimeline::draw_mark (cairo_t* cr, int x0, int x1, const std::string& label, bool& prelight)
321 int h = _marker_height;
322 /* ArdourMarker shape
330 * (0,MH*.4) (6,MH*.4)
335 const int y = PADDING;
336 int w2 = (h - 1) / 4;
341 _layout->set_text (label);
342 _layout->get_pixel_size (lw, lh);
343 int rw = std::min (x1, x0 + w2 + lw + 2);
345 if (_pointer_y >= 0 && _pointer_y <= y + h && _pointer_x >= x0 && _pointer_x <= rw) {
349 // TODO cache in set_colors()
350 uint32_t color = UIConfiguration::instance().color (
351 prelight ? "entered marker" : "location marker");
354 ArdourCanvas::color_to_rgba (color, r, g, b, a);
360 cairo_rectangle (cr, x0, y, rw - x0, h);
361 cairo_set_source_rgba (cr, r, g, b, 0.5); // this should use a shaded color
362 cairo_fill_preserve (cr);
366 cairo_move_to (cr, x0 + w2, y + .5 * (h - lh));
367 cairo_set_source_rgb (cr, 0, 0, 0);
368 pango_cairo_show_layout (cr, _layout->gobj());
372 // draw marker on top
373 cairo_move_to (cr, x0 - .5, y + .5);
374 cairo_rel_line_to (cr, -w2 , 0 );
375 cairo_rel_line_to (cr, 0, h0);
376 cairo_rel_line_to (cr, w2, h1);
377 cairo_rel_line_to (cr, w2, -h1);
378 cairo_rel_line_to (cr, 0, -h0);
379 cairo_close_path (cr);
380 cairo_set_source_rgba (cr, r, g, b, 1.0);
381 cairo_set_line_width (cr, 1.0);
382 cairo_stroke_preserve (cr);
388 struct LocationMarker {
389 LocationMarker (const std::string& l, framepos_t w)
390 : label (l), when (w) {}
395 struct LocationMarkerSort {
396 bool operator() (const LocationMarker& a, const LocationMarker& b) {
397 return (a.when < b.when);
402 MiniTimeline::render (cairo_t* cr, cairo_rectangle_t*)
404 // TODO cache, set_colors()
405 ArdourCanvas::Color base = UIConfiguration::instance().color ("ruler base");
406 ArdourCanvas::Color text = UIConfiguration::instance().color ("ruler text");
408 if (_n_labels == 0) {
412 Gtkmm2ext::rounded_rectangle (cr, 0, 0, get_width(), get_height(), 4);
413 ArdourCanvas::set_source_rgba(cr, base);
416 Gtkmm2ext::rounded_rectangle (cr, PADDING, PADDING, get_width() - PADDING - PADDING, get_height() - PADDING - PADDING, 4);
425 const framepos_t p = _last_update_frame;
426 const framepos_t lower = (std::max ((framepos_t)0, (p - _time_span_samples)) / _time_granularity) * _time_granularity;
428 int dot_left = get_width() * .5 + (lower - p) * _px_per_sample;
429 for (int i = 0; i < 2 + _n_labels; ++i) {
430 framepos_t when = lower + i * _time_granularity;
431 double xpos = get_width() * .5 + (when - p) * _px_per_sample;
433 // TODO round to nearest display TC in +/- 1px
434 // prefer to display BBT |0 or .0
438 _layout->get_pixel_size (lw, lh);
440 int x0 = xpos - lw / 2.0;
441 int y0 = get_height() - PADDING - _time_height;
443 draw_dots (cr, dot_left, x0, y0 + _time_height * .5, text);
445 cairo_move_to (cr, x0, y0);
446 ArdourCanvas::set_source_rgba(cr, text);
447 pango_cairo_show_layout (cr, _layout->gobj());
450 draw_dots (cr, dot_left, get_width(), get_height() - PADDING - _time_height * .5, text);
453 framepos_t lmin = std::max ((framepos_t)0, (p - _time_span_samples));
454 framepos_t lmax = p + _time_span_samples;
457 _layout->set_text (X_("Marker@"));
458 _layout->get_pixel_size (tw, th);
460 _marker_height = th + 2;
461 assert (_marker_height > 4);
462 const int mw = (_marker_height - 1) / 4;
464 lmin -= mw / _px_per_sample;
465 lmax += mw / _px_per_sample;
467 std::vector<LocationMarker> lm;
469 const Locations::LocationList& ll (_session->locations ()->list ());
470 for (Locations::LocationList::const_iterator l = ll.begin(); l != ll.end(); ++l) {
471 if ((*l)->is_session_range ()) {
472 framepos_t when = (*l)->start ();
473 if (when >= lmin && when <= lmax) {
474 lm.push_back (LocationMarker(_("start"), when));
477 if (when >= lmin && when <= lmax) {
478 lm.push_back (LocationMarker(_("end"), when));
483 if (!(*l)->is_mark () || (*l)->name().substr (0, 4) == "xrun") {
487 framepos_t when = (*l)->start ();
488 if (when < lmin || when > lmax) {
491 lm.push_back (LocationMarker((*l)->name(), when));
496 LocationMarkerSort location_marker_sort;
497 std::sort (lm.begin(), lm.end(), location_marker_sort);
500 for (std::vector<LocationMarker>::const_iterator l = lm.begin(); l != lm.end(); ++id) {
501 framepos_t when = (*l).when;
502 int x0 = floor (get_width() * .5 + (when - p) * _px_per_sample);
503 int x1 = get_width();
504 const std::string& label = (*l).label;
505 if (++l != lm.end()) {
506 x1 = floor (get_width() * .5 + ((*l).when - p) * _px_per_sample) - 1 - mw;
508 bool prelight = false;
509 x1 = draw_mark (cr, x0, x1, label, prelight);
510 _jumplist.push_back (JumpRange (x0 - mw, x1, when, prelight));
513 /* playhead on top */
514 int xc = get_width () * 0.5f;
515 cairo_set_line_width (cr, 1.0);
516 cairo_set_source_rgb (cr, 1, 0, 0); // playhead color
517 cairo_move_to (cr, xc - .5, 0);
518 cairo_rel_line_to (cr, 0, get_height ());
520 cairo_move_to (cr, xc - .5, get_height ());
521 cairo_rel_line_to (cr, -3, 0);
522 cairo_rel_line_to (cr, 3, -4);
523 cairo_rel_line_to (cr, 3, 4);
524 cairo_close_path (cr);
529 MiniTimeline::build_minitl_context_menu ()
532 using namespace Gtk::Menu_Helpers;
536 const framecnt_t time_span = _session->config.get_minitimeline_span ();
538 _minitl_context_menu = new Gtk::Menu();
539 MenuList& items = _minitl_context_menu->items();
541 // ideally this would have a heading (or rather be a sub-menu to "Visible Time")
542 std::map<framecnt_t, std::string> spans;
543 spans[30] = _("30 sec");
544 spans[60] = _("1 min");
545 spans[120] = _("2 mins");
546 spans[300] = _("5 mins");
547 spans[600] = _("10 mins");
548 spans[1200] = _("20 mins");
550 RadioMenuItem::Group span_group;
551 for (std::map<framecnt_t, std::string>::const_iterator i = spans.begin (); i != spans.end (); ++i) {
552 items.push_back (RadioMenuElem (span_group, i->second, sigc::bind (sigc::mem_fun (*this, &MiniTimeline::set_span), i->first)));
553 if (time_span == i->first) {
554 static_cast<RadioMenuItem*>(&items.back())->set_active ();
560 MiniTimeline::show_minitl_context_menu ()
562 if (_minitl_context_menu == 0) {
563 build_minitl_context_menu ();
565 _minitl_context_menu->popup (1, gtk_get_current_event_time());
569 MiniTimeline::on_button_press_event (GdkEventButton *ev)
571 if (Gtkmm2ext::Keyboard::is_context_menu_event (ev)) {
573 show_minitl_context_menu ();
581 MiniTimeline::on_button_release_event (GdkEventButton *ev)
583 if (!_session) { return true; }
584 if (ev->y < 0 || ev->y > get_height () || ev->x < 0 || ev->x > get_width ()) {
588 if (ev->y <= PADDING + _marker_height) {
589 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
590 if (i->left < ev->x && ev->x < i->right) {
591 _session->request_locate (i->to, _session->transport_rolling ());
597 if (ev->button == 1) {
598 framepos_t when = _last_update_frame + (ev->x - get_width() * .5) / _px_per_sample;
599 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());
606 MiniTimeline::on_motion_notify_event (GdkEventMotion *ev)
608 if (!_session) { return true; }
613 bool need_expose = false;
615 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
616 if (i->left < ev->x && ev->x < i->right && ev->y <= PADDING + _marker_height) {
617 if (!(*i).prelight) {
629 update_minitimeline ();
636 MiniTimeline::on_leave_notify_event (GdkEventCrossing *ev)
638 CairoWidget::on_leave_notify_event (ev);
639 _pointer_x = _pointer_y = -1;
640 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
642 update_minitimeline ();
650 MiniTimeline::on_scroll_event (GdkEventScroll *ev)
652 if (!_session) { return true; }
653 const framecnt_t time_span = _session->config.get_minitimeline_span ();
654 framepos_t when = _session->audible_frame ();
656 double scale = time_span / 60.0;
658 if (ev->state & Gtkmm2ext::Keyboard::GainFineScaleModifier) {
659 if (ev->state & Gtkmm2ext::Keyboard::GainExtraFineScaleModifier) {
666 switch (ev->direction) {
668 when += scale * _session->nominal_frame_rate ();
670 case GDK_SCROLL_DOWN:
671 when -= scale * _session->nominal_frame_rate ();
677 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());