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