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