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