Gracefully handle templates that lack contents in their description or created_with...
[ardour.git] / gtk2_ardour / audio_clock.cc
index 7a588d4e7f20aab5fa729b7606dc3a9b1d158cee..3c5d065264436e4a3f2b0f11de54ac001f185e05 100644 (file)
 #include <gtkmm/style.h>
 #include <sigc++/bind.h>
 
-#include "gtkmm2ext/cairocell.h"
 #include "gtkmm2ext/utils.h"
 #include "gtkmm2ext/rgb_macros.h"
 
+#include "widgets/tooltips.h"
+
 #include "ardour/profile.h"
 #include "ardour/lmath.h"
 #include "ardour/session.h"
@@ -39,6 +40,7 @@
 
 #include "ardour_ui.h"
 #include "audio_clock.h"
+#include "enums_convert.h"
 #include "gui_thread.h"
 #include "keyboard.h"
 #include "ui_config.h"
@@ -48,6 +50,7 @@
 
 using namespace ARDOUR;
 using namespace ARDOUR_UI_UTILS;
+using namespace ArdourWidgets;
 using namespace PBD;
 using namespace Gtk;
 using namespace std;
@@ -75,6 +78,7 @@ AudioClock::AudioClock (const string& clock_name, bool transient, const string&
        , _edit_by_click_field (false)
        , _negative_allowed (false)
        , edit_is_negative (false)
+       , _limit_pos (INT64_MAX - 1)
        , _with_info (with_info)
        , editing_attr (0)
        , foreground_attr (0)
@@ -274,8 +278,9 @@ AudioClock::set_scale (double x, double y)
 }
 
 void
-AudioClock::render (cairo_t* cr, cairo_rectangle_t*)
+AudioClock::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
 {
+       cairo_t* cr = ctx->cobj();
        /* main layout: rounded rect, plus the text */
 
        if (_need_bg) {
@@ -323,10 +328,10 @@ AudioClock::render (cairo_t* cr, cairo_rectangle_t*)
 
                                cairo_set_source_rgba (cr, cursor_r, cursor_g, cursor_b, cursor_a);
                                cairo_rectangle (cr,
-                                                min (get_width() - 2.0,
-                                                     (double) xcenter + cursor.get_x()/PANGO_SCALE + em_width),
-                                                (get_height() - layout_height)/2.0,
-                                                2.0, cursor.get_height()/PANGO_SCALE);
+                                                min (get_width() - 2.0,
+                                                (double) xcenter + cursor.get_x()/PANGO_SCALE + em_width),
+                                                (get_height() - layout_height)/2.0,
+                                                2.0, cursor.get_height()/PANGO_SCALE);
                                cairo_fill (cr);
                        } else {
                                /* we've entered all possible digits, no cursor */
@@ -772,12 +777,6 @@ AudioClock::session_property_changed (const PropertyChange&)
        set (last_when, true);
 }
 
-void
-AudioClock::metric_position_changed ()
-{
-       set (last_when, true);
-}
-
 void
 AudioClock::session_configuration_changed (std::string p)
 {
@@ -814,7 +813,7 @@ AudioClock::session_configuration_changed (std::string p)
 void
 AudioClock::set (framepos_t when, bool force, framecnt_t offset)
 {
-       if ((!force && !is_visible()) || _session == 0) {
+       if ((!force && !is_visible()) || _session == 0) {
                return;
        }
 
@@ -822,6 +821,12 @@ AudioClock::set (framepos_t when, bool force, framecnt_t offset)
                when = when - offset;
        }
 
+       if (when > _limit_pos) {
+               when = _limit_pos;
+       } else if (when < -_limit_pos) {
+               when = -_limit_pos;
+       }
+
        if (when == last_when && !force) {
 #if 0 // XXX return if no change and no change forced. verify Aug/2014
                if (_mode != Timecode && _mode != MinSec) {
@@ -877,11 +882,15 @@ AudioClock::set (framepos_t when, bool force, framecnt_t offset)
                        _right_btn.set_elements (ArdourButton::Element(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text));
                        _left_btn.set_alignment (.5, .5);
                        _right_btn.set_alignment (.5, .5);
+                       set_tooltip (_left_btn, _("Change current tempo"));
+                       set_tooltip (_right_btn, _("Change current time signature"));
                } else {
                        _left_btn.set_elements (ArdourButton::Text);
                        _right_btn.set_elements (ArdourButton::Text);
                        _left_btn.set_alignment (0, .5);
                        _right_btn.set_alignment (1, .5);
+                       set_tooltip (_left_btn, _(""));
+                       set_tooltip (_right_btn, _(""));
                }
        }
 
@@ -903,16 +912,16 @@ AudioClock::set_slave_info ()
 
                switch (sync_src) {
                case Engine:
-                       _left_btn.set_text (sync_source_to_string (sync_src, true));
-                       _right_btn.set_text ("");
+                       _left_btn.set_text (sync_source_to_string (sync_src, true), true);
+                       _right_btn.set_text ("", true);
                        break;
                case MIDIClock:
                        if (slave) {
-                               _left_btn.set_text (sync_source_to_string (sync_src, true));
+                               _left_btn.set_text (sync_source_to_string (sync_src, true), true);
                                _right_btn.set_text (slave->approximate_current_delta (), true);
                        } else {
-                               _left_btn.set_text (_("--pending--"));
-                               _right_btn.set_text ("");
+                               _left_btn.set_text (_("--pending--"), true);
+                               _right_btn.set_text ("", true);
                        }
                        break;
                case LTC:
@@ -922,7 +931,7 @@ AudioClock::set_slave_info ()
                                TimecodeSlave* tcslave;
                                if ((tcslave = dynamic_cast<TimecodeSlave*>(_session->slave())) != 0) {
                                        matching = (tcslave->apparent_timecode_format() == _session->config.get_timecode_format());
-                                       _left_btn.set_text (string_compose ("%1 <span face=\"monospace\" foreground=\"%3\">%2</span>",
+                                       _left_btn.set_text (string_compose ("%1<span face=\"monospace\" foreground=\"%3\">%2</span>",
                                                                sync_source_to_string(sync_src, true)[0],
                                                                dynamic_cast<TimecodeSlave*>(slave)->approximate_current_position (),
                                                                matching ? "#66ff66" : "#ff3333"
@@ -930,15 +939,33 @@ AudioClock::set_slave_info ()
                                        _right_btn.set_text (slave->approximate_current_delta (), true);
                                }
                        } else {
-                               _left_btn.set_text (_("--pending--"));
-                               _right_btn.set_text ("");
+                               _left_btn.set_text (_("--pending--"), true);
+                               _right_btn.set_text ("", true);
                        }
                        break;
                }
        } else {
                _left_btn.set_text (string_compose ("%1/%2",
-                                       _("INT"), sync_source_to_string(sync_src, true)));
-               _right_btn.set_text ("");
+                                       _("INT"), sync_source_to_string(sync_src, true)), true);
+               _right_btn.set_text ("", true);
+       }
+}
+
+void
+AudioClock::set_out_of_bounds (bool negative)
+{
+       if (is_duration) {
+               if (negative) {
+                       _layout->set_text (" >>> -- <<< ");
+               } else {
+                       _layout->set_text (" >>> ++ <<< ");
+               }
+       } else {
+               if (negative) {
+                       _layout->set_text (" <<<<<<<<<< ");
+               } else {
+                       _layout->set_text (" >>>>>>>>>> ");
+               }
        }
 }
 
@@ -950,8 +977,8 @@ AudioClock::set_frames (framepos_t when, bool /*force*/)
 
        if (_off) {
                _layout->set_text (" ----------");
-               _left_btn.set_text ("");
-               _right_btn.set_text ("");
+               _left_btn.set_text ("", true);
+               _right_btn.set_text ("", true);
                return;
        }
 
@@ -960,14 +987,16 @@ AudioClock::set_frames (framepos_t when, bool /*force*/)
                negative = true;
        }
 
-       if (negative) {
+       if (when >= _limit_pos) {
+               set_out_of_bounds (negative);
+       } else if (negative) {
                snprintf (buf, sizeof (buf), "-%10" PRId64, when);
+               _layout->set_text (buf);
        } else {
                snprintf (buf, sizeof (buf), " %10" PRId64, when);
+               _layout->set_text (buf);
        }
 
-       _layout->set_text (buf);
-
        if (_with_info) {
                framecnt_t rate = _session->frame_rate();
 
@@ -977,15 +1006,15 @@ AudioClock::set_frames (framepos_t when, bool /*force*/)
                        sprintf (buf, "%" PRId64 "Hz", rate);
                }
 
-               _left_btn.set_text (string_compose ("%1 %2", _("SR"), buf));
+               _left_btn.set_text (string_compose ("%1 %2", _("SR"), buf), true);
 
                float vid_pullup = _session->config.get_video_pullup();
 
                if (vid_pullup == 0.0) {
-                       _right_btn.set_text (string_compose ("%1 off", _("Pull")));
+                       _right_btn.set_text ("", true);
                } else {
                        sprintf (buf, _("%+.4f%%"), vid_pullup);
-                       _right_btn.set_text (string_compose ("%1 %2", _("Pull"), buf));
+                       _right_btn.set_text (string_compose ("%1 %2", _("Pull"), buf), true);
                }
        }
 }
@@ -1031,15 +1060,19 @@ AudioClock::set_minsec (framepos_t when, bool /*force*/)
 
        if (_off) {
                _layout->set_text (" --:--:--.---");
-               _left_btn.set_text ("");
-               _right_btn.set_text ("");
+               _left_btn.set_text ("", true);
+               _right_btn.set_text ("", true);
 
                return;
        }
 
-       print_minsec (when, buf, sizeof (buf), _session->frame_rate());
+       if (when >= _limit_pos || when <= -_limit_pos) {
+               set_out_of_bounds (when < 0);
+       } else {
+               print_minsec (when, buf, sizeof (buf), _session->frame_rate());
+               _layout->set_text (buf);
+       }
 
-       _layout->set_text (buf);
        set_slave_info();
 }
 
@@ -1051,8 +1084,8 @@ AudioClock::set_timecode (framepos_t when, bool /*force*/)
 
        if (_off) {
                _layout->set_text (" --:--:--:--");
-               _left_btn.set_text ("");
-               _right_btn.set_text ("");
+               _left_btn.set_text ("", true);
+               _right_btn.set_text ("", true);
                return;
        }
 
@@ -1060,6 +1093,11 @@ AudioClock::set_timecode (framepos_t when, bool /*force*/)
                when = -when;
                negative = true;
        }
+       if (when >= _limit_pos) {
+               set_out_of_bounds (negative);
+               set_slave_info();
+               return;
+       }
 
        if (is_duration) {
                _session->timecode_duration (when, TC);
@@ -1081,10 +1119,10 @@ AudioClock::set_bbt (framepos_t when, framecnt_t offset, bool /*force*/)
        Timecode::BBT_Time BBT;
        bool negative = false;
 
-       if (_off) {
+       if (_off || when >= _limit_pos || when < -_limit_pos) {
                _layout->set_text (" ---|--|----");
-               _left_btn.set_text ("");
-               _right_btn.set_text ("");
+               _left_btn.set_text ("", true);
+               _right_btn.set_text ("", true);
                return;
        }
 
@@ -1165,15 +1203,17 @@ AudioClock::set_bbt (framepos_t when, framecnt_t offset, bool /*force*/)
 
                if (m.tempo().note_type() == 4) {
                        snprintf (buf, sizeof(buf), "\u2669 = %.3f", _session->tempo_map().tempo_at_frame (pos).note_types_per_minute());
+                       _left_btn.set_text (string_compose ("%1", buf), true);
                } else if (m.tempo().note_type() == 8) {
                        snprintf (buf, sizeof(buf), "\u266a = %.3f", _session->tempo_map().tempo_at_frame (pos).note_types_per_minute());
+                       _left_btn.set_text (string_compose ("%1", buf), true);
                } else {
-                       snprintf (buf, sizeof(buf), "%.1f@%.3f", _session->tempo_map().tempo_at_frame (pos).note_types_per_minute(), m.tempo().note_type());
+                       snprintf (buf, sizeof(buf), "%.1f = %.3f", m.tempo().note_type(), _session->tempo_map().tempo_at_frame (pos).note_types_per_minute());
+                       _left_btn.set_text (string_compose ("%1: %2", S_("Tempo|T"), buf), true);
                }
-               _left_btn.set_text (string_compose ("%1: %2", S_("Tempo|T"), buf));
 
                snprintf (buf, sizeof(buf), "%g/%g", m.meter().divisions_per_bar(), m.meter().note_divisor());
-               _right_btn.set_text (string_compose ("%1: %2", S_("Meter|M"), buf));
+               _right_btn.set_text (string_compose ("%1: %2", S_("TimeSignature|TS"), buf), true);
        }
 }
 
@@ -1184,25 +1224,30 @@ AudioClock::set_session (Session *s)
 
        if (_session) {
 
+               int64_t limit_sec = UIConfiguration::instance().get_clock_display_limit ();
+               if (limit_sec > 0) {
+                       _limit_pos = (framecnt_t) floor ((double)(limit_sec * _session->frame_rate()));
+               }
+
                Config->ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_configuration_changed, this, _1), gui_context());
                _session->config.ParameterChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_configuration_changed, this, _1), gui_context());
                _session->tempo_map().PropertyChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_property_changed, this, _1), gui_context());
-               _session->tempo_map().MetricPositionChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::metric_position_changed, this), gui_context());
+               _session->tempo_map().MetricPositionChanged.connect (_session_connections, invalidator (*this), boost::bind (&AudioClock::session_property_changed, this, _1), gui_context());
 
-               XMLProperty const * prop;
                XMLNode* node = _session->extra_xml (X_("ClockModes"));
-               AudioClock::Mode amode;
 
                if (node) {
                        for (XMLNodeList::const_iterator i = node->children().begin(); i != node->children().end(); ++i) {
-                               if ((prop = (*i)->property (X_("name"))) && prop->value() == _name) {
+                               std::string name;
+                               if ((*i)->get_property (X_("name"), name) && name == _name) {
 
-                                       if ((prop = (*i)->property (X_("mode"))) != 0) {
-                                               amode = AudioClock::Mode (string_2_enum (prop->value(), amode));
+                                       AudioClock::Mode amode;
+                                       if ((*i)->get_property (X_("mode"), amode)) {
                                                set_mode (amode, true);
                                        }
-                                       if ((prop = (*i)->property (X_("on"))) != 0) {
-                                               set_off (!string_is_affirmative (prop->value()));
+                                       bool on;
+                                       if ((*i)->get_property (X_("on"), on)) {
+                                               set_off (!on);
                                        }
                                        break;
                                }
@@ -1476,6 +1521,11 @@ AudioClock::index_to_field (int index) const
 bool
 AudioClock::on_button_press_event (GdkEventButton *ev)
 {
+       if (!_session || _session->actively_recording()) {
+               /* swallow event, do nothing */
+               return true;
+       }
+
        switch (ev->button) {
        case 1:
                if (editable && !_off) {
@@ -1519,6 +1569,11 @@ AudioClock::on_button_press_event (GdkEventButton *ev)
 bool
 AudioClock::on_button_release_event (GdkEventButton *ev)
 {
+       if (!_session || _session->actively_recording()) {
+               /* swallow event, do nothing */
+               return true;
+       }
+
        if (editable && !_off) {
                if (dragging) {
                        gdk_pointer_ungrab (GDK_CURRENT_TIME);
@@ -1592,7 +1647,7 @@ AudioClock::on_scroll_event (GdkEventScroll *ev)
        int index;
        int trailing;
 
-       if (editing || _session == 0 || !editable || _off) {
+       if (editing || _session == 0 || !editable || _off || _session->actively_recording())  {
                return false;
        }
 
@@ -1656,7 +1711,7 @@ AudioClock::on_scroll_event (GdkEventScroll *ev)
 bool
 AudioClock::on_motion_notify_event (GdkEventMotion *ev)
 {
-       if (editing || _session == 0 || !dragging) {
+       if (editing || _session == 0 || !dragging || _session->actively_recording()) {
                return false;
        }
 
@@ -1668,8 +1723,7 @@ AudioClock::on_motion_notify_event (GdkEventMotion *ev)
 
 
        if (Keyboard::modifier_state_contains (ev->state,
-                                              Keyboard::PrimaryModifier|Keyboard::SecondaryModifier)) {
-
+                                              Keyboard::PrimaryModifier|Keyboard::SecondaryModifier)) {
                pixel_frame_scale_factor = 0.025f;
        }
 
@@ -1692,9 +1746,9 @@ AudioClock::on_motion_notify_event (GdkEventMotion *ev)
                        set ((framepos_t) floor (pos - drag_accum * frames), false); // minus because up is negative in GTK
                } else {
                        set (0 , false);
-               }
+               }
 
-               drag_accum= 0;
+               drag_accum= 0;
                ValueChanged();  /* EMIT_SIGNAL */
        }
 
@@ -1827,7 +1881,7 @@ AudioClock::timecode_validate_edit (const string&)
        char ignored[2];
 
        if (sscanf (_layout->get_text().c_str(), "%[- _]%" PRId32 ":%" PRId32 ":%" PRId32 "%[:;]%" PRId32,
-                   ignored, &hours, &TC.minutes, &TC.seconds, ignored, &TC.frames) != 6) {
+                   ignored, &hours, &TC.minutes, &TC.seconds, ignored, &TC.frames) != 6) {
                return false;
        }
 
@@ -1942,10 +1996,10 @@ AudioClock::frames_from_bbt_string (framepos_t pos, const string& str) const
        if (is_duration) {
                any.bbt.bars++;
                any.bbt.beats++;
-                return _session->any_duration_to_frames (pos, any);
+               return _session->any_duration_to_frames (pos, any);
        } else {
-                return _session->convert_to_frames (any);
-        }
+               return _session->convert_to_frames (any);
+       }
 }