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.
21 #ifndef __ardour_gui_h__
22 #define __ardour_gui_h__
24 /* need _BSD_SOURCE to get timersub macros */
38 #include <libgnomecanvasmm/canvas.h>
40 #include <pbd/xml++.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/adjustment.h>
55 #include <gtkmm2ext/gtk_ui.h>
56 #include <gtkmm2ext/click_box.h>
57 #include <gtkmm2ext/stateful_button.h>
58 #include <ardour/ardour.h>
59 #include <ardour/session.h>
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
71 class ConnectionEditor;
73 class SoundFileBrowser;
76 class NewSessionDialog;
89 class ControlProtocolInfo;
93 class MultiChannelDevice;
96 #define FRAME_NAME "BaseFrame"
98 class ARDOUR_UI : public Gtkmm2ext::UI
101 ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
105 bool shown() { return shown_flag; }
110 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
112 int build_session (const string & path, const string & snapshot,
114 uint32_t master_chns,
115 ARDOUR::Session::AutoConnectOption input_connect,
116 ARDOUR::Session::AutoConnectOption output_connect,
119 jack_nframes_t initial_length);
120 bool session_is_new() const { return _session_is_new; }
122 ARDOUR::Session* the_session() { return session; }
124 bool will_create_new_session_automatically() const {
125 return _will_create_new_session_automatically;
128 void set_will_create_new_session_automatically (bool yn) {
129 _will_create_new_session_automatically = yn;
132 void new_session(bool startup = false, std::string path = string());
133 gint cmdline_new_session (string path);
134 int unload_session ();
135 void close_session();
137 int save_state_canfail (string state_name = "");
138 void save_state (const string & state_name = "");
139 void restore_state (string state_name = "");
141 static double gain_to_slider_position (ARDOUR::gain_t g);
142 static ARDOUR::gain_t slider_position_to_gain (double pos);
144 static ARDOUR_UI *instance () { return theArdourUI; }
146 PublicEditor& the_editor(){return *editor;}
147 Mixer_UI* the_mixer() { return mixer; }
149 void toggle_location_window ();
150 void toggle_color_manager ();
151 void toggle_big_clock_window ();
152 void toggle_connection_editor ();
153 void toggle_route_params_window ();
154 void toggle_tempo_window ();
155 void toggle_editing_space();
157 Gtk::Tooltips& tooltips() { return _tooltips; }
159 static sigc::signal<void,bool> Blink;
160 static sigc::signal<void> RapidScreenUpdate;
161 static sigc::signal<void> SuperRapidScreenUpdate;
162 static sigc::signal<void,jack_nframes_t> Clock;
164 /* this is a helper function to centralize the (complex) logic for
165 blinking rec-enable buttons.
168 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
170 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
171 void choose_io (ARDOUR::IO&, bool input);
173 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
175 XMLNode* editor_settings() const;
176 XMLNode* mixer_settings () const;
177 XMLNode* keyboard_settings () const;
179 void save_ardour_state ();
180 gboolean configure_handler (GdkEventConfigure* conf);
182 void do_transport_locate (jack_nframes_t position);
183 void halt_on_xrun_message ();
185 AudioClock primary_clock;
186 AudioClock secondary_clock;
187 AudioClock preroll_clock;
188 AudioClock postroll_clock;
192 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode) {
193 session_add_audio_route (true, input_channels, output_channels, mode);
196 void session_add_audio_bus (int input_channels, int32_t output_channels) {
197 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal);
200 void session_add_midi_track () {
201 session_add_midi_route (true);
204 void session_add_midi_bus () {
205 session_add_midi_route (false);
208 void set_engine (ARDOUR::AudioEngine&);
210 gint exit_on_main_window_close (GdkEventAny *);
212 void maximise_editing_space ();
213 void restore_editing_space ();
215 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
216 void set_native_file_data_format (ARDOUR::SampleFormat sf);
219 friend class PublicEditor;
221 void toggle_clocking ();
222 void toggle_auto_play ();
223 void toggle_auto_input ();
224 void toggle_punch_in ();
225 void toggle_punch_out ();
226 void toggle_auto_return ();
227 void toggle_click ();
229 void toggle_session_auto_loop ();
230 void toggle_session_punch_in ();
232 void toggle_options_window ();
235 struct GlobalClickBox : public Gtk::VBox {
236 Gtkmm2ext::ClickBox *box;
239 vector<string> &strings;
240 Gtk::Adjustment adjustment;
242 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
244 GlobalClickBox (const string &str, vector<string> &vs)
246 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
247 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
248 label.set_text (str);
249 label.set_name ("GlobalButtonLabel");
251 frame.set_shadow_type (Gtk::SHADOW_IN);
254 box->set_print_func (printer, this);
255 box->set_wrap (true);
259 ARDOUR::AudioEngine *engine;
260 ARDOUR::Session *session;
262 Gtk::Tooltips _tooltips;
264 void goto_editor_window ();
265 void goto_mixer_window ();
267 Gtk::Table adjuster_table;
268 Gtk::Frame adjuster_frame;
269 Gtk::Fixed adjuster_base;
271 GlobalClickBox *online_control_button;
272 vector<string> online_control_strings;
274 GlobalClickBox *crossfade_time_button;
275 vector<string> crossfade_time_strings;
277 GlobalClickBox *mmc_id_button;
278 vector<string> mmc_id_strings;
280 Gtk::ToggleButton preroll_button;
281 Gtk::ToggleButton postroll_button;
283 Gtk::Table transport_table;
284 Gtk::Table option_table;
286 int setup_windows ();
287 void setup_session_menu ();
288 void setup_transport ();
290 void setup_session_info ();
291 void setup_adjustables ();
293 Gtk::MenuBar* make_menubar ();
295 static ARDOUR_UI *theArdourUI;
301 int ask_about_saving_session (const string & why);
302 gint ask_about_save_deleted (GdkEventAny*);
303 void save_session_choice_made (int);
304 int save_the_session;
306 void queue_transport_change ();
307 void map_transport_state ();
308 int32_t do_engine_start ();
309 gint start_engine ();
311 void engine_halted ();
312 void engine_stopped ();
313 void engine_running ();
317 void clear_meters ();
319 static gint _blink (void *);
321 gint blink_timeout_tag;
323 void start_blinking ();
324 void stop_blinking ();
326 void control_methods_adjusted ();
327 void mmc_device_id_adjusted ();
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::Frame big_clock_frame;
341 Gtk::Window* big_clock_window;
343 /* Transport Control */
345 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
346 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
348 Gtkmm2ext::TearOff* transport_tearoff;
349 Gtk::Frame transport_frame;
350 Gtk::HBox transport_tearoff_hbox;
351 Gtk::HBox transport_hbox;
352 Gtk::Fixed transport_base;
353 Gtk::Fixed transport_button_base;
354 Gtk::Frame transport_button_frame;
355 Gtk::HBox transport_button_hbox;
356 Gtk::VBox transport_button_vbox;
357 Gtk::HBox transport_option_button_hbox;
358 Gtk::VBox transport_option_button_vbox;
359 Gtk::HBox transport_clock_hbox;
360 Gtk::VBox transport_clock_vbox;
361 Gtk::HBox primary_clock_hbox;
362 Gtk::HBox secondary_clock_hbox;
364 Gtkmm2ext::StatefulButton roll_button;
365 Gtkmm2ext::StatefulButton stop_button;
366 Gtkmm2ext::StatefulButton rewind_button;
367 Gtkmm2ext::StatefulButton forward_button;
368 Gtkmm2ext::StatefulButton goto_start_button;
369 Gtkmm2ext::StatefulButton goto_end_button;
370 Gtkmm2ext::StatefulButton auto_loop_button;
371 Gtkmm2ext::StatefulButton play_selection_button;
373 Gtkmm2ext::StatefulButton rec_button;
375 Gtk::ToggleButton time_master_button;
376 Gtk::ComboBoxText sync_option_combo;
378 void sync_option_changed ();
379 void toggle_time_master ();
381 enum ShuttleBehaviour {
391 Gtk::DrawingArea shuttle_box;
392 Gtk::EventBox speed_display_box;
393 Gtk::Label speed_display_label;
394 Gtk::Button shuttle_units_button;
395 Gtk::ComboBoxText shuttle_style_button;
396 Gtk::Menu* shuttle_unit_menu;
397 Gtk::Menu* shuttle_style_menu;
398 ShuttleBehaviour shuttle_behaviour;
399 ShuttleUnits shuttle_units;
400 float shuttle_max_speed;
401 Gtk::Menu* shuttle_context_menu;
403 void build_shuttle_context_menu ();
404 void show_shuttle_context_menu ();
405 void shuttle_style_changed();
406 void shuttle_unit_clicked ();
407 void set_shuttle_behaviour (ShuttleBehaviour);
408 void set_shuttle_units (ShuttleUnits);
409 void set_shuttle_max_speed (float);
410 void update_speed_display ();
411 float last_speed_displayed;
413 gint shuttle_box_button_press (GdkEventButton*);
414 gint shuttle_box_button_release (GdkEventButton*);
415 gint shuttle_box_scroll (GdkEventScroll*);
416 gint shuttle_box_motion (GdkEventMotion*);
417 gint shuttle_box_expose (GdkEventExpose*);
418 gint mouse_shuttle (double x, bool force);
419 void use_shuttle_fract (bool force);
421 bool shuttle_grabbed;
422 double shuttle_fract;
424 Gtk::ToggleButton punch_in_button;
425 Gtk::ToggleButton punch_out_button;
426 Gtk::ToggleButton auto_return_button;
427 Gtk::ToggleButton auto_play_button;
428 Gtk::ToggleButton auto_input_button;
429 Gtk::ToggleButton click_button;
430 Gtk::ToggleButton auditioning_alert_button;
431 Gtk::ToggleButton solo_alert_button;
435 void solo_blink (bool);
436 void audition_blink (bool);
438 void soloing_changed (bool);
439 void auditioning_changed (bool);
440 void _auditioning_changed (bool);
442 void solo_alert_toggle ();
443 void audition_alert_toggle ();
445 void primary_clock_value_changed ();
446 void secondary_clock_value_changed ();
448 /* called by Blink signal */
450 void transport_rec_enable_blink (bool onoff);
452 /* These change where we accept control from:
453 MMC, X (local) or both.
456 void allow_mmc_only ();
457 void allow_mmc_and_local ();
458 void allow_local_only ();
460 static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
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 recent_session_selection_changed ();
482 void redisplay_recent_sessions();
483 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
485 struct RecentSessionsSorter {
486 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
487 return cmp_nocase(a.first, b.first) == -1;
491 /* menu bar and associated stuff */
493 Gtk::MenuBar* menu_bar;
494 Gtk::EventBox menu_bar_base;
497 void build_menu_bar ();
498 void build_control_surface_menu ();
499 void pack_toplevel_controls();
501 Gtk::Label wall_clock_label;
502 Gtk::EventBox wall_clock_box;
503 gint update_wall_clock ();
505 Gtk::Label disk_space_label;
506 Gtk::EventBox disk_space_box;
507 void update_disk_space ();
509 Gtk::Label cpu_load_label;
510 Gtk::EventBox cpu_load_box;
511 void update_cpu_load ();
513 Gtk::Label buffer_load_label;
514 Gtk::EventBox buffer_load_box;
515 void update_buffer_load ();
517 Gtk::Label sample_rate_label;
518 Gtk::EventBox sample_rate_box;
519 void update_sample_rate (jack_nframes_t);
521 gint every_second ();
522 gint every_point_one_seconds ();
523 gint every_point_zero_one_seconds ();
525 sigc::connection second_connection;
526 sigc::connection point_one_second_connection;
527 sigc::connection point_zero_one_second_connection;
529 void diskstream_added (ARDOUR::Diskstream*);
531 gint session_menu (GdkEventButton *);
533 bool _will_create_new_session_automatically;
535 NewSessionDialog* m_new_session_dialog;
537 void open_session ();
538 void open_recent_session ();
539 void open_ok_clicked ();
541 void save_template ();
543 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode);
544 void session_add_midi_route (bool disk);
546 void set_transport_sensitivity (bool);
548 void remove_last_capture ();
550 void transport_goto_zero ();
551 void transport_goto_start ();
552 void transport_goto_end ();
553 void transport_stop ();
554 void transport_stop_and_forget_capture ();
555 void transport_record ();
556 void transport_roll ();
557 void transport_play_selection();
558 void transport_forward (int option);
559 void transport_rewind (int option);
560 void transport_loop ();
562 void transport_locating ();
563 void transport_rolling ();
564 void transport_rewinding ();
565 void transport_forwarding ();
566 void transport_stopped ();
568 void send_all_midi_feedback ();
570 bool _session_is_new;
571 void connect_to_session (ARDOUR::Session *);
572 void connect_dependents_to_session (ARDOUR::Session *);
573 void we_have_dependents ();
574 void setup_keybindings ();
575 void setup_session_options ();
576 void setup_config_options ();
578 guint32 last_key_press_time;
580 void snapshot_session ();
582 void map_record_state ();
583 void queue_map_record_state ();
588 PublicEditor *editor;
589 int create_editor ();
591 RouteParams_UI *route_params;
592 int create_route_params ();
594 ConnectionEditor *connection_editor;
595 int create_connection_editor ();
597 LocationUI *location_ui;
598 int create_location_ui ();
599 void handle_locations_change (ARDOUR::Location*);
601 ColorManager* color_manager;
605 OptionEditor *option_editor;
609 AddRouteDialog *add_route_dialog;
610 void add_route_dialog_done (int status);
612 /* SoundFile Browser */
613 SoundFileBrowser *sfdb;
614 void toggle_sound_file_browser ();
615 int create_sound_file_browser ();
617 /* Keyboard Handling */
621 /* Keymap handling */
623 Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
624 void install_actions ();
625 void test_binding_action (const char *);
626 void start_keyboard_prefix();
628 void toggle_record_enable (uint32_t);
630 uint32_t rec_enabled_diskstreams;
631 void count_recenabled_diskstreams (ARDOUR::Diskstream&);
637 Gtk::MenuItem *cleanup_item;
639 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
643 bool have_configure_timeout;
644 struct timeval last_configure_time;
645 gint configure_timeout ();
647 struct timeval last_peak_grab;
648 struct timeval last_shuttle_request;
650 void delete_sources_in_the_right_thread (list<ARDOUR::AudioFileSource*>*);
652 void editor_display_control_changed (Editing::DisplayControl c);
654 bool have_disk_overrun_displayed;
655 bool have_disk_underrun_displayed;
657 void disk_overrun_message_gone ();
658 void disk_underrun_message_gone ();
659 void disk_overrun_handler ();
660 void disk_underrun_handler ();
662 int pending_state_dialog ();
664 void disconnect_from_jack ();
665 void reconnect_to_jack ();
666 void set_jack_buffer_size (jack_nframes_t);
668 Gtk::MenuItem* jack_disconnect_item;
669 Gtk::MenuItem* jack_reconnect_item;
670 Gtk::Menu* jack_bufsize_menu;
672 int make_session_clean ();
673 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
675 Glib::RefPtr<Gtk::ActionGroup> common_actions;
677 void editor_realized ();
679 std::vector<std::string> positional_sync_strings;
681 void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
682 void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
683 void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
684 void toggle_send_midi_feedback ();
685 void toggle_use_mmc ();
686 void toggle_send_mmc ();
687 void toggle_use_midi_control();
688 void toggle_send_mtc ();
690 void toggle_AutoConnectNewTrackInputsToHardware();
691 void toggle_AutoConnectNewTrackOutputsToHardware();
692 void toggle_AutoConnectNewTrackOutputsToMaster();
693 void toggle_ManuallyConnectNewTrackOutputs();
694 void toggle_UseHardwareMonitoring();
695 void toggle_UseSoftwareMonitoring();
696 void toggle_UseExternalMonitoring();
697 void toggle_StopPluginsWithTransport();
698 void toggle_DoNotRunPluginsWhileRecording();
699 void toggle_VerifyRemoveLastCapture();
700 void toggle_StopRecordingOnXrun();
701 void toggle_StopTransportAtEndOfSession();
702 void toggle_GainReduceFastTransport();
703 void toggle_LatchedSolo();
704 void toggle_SoloViaBus();
705 void toggle_AutomaticallyCreateCrossfades();
706 void toggle_UnmuteNewFullCrossfades();
707 void toggle_LatchedRecordEnable ();
709 void mtc_port_changed ();
710 void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
711 void queue_session_control_changed (ARDOUR::Session::ControlType t);
712 void session_control_changed (ARDOUR::Session::ControlType t);
714 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
718 #endif /* __ardour_gui_h__ */