gtk2_ardour/mixer_ui.h

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