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/types.h>
63 #include "audio_clock.h"
64 #include "ardour_dialog.h"
66 #include "ui_config.h"
74 class ConnectionEditor;
81 class NewSessionDialog;
92 class ControlProtocolInfo;
96 class MultiChannelDevice;
99 #define FRAME_NAME "BaseFrame"
101 extern sigc::signal<void> ColorsChanged;
102 extern sigc::signal<void> DPIReset;
104 class ARDOUR_UI : public Gtkmm2ext::UI
107 ARDOUR_UI (int *argcp, char **argvp[]);
111 bool shown() { return shown_flag; }
119 void idle_load (const Glib::ustring& path);
120 int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
122 int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
124 uint32_t master_chns,
125 ARDOUR::AutoConnectOption input_connect,
126 ARDOUR::AutoConnectOption output_connect,
129 nframes_t initial_length);
130 bool session_is_new() const { return _session_is_new; }
132 ARDOUR::Session* the_session() { return session; }
134 bool will_create_new_session_automatically() const {
135 return _will_create_new_session_automatically;
138 void set_will_create_new_session_automatically (bool yn) {
139 _will_create_new_session_automatically = yn;
142 bool get_session_parameters (bool have_engine = false, bool should_be_new = false);
143 void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
144 int load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
145 int build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
146 bool ask_about_loading_existing_session (const Glib::ustring& session_path);
147 int unload_session (bool hide_stuff = false);
148 void close_session();
150 int save_state_canfail (string state_name = "");
151 void save_state (const string & state_name = "");
153 static double gain_to_slider_position (ARDOUR::gain_t g);
154 static ARDOUR::gain_t slider_position_to_gain (double pos);
156 static ARDOUR_UI *instance () { return theArdourUI; }
157 static UIConfiguration *config () { return ui_config; }
159 PublicEditor& the_editor(){return *editor;}
160 Mixer_UI* the_mixer() { return mixer; }
162 ARDOUR::AudioEngine& the_engine() const { return *engine; }
164 void toggle_key_editor ();
165 void toggle_location_window ();
166 void toggle_theme_manager ();
167 void toggle_big_clock_window ();
168 void toggle_connection_editor ();
169 void toggle_route_params_window ();
170 void toggle_editing_space();
172 Gtk::Tooltips& tooltips() { return _tooltips; }
174 static sigc::signal<void,bool> Blink;
175 static sigc::signal<void> RapidScreenUpdate;
176 static sigc::signal<void> SuperRapidScreenUpdate;
177 static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
179 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
181 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
183 XMLNode* editor_settings() const;
184 XMLNode* mixer_settings () const;
185 XMLNode* keyboard_settings () const;
187 void save_ardour_state ();
188 gboolean configure_handler (GdkEventConfigure* conf);
190 void do_transport_locate (nframes_t position);
191 void halt_on_xrun_message ();
192 void xrun_handler (nframes_t);
193 void create_xrun_marker (nframes_t);
195 AudioClock primary_clock;
196 AudioClock secondary_clock;
197 AudioClock preroll_clock;
198 AudioClock postroll_clock;
200 void store_clock_modes ();
201 void restore_clock_modes ();
203 void add_route (Gtk::Window* float_window);
205 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
206 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
209 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
210 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
213 void session_add_midi_track ();
215 int create_engine ();
218 gint exit_on_main_window_close (GdkEventAny *);
220 void maximise_editing_space ();
221 void restore_editing_space ();
223 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
224 void set_native_file_data_format (ARDOUR::SampleFormat sf);
226 void setup_profile ();
229 void set_shuttle_fract (double);
232 friend class PublicEditor;
234 void toggle_clocking ();
235 void toggle_auto_play ();
236 void toggle_auto_input ();
237 void toggle_punch ();
238 void unset_dual_punch ();
239 bool ignore_dual_punch;
240 void toggle_punch_in ();
241 void toggle_punch_out ();
242 void toggle_auto_return ();
243 void toggle_click ();
245 void toggle_session_auto_loop ();
247 void toggle_options_window ();
250 struct GlobalClickBox : public Gtk::VBox {
251 Gtkmm2ext::ClickBox *box;
254 vector<string> &strings;
255 Gtk::Adjustment adjustment;
257 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
259 GlobalClickBox (const string &str, vector<string> &vs)
261 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
262 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
263 label.set_text (str);
264 label.set_name ("GlobalButtonLabel");
266 frame.set_shadow_type (Gtk::SHADOW_IN);
269 box->set_print_func (printer, this);
270 box->set_wrap (true);
274 ARDOUR::AudioEngine *engine;
275 ARDOUR::Session *session;
277 Gtk::Tooltips _tooltips;
279 void goto_editor_window ();
280 void goto_mixer_window ();
282 GlobalClickBox *online_control_button;
283 vector<string> online_control_strings;
285 GlobalClickBox *crossfade_time_button;
286 vector<string> crossfade_time_strings;
288 Gtk::ToggleButton preroll_button;
289 Gtk::ToggleButton postroll_button;
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);
304 /* periodic safety backup, to be precise */
305 gint autosave_session();
306 void update_autosave();
307 sigc::connection _autosave_connection;
309 void queue_transport_change ();
310 void map_transport_state ();
311 int32_t do_engine_start ();
313 void engine_halted ();
314 void engine_stopped ();
315 void engine_running ();
319 static gint _blink (void *);
321 gint blink_timeout_tag;
323 void start_blinking ();
324 void stop_blinking ();
326 void about_signal_response(int response);
330 Gtk::VBox top_packer;
332 sigc::connection clock_signal_connection;
333 void update_clocks ();
334 void start_clocking ();
335 void stop_clocking ();
337 void manage_window (Gtk::Window&);
339 AudioClock big_clock;
340 Gtk::Window* big_clock_window;
342 void float_big_clock (Gtk::Window* parent);
343 bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
345 void update_transport_clocks (nframes_t pos);
346 void record_state_changed ();
348 /* Transport Control */
350 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
351 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
353 Gtkmm2ext::TearOff* transport_tearoff;
354 Gtk::Frame transport_frame;
355 Gtk::HBox transport_tearoff_hbox;
356 Gtk::HBox transport_hbox;
357 Gtk::Fixed transport_base;
358 Gtk::Fixed transport_button_base;
359 Gtk::Frame transport_button_frame;
360 Gtk::HBox transport_button_hbox;
361 Gtk::VBox transport_button_vbox;
362 Gtk::HBox transport_option_button_hbox;
363 Gtk::VBox transport_option_button_vbox;
364 Gtk::HBox transport_clock_hbox;
365 Gtk::VBox transport_clock_vbox;
366 Gtk::HBox primary_clock_hbox;
367 Gtk::HBox secondary_clock_hbox;
370 struct TransportControllable : public PBD::Controllable {
383 TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
384 void set_value (float);
385 float get_value (void) const;
387 void set_id (const std::string&);
393 TransportControllable roll_controllable;
394 TransportControllable stop_controllable;
395 TransportControllable goto_start_controllable;
396 TransportControllable goto_end_controllable;
397 TransportControllable auto_loop_controllable;
398 TransportControllable play_selection_controllable;
399 TransportControllable rec_controllable;
400 TransportControllable shuttle_controllable;
401 BindingProxy shuttle_controller_binding_proxy;
403 void set_transport_controllable_state (const XMLNode&);
404 XMLNode& get_transport_controllable_state ();
406 BindableButton roll_button;
407 BindableButton stop_button;
408 BindableButton goto_start_button;
409 BindableButton goto_end_button;
410 BindableButton auto_loop_button;
411 BindableButton play_selection_button;
412 BindableButton rec_button;
414 Gtk::ComboBoxText sync_option_combo;
416 void sync_option_changed ();
417 void toggle_time_master ();
418 void toggle_video_sync ();
420 Gtk::DrawingArea shuttle_box;
421 Gtk::EventBox speed_display_box;
422 Gtk::Label speed_display_label;
423 Gtk::Button shuttle_units_button;
424 Gtk::ComboBoxText shuttle_style_button;
425 Gtk::Menu* shuttle_unit_menu;
426 Gtk::Menu* shuttle_style_menu;
427 float shuttle_max_speed;
428 Gtk::Menu* shuttle_context_menu;
430 void build_shuttle_context_menu ();
431 void show_shuttle_context_menu ();
432 void shuttle_style_changed();
433 void shuttle_unit_clicked ();
434 void set_shuttle_max_speed (float);
435 void update_speed_display ();
436 float last_speed_displayed;
438 gint shuttle_box_button_press (GdkEventButton*);
439 gint shuttle_box_button_release (GdkEventButton*);
440 gint shuttle_box_scroll (GdkEventScroll*);
441 gint shuttle_box_motion (GdkEventMotion*);
442 gint shuttle_box_expose (GdkEventExpose*);
443 gint mouse_shuttle (double x, bool force);
444 void use_shuttle_fract (bool force);
446 bool shuttle_grabbed;
447 double shuttle_fract;
449 Gtkmm2ext::StatefulToggleButton punch_in_button;
450 Gtkmm2ext::StatefulToggleButton punch_out_button;
451 Gtkmm2ext::StatefulToggleButton auto_return_button;
452 Gtkmm2ext::StatefulToggleButton auto_play_button;
453 Gtkmm2ext::StatefulToggleButton auto_input_button;
454 Gtkmm2ext::StatefulToggleButton click_button;
455 Gtkmm2ext::StatefulToggleButton time_master_button;
457 Gtk::ToggleButton auditioning_alert_button;
458 Gtk::ToggleButton solo_alert_button;
462 void solo_blink (bool);
463 void audition_blink (bool);
465 void soloing_changed (bool);
466 void auditioning_changed (bool);
467 void _auditioning_changed (bool);
469 void solo_alert_toggle ();
470 void audition_alert_toggle ();
472 void big_clock_value_changed ();
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_goto_wallclock ();
568 void transport_stop ();
569 void transport_stop_and_forget_capture ();
570 void transport_record (bool roll);
571 void transport_roll ();
572 void transport_play_selection();
573 void transport_forward (int option);
574 void transport_rewind (int option);
575 void transport_loop ();
577 void transport_rolling ();
578 void transport_rewinding ();
579 void transport_forwarding ();
580 void transport_stopped ();
582 bool _session_is_new;
583 void connect_to_session (ARDOUR::Session *);
584 void connect_dependents_to_session (ARDOUR::Session *);
585 void we_have_dependents ();
587 void setup_session_options ();
589 guint32 last_key_press_time;
591 void snapshot_session ();
596 PublicEditor *editor;
597 int create_editor ();
599 RouteParams_UI *route_params;
600 int create_route_params ();
602 ConnectionEditor *connection_editor;
603 int create_connection_editor ();
605 LocationUI *location_ui;
606 int create_location_ui ();
607 void handle_locations_change (ARDOUR::Location*);
609 static UIConfiguration *ui_config;
610 ThemeManager *theme_manager;
612 /* Key bindings editor */
614 KeyEditor *key_editor;
618 OptionEditor *option_editor;
622 AddRouteDialog *add_route_dialog;
624 /* Keyboard Handling */
628 /* Keymap handling */
630 void install_actions ();
632 void toggle_record_enable (uint32_t);
634 uint32_t rec_enabled_streams;
635 void count_recenabled_streams (ARDOUR::Route&);
639 void pop_back_splash ();
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 ARDOUR::microseconds_t last_configure_time;
652 gint configure_timeout ();
654 ARDOUR::microseconds_t last_peak_grab;
655 ARDOUR::microseconds_t 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 void session_dialog (std::string);
663 int pending_state_dialog ();
664 int sr_mismatch_dialog (nframes_t, nframes_t);
666 void disconnect_from_jack ();
667 void reconnect_to_jack ();
668 void set_jack_buffer_size (nframes_t);
670 Gtk::MenuItem* jack_disconnect_item;
671 Gtk::MenuItem* jack_reconnect_item;
672 Gtk::Menu* jack_bufsize_menu;
674 Glib::RefPtr<Gtk::ActionGroup> common_actions;
676 void editor_realized ();
678 std::vector<std::string> positional_sync_strings;
680 void toggle_send_midi_feedback ();
681 void toggle_use_mmc ();
682 void toggle_send_mmc ();
683 void toggle_send_mtc ();
685 void toggle_use_osc ();
687 void toggle_denormal_protection ();
689 void set_input_auto_connect (ARDOUR::AutoConnectOption);
690 void set_output_auto_connect (ARDOUR::AutoConnectOption);
691 void set_solo_model (ARDOUR::SoloModel);
692 void set_monitor_model (ARDOUR::MonitorModel);
693 void set_remote_model (ARDOUR::RemoteModel);
694 void set_denormal_model (ARDOUR::DenormalModel);
696 void toggle_sync_order_keys ();
697 void toggle_StopPluginsWithTransport();
698 void toggle_DoNotRunPluginsWhileRecording();
699 void toggle_VerifyRemoveLastCapture();
700 void toggle_PeriodicSafetyBackups();
701 void toggle_StopRecordingOnXrun();
702 void toggle_CreateXrunMarker();
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 ();
712 void toggle_ShowTrackMeters ();
713 void toggle_use_narrow_ms();
714 void toggle_NameNewMarkers ();
715 void toggle_rubberbanding_snaps_to_grid ();
716 void toggle_auto_analyse_audio ();
717 void toggle_TapeMachineMode();
719 void mtc_port_changed ();
720 void map_solo_model ();
721 void map_monitor_model ();
722 void map_denormal_model ();
723 void map_denormal_protection ();
724 void map_remote_model ();
725 void map_file_header_format ();
726 void map_file_data_format ();
727 void map_input_auto_connect ();
728 void map_output_auto_connect ();
729 void map_only_copy_imported_files ();
730 void parameter_changed (const char*);
732 void set_meter_hold (ARDOUR::MeterHold);
733 void set_meter_falloff (ARDOUR::MeterFalloff);
734 void map_meter_hold ();
735 void map_meter_falloff ();
737 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
738 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
742 void no_memory_warning ();
743 void check_memory_locking ();
745 bool check_audioengine();
746 void audioengine_setup ();
748 void display_message (const char *prefix, gint prefix_len,
749 Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
750 Gtk::Label status_bar_label;
751 Gtk::ToggleButton error_log_button;
753 void loading_message (const std::string& msg);
754 void end_loading_messages ();
756 void platform_specific ();
757 void platform_setup ();
758 void fontconfig_dialog ();
761 #endif /* __ardour_gui_h__ */