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