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