e50f9e90060806e5c7ad7fcb458d99eddbac4924
[ardour.git] / gtk2_ardour / audio_clock.cc
1 /*
2     Copyright (C) 1999 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (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., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <cstdio> // for sprintf
21 #include <cmath>
22
23 #include "pbd/convert.h"
24 #include "pbd/enumwriter.h"
25
26 #include <gtkmm/style.h>
27 #include <sigc++/bind.h>
28
29 #include "gtkmm2ext/cairocell.h"
30 #include "gtkmm2ext/utils.h"
31 #include "gtkmm2ext/rgb_macros.h"
32
33 #include "ardour/profile.h"
34 #include "ardour/session.h"
35 #include "ardour/slave.h"
36 #include "ardour/tempo.h"
37 #include "ardour/types.h"
38
39 #include "ardour_ui.h"
40 #include "audio_clock.h"
41 #include "global_signals.h"
42 #include "utils.h"
43 #include "keyboard.h"
44 #include "gui_thread.h"
45 #include "i18n.h"
46
47 using namespace ARDOUR;
48 using namespace PBD;
49 using namespace Gtk;
50 using namespace std;
51
52 using Gtkmm2ext::Keyboard;
53
54 sigc::signal<void> AudioClock::ModeChanged;
55 vector<AudioClock*> AudioClock::clocks;
56 const double AudioClock::info_font_scale_factor = 0.5;
57 const double AudioClock::separator_height = 0.0;
58 const double AudioClock::x_leading_padding = 6.0;
59
60 #define BBT_BAR_CHAR "|"
61 #define BBT_SCANF_FORMAT "%" PRIu32 "%*c%" PRIu32 "%*c%" PRIu32
62 #define INFO_FONT_SIZE ((int)round(font_size * info_font_scale_factor))
63
64 AudioClock::AudioClock (const string& clock_name, bool transient, const string& widget_name,
65                         bool allow_edit, bool follows_playhead, bool duration, bool with_info)
66         : ops_menu (0)
67         , _name (clock_name)
68         , is_transient (transient)
69         , is_duration (duration)
70         , editable (allow_edit)
71         , _follows_playhead (follows_playhead)
72         , _off (false)
73         , _fixed_width (true)
74         , layout_x_offset (0)
75         , em_width (0)
76         , _edit_by_click_field (false)
77         , _negative_allowed (false)
78         , edit_is_negative (false)
79         , editing_attr (0)
80         , foreground_attr (0)
81         , first_height (0)
82         , first_width (0)
83         , layout_height (0)
84         , layout_width (0)
85         , info_height (0)
86         , upper_height (0)
87         , mode_based_info_ratio (1.0)
88         , corner_radius (9)
89         , font_size (10240)
90         , editing (false)
91         , bbt_reference_time (-1)
92         , last_when(0)
93         , last_pdelta (0)
94         , last_sdelta (0)
95         , dragging (false)
96         , drag_field (Field (0))
97
98 {
99         set_flags (CAN_FOCUS);
100
101         _layout = Pango::Layout::create (get_pango_context());
102         _layout->set_attributes (normal_attributes);
103
104         if (with_info) {
105                 _left_layout = Pango::Layout::create (get_pango_context());
106                 _right_layout = Pango::Layout::create (get_pango_context());
107         }
108
109         set_widget_name (widget_name);
110
111         _mode = BBT; /* lie to force mode switch */
112         set_mode (Timecode);
113         set (last_when, true);
114
115         if (!is_transient) {
116                 clocks.push_back (this);
117         }
118
119         ColorsChanged.connect (sigc::mem_fun (*this, &AudioClock::set_colors));
120         DPIReset.connect (sigc::mem_fun (*this, &AudioClock::dpi_reset));
121 }
122
123 AudioClock::~AudioClock ()
124 {
125         delete foreground_attr;
126         delete editing_attr;
127 }
128
129 void
130 AudioClock::set_widget_name (const string& str)
131 {
132         if (str.empty()) {
133                 set_name ("clock");
134         } else {
135                 set_name (str + " clock");
136         }
137
138         if (is_realized()) {
139                 set_colors ();
140         }
141 }
142
143
144 void
145 AudioClock::on_realize ()
146 {
147         CairoWidget::on_realize ();
148         set_font ();
149         set_colors ();
150 }
151
152 void
153 AudioClock::set_font ()
154 {
155         Glib::RefPtr<Gtk::Style> style = get_style ();
156         Pango::FontDescription font;
157         Pango::AttrFontDesc* font_attr;
158
159         if (!is_realized()) {
160                 font = get_font_for_style (get_name());
161         } else {
162                 font = style->get_font();
163         }
164
165         font_size = font.get_size();
166
167         font_attr = new Pango::AttrFontDesc (Pango::Attribute::create_attr_font_desc (font));
168
169         normal_attributes.change (*font_attr);
170         editing_attributes.change (*font_attr);
171
172         /* now a smaller version of the same font */
173
174         delete font_attr;
175         font.set_size ((int) lrint (font_size * info_font_scale_factor));
176         font.set_weight (Pango::WEIGHT_NORMAL);
177         font_attr = new Pango::AttrFontDesc (Pango::Attribute::create_attr_font_desc (font));
178
179         info_attributes.change (*font_attr);
180
181         /* and an even smaller one */
182
183         delete font_attr;
184
185         /* get the figure width for the font. This doesn't have to super
186          * accurate since we only use it to measure the (roughly 1 character)
187          * offset from the position Pango tells us for the "cursor"
188          */
189
190         Glib::RefPtr<Pango::Layout> tmp = Pango::Layout::create (get_pango_context());
191         int ignore_height;
192
193         tmp->set_text ("8");
194         tmp->get_pixel_size (em_width, ignore_height);
195
196         /* force redraw of markup with new font-size */
197         set (last_when, true);
198 }
199
200 void
201 AudioClock::set_active_state (Gtkmm2ext::ActiveState s)
202 {
203         CairoWidget::set_active_state (s);
204         set_colors ();
205 }
206
207 void
208 AudioClock::set_colors ()
209 {
210         int r, g, b, a;
211
212         uint32_t bg_color;
213         uint32_t text_color;
214         uint32_t editing_color;
215         uint32_t cursor_color;
216
217         if (active_state()) {
218                 bg_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1 active: background", get_name()));
219                 text_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1 active: text", get_name()));
220                 editing_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1 active: edited text", get_name()));
221                 cursor_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1 active: cursor", get_name()));
222         } else {
223                 bg_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: background", get_name()));
224                 text_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: text", get_name()));
225                 editing_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: edited text", get_name()));
226                 cursor_color = ARDOUR_UI::config()->color_by_name (string_compose ("%1: cursor", get_name()));
227         }
228
229         /* store for bg and cursor in render() */
230
231         UINT_TO_RGBA (bg_color, &r, &g, &b, &a);
232
233         bg_r = r/255.0;
234         bg_g = g/255.0;
235         bg_b = b/255.0;
236         bg_a = a/255.0;
237
238         UINT_TO_RGBA (cursor_color, &r, &g, &b, &a);
239
240         cursor_r = r/255.0;
241         cursor_g = g/255.0;
242         cursor_b = b/255.0;
243         cursor_a = a/255.0;
244
245         /* rescale for Pango colors ... sigh */
246
247         r = lrint (r * 65535.0);
248         g = lrint (g * 65535.0);
249         b = lrint (b * 65535.0);
250
251         UINT_TO_RGBA (text_color, &r, &g, &b, &a);
252         r = lrint ((r/255.0) * 65535.0);
253         g = lrint ((g/255.0) * 65535.0);
254         b = lrint ((b/255.0) * 65535.0);
255         foreground_attr = new Pango::AttrColor (Pango::Attribute::create_attr_foreground (r, g, b));
256
257         UINT_TO_RGBA (editing_color, &r, &g, &b, &a);
258         r = lrint ((r/255.0) * 65535.0);
259         g = lrint ((g/255.0) * 65535.0);
260         b = lrint ((b/255.0) * 65535.0);
261         editing_attr = new Pango::AttrColor (Pango::Attribute::create_attr_foreground (r, g, b));
262
263         normal_attributes.change (*foreground_attr);
264         info_attributes.change (*foreground_attr);
265         editing_attributes.change (*foreground_attr);
266         editing_attributes.change (*editing_attr);
267
268         if (!editing) {
269                 _layout->set_attributes (normal_attributes);
270         } else {
271                 _layout->set_attributes (editing_attributes);
272         }
273
274         queue_draw ();
275 }
276
277 void
278 AudioClock::render (cairo_t* cr)
279 {
280         /* main layout: rounded rect, plus the text */
281
282         if (_need_bg) {
283                 cairo_set_source_rgba (cr, bg_r, bg_g, bg_b, bg_a);
284                 if (corner_radius) {
285                         if (_left_layout) {
286                                 Gtkmm2ext::rounded_top_half_rectangle (cr, 0, 0, get_width() - corner_radius/2.0, upper_height, corner_radius);
287                         } else {
288                                 Gtkmm2ext::rounded_rectangle (cr, 0, 0, get_width(), upper_height, corner_radius);
289                         }
290                 } else {
291                         cairo_rectangle (cr, 0, 0, get_width(), upper_height);
292                 }
293                 cairo_fill (cr);
294         }
295
296         if (!_fixed_width) {
297                 cairo_move_to (cr, layout_x_offset, 0);
298         } else {
299                 int xcenter = layout_x_offset > corner_radius/4.0 ? 0 : (get_width() - _mode_width[_mode]) /2;
300                 cairo_move_to (cr, layout_x_offset + xcenter, (upper_height - layout_height) / 2.0);
301         }
302
303         pango_cairo_show_layout (cr, _layout->gobj());
304
305         if (_left_layout) {
306
307                 double h = get_height() - upper_height - separator_height;
308
309                 if (_need_bg) {
310                         cairo_set_source_rgba (cr, bg_r, bg_g, bg_b, bg_a);
311                 }
312
313                 if (mode_based_info_ratio != 1.0) {
314
315                         double left_rect_width = round (((get_width() - separator_height) * mode_based_info_ratio) + 0.5);
316
317                         if (_need_bg) {
318                                 if (corner_radius) {
319                                         Gtkmm2ext::rounded_bottom_half_rectangle (cr, 0, upper_height + separator_height,
320                                                         left_rect_width + (separator_height == 0 ? corner_radius : 0),
321                                                         h - corner_radius/2.0, corner_radius);
322                                 } else {
323                                         cairo_rectangle (cr, 0, upper_height + separator_height, left_rect_width, h);
324                                 }
325                                 cairo_fill (cr);
326                         }
327
328                         cairo_move_to (cr, x_leading_padding, upper_height + separator_height + ((h - info_height)/2.0));
329                         pango_cairo_show_layout (cr, _left_layout->gobj());
330
331                         if (_need_bg) {
332                                 if (corner_radius) {
333                                         Gtkmm2ext::rounded_bottom_half_rectangle (cr, left_rect_width + separator_height,
334                                                         upper_height + separator_height,
335                                                         get_width() - separator_height - left_rect_width - corner_radius/2.0,
336                                                         h - corner_radius/2.0, corner_radius);
337                                 } else {
338                                         cairo_rectangle (cr, left_rect_width + separator_height, upper_height + separator_height,
339                                                          get_width() - separator_height - left_rect_width, h);
340                                 }
341                                 cairo_fill (cr);
342                         }
343
344
345                         if (_right_layout->get_alignment() == Pango::ALIGN_RIGHT) {
346                                 /* right-align does not work per se beacuse layout width is unset.
347                                  * Using _right_layout->set_width([value >=0]) would also enable
348                                  * word-wrapping which is not wanted here.
349                                  * The solution is to custom align the layout depending on its size.
350                                  * if it is larger than the available space it will be cropped on the
351                                  * right edge rather than override text on the left side.
352                                  */
353                                 int x, rw, rh;
354                                 _right_layout->get_pixel_size(rw, rh);
355                                 x = get_width() - rw - separator_height - x_leading_padding - corner_radius/2.0;
356                                 if (x < x_leading_padding + left_rect_width + separator_height) {
357                                         /* rather cut off the right end than overlap with the text on the left */
358                                         x = x_leading_padding + left_rect_width + separator_height;
359                                 }
360                                 cairo_move_to (cr, x, upper_height + separator_height + ((h - info_height)/2.0));
361                         } else {
362                                 cairo_move_to (cr, x_leading_padding + left_rect_width + separator_height, upper_height + separator_height + ((h - info_height)/2.0));
363                         }
364                         pango_cairo_show_layout (cr, _right_layout->gobj());
365
366                 } else {
367                         /* no info to display, or just one */
368
369                         if (_need_bg) {
370                                 if (corner_radius) {
371                                         Gtkmm2ext::rounded_bottom_half_rectangle (cr, 0, upper_height + separator_height, get_width(), h, corner_radius);
372                                 } else {
373                                         cairo_rectangle (cr, 0, upper_height + separator_height, get_width(), h);
374                                 }
375                                 cairo_fill (cr);
376                         }
377                 }
378         }
379
380         if (editing) {
381                 if (!insert_map.empty()) {
382
383                         int xcenter = layout_x_offset > corner_radius/4.0 ? 0 : (get_width() - _mode_width[_mode]) /2;
384
385                         if (input_string.length() < insert_map.size()) {
386                                 Pango::Rectangle cursor;
387
388                                 if (input_string.empty()) {
389                                         /* nothing entered yet, put cursor at the end
390                                            of string
391                                         */
392                                         cursor = _layout->get_cursor_strong_pos (edit_string.length() - 1);
393                                 } else {
394                                         cursor = _layout->get_cursor_strong_pos (insert_map[input_string.length()]);
395                                 }
396
397                                 cairo_set_source_rgba (cr, cursor_r, cursor_g, cursor_b, cursor_a);
398                                 if (!_fixed_width) {
399                                         cairo_rectangle (cr,
400                                                          min (get_width() - 2.0,
401                                                               (double) cursor.get_x()/PANGO_SCALE + layout_x_offset + xcenter + em_width), 0,
402                                                          2.0, cursor.get_height()/PANGO_SCALE);
403                                 } else {
404                                         cairo_rectangle (cr,
405                                                          min (get_width() - 2.0,
406                                                               (double) layout_x_offset + xcenter + cursor.get_x()/PANGO_SCALE + em_width),
407                                                          (upper_height - layout_height)/2.0,
408                                                          2.0, cursor.get_height()/PANGO_SCALE);
409                                 }
410                                 cairo_fill (cr);
411                         } else {
412                                 /* we've entered all possible digits, no cursor */
413                         }
414
415                 } else {
416                         if (input_string.empty()) {
417                                 cairo_set_source_rgba (cr, cursor_r, cursor_g, cursor_b, cursor_a);
418                                 if (!_fixed_width) {
419                                         cairo_rectangle (cr,
420                                                          (get_width()/2.0),
421                                                          0,
422                                                          2.0, upper_height);
423                                 } else {
424                                         cairo_rectangle (cr,
425                                                          (get_width()/2.0),
426                                                          (upper_height - layout_height)/2.0,
427                                                          2.0, upper_height);
428                                 }
429                                 cairo_fill (cr);
430                         }
431                 }
432         }
433 }
434
435 void
436 AudioClock::on_size_allocate (Gtk::Allocation& alloc)
437 {
438         CairoWidget::on_size_allocate (alloc);
439
440         if (_left_layout) {
441                 upper_height = (get_height()/2.0) - 1.0;
442         } else {
443                 upper_height = get_height();
444         }
445
446         if (_fixed_width) {
447                 /* center display in available space
448                  * NB. this only works if the containing widget is not the
449                  * layout itself (eg. the session->property dialog)
450                  */
451                 layout_x_offset = (get_width() - layout_width)/2.0;
452         } else {
453                 /* left justify */
454                 layout_x_offset = 0;
455         }
456 }
457
458 void
459 AudioClock::on_size_request (Gtk::Requisition* req)
460 {
461         /* even for non fixed width clocks, the size we *ask* for never changes,
462            even though the size we receive might. so once we've computed it,
463            just return it.
464         */
465
466         if (first_width) {
467                 req->width = first_width;
468                 req->height = first_height;
469                 return;
470         }
471
472         Glib::RefPtr<Pango::Layout> tmp;
473         Glib::RefPtr<Gtk::Style> style = get_style ();
474         Pango::FontDescription font;
475
476         tmp = Pango::Layout::create (get_pango_context());
477
478         if (!is_realized()) {
479                 font = get_font_for_style (get_name());
480         } else {
481                 font = style->get_font();
482         }
483
484         tmp->set_font_description (font);
485
486         if (_fixed_width) {
487                 int ignored;
488                 tmp->set_text ("-88:88:88:88");
489                 tmp->get_pixel_size (_mode_width[Timecode], ignored);
490                 tmp->set_text (" 88888|88|8888");
491                 tmp->get_pixel_size (_mode_width[BBT], ignored);
492                 tmp->set_text (" 88:88:88,888");
493                 tmp->get_pixel_size (_mode_width[MinSec], ignored);
494                 tmp->set_text (" 8888888888");
495                 tmp->get_pixel_size (_mode_width[Frames], ignored);
496
497                 /* this string is the longest thing we will ever display,
498                    it does not include the BBT bar char that may descend
499                          below the baseline.
500                          note; depending on BPM setting this may actually
501                          not be sufficient for 24h worth of BBT
502                 */
503
504                 tmp->set_text (" 88888888888::,");
505         } else {
506                 switch (_mode) {
507                 case Timecode:
508                         tmp->set_text ("-88:88:88:88");
509                         break;
510                 case BBT:
511                         tmp->set_text (" 88888|88|8888");
512                         break;
513                 case MinSec:
514                         tmp->set_text (" 88:88:88,888");
515                         break;
516                 case Frames:
517                         tmp->set_text (" 8888888888");
518                         break;
519                 }
520         }
521
522         tmp->get_pixel_size (req->width, req->height);
523
524         layout_height = req->height;
525         layout_width = req->width;
526
527         /* now tackle height, for which we need to know the height of the lower
528          * layout
529          */
530
531         if (_left_layout) {
532
533                 int w;
534
535                 font.set_size ((int) lrint (font.get_size() * info_font_scale_factor));
536                 font.set_weight (Pango::WEIGHT_NORMAL);
537                 tmp->set_font_description (font);
538
539                 /* we only care about height, so put as much stuff in here
540                    as possible that might change the height.
541                 */
542                 tmp->set_text ("qyhH|"); /* one ascender, one descender */
543
544                 tmp->get_pixel_size (w, info_height);
545
546                 /* silly extra padding that seems necessary to correct the info
547                  * that pango just gave us. I have no idea why.
548                  */
549
550                 req->height += info_height;
551                 req->height += separator_height;
552         }
553
554         first_height = req->height;
555         first_width = req->width;
556 }
557
558 void
559 AudioClock::show_edit_status (int length)
560 {
561         editing_attr->set_start_index (edit_string.length() - length);
562         editing_attr->set_end_index (edit_string.length());
563
564         editing_attributes.change (*foreground_attr);
565         editing_attributes.change (*editing_attr);
566
567         _layout->set_attributes (editing_attributes);
568 }
569
570 void
571 AudioClock::start_edit (Field f)
572 {
573         pre_edit_string = _layout->get_text ();
574         if (!insert_map.empty()) {
575                 edit_string = pre_edit_string;
576         } else {
577                 edit_string.clear ();
578                 _layout->set_text ("");
579         }
580
581         input_string.clear ();
582         editing = true;
583         edit_is_negative = false;
584
585         if (f) {
586                 input_string = get_field (f);
587                 show_edit_status (merge_input_and_edit_string ());
588                 _layout->set_text (edit_string);
589         }
590
591         queue_draw ();
592
593         Keyboard::magic_widget_grab_focus ();
594         grab_focus ();
595 }
596
597 string
598 AudioClock::get_field (Field f)
599 {
600         switch (f) {
601         case Timecode_Hours:
602                 return edit_string.substr (1, 2);
603                 break;
604         case Timecode_Minutes:
605                 return edit_string.substr (4, 2);
606                 break;
607         case Timecode_Seconds:
608                 return edit_string.substr (7, 2);
609                 break;
610         case Timecode_Frames:
611                 return edit_string.substr (10, 2);
612                 break;
613         case MS_Hours:
614                 return edit_string.substr (1, 2);
615                 break;
616         case MS_Minutes:
617                 return edit_string.substr (4, 2);
618                 break;
619         case MS_Seconds:
620                 return edit_string.substr (7, 2);
621                 break;
622         case MS_Milliseconds:
623                 return edit_string.substr (10, 3);
624                 break;
625         case Bars:
626                 return edit_string.substr (1, 3);
627                 break;
628         case Beats:
629                 return edit_string.substr (5, 2);
630                 break;
631         case Ticks:
632                 return edit_string.substr (8, 4);
633                 break;
634         case AudioFrames:
635                 return edit_string;
636                 break;
637         }
638         return "";
639 }
640
641 void
642 AudioClock::end_edit (bool modify)
643 {
644         if (modify) {
645
646                 bool ok = true;
647
648                 switch (_mode) {
649                 case Timecode:
650                         ok = timecode_validate_edit (edit_string);
651                         break;
652
653                 case BBT:
654                         ok = bbt_validate_edit (edit_string);
655                         break;
656
657                 case MinSec:
658                         ok = minsec_validate_edit (edit_string);
659                         break;
660
661                 case Frames:
662                         break;
663                 }
664
665                 if (!ok) {
666                         edit_string = pre_edit_string;
667                         input_string.clear ();
668                         _layout->set_text (edit_string);
669                         show_edit_status (0);
670                         /* edit attributes remain in use */
671                 } else {
672
673                         editing = false;
674                         framepos_t pos = 0; /* stupid gcc */
675
676                         switch (_mode) {
677                         case Timecode:
678                                 pos = frames_from_timecode_string (edit_string);
679                                 break;
680
681                         case BBT:
682                                 if (is_duration) {
683                                         pos = frame_duration_from_bbt_string (0, edit_string);
684                                 } else {
685                                         pos = frames_from_bbt_string (0, edit_string);
686                                 }
687                                 break;
688
689                         case MinSec:
690                                 pos = frames_from_minsec_string (edit_string);
691                                 break;
692
693                         case Frames:
694                                 pos = frames_from_audioframes_string (edit_string);
695                                 break;
696                         }
697
698                         set (pos, true);
699                         _layout->set_attributes (normal_attributes);
700                         ValueChanged(); /* EMIT_SIGNAL */
701                 }
702
703         } else {
704
705                 editing = false;
706                 edit_is_negative = false;
707                 _layout->set_attributes (normal_attributes);
708                 _layout->set_text (pre_edit_string);
709         }
710
711         queue_draw ();
712
713         if (!editing) {
714                 drop_focus ();
715         }
716 }
717
718 void
719 AudioClock::drop_focus ()
720 {
721         Keyboard::magic_widget_drop_focus ();
722
723         if (has_focus()) {
724
725                 /* move focus back to the default widget in the top level window */
726
727                 Widget* top = get_toplevel();
728
729                 if (top->is_toplevel ()) {
730                         Window* win = dynamic_cast<Window*> (top);
731                         win->grab_focus ();
732                 }
733         }
734 }
735
736 framecnt_t
737 AudioClock::parse_as_frames_distance (const std::string& str)
738 {
739         framecnt_t f;
740
741         if (sscanf (str.c_str(), "%" PRId64, &f) == 1) {
742                 return f;
743         }
744
745         return 0;
746 }
747
748 framecnt_t
749 AudioClock::parse_as_minsec_distance (const std::string& str)
750 {
751         framecnt_t sr = _session->frame_rate();
752         int msecs;
753         int secs;
754         int mins;
755         int hrs;
756
757         switch (str.length()) {
758         case 0:
759                 return 0;
760         case 1:
761         case 2:
762         case 3:
763         case 4:
764                 sscanf (str.c_str(), "%" PRId32, &msecs);
765                 return msecs * (sr / 1000);
766
767         case 5:
768                 sscanf (str.c_str(), "%1" PRId32 "%" PRId32, &secs, &msecs);
769                 return (secs * sr) + (msecs * (sr/1000));
770
771         case 6:
772                 sscanf (str.c_str(), "%2" PRId32 "%" PRId32, &secs, &msecs);
773                 return (secs * sr) + (msecs * (sr/1000));
774
775         case 7:
776                 sscanf (str.c_str(), "%1" PRId32 "%2" PRId32 "%" PRId32, &mins, &secs, &msecs);
777                 return (mins * 60 * sr) + (secs * sr) + (msecs * (sr/1000));
778
779         case 8:
780                 sscanf (str.c_str(), "%2" PRId32 "%2" PRId32 "%" PRId32, &mins, &secs, &msecs);
781                 return (mins * 60 * sr) + (secs * sr) + (msecs * (sr/1000));
782
783         case 9:
784                 sscanf (str.c_str(), "%1" PRId32 "%2" PRId32 "%2" PRId32 "%" PRId32, &hrs, &mins, &secs, &msecs);
785                 return (hrs * 3600 * sr) + (mins * 60 * sr) + (secs * sr) + (msecs * (sr/1000));
786
787         case 10:
788                 sscanf (str.c_str(), "%1" PRId32 "%2" PRId32 "%2" PRId32 "%" PRId32, &hrs, &mins, &secs, &msecs);
789                 return (hrs * 3600 * sr) + (mins * 60 * sr) + (secs * sr) + (msecs * (sr/1000));
790
791         default:
792                 break;
793         }
794
795         return 0;
796 }
797
798 framecnt_t
799 AudioClock::parse_as_timecode_distance (const std::string& str)
800 {
801         double fps = _session->timecode_frames_per_second();
802         framecnt_t sr = _session->frame_rate();
803         int frames;
804         int secs;
805         int mins;
806         int hrs;
807
808         switch (str.length()) {
809         case 0:
810                 return 0;
811         case 1:
812         case 2:
813                 sscanf (str.c_str(), "%" PRId32, &frames);
814                 return lrint ((frames/(float)fps) * sr);
815
816         case 3:
817                 sscanf (str.c_str(), "%1" PRId32 "%" PRId32, &secs, &frames);
818                 return (secs * sr) + lrint ((frames/(float)fps) * sr);
819
820         case 4:
821                 sscanf (str.c_str(), "%2" PRId32 "%" PRId32, &secs, &frames);
822                 return (secs * sr) + lrint ((frames/(float)fps) * sr);
823
824         case 5:
825                 sscanf (str.c_str(), "%1" PRId32 "%2" PRId32 "%" PRId32, &mins, &secs, &frames);
826                 return (mins * 60 * sr) + (secs * sr) + lrint ((frames/(float)fps) * sr);
827
828         case 6:
829                 sscanf (str.c_str(), "%2" PRId32 "%2" PRId32 "%" PRId32, &mins, &secs, &frames);
830                 return (mins * 60 * sr) + (secs * sr) + lrint ((frames/(float)fps) * sr);
831
832         case 7:
833                 sscanf (str.c_str(), "%1" PRId32 "%2" PRId32 "%2" PRId32 "%" PRId32, &hrs, &mins, &secs, &frames);
834                 return (hrs * 3600 * sr) + (mins * 60 * sr) + (secs * sr) + lrint ((frames/(float)fps) * sr);
835
836         case 8:
837                 sscanf (str.c_str(), "%2" PRId32 "%2" PRId32 "%2" PRId32 "%" PRId32, &hrs, &mins, &secs, &frames);
838                 return (hrs * 3600 * sr) + (mins * 60 * sr) + (secs * sr) + lrint ((frames/(float)fps) * sr);
839
840         default:
841                 break;
842         }
843
844         return 0;
845 }
846
847 framecnt_t
848 AudioClock::parse_as_bbt_distance (const std::string&)
849 {
850         return 0;
851 }
852
853 framecnt_t
854 AudioClock::parse_as_distance (const std::string& instr)
855 {
856         switch (_mode) {
857         case Timecode:
858                 return parse_as_timecode_distance (instr);
859                 break;
860         case Frames:
861                 return parse_as_frames_distance (instr);
862                 break;
863         case BBT:
864                 return parse_as_bbt_distance (instr);
865                 break;
866         case MinSec:
867                 return parse_as_minsec_distance (instr);
868                 break;
869         }
870         return 0;
871 }
872
873 void
874 AudioClock::end_edit_relative (bool add)
875 {
876         bool ok = true;
877
878         switch (_mode) {
879         case Timecode:
880                 ok = timecode_validate_edit (edit_string);
881                 break;
882
883         case BBT:
884                 ok = bbt_validate_edit (edit_string);
885                 break;
886
887         case MinSec:
888                 ok = minsec_validate_edit (edit_string);
889                 break;
890
891         case Frames:
892                 break;
893         }
894
895         if (!ok) {
896                 edit_string = pre_edit_string;
897                 input_string.clear ();
898                 _layout->set_text (edit_string);
899                 show_edit_status (0);
900                 /* edit attributes remain in use */
901                 queue_draw ();
902                 return;
903         }
904
905         framecnt_t frames = parse_as_distance (input_string);
906
907         editing = false;
908
909         editing = false;
910         _layout->set_attributes (normal_attributes);
911
912         if (frames != 0) {
913                 if (add) {
914                         set (current_time() + frames, true);
915                 } else {
916                         framepos_t c = current_time();
917
918                         if (c > frames) {
919                                 set (c - frames, true);
920                         } else {
921                                 set (0, true);
922                         }
923                 }
924                 ValueChanged (); /* EMIT SIGNAL */
925         }
926
927         input_string.clear ();
928         queue_draw ();
929         drop_focus ();
930 }
931
932 void
933 AudioClock::session_configuration_changed (std::string p)
934 {
935         if (p == "sync-source" || p == "external-sync") {
936                 set (current_time(), true);
937                 return;
938         }
939
940         if (p != "timecode-offset" && p != "timecode-offset-negative") {
941                 return;
942         }
943
944         framecnt_t current;
945
946         switch (_mode) {
947         case Timecode:
948                 if (is_duration) {
949                         current = current_duration ();
950                 } else {
951                         current = current_time ();
952                 }
953                 set (current, true);
954                 break;
955         default:
956                 break;
957         }
958 }
959
960 void
961 AudioClock::set (framepos_t when, bool force, framecnt_t offset)
962 {
963         if ((!force && !is_visible()) || _session == 0) {
964                 return;
965         }
966
967         if (is_duration) {
968                 when = when - offset;
969         }
970
971         if (when == last_when && !force) {
972                 if (_mode != Timecode && _mode != MinSec) {
973                         /* may need to force display of TC source
974                          * time, so don't return early.
975                          */
976                         return;
977                 }
978         }
979
980         if (!editing) {
981                 if (_right_layout) {
982                         _right_layout->set_alignment(Pango::ALIGN_LEFT);
983                 }
984
985                 switch (_mode) {
986                 case Timecode:
987                         if (_right_layout) {
988                                 _right_layout->set_alignment(Pango::ALIGN_RIGHT);
989                         }
990                         set_timecode (when, force);
991                         break;
992
993                 case BBT:
994                         set_bbt (when, force);
995                         break;
996
997                 case MinSec:
998                         if (_right_layout) {
999                                 _right_layout->set_alignment(Pango::ALIGN_RIGHT);
1000                         }
1001                         set_minsec (when, force);
1002                         break;
1003
1004                 case Frames:
1005                         set_frames (when, force);
1006                         break;
1007                 }
1008         }
1009
1010         queue_draw ();
1011         last_when = when;
1012 }
1013
1014 void
1015 AudioClock::set_slave_info ()
1016 {
1017         if (!_left_layout || !_right_layout) {
1018                 return;
1019         }
1020
1021         SyncSource sync_src = Config->get_sync_source();
1022
1023         if (_session->config.get_external_sync()) {
1024                 Slave* slave = _session->slave();
1025
1026                 switch (sync_src) {
1027                 case JACK:
1028                         _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1029                                                 INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1030                         _right_layout->set_text ("");
1031                         break;
1032                 case MIDIClock:
1033                         if (slave) {
1034                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1035                                                         INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1036                                 _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1037                                                         INFO_FONT_SIZE, slave->approximate_current_delta()));
1038                         } else {
1039                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1040                                                         INFO_FONT_SIZE, _("--pending--")));
1041                                 _right_layout->set_text ("");
1042                         }
1043                         break;
1044                 case LTC:
1045                 case MTC:
1046                         if (slave) {
1047                                 bool matching;
1048                                 TimecodeSlave* tcslave;
1049                                 if ((tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
1050                                         matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
1051                                         _left_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2</span><span foreground=\"%3\">%4</span></span>",
1052                                                                                   INFO_FONT_SIZE, sync_source_to_string(sync_src, true)[0], (matching?"green":"red"),
1053                                                                                   dynamic_cast<TimecodeSlave*>(slave)->approximate_current_position()));
1054                                         _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1055                                                                                    INFO_FONT_SIZE, slave->approximate_current_delta()));
1056                                 }
1057                         } else {
1058                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1059                                                         INFO_FONT_SIZE, _("--pending--")));
1060                                 _right_layout->set_text ("");
1061                         }
1062                         break;
1063                 }
1064         } else {
1065                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">INT/%2</span>",
1066                                         INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1067                 _right_layout->set_text ("");
1068         }
1069 }
1070
1071 void
1072 AudioClock::set_frames (framepos_t when, bool /*force*/)
1073 {
1074         char buf[32];
1075         bool negative = false;
1076
1077         if (_off) {
1078                 _layout->set_text ("\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012");
1079
1080                 if (_left_layout) {
1081                         _left_layout->set_text ("");
1082                         _right_layout->set_text ("");
1083                 }
1084
1085                 return;
1086         }
1087
1088         if (when < 0) {
1089                 when = -when;
1090                 negative = true;
1091         }
1092
1093         if (negative) {
1094                 snprintf (buf, sizeof (buf), "-%10" PRId64, when);
1095         } else {
1096                 snprintf (buf, sizeof (buf), " %10" PRId64, when);
1097         }
1098
1099         _layout->set_text (buf);
1100
1101         if (_left_layout) {
1102                 framecnt_t rate = _session->frame_rate();
1103
1104                 if (fmod (rate, 100.0) == 0.0) {
1105                         sprintf (buf, "%.1fkHz", rate/1000.0);
1106                 } else {
1107                         sprintf (buf, "%" PRId64 "Hz", rate);
1108                 }
1109
1110                 _left_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2 </span><span foreground=\"green\">%3</span></span>",
1111                                 INFO_FONT_SIZE, _("SR"), buf));
1112
1113                 float vid_pullup = _session->config.get_video_pullup();
1114
1115                 if (vid_pullup == 0.0) {
1116                         _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1117                                         INFO_FONT_SIZE, _("pullup: \u2012")));
1118                 } else {
1119                         sprintf (buf, _("%+-6.4f%%"), vid_pullup);
1120                         _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"green\">%2</span>",
1121                                         INFO_FONT_SIZE, buf));
1122                 }
1123         }
1124 }
1125
1126 void
1127 AudioClock::set_minsec (framepos_t when, bool /*force*/)
1128 {
1129         char buf[32];
1130         framecnt_t left;
1131         int hrs;
1132         int mins;
1133         int secs;
1134         int millisecs;
1135         bool negative = false;
1136
1137         if (_off) {
1138                 _layout->set_text ("\u2012\u2012:\u2012\u2012:\u2012\u2012.\u2012\u2012\u2012");
1139
1140                 if (_left_layout) {
1141                         _left_layout->set_text ("");
1142                         _right_layout->set_text ("");
1143                 }
1144
1145                 return;
1146         }
1147
1148         if (when < 0) {
1149                 when = -when;
1150                 negative = true;
1151         }
1152
1153         left = when;
1154         hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
1155         left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
1156         mins = (int) floor (left / (_session->frame_rate() * 60.0f));
1157         left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
1158         secs = (int) floor (left / (float) _session->frame_rate());
1159         left -= (framecnt_t) floor (secs * _session->frame_rate());
1160         millisecs = floor (left * 1000.0 / (float) _session->frame_rate());
1161
1162         if (negative) {
1163                 snprintf (buf, sizeof (buf), "-%02" PRId32 ":%02" PRId32 ":%02" PRId32 ".%03" PRId32, hrs, mins, secs, millisecs);
1164         } else {
1165                 snprintf (buf, sizeof (buf), " %02" PRId32 ":%02" PRId32 ":%02" PRId32 ".%03" PRId32, hrs, mins, secs, millisecs);
1166         }
1167
1168         _layout->set_text (buf);
1169         set_slave_info();
1170 }
1171
1172 void
1173 AudioClock::set_timecode (framepos_t when, bool /*force*/)
1174 {
1175         Timecode::Time TC;
1176         bool negative = false;
1177
1178         if (_off) {
1179                 _layout->set_text ("\u2012\u2012:\u2012\u2012:\u2012\u2012:\u2012\u2012");
1180                 if (_left_layout) {
1181                         _left_layout->set_text ("");
1182                         _right_layout->set_text ("");
1183                 }
1184
1185                 return;
1186         }
1187
1188         if (when < 0) {
1189                 when = -when;
1190                 negative = true;
1191         }
1192
1193         if (is_duration) {
1194                 _session->timecode_duration (when, TC);
1195         } else {
1196                 _session->timecode_time (when, TC);
1197         }
1198
1199         TC.negative = TC.negative || negative;
1200
1201         _layout->set_text (Timecode::timecode_format_time(TC));
1202
1203         set_slave_info();
1204 }
1205
1206 void
1207 AudioClock::set_bbt (framepos_t when, bool /*force*/)
1208 {
1209         char buf[16];
1210         Timecode::BBT_Time BBT;
1211         bool negative = false;
1212
1213         if (_off) {
1214                 _layout->set_text ("\u2012\u2012\u2012|\u2012\u2012|\u2012\u2012\u2012\u2012");
1215                 if (_left_layout) {
1216                         _left_layout->set_text ("");
1217                         _right_layout->set_text ("");
1218                 }
1219                 return;
1220         }
1221
1222         if (when < 0) {
1223                 when = -when;
1224                 negative = true;
1225         }
1226
1227         /* handle a common case */
1228         if (is_duration) {
1229                 if (when == 0) {
1230                         BBT.bars = 0;
1231                         BBT.beats = 0;
1232                         BBT.ticks = 0;
1233                 } else {
1234                         _session->tempo_map().bbt_time (when, BBT);
1235                         BBT.bars--;
1236                         BBT.beats--;
1237                 }
1238         } else {
1239                 _session->tempo_map().bbt_time (when, BBT);
1240         }
1241
1242         if (negative) {
1243                 snprintf (buf, sizeof (buf), "-%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
1244                           BBT.bars, BBT.beats, BBT.ticks);
1245         } else {
1246                 snprintf (buf, sizeof (buf), " %03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
1247                           BBT.bars, BBT.beats, BBT.ticks);
1248         }
1249
1250         _layout->set_text (buf);
1251
1252         if (_right_layout) {
1253                 framepos_t pos;
1254
1255                 if (bbt_reference_time < 0) {
1256                         pos = when;
1257                 } else {
1258                         pos = bbt_reference_time;
1259                 }
1260
1261                 TempoMetric m (_session->tempo_map().metric_at (pos));
1262
1263                 sprintf (buf, "%-5.2f", m.tempo().beats_per_minute());
1264                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">Tmp <span foreground=\"green\">%2</span></span>",
1265                                         INFO_FONT_SIZE, buf));
1266
1267                 sprintf (buf, "%g/%g", m.meter().divisions_per_bar(), m.meter().note_divisor());
1268                 _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">Mtr <span foreground=\"green\">%2</span></span>",
1269                                         INFO_FONT_SIZE, buf));
1270         }
1271 }
1272
1273 void
1274 AudioClock::set_session (Session *s)
1275 {
1276         SessionHandlePtr::set_session (s);
1277
1278         if (_session) {
1279
1280                 _session->config.ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_configuration_changed, this, _1), gui_context());
1281
1282                 const XMLProperty* prop;
1283                 XMLNode* node = _session->extra_xml (X_("ClockModes"));
1284                 AudioClock::Mode amode;
1285
1286                 if (node) {
1287                         for (XMLNodeList::const_iterator i = node->children().begin(); i != node->children().end(); ++i) {
1288                                 if ((prop = (*i)->property (X_("name"))) && prop->value() == _name) {
1289
1290                                         if ((prop = (*i)->property (X_("mode"))) != 0) {
1291                                                 amode = AudioClock::Mode (string_2_enum (prop->value(), amode));
1292                                                 set_mode (amode);
1293                                         }
1294                                         if ((prop = (*i)->property (X_("on"))) != 0) {
1295                                                 set_off (!string_is_affirmative (prop->value()));
1296                                         }
1297                                         break;
1298                                 }
1299                         }
1300                 }
1301
1302                 set (last_when, true);
1303         }
1304 }
1305
1306 bool
1307 AudioClock::on_key_press_event (GdkEventKey* ev)
1308 {
1309         if (!editing) {
1310                 return false;
1311         }
1312
1313         string new_text;
1314         char new_char = 0;
1315         int highlight_length;
1316         framepos_t pos;
1317
1318         switch (ev->keyval) {
1319         case GDK_0:
1320         case GDK_KP_0:
1321                 new_char = '0';
1322                 break;
1323         case GDK_1:
1324         case GDK_KP_1:
1325                 new_char = '1';
1326                 break;
1327         case GDK_2:
1328         case GDK_KP_2:
1329                 new_char = '2';
1330                 break;
1331         case GDK_3:
1332         case GDK_KP_3:
1333                 new_char = '3';
1334                 break;
1335         case GDK_4:
1336         case GDK_KP_4:
1337                 new_char = '4';
1338                 break;
1339         case GDK_5:
1340         case GDK_KP_5:
1341                 new_char = '5';
1342                 break;
1343         case GDK_6:
1344         case GDK_KP_6:
1345                 new_char = '6';
1346                 break;
1347         case GDK_7:
1348         case GDK_KP_7:
1349                 new_char = '7';
1350                 break;
1351         case GDK_8:
1352         case GDK_KP_8:
1353                 new_char = '8';
1354                 break;
1355         case GDK_9:
1356         case GDK_KP_9:
1357                 new_char = '9';
1358                 break;
1359
1360         case GDK_minus:
1361         case GDK_KP_Subtract:
1362                 if (_negative_allowed && input_string.empty()) {
1363                                 edit_is_negative = true;
1364                 } else {
1365                         end_edit_relative (false);
1366                 }
1367                 return true;
1368                 break;
1369
1370         case GDK_plus:
1371                 end_edit_relative (true);
1372                 return true;
1373                 break;
1374
1375         case GDK_Tab:
1376         case GDK_Return:
1377         case GDK_KP_Enter:
1378                 end_edit (true);
1379                 return true;
1380                 break;
1381
1382         case GDK_Escape:
1383                 end_edit (false);
1384                 ChangeAborted();  /*  EMIT SIGNAL  */
1385                 return true;
1386
1387         case GDK_Delete:
1388         case GDK_BackSpace:
1389                 if (!input_string.empty()) {
1390                         /* delete the last key entered
1391                         */
1392                         input_string = input_string.substr (0, input_string.length() - 1);
1393                 }
1394                 goto use_input_string;
1395
1396         default:
1397                 return false;
1398         }
1399
1400         if (!insert_map.empty() && (input_string.length() >= insert_map.size())) {
1401                 /* too many digits: eat the key event, but do nothing with it */
1402                 return true;
1403         }
1404
1405         input_string.push_back (new_char);
1406
1407   use_input_string:
1408
1409         switch (_mode) {
1410         case Frames:
1411                 /* get this one in the right order, and to the right width */
1412                 if (ev->keyval == GDK_Delete || ev->keyval == GDK_BackSpace) {
1413                         edit_string = edit_string.substr (0, edit_string.length() - 1);
1414                 } else {
1415                         edit_string.push_back (new_char);
1416                 }
1417                 if (!edit_string.empty()) {
1418                         char buf[32];
1419                         sscanf (edit_string.c_str(), "%" PRId64, &pos);
1420                         snprintf (buf, sizeof (buf), " %10" PRId64, pos);
1421                         edit_string = buf;
1422                 }
1423                 /* highlight the whole thing */
1424                 highlight_length = edit_string.length();
1425                 break;
1426
1427         default:
1428                 highlight_length = merge_input_and_edit_string ();
1429         }
1430
1431         show_edit_status (highlight_length);
1432         _layout->set_text (edit_string);
1433         queue_draw ();
1434
1435         return true;
1436 }
1437
1438 int
1439 AudioClock::merge_input_and_edit_string ()
1440 {
1441         /* merge with pre-edit-string into edit string */
1442
1443         edit_string = pre_edit_string;
1444
1445         if (input_string.empty()) {
1446                 return 0;
1447         }
1448
1449         string::size_type target;
1450         for (string::size_type i = 0; i < input_string.length(); ++i) {
1451                 target = insert_map[input_string.length() - 1 - i];
1452                 edit_string[target] = input_string[i];
1453         }
1454         /* highlight from end to wherever the last character was added */
1455         return edit_string.length() - insert_map[input_string.length()-1];
1456 }
1457
1458
1459 bool
1460 AudioClock::on_key_release_event (GdkEventKey *ev)
1461 {
1462         if (!editing) {
1463                 return false;
1464         }
1465
1466         /* return true for keys that we used on press
1467            so that they cannot possibly do double-duty
1468         */
1469         switch (ev->keyval) {
1470         case GDK_0:
1471         case GDK_KP_0:
1472         case GDK_1:
1473         case GDK_KP_1:
1474         case GDK_2:
1475         case GDK_KP_2:
1476         case GDK_3:
1477         case GDK_KP_3:
1478         case GDK_4:
1479         case GDK_KP_4:
1480         case GDK_5:
1481         case GDK_KP_5:
1482         case GDK_6:
1483         case GDK_KP_6:
1484         case GDK_7:
1485         case GDK_KP_7:
1486         case GDK_8:
1487         case GDK_KP_8:
1488         case GDK_9:
1489         case GDK_KP_9:
1490         case GDK_period:
1491         case GDK_comma:
1492         case GDK_KP_Decimal:
1493         case GDK_Tab:
1494         case GDK_Return:
1495         case GDK_KP_Enter:
1496         case GDK_Escape:
1497         case GDK_minus:
1498         case GDK_plus:
1499         case GDK_KP_Add:
1500         case GDK_KP_Subtract:
1501                 return true;
1502         default:
1503                 return false;
1504         }
1505 }
1506
1507 AudioClock::Field
1508 AudioClock::index_to_field (int index) const
1509 {
1510         switch (_mode) {
1511         case Timecode:
1512                 if (index < 4) {
1513                         return Timecode_Hours;
1514                 } else if (index < 7) {
1515                         return Timecode_Minutes;
1516                 } else if (index < 10) {
1517                         return Timecode_Seconds;
1518                 } else {
1519                         return Timecode_Frames;
1520                 }
1521                 break;
1522         case BBT:
1523                 if (index < 5) {
1524                         return Bars;
1525                 } else if (index < 7) {
1526                         return Beats;
1527                 } else {
1528                         return Ticks;
1529                 }
1530                 break;
1531         case MinSec:
1532                 if (index < 3) {
1533                         return Timecode_Hours;
1534                 } else if (index < 6) {
1535                         return MS_Minutes;
1536                 } else if (index < 9) {
1537                         return MS_Seconds;
1538                 } else {
1539                         return MS_Milliseconds;
1540                 }
1541                 break;
1542         case Frames:
1543                 return AudioFrames;
1544                 break;
1545         }
1546
1547         return Field (0);
1548 }
1549
1550 bool
1551 AudioClock::on_button_press_event (GdkEventButton *ev)
1552 {
1553         switch (ev->button) {
1554         case 1:
1555                 if (editable && !_off) {
1556                         int index;
1557                         int trailing;
1558                         int y;
1559                         int x;
1560
1561                         /* the text has been centered vertically, so adjust
1562                          * x and y.
1563                          */
1564                         int xcenter = !_fixed_width || layout_x_offset > corner_radius/4.0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1565
1566                         y = ev->y - ((upper_height - layout_height)/2);
1567                         x = ev->x - layout_x_offset - xcenter;
1568
1569                         if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1570                                 /* pretend it is a character on the far right */
1571                                 index = 99;
1572                         }
1573                         drag_field = index_to_field (index);
1574                         dragging = true;
1575                         /* make absolutely sure that the pointer is grabbed */
1576                         gdk_pointer_grab(ev->window,false ,
1577                                          GdkEventMask( Gdk::POINTER_MOTION_MASK | Gdk::BUTTON_PRESS_MASK |Gdk::BUTTON_RELEASE_MASK),
1578                                          NULL,NULL,ev->time);
1579                         drag_accum = 0;
1580                         drag_start_y = ev->y;
1581                         drag_y = ev->y;
1582                 }
1583                 break;
1584
1585         default:
1586                 return false;
1587                 break;
1588         }
1589
1590         return true;
1591 }
1592
1593 bool
1594 AudioClock::on_button_release_event (GdkEventButton *ev)
1595 {
1596         if (editable && !_off) {
1597                 if (dragging) {
1598                         gdk_pointer_ungrab (GDK_CURRENT_TIME);
1599                         dragging = false;
1600                         if (ev->y > drag_start_y+1 || ev->y < drag_start_y-1 || Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)){
1601                                 // we actually dragged so return without
1602                                 // setting editing focus, or we shift clicked
1603                                 return true;
1604                         } else {
1605                                 if (ev->button == 1) {
1606
1607                                         if (_edit_by_click_field) {
1608
1609                                                 int xcenter = !_fixed_width || layout_x_offset > corner_radius/4.0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1610                                                 int index = 0;
1611                                                 int trailing;
1612                                                 int y = ev->y - ((upper_height - layout_height)/2);
1613                                                 int x = ev->x - layout_x_offset - xcenter;
1614                                                 Field f;
1615
1616                                                 if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1617                                                         return true;
1618                                                 }
1619
1620                                                 f = index_to_field (index);
1621
1622                                                 switch (f) {
1623                                                 case Timecode_Frames:
1624                                                 case MS_Milliseconds:
1625                                                 case Ticks:
1626                                                         f = Field (0);
1627                                                         break;
1628                                                 default:
1629                                                         break;
1630                                                 }
1631                                                 start_edit (f);
1632                                         } else {
1633                                                 start_edit ();
1634                                         }
1635                                 }
1636                         }
1637                 }
1638         }
1639
1640         if (Keyboard::is_context_menu_event (ev)) {
1641                 if (ops_menu == 0) {
1642                         build_ops_menu ();
1643                 }
1644                 ops_menu->popup (1, ev->time);
1645                 return true;
1646         }
1647
1648         return false;
1649 }
1650
1651 bool
1652 AudioClock::on_focus_out_event (GdkEventFocus* ev)
1653 {
1654         bool ret = CairoWidget::on_focus_out_event (ev);
1655
1656         if (editing) {
1657                 end_edit (false);
1658         }
1659
1660         return ret;
1661 }
1662
1663 bool
1664 AudioClock::on_scroll_event (GdkEventScroll *ev)
1665 {
1666         int index;
1667         int trailing;
1668
1669         if (editing || _session == 0 || !editable || _off) {
1670                 return false;
1671         }
1672
1673         int y;
1674         int x;
1675
1676         /* the text has been centered vertically, so adjust
1677          * x and y.
1678          */
1679
1680         int xcenter = !_fixed_width || layout_x_offset > corner_radius/4.0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1681         y = ev->y - ((upper_height - layout_height)/2);
1682         x = ev->x - layout_x_offset - xcenter;
1683
1684         if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1685                 /* not in the main layout */
1686                 return false;
1687         }
1688
1689         Field f = index_to_field (index);
1690         framepos_t frames = 0;
1691
1692         switch (ev->direction) {
1693
1694         case GDK_SCROLL_UP:
1695                 frames = get_frame_step (f);
1696                 if (frames != 0) {
1697                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1698                                 frames *= 10;
1699                         }
1700                         set (current_time() + frames, true);
1701                         ValueChanged (); /* EMIT_SIGNAL */
1702                 }
1703                 break;
1704
1705         case GDK_SCROLL_DOWN:
1706                 frames = get_frame_step (f);
1707                 if (frames != 0) {
1708                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1709                                 frames *= 10;
1710                         }
1711
1712                         if ((double)current_time() - (double)frames < 0.0) {
1713                                 set (0, true);
1714                         } else {
1715                                 set (current_time() - frames, true);
1716                         }
1717
1718                         ValueChanged (); /* EMIT_SIGNAL */
1719                 }
1720                 break;
1721
1722         default:
1723                 return false;
1724                 break;
1725         }
1726
1727         return true;
1728 }
1729
1730 bool
1731 AudioClock::on_motion_notify_event (GdkEventMotion *ev)
1732 {
1733         if (editing || _session == 0 || !dragging) {
1734                 return false;
1735         }
1736
1737         float pixel_frame_scale_factor = 0.2f;
1738
1739         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier))  {
1740                 pixel_frame_scale_factor = 0.1f;
1741         }
1742
1743
1744         if (Keyboard::modifier_state_contains (ev->state,
1745                                                Keyboard::PrimaryModifier|Keyboard::SecondaryModifier)) {
1746
1747                 pixel_frame_scale_factor = 0.025f;
1748         }
1749
1750         double y_delta = ev->y - drag_y;
1751
1752         drag_accum +=  y_delta*pixel_frame_scale_factor;
1753
1754         drag_y = ev->y;
1755
1756         if (trunc (drag_accum) != 0) {
1757
1758                 framepos_t frames;
1759                 framepos_t pos;
1760                 int dir;
1761                 dir = (drag_accum < 0 ? 1:-1);
1762                 pos = current_time();
1763                 frames = get_frame_step (drag_field, pos, dir);
1764
1765                 if (frames  != 0 &&  frames * drag_accum < current_time()) {
1766                         set ((framepos_t) floor (pos - drag_accum * frames), false); // minus because up is negative in GTK
1767                 } else {
1768                         set (0 , false);
1769                 }
1770
1771                 drag_accum= 0;
1772                 ValueChanged();  /* EMIT_SIGNAL */
1773         }
1774
1775         return true;
1776 }
1777
1778 framepos_t
1779 AudioClock::get_frame_step (Field field, framepos_t pos, int dir)
1780 {
1781         framecnt_t f = 0;
1782         Timecode::BBT_Time BBT;
1783         switch (field) {
1784         case Timecode_Hours:
1785                 f = (framecnt_t) floor (3600.0 * _session->frame_rate());
1786                 break;
1787         case Timecode_Minutes:
1788                 f = (framecnt_t) floor (60.0 * _session->frame_rate());
1789                 break;
1790         case Timecode_Seconds:
1791                 f = _session->frame_rate();
1792                 break;
1793         case Timecode_Frames:
1794                 f = (framecnt_t) floor (_session->frame_rate() / _session->timecode_frames_per_second());
1795                 break;
1796
1797         case AudioFrames:
1798                 f = 1;
1799                 break;
1800
1801         case MS_Hours:
1802                 f = (framecnt_t) floor (3600.0 * _session->frame_rate());
1803                 break;
1804         case MS_Minutes:
1805                 f = (framecnt_t) floor (60.0 * _session->frame_rate());
1806                 break;
1807         case MS_Seconds:
1808                 f = (framecnt_t) _session->frame_rate();
1809                 break;
1810         case MS_Milliseconds:
1811                 f = (framecnt_t) floor (_session->frame_rate() / 1000.0);
1812                 break;
1813
1814         case Bars:
1815                 BBT.bars = 1;
1816                 BBT.beats = 0;
1817                 BBT.ticks = 0;
1818                 f = _session->tempo_map().bbt_duration_at (pos,BBT,dir);
1819                 break;
1820         case Beats:
1821                 BBT.bars = 0;
1822                 BBT.beats = 1;
1823                 BBT.ticks = 0;
1824                 f = _session->tempo_map().bbt_duration_at(pos,BBT,dir);
1825                 break;
1826         case Ticks:
1827                 BBT.bars = 0;
1828                 BBT.beats = 0;
1829                 BBT.ticks = 1;
1830                 f = _session->tempo_map().bbt_duration_at(pos,BBT,dir);
1831                 break;
1832         default:
1833                 error << string_compose (_("programming error: %1"), "attempt to get frames from non-text field!") << endmsg;
1834                 f = 0;
1835                 break;
1836         }
1837
1838         return f;
1839 }
1840
1841 framepos_t
1842 AudioClock::current_time (framepos_t) const
1843 {
1844         return last_when;
1845 }
1846
1847 framepos_t
1848 AudioClock::current_duration (framepos_t pos) const
1849 {
1850         framepos_t ret = 0;
1851
1852         switch (_mode) {
1853         case Timecode:
1854                 ret = last_when;
1855                 break;
1856         case BBT:
1857                 ret = frame_duration_from_bbt_string (pos, _layout->get_text());
1858                 break;
1859
1860         case MinSec:
1861                 ret = last_when;
1862                 break;
1863
1864         case Frames:
1865                 ret = last_when;
1866                 break;
1867         }
1868
1869         return ret;
1870 }
1871
1872 bool
1873 AudioClock::bbt_validate_edit (const string& str)
1874 {
1875         AnyTime any;
1876
1877         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &any.bbt.bars, &any.bbt.beats, &any.bbt.ticks) != 3) {
1878                 return false;
1879         }
1880
1881         if (any.bbt.ticks > Timecode::BBT_Time::ticks_per_beat) {
1882                 return false;
1883         }
1884
1885         if (!is_duration && any.bbt.bars == 0) {
1886                 return false;
1887         }
1888
1889         if (!is_duration && any.bbt.beats == 0) {
1890                 return false;
1891         }
1892
1893         return true;
1894 }
1895
1896 bool
1897 AudioClock::timecode_validate_edit (const string&)
1898 {
1899         Timecode::Time TC;
1900
1901         if (sscanf (_layout->get_text().c_str(), "%" PRId32 ":%" PRId32 ":%" PRId32 ":%" PRId32,
1902                     &TC.hours, &TC.minutes, &TC.seconds, &TC.frames) != 4) {
1903                 return false;
1904         }
1905
1906         if (TC.hours > 23U || TC.minutes > 59U || TC.seconds > 59U) {
1907                 return false;
1908         }
1909
1910         if (TC.frames > (uint32_t) rint (_session->timecode_frames_per_second()) - 1) {
1911                 return false;
1912         }
1913
1914         if (_session->timecode_drop_frames()) {
1915                 if (TC.minutes % 10 && TC.seconds == 0U && TC.frames < 2U) {
1916                         return false;
1917                 }
1918         }
1919
1920         return true;
1921 }
1922
1923 bool
1924 AudioClock::minsec_validate_edit (const string& str)
1925 {
1926         int hrs, mins, secs, millisecs;
1927
1928         if (sscanf (str.c_str(), "%d:%d:%d.%d", &hrs, &mins, &secs, &millisecs) != 4) {
1929                 return false;
1930         }
1931
1932         if (hrs > 23 || mins > 59 || secs > 59 || millisecs > 999) {
1933                 return false;
1934         }
1935
1936         return true;
1937 }
1938
1939 framepos_t
1940 AudioClock::frames_from_timecode_string (const string& str) const
1941 {
1942         if (_session == 0) {
1943                 return 0;
1944         }
1945
1946         Timecode::Time TC;
1947         framepos_t sample;
1948
1949         if (sscanf (str.c_str(), "%d:%d:%d:%d", &TC.hours, &TC.minutes, &TC.seconds, &TC.frames) != 4) {
1950                 error << string_compose (_("programming error: %1 %2"), "badly formatted timecode clock string", str) << endmsg;
1951                 return 0;
1952         }
1953
1954         TC.negative = edit_is_negative;
1955         TC.rate = _session->timecode_frames_per_second();
1956         TC.drop= _session->timecode_drop_frames();
1957
1958         _session->timecode_to_sample (TC, sample, false /* use_offset */, false /* use_subframes */ );
1959
1960         // timecode_tester ();
1961
1962         return sample;
1963 }
1964
1965 framepos_t
1966 AudioClock::frames_from_minsec_string (const string& str) const
1967 {
1968         if (_session == 0) {
1969                 return 0;
1970         }
1971
1972         int hrs, mins, secs, millisecs;
1973         framecnt_t sr = _session->frame_rate();
1974
1975         if (sscanf (str.c_str(), "%d:%d:%d.%d", &hrs, &mins, &secs, &millisecs) != 4) {
1976                 error << string_compose (_("programming error: %1 %2"), "badly formatted minsec clock string", str) << endmsg;
1977                 return 0;
1978         }
1979
1980         return (framepos_t) floor ((hrs * 60.0f * 60.0f * sr) + (mins * 60.0f * sr) + (secs * sr) + (millisecs * sr / 1000.0));
1981 }
1982
1983 framepos_t
1984 AudioClock::frames_from_bbt_string (framepos_t pos, const string& str) const
1985 {
1986         if (_session == 0) {
1987                 error << "AudioClock::current_time() called with BBT mode but without session!" << endmsg;
1988                 return 0;
1989         }
1990
1991         AnyTime any;
1992         any.type = AnyTime::BBT;
1993
1994         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &any.bbt.bars, &any.bbt.beats, &any.bbt.ticks) != 3) {
1995                 return 0;
1996         }
1997
1998         if (is_duration) {
1999                 any.bbt.bars++;
2000                 any.bbt.beats++;
2001                 return _session->any_duration_to_frames (pos, any);
2002         } else {
2003                 return _session->convert_to_frames (any);
2004         }
2005 }
2006
2007
2008 framepos_t
2009 AudioClock::frame_duration_from_bbt_string (framepos_t pos, const string& str) const
2010 {
2011         if (_session == 0) {
2012                 error << "AudioClock::current_time() called with BBT mode but without session!" << endmsg;
2013                 return 0;
2014         }
2015
2016         Timecode::BBT_Time bbt;
2017
2018         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &bbt.bars, &bbt.beats, &bbt.ticks) != 3) {
2019                 return 0;
2020         }
2021
2022         return _session->tempo_map().bbt_duration_at(pos,bbt,1);
2023 }
2024
2025 framepos_t
2026 AudioClock::frames_from_audioframes_string (const string& str) const
2027 {
2028         framepos_t f;
2029         sscanf (str.c_str(), "%" PRId64, &f);
2030         return f;
2031 }
2032
2033 void
2034 AudioClock::build_ops_menu ()
2035 {
2036         using namespace Menu_Helpers;
2037         ops_menu = new Menu;
2038         MenuList& ops_items = ops_menu->items();
2039         ops_menu->set_name ("ArdourContextMenu");
2040
2041         if (!Profile->get_sae()) {
2042                 ops_items.push_back (MenuElem (_("Timecode"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), Timecode)));
2043         }
2044         ops_items.push_back (MenuElem (_("Bars:Beats"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), BBT)));
2045         ops_items.push_back (MenuElem (_("Minutes:Seconds"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), MinSec)));
2046         ops_items.push_back (MenuElem (_("Samples"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), Frames)));
2047
2048         if (editable && !_off && !is_duration && !_follows_playhead) {
2049                 ops_items.push_back (SeparatorElem());
2050                 ops_items.push_back (MenuElem (_("Set From Playhead"), sigc::mem_fun(*this, &AudioClock::set_from_playhead)));
2051                 ops_items.push_back (MenuElem (_("Locate to This Time"), sigc::mem_fun(*this, &AudioClock::locate)));
2052         }
2053 }
2054
2055 void
2056 AudioClock::set_from_playhead ()
2057 {
2058         if (!_session) {
2059                 return;
2060         }
2061
2062         set (_session->transport_frame());
2063         ValueChanged ();
2064 }
2065
2066 void
2067 AudioClock::locate ()
2068 {
2069         if (!_session || is_duration) {
2070                 return;
2071         }
2072
2073         _session->request_locate (current_time(), _session->transport_rolling ());
2074 }
2075
2076 void
2077 AudioClock::set_mode (Mode m)
2078 {
2079         if (_mode == m) {
2080                 return;
2081         }
2082
2083         _mode = m;
2084
2085         insert_map.clear();
2086
2087         _layout->set_text ("");
2088
2089         if (_left_layout) {
2090
2091                 _left_layout->set_attributes (info_attributes);
2092                 _right_layout->set_attributes (info_attributes);
2093                 /* adjust info_height according to font size */
2094                 int ignored;
2095                 _left_layout->set_text (" 1234567890");
2096                 _left_layout->get_pixel_size (ignored, info_height);
2097
2098                 _left_layout->set_text ("");
2099                 _right_layout->set_text ("");
2100         }
2101
2102         switch (_mode) {
2103         case Timecode:
2104                 mode_based_info_ratio = 0.5;
2105                 insert_map.push_back (11);
2106                 insert_map.push_back (10);
2107                 insert_map.push_back (8);
2108                 insert_map.push_back (7);
2109                 insert_map.push_back (5);
2110                 insert_map.push_back (4);
2111                 insert_map.push_back (2);
2112                 insert_map.push_back (1);
2113                 break;
2114
2115         case BBT:
2116                 mode_based_info_ratio = 0.5;
2117                 insert_map.push_back (11);
2118                 insert_map.push_back (10);
2119                 insert_map.push_back (9);
2120                 insert_map.push_back (8);
2121                 insert_map.push_back (6);
2122                 insert_map.push_back (5);
2123                 insert_map.push_back (3);
2124                 insert_map.push_back (2);
2125                 insert_map.push_back (1);
2126                 break;
2127
2128         case MinSec:
2129                 mode_based_info_ratio = 0.5;
2130                 insert_map.push_back (12);
2131                 insert_map.push_back (11);
2132                 insert_map.push_back (10);
2133                 insert_map.push_back (8);
2134                 insert_map.push_back (7);
2135                 insert_map.push_back (5);
2136                 insert_map.push_back (4);
2137                 insert_map.push_back (2);
2138                 insert_map.push_back (1);
2139                 break;
2140
2141         case Frames:
2142                 mode_based_info_ratio = 0.5;
2143                 break;
2144         }
2145
2146         set (last_when, true);
2147
2148         if (!is_transient) {
2149                 ModeChanged (); /* EMIT SIGNAL (the static one)*/
2150         }
2151
2152         if (!_fixed_width) {
2153                 /* display is different, allow us to resize */
2154                 first_width = 0;
2155                 first_height = 0;
2156                 queue_resize ();
2157         }
2158
2159         mode_changed (); /* EMIT SIGNAL (the member one) */
2160 }
2161
2162 void
2163 AudioClock::set_bbt_reference (framepos_t pos)
2164 {
2165         bbt_reference_time = pos;
2166 }
2167
2168 void
2169 AudioClock::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
2170 {
2171         CairoWidget::on_style_changed (old_style);
2172         first_width = 0;
2173         first_height = 0;
2174         set_font ();
2175         set_colors ();
2176 }
2177
2178 void
2179 AudioClock::set_editable (bool yn)
2180 {
2181         editable = yn;
2182 }
2183
2184 void
2185 AudioClock::set_is_duration (bool yn)
2186 {
2187         if (yn == is_duration) {
2188                 return;
2189         }
2190
2191         is_duration = yn;
2192         set (last_when, true);
2193 }
2194
2195 void
2196 AudioClock::set_off (bool yn)
2197 {
2198         if (_off == yn) {
2199                 return;
2200         }
2201
2202         _off = yn;
2203
2204         /* force a redraw. last_when will be preserved, but the clock text will
2205          * change
2206          */
2207
2208         set (last_when, true);
2209 }
2210
2211 void
2212 AudioClock::focus ()
2213 {
2214         start_edit (Field (0));
2215 }
2216
2217 void
2218 AudioClock::set_corner_radius (double r)
2219 {
2220         corner_radius = r;
2221         first_width = 0;
2222         first_height = 0;
2223         queue_resize ();
2224 }
2225
2226 void
2227 AudioClock::set_fixed_width (bool yn)
2228 {
2229         _fixed_width = yn;
2230 }
2231
2232 void
2233 AudioClock::dpi_reset ()
2234 {
2235         /* force recomputation of size even if we are fixed width
2236          */
2237         first_width = 0;
2238         first_height = 0;
2239         queue_resize ();
2240 }
2241
2242 void
2243 AudioClock::set_negative_allowed (bool yn)
2244 {
2245         _negative_allowed = yn;
2246 }