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