gtk2_ardour/engine_dialog.h

   1 /*
   2     Copyright (C) 2010 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 __gtk2_ardour_engine_dialog_h__
  21 #define __gtk2_ardour_engine_dialog_h__
  22
  23 #include <map>
  24 #include <vector>
  25 #include <string>
  26
  27 #include <gtkmm/checkbutton.h>
  28 #include <gtkmm/spinbutton.h>
  29 #include <gtkmm/comboboxtext.h>
  30 #include <gtkmm/table.h>
  31 #include <gtkmm/expander.h>
  32 #include <gtkmm/box.h>
  33 #include <gtkmm/buttonbox.h>
  34 #include <gtkmm/button.h>
  35
  36 #include "pbd/signals.h"
  37
  38 #include "ardour_dialog.h"
  39 #include "ardour_button.h"
  40
  41 class EngineControl : public ArdourDialog, public PBD::ScopedConnectionList {
  42   public:
  43     EngineControl ();
  44     ~EngineControl ();
  45
  46     static bool need_setup ();
  47
  48     XMLNode& get_state ();
  49     bool set_state (const XMLNode&);
  50
  51     void set_desired_sample_rate (uint32_t);
  52
  53   private:
  54     Gtk::Notebook notebook;
  55
  56     Gtk::Label engine_status;
  57
  58     /* core fields used by all backends */
  59
  60     Gtk::Table basic_packer;
  61     Gtk::HBox basic_hbox;
  62     Gtk::VBox basic_vbox;
  63
  64     Gtk::ComboBoxText backend_combo;
  65     Gtk::ComboBoxText driver_combo;
  66     Gtk::ComboBoxText device_combo;
  67     Gtk::ComboBoxText input_device_combo;
  68     Gtk::ComboBoxText output_device_combo;
  69     Gtk::ComboBoxText sample_rate_combo;
  70     Gtk::ComboBoxText midi_option_combo;
  71     Gtk::ComboBoxText buffer_size_combo;
  72     Gtk::Label        buffer_size_duration_label;
  73     Gtk::ComboBoxText nperiods_combo;
  74     Gtk::Adjustment input_latency_adjustment;
  75     Gtk::SpinButton input_latency;
  76     Gtk::Adjustment output_latency_adjustment;
  77     Gtk::SpinButton output_latency;
  78     Gtk::Adjustment input_channels_adjustment;
  79     Gtk::SpinButton input_channels;
  80     Gtk::Adjustment output_channels_adjustment;
  81     Gtk::SpinButton output_channels;
  82     Gtk::Adjustment ports_adjustment;
  83     Gtk::SpinButton ports_spinner;
  84
  85     Gtk::Label      have_control_text;
  86     ArdourButton    control_app_button;
  87     ArdourButton    midi_devices_button;
  88     ArdourButton    start_stop_button;
  89     ArdourButton    update_devices_button;
  90     ArdourButton    use_buffered_io_button;
  91
  92     Gtk::Button     connect_disconnect_button;
  93
  94     /* latency measurement */
  95
  96     Gtk::ComboBoxText lm_output_channel_combo;
  97     Gtk::ComboBoxText lm_input_channel_combo;
  98     Gtk::Label        lm_measure_label;
  99     Gtk::Button       lm_measure_button;
 100     Gtk::Button       lm_use_button;
 101     Gtk::Button       lm_back_button;
 102     ArdourButton      lm_button_audio;
 103     Gtk::Label        lm_title;
 104     Gtk::Label        lm_preamble;
 105     Gtk::Label        lm_results;
 106     Gtk::Table        lm_table;
 107     Gtk::VBox         lm_vbox;
 108     bool              have_lm_results;
 109     bool              lm_running;
 110
 111     Gtk::Button* cancel_button;
 112     Gtk::Button* ok_button;
 113
 114     /* MIDI Tab */
 115
 116     Gtk::VBox midi_vbox;
 117     Gtk::Button midi_back_button;
 118     Gtk::Table midi_device_table;
 119
 120     /* MIDI ... JACK */
 121
 122     Gtk::CheckButton aj_button;
 123
 124     uint32_t ignore_changes; // state save/load
 125     uint32_t ignore_device_changes; // AudioEngine::DeviceListChanged
 126     uint32_t _desired_sample_rate;
 127     bool     started_at_least_once;
 128     bool     queue_device_changed;
 129
 130     void driver_changed ();
 131     void backend_changed ();
 132     void sample_rate_changed ();
 133     void buffer_size_changed ();
 134     void nperiods_changed ();
 135     void parameter_changed ();
 136     void midi_option_changed ();
 137
 138     void setup_midi_tab_for_backend ();
 139     void setup_midi_tab_for_jack ();
 140     void refresh_midi_display (std::string focus = "");
 141
 142         void update_midi_options ();
 143
 144         std::string bufsize_as_string (uint32_t);
 145         std::string nperiods_as_string (uint32_t);
 146
 147         std::vector<float> get_default_sample_rates ();
 148         std::vector<uint32_t> get_default_buffer_sizes ();
 149
 150         std::vector<float> get_sample_rates_for_all_devices ();
 151         std::vector<uint32_t> get_buffer_sizes_for_all_devices ();
 152
 153     float get_rate() const;
 154     uint32_t get_buffer_size() const;
 155     uint32_t get_nperiods() const;
 156     uint32_t get_input_channels() const;
 157     uint32_t get_output_channels() const;
 158     uint32_t get_input_latency() const;
 159     uint32_t get_output_latency() const;
 160     std::string get_device_name() const;
 161     std::string get_input_device_name() const;
 162     std::string get_output_device_name() const;
 163     std::string get_driver() const;
 164     std::string get_backend() const;
 165     std::string get_midi_option () const;
 166     bool get_use_buffered_io () const;
 167
 168         std::string get_default_device (const std::string&,
 169                                         const std::vector<std::string>&);
 170
 171     void device_changed ();
 172     void input_device_changed ();
 173     void output_device_changed ();
 174     bool set_driver_popdown_strings ();
 175     bool set_device_popdown_strings ();
 176     bool set_input_device_popdown_strings ();
 177     bool set_output_device_popdown_strings ();
 178     void set_samplerate_popdown_strings ();
 179     void set_buffersize_popdown_strings ();
 180     void set_nperiods_popdown_strings ();
 181     void list_devices ();
 182     void show_buffer_duration ();
 183
 184     void configure_midi_devices ();
 185
 186     struct MidiDeviceSetting {
 187         std::string name;
 188         bool enabled;
 189         uint32_t input_latency;
 190         uint32_t output_latency;
 191
 192         MidiDeviceSetting (std::string n, bool en = true, uint32_t inl = 0, uint32_t oul = 0)
 193             : name (n)
 194             , enabled (en)
 195             , input_latency (inl)
 196             , output_latency (oul)
 197         {}
 198     };
 199
 200     typedef boost::shared_ptr<MidiDeviceSetting> MidiDeviceSettings;
 201     bool _can_set_midi_latencies;
 202     std::vector<MidiDeviceSettings> _midi_devices;
 203
 204     MidiDeviceSettings find_midi_device(std::string devicename) const {
 205         for (std::vector<MidiDeviceSettings>::const_iterator p = _midi_devices.begin(); p != _midi_devices.end(); ++p) {
 206             if ((*p)->name == devicename) {
 207                 return *p;
 208             }
 209         }
 210         return MidiDeviceSettings();
 211     }
 212
 213     struct StateStruct {
 214         std::string backend;
 215         std::string driver;
 216         std::string device;
 217         std::string input_device;
 218         std::string output_device;
 219         float sample_rate;
 220         uint32_t buffer_size;
 221         uint32_t n_periods;
 222         uint32_t input_latency;
 223         uint32_t output_latency;
 224         uint32_t input_channels;
 225         uint32_t output_channels;
 226         bool active;
 227         bool use_buffered_io;
 228         std::string midi_option;
 229         std::vector<MidiDeviceSettings> midi_devices;
 230         time_t lru;
 231
 232         StateStruct()
 233                 : sample_rate (48000)
 234                 , buffer_size (1024)
 235                 , input_latency (0)
 236                 , output_latency (0)
 237                 , input_channels (0)
 238                 , output_channels (0)
 239                 , active (false)
 240                 , use_buffered_io (false)
 241                 , lru (0) {}
 242
 243     };
 244
 245     typedef boost::shared_ptr<StateStruct> State;
 246     typedef std::list<State> StateList;
 247     static bool state_sort_cmp (const State &a, const State &b);
 248
 249     StateList states;
 250
 251     State get_matching_state (const std::string& backend);
 252     State get_matching_state (const std::string& backend,
 253                                const std::string& driver,
 254                                const std::string& device);
 255     State get_matching_state (const std::string& backend,
 256                                const std::string& driver,
 257                                const std::string& input_device,
 258                                const std::string& output_device);
 259     State get_saved_state_for_currently_displayed_backend_and_device ();
 260     void maybe_display_saved_state ();
 261     State save_state ();
 262     void store_state (State);
 263     bool equivalent_states (const State&, const State&);
 264
 265         bool set_current_state (const State& state);
 266         void set_default_state ();
 267
 268     bool  _have_control;
 269
 270     static bool print_channel_count (Gtk::SpinButton*);
 271
 272     void build_notebook ();
 273     void build_full_control_notebook ();
 274     void build_no_control_notebook ();
 275
 276         void connect_changed_signals ();
 277         void block_changed_signals ();
 278         void unblock_changed_signals ();
 279
 280         class SignalBlocker
 281         {
 282         public:
 283                 SignalBlocker (EngineControl& engine_control, const std::string& reason);
 284
 285                 ~SignalBlocker ();
 286
 287         private:
 288                 EngineControl& ec;
 289                 std::string m_reason;
 290         };
 291
 292         uint32_t block_signals;
 293
 294         sigc::connection backend_combo_connection;
 295         sigc::connection driver_combo_connection;
 296         sigc::connection sample_rate_combo_connection;
 297         sigc::connection buffer_size_combo_connection;
 298         sigc::connection nperiods_combo_connection;
 299         sigc::connection device_combo_connection;
 300         sigc::connection input_device_combo_connection;
 301         sigc::connection output_device_combo_connection;
 302         sigc::connection midi_option_combo_connection;
 303         sigc::connection input_latency_connection;
 304         sigc::connection output_latency_connection;
 305         sigc::connection input_channels_connection;
 306         sigc::connection output_channels_connection;
 307
 308     void on_show ();
 309     void on_response (int);
 310     void control_app_button_clicked ();
 311     void start_stop_button_clicked ();
 312     void update_devices_button_clicked ();
 313     void use_buffered_io_button_clicked ();
 314     void use_latency_button_clicked ();
 315     void manage_control_app_sensitivity ();
 316     int push_state_to_backend (bool start);
 317     void post_push ();
 318     void update_sensitivity ();
 319         bool start_engine ();
 320         bool stop_engine (bool for_latency = false);
 321
 322     /* latency measurement */
 323     void latency_button_clicked ();
 324     void latency_back_button_clicked ();
 325     bool check_audio_latency_measurement ();
 326     bool check_midi_latency_measurement ();
 327     sigc::connection latency_timeout;
 328     void enable_latency_tab ();
 329     void disable_latency_tab ();
 330     void start_latency_detection ();
 331     void end_latency_detection ();
 332
 333     void on_switch_page (GtkNotebookPage*, guint page_num);
 334     bool on_delete_event (GdkEventAny*);
 335
 336     void engine_running ();
 337     void engine_stopped ();
 338     void device_list_changed ();
 339
 340     PBD::ScopedConnection running_connection;
 341     PBD::ScopedConnectionList stopped_connection;
 342     PBD::ScopedConnection devicelist_connection;
 343
 344     void connect_disconnect_click ();
 345     void calibrate_audio_latency ();
 346     void calibrate_midi_latency (MidiDeviceSettings);
 347
 348     MidiDeviceSettings _measure_midi;
 349     void midi_latency_adjustment_changed(Gtk::Adjustment *, MidiDeviceSettings, bool);
 350     void midi_device_enabled_toggled(ArdourButton *, MidiDeviceSettings);
 351     sigc::connection lm_back_button_signal;
 352 };
 353
 354 #endif /* __gtk2_ardour_engine_dialog_h__ */