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;
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[]);
113 void run_startup (bool should_be_new);
116 bool shown() { return shown_flag; }
126 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
128 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
130 uint32_t master_chns,
131 ARDOUR::AutoConnectOption input_connect,
132 ARDOUR::AutoConnectOption output_connect,
135 nframes_t initial_length);
136 bool session_is_new() const { return _session_is_new; }
138 ARDOUR::Session* the_session() { return session; }
140 bool will_create_new_session_automatically() const {
141 return _will_create_new_session_automatically;
144 void set_will_create_new_session_automatically (bool yn) {
145 _will_create_new_session_automatically = yn;
148 int get_session_parameters (bool should_be_new = false);
149 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
150 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
151 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
152 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
154 /// @return true if session was successfully unloaded.
155 int unload_session (bool hide_stuff = false);
156 void close_session();
158 int save_state_canfail (string state_name = "");
159 void save_state (const string & state_name = "");
161 static double gain_to_slider_position (ARDOUR::gain_t g);
162 static ARDOUR::gain_t slider_position_to_gain (double pos);
164 static ARDOUR_UI *instance () { return theArdourUI; }
165 static UIConfiguration *config () { return ui_config; }
167 PublicEditor& the_editor(){return *editor;}
168 Mixer_UI* the_mixer() { return mixer; }
170 ARDOUR::AudioEngine& the_engine() const { return *engine; }
172 void toggle_key_editor ();
173 void toggle_location_window ();
174 void toggle_theme_manager ();
175 void toggle_bundle_manager ();
176 void toggle_big_clock_window ();
177 void toggle_route_params_window ();
178 void toggle_editing_space();
180 Gtk::Tooltips& tooltips() { return _tooltips; }
182 static sigc::signal<void,bool> Blink;
183 static sigc::signal<void> RapidScreenUpdate;
184 static sigc::signal<void> SuperRapidScreenUpdate;
185 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
187 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
189 XMLNode* editor_settings() const;
190 XMLNode* mixer_settings () const;
191 XMLNode* keyboard_settings () const;
193 void save_ardour_state ();
194 gboolean configure_handler (GdkEventConfigure* conf);
196 void do_transport_locate (nframes_t position);
197 void halt_on_xrun_message ();
198 void xrun_handler (nframes_t);
199 void create_xrun_marker (nframes_t);
201 AudioClock primary_clock;
202 AudioClock secondary_clock;
203 AudioClock preroll_clock;
204 AudioClock postroll_clock;
206 void store_clock_modes ();
207 void restore_clock_modes ();
209 void add_route (Gtk::Window* float_window);
211 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
212 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
215 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
216 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
219 void session_add_midi_track (uint32_t how_many) {
220 session_add_midi_route (true, how_many);
223 /*void session_add_midi_bus () {
224 session_add_midi_route (false);
227 int create_engine ();
230 gint exit_on_main_window_close (GdkEventAny *);
232 void maximise_editing_space ();
233 void restore_editing_space ();
235 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
236 void set_native_file_data_format (ARDOUR::SampleFormat sf);
238 void setup_profile ();
241 void set_shuttle_fract (double);
244 friend class PublicEditor;
246 void toggle_clocking ();
247 void toggle_auto_play ();
248 void toggle_auto_input ();
249 void toggle_punch ();
250 void unset_dual_punch ();
251 bool ignore_dual_punch;
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 ArdourStartup* _startup;
263 ARDOUR::AudioEngine *engine;
264 ARDOUR::Session *session;
265 Gtk::Tooltips _tooltips;
267 void goto_editor_window ();
268 void goto_mixer_window ();
269 void toggle_editor_mixer_on_top ();
272 Gtk::ToggleButton preroll_button;
273 Gtk::ToggleButton postroll_button;
275 int setup_windows ();
276 void setup_transport ();
279 static ARDOUR_UI *theArdourUI;
281 void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
285 int ask_about_saving_session (const string & why);
287 /* periodic safety backup, to be precise */
288 gint autosave_session();
289 void update_autosave();
290 sigc::connection _autosave_connection;
292 void queue_transport_change ();
293 void map_transport_state ();
294 int32_t do_engine_start ();
296 void engine_halted ();
297 void engine_stopped ();
298 void engine_running ();
302 static gint _blink (void *);
304 gint blink_timeout_tag;
306 void start_blinking ();
307 void stop_blinking ();
309 void about_signal_response(int response);
312 Gtk::VBox top_packer;
314 sigc::connection clock_signal_connection;
315 void update_clocks ();
316 void start_clocking ();
317 void stop_clocking ();
319 void manage_window (Gtk::Window&);
321 AudioClock big_clock;
322 Gtk::Window* big_clock_window;
324 void float_big_clock (Gtk::Window* parent);
325 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
327 void update_transport_clocks (nframes_t pos);
328 void record_state_changed ();
330 /* Transport Control */
332 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
333 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
335 Gtkmm2ext::TearOff* transport_tearoff;
336 Gtk::Frame transport_frame;
337 Gtk::HBox transport_tearoff_hbox;
338 Gtk::HBox transport_hbox;
339 Gtk::Fixed transport_base;
340 Gtk::Fixed transport_button_base;
341 Gtk::Frame transport_button_frame;
342 Gtk::HBox transport_button_hbox;
343 Gtk::VBox transport_button_vbox;
344 Gtk::HBox transport_option_button_hbox;
345 Gtk::VBox transport_option_button_vbox;
346 Gtk::HBox transport_clock_hbox;
347 Gtk::VBox transport_clock_vbox;
348 Gtk::HBox primary_clock_hbox;
349 Gtk::HBox secondary_clock_hbox;
352 struct TransportControllable : public PBD::Controllable {
365 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
366 void set_value (float);
367 float get_value (void) const;
369 void set_id (const std::string&);
375 boost::shared_ptr<TransportControllable> roll_controllable;
376 boost::shared_ptr<TransportControllable> stop_controllable;
377 boost::shared_ptr<TransportControllable> goto_start_controllable;
378 boost::shared_ptr<TransportControllable> goto_end_controllable;
379 boost::shared_ptr<TransportControllable> auto_loop_controllable;
380 boost::shared_ptr<TransportControllable> play_selection_controllable;
381 boost::shared_ptr<TransportControllable> rec_controllable;
382 boost::shared_ptr<TransportControllable> shuttle_controllable;
383 BindingProxy shuttle_controller_binding_proxy;
385 void set_transport_controllable_state (const XMLNode&);
386 XMLNode& get_transport_controllable_state ();
388 BindableButton roll_button;
389 BindableButton stop_button;
390 BindableButton goto_start_button;
391 BindableButton goto_end_button;
392 BindableButton auto_loop_button;
393 BindableButton play_selection_button;
394 BindableButton rec_button;
396 Gtk::ComboBoxText sync_option_combo;
398 void sync_option_changed ();
399 void toggle_time_master ();
400 void toggle_video_sync ();
402 Gtk::DrawingArea shuttle_box;
403 Gtk::EventBox speed_display_box;
404 Gtk::Label speed_display_label;
405 Gtk::Button shuttle_units_button;
406 Gtk::ComboBoxText shuttle_style_button;
407 Gtk::Menu* shuttle_unit_menu;
408 Gtk::Menu* shuttle_style_menu;
409 float shuttle_max_speed;
410 Gtk::Menu* shuttle_context_menu;
412 void build_shuttle_context_menu ();
413 void show_shuttle_context_menu ();
414 void shuttle_style_changed();
415 void shuttle_unit_clicked ();
416 void set_shuttle_max_speed (float);
417 void update_speed_display ();
418 float last_speed_displayed;
420 gint shuttle_box_button_press (GdkEventButton*);
421 gint shuttle_box_button_release (GdkEventButton*);
422 gint shuttle_box_scroll (GdkEventScroll*);
423 gint shuttle_box_motion (GdkEventMotion*);
424 gint shuttle_box_expose (GdkEventExpose*);
425 gint mouse_shuttle (double x, bool force);
426 void use_shuttle_fract (bool force);
428 bool shuttle_grabbed;
429 double shuttle_fract;
431 Gtkmm2ext::StatefulToggleButton punch_in_button;
432 Gtkmm2ext::StatefulToggleButton punch_out_button;
433 Gtkmm2ext::StatefulToggleButton auto_return_button;
434 Gtkmm2ext::StatefulToggleButton auto_play_button;
435 Gtkmm2ext::StatefulToggleButton auto_input_button;
436 Gtkmm2ext::StatefulToggleButton click_button;
437 Gtkmm2ext::StatefulToggleButton time_master_button;
439 Gtk::ToggleButton auditioning_alert_button;
440 Gtk::ToggleButton solo_alert_button;
444 void solo_blink (bool);
445 void audition_blink (bool);
447 void soloing_changed (bool);
448 void auditioning_changed (bool);
449 void _auditioning_changed (bool);
451 void solo_alert_toggle ();
452 void audition_alert_toggle ();
454 void big_clock_value_changed ();
455 void primary_clock_value_changed ();
456 void secondary_clock_value_changed ();
458 /* called by Blink signal */
460 void transport_rec_enable_blink (bool onoff);
462 Gtk::Menu* session_popup_menu;
464 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
465 RecentSessionModelColumns() {
469 Gtk::TreeModelColumn<Glib::ustring> visible_name;
470 Gtk::TreeModelColumn<Glib::ustring> fullpath;
473 RecentSessionModelColumns recent_session_columns;
474 Gtk::TreeView recent_session_display;
475 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
477 ArdourDialog* session_selector_window;
478 Gtk::FileChooserDialog* open_session_selector;
480 void build_session_selector();
481 void redisplay_recent_sessions();
482 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
484 struct RecentSessionsSorter {
485 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
486 return cmp_nocase(a.first, b.first) == -1;
490 /* menu bar and associated stuff */
492 Gtk::MenuBar* menu_bar;
493 Gtk::EventBox menu_bar_base;
496 void use_menubar_as_top_menubar ();
497 void build_menu_bar ();
498 void build_control_surface_menu ();
500 Gtk::Label wall_clock_label;
501 Gtk::EventBox wall_clock_box;
502 gint update_wall_clock ();
504 Gtk::Label disk_space_label;
505 Gtk::EventBox disk_space_box;
506 void update_disk_space ();
508 Gtk::Label cpu_load_label;
509 Gtk::EventBox cpu_load_box;
510 void update_cpu_load ();
512 Gtk::Label buffer_load_label;
513 Gtk::EventBox buffer_load_box;
514 void update_buffer_load ();
516 Gtk::Label sample_rate_label;
517 Gtk::EventBox sample_rate_box;
518 void update_sample_rate (nframes_t);
520 gint every_second ();
521 gint every_point_one_seconds ();
522 gint every_point_zero_one_seconds ();
524 sigc::connection second_connection;
525 sigc::connection point_one_second_connection;
526 sigc::connection point_oh_five_second_connection;
527 sigc::connection point_zero_one_second_connection;
529 gint session_menu (GdkEventButton *);
531 bool _will_create_new_session_automatically;
533 void open_session ();
534 void open_recent_session ();
535 void save_template ();
537 void edit_metadata ();
538 void import_metadata ();
540 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
541 void session_add_midi_route (bool disk, uint32_t how_many);
543 void set_transport_sensitivity (bool);
545 void remove_last_capture ();
547 void transport_goto_zero ();
548 void transport_goto_start ();
549 void transport_goto_end ();
550 void transport_goto_wallclock ();
551 void transport_stop ();
552 void transport_stop_and_forget_capture ();
553 void transport_record (bool roll);
554 void transport_roll ();
555 void transport_play_selection();
556 void transport_forward (int option);
557 void transport_rewind (int option);
558 void transport_loop ();
560 void transport_rolling ();
561 void transport_rewinding ();
562 void transport_forwarding ();
563 void transport_stopped ();
565 bool _session_is_new;
566 void connect_to_session (ARDOUR::Session *);
567 void connect_dependents_to_session (ARDOUR::Session *);
568 void we_have_dependents ();
570 void setup_session_options ();
572 guint32 last_key_press_time;
574 void snapshot_session ();
579 PublicEditor *editor;
580 int create_editor ();
582 RouteParams_UI *route_params;
583 int create_route_params ();
585 BundleManager *bundle_manager;
586 void create_bundle_manager ();
588 LocationUI *location_ui;
589 int create_location_ui ();
590 void handle_locations_change (ARDOUR::Location*);
592 static UIConfiguration *ui_config;
593 ThemeManager *theme_manager;
595 /* Key bindings editor */
597 KeyEditor *key_editor;
601 OptionEditor *option_editor;
605 AddRouteDialog *add_route_dialog;
607 /* Keyboard Handling */
611 /* Keymap handling */
613 void install_actions ();
615 void toggle_record_enable (uint32_t);
617 uint32_t rec_enabled_streams;
618 void count_recenabled_streams (ARDOUR::Route&);
622 void pop_back_splash ();
627 Gtk::MenuItem *cleanup_item;
629 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
633 bool have_configure_timeout;
634 ARDOUR::microseconds_t last_configure_time;
635 gint configure_timeout ();
637 ARDOUR::microseconds_t last_peak_grab;
638 ARDOUR::microseconds_t last_shuttle_request;
640 bool have_disk_speed_dialog_displayed;
641 void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
642 void disk_overrun_handler ();
643 void disk_underrun_handler ();
645 void session_dialog (std::string);
646 int pending_state_dialog ();
647 int sr_mismatch_dialog (nframes_t, nframes_t);
649 void disconnect_from_jack ();
650 void reconnect_to_jack ();
651 void set_jack_buffer_size (nframes_t);
653 Gtk::MenuItem* jack_disconnect_item;
654 Gtk::MenuItem* jack_reconnect_item;
655 Gtk::Menu* jack_bufsize_menu;
657 Glib::RefPtr<Gtk::ActionGroup> common_actions;
659 void editor_realized ();
661 std::vector<std::string> positional_sync_strings;
663 void toggle_send_midi_feedback ();
664 void toggle_use_mmc ();
665 void toggle_send_mmc ();
666 void toggle_send_mtc ();
667 void toggle_send_midi_clock ();
669 void toggle_use_osc ();
671 void toggle_denormal_protection ();
673 void set_input_auto_connect (ARDOUR::AutoConnectOption);
674 void set_output_auto_connect (ARDOUR::AutoConnectOption);
675 void set_solo_model (ARDOUR::SoloModel);
676 void set_monitor_model (ARDOUR::MonitorModel);
677 void set_remote_model (ARDOUR::RemoteModel);
678 void set_denormal_model (ARDOUR::DenormalModel);
680 void toggle_sync_order_keys ();
681 void toggle_new_plugins_active();
682 void toggle_StopPluginsWithTransport();
683 void toggle_DoNotRunPluginsWhileRecording();
684 void toggle_VerifyRemoveLastCapture();
685 void toggle_PeriodicSafetyBackups();
686 void toggle_StopRecordingOnXrun();
687 void toggle_CreateXrunMarker();
688 void toggle_StopTransportAtEndOfSession();
689 void toggle_GainReduceFastTransport();
690 void toggle_LatchedSolo();
691 void toggle_ShowSoloMutes();
692 void toggle_SoloMuteOverride();
693 void toggle_LatchedRecordEnable ();
694 void toggle_RegionEquivalentsOverlap ();
695 void toggle_PrimaryClockDeltaEditCursor ();
696 void toggle_SecondaryClockDeltaEditCursor ();
697 void toggle_ShowTrackMeters ();
698 void toggle_only_copy_imported_files ();
699 void toggle_use_narrow_ms();
700 void toggle_NameNewMarkers ();
701 void toggle_rubberbanding_snaps_to_grid ();
702 void toggle_auto_analyse_audio ();
703 void toggle_TapeMachineMode();
705 void mtc_port_changed ();
706 void map_solo_model ();
707 void map_monitor_model ();
708 void map_denormal_model ();
709 void map_denormal_protection ();
710 void map_remote_model ();
711 void map_file_header_format ();
712 void map_file_data_format ();
713 void map_input_auto_connect ();
714 void map_output_auto_connect ();
715 void map_only_copy_imported_files ();
716 void parameter_changed (const char*);
718 void set_meter_hold (ARDOUR::MeterHold);
719 void set_meter_falloff (ARDOUR::MeterFalloff);
720 void map_meter_hold ();
721 void map_meter_falloff ();
723 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
724 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
728 void no_memory_warning ();
729 void check_memory_locking ();
731 bool check_audioengine();
732 void audioengine_setup ();
734 void display_message (const char *prefix, gint prefix_len,
735 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
736 Gtk::Label status_bar_label;
737 Gtk::ToggleButton error_log_button;
739 void loading_message (const std::string& msg);
740 void end_loading_messages ();
742 void platform_specific ();
743 void platform_setup ();
744 void fontconfig_dialog ();
747 #endif /* __ardour_gui_h__ */