2 Copyright (C) 1999-2002 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.
21 #ifndef __ardour_gui_h__
22 #define __ardour_gui_h__
24 /* need _BSD_SOURCE to get timersub macros */
38 #include <libgnomecanvasmm/canvas.h>
40 #include <pbd/xml++.h>
41 #include <gtkmm/box.h>
42 #include <gtkmm/frame.h>
43 #include <gtkmm/label.h>
44 #include <gtkmm/table.h>
45 #include <gtkmm/fixed.h>
46 #include <gtkmm/drawingarea.h>
47 #include <gtkmm/eventbox.h>
48 #include <gtkmm/menu.h>
49 #include <gtkmm/menuitem.h>
50 #include <gtkmm/button.h>
51 #include <gtkmm/togglebutton.h>
52 #include <gtkmm/treeview.h>
53 #include <gtkmm/menubar.h>
54 #include <gtkmm/adjustment.h>
55 #include <gtkmm2ext/gtk_ui.h>
56 #include <gtkmm2ext/click_box.h>
57 #include <gtkmm2ext/stateful_button.h>
58 #include <ardour/ardour.h>
59 #include <ardour/session.h>
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
71 class ConnectionEditor;
75 class NewSessionDialog;
88 class ControlProtocolInfo;
92 class MultiChannelDevice;
95 #define FRAME_NAME "BaseFrame"
97 class ARDOUR_UI : public Gtkmm2ext::UI
100 ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
104 bool shown() { return shown_flag; }
109 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
111 int build_session (const string & path, const string & snapshot,
113 uint32_t master_chns,
114 ARDOUR::AutoConnectOption input_connect,
115 ARDOUR::AutoConnectOption output_connect,
118 nframes_t initial_length);
119 bool session_is_new() const { return _session_is_new; }
121 ARDOUR::Session* the_session() { return session; }
123 bool will_create_new_session_automatically() const {
124 return _will_create_new_session_automatically;
127 void set_will_create_new_session_automatically (bool yn) {
128 _will_create_new_session_automatically = yn;
131 void new_session(std::string path = string());
132 gint cmdline_new_session (string path);
133 int unload_session ();
134 void close_session();
136 int save_state_canfail (string state_name = "");
137 void save_state (const string & state_name = "");
138 void restore_state (string state_name = "");
140 static double gain_to_slider_position (ARDOUR::gain_t g);
141 static ARDOUR::gain_t slider_position_to_gain (double pos);
143 static ARDOUR_UI *instance () { return theArdourUI; }
145 PublicEditor& the_editor(){return *editor;}
146 Mixer_UI* the_mixer() { return mixer; }
148 void toggle_location_window ();
149 void toggle_color_manager ();
150 void toggle_big_clock_window ();
151 void toggle_connection_editor ();
152 void toggle_route_params_window ();
153 void toggle_editing_space();
155 Gtk::Tooltips& tooltips() { return _tooltips; }
157 static sigc::signal<void,bool> Blink;
158 static sigc::signal<void> RapidScreenUpdate;
159 static sigc::signal<void> SuperRapidScreenUpdate;
160 static sigc::signal<void,nframes_t> Clock;
162 /* this is a helper function to centralize the (complex) logic for
163 blinking rec-enable buttons.
166 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
168 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
170 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
172 XMLNode* editor_settings() const;
173 XMLNode* mixer_settings () const;
174 XMLNode* keyboard_settings () const;
176 void save_ardour_state ();
177 gboolean configure_handler (GdkEventConfigure* conf);
179 void do_transport_locate (nframes_t position);
180 void halt_on_xrun_message ();
182 AudioClock primary_clock;
183 AudioClock secondary_clock;
184 AudioClock preroll_clock;
185 AudioClock postroll_clock;
187 void store_clock_modes ();
188 void restore_clock_modes ();
192 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
193 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
196 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
197 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
200 void session_add_midi_track ();
202 void set_engine (ARDOUR::AudioEngine&);
203 gint start_engine ();
205 gint exit_on_main_window_close (GdkEventAny *);
207 void maximise_editing_space ();
208 void restore_editing_space ();
210 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
211 void set_native_file_data_format (ARDOUR::SampleFormat sf);
213 void set_keybindings_path (std::string path);
214 void save_keybindings ();
217 friend class PublicEditor;
219 void toggle_clocking ();
220 void toggle_auto_play ();
221 void toggle_auto_input ();
222 void toggle_punch_in ();
223 void toggle_punch_out ();
224 void toggle_auto_return ();
225 void toggle_click ();
227 void toggle_session_auto_loop ();
229 void toggle_options_window ();
232 struct GlobalClickBox : public Gtk::VBox {
233 Gtkmm2ext::ClickBox *box;
236 vector<string> &strings;
237 Gtk::Adjustment adjustment;
239 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
241 GlobalClickBox (const string &str, vector<string> &vs)
243 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
244 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
245 label.set_text (str);
246 label.set_name ("GlobalButtonLabel");
248 frame.set_shadow_type (Gtk::SHADOW_IN);
251 box->set_print_func (printer, this);
252 box->set_wrap (true);
256 ARDOUR::AudioEngine *engine;
257 ARDOUR::Session *session;
259 Gtk::Tooltips _tooltips;
261 void goto_editor_window ();
262 void goto_mixer_window ();
264 Gtk::Table adjuster_table;
265 Gtk::Frame adjuster_frame;
266 Gtk::Fixed adjuster_base;
268 GlobalClickBox *online_control_button;
269 vector<string> online_control_strings;
271 GlobalClickBox *crossfade_time_button;
272 vector<string> crossfade_time_strings;
274 GlobalClickBox *mmc_id_button;
275 vector<string> mmc_id_strings;
277 Gtk::ToggleButton preroll_button;
278 Gtk::ToggleButton postroll_button;
280 Gtk::Table transport_table;
281 Gtk::Table option_table;
283 int setup_windows ();
284 void setup_transport ();
286 void setup_adjustables ();
288 static ARDOUR_UI *theArdourUI;
294 int ask_about_saving_session (const string & why);
295 int save_the_session;
297 void queue_transport_change ();
298 void map_transport_state ();
299 int32_t do_engine_start ();
301 void engine_halted ();
302 void engine_stopped ();
303 void engine_running ();
307 static gint _blink (void *);
309 gint blink_timeout_tag;
311 void start_blinking ();
312 void stop_blinking ();
314 void control_methods_adjusted ();
315 void mmc_device_id_adjusted ();
317 void about_signal_response(int response);
320 Gtk::VBox top_packer;
322 sigc::connection clock_signal_connection;
323 void update_clocks ();
324 void start_clocking ();
325 void stop_clocking ();
327 void manage_window (Gtk::Window&);
329 AudioClock big_clock;
330 Gtk::Frame big_clock_frame;
331 Gtk::Window* big_clock_window;
333 void update_transport_clocks (nframes_t pos);
334 void record_state_changed ();
336 /* Transport Control */
338 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
339 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
341 Gtkmm2ext::TearOff* transport_tearoff;
342 Gtk::Frame transport_frame;
343 Gtk::HBox transport_tearoff_hbox;
344 Gtk::HBox transport_hbox;
345 Gtk::Fixed transport_base;
346 Gtk::Fixed transport_button_base;
347 Gtk::Frame transport_button_frame;
348 Gtk::HBox transport_button_hbox;
349 Gtk::VBox transport_button_vbox;
350 Gtk::HBox transport_option_button_hbox;
351 Gtk::VBox transport_option_button_vbox;
352 Gtk::HBox transport_clock_hbox;
353 Gtk::VBox transport_clock_vbox;
354 Gtk::HBox primary_clock_hbox;
355 Gtk::HBox secondary_clock_hbox;
357 Gtkmm2ext::StatefulButton roll_button;
358 Gtkmm2ext::StatefulButton stop_button;
359 Gtkmm2ext::StatefulButton rewind_button;
360 Gtkmm2ext::StatefulButton forward_button;
361 Gtkmm2ext::StatefulButton goto_start_button;
362 Gtkmm2ext::StatefulButton goto_end_button;
363 Gtkmm2ext::StatefulButton auto_loop_button;
364 Gtkmm2ext::StatefulButton play_selection_button;
366 Gtkmm2ext::StatefulButton rec_button;
368 Gtk::ToggleButton time_master_button;
369 Gtk::ComboBoxText sync_option_combo;
371 void sync_option_changed ();
372 void toggle_time_master ();
373 void toggle_video_sync ();
375 Gtk::DrawingArea shuttle_box;
376 Gtk::EventBox speed_display_box;
377 Gtk::Label speed_display_label;
378 Gtk::Button shuttle_units_button;
379 Gtk::ComboBoxText shuttle_style_button;
380 Gtk::Menu* shuttle_unit_menu;
381 Gtk::Menu* shuttle_style_menu;
382 float shuttle_max_speed;
383 Gtk::Menu* shuttle_context_menu;
385 void build_shuttle_context_menu ();
386 void show_shuttle_context_menu ();
387 void shuttle_style_changed();
388 void shuttle_unit_clicked ();
389 void set_shuttle_max_speed (float);
390 void update_speed_display ();
391 float last_speed_displayed;
393 gint shuttle_box_button_press (GdkEventButton*);
394 gint shuttle_box_button_release (GdkEventButton*);
395 gint shuttle_box_scroll (GdkEventScroll*);
396 gint shuttle_box_motion (GdkEventMotion*);
397 gint shuttle_box_expose (GdkEventExpose*);
398 gint mouse_shuttle (double x, bool force);
399 void use_shuttle_fract (bool force);
401 bool shuttle_grabbed;
402 double shuttle_fract;
404 Gtk::ToggleButton punch_in_button;
405 Gtk::ToggleButton punch_out_button;
406 Gtk::ToggleButton auto_return_button;
407 Gtk::ToggleButton auto_play_button;
408 Gtk::ToggleButton auto_input_button;
409 Gtk::ToggleButton click_button;
410 Gtk::ToggleButton auditioning_alert_button;
411 Gtk::ToggleButton solo_alert_button;
415 void solo_blink (bool);
416 void audition_blink (bool);
418 void soloing_changed (bool);
419 void auditioning_changed (bool);
420 void _auditioning_changed (bool);
422 void solo_alert_toggle ();
423 void audition_alert_toggle ();
425 void primary_clock_value_changed ();
426 void secondary_clock_value_changed ();
428 /* called by Blink signal */
430 void transport_rec_enable_blink (bool onoff);
432 /* These change where we accept control from:
433 MMC, X (local) or both.
436 void allow_mmc_only ();
437 void allow_mmc_and_local ();
438 void allow_local_only ();
440 Gtk::Menu* session_popup_menu;
442 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
443 RecentSessionModelColumns() {
447 Gtk::TreeModelColumn<Glib::ustring> visible_name;
448 Gtk::TreeModelColumn<Glib::ustring> fullpath;
451 RecentSessionModelColumns recent_session_columns;
452 Gtk::TreeView recent_session_display;
453 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
455 ArdourDialog* session_selector_window;
456 Gtk::FileChooserDialog* open_session_selector;
458 void build_session_selector();
459 void redisplay_recent_sessions();
460 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
462 struct RecentSessionsSorter {
463 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
464 return cmp_nocase(a.first, b.first) == -1;
468 /* menu bar and associated stuff */
470 Gtk::MenuBar* menu_bar;
471 Gtk::EventBox menu_bar_base;
474 void build_menu_bar ();
475 void build_control_surface_menu ();
477 Gtk::Label wall_clock_label;
478 Gtk::EventBox wall_clock_box;
479 gint update_wall_clock ();
481 Gtk::Label disk_space_label;
482 Gtk::EventBox disk_space_box;
483 void update_disk_space ();
485 Gtk::Label cpu_load_label;
486 Gtk::EventBox cpu_load_box;
487 void update_cpu_load ();
489 Gtk::Label buffer_load_label;
490 Gtk::EventBox buffer_load_box;
491 void update_buffer_load ();
493 Gtk::Label sample_rate_label;
494 Gtk::EventBox sample_rate_box;
495 void update_sample_rate (nframes_t);
497 gint every_second ();
498 gint every_point_one_seconds ();
499 gint every_point_zero_one_seconds ();
501 sigc::connection second_connection;
502 sigc::connection point_one_second_connection;
503 sigc::connection point_zero_one_second_connection;
505 gint session_menu (GdkEventButton *);
507 bool _will_create_new_session_automatically;
509 NewSessionDialog* new_session_dialog;
511 void open_session ();
512 void open_recent_session ();
513 void save_template ();
515 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
517 void set_transport_sensitivity (bool);
519 void remove_last_capture ();
521 void transport_goto_zero ();
522 void transport_goto_start ();
523 void transport_goto_end ();
524 void transport_stop ();
525 void transport_stop_and_forget_capture ();
526 void transport_record ();
527 void transport_roll ();
528 void transport_play_selection();
529 void transport_forward (int option);
530 void transport_rewind (int option);
531 void transport_loop ();
533 void transport_rolling ();
534 void transport_rewinding ();
535 void transport_forwarding ();
536 void transport_stopped ();
538 bool _session_is_new;
539 void connect_to_session (ARDOUR::Session *);
540 void connect_dependents_to_session (ARDOUR::Session *);
541 void we_have_dependents ();
543 std::string keybindings_path;
545 void setup_keybindings ();
546 void setup_session_options ();
548 guint32 last_key_press_time;
550 void snapshot_session ();
555 PublicEditor *editor;
556 int create_editor ();
558 RouteParams_UI *route_params;
559 int create_route_params ();
561 ConnectionEditor *connection_editor;
562 int create_connection_editor ();
564 LocationUI *location_ui;
565 int create_location_ui ();
566 void handle_locations_change (ARDOUR::Location*);
568 ColorManager* color_manager;
572 OptionEditor *option_editor;
576 AddRouteDialog *add_route_dialog;
578 /* Keyboard Handling */
582 /* Keymap handling */
584 void install_actions ();
585 void start_keyboard_prefix();
587 void toggle_record_enable (uint32_t);
589 uint32_t rec_enabled_streams;
590 void count_recenabled_streams (ARDOUR::Route&);
596 Gtk::MenuItem *cleanup_item;
598 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
602 bool have_configure_timeout;
603 struct timeval last_configure_time;
604 gint configure_timeout ();
606 struct timeval last_peak_grab;
607 struct timeval last_shuttle_request;
609 bool have_disk_overrun_displayed;
610 bool have_disk_underrun_displayed;
612 void disk_overrun_message_gone ();
613 void disk_underrun_message_gone ();
614 void disk_overrun_handler ();
615 void disk_underrun_handler ();
617 int pending_state_dialog ();
619 void disconnect_from_jack ();
620 void reconnect_to_jack ();
621 void set_jack_buffer_size (nframes_t);
623 Gtk::MenuItem* jack_disconnect_item;
624 Gtk::MenuItem* jack_reconnect_item;
625 Gtk::Menu* jack_bufsize_menu;
627 int make_session_clean ();
628 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
630 Glib::RefPtr<Gtk::ActionGroup> common_actions;
632 void editor_realized ();
634 std::vector<std::string> positional_sync_strings;
636 void toggle_send_midi_feedback ();
637 void toggle_use_mmc ();
638 void toggle_send_mmc ();
639 void toggle_use_midi_control();
640 void toggle_send_mtc ();
642 void set_input_auto_connect (ARDOUR::AutoConnectOption);
643 void set_output_auto_connect (ARDOUR::AutoConnectOption);
644 void set_solo_model (ARDOUR::SoloModel);
645 void set_monitor_model (ARDOUR::MonitorModel);
647 void toggle_StopPluginsWithTransport();
648 void toggle_DoNotRunPluginsWhileRecording();
649 void toggle_VerifyRemoveLastCapture();
650 void toggle_StopRecordingOnXrun();
651 void toggle_StopTransportAtEndOfSession();
652 void toggle_GainReduceFastTransport();
653 void toggle_LatchedSolo();
654 void toggle_LatchedRecordEnable ();
656 void mtc_port_changed ();
657 void map_solo_model ();
658 void map_monitor_model ();
659 void map_file_header_format ();
660 void map_file_data_format ();
661 void map_input_auto_connect ();
662 void map_output_auto_connect ();
663 void parameter_changed (const char*);
665 void set_meter_hold (ARDOUR::MeterHold);
666 void set_meter_falloff (ARDOUR::MeterFalloff);
667 void map_meter_hold ();
668 void map_meter_falloff ();
670 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
671 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
673 bool can_save_keybindings;
677 #endif /* __ardour_gui_h__ */