update BPM and Meter when changed, also change back labels for it.
[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(), 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 > 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);
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,
336                                                         h, 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;
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 > 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 || _negative_allowed) {
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_property_changed (const PropertyChange& p)
934 {
935         set (last_when, true);
936 }
937
938 void
939 AudioClock::session_configuration_changed (std::string p)
940 {
941         if (_negative_allowed) {
942                 /* session option editor clock */
943                 return;
944         }
945
946         if (p == "sync-source" || p == "external-sync") {
947                 set (current_time(), true);
948                 return;
949         }
950
951         if (p != "timecode-offset" && p != "timecode-offset-negative") {
952                 return;
953         }
954
955         framecnt_t current;
956
957         switch (_mode) {
958         case Timecode:
959                 if (is_duration) {
960                         current = current_duration ();
961                 } else {
962                         current = current_time ();
963                 }
964                 set (current, true);
965                 break;
966         default:
967                 break;
968         }
969 }
970
971 void
972 AudioClock::set (framepos_t when, bool force, framecnt_t offset)
973 {
974         if ((!force && !is_visible()) || _session == 0) {
975                 return;
976         }
977
978         if (is_duration) {
979                 when = when - offset;
980         }
981
982         if (when == last_when && !force) {
983                 if (_mode != Timecode && _mode != MinSec) {
984                         /* may need to force display of TC source
985                          * time, so don't return early.
986                          */
987                         return;
988                 }
989         }
990
991         if (!editing) {
992                 if (_right_layout) {
993                         _right_layout->set_alignment(Pango::ALIGN_LEFT);
994                 }
995
996                 switch (_mode) {
997                 case Timecode:
998                         if (_right_layout) {
999                                 _right_layout->set_alignment(Pango::ALIGN_RIGHT);
1000                         }
1001                         set_timecode (when, force);
1002                         break;
1003
1004                 case BBT:
1005                         set_bbt (when, force);
1006                         break;
1007
1008                 case MinSec:
1009                         if (_right_layout) {
1010                                 _right_layout->set_alignment(Pango::ALIGN_RIGHT);
1011                         }
1012                         set_minsec (when, force);
1013                         break;
1014
1015                 case Frames:
1016                         set_frames (when, force);
1017                         break;
1018                 }
1019         }
1020
1021         queue_draw ();
1022         last_when = when;
1023 }
1024
1025 void
1026 AudioClock::set_slave_info ()
1027 {
1028         if (!_left_layout || !_right_layout) {
1029                 return;
1030         }
1031
1032         SyncSource sync_src = Config->get_sync_source();
1033
1034         if (_session->config.get_external_sync()) {
1035                 Slave* slave = _session->slave();
1036
1037                 switch (sync_src) {
1038                 case JACK:
1039                         _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1040                                                 INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1041                         _right_layout->set_text ("");
1042                         break;
1043                 case MIDIClock:
1044                         if (slave) {
1045                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1046                                                         INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1047                                 _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1048                                                         INFO_FONT_SIZE, slave->approximate_current_delta()));
1049                         } else {
1050                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1051                                                         INFO_FONT_SIZE, _("--pending--")));
1052                                 _right_layout->set_text ("");
1053                         }
1054                         break;
1055                 case LTC:
1056                 case MTC:
1057                         if (slave) {
1058                                 bool matching;
1059                                 TimecodeSlave* tcslave;
1060                                 if ((tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
1061                                         matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
1062                                         _left_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2</span><span foreground=\"%3\">%4</span></span>",
1063                                                                                   INFO_FONT_SIZE, sync_source_to_string(sync_src, true)[0], (matching?"green":"red"),
1064                                                                                   dynamic_cast<TimecodeSlave*>(slave)->approximate_current_position()));
1065                                         _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1066                                                                                    INFO_FONT_SIZE, slave->approximate_current_delta()));
1067                                 }
1068                         } else {
1069                                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">%2</span>",
1070                                                         INFO_FONT_SIZE, _("--pending--")));
1071                                 _right_layout->set_text ("");
1072                         }
1073                         break;
1074                 }
1075         } else {
1076                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">INT/%2</span>",
1077                                         INFO_FONT_SIZE, sync_source_to_string(sync_src, true)));
1078                 _right_layout->set_text ("");
1079         }
1080 }
1081
1082 void
1083 AudioClock::set_frames (framepos_t when, bool /*force*/)
1084 {
1085         char buf[32];
1086         bool negative = false;
1087
1088         if (_off) {
1089                 _layout->set_text ("\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012\u2012");
1090
1091                 if (_left_layout) {
1092                         _left_layout->set_text ("");
1093                         _right_layout->set_text ("");
1094                 }
1095
1096                 return;
1097         }
1098
1099         if (when < 0) {
1100                 when = -when;
1101                 negative = true;
1102         }
1103
1104         if (negative) {
1105                 snprintf (buf, sizeof (buf), "-%10" PRId64, when);
1106         } else {
1107                 snprintf (buf, sizeof (buf), " %10" PRId64, when);
1108         }
1109
1110         _layout->set_text (buf);
1111
1112         if (_left_layout) {
1113                 framecnt_t rate = _session->frame_rate();
1114
1115                 if (fmod (rate, 100.0) == 0.0) {
1116                         sprintf (buf, "%.1fkHz", rate/1000.0);
1117                 } else {
1118                         sprintf (buf, "%" PRId64 "Hz", rate);
1119                 }
1120
1121                 _left_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2 </span><span foreground=\"green\">%3</span></span>",
1122                                 INFO_FONT_SIZE, _("SR"), buf));
1123
1124                 float vid_pullup = _session->config.get_video_pullup();
1125
1126                 if (vid_pullup == 0.0) {
1127                         _right_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2 </span><span foreground=\"green\">off</span></span>",
1128                                         INFO_FONT_SIZE, _("Pull")));
1129                 } else {
1130                         sprintf (buf, _("%+.4f%%"), vid_pullup);
1131                         _right_layout->set_markup (string_compose ("<span size=\"%1\"><span foreground=\"white\">%2 </span><span foreground=\"green\">%3</span></span>",
1132                                         INFO_FONT_SIZE, _("Pull"), buf));
1133                 }
1134         }
1135 }
1136
1137 void
1138 AudioClock::set_minsec (framepos_t when, bool /*force*/)
1139 {
1140         char buf[32];
1141         framecnt_t left;
1142         int hrs;
1143         int mins;
1144         int secs;
1145         int millisecs;
1146         bool negative = false;
1147
1148         if (_off) {
1149                 _layout->set_text ("\u2012\u2012:\u2012\u2012:\u2012\u2012.\u2012\u2012\u2012");
1150
1151                 if (_left_layout) {
1152                         _left_layout->set_text ("");
1153                         _right_layout->set_text ("");
1154                 }
1155
1156                 return;
1157         }
1158
1159         if (when < 0) {
1160                 when = -when;
1161                 negative = true;
1162         }
1163
1164         left = when;
1165         hrs = (int) floor (left / (_session->frame_rate() * 60.0f * 60.0f));
1166         left -= (framecnt_t) floor (hrs * _session->frame_rate() * 60.0f * 60.0f);
1167         mins = (int) floor (left / (_session->frame_rate() * 60.0f));
1168         left -= (framecnt_t) floor (mins * _session->frame_rate() * 60.0f);
1169         secs = (int) floor (left / (float) _session->frame_rate());
1170         left -= (framecnt_t) floor (secs * _session->frame_rate());
1171         millisecs = floor (left * 1000.0 / (float) _session->frame_rate());
1172
1173         if (negative) {
1174                 snprintf (buf, sizeof (buf), "-%02" PRId32 ":%02" PRId32 ":%02" PRId32 ".%03" PRId32, hrs, mins, secs, millisecs);
1175         } else {
1176                 snprintf (buf, sizeof (buf), " %02" PRId32 ":%02" PRId32 ":%02" PRId32 ".%03" PRId32, hrs, mins, secs, millisecs);
1177         }
1178
1179         _layout->set_text (buf);
1180         set_slave_info();
1181 }
1182
1183 void
1184 AudioClock::set_timecode (framepos_t when, bool /*force*/)
1185 {
1186         Timecode::Time TC;
1187         bool negative = false;
1188
1189         if (_off) {
1190                 _layout->set_text ("\u2012\u2012:\u2012\u2012:\u2012\u2012:\u2012\u2012");
1191                 if (_left_layout) {
1192                         _left_layout->set_text ("");
1193                         _right_layout->set_text ("");
1194                 }
1195
1196                 return;
1197         }
1198
1199         if (when < 0) {
1200                 when = -when;
1201                 negative = true;
1202         }
1203
1204         if (is_duration) {
1205                 _session->timecode_duration (when, TC);
1206         } else {
1207                 _session->timecode_time (when, TC);
1208         }
1209
1210         TC.negative = TC.negative || negative;
1211
1212         _layout->set_text (Timecode::timecode_format_time(TC));
1213
1214         set_slave_info();
1215 }
1216
1217 void
1218 AudioClock::set_bbt (framepos_t when, bool /*force*/)
1219 {
1220         char buf[16];
1221         Timecode::BBT_Time BBT;
1222         bool negative = false;
1223
1224         if (_off) {
1225                 _layout->set_text ("\u2012\u2012\u2012|\u2012\u2012|\u2012\u2012\u2012\u2012");
1226                 if (_left_layout) {
1227                         _left_layout->set_text ("");
1228                         _right_layout->set_text ("");
1229                 }
1230                 return;
1231         }
1232
1233         if (when < 0) {
1234                 when = -when;
1235                 negative = true;
1236         }
1237
1238         /* handle a common case */
1239         if (is_duration) {
1240                 if (when == 0) {
1241                         BBT.bars = 0;
1242                         BBT.beats = 0;
1243                         BBT.ticks = 0;
1244                 } else {
1245                         _session->tempo_map().bbt_time (when, BBT);
1246                         BBT.bars--;
1247                         BBT.beats--;
1248                 }
1249         } else {
1250                 _session->tempo_map().bbt_time (when, BBT);
1251         }
1252
1253         if (negative) {
1254                 snprintf (buf, sizeof (buf), "-%03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
1255                           BBT.bars, BBT.beats, BBT.ticks);
1256         } else {
1257                 snprintf (buf, sizeof (buf), " %03" PRIu32 BBT_BAR_CHAR "%02" PRIu32 BBT_BAR_CHAR "%04" PRIu32,
1258                           BBT.bars, BBT.beats, BBT.ticks);
1259         }
1260
1261         _layout->set_text (buf);
1262
1263         if (_right_layout) {
1264                 framepos_t pos;
1265
1266                 if (bbt_reference_time < 0) {
1267                         pos = when;
1268                 } else {
1269                         pos = bbt_reference_time;
1270                 }
1271
1272                 TempoMetric m (_session->tempo_map().metric_at (pos));
1273
1274                 sprintf (buf, "%-5.2f", m.tempo().beats_per_minute());
1275                 _left_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">Tempo <span foreground=\"green\">%2</span></span>",
1276                                         INFO_FONT_SIZE, buf));
1277
1278                 sprintf (buf, "%g/%g", m.meter().divisions_per_bar(), m.meter().note_divisor());
1279                 _right_layout->set_markup (string_compose ("<span size=\"%1\" foreground=\"white\">Meter <span foreground=\"green\">%2</span></span>",
1280                                         INFO_FONT_SIZE, buf));
1281         }
1282 }
1283
1284 void
1285 AudioClock::set_session (Session *s)
1286 {
1287         SessionHandlePtr::set_session (s);
1288
1289         if (_session) {
1290
1291                 _session->config.ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_configuration_changed, this, _1), gui_context());
1292                 _session->tempo_map().PropertyChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_property_changed, this, _1), gui_context());
1293
1294                 const XMLProperty* prop;
1295                 XMLNode* node = _session->extra_xml (X_("ClockModes"));
1296                 AudioClock::Mode amode;
1297
1298                 if (node) {
1299                         for (XMLNodeList::const_iterator i = node->children().begin(); i != node->children().end(); ++i) {
1300                                 if ((prop = (*i)->property (X_("name"))) && prop->value() == _name) {
1301
1302                                         if ((prop = (*i)->property (X_("mode"))) != 0) {
1303                                                 amode = AudioClock::Mode (string_2_enum (prop->value(), amode));
1304                                                 set_mode (amode);
1305                                         }
1306                                         if ((prop = (*i)->property (X_("on"))) != 0) {
1307                                                 set_off (!string_is_affirmative (prop->value()));
1308                                         }
1309                                         break;
1310                                 }
1311                         }
1312                 }
1313
1314                 set (last_when, true);
1315         }
1316 }
1317
1318 bool
1319 AudioClock::on_key_press_event (GdkEventKey* ev)
1320 {
1321         if (!editing) {
1322                 return false;
1323         }
1324
1325         string new_text;
1326         char new_char = 0;
1327         int highlight_length;
1328         framepos_t pos;
1329
1330         switch (ev->keyval) {
1331         case GDK_0:
1332         case GDK_KP_0:
1333                 new_char = '0';
1334                 break;
1335         case GDK_1:
1336         case GDK_KP_1:
1337                 new_char = '1';
1338                 break;
1339         case GDK_2:
1340         case GDK_KP_2:
1341                 new_char = '2';
1342                 break;
1343         case GDK_3:
1344         case GDK_KP_3:
1345                 new_char = '3';
1346                 break;
1347         case GDK_4:
1348         case GDK_KP_4:
1349                 new_char = '4';
1350                 break;
1351         case GDK_5:
1352         case GDK_KP_5:
1353                 new_char = '5';
1354                 break;
1355         case GDK_6:
1356         case GDK_KP_6:
1357                 new_char = '6';
1358                 break;
1359         case GDK_7:
1360         case GDK_KP_7:
1361                 new_char = '7';
1362                 break;
1363         case GDK_8:
1364         case GDK_KP_8:
1365                 new_char = '8';
1366                 break;
1367         case GDK_9:
1368         case GDK_KP_9:
1369                 new_char = '9';
1370                 break;
1371
1372         case GDK_minus:
1373         case GDK_KP_Subtract:
1374                 if (_negative_allowed && input_string.empty()) {
1375                                 edit_is_negative = true;
1376                 } else {
1377                         end_edit_relative (false);
1378                 }
1379                 return true;
1380                 break;
1381
1382         case GDK_plus:
1383                 end_edit_relative (true);
1384                 return true;
1385                 break;
1386
1387         case GDK_Tab:
1388         case GDK_Return:
1389         case GDK_KP_Enter:
1390                 end_edit (true);
1391                 return true;
1392                 break;
1393
1394         case GDK_Escape:
1395                 end_edit (false);
1396                 ChangeAborted();  /*  EMIT SIGNAL  */
1397                 return true;
1398
1399         case GDK_Delete:
1400         case GDK_BackSpace:
1401                 if (!input_string.empty()) {
1402                         /* delete the last key entered
1403                         */
1404                         input_string = input_string.substr (0, input_string.length() - 1);
1405                 }
1406                 goto use_input_string;
1407
1408         default:
1409                 return false;
1410         }
1411
1412         if (!insert_map.empty() && (input_string.length() >= insert_map.size())) {
1413                 /* too many digits: eat the key event, but do nothing with it */
1414                 return true;
1415         }
1416
1417         input_string.push_back (new_char);
1418
1419   use_input_string:
1420
1421         switch (_mode) {
1422         case Frames:
1423                 /* get this one in the right order, and to the right width */
1424                 if (ev->keyval == GDK_Delete || ev->keyval == GDK_BackSpace) {
1425                         edit_string = edit_string.substr (0, edit_string.length() - 1);
1426                 } else {
1427                         edit_string.push_back (new_char);
1428                 }
1429                 if (!edit_string.empty()) {
1430                         char buf[32];
1431                         sscanf (edit_string.c_str(), "%" PRId64, &pos);
1432                         snprintf (buf, sizeof (buf), " %10" PRId64, pos);
1433                         edit_string = buf;
1434                 }
1435                 /* highlight the whole thing */
1436                 highlight_length = edit_string.length();
1437                 break;
1438
1439         default:
1440                 highlight_length = merge_input_and_edit_string ();
1441         }
1442
1443         show_edit_status (highlight_length);
1444         _layout->set_text (edit_string);
1445         queue_draw ();
1446
1447         return true;
1448 }
1449
1450 int
1451 AudioClock::merge_input_and_edit_string ()
1452 {
1453         /* merge with pre-edit-string into edit string */
1454
1455         edit_string = pre_edit_string;
1456
1457         if (input_string.empty()) {
1458                 return 0;
1459         }
1460
1461         string::size_type target;
1462         for (string::size_type i = 0; i < input_string.length(); ++i) {
1463                 target = insert_map[input_string.length() - 1 - i];
1464                 edit_string[target] = input_string[i];
1465         }
1466         /* highlight from end to wherever the last character was added */
1467         return edit_string.length() - insert_map[input_string.length()-1];
1468 }
1469
1470
1471 bool
1472 AudioClock::on_key_release_event (GdkEventKey *ev)
1473 {
1474         if (!editing) {
1475                 return false;
1476         }
1477
1478         /* return true for keys that we used on press
1479            so that they cannot possibly do double-duty
1480         */
1481         switch (ev->keyval) {
1482         case GDK_0:
1483         case GDK_KP_0:
1484         case GDK_1:
1485         case GDK_KP_1:
1486         case GDK_2:
1487         case GDK_KP_2:
1488         case GDK_3:
1489         case GDK_KP_3:
1490         case GDK_4:
1491         case GDK_KP_4:
1492         case GDK_5:
1493         case GDK_KP_5:
1494         case GDK_6:
1495         case GDK_KP_6:
1496         case GDK_7:
1497         case GDK_KP_7:
1498         case GDK_8:
1499         case GDK_KP_8:
1500         case GDK_9:
1501         case GDK_KP_9:
1502         case GDK_period:
1503         case GDK_comma:
1504         case GDK_KP_Decimal:
1505         case GDK_Tab:
1506         case GDK_Return:
1507         case GDK_KP_Enter:
1508         case GDK_Escape:
1509         case GDK_minus:
1510         case GDK_plus:
1511         case GDK_KP_Add:
1512         case GDK_KP_Subtract:
1513                 return true;
1514         default:
1515                 return false;
1516         }
1517 }
1518
1519 AudioClock::Field
1520 AudioClock::index_to_field (int index) const
1521 {
1522         switch (_mode) {
1523         case Timecode:
1524                 if (index < 4) {
1525                         return Timecode_Hours;
1526                 } else if (index < 7) {
1527                         return Timecode_Minutes;
1528                 } else if (index < 10) {
1529                         return Timecode_Seconds;
1530                 } else {
1531                         return Timecode_Frames;
1532                 }
1533                 break;
1534         case BBT:
1535                 if (index < 5) {
1536                         return Bars;
1537                 } else if (index < 7) {
1538                         return Beats;
1539                 } else {
1540                         return Ticks;
1541                 }
1542                 break;
1543         case MinSec:
1544                 if (index < 3) {
1545                         return Timecode_Hours;
1546                 } else if (index < 6) {
1547                         return MS_Minutes;
1548                 } else if (index < 9) {
1549                         return MS_Seconds;
1550                 } else {
1551                         return MS_Milliseconds;
1552                 }
1553                 break;
1554         case Frames:
1555                 return AudioFrames;
1556                 break;
1557         }
1558
1559         return Field (0);
1560 }
1561
1562 bool
1563 AudioClock::on_button_press_event (GdkEventButton *ev)
1564 {
1565         switch (ev->button) {
1566         case 1:
1567                 if (editable && !_off) {
1568                         int index;
1569                         int trailing;
1570                         int y;
1571                         int x;
1572
1573                         /* the text has been centered vertically, so adjust
1574                          * x and y.
1575                          */
1576                         int xcenter = !_fixed_width || layout_x_offset > 0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1577
1578                         y = ev->y - ((upper_height - layout_height)/2);
1579                         x = ev->x - layout_x_offset - xcenter;
1580
1581                         if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1582                                 /* pretend it is a character on the far right */
1583                                 index = 99;
1584                         }
1585                         drag_field = index_to_field (index);
1586                         dragging = true;
1587                         /* make absolutely sure that the pointer is grabbed */
1588                         gdk_pointer_grab(ev->window,false ,
1589                                          GdkEventMask( Gdk::POINTER_MOTION_MASK | Gdk::BUTTON_PRESS_MASK |Gdk::BUTTON_RELEASE_MASK),
1590                                          NULL,NULL,ev->time);
1591                         drag_accum = 0;
1592                         drag_start_y = ev->y;
1593                         drag_y = ev->y;
1594                 }
1595                 break;
1596
1597         default:
1598                 return false;
1599                 break;
1600         }
1601
1602         return true;
1603 }
1604
1605 bool
1606 AudioClock::on_button_release_event (GdkEventButton *ev)
1607 {
1608         if (editable && !_off) {
1609                 if (dragging) {
1610                         gdk_pointer_ungrab (GDK_CURRENT_TIME);
1611                         dragging = false;
1612                         if (ev->y > drag_start_y+1 || ev->y < drag_start_y-1 || Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)){
1613                                 // we actually dragged so return without
1614                                 // setting editing focus, or we shift clicked
1615                                 return true;
1616                         } else {
1617                                 if (ev->button == 1) {
1618
1619                                         if (_edit_by_click_field) {
1620
1621                                                 int xcenter = !_fixed_width || layout_x_offset > 0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1622                                                 int index = 0;
1623                                                 int trailing;
1624                                                 int y = ev->y - ((upper_height - layout_height)/2);
1625                                                 int x = ev->x - layout_x_offset - xcenter;
1626                                                 Field f;
1627
1628                                                 if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1629                                                         return true;
1630                                                 }
1631
1632                                                 f = index_to_field (index);
1633
1634                                                 switch (f) {
1635                                                 case Timecode_Frames:
1636                                                 case MS_Milliseconds:
1637                                                 case Ticks:
1638                                                         f = Field (0);
1639                                                         break;
1640                                                 default:
1641                                                         break;
1642                                                 }
1643                                                 start_edit (f);
1644                                         } else {
1645                                                 start_edit ();
1646                                         }
1647                                 }
1648                         }
1649                 }
1650         }
1651
1652         if (Keyboard::is_context_menu_event (ev)) {
1653                 if (ops_menu == 0) {
1654                         build_ops_menu ();
1655                 }
1656                 ops_menu->popup (1, ev->time);
1657                 return true;
1658         }
1659
1660         return false;
1661 }
1662
1663 bool
1664 AudioClock::on_focus_out_event (GdkEventFocus* ev)
1665 {
1666         bool ret = CairoWidget::on_focus_out_event (ev);
1667
1668         if (editing) {
1669                 end_edit (false);
1670         }
1671
1672         return ret;
1673 }
1674
1675 bool
1676 AudioClock::on_scroll_event (GdkEventScroll *ev)
1677 {
1678         int index;
1679         int trailing;
1680
1681         if (editing || _session == 0 || !editable || _off) {
1682                 return false;
1683         }
1684
1685         int y;
1686         int x;
1687
1688         /* the text has been centered vertically, so adjust
1689          * x and y.
1690          */
1691
1692         int xcenter = !_fixed_width || layout_x_offset > 0 ? 0 : (get_width() - _mode_width[_mode]) /2;
1693         y = ev->y - ((upper_height - layout_height)/2);
1694         x = ev->x - layout_x_offset - xcenter;
1695
1696         if (!_layout->xy_to_index (x * PANGO_SCALE, y * PANGO_SCALE, index, trailing)) {
1697                 /* not in the main layout */
1698                 return false;
1699         }
1700
1701         Field f = index_to_field (index);
1702         framepos_t frames = 0;
1703
1704         switch (ev->direction) {
1705
1706         case GDK_SCROLL_UP:
1707                 frames = get_frame_step (f);
1708                 if (frames != 0) {
1709                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1710                                 frames *= 10;
1711                         }
1712                         set (current_time() + frames, true);
1713                         ValueChanged (); /* EMIT_SIGNAL */
1714                 }
1715                 break;
1716
1717         case GDK_SCROLL_DOWN:
1718                 frames = get_frame_step (f);
1719                 if (frames != 0) {
1720                         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier)) {
1721                                 frames *= 10;
1722                         }
1723
1724                         if ((double)current_time() - (double)frames < 0.0) {
1725                                 set (0, true);
1726                         } else {
1727                                 set (current_time() - frames, true);
1728                         }
1729
1730                         ValueChanged (); /* EMIT_SIGNAL */
1731                 }
1732                 break;
1733
1734         default:
1735                 return false;
1736                 break;
1737         }
1738
1739         return true;
1740 }
1741
1742 bool
1743 AudioClock::on_motion_notify_event (GdkEventMotion *ev)
1744 {
1745         if (editing || _session == 0 || !dragging) {
1746                 return false;
1747         }
1748
1749         float pixel_frame_scale_factor = 0.2f;
1750
1751         if (Keyboard::modifier_state_equals (ev->state, Keyboard::PrimaryModifier))  {
1752                 pixel_frame_scale_factor = 0.1f;
1753         }
1754
1755
1756         if (Keyboard::modifier_state_contains (ev->state,
1757                                                Keyboard::PrimaryModifier|Keyboard::SecondaryModifier)) {
1758
1759                 pixel_frame_scale_factor = 0.025f;
1760         }
1761
1762         double y_delta = ev->y - drag_y;
1763
1764         drag_accum +=  y_delta*pixel_frame_scale_factor;
1765
1766         drag_y = ev->y;
1767
1768         if (trunc (drag_accum) != 0) {
1769
1770                 framepos_t frames;
1771                 framepos_t pos;
1772                 int dir;
1773                 dir = (drag_accum < 0 ? 1:-1);
1774                 pos = current_time();
1775                 frames = get_frame_step (drag_field, pos, dir);
1776
1777                 if (frames  != 0 &&  frames * drag_accum < current_time()) {
1778                         set ((framepos_t) floor (pos - drag_accum * frames), false); // minus because up is negative in GTK
1779                 } else {
1780                         set (0 , false);
1781                 }
1782
1783                 drag_accum= 0;
1784                 ValueChanged();  /* EMIT_SIGNAL */
1785         }
1786
1787         return true;
1788 }
1789
1790 framepos_t
1791 AudioClock::get_frame_step (Field field, framepos_t pos, int dir)
1792 {
1793         framecnt_t f = 0;
1794         Timecode::BBT_Time BBT;
1795         switch (field) {
1796         case Timecode_Hours:
1797                 f = (framecnt_t) floor (3600.0 * _session->frame_rate());
1798                 break;
1799         case Timecode_Minutes:
1800                 f = (framecnt_t) floor (60.0 * _session->frame_rate());
1801                 break;
1802         case Timecode_Seconds:
1803                 f = _session->frame_rate();
1804                 break;
1805         case Timecode_Frames:
1806                 f = (framecnt_t) floor (_session->frame_rate() / _session->timecode_frames_per_second());
1807                 break;
1808
1809         case AudioFrames:
1810                 f = 1;
1811                 break;
1812
1813         case MS_Hours:
1814                 f = (framecnt_t) floor (3600.0 * _session->frame_rate());
1815                 break;
1816         case MS_Minutes:
1817                 f = (framecnt_t) floor (60.0 * _session->frame_rate());
1818                 break;
1819         case MS_Seconds:
1820                 f = (framecnt_t) _session->frame_rate();
1821                 break;
1822         case MS_Milliseconds:
1823                 f = (framecnt_t) floor (_session->frame_rate() / 1000.0);
1824                 break;
1825
1826         case Bars:
1827                 BBT.bars = 1;
1828                 BBT.beats = 0;
1829                 BBT.ticks = 0;
1830                 f = _session->tempo_map().bbt_duration_at (pos,BBT,dir);
1831                 break;
1832         case Beats:
1833                 BBT.bars = 0;
1834                 BBT.beats = 1;
1835                 BBT.ticks = 0;
1836                 f = _session->tempo_map().bbt_duration_at(pos,BBT,dir);
1837                 break;
1838         case Ticks:
1839                 BBT.bars = 0;
1840                 BBT.beats = 0;
1841                 BBT.ticks = 1;
1842                 f = _session->tempo_map().bbt_duration_at(pos,BBT,dir);
1843                 break;
1844         default:
1845                 error << string_compose (_("programming error: %1"), "attempt to get frames from non-text field!") << endmsg;
1846                 f = 0;
1847                 break;
1848         }
1849
1850         return f;
1851 }
1852
1853 framepos_t
1854 AudioClock::current_time (framepos_t) const
1855 {
1856         return last_when;
1857 }
1858
1859 framepos_t
1860 AudioClock::current_duration (framepos_t pos) const
1861 {
1862         framepos_t ret = 0;
1863
1864         switch (_mode) {
1865         case Timecode:
1866                 ret = last_when;
1867                 break;
1868         case BBT:
1869                 ret = frame_duration_from_bbt_string (pos, _layout->get_text());
1870                 break;
1871
1872         case MinSec:
1873                 ret = last_when;
1874                 break;
1875
1876         case Frames:
1877                 ret = last_when;
1878                 break;
1879         }
1880
1881         return ret;
1882 }
1883
1884 bool
1885 AudioClock::bbt_validate_edit (const string& str)
1886 {
1887         AnyTime any;
1888
1889         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &any.bbt.bars, &any.bbt.beats, &any.bbt.ticks) != 3) {
1890                 return false;
1891         }
1892
1893         if (any.bbt.ticks > Timecode::BBT_Time::ticks_per_beat) {
1894                 return false;
1895         }
1896
1897         if (!is_duration && any.bbt.bars == 0) {
1898                 return false;
1899         }
1900
1901         if (!is_duration && any.bbt.beats == 0) {
1902                 return false;
1903         }
1904
1905         return true;
1906 }
1907
1908 bool
1909 AudioClock::timecode_validate_edit (const string&)
1910 {
1911         Timecode::Time TC;
1912         int hours;
1913         char ignored[2];
1914
1915         if (sscanf (_layout->get_text().c_str(), "%" PRId32 ":%" PRId32 ":%" PRId32 "%[:;]%" PRId32,
1916                     &hours, &TC.minutes, &TC.seconds, ignored, &TC.frames) != 5) {
1917                 return false;
1918         }
1919
1920         if (hours < 0) {
1921                 TC.hours = hours * -1;
1922                 TC.negative = true;
1923         } else {
1924                 TC.hours = hours;
1925                 TC.negative = false;
1926         }
1927
1928         if (TC.negative && !_negative_allowed) {
1929                 return false;
1930         }
1931
1932         if (TC.hours > 23U || TC.minutes > 59U || TC.seconds > 59U) {
1933                 return false;
1934         }
1935
1936         if (TC.frames > (uint32_t) rint (_session->timecode_frames_per_second()) - 1) {
1937                 return false;
1938         }
1939
1940         if (_session->timecode_drop_frames()) {
1941                 if (TC.minutes % 10 && TC.seconds == 0U && TC.frames < 2U) {
1942                         return false;
1943                 }
1944         }
1945
1946         return true;
1947 }
1948
1949 bool
1950 AudioClock::minsec_validate_edit (const string& str)
1951 {
1952         int hrs, mins, secs, millisecs;
1953
1954         if (sscanf (str.c_str(), "%d:%d:%d.%d", &hrs, &mins, &secs, &millisecs) != 4) {
1955                 return false;
1956         }
1957
1958         if (hrs > 23 || mins > 59 || secs > 59 || millisecs > 999) {
1959                 return false;
1960         }
1961
1962         return true;
1963 }
1964
1965 framepos_t
1966 AudioClock::frames_from_timecode_string (const string& str) const
1967 {
1968         if (_session == 0) {
1969                 return 0;
1970         }
1971
1972         Timecode::Time TC;
1973         framepos_t sample;
1974         char ignored[2];
1975         int hours;
1976
1977         if (sscanf (str.c_str(), "%d:%d:%d%[:;]%d", &hours, &TC.minutes, &TC.seconds, ignored, &TC.frames) != 5) {
1978                 error << string_compose (_("programming error: %1 %2"), "badly formatted timecode clock string", str) << endmsg;
1979                 return 0;
1980         }
1981         TC.hours = abs(hours);
1982         TC.rate = _session->timecode_frames_per_second();
1983         TC.drop= _session->timecode_drop_frames();
1984
1985         _session->timecode_to_sample (TC, sample, false /* use_offset */, false /* use_subframes */ );
1986
1987         // timecode_tester ();
1988         if (edit_is_negative) {
1989                 sample = - sample;
1990         }
1991
1992         return sample;
1993 }
1994
1995 framepos_t
1996 AudioClock::frames_from_minsec_string (const string& str) const
1997 {
1998         if (_session == 0) {
1999                 return 0;
2000         }
2001
2002         int hrs, mins, secs, millisecs;
2003         framecnt_t sr = _session->frame_rate();
2004
2005         if (sscanf (str.c_str(), "%d:%d:%d.%d", &hrs, &mins, &secs, &millisecs) != 4) {
2006                 error << string_compose (_("programming error: %1 %2"), "badly formatted minsec clock string", str) << endmsg;
2007                 return 0;
2008         }
2009
2010         return (framepos_t) floor ((hrs * 60.0f * 60.0f * sr) + (mins * 60.0f * sr) + (secs * sr) + (millisecs * sr / 1000.0));
2011 }
2012
2013 framepos_t
2014 AudioClock::frames_from_bbt_string (framepos_t pos, const string& str) const
2015 {
2016         if (_session == 0) {
2017                 error << "AudioClock::current_time() called with BBT mode but without session!" << endmsg;
2018                 return 0;
2019         }
2020
2021         AnyTime any;
2022         any.type = AnyTime::BBT;
2023
2024         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &any.bbt.bars, &any.bbt.beats, &any.bbt.ticks) != 3) {
2025                 return 0;
2026         }
2027
2028         if (is_duration) {
2029                 any.bbt.bars++;
2030                 any.bbt.beats++;
2031                 return _session->any_duration_to_frames (pos, any);
2032         } else {
2033                 return _session->convert_to_frames (any);
2034         }
2035 }
2036
2037
2038 framepos_t
2039 AudioClock::frame_duration_from_bbt_string (framepos_t pos, const string& str) const
2040 {
2041         if (_session == 0) {
2042                 error << "AudioClock::current_time() called with BBT mode but without session!" << endmsg;
2043                 return 0;
2044         }
2045
2046         Timecode::BBT_Time bbt;
2047
2048         if (sscanf (str.c_str(), BBT_SCANF_FORMAT, &bbt.bars, &bbt.beats, &bbt.ticks) != 3) {
2049                 return 0;
2050         }
2051
2052         return _session->tempo_map().bbt_duration_at(pos,bbt,1);
2053 }
2054
2055 framepos_t
2056 AudioClock::frames_from_audioframes_string (const string& str) const
2057 {
2058         framepos_t f;
2059         sscanf (str.c_str(), "%" PRId64, &f);
2060         return f;
2061 }
2062
2063 void
2064 AudioClock::build_ops_menu ()
2065 {
2066         using namespace Menu_Helpers;
2067         ops_menu = new Menu;
2068         MenuList& ops_items = ops_menu->items();
2069         ops_menu->set_name ("ArdourContextMenu");
2070
2071         if (!Profile->get_sae()) {
2072                 ops_items.push_back (MenuElem (_("Timecode"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), Timecode)));
2073         }
2074         ops_items.push_back (MenuElem (_("Bars:Beats"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), BBT)));
2075         ops_items.push_back (MenuElem (_("Minutes:Seconds"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), MinSec)));
2076         ops_items.push_back (MenuElem (_("Samples"), sigc::bind (sigc::mem_fun(*this, &AudioClock::set_mode), Frames)));
2077
2078         if (editable && !_off && !is_duration && !_follows_playhead) {
2079                 ops_items.push_back (SeparatorElem());
2080                 ops_items.push_back (MenuElem (_("Set From Playhead"), sigc::mem_fun(*this, &AudioClock::set_from_playhead)));
2081                 ops_items.push_back (MenuElem (_("Locate to This Time"), sigc::mem_fun(*this, &AudioClock::locate)));
2082         }
2083 }
2084
2085 void
2086 AudioClock::set_from_playhead ()
2087 {
2088         if (!_session) {
2089                 return;
2090         }
2091
2092         set (_session->transport_frame());
2093         ValueChanged ();
2094 }
2095
2096 void
2097 AudioClock::locate ()
2098 {
2099         if (!_session || is_duration) {
2100                 return;
2101         }
2102
2103         _session->request_locate (current_time(), _session->transport_rolling ());
2104 }
2105
2106 void
2107 AudioClock::set_mode (Mode m)
2108 {
2109         if (_mode == m) {
2110                 return;
2111         }
2112
2113         _mode = m;
2114
2115         insert_map.clear();
2116
2117         _layout->set_text ("");
2118
2119         if (_left_layout) {
2120
2121                 _left_layout->set_attributes (info_attributes);
2122                 _right_layout->set_attributes (info_attributes);
2123                 /* adjust info_height according to font size */
2124                 int ignored;
2125                 _left_layout->set_text (" 1234567890");
2126                 _left_layout->get_pixel_size (ignored, info_height);
2127
2128                 _left_layout->set_text ("");
2129                 _right_layout->set_text ("");
2130         }
2131
2132         switch (_mode) {
2133         case Timecode:
2134                 mode_based_info_ratio = 0.5;
2135                 insert_map.push_back (11);
2136                 insert_map.push_back (10);
2137                 insert_map.push_back (8);
2138                 insert_map.push_back (7);
2139                 insert_map.push_back (5);
2140                 insert_map.push_back (4);
2141                 insert_map.push_back (2);
2142                 insert_map.push_back (1);
2143                 break;
2144
2145         case BBT:
2146                 mode_based_info_ratio = 0.5;
2147                 insert_map.push_back (11);
2148                 insert_map.push_back (10);
2149                 insert_map.push_back (9);
2150                 insert_map.push_back (8);
2151                 insert_map.push_back (6);
2152                 insert_map.push_back (5);
2153                 insert_map.push_back (3);
2154                 insert_map.push_back (2);
2155                 insert_map.push_back (1);
2156                 break;
2157
2158         case MinSec:
2159                 mode_based_info_ratio = 0.5;
2160                 insert_map.push_back (12);
2161                 insert_map.push_back (11);
2162                 insert_map.push_back (10);
2163                 insert_map.push_back (8);
2164                 insert_map.push_back (7);
2165                 insert_map.push_back (5);
2166                 insert_map.push_back (4);
2167                 insert_map.push_back (2);
2168                 insert_map.push_back (1);
2169                 break;
2170
2171         case Frames:
2172                 mode_based_info_ratio = 0.5;
2173                 break;
2174         }
2175
2176         set (last_when, true);
2177
2178         if (!is_transient) {
2179                 ModeChanged (); /* EMIT SIGNAL (the static one)*/
2180         }
2181
2182         if (!_fixed_width) {
2183                 /* display is different, allow us to resize */
2184                 first_width = 0;
2185                 first_height = 0;
2186                 queue_resize ();
2187         }
2188
2189         mode_changed (); /* EMIT SIGNAL (the member one) */
2190 }
2191
2192 void
2193 AudioClock::set_bbt_reference (framepos_t pos)
2194 {
2195         bbt_reference_time = pos;
2196 }
2197
2198 void
2199 AudioClock::on_style_changed (const Glib::RefPtr<Gtk::Style>& old_style)
2200 {
2201         CairoWidget::on_style_changed (old_style);
2202         first_width = 0;
2203         first_height = 0;
2204         set_font ();
2205         set_colors ();
2206 }
2207
2208 void
2209 AudioClock::set_editable (bool yn)
2210 {
2211         editable = yn;
2212 }
2213
2214 void
2215 AudioClock::set_is_duration (bool yn)
2216 {
2217         if (yn == is_duration) {
2218                 return;
2219         }
2220
2221         is_duration = yn;
2222         set (last_when, true);
2223 }
2224
2225 void
2226 AudioClock::set_off (bool yn)
2227 {
2228         if (_off == yn) {
2229                 return;
2230         }
2231
2232         _off = yn;
2233
2234         /* force a redraw. last_when will be preserved, but the clock text will
2235          * change
2236          */
2237
2238         set (last_when, true);
2239 }
2240
2241 void
2242 AudioClock::focus ()
2243 {
2244         start_edit (Field (0));
2245 }
2246
2247 void
2248 AudioClock::set_corner_radius (double r)
2249 {
2250         corner_radius = r;
2251         first_width = 0;
2252         first_height = 0;
2253         queue_resize ();
2254 }
2255
2256 void
2257 AudioClock::set_fixed_width (bool yn)
2258 {
2259         _fixed_width = yn;
2260 }
2261
2262 void
2263 AudioClock::dpi_reset ()
2264 {
2265         /* force recomputation of size even if we are fixed width
2266          */
2267         first_width = 0;
2268         first_height = 0;
2269         queue_resize ();
2270 }
2271
2272 void
2273 AudioClock::set_negative_allowed (bool yn)
2274 {
2275         _negative_allowed = yn;
2276 }