gtk2_ardour/panner_ui.cc

   1 /*
   2   Copyright (C) 2004 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 #include <limits.h>
  20
  21 #include <gtkmm2ext/utils.h>
  22
  23 #include "pbd/fastlog.h"
  24
  25 #include "ardour/pannable.h"
  26 #include "ardour/panner.h"
  27 #include "ardour/panner_shell.h"
  28 #include "ardour/session.h"
  29
  30 #include "ardour_ui.h"
  31 #include "panner_ui.h"
  32 #include "panner2d.h"
  33 #include "gui_thread.h"
  34 #include "stereo_panner.h"
  35 #include "mono_panner.h"
  36
  37 #include "i18n.h"
  38
  39 using namespace std;
  40 using namespace ARDOUR;
  41 using namespace PBD;
  42 using namespace Gtkmm2ext;
  43 using namespace Gtk;
  44
  45 const int PannerUI::pan_bar_height = 35;
  46
  47 PannerUI::PannerUI (Session* s)
  48         : _current_nouts (-1)
  49         , _current_nins (-1)
  50         , _current_uri ("")
  51         , _send_mode (false)
  52         , pan_automation_style_button ("")
  53         , pan_automation_state_button ("")
  54         , _panner_list()
  55 {
  56         set_session (s);
  57
  58         ignore_toggle = false;
  59         pan_menu = 0;
  60         pan_astate_menu = 0;
  61         pan_astyle_menu = 0;
  62         in_pan_update = false;
  63         _stereo_panner = 0;
  64         _mono_panner = 0;
  65         _ignore_width_change = false;
  66         _ignore_position_change = false;
  67
  68         pan_automation_style_button.set_name ("MixerAutomationModeButton");
  69         pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");
  70
  71         ARDOUR_UI::instance()->set_tip (pan_automation_state_button, _("Pan automation mode"));
  72         ARDOUR_UI::instance()->set_tip (pan_automation_style_button, _("Pan automation type"));
  73
  74         //set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);
  75         //set_size_request_to_display_given_text (pan_automation_style_button, X_("0"), 2, 2);
  76
  77         pan_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
  78         pan_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
  79
  80         pan_automation_style_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_style_button_event), false);
  81         pan_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);
  82
  83         pan_vbox.set_spacing (2);
  84         pack_start (pan_vbox, true, true);
  85
  86         twod_panner = 0;
  87         big_window = 0;
  88
  89         set_width(Narrow);
  90 }
  91
  92 void
  93 PannerUI::set_panner (boost::shared_ptr<PannerShell> ps, boost::shared_ptr<Panner> p)
  94 {
  95         /* note that the panshell might not change here (i.e. ps == _panshell)
  96          */
  97
  98         connections.drop_connections ();
  99
 100         delete pan_astyle_menu;
 101         pan_astyle_menu = 0;
 102
 103         delete pan_astate_menu;
 104         pan_astate_menu = 0;
 105
 106         _panshell = ps;
 107         _panner = p;
 108
 109         delete twod_panner;
 110         twod_panner = 0;
 111
 112         delete _stereo_panner;
 113         _stereo_panner = 0;
 114
 115         delete _mono_panner;
 116         _mono_panner = 0;
 117
 118         if (!_panner) {
 119                 return;
 120         }
 121
 122         _panshell->Changed.connect (connections, invalidator (*this), boost::bind (&PannerUI::panshell_changed, this), gui_context());
 123
 124         /* new panner object, force complete reset of panner GUI
 125          */
 126
 127         _current_nouts = 0;
 128         _current_nins = 0;
 129
 130         setup_pan ();
 131         update_pan_sensitive ();
 132         pan_automation_state_changed ();
 133 }
 134
 135 void
 136 PannerUI::build_astate_menu ()
 137 {
 138         using namespace Menu_Helpers;
 139
 140         if (pan_astate_menu == 0) {
 141                 pan_astate_menu = new Menu;
 142                 pan_astate_menu->set_name ("ArdourContextMenu");
 143         } else {
 144                 pan_astate_menu->items().clear ();
 145         }
 146
 147         /** TRANSLATORS: this is `Manual' in the sense of automation not being played,
 148             so that changes to pan must be done by hand.
 149         */
 150         pan_astate_menu->items().push_back (MenuElem (S_("Automation|Manual"), sigc::bind (
 151                         sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
 152                         (AutoState) ARDOUR::Off)));
 153         pan_astate_menu->items().push_back (MenuElem (_("Play"), sigc::bind (
 154                         sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
 155                         (AutoState) Play)));
 156         pan_astate_menu->items().push_back (MenuElem (_("Write"), sigc::bind (
 157                         sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
 158                         (AutoState) Write)));
 159         pan_astate_menu->items().push_back (MenuElem (_("Touch"), sigc::bind (
 160                         sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
 161                         (AutoState) Touch)));
 162
 163 }
 164
 165 void
 166 PannerUI::build_astyle_menu ()
 167 {
 168         using namespace Menu_Helpers;
 169
 170         if (pan_astyle_menu == 0) {
 171                 pan_astyle_menu = new Menu;
 172                 pan_astyle_menu->set_name ("ArdourContextMenu");
 173         } else {
 174                 pan_astyle_menu->items().clear();
 175         }
 176
 177         pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
 178         pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
 179 }
 180
 181 void
 182 PannerUI::on_size_allocate (Allocation& a)
 183 {
 184         HBox::on_size_allocate (a);
 185 }
 186
 187 void
 188 PannerUI::set_width (Width w)
 189 {
 190         _width = w;
 191 }
 192
 193 PannerUI::~PannerUI ()
 194 {
 195         delete twod_panner;
 196         delete big_window;
 197         delete pan_menu;
 198         delete pan_astyle_menu;
 199         delete pan_astate_menu;
 200         delete _stereo_panner;
 201         delete _mono_panner;
 202 }
 203
 204 void
 205 PannerUI::panshell_changed ()
 206 {
 207         set_panner (_panshell, _panshell->panner());
 208         setup_pan ();
 209 }
 210
 211 void
 212 PannerUI::setup_pan ()
 213 {
 214         int const nouts = _panner ? _panner->out().n_audio() : -1;
 215         int const nins = _panner ? _panner->in().n_audio() : -1;
 216
 217         if (nouts == _current_nouts
 218                         && nins == _current_nins
 219                         && _current_uri == _panshell->panner_gui_uri()
 220                         )
 221         {
 222                 return;
 223         }
 224
 225         _current_nins = nins;
 226         _current_nouts = nouts;
 227         _current_uri = _panshell->panner_gui_uri();
 228
 229         container_clear (pan_vbox);
 230
 231         delete twod_panner;
 232         twod_panner = 0;
 233         delete _stereo_panner;
 234         _stereo_panner = 0;
 235         delete _mono_panner;
 236         _mono_panner = 0;
 237
 238         if (!_panner) {
 239                 delete big_window;
 240                 big_window = 0;
 241                 return;
 242         }
 243
 244         if (_current_uri == "http://ardour.org/plugin/panner_2in2out#ui")
 245         {
 246                 delete big_window;
 247                 big_window = 0;
 248
 249                 boost::shared_ptr<Pannable> pannable = _panner->pannable();
 250
 251                 _stereo_panner = new StereoPanner (_panshell);
 252                 _stereo_panner->set_size_request (-1, pan_bar_height);
 253                 _stereo_panner->set_send_drawing_mode (_send_mode);
 254                 pan_vbox.pack_start (*_stereo_panner, false, false);
 255
 256                 boost::shared_ptr<AutomationControl> ac;
 257
 258                 ac = pannable->pan_azimuth_control;
 259                 _stereo_panner->StartPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 260                                         boost::weak_ptr<AutomationControl> (ac)));
 261                 _stereo_panner->StopPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 262                                         boost::weak_ptr<AutomationControl>(ac)));
 263
 264                 ac = pannable->pan_width_control;
 265                 _stereo_panner->StartWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 266                                         boost::weak_ptr<AutomationControl> (ac)));
 267                 _stereo_panner->StopWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 268                                         boost::weak_ptr<AutomationControl>(ac)));
 269                 _stereo_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
 270         }
 271         else if (_current_uri == "http://ardour.org/plugin/panner_1in2out#ui"
 272                         || _current_uri == "http://ardour.org/plugin/panner_balance#ui")
 273         {
 274                 delete big_window;
 275                 big_window = 0;
 276                 boost::shared_ptr<Pannable> pannable = _panner->pannable();
 277                 boost::shared_ptr<AutomationControl> ac = pannable->pan_azimuth_control;
 278
 279                 _mono_panner = new MonoPanner (_panshell);
 280
 281                 _mono_panner->StartGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 282                                         boost::weak_ptr<AutomationControl> (ac)));
 283                 _mono_panner->StopGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 284                                         boost::weak_ptr<AutomationControl>(ac)));
 285
 286                 _mono_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
 287
 288                 _mono_panner->set_size_request (-1, pan_bar_height);
 289                 _mono_panner->set_send_drawing_mode (_send_mode);
 290
 291                 update_pan_sensitive ();
 292                 pan_vbox.pack_start (*_mono_panner, false, false);
 293         }
 294         else if (_current_uri == "http://ardour.org/plugin/panner_vbap#ui")
 295         {
 296                 if (!twod_panner) {
 297                         twod_panner = new Panner2d (_panshell, 61);
 298                         twod_panner->set_name ("MixerPanZone");
 299                         twod_panner->show ();
 300                         twod_panner->signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event), false);
 301                 }
 302
 303                 update_pan_sensitive ();
 304                 twod_panner->reset (nins);
 305                 if (big_window) {
 306                         big_window->reset (nins);
 307                 }
 308                 twod_panner->set_size_request (-1, 61);
 309                 twod_panner->set_send_drawing_mode (_send_mode);
 310
 311                 /* and finally, add it to the panner frame */
 312
 313                 pan_vbox.pack_start (*twod_panner, false, false);
 314         }
 315         else
 316         {
 317                 /* stick something into the panning viewport so that it redraws */
 318                 EventBox* eb = manage (new EventBox());
 319                 pan_vbox.pack_start (*eb, false, false);
 320
 321                 delete big_window;
 322                 big_window = 0;
 323         }
 324
 325         pan_vbox.show_all ();
 326 }
 327
 328 void
 329 PannerUI::set_send_drawing_mode (bool onoff)
 330 {
 331         if (_stereo_panner) {
 332                 _stereo_panner->set_send_drawing_mode (onoff);
 333         } else if (_mono_panner) {
 334                 _mono_panner->set_send_drawing_mode (onoff);
 335         } else if (twod_panner) {
 336                 twod_panner->set_send_drawing_mode (onoff);
 337         }
 338         _send_mode = onoff;
 339 }
 340
 341 void
 342 PannerUI::start_touch (boost::weak_ptr<AutomationControl> wac)
 343 {
 344         boost::shared_ptr<AutomationControl> ac = wac.lock();
 345         if (!ac) {
 346                 return;
 347         }
 348         ac->start_touch (ac->session().transport_frame());
 349 }
 350
 351 void
 352 PannerUI::stop_touch (boost::weak_ptr<AutomationControl> wac)
 353 {
 354         boost::shared_ptr<AutomationControl> ac = wac.lock();
 355         if (!ac) {
 356                 return;
 357         }
 358         ac->stop_touch (false, ac->session().transport_frame());
 359 }
 360
 361 bool
 362 PannerUI::pan_button_event (GdkEventButton* ev)
 363 {
 364         switch (ev->button) {
 365         case 1:
 366                 if (twod_panner && ev->type == GDK_2BUTTON_PRESS) {
 367                         if (!big_window) {
 368                                 big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
 369                         }
 370                         big_window->show ();
 371                         return true;
 372                 }
 373                 break;
 374
 375         case 3:
 376                 if (pan_menu == 0) {
 377                         pan_menu = manage (new Menu);
 378                         pan_menu->set_name ("ArdourContextMenu");
 379                 }
 380                 build_pan_menu ();
 381                 pan_menu->popup (1, ev->time);
 382                 return true;
 383                 break;
 384         default:
 385                 return false;
 386         }
 387
 388         return false; // what's wrong with gcc?
 389 }
 390
 391 void
 392 PannerUI::build_pan_menu ()
 393 {
 394         using namespace Menu_Helpers;
 395         MenuList& items (pan_menu->items());
 396
 397         items.clear ();
 398
 399         items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
 400         bypass_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());
 401
 402         /* set state first, connect second */
 403
 404         bypass_menu_item->set_active (_panshell->bypassed());
 405         bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));
 406
 407         if (!_panshell->bypassed()) {
 408                 items.push_back (MenuElem (_("Reset"), sigc::mem_fun (*this, &PannerUI::pan_reset)));
 409                 items.push_back (MenuElem (_("Edit..."), sigc::mem_fun (*this, &PannerUI::pan_edit)));
 410         }
 411
 412         if (_panner_list.size() > 1 && !_panshell->bypassed()) {
 413                 RadioMenuItem::Group group;
 414                 items.push_back (SeparatorElem());
 415
 416                 _suspend_menu_callbacks = true;
 417                 for (std::map<std::string,std::string>::const_iterator p = _panner_list.begin(); p != _panner_list.end(); ++p) {
 418                         items.push_back (RadioMenuElem (group, p->second,
 419                                                 sigc::bind(sigc::mem_fun (*this, &PannerUI::pan_set_custom_type), p->first)));
 420                         RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
 421                         i->set_active (_panshell->current_panner_uri() == p->first);
 422                 }
 423                 _suspend_menu_callbacks = false;
 424         }
 425 }
 426
 427 void
 428 PannerUI::pan_bypass_toggle ()
 429 {
 430         if (bypass_menu_item && (_panshell->bypassed() != bypass_menu_item->get_active())) {
 431                 _panshell->set_bypassed (!_panshell->bypassed());
 432         }
 433 }
 434
 435 void
 436 PannerUI::pan_edit ()
 437 {
 438         if (_panshell->bypassed()) {
 439                 return;
 440         }
 441         if (_mono_panner) {
 442                 _mono_panner->edit ();
 443         } else if (_stereo_panner) {
 444                 _stereo_panner->edit ();
 445         } else if (twod_panner) {
 446                 if (!big_window) {
 447                         big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
 448                 }
 449                 big_window->show ();
 450         }
 451 }
 452
 453 void
 454 PannerUI::pan_reset ()
 455 {
 456         if (_panshell->bypassed()) {
 457                 return;
 458         }
 459         _panner->reset ();
 460 }
 461
 462 void
 463 PannerUI::pan_set_custom_type (std::string uri) {
 464         if (_suspend_menu_callbacks) return;
 465         _panshell->select_panner_by_uri(uri);
 466 }
 467
 468 void
 469 PannerUI::effective_pan_display ()
 470 {
 471         if (_stereo_panner) {
 472                 _stereo_panner->queue_draw ();
 473         } else if (_mono_panner) {
 474                 _mono_panner->queue_draw ();
 475         } else if (twod_panner) {
 476                 twod_panner->queue_draw ();
 477         }
 478 }
 479
 480 void
 481 PannerUI::update_pan_sensitive ()
 482 {
 483         bool const sensitive = !(_panner->pannable()->automation_state() & Play);
 484
 485         pan_vbox.set_sensitive (sensitive);
 486
 487         if (big_window) {
 488                 big_window->set_sensitive (sensitive);
 489         }
 490 }
 491
 492 gint
 493 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
 494 {
 495         using namespace Menu_Helpers;
 496
 497         if (ev->type == GDK_BUTTON_RELEASE) {
 498                 return TRUE;
 499         }
 500
 501         switch (ev->button) {
 502         case 1:
 503                 if (pan_astate_menu == 0) {
 504                         build_astate_menu ();
 505                 }
 506                 pan_astate_menu->popup (1, ev->time);
 507                 break;
 508         default:
 509                 break;
 510         }
 511
 512         return TRUE;
 513 }
 514
 515 gint
 516 PannerUI::pan_automation_style_button_event (GdkEventButton *ev)
 517 {
 518         if (ev->type == GDK_BUTTON_RELEASE) {
 519                 return TRUE;
 520         }
 521
 522         switch (ev->button) {
 523         case 1:
 524                 if (pan_astyle_menu == 0) {
 525                         build_astyle_menu ();
 526                 }
 527                 pan_astyle_menu->popup (1, ev->time);
 528                 break;
 529         default:
 530                 break;
 531         }
 532         return TRUE;
 533 }
 534
 535 void
 536 PannerUI::pan_automation_style_changed ()
 537 {
 538         ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_style_changed)
 539
 540         switch (_width) {
 541         case Wide:
 542                 pan_automation_style_button.set_label (astyle_string(_panner->automation_style()));
 543                 break;
 544         case Narrow:
 545                 pan_automation_style_button.set_label (short_astyle_string(_panner->automation_style()));
 546                 break;
 547         }
 548 }
 549
 550 void
 551 PannerUI::pan_automation_state_changed ()
 552 {
 553         boost::shared_ptr<Pannable> pannable (_panner->pannable());
 554
 555         switch (_width) {
 556         case Wide:
 557                 pan_automation_state_button.set_label (astate_string(pannable->automation_state()));
 558                 break;
 559         case Narrow:
 560                 pan_automation_state_button.set_label (short_astate_string(pannable->automation_state()));
 561                 break;
 562         }
 563
 564         bool x = (pannable->automation_state() != ARDOUR::Off);
 565
 566         if (pan_automation_state_button.get_active() != x) {
 567                 ignore_toggle = true;
 568                 pan_automation_state_button.set_active (x);
 569                 ignore_toggle = false;
 570         }
 571
 572         update_pan_sensitive ();
 573
 574         /* start watching automation so that things move */
 575
 576         pan_watching.disconnect();
 577
 578         if (x) {
 579                 pan_watching = ARDOUR_UI::RapidScreenUpdate.connect (sigc::mem_fun (*this, &PannerUI::effective_pan_display));
 580         }
 581 }
 582
 583 string
 584 PannerUI::astate_string (AutoState state)
 585 {
 586         return _astate_string (state, false);
 587 }
 588
 589 string
 590 PannerUI::short_astate_string (AutoState state)
 591 {
 592         return _astate_string (state, true);
 593 }
 594
 595 string
 596 PannerUI::_astate_string (AutoState state, bool shrt)
 597 {
 598         string sstr;
 599
 600         switch (state) {
 601         case ARDOUR::Off:
 602                 sstr = (shrt ? "M" : _("M"));
 603                 break;
 604         case Play:
 605                 sstr = (shrt ? "P" : _("P"));
 606                 break;
 607         case Touch:
 608                 sstr = (shrt ? "T" : _("T"));
 609                 break;
 610         case Write:
 611                 sstr = (shrt ? "W" : _("W"));
 612                 break;
 613         }
 614
 615         return sstr;
 616 }
 617
 618 string
 619 PannerUI::astyle_string (AutoStyle style)
 620 {
 621         return _astyle_string (style, false);
 622 }
 623
 624 string
 625 PannerUI::short_astyle_string (AutoStyle style)
 626 {
 627         return _astyle_string (style, true);
 628 }
 629
 630 string
 631 PannerUI::_astyle_string (AutoStyle style, bool shrt)
 632 {
 633         if (style & Trim) {
 634                 return _("Trim");
 635         } else {
 636                 /* XXX it might different in different languages */
 637
 638                 return (shrt ? _("Abs") : _("Abs"));
 639         }
 640 }
 641
 642 void
 643 PannerUI::show_width ()
 644 {
 645 }
 646
 647 void
 648 PannerUI::width_adjusted ()
 649 {
 650 }
 651
 652 void
 653 PannerUI::show_position ()
 654 {
 655 }
 656
 657 void
 658 PannerUI::position_adjusted ()
 659 {
 660 }
 661
 662 void
 663 PannerUI::set_available_panners(std::map<std::string,std::string> p)
 664 {
 665         _panner_list = p;
 666 }