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 class ControlSlaveUI;
  60
  61 class RoutePinWindowProxy : public WM::ProxyBase
  62 {
  63   public:
  64         RoutePinWindowProxy (std::string const &, boost::shared_ptr<ARDOUR::Route>);
  65         ~RoutePinWindowProxy();
  66
  67         Gtk::Window* get (bool create = false);
  68         ARDOUR::SessionHandlePtr* session_handle();
  69
  70   private:
  71         boost::weak_ptr<ARDOUR::Route> _route;
  72
  73         void route_going_away ();
  74         PBD::ScopedConnection going_away_connection;
  75 };
  76
  77 class RouteUI : public virtual ARDOUR::SessionHandlePtr, public virtual PBD::ScopedConnectionList, public virtual Selectable, public virtual sigc::trackable
  78 {
  79   public:
  80         RouteUI (ARDOUR::Session*);
  81
  82         virtual ~RouteUI();
  83
  84         boost::shared_ptr<ARDOUR::Stripable> stripable() const;
  85
  86         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
  87         virtual void set_button_names () = 0;
  88
  89         bool is_track() const;
  90         bool is_audio_track() const;
  91         bool is_midi_track() const;
  92         bool has_audio_outputs () const;
  93
  94         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
  95         ARDOUR::RouteGroup* route_group() const;
  96
  97         boost::shared_ptr<ARDOUR::Track>      track() const;
  98         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
  99         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
 100
 101         // protected: XXX sigh this should be here
 102
 103         boost::shared_ptr<ARDOUR::Route> _route;
 104
 105         void request_redraw ();
 106
 107         virtual void set_color (uint32_t c);
 108         Gdk::Color route_color () const;
 109         void choose_color ();
 110
 111         bool ignore_toggle;
 112         bool wait_for_release;
 113         bool multiple_mute_change;
 114         bool multiple_solo_change;
 115
 116         Gtk::HBox _invert_button_box;
 117         ArdourButton* mute_button;
 118         ArdourButton* solo_button;
 119         ArdourButton* rec_enable_button; /* audio tracks */
 120         ArdourButton* show_sends_button; /* busses */
 121         ArdourButton* monitor_input_button;
 122         ArdourButton* monitor_disk_button;
 123
 124         Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
 125
 126         ArdourButton* solo_safe_led;
 127         ArdourButton* solo_isolated_led;
 128
 129
 130         Gtk::Label monitor_input_button_label;
 131         Gtk::Label monitor_disk_button_label;
 132
 133         void send_blink (bool);
 134         sigc::connection send_blink_connection;
 135
 136         sigc::connection rec_blink_connection;
 137
 138         Gtk::Menu* mute_menu;
 139         Gtk::Menu* solo_menu;
 140         Gtk::Menu* sends_menu;
 141
 142         boost::shared_ptr<ARDOUR::Delivery> _current_delivery;
 143
 144         bool mute_press(GdkEventButton*);
 145         bool mute_release(GdkEventButton*);
 146         bool solo_press(GdkEventButton*);
 147         bool solo_release(GdkEventButton*);
 148         bool rec_enable_press(GdkEventButton*);
 149         bool rec_enable_release(GdkEventButton*);
 150         bool show_sends_press(GdkEventButton*);
 151         bool show_sends_release(GdkEventButton*);
 152
 153         bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
 154         bool monitor_input_press(GdkEventButton*);
 155         bool monitor_input_release(GdkEventButton*);
 156         bool monitor_disk_press(GdkEventButton*);
 157         bool monitor_disk_release(GdkEventButton*);
 158         void update_monitoring_display ();
 159
 160         void edit_input_configuration ();
 161         void edit_output_configuration ();
 162
 163         void step_gain_up ();
 164         void step_gain_down ();
 165         void page_gain_up ();
 166         void page_gain_down ();
 167
 168         void build_sends_menu ();
 169         void set_sends_gain_from_track ();
 170         void set_sends_gain_to_zero ();
 171         void set_sends_gain_to_unity ();
 172         void create_sends (ARDOUR::Placement, bool);
 173         void create_selected_sends (ARDOUR::Placement, bool);
 174
 175         void solo_changed(bool, void*);
 176         void solo_changed_so_update_mute ();
 177         void listen_changed(void*);
 178         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
 179         void route_rec_enable_changed();
 180         void session_rec_enable_changed();
 181
 182         void build_solo_menu ();
 183
 184         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
 185         void toggle_solo_isolated (Gtk::CheckMenuItem*);
 186
 187         bool solo_isolate_button_release (GdkEventButton*);
 188         bool solo_safe_button_release (GdkEventButton*);
 189
 190         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
 191         void toggle_solo_safe (Gtk::CheckMenuItem*);
 192
 193         Gtk::CheckMenuItem* pre_fader_mute_check;
 194         Gtk::CheckMenuItem* post_fader_mute_check;
 195         Gtk::CheckMenuItem* listen_mute_check;
 196         Gtk::CheckMenuItem* main_mute_check;
 197         Gtk::CheckMenuItem* solo_safe_check;
 198         Gtk::CheckMenuItem* solo_isolated_check;
 199
 200         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 201         void muting_change ();
 202         void build_mute_menu(void);
 203         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 204
 205         int  set_color_from_route ();
 206
 207         void route_rename();
 208
 209         void manage_pins ();
 210         void maybe_add_route_print_mgr ();
 211
 212         virtual void route_property_changed (const PBD::PropertyChange&) = 0;
 213         void route_removed ();
 214
 215         virtual void route_active_changed () {}
 216         void set_route_active (bool, bool);
 217         void duplicate_selected_routes ();
 218
 219         Gtk::Menu* record_menu;
 220         void build_record_menu ();
 221
 222         Gtk::CheckMenuItem *step_edit_item;
 223         void toggle_step_edit ();
 224         virtual void step_edit_changed (bool);
 225
 226         Gtk::CheckMenuItem *rec_safe_item;
 227         void toggle_rec_safe ();
 228
 229         virtual void polarity_changed ();
 230
 231         Gtk::CheckMenuItem *denormal_menu_item;
 232         void toggle_denormal_protection();
 233         virtual void denormal_protection_changed ();
 234
 235         void disconnect_input ();
 236         void disconnect_output ();
 237
 238         virtual void blink_rec_display (bool onoff);
 239         void update_mute_display ();
 240
 241         void update_solo_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 (PBD::PropertyChange const&);
 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         ControlSlaveUI* csu;
 326
 327 private:
 328         void setup_invert_buttons ();
 329         void set_invert_button_state ();
 330         void invert_menu_toggled (uint32_t);
 331         bool invert_press (GdkEventButton *);
 332         bool invert_release (GdkEventButton *, uint32_t i);
 333
 334         int _i_am_the_modifier;
 335         std::vector<ArdourButton*> _invert_buttons;
 336         Gtk::Menu* _invert_menu;
 337
 338         static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
 339         static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
 340
 341         static uint32_t _max_invert_buttons;
 342 };
 343
 344 #endif /* __ardour_route_ui__ */