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>
61 #include <ardour/configuration.h>
63 #include "audio_clock.h"
64 #include "ardour_dialog.h"
66 #include "ui_config.h"
74 class ConnectionEditor;
79 class NewSessionDialog;
93 class ControlProtocolInfo;
97 class MultiChannelDevice;
100 #define FRAME_NAME "BaseFrame"
102 extern sigc::signal<void> ColorsChanged;
104 class ARDOUR_UI : public Gtkmm2ext::UI
107 ARDOUR_UI (int *argcp, char **argvp[]);
111 bool shown() { return shown_flag; }
119 int load_session (const Glib::ustring & path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
121 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
123 uint32_t master_chns,
124 ARDOUR::AutoConnectOption input_connect,
125 ARDOUR::AutoConnectOption output_connect,
128 nframes_t initial_length);
129 bool session_is_new() const { return _session_is_new; }
131 ARDOUR::Session* the_session() { return session; }
133 bool will_create_new_session_automatically() const {
134 return _will_create_new_session_automatically;
137 void set_will_create_new_session_automatically (bool yn) {
138 _will_create_new_session_automatically = yn;
141 bool get_session_parameters (bool have_engine = false, bool should_be_new = false);
142 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
143 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
144 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
145 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
147 /// @return true if session was successfully unloaded.
148 int unload_session (bool hide_stuff = false);
149 void close_session();
151 int save_state_canfail (string state_name = "");
152 void save_state (const string & state_name = "");
153 void restore_state (string state_name = "");
155 static double gain_to_slider_position (ARDOUR::gain_t g);
156 static ARDOUR::gain_t slider_position_to_gain (double pos);
158 static ARDOUR_UI *instance () { return theArdourUI; }
159 static UIConfiguration *config () { return ui_config; }
161 PublicEditor& the_editor(){return *editor;}
162 Mixer_UI* the_mixer() { return mixer; }
164 ARDOUR::AudioEngine& the_engine() const { return *engine; }
166 void toggle_key_editor ();
167 void toggle_location_window ();
168 void toggle_theme_manager ();
169 void toggle_bundle_manager ();
170 void toggle_big_clock_window ();
171 void toggle_connection_editor ();
172 void toggle_route_params_window ();
173 void toggle_editing_space();
175 Gtk::Tooltips& tooltips() { return _tooltips; }
177 static sigc::signal<void,bool> Blink;
178 static sigc::signal<void> RapidScreenUpdate;
179 static sigc::signal<void> SuperRapidScreenUpdate;
180 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
182 /* this is a helper function to centralize the (complex) logic for
183 blinking rec-enable buttons.
186 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
188 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
190 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
192 XMLNode* editor_settings() const;
193 XMLNode* mixer_settings () const;
194 XMLNode* keyboard_settings () const;
196 void save_ardour_state ();
197 gboolean configure_handler (GdkEventConfigure* conf);
199 void do_transport_locate (nframes_t position);
200 void halt_on_xrun_message ();
201 void xrun_handler (nframes_t);
202 void create_xrun_marker (nframes_t);
204 AudioClock primary_clock;
205 AudioClock secondary_clock;
206 AudioClock preroll_clock;
207 AudioClock postroll_clock;
209 void store_clock_modes ();
210 void restore_clock_modes ();
212 void add_route (Gtk::Window* float_window);
214 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
215 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
218 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
219 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
222 void session_add_midi_track (uint32_t how_many) {
223 session_add_midi_route (true, how_many);
226 /*void session_add_midi_bus () {
227 session_add_midi_route (false);
230 int create_engine ();
233 gint exit_on_main_window_close (GdkEventAny *);
235 void maximise_editing_space ();
236 void restore_editing_space ();
238 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
239 void set_native_file_data_format (ARDOUR::SampleFormat sf);
241 void setup_profile ();
244 void set_shuttle_fract (double);
247 friend class PublicEditor;
249 void toggle_clocking ();
250 void toggle_auto_play ();
251 void toggle_auto_input ();
252 void toggle_punch_in ();
253 void toggle_punch_out ();
254 void toggle_auto_return ();
255 void toggle_click ();
257 void toggle_session_auto_loop ();
259 void toggle_options_window ();
262 struct GlobalClickBox : public Gtk::VBox {
263 Gtkmm2ext::ClickBox *box;
266 vector<string> &strings;
267 Gtk::Adjustment adjustment;
269 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
271 GlobalClickBox (const string &str, vector<string> &vs)
273 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
274 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
275 label.set_text (str);
276 label.set_name ("GlobalButtonLabel");
278 frame.set_shadow_type (Gtk::SHADOW_IN);
281 box->set_print_func (printer, this);
282 box->set_wrap (true);
286 ARDOUR::AudioEngine *engine;
287 ARDOUR::Session *session;
289 Gtk::Tooltips _tooltips;
291 void goto_editor_window ();
292 void goto_mixer_window ();
294 Gtk::Table adjuster_table;
295 Gtk::Frame adjuster_frame;
296 Gtk::Fixed adjuster_base;
298 GlobalClickBox *online_control_button;
299 vector<string> online_control_strings;
301 GlobalClickBox *crossfade_time_button;
302 vector<string> crossfade_time_strings;
304 Gtk::ToggleButton preroll_button;
305 Gtk::ToggleButton postroll_button;
307 Gtk::Table transport_table;
308 Gtk::Table option_table;
310 int setup_windows ();
311 void setup_transport ();
314 static ARDOUR_UI *theArdourUI;
316 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
321 int ask_about_saving_session (const string & why);
322 int save_the_session;
324 /* periodic safety backup, to be precise */
325 gint autosave_session();
326 void update_autosave();
327 sigc::connection _autosave_connection;
329 void queue_transport_change ();
330 void map_transport_state ();
331 int32_t do_engine_start ();
333 void engine_halted ();
334 void engine_stopped ();
335 void engine_running ();
339 static gint _blink (void *);
341 gint blink_timeout_tag;
343 void start_blinking ();
344 void stop_blinking ();
346 void about_signal_response(int response);
349 Gtk::VBox top_packer;
351 sigc::connection clock_signal_connection;
352 void update_clocks ();
353 void start_clocking ();
354 void stop_clocking ();
356 void manage_window (Gtk::Window&);
358 AudioClock big_clock;
359 Gtk::Frame big_clock_frame;
360 Gtk::Window* big_clock_window;
362 void update_transport_clocks (nframes_t pos);
363 void record_state_changed ();
365 /* Transport Control */
367 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
368 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
370 Gtkmm2ext::TearOff* transport_tearoff;
371 Gtk::Frame transport_frame;
372 Gtk::HBox transport_tearoff_hbox;
373 Gtk::HBox transport_hbox;
374 Gtk::Fixed transport_base;
375 Gtk::Fixed transport_button_base;
376 Gtk::Frame transport_button_frame;
377 Gtk::HBox transport_button_hbox;
378 Gtk::VBox transport_button_vbox;
379 Gtk::HBox transport_option_button_hbox;
380 Gtk::VBox transport_option_button_vbox;
381 Gtk::HBox transport_clock_hbox;
382 Gtk::VBox transport_clock_vbox;
383 Gtk::HBox primary_clock_hbox;
384 Gtk::HBox secondary_clock_hbox;
387 struct TransportControllable : public PBD::Controllable {
400 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
401 void set_value (float);
402 float get_value (void) const;
404 void set_id (const std::string&);
410 TransportControllable roll_controllable;
411 TransportControllable stop_controllable;
412 TransportControllable goto_start_controllable;
413 TransportControllable goto_end_controllable;
414 TransportControllable auto_loop_controllable;
415 TransportControllable play_selection_controllable;
416 TransportControllable rec_controllable;
417 TransportControllable shuttle_controllable;
418 BindingProxy shuttle_controller_binding_proxy;
420 void set_transport_controllable_state (const XMLNode&);
421 XMLNode& get_transport_controllable_state ();
423 BindableButton roll_button;
424 BindableButton stop_button;
425 BindableButton goto_start_button;
426 BindableButton goto_end_button;
427 BindableButton auto_loop_button;
428 BindableButton play_selection_button;
429 BindableButton rec_button;
431 Gtk::ComboBoxText sync_option_combo;
433 void sync_option_changed ();
434 void toggle_time_master ();
435 void toggle_video_sync ();
437 Gtk::DrawingArea shuttle_box;
438 Gtk::EventBox speed_display_box;
439 Gtk::Label speed_display_label;
440 Gtk::Button shuttle_units_button;
441 Gtk::ComboBoxText shuttle_style_button;
442 Gtk::Menu* shuttle_unit_menu;
443 Gtk::Menu* shuttle_style_menu;
444 float shuttle_max_speed;
445 Gtk::Menu* shuttle_context_menu;
447 void build_shuttle_context_menu ();
448 void show_shuttle_context_menu ();
449 void shuttle_style_changed();
450 void shuttle_unit_clicked ();
451 void set_shuttle_max_speed (float);
452 void update_speed_display ();
453 float last_speed_displayed;
455 gint shuttle_box_button_press (GdkEventButton*);
456 gint shuttle_box_button_release (GdkEventButton*);
457 gint shuttle_box_scroll (GdkEventScroll*);
458 gint shuttle_box_motion (GdkEventMotion*);
459 gint shuttle_box_expose (GdkEventExpose*);
460 gint mouse_shuttle (double x, bool force);
461 void use_shuttle_fract (bool force);
463 bool shuttle_grabbed;
464 double shuttle_fract;
466 Gtkmm2ext::StatefulToggleButton punch_in_button;
467 Gtkmm2ext::StatefulToggleButton punch_out_button;
468 Gtkmm2ext::StatefulToggleButton auto_return_button;
469 Gtkmm2ext::StatefulToggleButton auto_play_button;
470 Gtkmm2ext::StatefulToggleButton auto_input_button;
471 Gtkmm2ext::StatefulToggleButton click_button;
472 Gtkmm2ext::StatefulToggleButton time_master_button;
474 Gtk::ToggleButton auditioning_alert_button;
475 Gtk::ToggleButton solo_alert_button;
479 void solo_blink (bool);
480 void audition_blink (bool);
482 void soloing_changed (bool);
483 void auditioning_changed (bool);
484 void _auditioning_changed (bool);
486 void solo_alert_toggle ();
487 void audition_alert_toggle ();
489 void big_clock_value_changed ();
490 void primary_clock_value_changed ();
491 void secondary_clock_value_changed ();
493 /* called by Blink signal */
495 void transport_rec_enable_blink (bool onoff);
497 Gtk::Menu* session_popup_menu;
499 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
500 RecentSessionModelColumns() {
504 Gtk::TreeModelColumn<Glib::ustring> visible_name;
505 Gtk::TreeModelColumn<Glib::ustring> fullpath;
508 RecentSessionModelColumns recent_session_columns;
509 Gtk::TreeView recent_session_display;
510 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
512 ArdourDialog* session_selector_window;
513 Gtk::FileChooserDialog* open_session_selector;
515 void build_session_selector();
516 void redisplay_recent_sessions();
517 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
519 struct RecentSessionsSorter {
520 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
521 return cmp_nocase(a.first, b.first) == -1;
525 /* menu bar and associated stuff */
527 Gtk::MenuBar* menu_bar;
528 Gtk::EventBox menu_bar_base;
531 void use_menubar_as_top_menubar ();
532 void build_menu_bar ();
533 void build_control_surface_menu ();
535 Gtk::Label wall_clock_label;
536 Gtk::EventBox wall_clock_box;
537 gint update_wall_clock ();
539 Gtk::Label disk_space_label;
540 Gtk::EventBox disk_space_box;
541 void update_disk_space ();
543 Gtk::Label cpu_load_label;
544 Gtk::EventBox cpu_load_box;
545 void update_cpu_load ();
547 Gtk::Label buffer_load_label;
548 Gtk::EventBox buffer_load_box;
549 void update_buffer_load ();
551 Gtk::Label sample_rate_label;
552 Gtk::EventBox sample_rate_box;
553 void update_sample_rate (nframes_t);
555 gint every_second ();
556 gint every_point_one_seconds ();
557 gint every_point_zero_one_seconds ();
559 sigc::connection second_connection;
560 sigc::connection point_one_second_connection;
561 sigc::connection point_oh_five_second_connection;
562 sigc::connection point_zero_one_second_connection;
564 gint session_menu (GdkEventButton *);
566 bool _will_create_new_session_automatically;
568 NewSessionDialog* new_session_dialog;
570 void open_session ();
571 void open_recent_session ();
572 void save_template ();
574 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
575 void session_add_midi_route (bool disk, uint32_t how_many);
577 void set_transport_sensitivity (bool);
579 void remove_last_capture ();
581 void transport_goto_zero ();
582 void transport_goto_start ();
583 void transport_goto_end ();
584 void transport_stop ();
585 void transport_stop_and_forget_capture ();
586 void transport_record (bool roll);
587 void transport_roll ();
588 void transport_play_selection();
589 void transport_forward (int option);
590 void transport_rewind (int option);
591 void transport_loop ();
593 void transport_rolling ();
594 void transport_rewinding ();
595 void transport_forwarding ();
596 void transport_stopped ();
598 bool _session_is_new;
599 void connect_to_session (ARDOUR::Session *);
600 void connect_dependents_to_session (ARDOUR::Session *);
601 void we_have_dependents ();
603 void setup_session_options ();
605 guint32 last_key_press_time;
607 void snapshot_session ();
612 PublicEditor *editor;
613 int create_editor ();
615 RouteParams_UI *route_params;
616 int create_route_params ();
618 BundleManager *bundle_manager;
619 void create_bundle_manager ();
621 ConnectionEditor *connection_editor;
622 int create_connection_editor ();
624 LocationUI *location_ui;
625 int create_location_ui ();
626 void handle_locations_change (ARDOUR::Location*);
628 static UIConfiguration *ui_config;
629 ThemeManager *theme_manager;
631 /* Key bindings editor */
633 KeyEditor *key_editor;
637 OptionEditor *option_editor;
641 AddRouteDialog *add_route_dialog;
643 /* Keyboard Handling */
647 /* Keymap handling */
649 void install_actions ();
651 void toggle_record_enable (uint32_t);
653 uint32_t rec_enabled_streams;
654 void count_recenabled_streams (ARDOUR::Route&);
658 void pop_back_splash ();
663 Gtk::MenuItem *cleanup_item;
665 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
669 bool have_configure_timeout;
670 struct timeval last_configure_time;
671 gint configure_timeout ();
673 struct timeval last_peak_grab;
674 struct timeval last_shuttle_request;
676 bool have_disk_speed_dialog_displayed;
677 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
678 void disk_overrun_handler ();
679 void disk_underrun_handler ();
681 int pending_state_dialog ();
682 int sr_mismatch_dialog (nframes_t, nframes_t);
684 void disconnect_from_jack ();
685 void reconnect_to_jack ();
686 void set_jack_buffer_size (nframes_t);
688 Gtk::MenuItem* jack_disconnect_item;
689 Gtk::MenuItem* jack_reconnect_item;
690 Gtk::Menu* jack_bufsize_menu;
692 int make_session_clean ();
693 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
695 Glib::RefPtr<Gtk::ActionGroup> common_actions;
697 void editor_realized ();
699 std::vector<std::string> positional_sync_strings;
701 void toggle_send_midi_feedback ();
702 void toggle_use_mmc ();
703 void toggle_send_mmc ();
704 void toggle_send_mtc ();
706 void toggle_use_osc ();
708 void toggle_denormal_protection ();
710 void set_input_auto_connect (ARDOUR::AutoConnectOption);
711 void set_output_auto_connect (ARDOUR::AutoConnectOption);
712 void set_solo_model (ARDOUR::SoloModel);
713 void set_monitor_model (ARDOUR::MonitorModel);
714 void set_remote_model (ARDOUR::RemoteModel);
715 void set_denormal_model (ARDOUR::DenormalModel);
717 void toggle_sync_order_keys ();
718 void toggle_StopPluginsWithTransport();
719 void toggle_DoNotRunPluginsWhileRecording();
720 void toggle_VerifyRemoveLastCapture();
721 void toggle_PeriodicSafetyBackups();
722 void toggle_StopRecordingOnXrun();
723 void toggle_CreateXrunMarker();
724 void toggle_StopTransportAtEndOfSession();
725 void toggle_GainReduceFastTransport();
726 void toggle_LatchedSolo();
727 void toggle_ShowSoloMutes();
728 void toggle_LatchedRecordEnable ();
729 void toggle_RegionEquivalentsOverlap ();
730 void toggle_PrimaryClockDeltaEditCursor ();
731 void toggle_SecondaryClockDeltaEditCursor ();
732 void toggle_ShowTrackMeters ();
733 void toggle_only_copy_imported_files ();
734 void toggle_use_narrow_ms();
736 void mtc_port_changed ();
737 void map_solo_model ();
738 void map_monitor_model ();
739 void map_denormal_model ();
740 void map_denormal_protection ();
741 void map_remote_model ();
742 void map_file_header_format ();
743 void map_file_data_format ();
744 void map_input_auto_connect ();
745 void map_output_auto_connect ();
746 void map_only_copy_imported_files ();
747 void parameter_changed (const char*);
749 void set_meter_hold (ARDOUR::MeterHold);
750 void set_meter_falloff (ARDOUR::MeterFalloff);
751 void map_meter_hold ();
752 void map_meter_falloff ();
754 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
755 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
759 void no_memory_warning ();
760 void check_memory_locking ();
762 bool check_audioengine();
763 void audioengine_setup ();
765 void display_message (const char *prefix, gint prefix_len,
766 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
767 Gtk::Label status_bar_label;
768 Gtk::ToggleButton error_log_button;
770 void loading_message (const std::string& msg);
771 void end_loading_messages ();
773 void platform_specific ();
774 void platform_setup ();
775 void fontconfig_dialog ();
778 #endif /* __ardour_gui_h__ */