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 ();
202 void set_engine (ARDOUR::AudioEngine&);
204 gint exit_on_main_window_close (GdkEventAny *);
206 void maximise_editing_space ();
207 void restore_editing_space ();
209 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
210 void set_native_file_data_format (ARDOUR::SampleFormat sf);
213 friend class PublicEditor;
215 void toggle_clocking ();
216 void toggle_auto_play ();
217 void toggle_auto_input ();
218 void toggle_punch_in ();
219 void toggle_punch_out ();
220 void toggle_auto_return ();
221 void toggle_click ();
223 void toggle_session_auto_loop ();
224 void toggle_session_punch_in ();
226 void toggle_options_window ();
229 struct GlobalClickBox : public Gtk::VBox {
230 Gtkmm2ext::ClickBox *box;
233 vector<string> &strings;
234 Gtk::Adjustment adjustment;
236 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
238 GlobalClickBox (const string &str, vector<string> &vs)
240 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
241 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
242 label.set_text (str);
243 label.set_name ("GlobalButtonLabel");
245 frame.set_shadow_type (Gtk::SHADOW_IN);
248 box->set_print_func (printer, this);
249 box->set_wrap (true);
253 ARDOUR::AudioEngine *engine;
254 ARDOUR::Session *session;
256 Gtk::Tooltips _tooltips;
258 void goto_editor_window ();
259 void goto_mixer_window ();
261 Gtk::Table adjuster_table;
262 Gtk::Frame adjuster_frame;
263 Gtk::Fixed adjuster_base;
265 GlobalClickBox *online_control_button;
266 vector<string> online_control_strings;
268 GlobalClickBox *crossfade_time_button;
269 vector<string> crossfade_time_strings;
271 GlobalClickBox *mmc_id_button;
272 vector<string> mmc_id_strings;
274 Gtk::ToggleButton preroll_button;
275 Gtk::ToggleButton postroll_button;
277 Gtk::Table transport_table;
278 Gtk::Table option_table;
280 int setup_windows ();
281 void setup_session_menu ();
282 void setup_transport ();
284 void setup_session_info ();
285 void setup_adjustables ();
287 Gtk::MenuBar* make_menubar ();
289 static ARDOUR_UI *theArdourUI;
295 int ask_about_saving_session (const string & why);
296 gint ask_about_save_deleted (GdkEventAny*);
297 void save_session_choice_made (int);
298 int save_the_session;
300 void queue_transport_change ();
301 void map_transport_state ();
302 int32_t do_engine_start ();
303 gint start_engine ();
305 void engine_halted ();
306 void engine_stopped ();
307 void engine_running ();
311 void clear_meters ();
313 static gint _blink (void *);
315 gint blink_timeout_tag;
317 void start_blinking ();
318 void stop_blinking ();
320 void control_methods_adjusted ();
321 void mmc_device_id_adjusted ();
324 Gtk::VBox top_packer;
326 sigc::connection clock_signal_connection;
327 void update_clocks ();
328 void start_clocking ();
329 void stop_clocking ();
331 void manage_window (Gtk::Window&);
333 AudioClock big_clock;
334 Gtk::Frame big_clock_frame;
335 Gtk::Window* big_clock_window;
337 /* Transport Control */
339 void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
340 void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
342 Gtkmm2ext::TearOff* transport_tearoff;
343 Gtk::Frame transport_frame;
344 Gtk::HBox transport_tearoff_hbox;
345 Gtk::HBox transport_hbox;
346 Gtk::Fixed transport_base;
347 Gtk::Fixed transport_button_base;
348 Gtk::Frame transport_button_frame;
349 Gtk::HBox transport_button_hbox;
350 Gtk::VBox transport_button_vbox;
351 Gtk::HBox transport_option_button_hbox;
352 Gtk::VBox transport_option_button_vbox;
353 Gtk::HBox transport_clock_hbox;
354 Gtk::VBox transport_clock_vbox;
355 Gtk::HBox primary_clock_hbox;
356 Gtk::HBox secondary_clock_hbox;
358 Gtkmm2ext::StatefulButton roll_button;
359 Gtkmm2ext::StatefulButton stop_button;
360 Gtkmm2ext::StatefulButton rewind_button;
361 Gtkmm2ext::StatefulButton forward_button;
362 Gtkmm2ext::StatefulButton goto_start_button;
363 Gtkmm2ext::StatefulButton goto_end_button;
364 Gtkmm2ext::StatefulButton auto_loop_button;
365 Gtkmm2ext::StatefulButton play_selection_button;
367 Gtkmm2ext::StatefulButton rec_button;
369 Gtk::ToggleButton time_master_button;
370 Gtk::ComboBoxText sync_option_combo;
372 void sync_option_changed ();
373 void toggle_time_master ();
375 enum ShuttleBehaviour {
385 Gtk::DrawingArea shuttle_box;
386 Gtk::EventBox speed_display_box;
387 Gtk::Label speed_display_label;
388 Gtk::Button shuttle_units_button;
389 Gtk::ComboBoxText shuttle_style_button;
390 Gtk::Menu* shuttle_unit_menu;
391 Gtk::Menu* shuttle_style_menu;
392 ShuttleBehaviour shuttle_behaviour;
393 ShuttleUnits shuttle_units;
394 float shuttle_max_speed;
395 Gtk::Menu* shuttle_context_menu;
397 void build_shuttle_context_menu ();
398 void show_shuttle_context_menu ();
399 void shuttle_style_changed();
400 void shuttle_unit_clicked ();
401 void set_shuttle_behaviour (ShuttleBehaviour);
402 void set_shuttle_units (ShuttleUnits);
403 void set_shuttle_max_speed (float);
404 void update_speed_display ();
405 float last_speed_displayed;
407 gint shuttle_box_button_press (GdkEventButton*);
408 gint shuttle_box_button_release (GdkEventButton*);
409 gint shuttle_box_scroll (GdkEventScroll*);
410 gint shuttle_box_motion (GdkEventMotion*);
411 gint shuttle_box_expose (GdkEventExpose*);
412 gint mouse_shuttle (double x, bool force);
413 void use_shuttle_fract (bool force);
415 bool shuttle_grabbed;
416 double shuttle_fract;
418 Gtk::ToggleButton punch_in_button;
419 Gtk::ToggleButton punch_out_button;
420 Gtk::ToggleButton auto_return_button;
421 Gtk::ToggleButton auto_play_button;
422 Gtk::ToggleButton auto_input_button;
423 Gtk::ToggleButton click_button;
424 Gtk::ToggleButton auditioning_alert_button;
425 Gtk::ToggleButton solo_alert_button;
429 void solo_blink (bool);
430 void audition_blink (bool);
432 void soloing_changed (bool);
433 void auditioning_changed (bool);
434 void _auditioning_changed (bool);
436 void solo_alert_toggle ();
437 void audition_alert_toggle ();
439 void primary_clock_value_changed ();
440 void secondary_clock_value_changed ();
442 /* called by Blink signal */
444 void transport_rec_enable_blink (bool onoff);
446 /* These change where we accept control from:
447 MMC, X (local) or both.
450 void allow_mmc_only ();
451 void allow_mmc_and_local ();
452 void allow_local_only ();
454 static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
456 Gtk::Menu* session_popup_menu;
458 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
459 RecentSessionModelColumns() {
463 Gtk::TreeModelColumn<Glib::ustring> visible_name;
464 Gtk::TreeModelColumn<Glib::ustring> fullpath;
467 RecentSessionModelColumns recent_session_columns;
468 Gtk::TreeView recent_session_display;
469 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
471 ArdourDialog* session_selector_window;
472 Gtk::FileChooserDialog* open_session_selector;
474 void build_session_selector();
475 void recent_session_selection_changed ();
476 void redisplay_recent_sessions();
477 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
479 struct RecentSessionsSorter {
480 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
481 return cmp_nocase(a.first, b.first) == -1;
485 /* menu bar and associated stuff */
487 Gtk::MenuBar* menu_bar;
488 Gtk::EventBox menu_bar_base;
491 void build_menu_bar ();
492 void build_control_surface_menu ();
493 void pack_toplevel_controls();
495 Gtk::Label wall_clock_label;
496 Gtk::EventBox wall_clock_box;
497 gint update_wall_clock ();
499 Gtk::Label disk_space_label;
500 Gtk::EventBox disk_space_box;
501 void update_disk_space ();
503 Gtk::Label cpu_load_label;
504 Gtk::EventBox cpu_load_box;
505 void update_cpu_load ();
507 Gtk::Label buffer_load_label;
508 Gtk::EventBox buffer_load_box;
509 void update_buffer_load ();
511 Gtk::Label sample_rate_label;
512 Gtk::EventBox sample_rate_box;
513 void update_sample_rate (jack_nframes_t);
515 gint every_second ();
516 gint every_point_one_seconds ();
517 gint every_point_zero_one_seconds ();
519 sigc::connection second_connection;
520 sigc::connection point_one_second_connection;
521 sigc::connection point_zero_one_second_connection;
523 void diskstream_added (ARDOUR::Diskstream*);
525 gint session_menu (GdkEventButton *);
527 bool _will_create_new_session_automatically;
529 NewSessionDialog* m_new_session_dialog;
531 void open_session ();
532 void open_recent_session ();
533 void open_ok_clicked ();
535 void save_template ();
537 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode);
539 void set_transport_sensitivity (bool);
541 void remove_last_capture ();
543 void transport_goto_zero ();
544 void transport_goto_start ();
545 void transport_goto_end ();
546 void transport_stop ();
547 void transport_stop_and_forget_capture ();
548 void transport_record ();
549 void transport_roll ();
550 void transport_play_selection();
551 void transport_forward (int option);
552 void transport_rewind (int option);
553 void transport_loop ();
555 void transport_locating ();
556 void transport_rolling ();
557 void transport_rewinding ();
558 void transport_forwarding ();
559 void transport_stopped ();
561 void send_all_midi_feedback ();
563 bool _session_is_new;
564 void connect_to_session (ARDOUR::Session *);
565 void connect_dependents_to_session (ARDOUR::Session *);
566 void we_have_dependents ();
567 void setup_keybindings ();
568 void setup_session_options ();
569 void setup_config_options ();
571 guint32 last_key_press_time;
573 void snapshot_session ();
575 void map_record_state ();
576 void queue_map_record_state ();
581 PublicEditor *editor;
582 int create_editor ();
584 RouteParams_UI *route_params;
585 int create_route_params ();
587 ConnectionEditor *connection_editor;
588 int create_connection_editor ();
590 LocationUI *location_ui;
591 int create_location_ui ();
592 void handle_locations_change (ARDOUR::Location*);
594 ColorManager* color_manager;
598 OptionEditor *option_editor;
602 AddRouteDialog *add_route_dialog;
603 void add_route_dialog_done (int status);
605 /* SoundFile Browser */
606 SoundFileBrowser *sfdb;
607 void toggle_sound_file_browser ();
608 int create_sound_file_browser ();
610 /* Keyboard Handling */
614 /* Keymap handling */
616 Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
617 void install_actions ();
618 void test_binding_action (const char *);
619 void start_keyboard_prefix();
621 void toggle_record_enable (uint32_t);
623 uint32_t rec_enabled_diskstreams;
624 void count_recenabled_diskstreams (ARDOUR::Route&);
630 Gtk::MenuItem *cleanup_item;
632 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
636 bool have_configure_timeout;
637 struct timeval last_configure_time;
638 gint configure_timeout ();
640 struct timeval last_peak_grab;
641 struct timeval last_shuttle_request;
643 void delete_sources_in_the_right_thread (list<ARDOUR::Source*>*);
645 void editor_display_control_changed (Editing::DisplayControl c);
647 bool have_disk_overrun_displayed;
648 bool have_disk_underrun_displayed;
650 void disk_overrun_message_gone ();
651 void disk_underrun_message_gone ();
652 void disk_overrun_handler ();
653 void disk_underrun_handler ();
655 int pending_state_dialog ();
657 void disconnect_from_jack ();
658 void reconnect_to_jack ();
659 void set_jack_buffer_size (jack_nframes_t);
661 Gtk::MenuItem* jack_disconnect_item;
662 Gtk::MenuItem* jack_reconnect_item;
663 Gtk::Menu* jack_bufsize_menu;
665 int make_session_clean ();
666 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
668 Glib::RefPtr<Gtk::ActionGroup> common_actions;
670 void editor_realized ();
672 std::vector<std::string> positional_sync_strings;
674 void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
675 void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
676 void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
677 void toggle_send_midi_feedback ();
678 void toggle_use_mmc ();
679 void toggle_send_mmc ();
680 void toggle_use_midi_control();
681 void toggle_send_mtc ();
683 void toggle_AutoConnectNewTrackInputsToHardware();
684 void toggle_AutoConnectNewTrackOutputsToHardware();
685 void toggle_AutoConnectNewTrackOutputsToMaster();
686 void toggle_ManuallyConnectNewTrackOutputs();
687 void toggle_UseHardwareMonitoring();
688 void toggle_UseSoftwareMonitoring();
689 void toggle_UseExternalMonitoring();
690 void toggle_StopPluginsWithTransport();
691 void toggle_DoNotRunPluginsWhileRecording();
692 void toggle_VerifyRemoveLastCapture();
693 void toggle_StopRecordingOnXrun();
694 void toggle_StopTransportAtEndOfSession();
695 void toggle_GainReduceFastTransport();
696 void toggle_LatchedSolo();
697 void toggle_SoloViaBus();
698 void toggle_AutomaticallyCreateCrossfades();
699 void toggle_UnmuteNewFullCrossfades();
700 void toggle_LatchedRecordEnable ();
702 void mtc_port_changed ();
703 void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
704 void queue_session_control_changed (ARDOUR::Session::ControlType t);
705 void session_control_changed (ARDOUR::Session::ControlType t);
707 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
710 #endif /* __ardour_gui_h__ */