unfinished tweaks to stereo panner, before a bigger commit of other stuff
[ardour.git] / gtk2_ardour / stereo_panner.cc
index 1e12213168fd38619ad37f71b120bcbe22be6b60..d3d44bd6d0a4e032ba83e8003f76cef02f2fdf96 100644 (file)
@@ -59,8 +59,13 @@ StereoPanner::StereoPanner (boost::shared_ptr<PBD::Controllable> position, boost
         , width_control (width)
         , dragging (false)
         , dragging_position (false)
+        , dragging_left (false)
+        , dragging_right (false)
         , drag_start_x (0)
         , last_drag_x (0)
+        , accumulated_delta (0)
+        , drag_data_window (0)
+        , drag_data_label (0)
 {
         if (!have_colors) {
                 set_colors ();
@@ -69,8 +74,8 @@ StereoPanner::StereoPanner (boost::shared_ptr<PBD::Controllable> position, boost
 
         position_control->Changed.connect (connections, invalidator(*this), boost::bind (&StereoPanner::value_change, this), gui_context());
         width_control->Changed.connect (connections, invalidator(*this), boost::bind (&StereoPanner::value_change, this), gui_context());
-        set_tooltip ();
 
+        set_tooltip ();
         set_flags (Gtk::CAN_FOCUS);
 
         add_events (Gdk::ENTER_NOTIFY_MASK|Gdk::LEAVE_NOTIFY_MASK|
@@ -84,25 +89,51 @@ StereoPanner::StereoPanner (boost::shared_ptr<PBD::Controllable> position, boost
 
 StereoPanner::~StereoPanner ()
 {
+        delete drag_data_window;
 }
 
 void
 StereoPanner::set_tooltip ()
 {
+        Gtkmm2ext::UI::instance()->set_tip (this, 
+                                            string_compose (_("0 -> set width to zero (mono)\n%1-uparrow -> set width to 100\n%1-downarrow -> set width to -100"), 
+                                                            
+                                                            Keyboard::secondary_modifier_name()).c_str());
+}
+
+void
+StereoPanner::unset_tooltip ()
+{
+        Gtkmm2ext::UI::instance()->set_tip (this, "");
+}
+
+void
+StereoPanner::set_drag_data ()
+{
+        if (!drag_data_label) {
+                return;
+        }
+
         double pos = position_control->get_value(); // 0..1
-        double w = width_control->get_value (); // -1..+1
-        int lpos = (int) lrint ((pos - (w/2.0)) * 100.0);
-        int rpos = (int) lrint ((pos + (w/2.0)) * 100.0);
-                                
-        Gtkmm2ext::UI::instance()->set_tip (this, string_compose (_("L:%1 R:%2 Width: %3%%"), 
-                                                                  lpos, rpos,
-                                                                  (int) floor (w * 100.0)).c_str());
+        
+        /* We show the position of the center of the image relative to the left & right.
+           This is expressed as a pair of percentage values that ranges from (100,0) 
+           (hard left) through (50,50) (hard center) to (0,100) (hard right).
+
+           This is pretty wierd, but its the way audio engineers expect it. Just remember that
+           the center of the USA isn't Kansas, its (50LA, 50NY) and it will all make sense.
+        */
+
+        drag_data_label->set_markup (string_compose (_("L:%1 R:%2 Width: %3%%"),
+                                                     (int) rint (100.0 * (1.0 - pos)),
+                                                     (int) rint (100.0 * pos),
+                                                     (int) floor (100.0 * width_control->get_value())));
 }
 
 void
 StereoPanner::value_change ()
 {
-        set_tooltip ();
+        set_drag_data ();
         queue_draw ();
 }
 
@@ -143,14 +174,31 @@ StereoPanner::on_expose_event (GdkEventExpose* ev)
         cairo_rectangle (cr, 0, 0, width, height);
         cairo_fill (cr);
 
+        /* the usable width is reduced from the real width, because we need space for 
+           the two halves of LR boxes that will extend past the actual left/right
+           positions (indicated by the vertical line segment above them).
+        */
+
+        double usable_width = width - lr_box_size;
+
         /* compute the centers of the L/R boxes based on the current stereo width */
-        
-        int usable_width = width - lr_box_size;
-        int center = lr_box_size/2 + (int) floor (usable_width * pos);
-        int left = center - (int) floor (fswidth * usable_width / 2.0); // center of leftmost box
-        int right = center + (int) floor (fswidth * usable_width / 2.0); // center of rightmost box
 
-        // cerr << "pos " << pos << " width = " << width << " swidth = " << swidth << " center @ " << center << " L = " << left << " R = " << right << endl;
+        if (fmod (usable_width,2.0) == 0) {
+                /* even width, but we need odd, so that there is an exact center.
+                   So, offset cairo by 1, and reduce effective width by 1 
+                */
+                usable_width -= 1.0;
+                cairo_translate (cr, 1.0, 0.0);
+        }
+
+        double center = (lr_box_size/2.0) + (usable_width * pos);
+        const double pan_spread = (fswidth * usable_width)/2.0;
+        const double half_lr_box = lr_box_size/2.0;
+        int left;
+        int right;
+
+        left = center - pan_spread;  // center of left box
+        right = center + pan_spread; // center of right box
 
         /* compute & draw the line through the box */
         
@@ -162,19 +210,11 @@ StereoPanner::on_expose_event (GdkEventExpose* ev)
         cairo_line_to (cr, right, top_step+(pos_box_size/2) + step_down);
         cairo_stroke (cr);
 
-        if (swidth < 0.0) {
-                /* flip where the L/R boxes are drawn */
-                swap (left, right);
-        }
-
         /* left box */
 
-        left -= lr_box_size/2;
-        right -= lr_box_size/2;
-
         cairo_rectangle (cr, 
-                         left,
-                         (lr_box_size/2)+step_down, 
+                         left - half_lr_box,
+                         half_lr_box+step_down, 
                          lr_box_size, lr_box_size);
         cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(o), UINT_RGBA_G_FLT(o), UINT_RGBA_B_FLT(o), UINT_RGBA_A_FLT(o));
         cairo_stroke_preserve (cr);
@@ -184,19 +224,24 @@ StereoPanner::on_expose_event (GdkEventExpose* ev)
         /* add text */
 
         cairo_move_to (cr, 
-                       left + 3,
+                       left - half_lr_box + 3,
                        (lr_box_size/2) + step_down + 13);
         cairo_select_font_face (cr, "sans-serif", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_BOLD);
+
         if (state != Mono) {
                 cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(t), UINT_RGBA_G_FLT(t), UINT_RGBA_B_FLT(t), UINT_RGBA_A_FLT(t));
-                cairo_show_text (cr, "L");
+                if (swidth < 0.0) {
+                        cairo_show_text (cr, _("R"));
+                } else {
+                        cairo_show_text (cr, _("L"));
+                }
         }
 
         /* right box */
 
         cairo_rectangle (cr, 
-                         right,
-                         (lr_box_size/2)+step_down, 
+                         right - half_lr_box,
+                         half_lr_box+step_down, 
                          lr_box_size, lr_box_size);
         cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(o), UINT_RGBA_G_FLT(o), UINT_RGBA_B_FLT(o), UINT_RGBA_A_FLT(o));
         cairo_stroke_preserve (cr);
@@ -206,19 +251,24 @@ StereoPanner::on_expose_event (GdkEventExpose* ev)
         /* add text */
 
         cairo_move_to (cr, 
-                       right + 3,
+                       right - half_lr_box + 3,
                        (lr_box_size/2)+step_down + 13);
         cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(t), UINT_RGBA_G_FLT(t), UINT_RGBA_B_FLT(t), UINT_RGBA_A_FLT(t));
+
         if (state == Mono) {
-                cairo_show_text (cr, "M");
+                cairo_show_text (cr, _("M"));
         } else {
-                cairo_show_text (cr, "R");
+                if (swidth < 0.0) {
+                        cairo_show_text (cr, _("L"));
+                } else {
+                        cairo_show_text (cr, _("R"));
+                }
         }
 
         /* draw the central box */
 
         cairo_set_line_width (cr, 1);
-       cairo_rectangle (cr, center - (pos_box_size/2), top_step, pos_box_size, pos_box_size);
+       cairo_rectangle (cr, lrint (center - (pos_box_size/2.0)), top_step, pos_box_size, pos_box_size);
         cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(o), UINT_RGBA_G_FLT(o), UINT_RGBA_B_FLT(o), UINT_RGBA_A_FLT(o));
         cairo_stroke_preserve (cr);
         cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(f), UINT_RGBA_G_FLT(f), UINT_RGBA_B_FLT(f), UINT_RGBA_A_FLT(f));
@@ -235,23 +285,65 @@ StereoPanner::on_button_press_event (GdkEventButton* ev)
 {
         drag_start_x = ev->x;
         last_drag_x = ev->x;
+        
+        dragging_position = false;
+        dragging_left = false;
+        dragging_right = false;
+        accumulated_delta = 0;
 
         if (ev->y < 20) {
                 /* top section of widget is for position drags */
                 dragging_position = true;
         } else {
-                dragging_position = false;
+                /* lower section is for dragging width */
+
+                double pos = position_control->get_value (); /* 0..1 */
+                double swidth = width_control->get_value (); /* -1..+1 */
+                double fswidth = fabs (swidth);
+                int usable_width = get_width() - lr_box_size;
+                double center = (lr_box_size/2.0) + (usable_width * pos);
+                int left = lrint (center - (fswidth * usable_width / 2.0)); // center of leftmost box
+                int right = lrint (center +  (fswidth * usable_width / 2.0)); // center of rightmost box
+                const int half_box = lr_box_size/2;
+
+                if (ev->x >= (left - half_box) && ev->x < (left + half_box)) {
+                        dragging_left = true;
+                } else if (ev->x >= (right - half_box) && ev->x < (right + half_box)) {
+                        dragging_right = true;
+                }
+
         }
 
         if (ev->type == GDK_2BUTTON_PRESS) {
                 if (dragging_position) {
-                        cerr << "Reset pos\n";
-                        position_control->set_value (0.5); // reset position to center
+                        int width = get_width();
+                        if (ev->x >= width/2 - 10 && ev->x <= width/2 + 10) {
+                                /* double click near center, reset position to center */
+                                position_control->set_value (0.5); 
+                        } else {
+                                if (ev->x < width/2) {
+                                        /* double click on left, collapse to hard left */
+                                        width_control->set_value (0);
+                                        position_control->set_value (0);
+                                } else {
+                                        /* double click on right, collapse to hard right */
+                                        width_control->set_value (0);
+                                        position_control->set_value (1.0);
+                                }
+                        }
                 } else {
-                        cerr << "Reset width\n";
-                        width_control->set_value (1.0); // reset position to full, LR
+                        if (dragging_left) {
+                                width_control->set_value (1.0); // reset width to 100%
+                        } else if (dragging_right) {
+                                width_control->set_value (-1.0); // reset width to inverted 100%
+                        } else {
+                                width_control->set_value (0); // collapse width to 0%
+                        }
+                                
                 }
+
                 dragging = false;
+
         } else {
                 dragging = true;
         }
@@ -264,13 +356,23 @@ StereoPanner::on_button_release_event (GdkEventButton* ev)
 {
         dragging = false;
         dragging_position = false;
+        dragging_left = false;
+        dragging_right = false;
+        accumulated_delta = 0;
+
+        if (drag_data_window) {
+                drag_data_window->hide ();
+        }
+
+        set_tooltip ();
+
         return true;
 }
 
 bool
 StereoPanner::on_scroll_event (GdkEventScroll* ev)
 {
-        double one_degree = 1.0/180.0;
+        double one_degree = 1.0/180.0; // one degree as a number from 0..1, since 180 degrees is the full L/R axis
         double pv = position_control->get_value(); // 0..1.0 ; 0 = left
         double wv = width_control->get_value(); // 0..1.0 ; 0 = left
         double step;
@@ -310,87 +412,64 @@ StereoPanner::on_motion_notify_event (GdkEventMotion* ev)
                 return false;
         }
 
-        int w = get_width();
-        double delta = (abs (ev->x - last_drag_x)) / (w/2.0);
-        int drag_dir = 0;
-
-        if (!dragging_position) {
-                double wv = width_control->get_value();        
-                int inc;
-                double old_wv;
-                double opx; // compute the operational x-coordinate given the current pos+width
+        if (!drag_data_window) {
+                drag_data_window = new Window (WINDOW_POPUP);
+                drag_data_window->set_position (WIN_POS_MOUSE);
+                drag_data_window->set_decorated (false);
                 
-                if (wv > 0) {
-                        /* positive value: increasing width means adding */
-                        inc = 1;
-                } else {
-                        /* positive value: increasing width means subtracting */
-                        inc = -1;
+                drag_data_label = manage (new Label);
+                drag_data_label->set_use_markup (true);
+
+                drag_data_window->set_border_width (6);
+                drag_data_window->add (*drag_data_label);
+                drag_data_label->show ();
+                
+                Window* toplevel = dynamic_cast<Window*> (get_toplevel());
+                if (toplevel) {
+                        drag_data_window->set_transient_for (*toplevel);
                 }
+        }
 
-                if (drag_start_x < w/2) {
-                        /* started left of center */
+        if (!drag_data_window->is_visible ()) {
+                /* move the window a little away from the mouse */
+                drag_data_window->move (ev->x_root+30, ev->y_root+30);
+                drag_data_window->present ();
+                unset_tooltip ();
+        }
 
-                        opx = position_control->get_value() - (wv/2.0);
+        int w = get_width();
+        double delta = (ev->x - last_drag_x) / (double) w;
+        
+        if (dragging_left) {
+                delta = -delta;
+        }
 
-                        if (opx < 0.5) {
-                                /* still left */
-                                if (ev->x > last_drag_x) {
-                                        /* motion to left */
-                                        drag_dir = -inc;
-                                } else {
-                                        drag_dir = inc;
-                                }
-                        } else {
-                                /* now right */
-                                if (ev->x > last_drag_x) {
-                                        /* motion to left */
-                                        drag_dir = inc;
-                                } else {
-                                        drag_dir = -inc;
-                                }
-                        }
-                } else {
-                        /* started right of center */
-                        
-                        opx = position_control->get_value() + (wv/2.0);
-
-                        if (opx > 0.5) {
-                                /* still right */
-                                if (ev->x < last_drag_x) {
-                                        /* motion to right */
-                                        drag_dir = -inc;
-                                } else {
-                                        drag_dir = inc;
-                                }
-                        } else {
-                                /* now left */
-                                if (ev->x < last_drag_x) {
-                                        /* motion to right */
-                                        drag_dir = inc;
-                                } else {
-                                        drag_dir = -inc;
-                                }
-                        }
+        if (dragging_left || dragging_right) {
 
-                }
+                /* maintain position as invariant as we change the width */
 
-                old_wv = wv;
-                wv = wv + (drag_dir * delta);
-                
-                width_control->set_value (wv);
+                double current_width = width_control->get_value ();
 
-        } else {
+                /* create a detent close to the center */
 
-                double pv = position_control->get_value(); // 0..1.0 ; 0 = left
-                
-                if (ev->x > last_drag_x) { // increasing 
-                        pv = pv + delta;
+                if (fabs (current_width) < 0.1) {
+                        accumulated_delta += delta;
+                        /* in the detent - have we pulled far enough to escape ? */
+                        if (fabs (accumulated_delta) >= 0.1) {
+                                width_control->set_value (current_width + accumulated_delta);
+                                accumulated_delta = 0;
+                        } else {
+                                /* snap to zero */
+                                width_control->set_value (0);
+                        }
                 } else {
-                        pv = pv - delta;
+                        width_control->set_value (current_width + delta);
                 }
 
-                position_control->set_value (pv);
+        } else if (dragging_position) {
+
+                double pv = position_control->get_value(); // 0..1.0 ; 0 = left
+                position_control->set_value (pv + delta);
         }
 
         last_drag_x = ev->x;