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