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