gtk2_ardour/editor_route_list.cc

   1 /*
   2     Copyright (C) 2000 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
  20 #include <algorithm>
  21 #include <cstdlib>
  22 #include <cmath>
  23 #include <cassert>
  24
  25 #include "editor.h"
  26 #include "keyboard.h"
  27 #include "ardour_ui.h"
  28 #include "audio_time_axis.h"
  29 #include "midi_time_axis.h"
  30 #include "mixer_strip.h"
  31 #include "gui_thread.h"
  32 #include "actions.h"
  33
  34 #include <pbd/unknown_type.h>
  35
  36 #include <ardour/route.h>
  37
  38 #include "i18n.h"
  39
  40 using namespace sigc;
  41 using namespace ARDOUR;
  42 using namespace PBD;
  43 using namespace Gtk;
  44
  45
  46 void
  47 Editor::handle_new_route (Session::RouteList& routes)
  48 {
  49         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::handle_new_route), routes));
  50
  51         TimeAxisView *tv;
  52         RouteTimeAxisView *rtv;
  53         TreeModel::Row parent;
  54         TreeModel::Row row;
  55
  56         for (Session::RouteList::iterator x = routes.begin(); x != routes.end(); ++x) {
  57                 boost::shared_ptr<Route> route = (*x);
  58
  59                 if (route->hidden()) {
  60                         continue;
  61                 }
  62
  63                 if (route->default_type() == ARDOUR::DataType::AUDIO)
  64                         tv = new AudioTimeAxisView (*this, *session, route, track_canvas);
  65                 else if (route->default_type() == ARDOUR::DataType::MIDI)
  66                         tv = new MidiTimeAxisView (*this, *session, route, track_canvas);
  67                 else
  68                         throw unknown_type();
  69
  70 #if 0
  71                 if (route_display_model->children().size() == 0) {
  72
  73                         /* set up basic entries */
  74
  75                         TreeModel::Row row;
  76
  77                         row = *(route_display_model->append());  // path = "0"
  78                         row[route_display_columns.text] = _("Busses");
  79                         row[route_display_columns.tv] = 0;
  80                         row = *(route_display_model->append());  // path = "1"
  81                         row[route_display_columns.text] = _("Tracks");
  82                         row[route_display_columns.tv] = 0;
  83
  84                 }
  85
  86                 if (dynamic_cast<AudioTrack*>(route.get()) != 0) {
  87                         TreeModel::iterator iter = route_display_model->get_iter ("1");  // audio tracks
  88                         parent = *iter;
  89                 } else {
  90                         TreeModel::iterator iter = route_display_model->get_iter ("0");  // busses
  91                         parent = *iter;
  92                 }
  93
  94
  95                 row = *(route_display_model->append (parent.children()));
  96 #else
  97                 row = *(route_display_model->append ());
  98 #endif
  99
 100                 row[route_display_columns.text] = route->name();
 101                 row[route_display_columns.visible] = tv->marked_for_display();
 102                 row[route_display_columns.tv] = tv;
 103
 104                 track_views.push_back (tv);
 105
 106                 ignore_route_list_reorder = true;
 107
 108                 if ((rtv = dynamic_cast<RouteTimeAxisView*> (tv)) != 0) {
 109                         /* added a new fresh one at the end */
 110                         if (rtv->route()->order_key(N_("editor")) == -1) {
 111                                 rtv->route()->set_order_key (N_("editor"), route_display_model->children().size()-1);
 112                         }
 113                 }
 114
 115                 ignore_route_list_reorder = false;
 116
 117                 route->gui_changed.connect (mem_fun(*this, &Editor::handle_gui_changes));
 118
 119                 tv->GoingAway.connect (bind (mem_fun(*this, &Editor::remove_route), tv));
 120         }
 121
 122         if (show_editor_mixer_when_tracks_arrive) {
 123                 show_editor_mixer (true);
 124         }
 125
 126         editor_mixer_button.set_sensitive(true);
 127 }
 128
 129 void
 130 Editor::handle_gui_changes (const string & what, void *src)
 131 {
 132         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::handle_gui_changes), what, src));
 133
 134         if (what == "track_height") {
 135                 redisplay_route_list ();
 136         }
 137 }
 138
 139
 140 void
 141 Editor::remove_route (TimeAxisView *tv)
 142 {
 143         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::remove_route), tv));
 144
 145
 146         TrackViewList::iterator i;
 147         TreeModel::Children rows = route_display_model->children();
 148         TreeModel::Children::iterator ri;
 149
 150         if ((i = find (track_views.begin(), track_views.end(), tv)) != track_views.end()) {
 151                 track_views.erase (i);
 152         }
 153
 154         for (ri = rows.begin(); ri != rows.end(); ++ri) {
 155                 if ((*ri)[route_display_columns.tv] == tv) {
 156                         route_display_model->erase (ri);
 157                         break;
 158                 }
 159         }
 160         /* since the editor mixer goes away when you remove a route, set the
 161          * button to inactive and untick the menu option
 162          */
 163         editor_mixer_button.set_active(false);
 164         ActionManager::uncheck_toggleaction ("<Actions>/Editor/show-editor-mixer");
 165
 166         /* and disable if all tracks and/or routes are gone */
 167
 168         if (track_views.size() == 0) {
 169                 editor_mixer_button.set_sensitive(false);
 170         }
 171 }
 172
 173 void
 174 Editor::route_name_changed (TimeAxisView *tv)
 175 {
 176         ENSURE_GUI_THREAD(bind (mem_fun(*this, &Editor::route_name_changed), tv));
 177
 178         TreeModel::Children rows = route_display_model->children();
 179         TreeModel::Children::iterator i;
 180
 181         for (i = rows.begin(); i != rows.end(); ++i) {
 182                 if ((*i)[route_display_columns.tv] == tv) {
 183                         (*i)[route_display_columns.text] = tv->name();
 184                         break;
 185                 }
 186         }
 187
 188 }
 189
 190 void
 191 Editor::hide_track_in_display (TimeAxisView& tv)
 192 {
 193         TreeModel::Children rows = route_display_model->children();
 194         TreeModel::Children::iterator i;
 195
 196         for (i = rows.begin(); i != rows.end(); ++i) {
 197                 if ((*i)[route_display_columns.tv] == &tv) {
 198                         (*i)[route_display_columns.visible] = false;
 199                         break;
 200                 }
 201         }
 202
 203         RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (&tv);
 204
 205         if (rtv && current_mixer_strip && (rtv->route() == current_mixer_strip->route())) {
 206                 // this will hide the mixer strip
 207                 set_selected_mixer_strip (tv);
 208         }
 209 }
 210
 211 void
 212 Editor::show_track_in_display (TimeAxisView& tv)
 213 {
 214         TreeModel::Children rows = route_display_model->children();
 215         TreeModel::Children::iterator i;
 216
 217         for (i = rows.begin(); i != rows.end(); ++i) {
 218                 if ((*i)[route_display_columns.tv] == &tv) {
 219                         (*i)[route_display_columns.visible] = true;
 220                         tv.set_marked_for_display (true);
 221                         break;
 222                 }
 223         }
 224 }
 225
 226 void
 227 Editor::route_list_reordered (const TreeModel::Path& path,const TreeModel::iterator& iter,int* what)
 228 {
 229         redisplay_route_list ();
 230 }
 231
 232 void
 233 Editor::redisplay_route_list ()
 234 {
 235         TreeModel::Children rows = route_display_model->children();
 236         TreeModel::Children::iterator i;
 237         uint32_t position;
 238         uint32_t order;
 239         int n;
 240
 241         if (no_route_list_redisplay) {
 242                 return;
 243         }
 244
 245         for (n = 0, order = 0, position = 0, i = rows.begin(); i != rows.end(); ++i) {
 246                 TimeAxisView *tv = (*i)[route_display_columns.tv];
 247                 RouteTimeAxisView* rt;
 248
 249                 if (tv == 0) {
 250                         // just a "title" row
 251                         continue;
 252                 }
 253
 254                 if (!ignore_route_list_reorder) {
 255
 256                         /* this reorder is caused by user action, so reassign sort order keys
 257                            to tracks.
 258                         */
 259
 260                         if ((rt = dynamic_cast<RouteTimeAxisView*> (tv)) != 0) {
 261                                 rt->route()->set_order_key (N_("editor"), order);
 262                                 ++order;
 263                         }
 264                 }
 265
 266                 bool visible = (*i)[route_display_columns.visible];
 267
 268                 if (visible) {
 269                         tv->set_marked_for_display (true);
 270                         position += tv->show_at (position, n, &edit_controls_vbox);
 271                 } else {
 272                         tv->hide ();
 273                 }
 274
 275                 n++;
 276
 277         }
 278
 279         full_canvas_height = position;
 280
 281         /* make sure the cursors stay on top of every newly added track */
 282
 283         cursor_group->raise_to_top ();
 284
 285         reset_scrolling_region ();
 286 }
 287
 288 void
 289 Editor::hide_all_tracks (bool with_select)
 290 {
 291         TreeModel::Children rows = route_display_model->children();
 292         TreeModel::Children::iterator i;
 293
 294         no_route_list_redisplay = true;
 295
 296         for (i = rows.begin(); i != rows.end(); ++i) {
 297
 298                 TreeModel::Row row = (*i);
 299                 TimeAxisView *tv = row[route_display_columns.tv];
 300
 301                 if (tv == 0) {
 302                         continue;
 303                 }
 304
 305                 row[route_display_columns.visible] = false;
 306         }
 307
 308         no_route_list_redisplay = false;
 309         redisplay_route_list ();
 310
 311         /* XXX this seems like a hack and half, but its not clear where to put this
 312            otherwise.
 313         */
 314
 315         reset_scrolling_region ();
 316 }
 317
 318 void
 319 Editor::build_route_list_menu ()
 320 {
 321         using namespace Menu_Helpers;
 322         using namespace Gtk;
 323
 324         route_list_menu = new Menu;
 325
 326         MenuList& items = route_list_menu->items();
 327         route_list_menu->set_name ("ArdourContextMenu");
 328
 329         items.push_back (MenuElem (_("Show All"), mem_fun(*this, &Editor::show_all_routes)));
 330         items.push_back (MenuElem (_("Hide All"), mem_fun(*this, &Editor::hide_all_routes)));
 331         items.push_back (MenuElem (_("Show All Audio Tracks"), mem_fun(*this, &Editor::show_all_audiotracks)));
 332         items.push_back (MenuElem (_("Hide All Audio Tracks"), mem_fun(*this, &Editor::hide_all_audiotracks)));
 333         items.push_back (MenuElem (_("Show All Audio Busses"), mem_fun(*this, &Editor::show_all_audiobus)));
 334         items.push_back (MenuElem (_("Hide All Audio Busses"), mem_fun(*this, &Editor::hide_all_audiobus)));
 335
 336 }
 337
 338 void
 339 Editor::set_all_tracks_visibility (bool yn)
 340 {
 341         TreeModel::Children rows = route_display_model->children();
 342         TreeModel::Children::iterator i;
 343
 344         no_route_list_redisplay = true;
 345
 346         for (i = rows.begin(); i != rows.end(); ++i) {
 347
 348                 TreeModel::Row row = (*i);
 349                 TimeAxisView* tv = row[route_display_columns.tv];
 350
 351                 if (tv == 0) {
 352                         continue;
 353                 }
 354
 355                 (*i)[route_display_columns.visible] = yn;
 356         }
 357
 358         no_route_list_redisplay = false;
 359         redisplay_route_list ();
 360 }
 361
 362 void
 363 Editor::set_all_audio_visibility (int tracks, bool yn)
 364 {
 365         TreeModel::Children rows = route_display_model->children();
 366         TreeModel::Children::iterator i;
 367
 368         no_route_list_redisplay = true;
 369
 370         for (i = rows.begin(); i != rows.end(); ++i) {
 371                 TreeModel::Row row = (*i);
 372                 TimeAxisView* tv = row[route_display_columns.tv];
 373                 AudioTimeAxisView* atv;
 374
 375                 if (tv == 0) {
 376                         continue;
 377                 }
 378
 379                 if ((atv = dynamic_cast<AudioTimeAxisView*>(tv)) != 0) {
 380                         switch (tracks) {
 381                         case 0:
 382                                 (*i)[route_display_columns.visible] = yn;
 383                                 break;
 384
 385                         case 1:
 386                                 if (atv->is_audio_track()) {
 387                                         (*i)[route_display_columns.visible] = yn;
 388                                 }
 389                                 break;
 390
 391                         case 2:
 392                                 if (!atv->is_audio_track()) {
 393                                         (*i)[route_display_columns.visible] = yn;
 394                                 }
 395                                 break;
 396                         }
 397                 }
 398         }
 399
 400         no_route_list_redisplay = false;
 401         redisplay_route_list ();
 402 }
 403
 404 void
 405 Editor::hide_all_routes ()
 406 {
 407         set_all_tracks_visibility (false);
 408 }
 409
 410 void
 411 Editor::show_all_routes ()
 412 {
 413         set_all_tracks_visibility (true);
 414 }
 415
 416 void
 417 Editor::show_all_audiobus ()
 418 {
 419         set_all_audio_visibility (2, true);
 420 }
 421 void
 422 Editor::hide_all_audiobus ()
 423 {
 424         set_all_audio_visibility (2, false);
 425 }
 426
 427 void
 428 Editor::show_all_audiotracks()
 429 {
 430         set_all_audio_visibility (1, true);
 431 }
 432 void
 433 Editor::hide_all_audiotracks ()
 434 {
 435         set_all_audio_visibility (1, false);
 436 }
 437
 438 bool
 439 Editor::route_list_display_button_press (GdkEventButton* ev)
 440 {
 441         if (Keyboard::is_context_menu_event (ev)) {
 442                 show_route_list_menu ();
 443                 return true;
 444         }
 445
 446         TreeIter iter;
 447         TreeModel::Path path;
 448         TreeViewColumn* column;
 449         int cellx;
 450         int celly;
 451
 452         if (!route_list_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
 453                 return false;
 454         }
 455
 456         switch (GPOINTER_TO_UINT (column->get_data (X_("colnum")))) {
 457         case 0:
 458                 if ((iter = route_display_model->get_iter (path))) {
 459                         TimeAxisView* tv = (*iter)[route_display_columns.tv];
 460                         if (tv) {
 461                                 bool visible = (*iter)[route_display_columns.visible];
 462                                 (*iter)[route_display_columns.visible] = !visible;
 463                         }
 464                 }
 465                 return true;
 466
 467         case 1:
 468                 /* allow normal processing to occur */
 469                 return false;
 470
 471         default:
 472                 break;
 473         }
 474
 475         return false;
 476 }
 477
 478 void
 479 Editor::show_route_list_menu()
 480 {
 481         if (route_list_menu == 0) {
 482                 build_route_list_menu ();
 483         }
 484
 485         route_list_menu->popup (1, gtk_get_current_event_time());
 486 }
 487
 488 bool
 489 Editor::route_list_selection_filter (const Glib::RefPtr<TreeModel>& model, const TreeModel::Path& path, bool yn)
 490 {
 491         return true;
 492 }
 493
 494 struct EditorOrderRouteSorter {
 495     bool operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b) {
 496             /* use of ">" forces the correct sort order */
 497             return a->order_key ("editor") < b->order_key ("editor");
 498     }
 499 };
 500
 501 void
 502 Editor::initial_route_list_display ()
 503 {
 504         boost::shared_ptr<Session::RouteList> routes = session->get_routes();
 505         Session::RouteList r (*routes);
 506         EditorOrderRouteSorter sorter;
 507
 508         r.sort (sorter);
 509
 510         no_route_list_redisplay = true;
 511
 512         route_display_model->clear ();
 513
 514         handle_new_route (r);
 515
 516         no_route_list_redisplay = false;
 517
 518         redisplay_route_list ();
 519 }
 520
 521 void
 522 Editor::route_list_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter)
 523 {
 524         session->set_remote_control_ids();
 525         redisplay_route_list ();
 526 }
 527
 528 void
 529 Editor::route_list_delete (const Gtk::TreeModel::Path& path)
 530 {
 531         session->set_remote_control_ids();
 532         redisplay_route_list ();
 533 }