Properly revert FormatSpec changes on "cancel"
[ardour.git] / gtk2_ardour / marker.cc
index 5ef7549a9fcc35eeb9413a4f6a87ca5a7e683184..a5084bf2c9c048c26cb89f82a8747ff4ec132269 100644 (file)
 #include "canvas/scroll_group.h"
 #include "canvas/debug.h"
 
-#include "ardour_ui.h"
+#include "ui_config.h"
 /*
  * ardour_ui.h include was moved to the top of the list
  * due to a conflicting definition of 'Rect' between
  * Apple's MacTypes.h and GTK.
+ *
+ * Now that we are including ui_config.h and not ardour_ui.h
+ * the above comment may no longer apply and this comment
+ * can be removed and ui_config.h inclusion moved.
  */
 
 #include "marker.h"
 
 #include <gtkmm2ext/utils.h>
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
 using namespace ARDOUR_UI_UTILS;
 using namespace Gtkmm2ext;
 
-PBD::Signal1<void,Marker*> Marker::CatchDeletion;
+PBD::Signal1<void,ArdourMarker*> ArdourMarker::CatchDeletion;
 
 static double marker_height = 13.0;
 
-void Marker::setup_sizes(const double timebar_height)
+void ArdourMarker::setup_sizes(const double timebar_height)
 {
        marker_height = floor (timebar_height) - 2;
 }
 
-Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba, const string& annotation,
-               Type type, framepos_t frame, bool handle_events)
+ArdourMarker::ArdourMarker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba, const string& annotation,
+               Type type, samplepos_t sample, bool handle_events)
 
        : editor (ed)
        , _parent (&parent)
@@ -70,13 +74,17 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
        , _shown (false)
        , _line_shown (false)
        , _color (rgba)
+       , _points_color (rgba)
        , _left_label_limit (DBL_MAX)
        , _right_label_limit (DBL_MAX)
        , _label_offset (0)
 
 {
 
-       const double MH = marker_height - 1;
+       const double MH = marker_height - .5;
+       const double M3 = std::max(1.f, rintf(3.f * UIConfiguration::instance().get_ui_scale()));
+       const double M6 = std::max(2.f, rintf(6.f * UIConfiguration::instance().get_ui_scale()));
+
        /* Shapes we use:
         *
         * Mark:
@@ -131,12 +139,12 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
         *    |    /
         *    |   /
         *    |  /
-        *   0,marker_height
+        *   0,MH
         *
         *
         *   PunchOut
         *
-        *   0,0 ------> marker_height,0
+        *   0,0 ------> MH,0
         *    \        |
         *     \       |
         *      \      |
@@ -144,7 +152,7 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
         *        \    |
         *         \   |
         *          \  |
-        *   marker_height,marker_height
+        *   MH,MH
         *
         */
 
@@ -153,9 +161,9 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
                points = new ArdourCanvas::Points ();
 
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (6.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (6.0, MH * .4));
-               points->push_back (ArdourCanvas::Duple (3.0, MH));
+               points->push_back (ArdourCanvas::Duple ( M6, 0.0));
+               points->push_back (ArdourCanvas::Duple ( M6, MH * .4));
+               points->push_back (ArdourCanvas::Duple ( M3, MH));
                points->push_back (ArdourCanvas::Duple (0.0, MH * .4));
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
 
@@ -166,12 +174,12 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
        case Tempo:
        case Meter:
                points = new ArdourCanvas::Points ();
-               points->push_back (ArdourCanvas::Duple (3.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (6.0, MH * .6));
-               points->push_back (ArdourCanvas::Duple (6.0, MH));
+               points->push_back (ArdourCanvas::Duple ( M3, 0.0));
+               points->push_back (ArdourCanvas::Duple ( M6, MH * .6));
+               points->push_back (ArdourCanvas::Duple ( M6, MH));
                points->push_back (ArdourCanvas::Duple (0.0, MH));
                points->push_back (ArdourCanvas::Duple (0.0, MH * .6));
-               points->push_back (ArdourCanvas::Duple (3.0, 0.0));
+               points->push_back (ArdourCanvas::Duple ( M3, 0.0));
 
                _shift = 3;
                _label_offset = 8.0;
@@ -180,10 +188,10 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
        case SessionStart:
        case RangeStart:
                points = new ArdourCanvas::Points ();
-               points->push_back (ArdourCanvas::Duple (0.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (6.5, MH * .5));
-               points->push_back (ArdourCanvas::Duple (0.0, MH));
-               points->push_back (ArdourCanvas::Duple (0.0, 0.0));
+               points->push_back (ArdourCanvas::Duple (    0.0, 0.0));
+               points->push_back (ArdourCanvas::Duple (M6 + .5, MH * .5));
+               points->push_back (ArdourCanvas::Duple (    0.0, MH));
+               points->push_back (ArdourCanvas::Duple (    0.0, 0.0));
 
                _shift = 0;
                _label_offset = 8.0;
@@ -191,75 +199,75 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
 
        case SessionEnd:
        case RangeEnd:
-               points = new ArdourCanvas::Points ();
-               points->push_back (ArdourCanvas::Duple (6.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (6.0, MH));
+               points = new ArdourCanvas::Points (); // leaks
+               points->push_back (ArdourCanvas::Duple ( M6, 0.0));
+               points->push_back (ArdourCanvas::Duple ( M6, MH));
                points->push_back (ArdourCanvas::Duple (0.0, MH * .5));
-               points->push_back (ArdourCanvas::Duple (6.0, 0.0));
+               points->push_back (ArdourCanvas::Duple ( M6, 0.0));
 
-               _shift = 6.0;
+               _shift = M6;
                _label_offset = 0.0;
                break;
 
        case LoopStart:
                points = new ArdourCanvas::Points ();
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (marker_height, marker_height));
-               points->push_back (ArdourCanvas::Duple (0.0, marker_height));
+               points->push_back (ArdourCanvas::Duple (MH, MH));
+               points->push_back (ArdourCanvas::Duple (0.0, MH));
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
 
                _shift = 0;
-               _label_offset = marker_height;
+               _label_offset = MH;
                break;
 
        case LoopEnd:
                points = new ArdourCanvas::Points ();
-               points->push_back (ArdourCanvas::Duple (marker_height,  0.0));
-               points->push_back (ArdourCanvas::Duple (marker_height, marker_height));
-               points->push_back (ArdourCanvas::Duple (0.0, marker_height));
-               points->push_back (ArdourCanvas::Duple (marker_height, 0.0));
+               points->push_back (ArdourCanvas::Duple (MH,  0.0));
+               points->push_back (ArdourCanvas::Duple (MH, MH));
+               points->push_back (ArdourCanvas::Duple (0.0, MH));
+               points->push_back (ArdourCanvas::Duple (MH, 0.0));
 
-               _shift = marker_height;
+               _shift = MH;
                _label_offset = 0.0;
                break;
 
        case PunchIn:
                points = new ArdourCanvas::Points ();
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (marker_height, 0.0));
-               points->push_back (ArdourCanvas::Duple (0.0, marker_height));
+               points->push_back (ArdourCanvas::Duple (MH, 0.0));
+               points->push_back (ArdourCanvas::Duple (0.0, MH));
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
 
                _shift = 0;
-               _label_offset = marker_height;
+               _label_offset = MH;
                break;
 
        case PunchOut:
                points = new ArdourCanvas::Points ();
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
-               points->push_back (ArdourCanvas::Duple (marker_height, 0.0));
-               points->push_back (ArdourCanvas::Duple (marker_height, marker_height));
+               points->push_back (ArdourCanvas::Duple (MH, 0.0));
+               points->push_back (ArdourCanvas::Duple (MH, MH));
                points->push_back (ArdourCanvas::Duple (0.0, 0.0));
 
-               _shift = marker_height;
+               _shift = MH;
                _label_offset = 0.0;
                break;
 
        }
 
-       frame_position = frame;
-       unit_position = editor.sample_to_pixel (frame);
+       sample_position = sample;
+       unit_position = editor.sample_to_pixel (sample);
        unit_position -= _shift;
 
-       group = new ArdourCanvas::Container (&parent, ArdourCanvas::Duple (unit_position, 0));
+       group = new ArdourCanvas::Container (&parent, ArdourCanvas::Duple (unit_position, 1));
 #ifdef CANVAS_DEBUG
        group->name = string_compose ("Marker::group for %1", annotation);
-#endif 
+#endif
 
        _name_background = new ArdourCanvas::Rectangle (group);
 #ifdef CANVAS_DEBUG
        _name_background->name = string_compose ("Marker::_name_background for %1", annotation);
-#endif 
+#endif
 
        /* adjust to properly locate the tip */
 
@@ -279,16 +287,16 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
 
        layout->set_font_description (name_font);
        Gtkmm2ext::get_ink_pixel_size (layout, width, name_height);
-       
+
        _name_item = new ArdourCanvas::Text (group);
-       CANVAS_DEBUG_NAME (_name_item, string_compose ("Marker::_name_item for %1", annotation));
+       CANVAS_DEBUG_NAME (_name_item, string_compose ("ArdourMarker::_name_item for %1", annotation));
        _name_item->set_font_description (name_font);
        _name_item->set_color (RGBA_TO_UINT (0,0,0,255));
        _name_item->set_position (ArdourCanvas::Duple (_label_offset, (marker_height - name_height - 1) * .5 ));
 
        set_name (annotation.c_str());
 
-       editor.ZoomChanged.connect (sigc::mem_fun (*this, &Marker::reposition));
+       editor.ZoomChanged.connect (sigc::mem_fun (*this, &ArdourMarker::reposition));
 
        /* events will be handled by both the group and the mark itself, so
         * make sure they can both be used to lookup this object.
@@ -296,50 +304,50 @@ Marker::Marker (PublicEditor& ed, ArdourCanvas::Container& parent, guint32 rgba,
 
        group->set_data ("marker", this);
        mark->set_data ("marker", this);
-       
+
        if (handle_events) {
                group->Event.connect (sigc::bind (sigc::mem_fun (editor, &PublicEditor::canvas_marker_event), group, this));
        }
 }
 
-Marker::~Marker ()
+ArdourMarker::~ArdourMarker ()
 {
        CatchDeletion (this); /* EMIT SIGNAL */
 
        /* destroying the parent group destroys its contents, namely any polygons etc. that we added */
        delete group;
        delete _track_canvas_line;
+       delete points;
 }
 
-void Marker::reparent(ArdourCanvas::Container & parent)
+void ArdourMarker::reparent(ArdourCanvas::Container & parent)
 {
        group->reparent (&parent);
        _parent = &parent;
 }
 
 void
-Marker::set_selected (bool s)
+ArdourMarker::set_selected (bool s)
 {
        _selected = s;
        setup_line ();
 }
 
 void
-Marker::set_show_line (bool s)
+ArdourMarker::set_show_line (bool s)
 {
        _line_shown = s;
        setup_line ();
 }
 
 void
-Marker::setup_line ()
+ArdourMarker::setup_line ()
 {
        if (_shown && (_selected || _line_shown)) {
 
                if (_track_canvas_line == 0) {
 
                        _track_canvas_line = new ArdourCanvas::Line (editor.get_hscroll_group());
-                       _track_canvas_line->set_outline_color (ARDOUR_UI::config()->color ("edit point"));
                        _track_canvas_line->Event.connect (sigc::bind (sigc::mem_fun (editor, &PublicEditor::canvas_marker_event), group, this));
                }
 
@@ -350,7 +358,7 @@ Marker::setup_line ()
                _track_canvas_line->set_x1 (d.x);
                _track_canvas_line->set_y0 (d.y);
                _track_canvas_line->set_y1 (ArdourCanvas::COORD_MAX);
-               _track_canvas_line->set_outline_color (_selected ? ARDOUR_UI::config()->color ("edit point") : _color);
+               _track_canvas_line->set_outline_color ( _selected ? UIConfiguration::instance().color ("entered marker") : _color );
                _track_canvas_line->raise_to_top ();
                _track_canvas_line->show ();
 
@@ -362,35 +370,39 @@ Marker::setup_line ()
 }
 
 void
-Marker::canvas_height_set (double h)
+ArdourMarker::canvas_height_set (double h)
 {
        _canvas_height = h;
        setup_line ();
 }
 
 ArdourCanvas::Item&
-Marker::the_item() const
+ArdourMarker::the_item() const
 {
        return *group;
 }
 
 void
-Marker::set_name (const string& new_name)
+ArdourMarker::set_name (const string& new_name)
 {
        _name = new_name;
 
+       mark->set_tooltip(new_name);
+       _name_background->set_tooltip(new_name);
+       _name_item->set_tooltip(new_name);
+
        setup_name_display ();
 }
 
 /** @return true if our label is on the left of the mark, otherwise false */
 bool
-Marker::label_on_left () const
+ArdourMarker::label_on_left () const
 {
        return (_type == SessionEnd || _type == RangeEnd || _type == LoopEnd || _type == PunchOut);
 }
 
 void
-Marker::setup_name_display ()
+ArdourMarker::setup_name_display ()
 {
        double limit = DBL_MAX;
 
@@ -400,8 +412,11 @@ Marker::setup_name_display ()
                limit = _right_label_limit;
        }
 
+       const float padding =  std::max(2.f, rintf(2.f * UIConfiguration::instance().get_ui_scale()));
+       const double M3 = std::max(1.f, rintf(3.f * UIConfiguration::instance().get_ui_scale()));
+
        /* Work out how wide the name can be */
-       int name_width = min ((double) pixel_width (_name, name_font) + 2, limit);
+       int name_width = min ((double) pixel_width (_name, name_font) + padding, limit);
 
        if (name_width == 0) {
                _name_item->hide ();
@@ -411,53 +426,68 @@ Marker::setup_name_display ()
                if (label_on_left ()) {
                        _name_item->set_x_position (-name_width);
                }
-                       
+
                _name_item->clamp_width (name_width);
                _name_item->set (_name);
-               
+
                if (label_on_left ()) {
                        /* adjust right edge of background to fit text */
-                       _name_background->set_x0 (_name_item->position().x - 2);
+                       _name_background->set_x0 (_name_item->position().x - padding);
                        _name_background->set_x1 (_name_item->position().x + name_width + _shift);
                } else {
                        /* right edge remains at zero (group-relative). Add
                         * arbitrary 2 pixels of extra padding at the end
                         */
-                       _name_background->set_x1 (_name_item->position().x + name_width + 2.0);
+                       switch (_type) {
+                               case Tempo:
+                                       _name_item->hide ();
+                                       // tip's x-pos is at "M3", box is 2x marker's
+                                       _name_background->set_x0 (-M3);
+                                       _name_background->set_x1 (3 * M3);
+                                       break;
+                               case Mark:
+                               case Meter:
+                                       _name_background->set_x0 (M3);
+                                       _name_background->set_x1 (_name_item->position().x + name_width + padding);
+                                       break;
+                               default:
+                                       _name_background->set_x0 (0);
+                                       _name_background->set_x1 (_name_item->position().x + name_width + padding);
+                                       break;
+                       }
                }
        }
 
        _name_background->set_y0 (0);
-       /* unfortunate hard coding - this has to * match the marker bars height */
-       _name_background->set_y1 (marker_height + 1.0); 
+       _name_background->set_y1 (marker_height + 1);
 }
 
 void
-Marker::set_position (framepos_t frame)
+ArdourMarker::set_position (samplepos_t sample)
 {
-       unit_position = editor.sample_to_pixel (frame) - _shift;
+       unit_position = editor.sample_to_pixel (sample) - _shift;
        group->set_x_position (unit_position);
        setup_line ();
-       frame_position = frame;
+       sample_position = sample;
 }
 
 void
-Marker::reposition ()
+ArdourMarker::reposition ()
 {
-       set_position (frame_position);
+       set_position (sample_position);
 }
 
 void
-Marker::show ()
+ArdourMarker::show ()
 {
        _shown = true;
 
-        group->show ();
+       group->show ();
        setup_line ();
 }
 
 void
-Marker::hide ()
+ArdourMarker::hide ()
 {
        _shown = false;
 
@@ -466,7 +496,15 @@ Marker::hide ()
 }
 
 void
-Marker::set_color_rgba (uint32_t c)
+ArdourMarker::set_points_color (uint32_t c)
+{
+       _points_color = c;
+       mark->set_fill_color (_points_color);
+       mark->set_outline_color (_points_color);
+}
+
+void
+ArdourMarker::set_color_rgba (uint32_t c)
 {
        _color = c;
        mark->set_fill_color (_color);
@@ -478,12 +516,12 @@ Marker::set_color_rgba (uint32_t c)
 
        _name_background->set_fill (true);
        _name_background->set_fill_color (UINT_RGBA_CHANGE_A (_color, 0x70));
-       _name_background->set_outline_color (_color);
+       _name_background->set_outline (false);
 }
 
 /** Set the number of pixels that are available for a label to the left of the centre of this marker */
 void
-Marker::set_left_label_limit (double p)
+ArdourMarker::set_left_label_limit (double p)
 {
        /* Account for the size of the marker */
        _left_label_limit = p - marker_height;
@@ -498,7 +536,7 @@ Marker::set_left_label_limit (double p)
 
 /** Set the number of pixels that are available for a label to the right of the centre of this marker */
 void
-Marker::set_right_label_limit (double p)
+ArdourMarker::set_right_label_limit (double p)
 {
        /* Account for the size of the marker */
        _right_label_limit = p - marker_height;
@@ -515,10 +553,9 @@ Marker::set_right_label_limit (double p)
 
 TempoMarker::TempoMarker (PublicEditor& editor, ArdourCanvas::Container& parent, guint32 rgba, const string& text,
                          ARDOUR::TempoSection& temp)
-       : Marker (editor, parent, rgba, text, Tempo, 0, false),
+       : ArdourMarker (editor, parent, rgba, text, Tempo, temp.sample(), false),
          _tempo (temp)
 {
-       set_position (_tempo.frame());
        group->Event.connect (sigc::bind (sigc::mem_fun (editor, &PublicEditor::canvas_tempo_marker_event), group, this));
 }
 
@@ -526,18 +563,36 @@ TempoMarker::~TempoMarker ()
 {
 }
 
+void
+TempoMarker::update_height_mark (const double ratio)
+{
+       const double MH = marker_height - .5;
+       const double top = MH * (1 - ratio);
+       const double M3 = std::max(1.f, rintf(3.f * UIConfiguration::instance().get_ui_scale()));
+       const double M6 = std::max(2.f, rintf(6.f * UIConfiguration::instance().get_ui_scale()));
+
+       delete points;
+       points = new ArdourCanvas::Points ();
+       points->push_back (ArdourCanvas::Duple ( M3, top));
+       points->push_back (ArdourCanvas::Duple ( M6, min (top + (MH * .6), MH)));
+       points->push_back (ArdourCanvas::Duple ( M6, MH));
+       points->push_back (ArdourCanvas::Duple (0.0, MH));
+       points->push_back (ArdourCanvas::Duple (0.0, min (top + (MH * .6), MH)));
+       points->push_back (ArdourCanvas::Duple ( M3, top));
+
+       mark->set (*points);
+}
+
 /***********************************************************************/
 
 MeterMarker::MeterMarker (PublicEditor& editor, ArdourCanvas::Container& parent, guint32 rgba, const string& text,
                          ARDOUR::MeterSection& m)
-       : Marker (editor, parent, rgba, text, Meter, 0, false),
+       : ArdourMarker (editor, parent, rgba, text, Meter, m.sample(), false),
          _meter (m)
 {
-       set_position (_meter.frame());
        group->Event.connect (sigc::bind (sigc::mem_fun (editor, &PublicEditor::canvas_meter_marker_event), group, this));
 }
 
 MeterMarker::~MeterMarker ()
 {
 }
-