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/button.h>
  30 #include <gtkmm/frame.h>
  31 #include <gtkmm/paned.h>
  32 #include <gtkmm/menu.h>
  33 #include <gtkmm/treeview.h>
  34 #include <gtkmm/liststore.h>
  35
  36 #include "pbd/stateful.h"
  37 #include "pbd/signals.h"
  38
  39 #include "ardour/ardour.h"
  40 #include "ardour/types.h"
  41 #include "ardour/session_handle.h"
  42 #include "ardour/plugin.h"
  43 #include "ardour/plugin_manager.h"
  44
  45
  46 #include "gtkmm2ext/dndtreeview.h"
  47 #include "gtkmm2ext/treeutils.h"
  48
  49 #include "gtkmm2ext/tabbable.h"
  50
  51 #include "enums.h"
  52 #include "mixer_actor.h"
  53
  54 namespace ARDOUR {
  55         class Route;
  56         class RouteGroup;
  57 };
  58
  59 class MixerStrip;
  60 class PluginSelector;
  61 class MixerGroupTabs;
  62 class MonitorSection;
  63 class VCAMasterStrip;
  64
  65 class PluginTreeStore : public Gtk::TreeStore
  66 {
  67 public:
  68         static Glib::RefPtr<PluginTreeStore> create(const Gtk::TreeModelColumnRecord& columns) {
  69                 return Glib::RefPtr<PluginTreeStore> (new PluginTreeStore (columns));
  70         }
  71
  72 protected:
  73         PluginTreeStore (const Gtk::TreeModelColumnRecord& columns) : Gtk::TreeStore (columns) {}
  74         virtual bool row_draggable_vfunc (const Gtk::TreeModel::Path&) const { return true; }
  75         virtual bool row_drop_possible_vfunc (const Gtk::TreeModel::Path&, const Gtk::SelectionData&) const;
  76 };
  77
  78 class Mixer_UI : public Gtkmm2ext::Tabbable, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr, public MixerActor
  79 {
  80   public:
  81         static Mixer_UI* instance();
  82         ~Mixer_UI();
  83
  84         Gtk::Window* use_own_window (bool and_fill_it);
  85         void show_window ();
  86
  87         void set_session (ARDOUR::Session *);
  88         void track_editor_selection ();
  89
  90         PluginSelector* plugin_selector();
  91
  92         void  set_strip_width (Width, bool save = false);
  93         Width get_strip_width () const { return _strip_width; }
  94
  95         void unselect_strip_in_display (MixerStrip*);
  96         void select_strip_in_display (MixerStrip*);
  97
  98         XMLNode& get_state ();
  99         int set_state (const XMLNode&, int /* version */);
 100
 101         void show_mixer_list (bool yn);
 102         void show_monitor_section (bool);
 103
 104         void show_strip (MixerStrip *);
 105         void hide_strip (MixerStrip *);
 106
 107         void maximise_mixer_space();
 108         void restore_mixer_space();
 109
 110         MonitorSection* monitor_section() const { return _monitor_section; }
 111
 112         void deselect_all_strip_processors();
 113         void delete_processors();
 114
 115         void select_none ();
 116
 117         bool window_not_visible () const;
 118
 119         void do_vca_assign (boost::shared_ptr<ARDOUR::VCA>);
 120         void do_vca_unassign (boost::shared_ptr<ARDOUR::VCA>);
 121
 122   protected:
 123         void set_route_targets_for_operation ();
 124
 125   private:
 126         Mixer_UI ();
 127         static Mixer_UI*     _instance;
 128         Gtk::VBox            _content;
 129         Gtk::HBox             global_hpacker;
 130         Gtk::VBox             global_vpacker;
 131         Gtk::ScrolledWindow   scroller;
 132         Gtk::EventBox         scroller_base;
 133         Gtk::HBox             scroller_hpacker;
 134         Gtk::VBox             mixer_scroller_vpacker;
 135         Gtk::VBox             list_vpacker;
 136         Gtk::Label                              group_display_button_label;
 137         Gtk::Button                             group_display_button;
 138         Gtk::ScrolledWindow             track_display_scroller;
 139         Gtk::ScrolledWindow             group_display_scroller;
 140         Gtk::ScrolledWindow             favorite_plugins_scroller;
 141         Gtk::VBox                               group_display_vbox;
 142         Gtk::Frame                              track_display_frame;
 143         Gtk::Frame                              group_display_frame;
 144         Gtk::Frame                              favorite_plugins_frame;
 145         Gtk::VPaned                             rhs_pane1;
 146         Gtk::VPaned                             rhs_pane2;
 147         Gtk::HBox                               strip_packer;
 148         Gtk::HBox                               vca_packer;
 149         Gtk::HBox                               out_packer;
 150         Gtk::HPaned                             list_hpane;
 151
 152         MixerGroupTabs* _group_tabs;
 153
 154         bool on_scroll_event (GdkEventScroll*);
 155
 156         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
 157
 158         std::list<MixerStrip *> strips;
 159
 160         void scroller_drag_data_received (const Glib::RefPtr<Gdk::DragContext>&, int, int, const Gtk::SelectionData&, guint, guint);
 161         bool strip_scroller_button_release (GdkEventButton*);
 162         void scroll_left ();
 163         void scroll_right ();
 164         void toggle_midi_input_active (bool flip_others);
 165
 166         void add_strips (ARDOUR::RouteList&);
 167         void remove_strip (MixerStrip *);
 168
 169         void add_masters (ARDOUR::VCAList&);
 170         void remove_master (VCAMasterStrip*);
 171
 172         MixerStrip* strip_by_route (boost::shared_ptr<ARDOUR::Route>);
 173
 174         void hide_all_strips (bool with_select);
 175         void unselect_all_strips();
 176         void select_all_strips ();
 177         void unselect_all_audiotrack_strips ();
 178         void select_all_audiotrack_strips ();
 179         void unselect_all_audiobus_strips ();
 180         void select_all_audiobus_strips ();
 181
 182         void strip_select_op (bool audiotrack, bool select);
 183         void select_strip_op (MixerStrip*, bool select);
 184
 185         gint start_updating ();
 186         gint stop_updating ();
 187
 188         void session_going_away ();
 189
 190         sigc::connection fast_screen_update_connection;
 191         void fast_update_strips ();
 192
 193         void track_name_changed (MixerStrip *);
 194
 195         void redisplay_track_list ();
 196         bool no_track_list_redisplay;
 197         bool track_display_button_press (GdkEventButton*);
 198         void strip_width_changed ();
 199
 200         void track_list_delete (const Gtk::TreeModel::Path&);
 201         void track_list_reorder (const Gtk::TreeModel::Path& path, const Gtk::TreeModel::iterator& iter, int* new_order);
 202
 203         void plugin_row_activated (const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* column);
 204         bool plugin_row_button_press (GdkEventButton*);
 205         void popup_note_context_menu (GdkEventButton*);
 206         void plugin_drop (const Glib::RefPtr<Gdk::DragContext>&, const Gtk::SelectionData& data);
 207
 208         enum ProcessorPosition {
 209                 AddTop,
 210                 AddPreFader,
 211                 AddPostFader,
 212                 AddBottom
 213         };
 214
 215         void add_selected_processor (ProcessorPosition);
 216         void add_favorite_processor (ARDOUR::PluginPresetPtr, ProcessorPosition);
 217         void remove_selected_from_favorites ();
 218         void delete_selected_preset ();
 219         ARDOUR::PluginPresetPtr selected_plugin ();
 220
 221         void initial_track_display ();
 222         void show_track_list_menu ();
 223
 224         void set_all_strips_visibility (bool yn);
 225         void set_all_audio_midi_visibility (int, bool);
 226         void track_visibility_changed (std::string const & path);
 227         void update_track_visibility ();
 228
 229         void hide_all_routes ();
 230         void show_all_routes ();
 231         void show_all_audiobus ();
 232         void hide_all_audiobus ();
 233         void show_all_audiotracks();
 234         void hide_all_audiotracks ();
 235         void show_all_miditracks();
 236         void hide_all_miditracks ();
 237
 238         bool in_group_row_change;
 239
 240         void group_selected (gint row, gint col, GdkEvent *ev);
 241         void group_unselected (gint row, gint col, GdkEvent *ev);
 242         void group_display_active_clicked();
 243         void new_route_group ();
 244         void remove_selected_route_group ();
 245         void activate_all_route_groups ();
 246         void disable_all_route_groups ();
 247         void add_route_group (ARDOUR::RouteGroup *);
 248         void route_groups_changed ();
 249         void route_group_name_edit (const std::string&, const std::string&);
 250         void route_group_row_change (const Gtk::TreeModel::Path& path,const Gtk::TreeModel::iterator& iter);
 251         void route_group_row_deleted (Gtk::TreeModel::Path const &);
 252
 253         Gtk::Menu *track_menu;
 254         void track_column_click (gint);
 255         void build_track_menu ();
 256
 257         MonitorSection* _monitor_section;
 258         PluginSelector    *_plugin_selector;
 259
 260         void strip_property_changed (const PBD::PropertyChange&, MixerStrip *);
 261         void route_group_property_changed (ARDOUR::RouteGroup *, const PBD::PropertyChange &);
 262
 263         /* various treeviews */
 264
 265         struct TrackDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 266                 TrackDisplayModelColumns () {
 267                         add (text);
 268                         add (visible);
 269                         add (route);
 270                         add (strip);
 271                         add (vca);
 272                 }
 273                 Gtk::TreeModelColumn<bool>         visible;
 274                 Gtk::TreeModelColumn<std::string>  text;
 275                 Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Route> > route;
 276                 /* if route is non-null, this must be non-null */
 277                 Gtk::TreeModelColumn<MixerStrip*>  strip;
 278                 /* if route is null, this may be non-null */
 279                 Gtk::TreeModelColumn<VCAMasterStrip*>  vca;
 280         };
 281
 282         struct GroupDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 283             GroupDisplayModelColumns() {
 284                     add (visible);
 285                     add (text);
 286                     add (group);
 287             }
 288             Gtk::TreeModelColumn<bool>                                  visible;
 289             Gtk::TreeModelColumn<std::string>                   text;
 290             Gtk::TreeModelColumn<ARDOUR::RouteGroup*>   group;
 291         };
 292
 293         struct PluginsDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
 294             PluginsDisplayModelColumns() {
 295                     add (name);
 296                     add (plugin);
 297             }
 298             Gtk::TreeModelColumn<std::string> name;
 299                         Gtk::TreeModelColumn<ARDOUR::PluginPresetPtr> plugin;
 300         };
 301
 302         ARDOUR::PluginInfoList favorite_order;
 303         std::map<std::string, bool> favorite_ui_state;
 304
 305         TrackDisplayModelColumns    track_columns;
 306         GroupDisplayModelColumns    group_columns;
 307         PluginsDisplayModelColumns  favorite_plugins_columns;
 308
 309         Gtk::TreeView track_display;
 310         Gtk::TreeView group_display;
 311         Gtkmm2ext::DnDTreeView<ARDOUR::PluginPresetPtr> favorite_plugins_display;
 312
 313         Glib::RefPtr<Gtk::ListStore> track_model;
 314         Glib::RefPtr<Gtk::ListStore> group_model;
 315         Glib::RefPtr<PluginTreeStore> favorite_plugins_model;
 316
 317         bool group_display_button_press (GdkEventButton*);
 318         void group_display_selection_changed ();
 319
 320         bool strip_button_release_event (GdkEventButton*, MixerStrip*);
 321
 322         Width _strip_width;
 323
 324         void sync_order_keys_from_treeview ();
 325         void sync_treeview_from_order_keys ();
 326         void reset_remote_control_ids ();
 327         void reset_order_keys ();
 328
 329         bool ignore_reorder;
 330
 331         void parameter_changed (std::string const &);
 332         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
 333
 334         void setup_track_display ();
 335         void new_track_or_bus ();
 336
 337         static const int32_t default_width = 478;
 338         static const int32_t default_height = 765;
 339
 340         /** true if we are rebuilding the route group list, or clearing
 341             it during a session teardown.
 342         */
 343         bool _in_group_rebuild_or_clear;
 344         bool _route_deletion_in_progress;
 345
 346         void update_title ();
 347         MixerStrip* strip_by_x (int x);
 348
 349         friend class MixerGroupTabs;
 350
 351         void follow_editor_selection ();
 352         bool _following_editor_selection;
 353
 354         void monitor_section_going_away ();
 355
 356         void monitor_section_attached ();
 357         void monitor_section_detached ();
 358
 359         void store_current_favorite_order();
 360         void refiller (ARDOUR::PluginInfoList& result, const ARDOUR::PluginInfoList& plugs);
 361         void refill_favorite_plugins ();
 362         void sync_treeview_from_favorite_order ();
 363         void sync_treeview_favorite_ui_state (const Gtk::TreeModel::Path&, const Gtk::TreeModel::iterator&);
 364         void save_favorite_ui_state (const Gtk::TreeModel::iterator& iter, const Gtk::TreeModel::Path& path);
 365
 366         /// true if we are in fullscreen mode
 367         bool _maximised;
 368
 369         // true if mixer list is visible
 370         bool _show_mixer_list;
 371 };
 372
 373 #endif /* __ardour_mixer_ui_h__ */