clean up and refine shuttle control rendering.
[ardour.git] / gtk2_ardour / shuttle_control.cc
index 24f70904981d905ad96c3e2d6b70a6f4e7735c1f..654785d435a4ed4c26632d6c8dbcaec54c76743f 100644 (file)
@@ -18,7 +18,7 @@
 
 #include <algorithm>
 
-#include <cairo/cairo.h>
+#include <cairo.h>
 
 #include "ardour/ardour.h"
 #include "ardour/audioengine.h"
 
 #include "gtkmm2ext/keyboard.h"
 #include "gtkmm2ext/gui_thread.h"
+#include "gtkmm2ext/cairocell.h"
+#include "gtkmm2ext/utils.h"
+#include "gtkmm2ext/rgb_macros.h"
 
+#include "actions.h"
 #include "ardour_ui.h"
 #include "rgb_macros.h"
 #include "shuttle_control.h"
@@ -52,6 +56,7 @@ ShuttleControl::ShuttleControl ()
        ARDOUR_UI::instance()->set_tip (*this, _("Shuttle speed control (Context-click for options)"));
 
        pattern = 0;
+       shine_pattern = 0;
        last_shuttle_request = 0;
        last_speed_displayed = -99999999;
        shuttle_grabbed = false;
@@ -61,13 +66,14 @@ ShuttleControl::ShuttleControl ()
        shuttle_style_menu = 0;
        shuttle_unit_menu = 0;
        shuttle_context_menu = 0;
+       _hovering = false;
 
        set_flags (CAN_FOCUS);
        add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::BUTTON_PRESS_MASK|Gdk::POINTER_MOTION_MASK|Gdk::SCROLL_MASK);
-       set_size_request (100, 15);
+       set_size_request (85, 20);
        set_name (X_("ShuttleControl"));
 
-       Config->ParameterChanged.connect (parameter_connection, MISSING_INVALIDATOR, ui_bind (&ShuttleControl::parameter_changed, this, _1), gui_context());
+       Config->ParameterChanged.connect (parameter_connection, MISSING_INVALIDATOR, boost::bind (&ShuttleControl::parameter_changed, this, _1), gui_context());
 
        /* gtkmm 2.4: the C++ wrapper doesn't work */
        g_signal_connect ((GObject*) gobj(), "query-tooltip", G_CALLBACK (qt), NULL);
@@ -77,6 +83,7 @@ ShuttleControl::ShuttleControl ()
 ShuttleControl::~ShuttleControl ()
 {
        cairo_pattern_destroy (pattern);
+       cairo_pattern_destroy (shine_pattern);
 }
 
 void
@@ -98,22 +105,26 @@ ShuttleControl::on_size_allocate (Gtk::Allocation& alloc)
        if (pattern) {
                cairo_pattern_destroy (pattern);
                pattern = 0;
+               cairo_pattern_destroy (shine_pattern);
+               shine_pattern = 0;
        }
 
-       pattern = cairo_pattern_create_linear (0, 0, alloc.get_width(), alloc.get_height());
-
-       /* add 3 color stops */
-
-       uint32_t col = ARDOUR_UI::config()->canvasvar_Shuttle.get();
+       CairoWidget::on_size_allocate ( alloc);
 
+       //background
+       pattern = cairo_pattern_create_linear (0, 0, 0, alloc.get_height());
+       uint32_t col = ARDOUR_UI::config()->color ("shuttle");
        int r,b,g,a;
        UINT_TO_RGBA(col, &r, &g, &b, &a);
-
-       cairo_pattern_add_color_stop_rgb (pattern, 0.0, 0, 0, 0);
-       cairo_pattern_add_color_stop_rgb (pattern, 0.5, r/255.0, g/255.0, b/255.0);
-       cairo_pattern_add_color_stop_rgb (pattern, 1.0, 0, 0, 0);
-
-       DrawingArea::on_size_allocate (alloc);
+       cairo_pattern_add_color_stop_rgb (pattern, 0.0, r/400.0, g/400.0, b/400.0);
+       cairo_pattern_add_color_stop_rgb (pattern, 0.4, r/255.0, g/255.0, b/255.0);
+       cairo_pattern_add_color_stop_rgb (pattern, 1.0, r/512.0, g/512.0, b/512.0);
+
+       //reflection
+       shine_pattern = cairo_pattern_create_linear (0.0, 0.0, 0.0, 10);
+       cairo_pattern_add_color_stop_rgba (shine_pattern, 0, 1,1,1,0.0);
+       cairo_pattern_add_color_stop_rgba (shine_pattern, 0.2, 1,1,1,0.4);
+       cairo_pattern_add_color_stop_rgba (shine_pattern, 1, 1,1,1,0.1);
 }
 
 void
@@ -241,10 +252,19 @@ ShuttleControl::on_button_press_event (GdkEventButton* ev)
 
        switch (ev->button) {
        case 1:
-               add_modal_grab ();
-               shuttle_grabbed = true;
-               shuttle_speed_on_grab = _session->transport_speed ();
-               mouse_shuttle (ev->x, true);
+               if (Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {
+                       if (_session->transport_rolling()) {
+                               _session->request_transport_speed (1.0);
+                       }
+               } else {
+                       add_modal_grab ();
+                       shuttle_grabbed = true;
+                       shuttle_speed_on_grab = _session->transport_speed ();
+                       mouse_shuttle (ev->x, true);
+                       gdk_pointer_grab(ev->window,false,
+                                       GdkEventMask( Gdk::POINTER_MOTION_MASK | Gdk::BUTTON_PRESS_MASK |Gdk::BUTTON_RELEASE_MASK),
+                                       NULL,NULL,ev->time);
+               }
                break;
 
        case 2:
@@ -265,20 +285,25 @@ ShuttleControl::on_button_release_event (GdkEventButton* ev)
 
        switch (ev->button) {
        case 1:
-               shuttle_grabbed = false;
-               remove_modal_grab ();
-
-               if (Config->get_shuttle_behaviour() == Sprung) {
-                       _session->request_transport_speed (shuttle_speed_on_grab);
-               } else {
-                       mouse_shuttle (ev->x, true);
+               if (shuttle_grabbed) {
+                       shuttle_grabbed = false;
+                       remove_modal_grab ();
+                       gdk_pointer_ungrab (GDK_CURRENT_TIME);
+                       
+                       if (Config->get_shuttle_behaviour() == Sprung) {
+                               if (shuttle_speed_on_grab == 0 ) {
+                                       _session->request_transport_speed (1.0);
+                               }
+                               _session->request_transport_speed (shuttle_speed_on_grab);
+                       } else {
+                               mouse_shuttle (ev->x, true);
+                       }
                }
-
                return true;
 
        case 2:
                if (_session->transport_rolling()) {
-                       _session->request_transport_speed (1.0);
+                       _session->request_transport_speed (1.0, Config->get_shuttle_behaviour() == Wheel);
                }
                return true;
 
@@ -304,20 +329,42 @@ ShuttleControl::on_scroll_event (GdkEventScroll* ev)
                return true;
        }
 
+       bool semis = (Config->get_shuttle_units() == Semitones);
+
        switch (ev->direction) {
        case GDK_SCROLL_UP:
        case GDK_SCROLL_RIGHT:
-               shuttle_fract += 0.005;
+               if (semis) {
+                       if (shuttle_fract == 0) {
+                               shuttle_fract = semitones_as_fract (1, false);
+                       } else {
+                               bool rev;
+                               int st = fract_as_semitones (shuttle_fract, rev);
+                               shuttle_fract = semitones_as_fract (st + 1, rev);
+                       }
+               } else {
+                       shuttle_fract += 0.00125;
+               }
                break;
        case GDK_SCROLL_DOWN:
        case GDK_SCROLL_LEFT:
-               shuttle_fract -= 0.005;
+               if (semis) {
+                       if (shuttle_fract == 0) {
+                               shuttle_fract = semitones_as_fract (1, true);
+                       } else {
+                               bool rev;
+                               int st = fract_as_semitones (shuttle_fract, rev);
+                               shuttle_fract = semitones_as_fract (st - 1, rev);
+                       }
+               } else {
+                       shuttle_fract -= 0.00125;
+               }
                break;
        default:
                return false;
        }
-
-       if (Config->get_shuttle_units() == Semitones) {
+       
+       if (semis) {
 
                float lower_side_of_dead_zone = semitones_as_fract (-24, true);
                float upper_side_of_dead_zone = semitones_as_fract (-24, false);
@@ -381,10 +428,10 @@ ShuttleControl::mouse_shuttle (double x, bool force)
 }
 
 void
-ShuttleControl::set_shuttle_fract (double f)
+ShuttleControl::set_shuttle_fract (double f, bool zero_ok)
 {
        shuttle_fract = f;
-       use_shuttle_fract (false);
+       use_shuttle_fract (false, zero_ok);
 }
 
 int
@@ -426,7 +473,7 @@ ShuttleControl::fract_as_semitones (float fract, bool& reverse)
 }
 
 void
-ShuttleControl::use_shuttle_fract (bool force)
+ShuttleControl::use_shuttle_fract (bool force, bool zero_ok)
 {
        microseconds_t now = get_microseconds();
 
@@ -457,24 +504,22 @@ ShuttleControl::use_shuttle_fract (bool force)
                speed = shuttle_max_speed * shuttle_fract;
        }
 
-       _session->request_transport_speed_nonzero (speed);
+       if (zero_ok) {
+               _session->request_transport_speed (speed, Config->get_shuttle_behaviour() == Wheel);
+       } else {
+               _session->request_transport_speed_nonzero (speed, Config->get_shuttle_behaviour() == Wheel);
+       }
 }
 
-bool
-ShuttleControl::on_expose_event (GdkEventExpose* event)
+void
+ShuttleControl::render (cairo_t* cr, cairo_rectangle_t*)
 {
        cairo_text_extents_t extents;
-       Glib::RefPtr<Gdk::Window> win (get_window());
-       Glib::RefPtr<Gtk::Style> style (get_style());
-
-       cairo_t* cr = gdk_cairo_create (win->gobj());
 
-       cairo_set_source (cr, pattern);
-       cairo_rectangle (cr, 0.0, 0.0, get_width(), get_height());
-       cairo_fill_preserve (cr);
-
-       cairo_set_source_rgb (cr, 0, 0, 0.0);
-       cairo_stroke (cr);
+       //black border
+       cairo_set_source_rgb (cr, 0, 0.0, 0.0);
+       rounded_rectangle (cr, 0, 0, get_width(), get_height(), 4);
+       cairo_fill (cr);
 
        float speed = 0.0;
 
@@ -483,12 +528,22 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
        }
 
        /* Marker */
-
-       double visual_fraction = std::min (1.0f, speed/shuttle_max_speed);
-       double x = (get_width() / 2.0) + (0.5 * (get_width() * visual_fraction));
-       cairo_move_to (cr, x, 1);
-       cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
-       cairo_line_to (cr, x, get_height()-1);
+       float visual_fraction = std::min (1.0f, speed / shuttle_max_speed);
+       float marker_size = get_height() - 5.0;
+       float avail_width = get_width() - marker_size - 4;
+       float x = get_width() * 0.5 + visual_fraction * avail_width * 0.5;
+//     cairo_set_source_rgb (cr, 0, 1, 0.0);
+       cairo_set_source (cr, pattern);
+       if (speed == 1.0) {
+               cairo_move_to( cr, x, 2.5);
+               cairo_line_to( cr, x + marker_size * .577, 2.5 + marker_size * 0.5);
+               cairo_line_to( cr, x, 2.5 + marker_size);
+               cairo_close_path(cr);
+       } else if ( speed ==0.0 )
+               rounded_rectangle (cr, x, 2.5, marker_size, marker_size, 1);
+       else
+               cairo_arc (cr, x, 2.5 + marker_size * .5, marker_size * 0.47, 0, 2.0 * M_PI);
+       cairo_set_line_width (cr, 1.75);
        cairo_stroke (cr);
 
        /* speed text */
@@ -500,7 +555,7 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
                if (Config->get_shuttle_units() == Percentage) {
 
                        if (speed == 1.0) {
-                               snprintf (buf, sizeof (buf), _("Playing"));
+                               snprintf (buf, sizeof (buf), "%s", _("Playing"));
                        } else {
                                if (speed < 0.0) {
                                        snprintf (buf, sizeof (buf), "<<< %d%%", (int) round (-speed * 100));
@@ -522,14 +577,18 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
                }
 
        } else {
-               snprintf (buf, sizeof (buf), _("Stopped"));
+               snprintf (buf, sizeof (buf), "%s", _("Stopped"));
        }
 
        last_speed_displayed = speed;
 
-       cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
-       cairo_text_extents (cr, buf, &extents);
-       cairo_move_to (cr, 10, extents.height + 2);
+       // TODO use a proper pango layout, scale font
+       cairo_set_source_rgb (cr, 0.6, 0.6, 0.6);
+       cairo_set_font_size (cr, 13.0);
+       cairo_text_extents (cr, "0|", &extents); // note the descender
+       const float text_ypos = (get_height() + extents.height - 1.) * .5;
+
+       cairo_move_to (cr, 10, text_ypos);
        cairo_show_text (cr, buf);
 
        /* style text */
@@ -537,21 +596,24 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
 
        switch (Config->get_shuttle_behaviour()) {
        case Sprung:
-               snprintf (buf, sizeof (buf), _("Sprung"));
+               snprintf (buf, sizeof (buf), "%s", _("Sprung"));
                break;
        case Wheel:
-               snprintf (buf, sizeof (buf), _("Wheel"));
+               snprintf (buf, sizeof (buf), "%s", _("Wheel"));
                break;
        }
 
        cairo_text_extents (cr, buf, &extents);
-
-       cairo_move_to (cr, get_width() - (fabs(extents.x_advance) + 5), extents.height + 2);
+       cairo_move_to (cr, get_width() - (fabs(extents.x_advance) + 5), text_ypos);
        cairo_show_text (cr, buf);
 
-       cairo_destroy (cr);
-
-       return true;
+       if (ARDOUR_UI::config()->get_widget_prelight()) {
+               if (_hovering) {
+                       rounded_rectangle (cr, 1, 1, get_width()-2, get_height()-2, 4.0);
+                       cairo_set_source_rgba (cr, 1, 1, 1, 0.2);
+                       cairo_fill (cr);
+               }
+       }
 }
 
 void
@@ -578,7 +640,12 @@ ShuttleControl::set_shuttle_units (ShuttleUnits s)
 void
 ShuttleControl::update_speed_display ()
 {
-       if (_session->transport_speed() != last_speed_displayed) {
+       const float speed = _session->transport_speed();
+       if ( (fabsf( speed - last_speed_displayed) > 0.009f) // dead-zone just below 1%, except..
+                       || ( speed == 1.f && last_speed_displayed != 1.f)
+                       || ( speed == 0.f && last_speed_displayed != 0.f)
+          )
+       {
                queue_draw ();
        }
 }
@@ -589,34 +656,16 @@ ShuttleControl::ShuttleControllable::ShuttleControllable (ShuttleControl& s)
 {
 }
 
-void
-ShuttleControl::ShuttleControllable::set_id (const std::string& str)
-{
-       _id = str;
-}
-
 void
 ShuttleControl::ShuttleControllable::set_value (double val)
 {
-       double fract;
-
-       if (val == 0.5) {
-               fract = 0.0;
-       } else {
-               if (val < 0.5) {
-                       fract = -((0.5 - val)/0.5);
-               } else {
-                       fract = ((val - 0.5)/0.5);
-               }
-       }
-
-       sc.set_shuttle_fract (fract);
+       sc.set_shuttle_fract ((val - lower()) / (upper() - lower()), true);
 }
 
 double
 ShuttleControl::ShuttleControllable::get_value () const
 {
-       return sc.get_shuttle_fract ();
+       return lower() + (sc.get_shuttle_fract () * (upper() - lower()));
 }
 
 void
@@ -632,6 +681,9 @@ ShuttleControl::parameter_changed (std::string p)
                                        if (_session->transport_speed() == 1.0) {
                                                queue_draw ();
                                        } else {
+                                               /* reset current speed and
+                                                  revert to 1.0 as the default
+                                               */
                                                _session->request_transport_speed (1.0);
                                                /* redraw when speed changes */
                                        }
@@ -650,3 +702,28 @@ ShuttleControl::parameter_changed (std::string p)
                queue_draw ();
        }
 }
+
+
+bool
+ShuttleControl::on_enter_notify_event (GdkEventCrossing* ev)
+{
+       _hovering = true;
+
+       if (ARDOUR_UI::config()->get_widget_prelight()) {
+               queue_draw ();
+       }
+
+       return CairoWidget::on_enter_notify_event (ev);
+}
+
+bool
+ShuttleControl::on_leave_notify_event (GdkEventCrossing* ev)
+{
+       _hovering = false;
+
+       if (ARDOUR_UI::config()->get_widget_prelight()) {
+               queue_draw ();
+       }
+
+       return CairoWidget::on_leave_notify_event (ev);
+}