libs/widgets/ardour_knob.cc

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <iostream>
  21 #include <cmath>
  22 #include <algorithm>
  23
  24 #include <pangomm/layout.h>
  25
  26 #include "pbd/compose.h"
  27 #include "pbd/controllable.h"
  28 #include "pbd/error.h"
  29 #include "pbd/stacktrace.h"
  30
  31 #include "gtkmm2ext/colors.h"
  32 #include "gtkmm2ext/gui_thread.h"
  33 #include "gtkmm2ext/keyboard.h"
  34 #include "gtkmm2ext/rgb_macros.h"
  35 #include "gtkmm2ext/utils.h"
  36
  37 #include "widgets/ardour_knob.h"
  38 #include "widgets/ui_config.h"
  39
  40 #include "pbd/i18n.h"
  41
  42 using namespace Gtkmm2ext;
  43 using namespace ArdourWidgets;
  44 using namespace Gtk;
  45 using namespace Glib;
  46 using namespace PBD;
  47 using std::max;
  48 using std::min;
  49 using namespace std;
  50
  51 ArdourKnob::Element ArdourKnob::default_elements = ArdourKnob::Element (ArdourKnob::Arc);
  52
  53 ArdourKnob::ArdourKnob (Element e, Flags flags)
  54         : _elements (e)
  55         , _hovering (false)
  56         , _grabbed_x (0)
  57         , _grabbed_y (0)
  58         , _val (0)
  59         , _normal (0)
  60         , _dead_zone_delta (0)
  61         , _flags (flags)
  62         , _tooltip (this)
  63 {
  64         UIConfigurationBase::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ArdourKnob::color_handler));
  65
  66         // watch automation :(
  67         // TODO only use for GainAutomation
  68         //Timers::rapid_connect (sigc::bind (sigc::mem_fun (*this, &ArdourKnob::controllable_changed), false));
  69 }
  70
  71 ArdourKnob::~ArdourKnob()
  72 {
  73 }
  74
  75 void
  76 ArdourKnob::render (Cairo::RefPtr<Cairo::Context> const& ctx, cairo_rectangle_t*)
  77 {
  78         cairo_t* cr = ctx->cobj();
  79         cairo_pattern_t* shade_pattern;
  80
  81         float width = get_width();
  82         float height = get_height();
  83
  84         const float scale = min(width, height);
  85         const float pointer_thickness = 3.0 * (scale/80);  //(if the knob is 80 pixels wide, we want a 3-pix line on it)
  86
  87         const float start_angle = ((180 - 65) * G_PI) / 180;
  88         const float end_angle = ((360 + 65) * G_PI) / 180;
  89
  90         float zero = 0;
  91         if (_flags & ArcToZero) {
  92                 zero = _normal;
  93         }
  94
  95         const float value_angle = start_angle + (_val * (end_angle - start_angle));
  96         const float zero_angle = start_angle + (zero * (end_angle - start_angle));
  97
  98         float value_x = cos (value_angle);
  99         float value_y = sin (value_angle);
 100
 101         float xc =  0.5 + width/ 2.0;
 102         float yc = 0.5 + height/ 2.0;
 103
 104         cairo_translate (cr, xc, yc);  //after this, everything is based on the center of the knob
 105
 106         //get the knob color from the theme
 107         Gtkmm2ext::Color knob_color = UIConfigurationBase::instance().color (string_compose ("%1", get_name()));
 108
 109         float center_radius = 0.48*scale;
 110         float border_width = 0.8;
 111
 112         bool arc = (_elements & Arc)==Arc;
 113         bool bevel = (_elements & Bevel)==Bevel;
 114         bool flat = _flat_buttons;
 115
 116         if ( arc ) {
 117                 center_radius = scale*0.33;
 118
 119                 float inner_progress_radius = scale*0.38;
 120                 float outer_progress_radius = scale*0.48;
 121                 float progress_width = (outer_progress_radius-inner_progress_radius);
 122                 float progress_radius = inner_progress_radius + progress_width/2.0;
 123
 124                 //dark arc background
 125                 cairo_set_source_rgb (cr, 0.3, 0.3, 0.3 );
 126                 cairo_set_line_width (cr, progress_width);
 127                 cairo_arc (cr, 0, 0, progress_radius, start_angle, end_angle);
 128                 cairo_stroke (cr);
 129
 130                 //look up the arc colors from the config
 131                 double red_start, green_start, blue_start, unused;
 132                 Gtkmm2ext::Color arc_start_color = UIConfigurationBase::instance().color ( string_compose ("%1: arc start", get_name()));
 133                 Gtkmm2ext::color_to_rgba( arc_start_color, red_start, green_start, blue_start, unused );
 134                 double red_end, green_end, blue_end;
 135                 Gtkmm2ext::Color arc_end_color = UIConfigurationBase::instance().color ( string_compose ("%1: arc end", get_name()) );
 136                 Gtkmm2ext::color_to_rgba( arc_end_color, red_end, green_end, blue_end, unused );
 137
 138                 //vary the arc color over the travel of the knob
 139                 float intensity = fabsf (_val - zero) / std::max(zero, (1.f - zero));
 140                 const float intensity_inv = 1.0 - intensity;
 141                 float r = intensity_inv * red_end   + intensity * red_start;
 142                 float g = intensity_inv * green_end + intensity * green_start;
 143                 float b = intensity_inv * blue_end  + intensity * blue_start;
 144
 145                 //draw the arc
 146                 cairo_set_source_rgb (cr, r,g,b);
 147                 cairo_set_line_width (cr, progress_width);
 148                 if (zero_angle > value_angle) {
 149                         cairo_arc (cr, 0, 0, progress_radius, value_angle, zero_angle);
 150                 } else {
 151                         cairo_arc (cr, 0, 0, progress_radius, zero_angle, value_angle);
 152                 }
 153                 cairo_stroke (cr);
 154
 155                 //shade the arc
 156                 if (!flat) {
 157                         shade_pattern = cairo_pattern_create_linear (0.0, -yc, 0.0,  yc);  //note we have to offset the pattern from our centerpoint
 158                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.0, 1,1,1, 0.15);
 159                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.5, 1,1,1, 0.0);
 160                         cairo_pattern_add_color_stop_rgba (shade_pattern, 1.0, 1,1,1, 0.0);
 161                         cairo_set_source (cr, shade_pattern);
 162                         cairo_arc (cr, 0, 0, outer_progress_radius-1, 0, 2.0*G_PI);
 163                         cairo_fill (cr);
 164                         cairo_pattern_destroy (shade_pattern);
 165                 }
 166
 167 #if 0 //black border
 168                 const float start_angle_x = cos (start_angle);
 169                 const float start_angle_y = sin (start_angle);
 170                 const float end_angle_x = cos (end_angle);
 171                 const float end_angle_y = sin (end_angle);
 172
 173                 cairo_set_source_rgb (cr, 0, 0, 0 );
 174                 cairo_set_line_width (cr, border_width);
 175                 cairo_move_to (cr, (outer_progress_radius * start_angle_x), (outer_progress_radius * start_angle_y));
 176                 cairo_line_to (cr, (inner_progress_radius * start_angle_x), (inner_progress_radius * start_angle_y));
 177                 cairo_stroke (cr);
 178                 cairo_move_to (cr, (outer_progress_radius * end_angle_x), (outer_progress_radius * end_angle_y));
 179                 cairo_line_to (cr, (inner_progress_radius * end_angle_x), (inner_progress_radius * end_angle_y));
 180                 cairo_stroke (cr);
 181                 cairo_arc (cr, 0, 0, outer_progress_radius, start_angle, end_angle);
 182                 cairo_stroke (cr);
 183 #endif
 184         }
 185
 186         if (!flat) {
 187                 //knob shadow
 188                 cairo_save(cr);
 189                 cairo_translate(cr, pointer_thickness+1, pointer_thickness+1 );
 190                 cairo_set_source_rgba (cr, 0, 0, 0, 0.1 );
 191                 cairo_arc (cr, 0, 0, center_radius-1, 0, 2.0*G_PI);
 192                 cairo_fill (cr);
 193                 cairo_restore(cr);
 194
 195                 //inner circle
 196                 Gtkmm2ext::set_source_rgba(cr, knob_color);
 197                 cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 198                 cairo_fill (cr);
 199
 200                 //gradient
 201                 if (bevel) {
 202                         //knob gradient
 203                         shade_pattern = cairo_pattern_create_linear (0.0, -yc, 0.0,  yc);  //note we have to offset the gradient from our centerpoint
 204                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.0, 1,1,1, 0.2);
 205                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.2, 1,1,1, 0.2);
 206                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.8, 0,0,0, 0.2);
 207                         cairo_pattern_add_color_stop_rgba (shade_pattern, 1.0, 0,0,0, 0.2);
 208                         cairo_set_source (cr, shade_pattern);
 209                         cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 210                         cairo_fill (cr);
 211                         cairo_pattern_destroy (shade_pattern);
 212
 213                         //flat top over beveled edge
 214                         Gtkmm2ext::set_source_rgb_a (cr, knob_color, 0.5 );
 215                         cairo_arc (cr, 0, 0, center_radius-pointer_thickness, 0, 2.0*G_PI);
 216                         cairo_fill (cr);
 217                 } else {
 218                         //radial gradient
 219                         shade_pattern = cairo_pattern_create_radial ( -center_radius, -center_radius, 1, -center_radius, -center_radius, center_radius*2.5  );  //note we have to offset the gradient from our centerpoint
 220                         cairo_pattern_add_color_stop_rgba (shade_pattern, 0.0, 1,1,1, 0.2);
 221                         cairo_pattern_add_color_stop_rgba (shade_pattern, 1.0, 0,0,0, 0.3);
 222                         cairo_set_source (cr, shade_pattern);
 223                         cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 224                         cairo_fill (cr);
 225                         cairo_pattern_destroy (shade_pattern);
 226                 }
 227
 228         } else {
 229                 //inner circle
 230                 Gtkmm2ext::set_source_rgba(cr, knob_color);
 231                 cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 232                 cairo_fill (cr);
 233         }
 234
 235
 236         //black knob border
 237         cairo_set_line_width (cr, border_width);
 238         cairo_set_source_rgba (cr, 0,0,0, 1 );
 239         cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 240         cairo_stroke (cr);
 241
 242         //line shadow
 243         if (!flat) {
 244                 cairo_save(cr);
 245                 cairo_translate(cr, 1, 1 );
 246                 cairo_set_source_rgba (cr, 0,0,0,0.3 );
 247                 cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
 248                 cairo_set_line_width (cr, pointer_thickness);
 249                 cairo_move_to (cr, (center_radius * value_x), (center_radius * value_y));
 250                 cairo_line_to (cr, ((center_radius*0.4) * value_x), ((center_radius*0.4) * value_y));
 251                 cairo_stroke (cr);
 252                 cairo_restore(cr);
 253         }
 254
 255         //line
 256         cairo_set_source_rgba (cr, 1,1,1, 1 );
 257         cairo_set_line_cap (cr, CAIRO_LINE_CAP_ROUND);
 258         cairo_set_line_width (cr, pointer_thickness);
 259         cairo_move_to (cr, (center_radius * value_x), (center_radius * value_y));
 260         cairo_line_to (cr, ((center_radius*0.4) * value_x), ((center_radius*0.4) * value_y));
 261         cairo_stroke (cr);
 262
 263         //highlight if grabbed or if mouse is hovering over me
 264         if (_tooltip.dragging() || (_hovering && UIConfigurationBase::instance().get_widget_prelight() ) ) {
 265                 cairo_set_source_rgba (cr, 1,1,1, 0.12 );
 266                 cairo_arc (cr, 0, 0, center_radius, 0, 2.0*G_PI);
 267                 cairo_fill (cr);
 268         }
 269
 270         cairo_identity_matrix(cr);
 271 }
 272
 273 void
 274 ArdourKnob::on_size_request (Gtk::Requisition* req)
 275 {
 276         // see ardour-button VectorIcon size, use font scaling as default
 277         CairoWidget::on_size_request (req); // allow to override
 278
 279         // we're square
 280         if (req->width < req->height) {
 281                 req->width = req->height;
 282         }
 283         if (req->height < req->width) {
 284                 req->height = req->width;
 285         }
 286 }
 287
 288 bool
 289 ArdourKnob::on_scroll_event (GdkEventScroll* ev)
 290 {
 291         /* mouse wheel */
 292
 293         float scale = 0.05;  //by default, we step in 1/20ths of the knob travel
 294         if (ev->state & Keyboard::GainFineScaleModifier) {
 295                 if (ev->state & Keyboard::GainExtraFineScaleModifier) {
 296                         scale *= 0.01;
 297                 } else {
 298                         scale *= 0.10;
 299                 }
 300         }
 301
 302         boost::shared_ptr<PBD::Controllable> c = binding_proxy.get_controllable();
 303         if (c) {
 304                 float val = c->get_interface();
 305
 306                 if ( ev->direction == GDK_SCROLL_UP )
 307                         val += scale;
 308                 else
 309                         val -= scale;
 310
 311                 c->set_interface(val);
 312         }
 313
 314         return true;
 315 }
 316
 317 bool
 318 ArdourKnob::on_motion_notify_event (GdkEventMotion *ev)
 319 {
 320         if (!(ev->state & Gdk::BUTTON1_MASK)) {
 321                 return true;
 322         }
 323
 324         boost::shared_ptr<PBD::Controllable> c = binding_proxy.get_controllable();
 325         if (!c) {
 326                 return true;
 327         }
 328
 329
 330         //scale the adjustment based on keyboard modifiers & GUI size
 331         const float ui_scale = max (1.f, UIConfigurationBase::instance().get_ui_scale());
 332         float scale = 0.0025 / ui_scale;
 333
 334         if (ev->state & Keyboard::GainFineScaleModifier) {
 335                 if (ev->state & Keyboard::GainExtraFineScaleModifier) {
 336                         scale *= 0.01;
 337                 } else {
 338                         scale *= 0.10;
 339                 }
 340         }
 341
 342         //calculate the travel of the mouse
 343         int delta = (_grabbed_y - ev->y) - (_grabbed_x - ev->x);
 344         if (delta == 0) {
 345                 return true;
 346         }
 347
 348         _grabbed_x = ev->x;
 349         _grabbed_y = ev->y;
 350         float val = c->get_interface();
 351
 352         if (_flags & Detent) {
 353                 const float px_deadzone = 42.f * ui_scale;
 354
 355                 if ((val - _normal) * (val - _normal + delta * scale) < 0) {
 356                         /* detent */
 357                         const int tozero = (_normal - val) * scale;
 358                         int remain = delta - tozero;
 359                         if (abs (remain) > px_deadzone) {
 360                                 /* slow down passing the default value */
 361                                 remain += (remain > 0) ? px_deadzone * -.5 : px_deadzone * .5;
 362                                 delta = tozero + remain;
 363                                 _dead_zone_delta = 0;
 364                         } else {
 365                                 c->set_value (c->normal(), Controllable::NoGroup);
 366                                 _dead_zone_delta = remain / px_deadzone;
 367                                 return true;
 368                         }
 369                 }
 370
 371                 if (fabsf (rintf((val - _normal) / scale) + _dead_zone_delta) < 1) {
 372                         c->set_value (c->normal(), Controllable::NoGroup);
 373                         _dead_zone_delta += delta / px_deadzone;
 374                         return true;
 375                 }
 376
 377                 _dead_zone_delta = 0;
 378         }
 379
 380         val += delta * scale;
 381         c->set_interface(val);
 382
 383         return true;
 384 }
 385
 386 bool
 387 ArdourKnob::on_button_press_event (GdkEventButton *ev)
 388 {
 389         _grabbed_x = ev->x;
 390         _grabbed_y = ev->y;
 391         _dead_zone_delta = 0;
 392
 393         if (ev->type != GDK_BUTTON_PRESS) {
 394                 if (_grabbed) {
 395                         remove_modal_grab();
 396                         gdk_pointer_ungrab (GDK_CURRENT_TIME);
 397                 }
 398                 return true;
 399         }
 400
 401         if (binding_proxy.button_press_handler (ev)) {
 402                 return true;
 403         }
 404
 405         if (ev->button != 1 && ev->button != 2) {
 406                 return false;
 407         }
 408
 409         set_active_state (Gtkmm2ext::ExplicitActive);
 410         _tooltip.start_drag();
 411         add_modal_grab();
 412         _grabbed = true;
 413         gdk_pointer_grab(ev->window,false,
 414                         GdkEventMask( Gdk::POINTER_MOTION_MASK | Gdk::BUTTON_PRESS_MASK |Gdk::BUTTON_RELEASE_MASK),
 415                         NULL,NULL,ev->time);
 416         return true;
 417 }
 418
 419 bool
 420 ArdourKnob::on_button_release_event (GdkEventButton *ev)
 421 {
 422         _tooltip.stop_drag();
 423         _grabbed = false;
 424         remove_modal_grab();
 425         gdk_pointer_ungrab (GDK_CURRENT_TIME);
 426
 427         if ( (_grabbed_y == ev->y && _grabbed_x == ev->x) && Keyboard::modifier_state_equals (ev->state, Keyboard::TertiaryModifier)) {  //no move, shift-click sets to default
 428                 boost::shared_ptr<PBD::Controllable> c = binding_proxy.get_controllable();
 429                 if (!c) return false;
 430                 c->set_value (c->normal(), Controllable::NoGroup);
 431                 return true;
 432         }
 433
 434         unset_active_state ();
 435
 436         return true;
 437 }
 438
 439 void
 440 ArdourKnob::color_handler ()
 441 {
 442         set_dirty ();
 443 }
 444
 445 void
 446 ArdourKnob::on_size_allocate (Allocation& alloc)
 447 {
 448         CairoWidget::on_size_allocate (alloc);
 449 }
 450
 451 void
 452 ArdourKnob::set_controllable (boost::shared_ptr<Controllable> c)
 453 {
 454         watch_connection.disconnect ();  //stop watching the old controllable
 455
 456         if (!c) return;
 457
 458         binding_proxy.set_controllable (c);
 459
 460         c->Changed.connect (watch_connection, invalidator(*this), boost::bind (&ArdourKnob::controllable_changed, this, false), gui_context());
 461
 462         _normal = c->internal_to_interface(c->normal());
 463
 464         controllable_changed();
 465 }
 466
 467 void
 468 ArdourKnob::controllable_changed (bool force_update)
 469 {
 470         boost::shared_ptr<PBD::Controllable> c = binding_proxy.get_controllable();
 471         if (!c) return;
 472
 473         float val = c->get_interface();
 474         val = min( max(0.0f, val), 1.0f); // clamp
 475
 476         if (val == _val && !force_update) {
 477                 return;
 478         }
 479
 480         _val = val;
 481         if (!_tooltip_prefix.empty()) {
 482                 _tooltip.set_tip (_tooltip_prefix + c->get_user_string());
 483         }
 484         set_dirty();
 485 }
 486
 487 void
 488 ArdourKnob::on_style_changed (const RefPtr<Gtk::Style>&)
 489 {
 490         set_dirty ();
 491 }
 492
 493 void
 494 ArdourKnob::on_name_changed ()
 495 {
 496         set_dirty ();
 497 }
 498
 499
 500 void
 501 ArdourKnob::set_active_state (Gtkmm2ext::ActiveState s)
 502 {
 503         if (_active_state != s)
 504                 CairoWidget::set_active_state (s);
 505 }
 506
 507 void
 508 ArdourKnob::set_visual_state (Gtkmm2ext::VisualState s)
 509 {
 510         if (_visual_state != s)
 511                 CairoWidget::set_visual_state (s);
 512 }
 513
 514
 515 bool
 516 ArdourKnob::on_focus_in_event (GdkEventFocus* ev)
 517 {
 518         set_dirty ();
 519         return CairoWidget::on_focus_in_event (ev);
 520 }
 521
 522 bool
 523 ArdourKnob::on_focus_out_event (GdkEventFocus* ev)
 524 {
 525         set_dirty ();
 526         return CairoWidget::on_focus_out_event (ev);
 527 }
 528
 529 bool
 530 ArdourKnob::on_enter_notify_event (GdkEventCrossing* ev)
 531 {
 532         _hovering = true;
 533
 534         set_dirty ();
 535
 536         boost::shared_ptr<PBD::Controllable> c (binding_proxy.get_controllable ());
 537         if (c) {
 538                 PBD::Controllable::GUIFocusChanged (boost::weak_ptr<PBD::Controllable> (c));
 539         }
 540
 541         return CairoWidget::on_enter_notify_event (ev);
 542 }
 543
 544 bool
 545 ArdourKnob::on_leave_notify_event (GdkEventCrossing* ev)
 546 {
 547         _hovering = false;
 548
 549         set_dirty ();
 550
 551         if (binding_proxy.get_controllable()) {
 552                 PBD::Controllable::GUIFocusChanged (boost::weak_ptr<PBD::Controllable> ());
 553         }
 554
 555         return CairoWidget::on_leave_notify_event (ev);
 556 }
 557
 558 void
 559 ArdourKnob::set_elements (Element e)
 560 {
 561         _elements = e;
 562 }
 563
 564 void
 565 ArdourKnob::add_elements (Element e)
 566 {
 567         _elements = (ArdourKnob::Element) (_elements | e);
 568 }
 569
 570
 571 KnobPersistentTooltip::KnobPersistentTooltip (Gtk::Widget* w)
 572         : PersistentTooltip (w, true, 3)
 573         , _dragging (false)
 574 {
 575 }
 576
 577 void
 578 KnobPersistentTooltip::start_drag ()
 579 {
 580         _dragging = true;
 581 }
 582
 583 void
 584 KnobPersistentTooltip::stop_drag ()
 585 {
 586         _dragging = false;
 587 }
 588
 589 bool
 590 KnobPersistentTooltip::dragging () const
 591 {
 592         return _dragging;
 593 }