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"
38 #define BBT_BAR_CHAR "|"
40 using namespace ARDOUR;
42 MiniTimeline::MiniTimeline ()
43 : _last_update_frame (-1)
44 , _clock_mode (AudioClock::Timecode)
48 _layout = Pango::Layout::create (get_pango_context());
50 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &MiniTimeline::set_colors));
51 UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
52 UIConfiguration::instance().DPIReset.connect (sigc::mem_fun (*this, &MiniTimeline::on_name_changed));
54 set_name ("minitimeline");
56 Location::name_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
57 Location::end_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
58 Location::start_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
59 Location::flags_changed.connect (marker_connection, invalidator (*this), boost::bind (&MiniTimeline::update_minitimeline, this), gui_context ());
63 MiniTimeline::~MiniTimeline ()
68 MiniTimeline::session_going_away ()
70 super_rapid_connection.disconnect ();
71 session_connection.drop_connections ();
72 SessionHandlePtr::session_going_away ();
77 MiniTimeline::set_session (Session* s)
79 SessionHandlePtr::set_session (s);
84 assert (!super_rapid_connection.connected ());
85 super_rapid_connection = Timers::super_rapid_connect (
86 sigc::mem_fun (*this, &MiniTimeline::super_rapid_update)
89 _session->config.ParameterChanged.connect (session_connection,
91 boost::bind (&MiniTimeline::parameter_changed, this, _1), gui_context()
93 _session->locations()->added.connect (session_connection,
95 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
97 _session->locations()->removed.connect (session_connection,
99 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
101 _session->locations()->changed.connect (session_connection,
103 boost::bind (&MiniTimeline::update_minitimeline, this), gui_context()
110 MiniTimeline::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
112 CairoWidget::on_style_changed (old_style);
114 calculate_time_width ();
118 MiniTimeline::on_name_changed ()
121 calculate_time_width ();
129 MiniTimeline::set_colors ()
131 // TODO UIConfiguration::instance().color & font
135 MiniTimeline::parameter_changed (std::string const& p)
137 if (p == "minitimeline-span") {
138 update_minitimeline ();
143 MiniTimeline::on_size_request (Gtk::Requisition* req)
145 req->width = req->height = 0;
146 CairoWidget::on_size_request (req);
148 req->width = std::max( req->width, 1);
149 req->height = std::max (req->height, 20);
153 MiniTimeline::super_rapid_update ()
155 if (!_session || !_session->engine().running()) {
158 framepos_t const frame = PublicEditor::instance().playhead_cursor_sample ();
159 AudioClock::Mode m = ARDOUR_UI::instance()->primary_clock->mode();
161 bool change = _last_update_frame != frame;
163 if (m != _clock_mode) {
165 calculate_time_width ();
170 _last_update_frame = frame;
171 update_minitimeline ();
176 MiniTimeline::update_minitimeline ()
178 CairoWidget::set_dirty ();
182 MiniTimeline::calculate_time_width ()
184 switch (_clock_mode) {
185 case AudioClock::Timecode:
186 _layout->set_text (" 88:88:88,888 ");
188 case AudioClock::BBT:
189 _layout->set_text ("888|88|8888");
191 case AudioClock::MinSec:
192 _layout->set_text ("88:88:88,88");
194 case AudioClock::Frames:
195 _layout->set_text ("8888888888");
198 _layout->get_pixel_size (_time_width, _time_height);
202 MiniTimeline::format_time (framepos_t when)
204 switch (_clock_mode) {
205 case AudioClock::Timecode:
208 _session->timecode_time (when, TC);
209 // chop of leading space or minus.
210 _layout->set_text (Timecode::timecode_format_time (TC).substr(1));
213 case AudioClock::BBT:
216 Timecode::BBT_Time BBT = _session->tempo_map().bbt_at_frame (when);
217 snprintf (buf, sizeof (buf), "%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
218 BBT.bars, BBT.beats, BBT.ticks);
219 _layout->set_text (buf);
222 case AudioClock::MinSec:
225 AudioClock::print_minsec (when, buf, sizeof (buf), _session->frame_rate());
226 _layout->set_text (std::string(buf).substr(1));
229 case AudioClock::Frames:
232 snprintf (buf, sizeof (buf), "%" PRId64, when);
233 _layout->set_text (buf);
240 MiniTimeline::draw_dots (cairo_t* cr, int left, int right, int y, ArdourCanvas::Color color)
242 if (left + 1 >= right) {
245 cairo_move_to (cr, left + .5, y + .5);
246 cairo_line_to (cr, right - .5, y + .5);
247 ArdourCanvas::set_source_rgb_a(cr, color, 0.3);
248 const double dashes[] = { 0, 1 };
249 cairo_set_dash (cr, dashes, 2, 1);
250 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
251 cairo_set_line_width (cr, 1.0);
253 cairo_set_dash (cr, 0, 0, 0);
257 MiniTimeline::draw_mark (cairo_t* cr, int x0, int x1, int h, const std::string& label)
259 /* ArdourMarker shape
267 * (0,MH*.4) (6,MH*.4)
273 int w2 = (h - 1) / 4;
278 _layout->set_text (label);
279 _layout->get_pixel_size (lw, lh);
281 // TODO cache, set_colors()
282 uint32_t color = UIConfiguration::instance().color ("location marker");
284 ArdourCanvas::color_to_rgba (color, r, g, b, a);
286 int rw = std::min (x1, x0 + w2 + lw + 2);
291 cairo_rectangle (cr, x0, y, rw - x0, h);
292 cairo_set_source_rgba (cr, r, g, b, 0.5);
293 cairo_fill_preserve (cr);
294 cairo_set_source_rgba (cr, r, g, b, 1.0);
295 cairo_set_line_width (cr, 1.0);
296 cairo_stroke_preserve (cr);
300 cairo_move_to (cr, x0 + w2, y + .5 * (h - lh));
301 cairo_set_source_rgb (cr, 0, 0, 0);
302 pango_cairo_show_layout (cr, _layout->gobj());
306 // draw marker on top
307 cairo_move_to (cr, x0 - .5, y + .5);
308 cairo_rel_line_to (cr, -w2 , 0 );
309 cairo_rel_line_to (cr, 0, h0);
310 cairo_rel_line_to (cr, w2, h1);
311 cairo_rel_line_to (cr, w2, -h1);
312 cairo_rel_line_to (cr, 0, -h0);
313 cairo_close_path (cr);
314 cairo_set_source_rgba (cr, r, g, b, a);
315 cairo_set_line_width (cr, 1.0);
316 cairo_stroke_preserve (cr);
322 struct LocationMarker {
323 LocationMarker (const std::string& l, framepos_t w)
324 : label (l), when (w) {}
329 struct LocationMarkerSort {
330 bool operator() (const LocationMarker& a, const LocationMarker& b) {
331 return (a.when < b.when);
336 MiniTimeline::render (cairo_t* cr, cairo_rectangle_t*)
338 // TODO cache, set_colors()
339 ArdourCanvas::Color base = UIConfiguration::instance().color ("ruler base");
340 ArdourCanvas::Color text = UIConfiguration::instance().color ("ruler text");
342 int n_labels = floor (get_width () / (_time_width * 1.15));
348 Gtkmm2ext::rounded_rectangle (cr, 0, 0, get_width(), get_height(), 4);
349 ArdourCanvas::set_source_rgba(cr, base);
352 Gtkmm2ext::rounded_rectangle (cr, 3, 3, get_width()-6, get_height()-6, 4);
361 const framepos_t time_span = _session->config.get_minitimeline_span () / 2;
362 const framepos_t time_span_samples = time_span * _session->nominal_frame_rate ();
363 const framepos_t time_granularity = _session->nominal_frame_rate () * ceil (2. * time_span / n_labels);
364 const framepos_t p = _last_update_frame;
365 const framepos_t lower = (std::max ((framepos_t)0, (p - time_span_samples)) / time_granularity) * time_granularity;
366 const double px_per_sample = get_width () / (2. * time_span_samples);
368 int dot_left = get_width() * .5 + (lower - p) * px_per_sample;
369 for (int i = 0; i < 2 + n_labels; ++i) {
370 framepos_t when = lower + i * time_granularity;
371 double xpos = get_width() * .5 + (when - p) * px_per_sample;
373 // TODO round to nearest display TC in +/- 1px
374 // prefer to display BBT |0 or .0
378 _layout->get_pixel_size (lw, lh);
380 int x0 = xpos - lw / 2.0;
381 int y0 = get_height() - 3 - _time_height;
383 draw_dots (cr, dot_left, x0, y0 + _time_height * .5, text);
385 #if 0 // border around TC
386 Gtkmm2ext::rounded_rectangle (cr, x0, y0, lw, _time_height, 4);
387 ArdourCanvas::set_source_rgba(cr, text);
388 cairo_set_line_width (cr, 1.0);
392 cairo_move_to (cr, x0, y0);
393 ArdourCanvas::set_source_rgba(cr, text);
394 pango_cairo_show_layout (cr, _layout->gobj());
397 draw_dots (cr, dot_left, get_width(), get_height() - 3 - _time_height * .5, text);
400 framepos_t lmin = std::max ((framepos_t)0, (p - time_span_samples));
401 framepos_t lmax = p + time_span_samples;
404 _layout->set_text( X_("Marker@") );
405 _layout->get_pixel_size (tw, th);
407 const int mh = th + 2;
409 const int mw = (mh - 1) / 4;
411 lmin -= mw / px_per_sample;
412 lmax += mw / px_per_sample;
414 std::vector<LocationMarker> lm;
416 const Locations::LocationList& ll (_session->locations ()->list ());
417 for (Locations::LocationList::const_iterator l = ll.begin(); l != ll.end(); ++l) {
418 if ((*l)->is_session_range ()) {
419 framepos_t when = (*l)->start ();
420 if (when >= lmin && when <= lmax) {
421 lm.push_back (LocationMarker(_("start"), when));
424 if (when >= lmin && when <= lmax) {
425 lm.push_back (LocationMarker(_("end"), when));
430 if (!(*l)->is_mark () || (*l)->name().substr (0, 4) == "xrun") {
434 framepos_t when = (*l)->start ();
435 if (when < lmin || when > lmax) {
438 lm.push_back (LocationMarker((*l)->name(), when));
443 LocationMarkerSort location_marker_sort;
444 std::sort (lm.begin(), lm.end(), location_marker_sort);
446 for (std::vector<LocationMarker>::const_iterator l = lm.begin(); l != lm.end();) {
447 framepos_t when = (*l).when;
448 int x0 = floor (get_width() * .5 + (when - p) * px_per_sample);
449 int x1 = get_width();
450 const std::string& label = (*l).label;
451 if (++l != lm.end()) {
452 x1 = floor (get_width() * .5 + ((*l).when - p) * px_per_sample) - 1 - mw;
454 x1 = draw_mark (cr, x0, x1, mh, label);
455 _jumplist.push_back (JumpRange (x0 - mw, x1, when));
458 /* playhead on top */
459 int xc = get_width () * 0.5f;
460 cairo_set_line_width (cr, 1.0);
461 cairo_set_source_rgb (cr, 1, 0, 0); // playhead color
462 cairo_move_to (cr, xc - .5, 0);
463 cairo_rel_line_to (cr, 0, get_height ());
465 cairo_move_to (cr, xc - .5, get_height ());
466 cairo_rel_line_to (cr, -3, 0);
467 cairo_rel_line_to (cr, 3, -4);
468 cairo_rel_line_to (cr, 3, 4);
469 cairo_close_path (cr);
474 MiniTimeline::on_button_release_event (GdkEventButton *ev)
476 if (!_session) { return true; }
478 bool handled = false;
479 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
480 if (i->left < ev->x && ev->x < i->right) {
481 if (ev->button == 3) {
482 PublicEditor::instance().center_screen (i->to);
483 } else if (ev->button == 1) {
484 _session->request_locate (i->to, _session->transport_rolling ());
491 if ( !handled && ev->button == 1 ) {
492 // copy from ::render() // TODO consolidate
493 const framepos_t time_span = _session->config.get_minitimeline_span () / 2;
494 const framepos_t time_span_samples = time_span * _session->nominal_frame_rate ();
495 const framepos_t p = _last_update_frame;
496 const double px_per_sample = get_width () / (2. * time_span_samples);
498 framepos_t when = p + (ev->x - get_width() * .5) / px_per_sample;
499 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());
506 MiniTimeline::on_scroll_event (GdkEventScroll *ev)
508 if (!_session) { return true; }
509 framepos_t when = _session->audible_frame ();
512 if (ev->state & Gtkmm2ext::Keyboard::GainFineScaleModifier) {
513 if (ev->state & Gtkmm2ext::Keyboard::GainExtraFineScaleModifier) {
520 switch (ev->direction) {
522 when += scale * _session->nominal_frame_rate ();
524 case GDK_SCROLL_DOWN:
525 when -= scale * _session->nominal_frame_rate ();
531 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());