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