Fixed bug where embedded sources did not correctly obey the BWF time stamp and would...
[ardour.git] / gtk2_ardour / shuttle_control.cc
index 357094959cc3d61fe6cf5c691ea2b12c46c701a1..24f70904981d905ad96c3e2d6b70a6f4e7735c1f 100644 (file)
 #include "gtkmm2ext/gui_thread.h"
 
 #include "ardour_ui.h"
+#include "rgb_macros.h"
 #include "shuttle_control.h"
 
+#include "i18n.h"
+
 using namespace Gtk;
 using namespace Gtkmm2ext;
 using namespace ARDOUR;
@@ -39,35 +42,36 @@ using std::max;
 
 gboolean qt (gboolean, gint, gint, gboolean, Gtk::Tooltip*, gpointer)
 {
-        return FALSE;
+       return FALSE;
 }
 
 ShuttleControl::ShuttleControl ()
-        : _controllable (new ShuttleControllable (*this))
-        , binding_proxy (_controllable)
+       : _controllable (new ShuttleControllable (*this))
+       , binding_proxy (_controllable)
 {
-        ARDOUR_UI::instance()->set_tip (*this, _("Shuttle speed control (Context-click for options)"));
+       ARDOUR_UI::instance()->set_tip (*this, _("Shuttle speed control (Context-click for options)"));
 
-        pattern = 0;
+       pattern = 0;
        last_shuttle_request = 0;
        last_speed_displayed = -99999999;
        shuttle_grabbed = false;
+       shuttle_speed_on_grab = 0;
        shuttle_fract = 0.0;
        shuttle_max_speed = 8.0f;
        shuttle_style_menu = 0;
        shuttle_unit_menu = 0;
-        shuttle_context_menu = 0;
+       shuttle_context_menu = 0;
 
-        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_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_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, ui_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);
-        // signal_query_tooltip().connect (sigc::mem_fun (*this, &ShuttleControl::on_query_tooltip));
+       /* gtkmm 2.4: the C++ wrapper doesn't work */
+       g_signal_connect ((GObject*) gobj(), "query-tooltip", G_CALLBACK (qt), NULL);
+       // signal_query_tooltip().connect (sigc::mem_fun (*this, &ShuttleControl::on_query_tooltip));
 }
 
 ShuttleControl::~ShuttleControl ()
@@ -78,33 +82,38 @@ ShuttleControl::~ShuttleControl ()
 void
 ShuttleControl::set_session (Session *s)
 {
-        SessionHandlePtr::set_session (s);
-
-        if (_session) {
-                set_sensitive (true);
-                _session->add_controllable (_controllable);
-        } else {
-                set_sensitive (false);
-        }
+       SessionHandlePtr::set_session (s);
+
+       if (_session) {
+               set_sensitive (true);
+               _session->add_controllable (_controllable);
+       } else {
+               set_sensitive (false);
+       }
 }
 
 void
 ShuttleControl::on_size_allocate (Gtk::Allocation& alloc)
 {
-        if (pattern) {
-                cairo_pattern_destroy (pattern);
-                pattern = 0;
-        }
+       if (pattern) {
+               cairo_pattern_destroy (pattern);
+               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();
+
+       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, 0.0, 0.0, 1.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);
+       DrawingArea::on_size_allocate (alloc);
 }
 
 void
@@ -112,14 +121,16 @@ ShuttleControl::map_transport_state ()
 {
        float speed = _session->transport_speed ();
 
-       if (speed != 0.0) {
-                if (Config->get_shuttle_units() == Semitones) {
-                        shuttle_fract = semitones_as_fract (speed_as_semitones (speed));
-                } else {
-                        shuttle_fract = speed/shuttle_max_speed;
-                }
-       } else {
+       if (fabs(speed) <= (2*DBL_EPSILON)) {
                shuttle_fract = 0;
+       } else {
+               if (Config->get_shuttle_units() == Semitones) {
+                       bool reverse;
+                       int semi = speed_as_semitones (speed, reverse);
+                       shuttle_fract = semitones_as_fract (semi, reverse);
+               } else {
+                       shuttle_fract = speed/shuttle_max_speed;
+               }
        }
 
        queue_draw ();
@@ -136,34 +147,34 @@ ShuttleControl::build_shuttle_context_menu ()
        Menu* speed_menu = manage (new Menu());
        MenuList& speed_items = speed_menu->items();
 
-        Menu* units_menu = manage (new Menu);
-        MenuList& units_items = units_menu->items();
+       Menu* units_menu = manage (new Menu);
+       MenuList& units_items = units_menu->items();
        RadioMenuItem::Group units_group;
-        
+
        units_items.push_back (RadioMenuElem (units_group, _("Percent"), sigc::bind (sigc::mem_fun (*this, &ShuttleControl::set_shuttle_units), Percentage)));
-        if (Config->get_shuttle_units() == Percentage) {
-                static_cast<RadioMenuItem*>(&units_items.back())->set_active();
-        }
+       if (Config->get_shuttle_units() == Percentage) {
+               static_cast<RadioMenuItem*>(&units_items.back())->set_active();
+       }
        units_items.push_back (RadioMenuElem (units_group, _("Semitones"), sigc::bind (sigc::mem_fun (*this, &ShuttleControl::set_shuttle_units), Semitones)));
-        if (Config->get_shuttle_units() == Semitones) {
-                static_cast<RadioMenuItem*>(&units_items.back())->set_active();
-        }
-        items.push_back (MenuElem (_("Units"), *units_menu));
-        
-        Menu* style_menu = manage (new Menu);
-        MenuList& style_items = style_menu->items();
+       if (Config->get_shuttle_units() == Semitones) {
+               static_cast<RadioMenuItem*>(&units_items.back())->set_active();
+       }
+       items.push_back (MenuElem (_("Units"), *units_menu));
+
+       Menu* style_menu = manage (new Menu);
+       MenuList& style_items = style_menu->items();
        RadioMenuItem::Group style_group;
 
        style_items.push_back (RadioMenuElem (style_group, _("Sprung"), sigc::bind (sigc::mem_fun (*this, &ShuttleControl::set_shuttle_style), Sprung)));
-        if (Config->get_shuttle_behaviour() == Sprung) {
-                static_cast<RadioMenuItem*>(&style_items.back())->set_active();
-        }
+       if (Config->get_shuttle_behaviour() == Sprung) {
+               static_cast<RadioMenuItem*>(&style_items.back())->set_active();
+       }
        style_items.push_back (RadioMenuElem (style_group, _("Wheel"), sigc::bind (sigc::mem_fun (*this, &ShuttleControl::set_shuttle_style), Wheel)));
-        if (Config->get_shuttle_behaviour() == Wheel) {
-                static_cast<RadioMenuItem*>(&style_items.back())->set_active();
-        }
-        
-        items.push_back (MenuElem (_("Mode"), *style_menu));
+       if (Config->get_shuttle_behaviour() == Wheel) {
+               static_cast<RadioMenuItem*>(&style_items.back())->set_active();
+       }
+
+       items.push_back (MenuElem (_("Mode"), *style_menu));
 
        RadioMenuItem::Group speed_group;
 
@@ -193,7 +204,7 @@ ShuttleControl::build_shuttle_context_menu ()
        }
 
        items.push_back (MenuElem (_("Maximum speed"), *speed_menu));
-        
+
 }
 
 void
@@ -232,6 +243,7 @@ ShuttleControl::on_button_press_event (GdkEventButton* ev)
        case 1:
                add_modal_grab ();
                shuttle_grabbed = true;
+               shuttle_speed_on_grab = _session->transport_speed ();
                mouse_shuttle (ev->x, true);
                break;
 
@@ -257,21 +269,17 @@ ShuttleControl::on_button_release_event (GdkEventButton* ev)
                remove_modal_grab ();
 
                if (Config->get_shuttle_behaviour() == Sprung) {
-                       if (_session->config.get_auto_play()) {
-                               _session->request_transport_speed (1.0);
-                       } else {
-                               _session->request_transport_speed (0.0);
-                       }
+                       _session->request_transport_speed (shuttle_speed_on_grab);
                } else {
-                        mouse_shuttle (ev->x, true);
-                }
+                       mouse_shuttle (ev->x, true);
+               }
 
                return true;
 
        case 2:
                if (_session->transport_rolling()) {
                        _session->request_transport_speed (1.0);
-               } 
+               }
                return true;
 
        case 3:
@@ -286,7 +294,7 @@ ShuttleControl::on_button_release_event (GdkEventButton* ev)
 bool
 ShuttleControl::on_query_tooltip (int, int, bool, const Glib::RefPtr<Gtk::Tooltip>&)
 {
-        return false;
+       return false;
 }
 
 bool
@@ -297,19 +305,44 @@ ShuttleControl::on_scroll_event (GdkEventScroll* ev)
        }
 
        switch (ev->direction) {
-
        case GDK_SCROLL_UP:
-        case GDK_SCROLL_RIGHT:
-                shuttle_fract += 0.005;
+       case GDK_SCROLL_RIGHT:
+               shuttle_fract += 0.005;
                break;
        case GDK_SCROLL_DOWN:
-        case GDK_SCROLL_LEFT:
-                shuttle_fract -= 0.005;
+       case GDK_SCROLL_LEFT:
+               shuttle_fract -= 0.005;
                break;
        default:
                return false;
        }
 
+       if (Config->get_shuttle_units() == Semitones) {
+
+               float lower_side_of_dead_zone = semitones_as_fract (-24, true);
+               float upper_side_of_dead_zone = semitones_as_fract (-24, false);
+
+               /* if we entered the "dead zone" (-24 semitones in forward or reverse), jump
+                  to the far side of it.
+               */
+
+               if (shuttle_fract > lower_side_of_dead_zone && shuttle_fract < upper_side_of_dead_zone) {
+                       switch (ev->direction) {
+                       case GDK_SCROLL_UP:
+                       case GDK_SCROLL_RIGHT:
+                               shuttle_fract = upper_side_of_dead_zone;
+                               break;
+                       case GDK_SCROLL_DOWN:
+                       case GDK_SCROLL_LEFT:
+                               shuttle_fract = lower_side_of_dead_zone;
+                               break;
+                       default:
+                               /* impossible, checked above */
+                               return false;
+                       }
+               }
+       }
+
        use_shuttle_fract (true);
 
        return true;
@@ -337,10 +370,10 @@ ShuttleControl::mouse_shuttle (double x, bool force)
                distance_from_center = max (distance_from_center, -center);
        }
 
-        /* compute shuttle fract as expressing how far between the center
-           and the edge we are. positive values indicate we are right of 
-           center, negative values indicate left of center
-        */
+       /* compute shuttle fract as expressing how far between the center
+          and the edge we are. positive values indicate we are right of
+          center, negative values indicate left of center
+       */
 
        shuttle_fract = distance_from_center / center; // center == half the width
        use_shuttle_fract (force);
@@ -355,33 +388,41 @@ ShuttleControl::set_shuttle_fract (double f)
 }
 
 int
-ShuttleControl::speed_as_semitones (float speed)
+ShuttleControl::speed_as_semitones (float speed, bool& reverse)
 {
-        if (speed < 0.0) {
-                return (int) round (12.0 * fast_log2 (-speed));
-        } else {
-                return (int) round (12.0 * fast_log2 (speed));
-        }
-}        
+       assert (speed != 0.0);
+
+       if (speed < 0.0) {
+               reverse = true;
+               return (int) round (12.0 * fast_log2 (-speed));
+       } else {
+               reverse = false;
+               return (int) round (12.0 * fast_log2 (speed));
+       }
+}
 
 float
-ShuttleControl::semitones_as_speed (int semi)
+ShuttleControl::semitones_as_speed (int semi, bool reverse)
 {
-        return pow (2.0, (semi / 12.0));
+       if (reverse) {
+               return -pow (2.0, (semi / 12.0));
+       } else {
+               return pow (2.0, (semi / 12.0));
+       }
 }
 
 float
-ShuttleControl::semitones_as_fract (int semi)
+ShuttleControl::semitones_as_fract (int semi, bool reverse)
 {
-        double const step = 1.0 / 24.0; // range is 24 semitones up & down
-        return semi * step;
+       float speed = semitones_as_speed (semi, reverse);
+       return speed/4.0; /* 4.0 is the maximum speed for a 24 semitone shift */
 }
 
 int
-ShuttleControl::fract_as_semitones (float fract)
+ShuttleControl::fract_as_semitones (float fract, bool& reverse)
 {
-        double const step = 1.0 / 24.0; // range is 24 semitones up & down
-        return (int) round (shuttle_fract / step);
+       assert (fract != 0.0);
+       return speed_as_semitones (fract * 4.0, reverse);
 }
 
 void
@@ -389,17 +430,12 @@ ShuttleControl::use_shuttle_fract (bool force)
 {
        microseconds_t now = get_microseconds();
 
-        if (Config->get_shuttle_units() == Semitones) {
-                shuttle_fract = max (-1.0f, shuttle_fract);
-                shuttle_fract = min (1.0f, shuttle_fract);
-        } else {
-                shuttle_fract = max (-shuttle_max_speed, shuttle_fract);
-                shuttle_fract = min (shuttle_max_speed, shuttle_fract);
-        }
+       shuttle_fract = max (-1.0f, shuttle_fract);
+       shuttle_fract = min (1.0f, shuttle_fract);
 
        /* do not attempt to submit a motion-driven transport speed request
           more than once per process cycle.
-        */
+       */
 
        if (!force && (last_shuttle_request - now) < (microseconds_t) AudioEngine::instance()->usecs_per_cycle()) {
                return;
@@ -410,7 +446,13 @@ ShuttleControl::use_shuttle_fract (bool force)
        double speed = 0;
 
        if (Config->get_shuttle_units() == Semitones) {
-               speed = semitones_as_speed (fract_as_semitones (shuttle_fract));
+               if (shuttle_fract != 0.0) {
+                       bool reverse;
+                       int semi = fract_as_semitones (shuttle_fract, reverse);
+                       speed = semitones_as_speed (semi, reverse);
+               } else {
+                       speed = 0.0;
+               }
        } else {
                speed = shuttle_max_speed * shuttle_fract;
        }
@@ -421,11 +463,11 @@ ShuttleControl::use_shuttle_fract (bool force)
 bool
 ShuttleControl::on_expose_event (GdkEventExpose* event)
 {
-        cairo_text_extents_t extents;
-        Glib::RefPtr<Gdk::Window> win (get_window());
+       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_t* cr = gdk_cairo_create (win->gobj());
 
        cairo_set_source (cr, pattern);
        cairo_rectangle (cr, 0.0, 0.0, get_width(), get_height());
@@ -436,13 +478,13 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
 
        float speed = 0.0;
 
-        if (_session) {
-                speed = _session->transport_speed ();
-        }
+       if (_session) {
+               speed = _session->transport_speed ();
+       }
 
        /* Marker */
 
-        double visual_fraction = std::min (1.0f, speed/shuttle_max_speed);
+       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);
@@ -452,16 +494,33 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
        /* speed text */
 
        char buf[32];
+
        if (speed != 0) {
+
                if (Config->get_shuttle_units() == Percentage) {
-                        if (speed == 1.0) {
-                                snprintf (buf, sizeof (buf), _("Playing"));
-                        } else {
-                                snprintf (buf, sizeof (buf), "%d%%", (int) round (speed * 100));
-                        }
+
+                       if (speed == 1.0) {
+                               snprintf (buf, sizeof (buf), _("Playing"));
+                       } else {
+                               if (speed < 0.0) {
+                                       snprintf (buf, sizeof (buf), "<<< %d%%", (int) round (-speed * 100));
+                               } else {
+                                       snprintf (buf, sizeof (buf), ">>> %d%%", (int) round (speed * 100));
+                               }
+                       }
+
                } else {
-                        snprintf (buf, sizeof (buf), "%+d semitones", speed_as_semitones (speed));
+
+                       bool reversed;
+                       int semi = speed_as_semitones (speed, reversed);
+
+                       if (reversed) {
+                               snprintf (buf, sizeof (buf), _("<<< %+d semitones"), semi);
+                       } else {
+                               snprintf (buf, sizeof (buf), _(">>> %+d semitones"), semi);
+                       }
                }
+
        } else {
                snprintf (buf, sizeof (buf), _("Stopped"));
        }
@@ -469,7 +528,7 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
        last_speed_displayed = speed;
 
        cairo_set_source_rgb (cr, 1.0, 1.0, 1.0);
-        cairo_text_extents (cr, buf, &extents);
+       cairo_text_extents (cr, buf, &extents);
        cairo_move_to (cr, 10, extents.height + 2);
        cairo_show_text (cr, buf);
 
@@ -485,7 +544,7 @@ ShuttleControl::on_expose_event (GdkEventExpose* event)
                break;
        }
 
-        cairo_text_extents (cr, buf, &extents);
+       cairo_text_extents (cr, buf, &extents);
 
        cairo_move_to (cr, get_width() - (fabs(extents.x_advance) + 5), extents.height + 2);
        cairo_show_text (cr, buf);
@@ -507,13 +566,13 @@ ShuttleControl::shuttle_unit_clicked ()
 void
 ShuttleControl::set_shuttle_style (ShuttleBehaviour s)
 {
-        Config->set_shuttle_behaviour (s);
+       Config->set_shuttle_behaviour (s);
 }
 
 void
 ShuttleControl::set_shuttle_units (ShuttleUnits s)
 {
-        Config->set_shuttle_units (s);
+       Config->set_shuttle_units (s);
 }
 
 void
@@ -523,71 +582,71 @@ ShuttleControl::update_speed_display ()
                queue_draw ();
        }
 }
-      
+
 ShuttleControl::ShuttleControllable::ShuttleControllable (ShuttleControl& s)
-        : PBD::Controllable (X_("Shuttle")) 
-        , sc (s)
+       : PBD::Controllable (X_("Shuttle"))
+       , sc (s)
 {
 }
 
 void
 ShuttleControl::ShuttleControllable::set_id (const std::string& str)
 {
-        _id = 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);
+       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);
 }
 
-double 
+double
 ShuttleControl::ShuttleControllable::get_value () const
 {
-        return sc.get_shuttle_fract ();
+       return sc.get_shuttle_fract ();
 }
 
 void
 ShuttleControl::parameter_changed (std::string p)
 {
-        if (p == "shuttle-behaviour") {
+       if (p == "shuttle-behaviour") {
                switch (Config->get_shuttle_behaviour ()) {
                case Sprung:
-                        /* back to Sprung - reset to speed = 1.0 if playing
-                         */
+                       /* back to Sprung - reset to speed = 1.0 if playing
+                        */
                        if (_session) {
                                if (_session->transport_rolling()) {
-                                        if (_session->transport_speed() == 1.0) {
-                                                queue_draw ();
-                                        } else {
-                                                _session->request_transport_speed (1.0);
-                                                /* redraw when speed changes */
-                                        }
+                                       if (_session->transport_speed() == 1.0) {
+                                               queue_draw ();
+                                       } else {
+                                               _session->request_transport_speed (1.0);
+                                               /* redraw when speed changes */
+                                       }
                                } else {
-                                        queue_draw ();
-                                }
+                                       queue_draw ();
+                               }
                        }
                        break;
 
                case Wheel:
-                        queue_draw ();
+                       queue_draw ();
                        break;
                }
-                        
+
        } else if (p == "shuttle-units") {
-                queue_draw ();
-        }
+               queue_draw ();
+       }
 }