gtk2_ardour/mixer_ui.h

   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 #ifndef __ardour_mixer_ui_h__
  21 #define __ardour_mixer_ui_h__
  22
  23 #include <list>
  24
  25 #include <gtkmm/box.h>
  26 #include <gtkmm/scrolledwindow.h>
  27 #include <gtkmm/eventbox.h>
  28 #include <gtkmm/label.h>
  29 #include <gtkmm/comboboxtext.h>
  30 #include <gtkmm/button.h>
  31 #include <gtkmm/frame.h>
  32 #include <gtkmm/menu.h>
  33 #include <gtkmm/treeview.h>
  34 #include <gtkmm/treestore.h>
  35 #include <gtkmm/liststore.h>
  36
  37 #include "pbd/stateful.h"
  38 #include "pbd/signals.h"
  39
  40 #include "ardour/ardour.h"
  41 #include "ardour/types.h"
  42 #include "ardour/session_handle.h"
  43 #include "ardour/plugin.h"
  44 #include "ardour/plugin_manager.h"
  45
  46 #include <gtkmm2ext/bindings.h>
  47 #include "gtkmm2ext/dndtreeview.h"
  48 #include "gtkmm2ext/treeutils.h"
  49
  50 #include "widgets/pane.h"
  51 #include "widgets/tabbable.h"
  52
  53 #include "axis_provider.h"
  54 #include "enums.h"
  55 #include "route_processor_selection.h"
  56
  57 namespace ARDOUR {
  58         class Route;
  59         class RouteGroup;
  60         class VCA;
  61 };
  62
  63 class AxisView;
  64 class MixerStrip;
  65 class PluginSelector;
  66 class MixerGroupTabs;
  67 class MonitorSection;
  68 class VCAMasterStrip;
  69
  70 class PluginTreeStore : public Gtk::TreeStore
  71 {
  72 public:
  73         static Glib::RefPtr<PluginTreeStore> create(const Gtk::TreeModelColumnRecord& columns) {
  74                 return Glib::RefPtr<PluginTreeStore> (new PluginTreeStore (columns));
  75         }
  76
  77 protected:
  78         PluginTreeStore (const Gtk::TreeModelColumnRecord& columns) : Gtk::TreeStore (columns) {}
  79         virtual bool row_draggable_vfunc (const Gtk::TreeModel::Path&) const { return true; }
  80         virtual bool row_drop_possible_vfunc (const Gtk::TreeModel::Path&, const Gtk::SelectionData&) const;
  81 };
  82
  83 class Mixer_UI : public ArdourWidgets::Tabbable, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr, public AxisViewProvider
  84 {
  85 public:
  86         static Mixer_UI* instance();
  87         ~Mixer_UI();
  88
  89         Gtk::Window* use_own_window (bool and_fill_it);
  90         void show_window ();
  91
  92         void set_session (ARDOUR::Session *);
  93
  94         PluginSelector* plugin_selector();
  95
  96         void  set_strip_width (Width, bool save = false);
  97         Width get_strip_width () const { return _strip_width; }
  98
  99         XMLNode& get_state ();
 100         int set_state (const XMLNode&, int /* version */);
 101
 102         void save_plugin_order_file ();
 103
 104         void show_mixer_list (bool yn);
 105         void show_monitor_section (bool);
 106
 107         void show_strip (MixerStrip *);
 108         void hide_strip (MixerStrip *);
 109
 110         void maximise_mixer_space();
 111         void restore_mixer_space();
 112
 113         MonitorSection* monitor_section() const { return _monitor_section; }
 114
 115         void deselect_all_strip_processors();
 116         void delete_processors();
 117         void select_none ();
 118
 119         void select_next_strip ();
 120         void select_prev_strip ();
 121
 122         void do_vca_assign (boost::shared_ptr<ARDOUR::VCA>);
 123         void do_vca_unassign (boost::shared_ptr<ARDOUR::VCA>);
 124         void show_spill (boost::shared_ptr<ARDOUR::Stripable>);
 125         bool showing_spill_for (boost::shared_ptr<ARDOUR::Stripable>) const;
 126
 127         sigc::signal1<void,boost::shared_ptr<ARDOUR::Stripable> > show_spill_change;
 128
 129         RouteProcessorSelection& selection() { return _selection; }
 130
 131         void show_editor_window () const;
 132
 133         void register_actions ();
 134
 135         void load_bindings ();
 136         Gtkmm2ext::Bindings*  bindings;
 137
 138         void showhide_vcas (bool on) {
 139                 if (on) { vca_vpacker.show(); } else { vca_vpacker.hide(); }
 140         }
 141 #ifdef MIXBUS
 142         void showhide_mixbusses (bool on) {
 143                 if (on) { mb_vpacker.show(); } else { mb_vpacker.hide(); }
 144         }
 145 #endif
 146
 147 protected:
 148         void set_axis_targets_for_operation ();
 149         ARDOUR::AutomationControlSet selected_gaincontrols ();
 150
 151 private:
 152         Mixer_UI ();
 153         static Mixer_UI*     _instance;
 154         Gtk::VBox            _content;
 155         Gtk::HBox             global_hpacker;
 156         Gtk::VBox             global_vpacker;
 157         Gtk::ScrolledWindow   scroller;
 158         Gtk::EventBox         scroller_base;
 159         Gtk::HBox             scroller_hpacker;
 160         Gtk::VBox             mixer_scroller_vpacker;
 161         Gtk::VBox             list_vpacker;
 162         Gtk::Label            group_display_button_label;
 163         Gtk::ScrolledWindow   track_display_scroller;
 164         Gtk::ScrolledWindow   group_display_scroller;
 165         Gtk::ScrolledWindow   favorite_plugins_scroller;
 166         Gtk::VBox             group_display_vbox;
 167         Gtk::Frame            track_display_frame;
 168         Gtk::Frame            group_display_frame;
 169         Gtk::Frame            favorite_plugins_frame;
 170         Gtk::VBox             favorite_plugins_vbox;
 171         Gtk::ComboBoxText     favorite_plugins_tag_combo;
 172         ArdourWidgets::VPane  rhs_pane1;
 173         ArdourWidgets::VPane  rhs_pane2;
 174         ArdourWidgets::HPane  inner_pane;
 175         Gtk::HBox             strip_packer;
 176         Gtk::ScrolledWindow   vca_scroller;
 177         Gtk::HBox             vca_hpacker;
 178         Gtk::VBox             vca_vpacker;
 179         Gtk::EventBox         vca_label_bar;
 180         Gtk::Label            vca_label;
 181         Gtk::EventBox         vca_scroller_base;
 182         Gtk::HBox             out_packer;
 183         ArdourWidgets::HPane  list_hpane;
 184         Gtk::Button           add_button; // should really be an ArdourButton
 185         Gtk::Button           add_vca_button;
 186
 187         MixerGroupTabs* _group_tabs;
 188
 189         bool on_scroll_event (GdkEventScroll*);
 190
 191         std::list<MixerStrip *> strips;
 192
 193         void scroller_drag_data_received (const Glib::RefPtr<Gdk::DragContext>&, int, int, const Gtk::SelectionData&, guint, guint);
 194         bool strip_scroller_button_release (GdkEventButton*);
 195         bool masters_scroller_button_release (GdkEventButton*);
 196         void scroll_left ();
 197         void scroll_right ();
 198         void toggle_midi_input_active (bool flip_others);
 199
 200         void move_stripable_into_view (boost::shared_ptr<ARDOUR::Stripable>);
 201
 202         void add_stripables (ARDOUR::StripableList&);
 203
 204         void add_routes (ARDOUR::RouteList&);
 205         void remove_strip (MixerStrip *);
 206
 207         void add_masters (ARDOUR::VCAList&);
 208         void remove_master (VCAMasterStrip*);
 209
 210         MixerStrip* strip_by_route (boost::shared_ptr<ARDOUR::Route>) const;
 211         MixerStrip* strip_by_stripable (boost::shared_ptr<ARDOUR::Stripable>) const;
 212
 213         AxisView* axis_view_by_stripable (boost::shared_ptr<ARDOUR::Stripable>) const;
 214         AxisView* axis_view_by_control (boost::shared_ptr<ARDOUR::AutomationControl>) const;
 215
 216         gint start_updating ();
 217         gint stop_updating ();
 218
 219         void session_going_away ();
 220
 221         sigc::connection fast_screen_update_connection;
 222         void fast_update_strips ();
 223
 224         void track_name_changed (MixerStrip *);
 225
 226         void redisplay_track_list ();
 227         void spill_redisplay (boost::shared_ptr<ARDOUR::VCA>);
 228         bool no_track_list_redisplay;
 229         bool track_display_button_press (GdkEventButton*);
 230         void strip_width_changed ();
 231
 232         void track_list_delete (const Gtk::TreeModel::Path&);
 233         void track_list_reorder (const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter, int* new_order);
 234
 235         void plugin_row_activated (const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* column);
 236         bool plugin_row_button_press (GdkEventButton*);
 237         void popup_note_context_menu (GdkEventButton*);
 238         void plugin_drop (const Glib::RefPtr<Gdk::DragContext>&, const Gtk::SelectionData& data);
 239
 240         enum ProcessorPosition {
 241                 AddTop,
 242                 AddPreFader,
 243                 AddPostFader,
 244                 AddBottom
 245         };
 246
 247         void add_selected_processor (ProcessorPosition);
 248         void add_favorite_processor (ARDOUR::PluginPresetPtr, ProcessorPosition);
 249         void remove_selected_from_favorites ();
 250         void delete_selected_preset ();
 251         ARDOUR::PluginPresetPtr selected_plugin ();
 252
 253         void initial_track_display ();
 254
 255         void set_all_strips_visibility (bool yn);
 256         void set_all_audio_midi_visibility (int, bool);
 257         void track_visibility_changed (std::string const & path);
 258         void update_track_visibility ();
 259
 260         void hide_all_routes ();
 261         void show_all_routes ();
 262         void show_all_audiobus ();
 263         void hide_all_audiobus ();
 264         void show_all_audiotracks();
 265         void hide_all_audiotracks ();
 266         void show_all_miditracks();
 267         void hide_all_miditracks ();
 268
 269         bool in_group_row_change;
 270
 271         void group_selected (gint row, gint col, GdkEvent *ev);
 272         void group_unselected (gint row, gint col, GdkEvent *ev);
 273         void group_display_active_clicked();
 274         void new_route_group ();
 275         void remove_selected_route_group ();
 276         void activate_all_route_groups ();
 277         void disable_all_route_groups ();
 278         void add_route_group (ARDOUR::RouteGroup *);
 279         void route_groups_changed ();
 280         void route_group_name_edit (const std::string&, const std::string&);
 281         void route_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
 282         void route_group_row_deleted (Gtk::TreeModel::Path const &);
 283
 284         Gtk::Menu *track_menu;
 285         void track_column_click (gint);
 286         void build_track_menu ();
 287
 288         MonitorSection* _monitor_section;
 289         PluginSelector    *_plugin_selector;
 290
 291         void stripable_property_changed (const PBD::PropertyChange& what_changed, boost::weak_ptr<ARDOUR::Stripable> ws);
 292         void route_group_property_changed (ARDOUR::RouteGroup *, const PBD::PropertyChange &);
 293
 294         /* various treeviews */
 295
 296         struct StripableDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 297                 StripableDisplayModelColumns () {
 298                         add (text);
 299                         add (visible);
 300                         add (stripable);
 301                         add (strip);
 302                 }
 303                 Gtk::TreeModelColumn<bool>         visible;
 304                 Gtk::TreeModelColumn<std::string>  text;
 305                 Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Stripable> > stripable;
 306                 Gtk::TreeModelColumn<AxisView*>    strip;
 307         };
 308
 309         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 310                 GroupDisplayModelColumns() {
 311                         add (visible);
 312                         add (text);
 313                         add (group);
 314                 }
 315                 Gtk::TreeModelColumn<bool>            visible;
 316                 Gtk::TreeModelColumn<std::string>         text;
 317                 Gtk::TreeModelColumn<ARDOUR::RouteGroup*> group;
 318         };
 319
 320         struct PluginsDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 321                 PluginsDisplayModelColumns() {
 322                         add (name);
 323                         add (plugin);
 324                 }
 325                 Gtk::TreeModelColumn<std::string> name;
 326                 Gtk::TreeModelColumn<ARDOUR::PluginPresetPtr> plugin;
 327         };
 328
 329         ARDOUR::PluginInfoList favorite_order;
 330         std::map<std::string, bool> favorite_ui_state;
 331
 332         StripableDisplayModelColumns stripable_columns;
 333         GroupDisplayModelColumns     group_columns;
 334         PluginsDisplayModelColumns   favorite_plugins_columns;
 335
 336         Gtk::TreeView track_display;
 337         Gtk::TreeView group_display;
 338         Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr> favorite_plugins_display;
 339
 340         Glib::RefPtr<Gtk::ListStore> track_model;
 341         Glib::RefPtr<Gtk::ListStore> group_model;
 342         Glib::RefPtr<PluginTreeStore> favorite_plugins_model;
 343
 344         bool group_display_button_press (GdkEventButton*);
 345         void group_display_selection_changed ();
 346
 347         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
 348         bool vca_button_release_event (GdkEventButton*, VCAMasterStrip*);
 349
 350         Width _strip_width;
 351         double _spill_scroll_position;
 352
 353         void presentation_info_changed (PBD::PropertyChange const &);
 354         void sync_treeview_from_presentation_info (PBD::PropertyChange const &);
 355         void sync_presentation_info_from_treeview ();
 356
 357         bool ignore_reorder;
 358
 359         void parameter_changed (std::string const &);
 360         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
 361
 362         void setup_track_display ();
 363         void new_track_or_bus ();
 364
 365         static const int32_t default_width = 478;
 366         static const int32_t default_height = 765;
 367
 368         /** true if we are rebuilding the route group list, or clearing
 369          * it during a session teardown.
 370          */
 371         bool _in_group_rebuild_or_clear;
 372         bool _route_deletion_in_progress;
 373
 374         void update_title ();
 375         MixerStrip* strip_by_x (int x);
 376
 377         friend class MixerGroupTabs;
 378
 379         void monitor_section_going_away ();
 380
 381         void monitor_section_attached ();
 382         void monitor_section_detached ();
 383
 384         void store_current_favorite_order();
 385         void refiller (ARDOUR::PluginInfoList& result, const ARDOUR::PluginInfoList& plugs);
 386
 387         void plugin_list_changed ();
 388
 389         void refill_favorite_plugins ();
 390         void refill_tag_combo ();
 391
 392         void tag_combo_changed ();
 393
 394         void sync_treeview_from_favorite_order ();
 395         void sync_treeview_favorite_ui_state (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&);
 396         void save_favorite_ui_state (const Gtk::TreeModel::iterator& iter, const Gtk::TreeModel::Path& path);
 397
 398         /// true if we are in fullscreen mode
 399         bool _maximised;
 400
 401         // true if mixer list is visible
 402         bool _show_mixer_list;
 403
 404         bool _strip_selection_change_without_scroll;
 405
 406         mutable boost::weak_ptr<ARDOUR::Stripable> spilled_strip;
 407
 408         void escape ();
 409
 410         Gtkmm2ext::ActionMap myactions;
 411         RouteProcessorSelection _selection;
 412         AxisViewSelection _axis_targets;
 413
 414         void vca_assign (boost::shared_ptr<ARDOUR::VCA>);
 415         void vca_unassign (boost::shared_ptr<ARDOUR::VCA>);
 416
 417         template<class T> void control_action (boost::shared_ptr<T> (ARDOUR::Stripable::*get_control)() const);
 418         void solo_action ();
 419         void mute_action ();
 420         void rec_enable_action ();
 421         void step_gain_up_action ();
 422         void step_gain_down_action ();
 423         void unity_gain_action ();
 424
 425         void copy_processors ();
 426         void cut_processors ();
 427         void paste_processors ();
 428         void select_all_processors ();
 429         void toggle_processors ();
 430         void ab_plugins ();
 431 };
 432
 433 #endif /* __ardour_mixer_ui_h__ */