2 Copyright (C) 2010 Paul Davis
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.
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.
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.
20 #ifndef __gtk2_ardour_engine_dialog_h__
21 #define __gtk2_ardour_engine_dialog_h__
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>
36 #include "pbd/signals.h"
38 #include "ardour_dialog.h"
39 #include "ardour_button.h"
41 class EngineControl : public ArdourDialog, public PBD::ScopedConnectionList {
46 static bool need_setup ();
48 XMLNode& get_state ();
49 bool set_state (const XMLNode&);
51 void set_desired_sample_rate (uint32_t);
54 Gtk::Notebook notebook;
56 Gtk::Label engine_status;
58 /* core fields used by all backends */
60 Gtk::Table basic_packer;
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::Adjustment input_latency_adjustment;
74 Gtk::SpinButton input_latency;
75 Gtk::Adjustment output_latency_adjustment;
76 Gtk::SpinButton output_latency;
77 Gtk::Adjustment input_channels_adjustment;
78 Gtk::SpinButton input_channels;
79 Gtk::Adjustment output_channels_adjustment;
80 Gtk::SpinButton output_channels;
81 Gtk::Adjustment ports_adjustment;
82 Gtk::SpinButton ports_spinner;
84 Gtk::Label have_control_text;
85 ArdourButton control_app_button;
86 ArdourButton midi_devices_button;
87 ArdourButton stop_engine_button;
89 Gtk::Button connect_disconnect_button;
91 /* latency measurement */
93 Gtk::ComboBoxText lm_output_channel_combo;
94 Gtk::ComboBoxText lm_input_channel_combo;
95 Gtk::Label lm_measure_label;
96 Gtk::Button lm_measure_button;
97 Gtk::Button lm_use_button;
98 Gtk::Button lm_back_button;
99 ArdourButton lm_button_audio;
101 Gtk::Label lm_preamble;
102 Gtk::Label lm_results;
105 bool have_lm_results;
108 Gtk::Button* cancel_button;
109 Gtk::Button* ok_button;
110 Gtk::Button* apply_button;
115 Gtk::Button midi_back_button;
116 Gtk::Table midi_device_table;
120 Gtk::CheckButton aj_button;
122 uint32_t ignore_changes;
123 uint32_t _desired_sample_rate;
124 bool started_at_least_once;
125 bool queue_device_changed;
127 void driver_changed ();
128 void backend_changed ();
129 void sample_rate_changed ();
130 void buffer_size_changed ();
131 void parameter_changed ();
132 void midi_option_changed ();
134 void setup_midi_tab_for_backend ();
135 void setup_midi_tab_for_jack ();
136 void refresh_midi_display (std::string focus = "");
138 void update_midi_options ();
140 std::string bufsize_as_string (uint32_t);
142 std::vector<float> get_default_sample_rates ();
143 std::vector<uint32_t> get_default_buffer_sizes ();
145 std::vector<float> get_sample_rates_for_all_devices ();
146 std::vector<uint32_t> get_buffer_sizes_for_all_devices ();
148 float get_rate() const;
149 uint32_t get_buffer_size() const;
150 uint32_t get_input_channels() const;
151 uint32_t get_output_channels() const;
152 uint32_t get_input_latency() const;
153 uint32_t get_output_latency() const;
154 std::string get_device_name() const;
155 std::string get_input_device_name() const;
156 std::string get_output_device_name() const;
157 std::string get_driver() const;
158 std::string get_backend() const;
159 std::string get_midi_option () const;
161 void device_changed ();
162 void input_device_changed ();
163 void output_device_changed ();
164 bool set_driver_popdown_strings ();
165 bool set_device_popdown_strings ();
166 bool set_input_device_popdown_strings ();
167 bool set_output_device_popdown_strings ();
168 void set_samplerate_popdown_strings ();
169 void set_buffersize_popdown_strings ();
170 void list_devices ();
171 void show_buffer_duration ();
173 void configure_midi_devices ();
175 struct MidiDeviceSetting {
178 uint32_t input_latency;
179 uint32_t output_latency;
181 MidiDeviceSetting (std::string n, bool en = true, uint32_t inl = 0, uint32_t oul = 0)
184 , input_latency (inl)
185 , output_latency (oul)
189 typedef boost::shared_ptr<MidiDeviceSetting> MidiDeviceSettings;
190 bool _can_set_midi_latencies;
191 std::vector<MidiDeviceSettings> _midi_devices;
193 MidiDeviceSettings find_midi_device(std::string devicename) const {
194 for (std::vector<MidiDeviceSettings>::const_iterator p = _midi_devices.begin(); p != _midi_devices.end(); ++p) {
195 if ((*p)->name == devicename) {
199 return MidiDeviceSettings();
206 std::string input_device;
207 std::string output_device;
209 uint32_t buffer_size;
210 uint32_t input_latency;
211 uint32_t output_latency;
212 uint32_t input_channels;
213 uint32_t output_channels;
215 std::string midi_option;
216 std::vector<MidiDeviceSettings> midi_devices;
219 : sample_rate (48000)
224 , output_channels (0)
229 typedef boost::shared_ptr<StateStruct> State;
230 typedef std::list<State> StateList;
234 State get_matching_state (const std::string& backend,
235 const std::string& driver,
236 const std::string& device);
237 State get_matching_state (const std::string& backend,
238 const std::string& driver,
239 const std::string& input_device,
240 const std::string& output_device);
241 State get_saved_state_for_currently_displayed_backend_and_device ();
242 void maybe_display_saved_state ();
244 void store_state (State);
245 bool equivalent_states (const State&, const State&);
247 bool set_current_state (const State& state);
248 void set_default_state ();
252 static bool print_channel_count (Gtk::SpinButton*);
254 void build_notebook ();
255 void build_full_control_notebook ();
256 void build_no_control_notebook ();
258 void connect_changed_signals ();
259 void block_changed_signals ();
260 void unblock_changed_signals ();
265 SignalBlocker (EngineControl& engine_control, const std::string& reason);
271 std::string m_reason;
274 uint32_t block_signals;
276 sigc::connection backend_combo_connection;
277 sigc::connection driver_combo_connection;
278 sigc::connection sample_rate_combo_connection;
279 sigc::connection buffer_size_combo_connection;
280 sigc::connection device_combo_connection;
281 sigc::connection input_device_combo_connection;
282 sigc::connection output_device_combo_connection;
283 sigc::connection midi_option_combo_connection;
284 sigc::connection input_latency_connection;
285 sigc::connection output_latency_connection;
286 sigc::connection input_channels_connection;
287 sigc::connection output_channels_connection;
290 void on_response (int);
291 void control_app_button_clicked ();
292 void stop_engine_button_clicked ();
293 void use_latency_button_clicked ();
294 void manage_control_app_sensitivity ();
295 int push_state_to_backend (bool start);
297 void update_sensitivity ();
299 /* latency measurement */
300 void latency_button_clicked ();
301 bool check_audio_latency_measurement ();
302 bool check_midi_latency_measurement ();
303 sigc::connection latency_timeout;
304 void enable_latency_tab ();
305 void disable_latency_tab ();
306 void start_latency_detection ();
307 void end_latency_detection ();
309 void on_switch_page (GtkNotebookPage*, guint page_num);
310 bool on_delete_event (GdkEventAny*);
312 void engine_running ();
313 void engine_stopped ();
314 void device_list_changed ();
316 PBD::ScopedConnection running_connection;
317 PBD::ScopedConnectionList stopped_connection;
318 PBD::ScopedConnection devicelist_connection;
320 void connect_disconnect_click ();
321 void calibrate_audio_latency ();
322 void calibrate_midi_latency (MidiDeviceSettings);
324 MidiDeviceSettings _measure_midi;
325 void midi_latency_adjustment_changed(Gtk::Adjustment *, MidiDeviceSettings, bool);
326 void midi_device_enabled_toggled(ArdourButton *, MidiDeviceSettings);
327 sigc::connection lm_back_button_signal;
330 #endif /* __gtk2_ardour_engine_dialog_h__ */