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 <pbd/controllable.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/textbuffer.h>
55 #include <gtkmm/adjustment.h>
56 #include <gtkmm2ext/gtk_ui.h>
57 #include <gtkmm2ext/click_box.h>
58 #include <gtkmm2ext/stateful_button.h>
59 #include <gtkmm2ext/bindable_button.h>
60 #include <ardour/ardour.h>
61 #include <ardour/session.h>
62 #include <ardour/configuration.h>
63 #include <ardour/types.h>
65 #include "audio_clock.h"
66 #include "ardour_dialog.h"
68 #include "ui_config.h"
76 class ConnectionEditor;
81 class NewSessionDialog;
95 class ControlProtocolInfo;
99 class MultiChannelDevice;
102 #define FRAME_NAME "BaseFrame"
104 extern sigc::signal<void> ColorsChanged;
105 extern sigc::signal<void> DPIReset;
107 class ARDOUR_UI : public Gtkmm2ext::UI
110 ARDOUR_UI (int *argcp, char **argvp[]);
114 bool shown() { return shown_flag; }
122 void idle_load (const Glib::ustring& path);
125 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
127 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
129 uint32_t master_chns,
130 ARDOUR::AutoConnectOption input_connect,
131 ARDOUR::AutoConnectOption output_connect,
134 nframes_t initial_length);
135 bool session_is_new() const { return _session_is_new; }
137 ARDOUR::Session* the_session() { return session; }
139 bool will_create_new_session_automatically() const {
140 return _will_create_new_session_automatically;
143 void set_will_create_new_session_automatically (bool yn) {
144 _will_create_new_session_automatically = yn;
147 bool get_session_parameters (bool have_engine = false, bool should_be_new = false, bool offer_quit = false);
148 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
149 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
150 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
151 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
153 /// @return true if session was successfully unloaded.
154 int unload_session (bool hide_stuff = false);
155 void close_session();
157 int save_state_canfail (string state_name = "");
158 void save_state (const string & state_name = "");
160 static double gain_to_slider_position (ARDOUR::gain_t g);
161 static ARDOUR::gain_t slider_position_to_gain (double pos);
163 static ARDOUR_UI *instance () { return theArdourUI; }
164 static UIConfiguration *config () { return ui_config; }
166 PublicEditor& the_editor(){return *editor;}
167 Mixer_UI* the_mixer() { return mixer; }
169 ARDOUR::AudioEngine& the_engine() const { return *engine; }
171 void toggle_key_editor ();
172 void toggle_location_window ();
173 void toggle_theme_manager ();
174 void toggle_bundle_manager ();
175 void toggle_big_clock_window ();
176 void toggle_route_params_window ();
177 void toggle_editing_space();
179 Gtk::Tooltips& tooltips() { return _tooltips; }
181 static sigc::signal<void,bool> Blink;
182 static sigc::signal<void> RapidScreenUpdate;
183 static sigc::signal<void> SuperRapidScreenUpdate;
184 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
186 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
188 XMLNode* editor_settings() const;
189 XMLNode* mixer_settings () const;
190 XMLNode* keyboard_settings () const;
192 void save_ardour_state ();
193 gboolean configure_handler (GdkEventConfigure* conf);
195 void do_transport_locate (nframes_t position);
196 void halt_on_xrun_message ();
197 void xrun_handler (nframes_t);
198 void create_xrun_marker (nframes_t);
200 AudioClock primary_clock;
201 AudioClock secondary_clock;
202 AudioClock preroll_clock;
203 AudioClock postroll_clock;
205 void store_clock_modes ();
206 void restore_clock_modes ();
208 void add_route (Gtk::Window* float_window);
210 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
211 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
214 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
215 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
218 void session_add_midi_track (uint32_t how_many) {
219 session_add_midi_route (true, how_many);
222 /*void session_add_midi_bus () {
223 session_add_midi_route (false);
226 int create_engine ();
229 gint exit_on_main_window_close (GdkEventAny *);
231 void maximise_editing_space ();
232 void restore_editing_space ();
234 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
235 void set_native_file_data_format (ARDOUR::SampleFormat sf);
237 void setup_profile ();
240 void set_shuttle_fract (double);
243 friend class PublicEditor;
245 void toggle_clocking ();
246 void toggle_auto_play ();
247 void toggle_auto_input ();
248 void toggle_punch ();
249 void unset_dual_punch ();
250 bool ignore_dual_punch;
251 void toggle_punch_in ();
252 void toggle_punch_out ();
253 void toggle_auto_return ();
254 void toggle_click ();
256 void toggle_session_auto_loop ();
258 void toggle_options_window ();
261 struct GlobalClickBox : public Gtk::VBox {
262 Gtkmm2ext::ClickBox *box;
265 vector<string> &strings;
266 Gtk::Adjustment adjustment;
268 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
270 GlobalClickBox (const string &str, vector<string> &vs)
272 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
273 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
274 label.set_text (str);
275 label.set_name ("GlobalButtonLabel");
277 frame.set_shadow_type (Gtk::SHADOW_IN);
280 box->set_print_func (printer, this);
281 box->set_wrap (true);
285 ARDOUR::AudioEngine *engine;
286 ARDOUR::Session *session;
288 Gtk::Tooltips _tooltips;
290 void goto_editor_window ();
291 void goto_mixer_window ();
292 void toggle_editor_mixer_on_top ();
295 Gtk::Table adjuster_table;
296 Gtk::Frame adjuster_frame;
297 Gtk::Fixed adjuster_base;
299 GlobalClickBox *online_control_button;
300 vector<string> online_control_strings;
302 GlobalClickBox *crossfade_time_button;
303 vector<string> crossfade_time_strings;
305 Gtk::ToggleButton preroll_button;
306 Gtk::ToggleButton postroll_button;
308 int setup_windows ();
309 void setup_transport ();
312 static ARDOUR_UI *theArdourUI;
314 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
318 int ask_about_saving_session (const string & why);
320 /* periodic safety backup, to be precise */
321 gint autosave_session();
322 void update_autosave();
323 sigc::connection _autosave_connection;
325 void queue_transport_change ();
326 void map_transport_state ();
327 int32_t do_engine_start ();
329 void engine_halted ();
330 void engine_stopped ();
331 void engine_running ();
335 static gint _blink (void *);
337 gint blink_timeout_tag;
339 void start_blinking ();
340 void stop_blinking ();
342 void about_signal_response(int response);
345 Gtk::VBox top_packer;
347 sigc::connection clock_signal_connection;
348 void update_clocks ();
349 void start_clocking ();
350 void stop_clocking ();
352 void manage_window (Gtk::Window&);
354 AudioClock big_clock;
355 Gtk::Window* big_clock_window;
357 void float_big_clock (Gtk::Window* parent);
358 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
360 void update_transport_clocks (nframes_t pos);
361 void record_state_changed ();
363 /* Transport Control */
365 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
366 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
368 Gtkmm2ext::TearOff* transport_tearoff;
369 Gtk::Frame transport_frame;
370 Gtk::HBox transport_tearoff_hbox;
371 Gtk::HBox transport_hbox;
372 Gtk::Fixed transport_base;
373 Gtk::Fixed transport_button_base;
374 Gtk::Frame transport_button_frame;
375 Gtk::HBox transport_button_hbox;
376 Gtk::VBox transport_button_vbox;
377 Gtk::HBox transport_option_button_hbox;
378 Gtk::VBox transport_option_button_vbox;
379 Gtk::HBox transport_clock_hbox;
380 Gtk::VBox transport_clock_vbox;
381 Gtk::HBox primary_clock_hbox;
382 Gtk::HBox secondary_clock_hbox;
385 struct TransportControllable : public PBD::Controllable {
398 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
399 void set_value (float);
400 float get_value (void) const;
402 void set_id (const std::string&);
408 boost::shared_ptr<TransportControllable> roll_controllable;
409 boost::shared_ptr<TransportControllable> stop_controllable;
410 boost::shared_ptr<TransportControllable> goto_start_controllable;
411 boost::shared_ptr<TransportControllable> goto_end_controllable;
412 boost::shared_ptr<TransportControllable> auto_loop_controllable;
413 boost::shared_ptr<TransportControllable> play_selection_controllable;
414 boost::shared_ptr<TransportControllable> rec_controllable;
415 boost::shared_ptr<TransportControllable> shuttle_controllable;
416 BindingProxy shuttle_controller_binding_proxy;
418 void set_transport_controllable_state (const XMLNode&);
419 XMLNode& get_transport_controllable_state ();
421 BindableButton roll_button;
422 BindableButton stop_button;
423 BindableButton goto_start_button;
424 BindableButton goto_end_button;
425 BindableButton auto_loop_button;
426 BindableButton play_selection_button;
427 BindableButton rec_button;
429 Gtk::ComboBoxText sync_option_combo;
431 void sync_option_changed ();
432 void toggle_time_master ();
433 void toggle_video_sync ();
435 Gtk::DrawingArea shuttle_box;
436 Gtk::EventBox speed_display_box;
437 Gtk::Label speed_display_label;
438 Gtk::Button shuttle_units_button;
439 Gtk::ComboBoxText shuttle_style_button;
440 Gtk::Menu* shuttle_unit_menu;
441 Gtk::Menu* shuttle_style_menu;
442 float shuttle_max_speed;
443 Gtk::Menu* shuttle_context_menu;
445 void build_shuttle_context_menu ();
446 void show_shuttle_context_menu ();
447 void shuttle_style_changed();
448 void shuttle_unit_clicked ();
449 void set_shuttle_max_speed (float);
450 void update_speed_display ();
451 float last_speed_displayed;
453 gint shuttle_box_button_press (GdkEventButton*);
454 gint shuttle_box_button_release (GdkEventButton*);
455 gint shuttle_box_scroll (GdkEventScroll*);
456 gint shuttle_box_motion (GdkEventMotion*);
457 gint shuttle_box_expose (GdkEventExpose*);
458 gint mouse_shuttle (double x, bool force);
459 void use_shuttle_fract (bool force);
461 bool shuttle_grabbed;
462 double shuttle_fract;
464 Gtkmm2ext::StatefulToggleButton punch_in_button;
465 Gtkmm2ext::StatefulToggleButton punch_out_button;
466 Gtkmm2ext::StatefulToggleButton auto_return_button;
467 Gtkmm2ext::StatefulToggleButton auto_play_button;
468 Gtkmm2ext::StatefulToggleButton auto_input_button;
469 Gtkmm2ext::StatefulToggleButton click_button;
470 Gtkmm2ext::StatefulToggleButton time_master_button;
472 Gtk::ToggleButton auditioning_alert_button;
473 Gtk::ToggleButton solo_alert_button;
477 void solo_blink (bool);
478 void audition_blink (bool);
480 void soloing_changed (bool);
481 void auditioning_changed (bool);
482 void _auditioning_changed (bool);
484 void solo_alert_toggle ();
485 void audition_alert_toggle ();
487 void big_clock_value_changed ();
488 void primary_clock_value_changed ();
489 void secondary_clock_value_changed ();
491 /* called by Blink signal */
493 void transport_rec_enable_blink (bool onoff);
495 Gtk::Menu* session_popup_menu;
497 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
498 RecentSessionModelColumns() {
502 Gtk::TreeModelColumn<Glib::ustring> visible_name;
503 Gtk::TreeModelColumn<Glib::ustring> fullpath;
506 RecentSessionModelColumns recent_session_columns;
507 Gtk::TreeView recent_session_display;
508 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
510 ArdourDialog* session_selector_window;
511 Gtk::FileChooserDialog* open_session_selector;
513 void build_session_selector();
514 void redisplay_recent_sessions();
515 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
517 struct RecentSessionsSorter {
518 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
519 return cmp_nocase(a.first, b.first) == -1;
523 /* menu bar and associated stuff */
525 Gtk::MenuBar* menu_bar;
526 Gtk::EventBox menu_bar_base;
529 void use_menubar_as_top_menubar ();
530 void build_menu_bar ();
531 void build_control_surface_menu ();
533 Gtk::Label wall_clock_label;
534 Gtk::EventBox wall_clock_box;
535 gint update_wall_clock ();
537 Gtk::Label disk_space_label;
538 Gtk::EventBox disk_space_box;
539 void update_disk_space ();
541 Gtk::Label cpu_load_label;
542 Gtk::EventBox cpu_load_box;
543 void update_cpu_load ();
545 Gtk::Label buffer_load_label;
546 Gtk::EventBox buffer_load_box;
547 void update_buffer_load ();
549 Gtk::Label sample_rate_label;
550 Gtk::EventBox sample_rate_box;
551 void update_sample_rate (nframes_t);
553 gint every_second ();
554 gint every_point_one_seconds ();
555 gint every_point_zero_one_seconds ();
557 sigc::connection second_connection;
558 sigc::connection point_one_second_connection;
559 sigc::connection point_oh_five_second_connection;
560 sigc::connection point_zero_one_second_connection;
562 gint session_menu (GdkEventButton *);
564 bool _will_create_new_session_automatically;
566 NewSessionDialog* new_session_dialog;
568 void open_session ();
569 void open_recent_session ();
570 void save_template ();
572 void edit_metadata ();
573 void import_metadata ();
575 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
576 void session_add_midi_route (bool disk, uint32_t how_many);
578 void set_transport_sensitivity (bool);
580 void remove_last_capture ();
582 void transport_goto_zero ();
583 void transport_goto_start ();
584 void transport_goto_end ();
585 void transport_goto_wallclock ();
586 void transport_stop ();
587 void transport_stop_and_forget_capture ();
588 void transport_record (bool roll);
589 void transport_roll ();
590 void transport_play_selection();
591 void transport_forward (int option);
592 void transport_rewind (int option);
593 void transport_loop ();
595 void transport_rolling ();
596 void transport_rewinding ();
597 void transport_forwarding ();
598 void transport_stopped ();
600 bool _session_is_new;
601 void connect_to_session (ARDOUR::Session *);
602 void connect_dependents_to_session (ARDOUR::Session *);
603 void we_have_dependents ();
605 void setup_session_options ();
607 guint32 last_key_press_time;
609 void snapshot_session ();
614 PublicEditor *editor;
615 int create_editor ();
617 RouteParams_UI *route_params;
618 int create_route_params ();
620 BundleManager *bundle_manager;
621 void create_bundle_manager ();
623 LocationUI *location_ui;
624 int create_location_ui ();
625 void handle_locations_change (ARDOUR::Location*);
627 static UIConfiguration *ui_config;
628 ThemeManager *theme_manager;
630 /* Key bindings editor */
632 KeyEditor *key_editor;
636 OptionEditor *option_editor;
640 AddRouteDialog *add_route_dialog;
642 /* Keyboard Handling */
646 /* Keymap handling */
648 void install_actions ();
650 void toggle_record_enable (uint32_t);
652 uint32_t rec_enabled_streams;
653 void count_recenabled_streams (ARDOUR::Route&);
657 void pop_back_splash ();
662 Gtk::MenuItem *cleanup_item;
664 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
668 bool have_configure_timeout;
669 ARDOUR::microseconds_t last_configure_time;
670 gint configure_timeout ();
672 ARDOUR::microseconds_t last_peak_grab;
673 ARDOUR::microseconds_t last_shuttle_request;
675 bool have_disk_speed_dialog_displayed;
676 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
677 void disk_overrun_handler ();
678 void disk_underrun_handler ();
680 void session_dialog (std::string);
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 Glib::RefPtr<Gtk::ActionGroup> common_actions;
694 void editor_realized ();
696 std::vector<std::string> positional_sync_strings;
698 void toggle_send_midi_feedback ();
699 void toggle_use_mmc ();
700 void toggle_send_mmc ();
701 void toggle_send_mtc ();
702 void toggle_send_midi_clock ();
704 void toggle_use_osc ();
706 void toggle_denormal_protection ();
708 void set_input_auto_connect (ARDOUR::AutoConnectOption);
709 void set_output_auto_connect (ARDOUR::AutoConnectOption);
710 void set_solo_model (ARDOUR::SoloModel);
711 void set_monitor_model (ARDOUR::MonitorModel);
712 void set_remote_model (ARDOUR::RemoteModel);
713 void set_denormal_model (ARDOUR::DenormalModel);
715 void toggle_sync_order_keys ();
716 void toggle_new_plugins_active();
717 void toggle_StopPluginsWithTransport();
718 void toggle_DoNotRunPluginsWhileRecording();
719 void toggle_VerifyRemoveLastCapture();
720 void toggle_PeriodicSafetyBackups();
721 void toggle_StopRecordingOnXrun();
722 void toggle_CreateXrunMarker();
723 void toggle_StopTransportAtEndOfSession();
724 void toggle_GainReduceFastTransport();
725 void toggle_LatchedSolo();
726 void toggle_ShowSoloMutes();
727 void toggle_SoloMuteOverride();
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();
735 void toggle_NameNewMarkers ();
736 void toggle_rubberbanding_snaps_to_grid ();
737 void toggle_auto_analyse_audio ();
738 void toggle_TapeMachineMode();
740 void mtc_port_changed ();
741 void map_solo_model ();
742 void map_monitor_model ();
743 void map_denormal_model ();
744 void map_denormal_protection ();
745 void map_remote_model ();
746 void map_file_header_format ();
747 void map_file_data_format ();
748 void map_input_auto_connect ();
749 void map_output_auto_connect ();
750 void map_only_copy_imported_files ();
751 void parameter_changed (const char*);
753 void set_meter_hold (ARDOUR::MeterHold);
754 void set_meter_falloff (ARDOUR::MeterFalloff);
755 void map_meter_hold ();
756 void map_meter_falloff ();
758 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
759 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
763 void no_memory_warning ();
764 void check_memory_locking ();
766 bool check_audioengine();
767 void audioengine_setup ();
769 void display_message (const char *prefix, gint prefix_len,
770 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
771 Gtk::Label status_bar_label;
772 Gtk::ToggleButton error_log_button;
774 void loading_message (const std::string& msg);
775 void end_loading_messages ();
777 void platform_specific ();
778 void platform_setup ();
779 void fontconfig_dialog ();
782 #endif /* __ardour_gui_h__ */