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.
20 #ifndef __ardour_gui_h__
21 #define __ardour_gui_h__
23 /* need _BSD_SOURCE to get timersub macros */
37 #include <libgnomecanvasmm/canvas.h>
39 #include <pbd/xml++.h>
40 #include <gtkmm/box.h>
41 #include <gtkmm/frame.h>
42 #include <gtkmm/label.h>
43 #include <gtkmm/table.h>
44 #include <gtkmm/fixed.h>
45 #include <gtkmm/drawingarea.h>
46 #include <gtkmm/eventbox.h>
47 #include <gtkmm/menu.h>
48 #include <gtkmm/menuitem.h>
49 #include <gtkmm/button.h>
50 #include <gtkmm/togglebutton.h>
51 #include <gtkmm/treeview.h>
52 #include <gtkmm/menubar.h>
53 #include <gtkmm/textbuffer.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 <gtkmm2ext/bindable_button.h>
59 #include <ardour/ardour.h>
60 #include <ardour/session.h>
62 #include "audio_clock.h"
63 #include "ardour_dialog.h"
65 #include "ui_config.h"
73 class ConnectionEditor;
79 class NewSessionDialog;
90 class ControlProtocolInfo;
94 class MultiChannelDevice;
97 #define FRAME_NAME "BaseFrame"
99 extern sigc::signal<void> ColorsChanged;
101 class ARDOUR_UI : public Gtkmm2ext::UI
104 ARDOUR_UI (int *argcp, char **argvp[]);
108 bool shown() { return shown_flag; }
113 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
115 int build_session (const string & path, const string & snapshot,
117 uint32_t master_chns,
118 ARDOUR::AutoConnectOption input_connect,
119 ARDOUR::AutoConnectOption output_connect,
122 nframes_t initial_length);
123 bool session_is_new() const { return _session_is_new; }
125 ARDOUR::Session* the_session() { return session; }
127 bool will_create_new_session_automatically() const {
128 return _will_create_new_session_automatically;
131 void set_will_create_new_session_automatically (bool yn) {
132 _will_create_new_session_automatically = yn;
135 bool get_session_parameters (Glib::ustring path, bool have_engine = false, bool should_be_new = false);
136 gint cmdline_new_session (string path);
137 int unload_session (bool hide_stuff = false);
138 void close_session();
140 int save_state_canfail (string state_name = "");
141 void save_state (const string & state_name = "");
142 void restore_state (string state_name = "");
144 static double gain_to_slider_position (ARDOUR::gain_t g);
145 static ARDOUR::gain_t slider_position_to_gain (double pos);
147 static ARDOUR_UI *instance () { return theArdourUI; }
148 static UIConfiguration *config () { return ui_config; }
150 PublicEditor& the_editor(){return *editor;}
151 Mixer_UI* the_mixer() { return mixer; }
153 void toggle_key_editor ();
154 void toggle_location_window ();
155 void toggle_theme_manager ();
156 void toggle_big_clock_window ();
157 void toggle_connection_editor ();
158 void toggle_route_params_window ();
159 void toggle_editing_space();
161 Gtk::Tooltips& tooltips() { return _tooltips; }
163 static sigc::signal<void,bool> Blink;
164 static sigc::signal<void> RapidScreenUpdate;
165 static sigc::signal<void> SuperRapidScreenUpdate;
166 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
168 /* this is a helper function to centralize the (complex) logic for
169 blinking rec-enable buttons.
172 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
174 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
176 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
178 XMLNode* editor_settings() const;
179 XMLNode* mixer_settings () const;
180 XMLNode* keyboard_settings () const;
182 void save_ardour_state ();
183 gboolean configure_handler (GdkEventConfigure* conf);
185 void do_transport_locate (nframes_t position);
186 void halt_on_xrun_message ();
188 AudioClock primary_clock;
189 AudioClock secondary_clock;
190 AudioClock preroll_clock;
191 AudioClock postroll_clock;
193 void store_clock_modes ();
194 void restore_clock_modes ();
196 void add_route (Gtk::Window* float_window);
198 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
199 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
202 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
203 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
206 void session_add_midi_track ();
208 int create_engine ();
211 gint exit_on_main_window_close (GdkEventAny *);
213 void maximise_editing_space ();
214 void restore_editing_space ();
216 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
217 void set_native_file_data_format (ARDOUR::SampleFormat sf);
219 void set_keybindings_path (std::string path);
220 void save_keybindings ();
222 void setup_profile ();
225 void set_shuttle_fract (double);
228 friend class PublicEditor;
230 void toggle_clocking ();
231 void toggle_auto_play ();
232 void toggle_auto_input ();
233 void toggle_punch_in ();
234 void toggle_punch_out ();
235 void toggle_auto_return ();
236 void toggle_click ();
238 void toggle_session_auto_loop ();
240 void toggle_options_window ();
243 struct GlobalClickBox : public Gtk::VBox {
244 Gtkmm2ext::ClickBox *box;
247 vector<string> &strings;
248 Gtk::Adjustment adjustment;
250 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
252 GlobalClickBox (const string &str, vector<string> &vs)
254 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
255 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
256 label.set_text (str);
257 label.set_name ("GlobalButtonLabel");
259 frame.set_shadow_type (Gtk::SHADOW_IN);
262 box->set_print_func (printer, this);
263 box->set_wrap (true);
267 ARDOUR::AudioEngine *engine;
268 ARDOUR::Session *session;
270 bool check_audioengine();
272 Gtk::Tooltips _tooltips;
274 void goto_editor_window ();
275 void goto_mixer_window ();
277 Gtk::Table adjuster_table;
278 Gtk::Frame adjuster_frame;
279 Gtk::Fixed adjuster_base;
281 GlobalClickBox *online_control_button;
282 vector<string> online_control_strings;
284 GlobalClickBox *crossfade_time_button;
285 vector<string> crossfade_time_strings;
287 Gtk::ToggleButton preroll_button;
288 Gtk::ToggleButton postroll_button;
290 Gtk::Table transport_table;
291 Gtk::Table option_table;
293 int setup_windows ();
294 void setup_transport ();
297 static ARDOUR_UI *theArdourUI;
299 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
304 int ask_about_saving_session (const string & why);
305 int save_the_session;
307 /* periodic safety backup, to be precise */
308 gint autosave_session();
309 void update_autosave();
310 sigc::connection _autosave_connection;
312 void queue_transport_change ();
313 void map_transport_state ();
314 int32_t do_engine_start ();
316 void engine_halted ();
317 void engine_stopped ();
318 void engine_running ();
322 static gint _blink (void *);
324 gint blink_timeout_tag;
326 void start_blinking ();
327 void stop_blinking ();
329 void about_signal_response(int response);
333 Gtk::VBox top_packer;
335 sigc::connection clock_signal_connection;
336 void update_clocks ();
337 void start_clocking ();
338 void stop_clocking ();
340 void manage_window (Gtk::Window&);
342 AudioClock big_clock;
343 Gtk::Frame big_clock_frame;
344 Gtk::Window* big_clock_window;
346 void update_transport_clocks (nframes_t pos);
347 void record_state_changed ();
349 /* Transport Control */
351 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
352 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
354 Gtkmm2ext::TearOff* transport_tearoff;
355 Gtk::Frame transport_frame;
356 Gtk::HBox transport_tearoff_hbox;
357 Gtk::HBox transport_hbox;
358 Gtk::Fixed transport_base;
359 Gtk::Fixed transport_button_base;
360 Gtk::Frame transport_button_frame;
361 Gtk::HBox transport_button_hbox;
362 Gtk::VBox transport_button_vbox;
363 Gtk::HBox transport_option_button_hbox;
364 Gtk::VBox transport_option_button_vbox;
365 Gtk::HBox transport_clock_hbox;
366 Gtk::VBox transport_clock_vbox;
367 Gtk::HBox primary_clock_hbox;
368 Gtk::HBox secondary_clock_hbox;
371 struct TransportControllable : public PBD::Controllable {
384 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
385 void set_value (float);
386 float get_value (void) const;
388 void set_id (const std::string&);
394 TransportControllable roll_controllable;
395 TransportControllable stop_controllable;
396 TransportControllable goto_start_controllable;
397 TransportControllable goto_end_controllable;
398 TransportControllable auto_loop_controllable;
399 TransportControllable play_selection_controllable;
400 TransportControllable rec_controllable;
401 TransportControllable shuttle_controllable;
402 BindingProxy shuttle_controller_binding_proxy;
404 void set_transport_controllable_state (const XMLNode&);
405 XMLNode& get_transport_controllable_state ();
407 BindableButton roll_button;
408 BindableButton stop_button;
409 BindableButton goto_start_button;
410 BindableButton goto_end_button;
411 BindableButton auto_loop_button;
412 BindableButton play_selection_button;
413 BindableButton rec_button;
415 Gtk::ComboBoxText sync_option_combo;
417 void sync_option_changed ();
418 void toggle_time_master ();
419 void toggle_video_sync ();
421 Gtk::DrawingArea shuttle_box;
422 Gtk::EventBox speed_display_box;
423 Gtk::Label speed_display_label;
424 Gtk::Button shuttle_units_button;
425 Gtk::ComboBoxText shuttle_style_button;
426 Gtk::Menu* shuttle_unit_menu;
427 Gtk::Menu* shuttle_style_menu;
428 float shuttle_max_speed;
429 Gtk::Menu* shuttle_context_menu;
431 void build_shuttle_context_menu ();
432 void show_shuttle_context_menu ();
433 void shuttle_style_changed();
434 void shuttle_unit_clicked ();
435 void set_shuttle_max_speed (float);
436 void update_speed_display ();
437 float last_speed_displayed;
439 gint shuttle_box_button_press (GdkEventButton*);
440 gint shuttle_box_button_release (GdkEventButton*);
441 gint shuttle_box_scroll (GdkEventScroll*);
442 gint shuttle_box_motion (GdkEventMotion*);
443 gint shuttle_box_expose (GdkEventExpose*);
444 gint mouse_shuttle (double x, bool force);
445 void use_shuttle_fract (bool force);
447 bool shuttle_grabbed;
448 double shuttle_fract;
450 Gtkmm2ext::StatefulToggleButton punch_in_button;
451 Gtkmm2ext::StatefulToggleButton punch_out_button;
452 Gtkmm2ext::StatefulToggleButton auto_return_button;
453 Gtkmm2ext::StatefulToggleButton auto_play_button;
454 Gtkmm2ext::StatefulToggleButton auto_input_button;
455 Gtkmm2ext::StatefulToggleButton click_button;
456 Gtkmm2ext::StatefulToggleButton time_master_button;
458 Gtk::ToggleButton auditioning_alert_button;
459 Gtk::ToggleButton solo_alert_button;
463 void solo_blink (bool);
464 void audition_blink (bool);
466 void soloing_changed (bool);
467 void auditioning_changed (bool);
468 void _auditioning_changed (bool);
470 void solo_alert_toggle ();
471 void audition_alert_toggle ();
473 void primary_clock_value_changed ();
474 void secondary_clock_value_changed ();
476 /* called by Blink signal */
478 void transport_rec_enable_blink (bool onoff);
480 Gtk::Menu* session_popup_menu;
482 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
483 RecentSessionModelColumns() {
487 Gtk::TreeModelColumn<Glib::ustring> visible_name;
488 Gtk::TreeModelColumn<Glib::ustring> fullpath;
491 RecentSessionModelColumns recent_session_columns;
492 Gtk::TreeView recent_session_display;
493 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
495 ArdourDialog* session_selector_window;
496 Gtk::FileChooserDialog* open_session_selector;
498 void build_session_selector();
499 void redisplay_recent_sessions();
500 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
502 struct RecentSessionsSorter {
503 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
504 return cmp_nocase(a.first, b.first) == -1;
508 /* menu bar and associated stuff */
510 Gtk::MenuBar* menu_bar;
511 Gtk::EventBox menu_bar_base;
514 void use_menubar_as_top_menubar ();
516 void build_menu_bar ();
517 void build_control_surface_menu ();
519 Gtk::Label wall_clock_label;
520 Gtk::EventBox wall_clock_box;
521 gint update_wall_clock ();
523 Gtk::Label disk_space_label;
524 Gtk::EventBox disk_space_box;
525 void update_disk_space ();
527 Gtk::Label cpu_load_label;
528 Gtk::EventBox cpu_load_box;
529 void update_cpu_load ();
531 Gtk::Label buffer_load_label;
532 Gtk::EventBox buffer_load_box;
533 void update_buffer_load ();
535 Gtk::Label sample_rate_label;
536 Gtk::EventBox sample_rate_box;
537 void update_sample_rate (nframes_t);
539 gint every_second ();
540 gint every_point_one_seconds ();
541 gint every_point_zero_one_seconds ();
543 sigc::connection second_connection;
544 sigc::connection point_one_second_connection;
545 sigc::connection point_oh_five_second_connection;
546 sigc::connection point_zero_one_second_connection;
548 gint session_menu (GdkEventButton *);
550 bool _will_create_new_session_automatically;
552 NewSessionDialog* new_session_dialog;
554 void open_session ();
555 void open_recent_session ();
556 void save_template ();
558 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
560 void set_transport_sensitivity (bool);
562 void remove_last_capture ();
564 void transport_goto_zero ();
565 void transport_goto_start ();
566 void transport_goto_end ();
567 void transport_stop ();
568 void transport_stop_and_forget_capture ();
569 void transport_record ();
570 void transport_roll ();
571 void transport_play_selection();
572 void transport_forward (int option);
573 void transport_rewind (int option);
574 void transport_loop ();
576 void transport_rolling ();
577 void transport_rewinding ();
578 void transport_forwarding ();
579 void transport_stopped ();
581 bool _session_is_new;
582 void connect_to_session (ARDOUR::Session *);
583 void connect_dependents_to_session (ARDOUR::Session *);
584 void we_have_dependents ();
586 std::string keybindings_path;
587 std::string user_keybindings_path;
589 void setup_keybindings ();
590 void setup_session_options ();
592 guint32 last_key_press_time;
594 void snapshot_session ();
599 PublicEditor *editor;
600 int create_editor ();
602 RouteParams_UI *route_params;
603 int create_route_params ();
605 ConnectionEditor *connection_editor;
606 int create_connection_editor ();
608 LocationUI *location_ui;
609 int create_location_ui ();
610 void handle_locations_change (ARDOUR::Location*);
612 static UIConfiguration *ui_config;
613 ThemeManager *theme_manager;
615 /* Key bindings editor */
617 KeyEditor *key_editor;
621 OptionEditor *option_editor;
625 AddRouteDialog *add_route_dialog;
627 /* Keyboard Handling */
631 /* Keymap handling */
633 void install_actions ();
635 void toggle_record_enable (uint32_t);
637 uint32_t rec_enabled_streams;
638 void count_recenabled_streams (ARDOUR::Route&);
644 Gtk::MenuItem *cleanup_item;
646 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
650 bool have_configure_timeout;
651 struct timeval last_configure_time;
652 gint configure_timeout ();
654 struct timeval last_peak_grab;
655 struct timeval last_shuttle_request;
657 bool have_disk_speed_dialog_displayed;
658 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
659 void disk_overrun_handler ();
660 void disk_underrun_handler ();
662 int pending_state_dialog ();
664 void disconnect_from_jack ();
665 void reconnect_to_jack ();
666 void set_jack_buffer_size (nframes_t);
668 Gtk::MenuItem* jack_disconnect_item;
669 Gtk::MenuItem* jack_reconnect_item;
670 Gtk::Menu* jack_bufsize_menu;
672 int make_session_clean ();
673 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
675 Glib::RefPtr<Gtk::ActionGroup> common_actions;
677 void editor_realized ();
679 std::vector<std::string> positional_sync_strings;
681 void toggle_send_midi_feedback ();
682 void toggle_use_mmc ();
683 void toggle_send_mmc ();
684 void toggle_send_mtc ();
686 void toggle_use_osc ();
688 void toggle_denormal_protection ();
690 void set_input_auto_connect (ARDOUR::AutoConnectOption);
691 void set_output_auto_connect (ARDOUR::AutoConnectOption);
692 void set_solo_model (ARDOUR::SoloModel);
693 void set_monitor_model (ARDOUR::MonitorModel);
694 void set_remote_model (ARDOUR::RemoteModel);
695 void set_denormal_model (ARDOUR::DenormalModel);
697 void toggle_sync_order_keys ();
698 void toggle_StopPluginsWithTransport();
699 void toggle_DoNotRunPluginsWhileRecording();
700 void toggle_VerifyRemoveLastCapture();
701 void toggle_PeriodicSafetyBackups();
702 void toggle_StopRecordingOnXrun();
703 void toggle_StopTransportAtEndOfSession();
704 void toggle_GainReduceFastTransport();
705 void toggle_LatchedSolo();
706 void toggle_ShowSoloMutes();
707 void toggle_LatchedRecordEnable ();
708 void toggle_RegionEquivalentsOverlap ();
709 void toggle_PrimaryClockDeltaEditCursor ();
710 void toggle_SecondaryClockDeltaEditCursor ();
711 void toggle_only_copy_imported_files ();
713 void mtc_port_changed ();
714 void map_solo_model ();
715 void map_monitor_model ();
716 void map_denormal_model ();
717 void map_denormal_protection ();
718 void map_remote_model ();
719 void map_file_header_format ();
720 void map_file_data_format ();
721 void map_input_auto_connect ();
722 void map_output_auto_connect ();
723 void map_only_copy_imported_files ();
724 void parameter_changed (const char*);
726 void set_meter_hold (ARDOUR::MeterHold);
727 void set_meter_falloff (ARDOUR::MeterFalloff);
728 void map_meter_hold ();
729 void map_meter_falloff ();
731 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
732 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
734 bool can_save_keybindings;
737 void no_memory_warning ();
738 void check_memory_locking ();
740 void audioengine_setup ();
742 void display_message (const char *prefix, gint prefix_len,
743 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
744 Gtk::Label status_bar_label;
745 Gtk::ToggleButton error_log_button;
746 Gtk::MessageDialog* loading_dialog;
748 void platform_specific ();
751 #endif /* __ardour_gui_h__ */