gtk2_ardour/route_ui.h

   1 /*
   2     Copyright (C) 2002 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_route_ui__
  21 #define __ardour_route_ui__
  22
  23 #include <list>
  24
  25 #include "pbd/xml++.h"
  26 #include "pbd/signals.h"
  27
  28 #include <gtkmm/textview.h>
  29
  30 #include "gtkmm2ext/widget_state.h"
  31
  32 #include "ardour/ardour.h"
  33 #include "ardour/mute_master.h"
  34 #include "ardour/session.h"
  35 #include "ardour/session_event.h"
  36 #include "ardour/session_handle.h"
  37 #include "ardour/route.h"
  38 #include "ardour/route_group.h"
  39 #include "ardour/track.h"
  40
  41 #include "axis_view.h"
  42 #include "selectable.h"
  43 #include "window_manager.h"
  44
  45 namespace ARDOUR {
  46         class AudioTrack;
  47         class MidiTrack;
  48 }
  49
  50 namespace Gtk {
  51         class Menu;
  52         class CheckMenuItem;
  53         class Widget;
  54 }
  55
  56 class ArdourButton;
  57 class ArdourWindow;
  58 class IOSelectorWindow;
  59
  60 class RoutePinWindowProxy : public WM::ProxyBase
  61 {
  62   public:
  63         RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
  64         ~RoutePinWindowProxy();
  65
  66         Gtk::Window* get (bool create = false);
  67         ARDOUR::SessionHandlePtr* session_handle();
  68
  69   private:
  70         boost::weak_ptr<ARDOUR::Route> _route;
  71
  72         void route_going_away ();
  73         PBD::ScopedConnection going_away_connection;
  74 };
  75
  76 class RouteUI : public virtual ARDOUR::SessionHandlePtr, public virtual sigc::trackable, public virtual PBD::ScopedConnectionList
  77 {
  78   public:
  79         RouteUI (ARDOUR::Session*);
  80
  81         virtual ~RouteUI();
  82
  83         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
  84         virtual void set_button_names () = 0;
  85
  86         bool is_track() const;
  87         bool is_audio_track() const;
  88         bool is_midi_track() const;
  89         bool has_audio_outputs () const;
  90
  91         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
  92         ARDOUR::RouteGroup* route_group() const;
  93
  94         boost::shared_ptr<ARDOUR::Track>      track() const;
  95         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
  96         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
  97
  98         // protected: XXX sigh this should be here
  99
 100         boost::shared_ptr<ARDOUR::Route> _route;
 101
 102         void request_redraw ();
 103
 104         virtual void set_color (uint32_t c);
 105         Gdk::Color route_color () const;
 106         void choose_color ();
 107
 108         bool ignore_toggle;
 109         bool wait_for_release;
 110         bool multiple_mute_change;
 111         bool multiple_solo_change;
 112
 113         Gtk::HBox _invert_button_box;
 114         ArdourButton* mute_button;
 115         ArdourButton* solo_button;
 116         ArdourButton* rec_enable_button; /* audio tracks */
 117         ArdourButton* show_sends_button; /* busses */
 118         ArdourButton* monitor_input_button;
 119         ArdourButton* monitor_disk_button;
 120
 121         Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
 122
 123         ArdourButton* solo_safe_led;
 124         ArdourButton* solo_isolated_led;
 125
 126         ArdourButton* vca_button;
 127
 128         Gtk::Label monitor_input_button_label;
 129         Gtk::Label monitor_disk_button_label;
 130
 131         void send_blink (bool);
 132         sigc::connection send_blink_connection;
 133
 134         sigc::connection rec_blink_connection;
 135
 136         Gtk::Menu* mute_menu;
 137         Gtk::Menu* solo_menu;
 138         Gtk::Menu* sends_menu;
 139
 140         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
 141
 142         bool mute_press(GdkEventButton*);
 143         bool mute_release(GdkEventButton*);
 144         bool solo_press(GdkEventButton*);
 145         bool solo_release(GdkEventButton*);
 146         bool rec_enable_press(GdkEventButton*);
 147         bool rec_enable_release(GdkEventButton*);
 148         bool show_sends_press(GdkEventButton*);
 149         bool show_sends_release(GdkEventButton*);
 150
 151         bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
 152         bool monitor_input_press(GdkEventButton*);
 153         bool monitor_input_release(GdkEventButton*);
 154         bool monitor_disk_press(GdkEventButton*);
 155         bool monitor_disk_release(GdkEventButton*);
 156         void update_monitoring_display ();
 157
 158         void edit_input_configuration ();
 159         void edit_output_configuration ();
 160
 161         void step_gain_up ();
 162         void step_gain_down ();
 163         void page_gain_up ();
 164         void page_gain_down ();
 165
 166         void build_sends_menu ();
 167         void set_sends_gain_from_track ();
 168         void set_sends_gain_to_zero ();
 169         void set_sends_gain_to_unity ();
 170         void create_sends (ARDOUR::Placement, bool);
 171         void create_selected_sends (ARDOUR::Placement, bool);
 172
 173         void solo_changed(bool, void*);
 174         void solo_changed_so_update_mute ();
 175         void listen_changed(void*);
 176         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
 177         void route_rec_enable_changed();
 178         void session_rec_enable_changed();
 179
 180         void build_solo_menu ();
 181
 182         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
 183         void toggle_solo_isolated (Gtk::CheckMenuItem*);
 184
 185         bool solo_isolate_button_release (GdkEventButton*);
 186         bool solo_safe_button_release (GdkEventButton*);
 187
 188         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
 189         void toggle_solo_safe (Gtk::CheckMenuItem*);
 190
 191         Gtk::CheckMenuItem* pre_fader_mute_check;
 192         Gtk::CheckMenuItem* post_fader_mute_check;
 193         Gtk::CheckMenuItem* listen_mute_check;
 194         Gtk::CheckMenuItem* main_mute_check;
 195         Gtk::CheckMenuItem* solo_safe_check;
 196         Gtk::CheckMenuItem* solo_isolated_check;
 197
 198         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 199         void muting_change ();
 200         void build_mute_menu(void);
 201         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 202
 203         int  set_color_from_route ();
 204
 205         void route_rename();
 206
 207         void manage_pins ();
 208         void maybe_add_route_print_mgr ();
 209
 210         virtual void route_property_changed (const PBD::PropertyChange&) = 0;
 211         void route_removed ();
 212
 213         virtual void route_active_changed () {}
 214         void set_route_active (bool, bool);
 215         void duplicate_selected_routes ();
 216
 217         Gtk::Menu* record_menu;
 218         void build_record_menu ();
 219
 220         Gtk::CheckMenuItem *step_edit_item;
 221         void toggle_step_edit ();
 222         virtual void step_edit_changed (bool);
 223
 224         Gtk::CheckMenuItem *rec_safe_item;
 225         void toggle_rec_safe ();
 226
 227         virtual void polarity_changed ();
 228
 229         Gtk::CheckMenuItem *denormal_menu_item;
 230         void toggle_denormal_protection();
 231         virtual void denormal_protection_changed ();
 232
 233         void disconnect_input ();
 234         void disconnect_output ();
 235
 236         virtual void blink_rec_display (bool onoff);
 237         void update_mute_display ();
 238
 239         void update_solo_display ();
 240
 241         void update_vca_display ();
 242
 243         virtual void map_frozen ();
 244
 245         void adjust_latency ();
 246         bool process_save_template_prompter (ArdourPrompter& prompter, const std::string& dir);
 247         void save_as_template ();
 248
 249         static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 250         static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 251         static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Stripable>);
 252         static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Stripable>);
 253
 254         /** Emitted when a bus has been set or unset from `display sends to this bus' mode
 255          *  by a click on the `Sends' button.  The parameter is the route that the sends are
 256          *  to, or 0 if no route is now in this mode.
 257          */
 258         static PBD::Signal1<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
 259
 260         void comment_editor_done_editing ();
 261         void setup_comment_editor ();
 262         void open_comment_editor ();
 263         void toggle_comment_editor ();
 264
 265         gint comment_key_release_handler (GdkEventKey*);
 266         void comment_changed ();
 267         void comment_edited ();
 268         bool ignore_comment_edit;
 269
 270    protected:
 271
 272         ArdourWindow*  comment_window;
 273         Gtk::TextView* comment_area;
 274         IOSelectorWindow *input_selector;
 275         IOSelectorWindow *output_selector;
 276
 277         PBD::ScopedConnectionList route_connections;
 278         bool self_destruct;
 279
 280         void init ();
 281         void reset ();
 282
 283         void self_delete ();
 284         virtual void start_step_editing () {}
 285         virtual void stop_step_editing() {}
 286
 287         void set_invert_sensitive (bool);
 288         bool verify_new_route_name (const std::string& name);
 289
 290         void route_gui_changed (std::string);
 291         virtual void route_color_changed () {}
 292
 293         void check_rec_enable_sensitivity ();
 294
 295         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
 296
 297         static std::string program_port_prefix;
 298
 299         bool mark_hidden (bool yn);
 300
 301   private:
 302         void parameter_changed (std::string const &);
 303         void relabel_solo_button ();
 304         void track_mode_changed ();
 305
 306         std::string route_state_id () const;
 307
 308 protected:
 309         struct SoloMuteRelease {
 310             SoloMuteRelease (bool was_active)
 311             : active (was_active)
 312             , exclusive (false) {}
 313
 314             boost::shared_ptr<ARDOUR::RouteList> routes;
 315             boost::shared_ptr<ARDOUR::RouteList> routes_on;
 316             boost::shared_ptr<ARDOUR::RouteList> routes_off;
 317             boost::shared_ptr<ARDOUR::Route> route;
 318             bool active;
 319             bool exclusive;
 320         };
 321
 322         SoloMuteRelease* _solo_release;
 323         SoloMuteRelease* _mute_release;
 324
 325 private:
 326         void setup_invert_buttons ();
 327         void set_invert_button_state ();
 328         void invert_menu_toggled (uint32_t);
 329         bool invert_press (GdkEventButton *);
 330         bool invert_release (GdkEventButton *, uint32_t i);
 331
 332         int _i_am_the_modifier;
 333         std::vector<ArdourButton*> _invert_buttons;
 334         Gtk::Menu* _invert_menu;
 335
 336         static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
 337         static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
 338
 339         static uint32_t _max_invert_buttons;
 340 };
 341
 342 #endif /* __ardour_route_ui__ */