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