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"
72 class ConnectionEditor;
78 class NewSessionDialog;
89 class ControlProtocolInfo;
93 class MultiChannelDevice;
96 #define FRAME_NAME "BaseFrame"
98 extern sigc::signal<void> ColorsChanged;
100 class ARDOUR_UI : public Gtkmm2ext::UI
103 ARDOUR_UI (int *argcp, char **argvp[]);
107 bool shown() { return shown_flag; }
112 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
114 int build_session (const string & path, const string & snapshot,
116 uint32_t master_chns,
117 ARDOUR::AutoConnectOption input_connect,
118 ARDOUR::AutoConnectOption output_connect,
121 nframes_t initial_length);
122 bool session_is_new() const { return _session_is_new; }
124 ARDOUR::Session* the_session() { return session; }
126 bool will_create_new_session_automatically() const {
127 return _will_create_new_session_automatically;
130 void set_will_create_new_session_automatically (bool yn) {
131 _will_create_new_session_automatically = yn;
134 bool get_session_parameters (Glib::ustring path, bool have_engine = false, bool should_be_new = false);
135 gint cmdline_new_session (string path);
136 int unload_session (bool hide_stuff = false);
137 void close_session();
139 int save_state_canfail (string state_name = "");
140 void save_state (const string & state_name = "");
141 void restore_state (string state_name = "");
143 static double gain_to_slider_position (ARDOUR::gain_t g);
144 static ARDOUR::gain_t slider_position_to_gain (double pos);
146 static ARDOUR_UI *instance () { return theArdourUI; }
147 static UIConfiguration *config () { return ui_config; }
149 PublicEditor& the_editor(){return *editor;}
150 Mixer_UI* the_mixer() { return mixer; }
152 void toggle_location_window ();
153 void toggle_theme_manager ();
154 void toggle_big_clock_window ();
155 void toggle_connection_editor ();
156 void toggle_route_params_window ();
157 void toggle_editing_space();
159 Gtk::Tooltips& tooltips() { return _tooltips; }
161 static sigc::signal<void,bool> Blink;
162 static sigc::signal<void> RapidScreenUpdate;
163 static sigc::signal<void> SuperRapidScreenUpdate;
164 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
166 /* this is a helper function to centralize the (complex) logic for
167 blinking rec-enable buttons.
170 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
172 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
174 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
176 XMLNode* editor_settings() const;
177 XMLNode* mixer_settings () const;
178 XMLNode* keyboard_settings () const;
180 void save_ardour_state ();
181 gboolean configure_handler (GdkEventConfigure* conf);
183 void do_transport_locate (nframes_t position);
184 void halt_on_xrun_message ();
186 AudioClock primary_clock;
187 AudioClock secondary_clock;
188 AudioClock preroll_clock;
189 AudioClock postroll_clock;
191 void store_clock_modes ();
192 void restore_clock_modes ();
194 void add_route (Gtk::Window* float_window);
196 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
197 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
200 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
201 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
204 void session_add_midi_track ();
206 int create_engine ();
209 gint exit_on_main_window_close (GdkEventAny *);
211 void maximise_editing_space ();
212 void restore_editing_space ();
214 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
215 void set_native_file_data_format (ARDOUR::SampleFormat sf);
217 void set_keybindings_path (std::string path);
218 void save_keybindings ();
220 void setup_profile ();
223 void set_shuttle_fract (double);
226 friend class PublicEditor;
228 void toggle_clocking ();
229 void toggle_auto_play ();
230 void toggle_auto_input ();
231 void toggle_punch_in ();
232 void toggle_punch_out ();
233 void toggle_auto_return ();
234 void toggle_click ();
236 void toggle_session_auto_loop ();
238 void toggle_options_window ();
241 struct GlobalClickBox : public Gtk::VBox {
242 Gtkmm2ext::ClickBox *box;
245 vector<string> &strings;
246 Gtk::Adjustment adjustment;
248 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
250 GlobalClickBox (const string &str, vector<string> &vs)
252 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
253 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
254 label.set_text (str);
255 label.set_name ("GlobalButtonLabel");
257 frame.set_shadow_type (Gtk::SHADOW_IN);
260 box->set_print_func (printer, this);
261 box->set_wrap (true);
265 ARDOUR::AudioEngine *engine;
266 ARDOUR::Session *session;
268 bool check_audioengine();
270 Gtk::Tooltips _tooltips;
272 void goto_editor_window ();
273 void goto_mixer_window ();
275 Gtk::Table adjuster_table;
276 Gtk::Frame adjuster_frame;
277 Gtk::Fixed adjuster_base;
279 GlobalClickBox *online_control_button;
280 vector<string> online_control_strings;
282 GlobalClickBox *crossfade_time_button;
283 vector<string> crossfade_time_strings;
285 Gtk::ToggleButton preroll_button;
286 Gtk::ToggleButton postroll_button;
288 Gtk::Table transport_table;
289 Gtk::Table option_table;
291 int setup_windows ();
292 void setup_transport ();
295 static ARDOUR_UI *theArdourUI;
297 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
302 int ask_about_saving_session (const string & why);
303 int save_the_session;
305 /* periodic safety backup, to be precise */
306 gint autosave_session();
307 void update_autosave();
308 sigc::connection _autosave_connection;
310 void queue_transport_change ();
311 void map_transport_state ();
312 int32_t do_engine_start ();
314 void engine_halted ();
315 void engine_stopped ();
316 void engine_running ();
320 static gint _blink (void *);
322 gint blink_timeout_tag;
324 void start_blinking ();
325 void stop_blinking ();
327 void about_signal_response(int response);
331 Gtk::VBox top_packer;
333 sigc::connection clock_signal_connection;
334 void update_clocks ();
335 void start_clocking ();
336 void stop_clocking ();
338 void manage_window (Gtk::Window&);
340 AudioClock big_clock;
341 Gtk::Frame big_clock_frame;
342 Gtk::Window* big_clock_window;
344 void update_transport_clocks (nframes_t pos);
345 void record_state_changed ();
347 /* Transport Control */
349 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
350 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
352 Gtkmm2ext::TearOff* transport_tearoff;
353 Gtk::Frame transport_frame;
354 Gtk::HBox transport_tearoff_hbox;
355 Gtk::HBox transport_hbox;
356 Gtk::Fixed transport_base;
357 Gtk::Fixed transport_button_base;
358 Gtk::Frame transport_button_frame;
359 Gtk::HBox transport_button_hbox;
360 Gtk::VBox transport_button_vbox;
361 Gtk::HBox transport_option_button_hbox;
362 Gtk::VBox transport_option_button_vbox;
363 Gtk::HBox transport_clock_hbox;
364 Gtk::VBox transport_clock_vbox;
365 Gtk::HBox primary_clock_hbox;
366 Gtk::HBox secondary_clock_hbox;
369 struct TransportControllable : public PBD::Controllable {
382 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
383 void set_value (float);
384 float get_value (void) const;
386 void set_id (const std::string&);
392 TransportControllable roll_controllable;
393 TransportControllable stop_controllable;
394 TransportControllable goto_start_controllable;
395 TransportControllable goto_end_controllable;
396 TransportControllable auto_loop_controllable;
397 TransportControllable play_selection_controllable;
398 TransportControllable rec_controllable;
399 TransportControllable shuttle_controllable;
400 BindingProxy shuttle_controller_binding_proxy;
402 void set_transport_controllable_state (const XMLNode&);
403 XMLNode& get_transport_controllable_state ();
405 BindableButton roll_button;
406 BindableButton stop_button;
407 BindableButton goto_start_button;
408 BindableButton goto_end_button;
409 BindableButton auto_loop_button;
410 BindableButton play_selection_button;
411 BindableButton rec_button;
413 Gtk::ComboBoxText sync_option_combo;
415 void sync_option_changed ();
416 void toggle_time_master ();
417 void toggle_video_sync ();
419 Gtk::DrawingArea shuttle_box;
420 Gtk::EventBox speed_display_box;
421 Gtk::Label speed_display_label;
422 Gtk::Button shuttle_units_button;
423 Gtk::ComboBoxText shuttle_style_button;
424 Gtk::Menu* shuttle_unit_menu;
425 Gtk::Menu* shuttle_style_menu;
426 float shuttle_max_speed;
427 Gtk::Menu* shuttle_context_menu;
429 void build_shuttle_context_menu ();
430 void show_shuttle_context_menu ();
431 void shuttle_style_changed();
432 void shuttle_unit_clicked ();
433 void set_shuttle_max_speed (float);
434 void update_speed_display ();
435 float last_speed_displayed;
437 gint shuttle_box_button_press (GdkEventButton*);
438 gint shuttle_box_button_release (GdkEventButton*);
439 gint shuttle_box_scroll (GdkEventScroll*);
440 gint shuttle_box_motion (GdkEventMotion*);
441 gint shuttle_box_expose (GdkEventExpose*);
442 gint mouse_shuttle (double x, bool force);
443 void use_shuttle_fract (bool force);
445 bool shuttle_grabbed;
446 double shuttle_fract;
448 Gtkmm2ext::StatefulToggleButton punch_in_button;
449 Gtkmm2ext::StatefulToggleButton punch_out_button;
450 Gtkmm2ext::StatefulToggleButton auto_return_button;
451 Gtkmm2ext::StatefulToggleButton auto_play_button;
452 Gtkmm2ext::StatefulToggleButton auto_input_button;
453 Gtkmm2ext::StatefulToggleButton click_button;
454 Gtkmm2ext::StatefulToggleButton time_master_button;
456 Gtk::ToggleButton auditioning_alert_button;
457 Gtk::ToggleButton solo_alert_button;
461 void solo_blink (bool);
462 void audition_blink (bool);
464 void soloing_changed (bool);
465 void auditioning_changed (bool);
466 void _auditioning_changed (bool);
468 void solo_alert_toggle ();
469 void audition_alert_toggle ();
471 void primary_clock_value_changed ();
472 void secondary_clock_value_changed ();
474 /* called by Blink signal */
476 void transport_rec_enable_blink (bool onoff);
478 Gtk::Menu* session_popup_menu;
480 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
481 RecentSessionModelColumns() {
485 Gtk::TreeModelColumn<Glib::ustring> visible_name;
486 Gtk::TreeModelColumn<Glib::ustring> fullpath;
489 RecentSessionModelColumns recent_session_columns;
490 Gtk::TreeView recent_session_display;
491 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
493 ArdourDialog* session_selector_window;
494 Gtk::FileChooserDialog* open_session_selector;
496 void build_session_selector();
497 void redisplay_recent_sessions();
498 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
500 struct RecentSessionsSorter {
501 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
502 return cmp_nocase(a.first, b.first) == -1;
506 /* menu bar and associated stuff */
508 Gtk::MenuBar* menu_bar;
509 Gtk::EventBox menu_bar_base;
512 void use_menubar_as_top_menubar ();
514 void build_menu_bar ();
515 void build_control_surface_menu ();
517 Gtk::Label wall_clock_label;
518 Gtk::EventBox wall_clock_box;
519 gint update_wall_clock ();
521 Gtk::Label disk_space_label;
522 Gtk::EventBox disk_space_box;
523 void update_disk_space ();
525 Gtk::Label cpu_load_label;
526 Gtk::EventBox cpu_load_box;
527 void update_cpu_load ();
529 Gtk::Label buffer_load_label;
530 Gtk::EventBox buffer_load_box;
531 void update_buffer_load ();
533 Gtk::Label sample_rate_label;
534 Gtk::EventBox sample_rate_box;
535 void update_sample_rate (nframes_t);
537 gint every_second ();
538 gint every_point_one_seconds ();
539 gint every_point_zero_one_seconds ();
541 sigc::connection second_connection;
542 sigc::connection point_one_second_connection;
543 sigc::connection point_oh_five_second_connection;
544 sigc::connection point_zero_one_second_connection;
546 gint session_menu (GdkEventButton *);
548 bool _will_create_new_session_automatically;
550 NewSessionDialog* new_session_dialog;
552 void open_session ();
553 void open_recent_session ();
554 void save_template ();
556 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
558 void set_transport_sensitivity (bool);
560 void remove_last_capture ();
562 void transport_goto_zero ();
563 void transport_goto_start ();
564 void transport_goto_end ();
565 void transport_stop ();
566 void transport_stop_and_forget_capture ();
567 void transport_record ();
568 void transport_roll ();
569 void transport_play_selection();
570 void transport_forward (int option);
571 void transport_rewind (int option);
572 void transport_loop ();
574 void transport_rolling ();
575 void transport_rewinding ();
576 void transport_forwarding ();
577 void transport_stopped ();
579 bool _session_is_new;
580 void connect_to_session (ARDOUR::Session *);
581 void connect_dependents_to_session (ARDOUR::Session *);
582 void we_have_dependents ();
584 std::string keybindings_path;
585 std::string user_keybindings_path;
587 void setup_keybindings ();
588 void setup_session_options ();
590 guint32 last_key_press_time;
592 void snapshot_session ();
597 PublicEditor *editor;
598 int create_editor ();
600 RouteParams_UI *route_params;
601 int create_route_params ();
603 ConnectionEditor *connection_editor;
604 int create_connection_editor ();
606 LocationUI *location_ui;
607 int create_location_ui ();
608 void handle_locations_change (ARDOUR::Location*);
610 static UIConfiguration *ui_config;
611 ThemeManager *theme_manager;
615 OptionEditor *option_editor;
619 AddRouteDialog *add_route_dialog;
621 /* Keyboard Handling */
625 /* Keymap handling */
627 void install_actions ();
629 void toggle_record_enable (uint32_t);
631 uint32_t rec_enabled_streams;
632 void count_recenabled_streams (ARDOUR::Route&);
638 Gtk::MenuItem *cleanup_item;
640 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
644 bool have_configure_timeout;
645 struct timeval last_configure_time;
646 gint configure_timeout ();
648 struct timeval last_peak_grab;
649 struct timeval last_shuttle_request;
651 bool have_disk_speed_dialog_displayed;
652 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
653 void disk_overrun_handler ();
654 void disk_underrun_handler ();
656 int pending_state_dialog ();
658 void disconnect_from_jack ();
659 void reconnect_to_jack ();
660 void set_jack_buffer_size (nframes_t);
662 Gtk::MenuItem* jack_disconnect_item;
663 Gtk::MenuItem* jack_reconnect_item;
664 Gtk::Menu* jack_bufsize_menu;
666 int make_session_clean ();
667 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
669 Glib::RefPtr<Gtk::ActionGroup> common_actions;
671 void editor_realized ();
673 std::vector<std::string> positional_sync_strings;
675 void toggle_send_midi_feedback ();
676 void toggle_use_mmc ();
677 void toggle_send_mmc ();
678 void toggle_send_mtc ();
680 void toggle_use_osc ();
682 void toggle_denormal_protection ();
684 void set_input_auto_connect (ARDOUR::AutoConnectOption);
685 void set_output_auto_connect (ARDOUR::AutoConnectOption);
686 void set_solo_model (ARDOUR::SoloModel);
687 void set_monitor_model (ARDOUR::MonitorModel);
688 void set_remote_model (ARDOUR::RemoteModel);
689 void set_denormal_model (ARDOUR::DenormalModel);
691 void toggle_sync_order_keys ();
692 void toggle_StopPluginsWithTransport();
693 void toggle_DoNotRunPluginsWhileRecording();
694 void toggle_VerifyRemoveLastCapture();
695 void toggle_PeriodicSafetyBackups();
696 void toggle_StopRecordingOnXrun();
697 void toggle_StopTransportAtEndOfSession();
698 void toggle_GainReduceFastTransport();
699 void toggle_LatchedSolo();
700 void toggle_ShowSoloMutes();
701 void toggle_LatchedRecordEnable ();
702 void toggle_RegionEquivalentsOverlap ();
703 void toggle_PrimaryClockDeltaEditCursor ();
704 void toggle_SecondaryClockDeltaEditCursor ();
705 void toggle_only_copy_imported_files ();
707 void mtc_port_changed ();
708 void map_solo_model ();
709 void map_monitor_model ();
710 void map_denormal_model ();
711 void map_denormal_protection ();
712 void map_remote_model ();
713 void map_file_header_format ();
714 void map_file_data_format ();
715 void map_input_auto_connect ();
716 void map_output_auto_connect ();
717 void map_only_copy_imported_files ();
718 void parameter_changed (const char*);
720 void set_meter_hold (ARDOUR::MeterHold);
721 void set_meter_falloff (ARDOUR::MeterFalloff);
722 void map_meter_hold ();
723 void map_meter_falloff ();
725 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
726 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
728 bool can_save_keybindings;
731 void no_memory_warning ();
732 void check_memory_locking ();
734 void audioengine_setup ();
736 void display_message (const char *prefix, gint prefix_len,
737 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
738 Gtk::Label status_bar_label;
739 Gtk::ToggleButton error_log_button;
740 Gtk::MessageDialog* loading_dialog;
742 void platform_specific ();
745 #endif /* __ardour_gui_h__ */