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.disconnect ();
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)
88 _session->config.ParameterChanged.connect (session_connection,
90 boost::bind (&MiniTimeline::parameter_changed, this, _1), gui_context()
97 MiniTimeline::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
99 CairoWidget::on_style_changed (old_style);
101 calculate_time_width ();
105 MiniTimeline::on_name_changed ()
108 calculate_time_width ();
116 MiniTimeline::set_colors ()
118 // TODO UIConfiguration::instance().color & font
122 MiniTimeline::parameter_changed (std::string const& p)
124 if (p == "minitimeline-span") {
125 update_minitimeline ();
130 MiniTimeline::on_size_request (Gtk::Requisition* req)
132 req->width = req->height = 0;
133 CairoWidget::on_size_request (req);
135 req->width = std::max( req->width, 1);
136 req->height = std::max (req->height, 20);
140 MiniTimeline::super_rapid_update ()
142 if (!_session || !_session->engine().running()) {
145 framepos_t const frame = PublicEditor::instance().playhead_cursor_sample ();
146 AudioClock::Mode m = ARDOUR_UI::instance()->primary_clock->mode();
148 bool change = _last_update_frame != frame;
150 if (m != _clock_mode) {
152 calculate_time_width ();
157 _last_update_frame = frame;
158 update_minitimeline ();
163 MiniTimeline::update_minitimeline ()
165 CairoWidget::set_dirty ();
169 MiniTimeline::calculate_time_width ()
171 switch (_clock_mode) {
172 case AudioClock::Timecode:
173 _layout->set_text (" 88:88:88,888 ");
175 case AudioClock::BBT:
176 _layout->set_text ("888|88|8888");
178 case AudioClock::MinSec:
179 _layout->set_text ("88:88:88,88");
181 case AudioClock::Frames:
182 _layout->set_text ("8888888888");
185 _layout->get_pixel_size (_time_width, _time_height);
189 MiniTimeline::format_time (framepos_t when)
191 switch (_clock_mode) {
192 case AudioClock::Timecode:
195 _session->timecode_time (when, TC);
196 // chop of leading space or minus.
197 _layout->set_text (Timecode::timecode_format_time (TC).substr(1));
200 case AudioClock::BBT:
203 Timecode::BBT_Time BBT = _session->tempo_map().bbt_at_frame (when);
204 snprintf (buf, sizeof (buf), "%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
205 BBT.bars, BBT.beats, BBT.ticks);
206 _layout->set_text (buf);
209 case AudioClock::MinSec:
212 AudioClock::print_minsec (when, buf, sizeof (buf), _session->frame_rate());
213 _layout->set_text (std::string(buf).substr(1));
216 case AudioClock::Frames:
219 snprintf (buf, sizeof (buf), "%" PRId64, when);
220 _layout->set_text (buf);
227 MiniTimeline::draw_dots (cairo_t* cr, int left, int right, int y, ArdourCanvas::Color color)
229 if (left + 1 >= right) {
232 cairo_move_to (cr, left + .5, y + .5);
233 cairo_line_to (cr, right - .5, y + .5);
234 ArdourCanvas::set_source_rgb_a(cr, color, 0.3);
235 const double dashes[] = { 0, 1 };
236 cairo_set_dash (cr, dashes, 2, 1);
237 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
238 cairo_set_line_width (cr, 1.0);
240 cairo_set_dash (cr, 0, 0, 0);
244 MiniTimeline::draw_mark (cairo_t* cr, int x0, int x1, int h, const std::string& label)
246 /* ArdourMarker shape
254 * (0,MH*.4) (6,MH*.4)
260 int w2 = (h - 1) / 4;
265 _layout->set_text (label);
266 _layout->get_pixel_size (lw, lh);
268 // TODO cache, set_colors()
269 uint32_t color = UIConfiguration::instance().color ("location marker");
271 ArdourCanvas::color_to_rgba (color, r, g, b, a);
273 int rw = std::min (x1, x0 + w2 + lw + 2);
278 cairo_rectangle (cr, x0, y, rw - x0, h);
279 cairo_set_source_rgba (cr, r, g, b, 0.5);
280 cairo_fill_preserve (cr);
284 cairo_move_to (cr, x0 + w2, y + .5 * (h - lh));
285 cairo_set_source_rgb (cr, 0, 0, 0);
286 pango_cairo_show_layout (cr, _layout->gobj());
290 // draw marker on top
291 cairo_move_to (cr, x0 - .5, y + .5);
292 cairo_rel_line_to (cr, -w2 , 0 );
293 cairo_rel_line_to (cr, 0, h0);
294 cairo_rel_line_to (cr, w2, h1);
295 cairo_rel_line_to (cr, w2, -h1);
296 cairo_rel_line_to (cr, 0, -h0);
297 cairo_close_path (cr);
298 cairo_set_source_rgba (cr, r, g, b, 1.0);
299 cairo_set_line_width (cr, 1.0);
300 cairo_stroke_preserve (cr);
306 struct LocationMarker {
307 LocationMarker (const std::string& l, framepos_t w)
308 : label (l), when (w) {}
313 struct LocationMarkerSort {
314 bool operator() (const LocationMarker& a, const LocationMarker& b) {
315 return (a.when < b.when);
320 MiniTimeline::render (cairo_t* cr, cairo_rectangle_t*)
322 // TODO cache, set_colors()
323 ArdourCanvas::Color base = UIConfiguration::instance().color ("ruler base");
324 ArdourCanvas::Color text = UIConfiguration::instance().color ("ruler text");
326 int n_labels = floor (get_width () / (_time_width * 1.15));
332 Gtkmm2ext::rounded_rectangle (cr, 0, 0, get_width(), get_height(), 4);
333 ArdourCanvas::set_source_rgba(cr, base);
336 Gtkmm2ext::rounded_rectangle (cr, 3, 3, get_width()-6, get_height()-6, 4);
345 const framepos_t time_span = _session->config.get_minitimeline_span () / 2;
346 const framepos_t time_span_samples = time_span * _session->nominal_frame_rate ();
347 const framepos_t time_granularity = _session->nominal_frame_rate () * ceil (2. * time_span / n_labels);
348 const framepos_t p = _last_update_frame;
349 const framepos_t lower = (std::max ((framepos_t)0, (p - time_span_samples)) / time_granularity) * time_granularity;
350 const double px_per_sample = get_width () / (2. * time_span_samples);
352 int dot_left = get_width() * .5 + (lower - p) * px_per_sample;
353 for (int i = 0; i < 2 + n_labels; ++i) {
354 framepos_t when = lower + i * time_granularity;
355 double xpos = get_width() * .5 + (when - p) * px_per_sample;
357 // TODO round to nearest display TC in +/- 1px
358 // prefer to display BBT |0 or .0
362 _layout->get_pixel_size (lw, lh);
364 int x0 = xpos - lw / 2.0;
365 int y0 = get_height() - 3 - _time_height;
367 draw_dots (cr, dot_left, x0, y0 + _time_height * .5, text);
369 #if 0 // border around TC
370 Gtkmm2ext::rounded_rectangle (cr, x0, y0, lw, _time_height, 4);
371 ArdourCanvas::set_source_rgba(cr, text);
372 cairo_set_line_width (cr, 1.0);
376 cairo_move_to (cr, x0, y0);
377 ArdourCanvas::set_source_rgba(cr, text);
378 pango_cairo_show_layout (cr, _layout->gobj());
381 draw_dots (cr, dot_left, get_width(), get_height() - 3 - _time_height * .5, text);
384 framepos_t lmin = std::max ((framepos_t)0, (p - time_span_samples));
385 framepos_t lmax = p + time_span_samples;
387 const int mh = std::min (.4f * get_height(), get_height() - _time_height - 8.f);
389 const int mw = (mh - 1) / 4;
391 lmin -= mw / px_per_sample;
392 lmax += mw / px_per_sample;
394 std::vector<LocationMarker> lm;
396 const Locations::LocationList& ll (_session->locations ()->list ());
397 for (Locations::LocationList::const_iterator l = ll.begin(); l != ll.end(); ++l) {
398 if ((*l)->is_session_range ()) {
399 framepos_t when = (*l)->start ();
400 if (when >= lmin && when <= lmax) {
401 lm.push_back (LocationMarker(_("start"), when));
404 if (when >= lmin && when <= lmax) {
405 lm.push_back (LocationMarker(_("end"), when));
410 if (!(*l)->is_mark () || (*l)->name().substr (0, 4) == "xrun") {
414 framepos_t when = (*l)->start ();
415 if (when < lmin || when > lmax) {
418 lm.push_back (LocationMarker((*l)->name(), when));
423 LocationMarkerSort location_marker_sort;
424 std::sort (lm.begin(), lm.end(), location_marker_sort);
426 for (std::vector<LocationMarker>::const_iterator l = lm.begin(); l != lm.end();) {
427 framepos_t when = (*l).when;
428 int x0 = floor (get_width() * .5 + (when - p) * px_per_sample);
429 int x1 = get_width();
430 const std::string& label = (*l).label;
431 if (++l != lm.end()) {
432 x1 = floor (get_width() * .5 + ((*l).when - p) * px_per_sample) - 1 - mw;
434 x1 = draw_mark (cr, x0, x1, mh, label);
435 _jumplist.push_back (JumpRange (x0 - mw, x1, when));
438 /* playhead on top */
439 int xc = get_width () * 0.5f;
440 cairo_set_line_width (cr, 1.0);
441 cairo_set_source_rgb (cr, 1, 0, 0); // playhead color
442 cairo_move_to (cr, xc - .5, 0);
443 cairo_rel_line_to (cr, 0, get_height ());
445 cairo_move_to (cr, xc - .5, get_height ());
446 cairo_rel_line_to (cr, -3, 0);
447 cairo_rel_line_to (cr, 3, -4);
448 cairo_rel_line_to (cr, 3, 4);
449 cairo_close_path (cr);
454 MiniTimeline::on_button_release_event (GdkEventButton *ev)
456 if (!_session) { return true; }
458 bool handled = false;
459 for (JumpList::const_iterator i = _jumplist.begin (); i != _jumplist.end(); ++i) {
460 if (i->left < ev->x && ev->x < i->right) {
461 if (ev->button == 3) {
462 PublicEditor::instance().center_screen (i->to);
463 } else if (ev->button == 1) {
464 _session->request_locate (i->to, _session->transport_rolling ());
471 if ( !handled && ev->button == 1 ) {
472 // copy from ::render() // TODO consolidate
473 const framepos_t time_span = _session->config.get_minitimeline_span () / 2;
474 const framepos_t time_span_samples = time_span * _session->nominal_frame_rate ();
475 const framepos_t p = _last_update_frame;
476 const double px_per_sample = get_width () / (2. * time_span_samples);
478 framepos_t when = p + (ev->x - get_width() * .5) / px_per_sample;
479 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());
486 MiniTimeline::on_scroll_event (GdkEventScroll *ev)
488 if (!_session) { return true; }
489 framepos_t when = _session->audible_frame ();
492 if (ev->state & Gtkmm2ext::Keyboard::GainFineScaleModifier) {
493 if (ev->state & Gtkmm2ext::Keyboard::GainExtraFineScaleModifier) {
500 switch (ev->direction) {
502 when += scale * _session->nominal_frame_rate ();
504 case GDK_SCROLL_DOWN:
505 when -= scale * _session->nominal_frame_rate ();
511 _session->request_locate (std::max ((framepos_t)0, when), _session->transport_rolling ());