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 "gtkmm2ext/widget_state.h"
  29
  30 #include "ardour/ardour.h"
  31 #include "ardour/mute_master.h"
  32 #include "ardour/session_event.h"
  33 #include "ardour/session.h"
  34 #include "ardour/route.h"
  35 #include "ardour/route_group.h"
  36 #include "ardour/track.h"
  37
  38 #include "axis_view.h"
  39
  40 namespace ARDOUR {
  41         class AudioTrack;
  42         class MidiTrack;
  43 }
  44
  45 namespace Gtk {
  46         class Menu;
  47         class CheckMenuItem;
  48         class Widget;
  49 }
  50
  51 class BindableToggleButton;
  52 class ArdourButton;
  53
  54 class RouteUI : public virtual AxisView
  55 {
  56   public:
  57         RouteUI(ARDOUR::Session*);
  58         RouteUI(boost::shared_ptr<ARDOUR::Route>, ARDOUR::Session*);
  59
  60         virtual ~RouteUI();
  61
  62         Gdk::Color color () const;
  63
  64         virtual void set_route (boost::shared_ptr<ARDOUR::Route>);
  65         virtual void set_button_names () = 0;
  66
  67         bool is_track() const;
  68         bool is_audio_track() const;
  69         bool is_midi_track() const;
  70         bool has_audio_outputs () const;
  71
  72         boost::shared_ptr<ARDOUR::Route> route() const { return _route; }
  73
  74         boost::shared_ptr<ARDOUR::Track>      track() const;
  75         boost::shared_ptr<ARDOUR::AudioTrack> audio_track() const;
  76         boost::shared_ptr<ARDOUR::MidiTrack>  midi_track() const;
  77
  78         std::string name() const;
  79
  80         // protected: XXX sigh this should be here
  81
  82         boost::shared_ptr<ARDOUR::Route> _route;
  83
  84         void request_redraw ();
  85
  86         virtual void set_color (const Gdk::Color & c);
  87         void choose_color ();
  88
  89         bool ignore_toggle;
  90         bool wait_for_release;
  91         bool multiple_mute_change;
  92         bool multiple_solo_change;
  93
  94         Gtk::HBox _invert_button_box;
  95         ArdourButton* mute_button;
  96         ArdourButton* solo_button;
  97         ArdourButton* rec_enable_button; /* audio tracks */
  98         ArdourButton* show_sends_button; /* busses */
  99         ArdourButton* monitor_input_button;
 100         ArdourButton* monitor_disk_button;
 101
 102         Glib::RefPtr<Gdk::Pixbuf> solo_safe_pixbuf;
 103
 104         ArdourButton* solo_safe_led;
 105         ArdourButton* solo_isolated_led;
 106
 107         Gtk::Label monitor_input_button_label;
 108         Gtk::Label monitor_disk_button_label;
 109
 110         void send_blink (bool);
 111         sigc::connection send_blink_connection;
 112
 113         Gtk::Menu* mute_menu;
 114         Gtk::Menu* solo_menu;
 115         Gtk::Menu* sends_menu;
 116
 117         bool mute_press(GdkEventButton*);
 118         bool mute_release(GdkEventButton*);
 119         bool solo_press(GdkEventButton*);
 120         bool solo_release(GdkEventButton*);
 121         bool rec_enable_press(GdkEventButton*);
 122         bool rec_enable_release(GdkEventButton*);
 123         bool show_sends_press(GdkEventButton*);
 124         bool show_sends_release(GdkEventButton*);
 125
 126         bool monitor_release(GdkEventButton*, ARDOUR::MonitorChoice);
 127         bool monitor_input_press(GdkEventButton*);
 128         bool monitor_input_release(GdkEventButton*);
 129         bool monitor_disk_press(GdkEventButton*);
 130         bool monitor_disk_release(GdkEventButton*);
 131         void monitoring_changed ();
 132         void update_monitoring_display ();
 133
 134         void step_gain_up ();
 135         void step_gain_down ();
 136         void page_gain_up ();
 137         void page_gain_down ();
 138
 139         void build_sends_menu ();
 140         void set_sends_gain_from_track ();
 141         void set_sends_gain_to_zero ();
 142         void set_sends_gain_to_unity ();
 143         void create_sends (ARDOUR::Placement, bool);
 144         void create_selected_sends (ARDOUR::Placement, bool);
 145
 146         void solo_changed(bool, void*);
 147         void solo_changed_so_update_mute ();
 148         void mute_changed(void*);
 149         void listen_changed(void*);
 150         virtual void processors_changed (ARDOUR::RouteProcessorChange) {}
 151         void route_rec_enable_changed();
 152         void session_rec_enable_changed();
 153
 154         void build_solo_menu ();
 155
 156         void solo_isolated_toggle (void*, Gtk::CheckMenuItem*);
 157         void toggle_solo_isolated (Gtk::CheckMenuItem*);
 158
 159         bool solo_isolate_button_release (GdkEventButton*);
 160         bool solo_safe_button_release (GdkEventButton*);
 161
 162         void solo_safe_toggle (void*, Gtk::CheckMenuItem*);
 163         void toggle_solo_safe (Gtk::CheckMenuItem*);
 164
 165         Gtk::CheckMenuItem* pre_fader_mute_check;
 166         Gtk::CheckMenuItem* post_fader_mute_check;
 167         Gtk::CheckMenuItem* listen_mute_check;
 168         Gtk::CheckMenuItem* main_mute_check;
 169         Gtk::CheckMenuItem* solo_safe_check;
 170         Gtk::CheckMenuItem* solo_isolated_check;
 171
 172         void toggle_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 173         void muting_change ();
 174         void build_mute_menu(void);
 175         void init_mute_menu(ARDOUR::MuteMaster::MutePoint, Gtk::CheckMenuItem*);
 176
 177         int  set_color_from_route ();
 178
 179         void remove_this_route (bool apply_to_selection = false);
 180         static gint idle_remove_this_route (RouteUI *);
 181
 182         void route_rename();
 183
 184         virtual void property_changed (const PBD::PropertyChange&);
 185         void route_removed ();
 186
 187         virtual void route_active_changed () {}
 188         void set_route_active (bool, bool);
 189
 190         Gtk::Menu* record_menu;
 191         void build_record_menu ();
 192
 193         Gtk::CheckMenuItem *step_edit_item;
 194         void toggle_step_edit ();
 195         virtual void step_edit_changed (bool);
 196
 197         virtual void polarity_changed ();
 198
 199         Gtk::CheckMenuItem *denormal_menu_item;
 200         void toggle_denormal_protection();
 201         virtual void denormal_protection_changed ();
 202
 203         void disconnect_input ();
 204         void disconnect_output ();
 205
 206         virtual void update_rec_display ();
 207         void update_mute_display ();
 208
 209         void update_solo_display ();
 210
 211         virtual void map_frozen ();
 212
 213         void adjust_latency ();
 214         void save_as_template ();
 215         void open_remote_control_id_dialog ();
 216
 217         static Gtkmm2ext::ActiveState solo_active_state (boost::shared_ptr<ARDOUR::Route>);
 218         static Gtkmm2ext::ActiveState solo_isolate_active_state (boost::shared_ptr<ARDOUR::Route>);
 219         static Gtkmm2ext::ActiveState solo_safe_active_state (boost::shared_ptr<ARDOUR::Route>);
 220         static Gtkmm2ext::ActiveState mute_active_state (ARDOUR::Session*, boost::shared_ptr<ARDOUR::Route>);
 221
 222         /** Emitted when a bus has been set or unset from `display sends to this bus' mode
 223          *  by a click on the `Sends' button.  The parameter is the route that the sends are
 224          *  to, or 0 if no route is now in this mode.
 225          */
 226         static sigc::signal<void, boost::shared_ptr<ARDOUR::Route> > BusSendDisplayChanged;
 227
 228    protected:
 229         PBD::ScopedConnectionList route_connections;
 230         bool self_destruct;
 231
 232         void init ();
 233         void reset ();
 234
 235         void self_delete ();
 236         virtual void start_step_editing () {}
 237         virtual void stop_step_editing() {}
 238
 239         void set_invert_sensitive (bool);
 240         bool verify_new_route_name (const std::string& name);
 241
 242         void route_gui_changed (std::string);
 243         virtual void route_color_changed () {}
 244
 245         virtual void bus_send_display_changed (boost::shared_ptr<ARDOUR::Route>);
 246
 247   private:
 248         void check_rec_enable_sensitivity ();
 249         void parameter_changed (std::string const &);
 250         void relabel_solo_button ();
 251
 252         std::string route_state_id () const;
 253
 254         struct SoloMuteRelease {
 255             SoloMuteRelease (bool was_active)
 256             : active (was_active)
 257             , exclusive (false) {}
 258
 259             boost::shared_ptr<ARDOUR::RouteList> routes;
 260             boost::shared_ptr<ARDOUR::RouteList> routes_on;
 261             boost::shared_ptr<ARDOUR::RouteList> routes_off;
 262             boost::shared_ptr<ARDOUR::Route> route;
 263             bool active;
 264             bool exclusive;
 265         };
 266
 267         SoloMuteRelease* _solo_release;
 268         SoloMuteRelease* _mute_release;
 269
 270         void setup_invert_buttons ();
 271         void set_invert_button_state ();
 272         void invert_toggled (uint32_t, BindableToggleButton *);
 273         void invert_menu_toggled (uint32_t);
 274         bool invert_press (GdkEventButton *);
 275
 276         int _i_am_the_modifier;
 277         std::list<BindableToggleButton*> _invert_buttons;
 278         Gtk::Menu* _invert_menu;
 279
 280         static void set_showing_sends_to (boost::shared_ptr<ARDOUR::Route>);
 281         static boost::weak_ptr<ARDOUR::Route> _showing_sends_to;
 282
 283         static uint32_t _max_invert_buttons;
 284 };
 285
 286 #endif /* __ardour_route_ui__ */