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 #include <gtkmm2ext/barcontroller.h>
  23
  24 #include "pbd/fastlog.h"
  25
  26 #include "ardour/pannable.h"
  27 #include "ardour/panner.h"
  28 #include "ardour/panner_shell.h"
  29 #include "ardour/session.h"
  30
  31 #include "ardour_ui.h"
  32 #include "panner_ui.h"
  33 #include "panner2d.h"
  34 #include "utils.h"
  35 #include "gui_thread.h"
  36 #include "stereo_panner.h"
  37 #include "mono_panner.h"
  38
  39 #include "i18n.h"
  40
  41 using namespace std;
  42 using namespace ARDOUR;
  43 using namespace PBD;
  44 using namespace Gtkmm2ext;
  45 using namespace Gtk;
  46
  47 const int PannerUI::pan_bar_height = 35;
  48
  49 PannerUI::PannerUI (Session* s)
  50         : _current_nouts (-1)
  51         , _current_nins (-1)
  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 && nins == _current_nins) {
 218                 return;
 219         }
 220
 221         _current_nins = nins;
 222         _current_nouts = nouts;
 223
 224         container_clear (pan_vbox);
 225
 226         delete twod_panner;
 227         twod_panner = 0;
 228         delete _stereo_panner;
 229         _stereo_panner = 0;
 230         delete _mono_panner;
 231         _mono_panner = 0;
 232
 233         if (!_panner) {
 234                 return;
 235         }
 236
 237         if (_panshell->panner_gui_uri() == "http://ardour.org/plugin/panner_2in2out#ui")
 238         {
 239                 boost::shared_ptr<Pannable> pannable = _panner->pannable();
 240
 241                 _stereo_panner = new StereoPanner (_panshell);
 242                 _stereo_panner->set_size_request (-1, pan_bar_height);
 243                 pan_vbox.pack_start (*_stereo_panner, false, false);
 244
 245                 boost::shared_ptr<AutomationControl> ac;
 246
 247                 ac = pannable->pan_azimuth_control;
 248                 _stereo_panner->StartPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 249                                         boost::weak_ptr<AutomationControl> (ac)));
 250                 _stereo_panner->StopPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 251                                         boost::weak_ptr<AutomationControl>(ac)));
 252
 253                 ac = pannable->pan_width_control;
 254                 _stereo_panner->StartWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 255                                         boost::weak_ptr<AutomationControl> (ac)));
 256                 _stereo_panner->StopWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 257                                         boost::weak_ptr<AutomationControl>(ac)));
 258                 _stereo_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
 259         }
 260         else if (_panshell->panner_gui_uri() == "http://ardour.org/plugin/panner_1in2out#ui"
 261                         || _panshell->panner_gui_uri() == "http://ardour.org/plugin/panner_balance#ui")
 262         {
 263                 boost::shared_ptr<Pannable> pannable = _panner->pannable();
 264                 boost::shared_ptr<AutomationControl> ac = pannable->pan_azimuth_control;
 265
 266                 _mono_panner = new MonoPanner (_panshell);
 267
 268                 _mono_panner->StartGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
 269                                         boost::weak_ptr<AutomationControl> (ac)));
 270                 _mono_panner->StopGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
 271                                         boost::weak_ptr<AutomationControl>(ac)));
 272
 273                 _mono_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
 274
 275                 _mono_panner->set_size_request (-1, pan_bar_height);
 276
 277                 update_pan_sensitive ();
 278                 pan_vbox.pack_start (*_mono_panner, false, false);
 279         }
 280         else if (_panshell->panner_gui_uri() == "http://ardour.org/plugin/panner_vbap#ui")
 281         {
 282                 if (!twod_panner) {
 283                         twod_panner = new Panner2d (_panshell, 61);
 284                         twod_panner->set_name ("MixerPanZone");
 285                         twod_panner->show ();
 286                         twod_panner->signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event), false);
 287                 }
 288
 289                 update_pan_sensitive ();
 290                 twod_panner->reset (nins);
 291                 if (big_window) {
 292                         big_window->reset (nins);
 293                 }
 294                 twod_panner->set_size_request (-1, 61);
 295
 296                 /* and finally, add it to the panner frame */
 297
 298                 pan_vbox.pack_start (*twod_panner, false, false);
 299         }
 300         else
 301         {
 302                 /* stick something into the panning viewport so that it redraws */
 303                 EventBox* eb = manage (new EventBox());
 304                 pan_vbox.pack_start (*eb, false, false);
 305
 306                 delete big_window;
 307                 big_window = 0;
 308         }
 309
 310         pan_vbox.show_all ();
 311 }
 312
 313 void
 314 PannerUI::start_touch (boost::weak_ptr<AutomationControl> wac)
 315 {
 316         boost::shared_ptr<AutomationControl> ac = wac.lock();
 317         if (!ac) {
 318                 return;
 319         }
 320         ac->start_touch (ac->session().transport_frame());
 321 }
 322
 323 void
 324 PannerUI::stop_touch (boost::weak_ptr<AutomationControl> wac)
 325 {
 326         boost::shared_ptr<AutomationControl> ac = wac.lock();
 327         if (!ac) {
 328                 return;
 329         }
 330         ac->stop_touch (false, ac->session().transport_frame());
 331 }
 332
 333 bool
 334 PannerUI::pan_button_event (GdkEventButton* ev)
 335 {
 336         switch (ev->button) {
 337         case 1:
 338                 if (twod_panner && ev->type == GDK_2BUTTON_PRESS) {
 339                         if (!big_window) {
 340                                 big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
 341                         }
 342                         big_window->show ();
 343                         return true;
 344                 }
 345                 break;
 346
 347         case 3:
 348                 if (pan_menu == 0) {
 349                         pan_menu = manage (new Menu);
 350                         pan_menu->set_name ("ArdourContextMenu");
 351                 }
 352                 build_pan_menu ();
 353                 pan_menu->popup (1, ev->time);
 354                 return true;
 355                 break;
 356         default:
 357                 return false;
 358         }
 359
 360         return false; // what's wrong with gcc?
 361 }
 362
 363 void
 364 PannerUI::build_pan_menu ()
 365 {
 366         using namespace Menu_Helpers;
 367         MenuList& items (pan_menu->items());
 368
 369         items.clear ();
 370
 371         items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
 372         bypass_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());
 373
 374         /* set state first, connect second */
 375
 376         bypass_menu_item->set_active (_panshell->bypassed());
 377         bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));
 378
 379         if (!_panshell->bypassed()) {
 380                 items.push_back (MenuElem (_("Reset"), sigc::mem_fun (*this, &PannerUI::pan_reset)));
 381                 items.push_back (MenuElem (_("Edit..."), sigc::mem_fun (*this, &PannerUI::pan_edit)));
 382         }
 383
 384         if (_route && _panner_list.size() > 1 && !_panshell->bypassed()) {
 385                 RadioMenuItem::Group group;
 386                 items.push_back (SeparatorElem());
 387
 388                 assert(_panshell->user_selected_panner_uri() == ""
 389                                 ||  _panshell->user_selected_panner_uri() == _panshell->current_panner_uri());
 390
 391                 _suspend_menu_callbacks = true;
 392                 for (std::map<std::string,std::string>::const_iterator p = _panner_list.begin(); p != _panner_list.end(); ++p) {
 393                         items.push_back (RadioMenuElem (group, p->second,
 394                                                 sigc::bind(sigc::mem_fun (*this, &PannerUI::pan_set_custom_type), p->first)));
 395                         RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
 396                         i->set_active (_panshell->current_panner_uri() == p->first);
 397                 }
 398                 _suspend_menu_callbacks = false;
 399         }
 400 }
 401
 402 void
 403 PannerUI::pan_bypass_toggle ()
 404 {
 405         if (bypass_menu_item && (_panshell->bypassed() != bypass_menu_item->get_active())) {
 406                 _panshell->set_bypassed (!_panshell->bypassed());
 407         }
 408 }
 409
 410 void
 411 PannerUI::pan_edit ()
 412 {
 413         if (_panshell->bypassed()) {
 414                 return;
 415         }
 416         if (_mono_panner) {
 417                 _mono_panner->edit ();
 418         } else if (_stereo_panner) {
 419                 _stereo_panner->edit ();
 420         }
 421 }
 422
 423 void
 424 PannerUI::pan_reset ()
 425 {
 426         if (_panshell->bypassed()) {
 427                 return;
 428         }
 429         _panner->reset ();
 430 }
 431
 432 void
 433 PannerUI::pan_set_custom_type (std::string uri) {
 434         if (_suspend_menu_callbacks) return;
 435         if (_route) {
 436                 _route->set_custom_panner_uri(uri);
 437         }
 438 }
 439
 440 void
 441 PannerUI::effective_pan_display ()
 442 {
 443         if (_stereo_panner) {
 444                 _stereo_panner->queue_draw ();
 445         } else if (_mono_panner) {
 446                 _mono_panner->queue_draw ();
 447         } else if (twod_panner) {
 448                 twod_panner->queue_draw ();
 449         }
 450 }
 451
 452 void
 453 PannerUI::update_pan_sensitive ()
 454 {
 455         bool const sensitive = !(_panner->pannable()->automation_state() & Play);
 456
 457         pan_vbox.set_sensitive (sensitive);
 458
 459         if (big_window) {
 460                 big_window->set_sensitive (sensitive);
 461         }
 462 }
 463
 464 gint
 465 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
 466 {
 467         using namespace Menu_Helpers;
 468
 469         if (ev->type == GDK_BUTTON_RELEASE) {
 470                 return TRUE;
 471         }
 472
 473         switch (ev->button) {
 474         case 1:
 475                 if (pan_astate_menu == 0) {
 476                         build_astate_menu ();
 477                 }
 478                 pan_astate_menu->popup (1, ev->time);
 479                 break;
 480         default:
 481                 break;
 482         }
 483
 484         return TRUE;
 485 }
 486
 487 gint
 488 PannerUI::pan_automation_style_button_event (GdkEventButton *ev)
 489 {
 490         if (ev->type == GDK_BUTTON_RELEASE) {
 491                 return TRUE;
 492         }
 493
 494         switch (ev->button) {
 495         case 1:
 496                 if (pan_astyle_menu == 0) {
 497                         build_astyle_menu ();
 498                 }
 499                 pan_astyle_menu->popup (1, ev->time);
 500                 break;
 501         default:
 502                 break;
 503         }
 504         return TRUE;
 505 }
 506
 507 void
 508 PannerUI::pan_automation_style_changed ()
 509 {
 510         ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_style_changed)
 511
 512         switch (_width) {
 513         case Wide:
 514                 pan_automation_style_button.set_label (astyle_string(_panner->automation_style()));
 515                 break;
 516         case Narrow:
 517                 pan_automation_style_button.set_label (short_astyle_string(_panner->automation_style()));
 518                 break;
 519         }
 520 }
 521
 522 void
 523 PannerUI::pan_automation_state_changed ()
 524 {
 525         boost::shared_ptr<Pannable> pannable (_panner->pannable());
 526
 527         switch (_width) {
 528         case Wide:
 529                 pan_automation_state_button.set_label (astate_string(pannable->automation_state()));
 530                 break;
 531         case Narrow:
 532                 pan_automation_state_button.set_label (short_astate_string(pannable->automation_state()));
 533                 break;
 534         }
 535
 536         bool x = (pannable->automation_state() != ARDOUR::Off);
 537
 538         if (pan_automation_state_button.get_active() != x) {
 539                 ignore_toggle = true;
 540                 pan_automation_state_button.set_active (x);
 541                 ignore_toggle = false;
 542         }
 543
 544         update_pan_sensitive ();
 545
 546         /* start watching automation so that things move */
 547
 548         pan_watching.disconnect();
 549
 550         if (x) {
 551                 pan_watching = ARDOUR_UI::RapidScreenUpdate.connect (sigc::mem_fun (*this, &PannerUI::effective_pan_display));
 552         }
 553 }
 554
 555 string
 556 PannerUI::astate_string (AutoState state)
 557 {
 558         return _astate_string (state, false);
 559 }
 560
 561 string
 562 PannerUI::short_astate_string (AutoState state)
 563 {
 564         return _astate_string (state, true);
 565 }
 566
 567 string
 568 PannerUI::_astate_string (AutoState state, bool shrt)
 569 {
 570         string sstr;
 571
 572         switch (state) {
 573         case ARDOUR::Off:
 574                 sstr = (shrt ? "M" : _("M"));
 575                 break;
 576         case Play:
 577                 sstr = (shrt ? "P" : _("P"));
 578                 break;
 579         case Touch:
 580                 sstr = (shrt ? "T" : _("T"));
 581                 break;
 582         case Write:
 583                 sstr = (shrt ? "W" : _("W"));
 584                 break;
 585         }
 586
 587         return sstr;
 588 }
 589
 590 string
 591 PannerUI::astyle_string (AutoStyle style)
 592 {
 593         return _astyle_string (style, false);
 594 }
 595
 596 string
 597 PannerUI::short_astyle_string (AutoStyle style)
 598 {
 599         return _astyle_string (style, true);
 600 }
 601
 602 string
 603 PannerUI::_astyle_string (AutoStyle style, bool shrt)
 604 {
 605         if (style & Trim) {
 606                 return _("Trim");
 607         } else {
 608                 /* XXX it might different in different languages */
 609
 610                 return (shrt ? _("Abs") : _("Abs"));
 611         }
 612 }
 613
 614 void
 615 PannerUI::show_width ()
 616 {
 617 }
 618
 619 void
 620 PannerUI::width_adjusted ()
 621 {
 622 }
 623
 624 void
 625 PannerUI::show_position ()
 626 {
 627 }
 628
 629 void
 630 PannerUI::position_adjusted ()
 631 {
 632 }
 633
 634 void
 635 PannerUI::set_available_panners(boost::shared_ptr<ARDOUR::Route> r, std::map<std::string,std::string> p)
 636 {
 637         _route = r;
 638         _panner_list = p;
 639 }