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;
75 class NewSessionDialog;
88 class ControlProtocolInfo;
92 class MultiChannelDevice;
95 #define FRAME_NAME "BaseFrame"
97 class ARDOUR_UI : public Gtkmm2ext::UI
100 ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
104 bool shown() { return shown_flag; }
109 int load_session (const string & path, const string & snapshot, string* mix_template = 0);
111 int build_session (const string & path, const string & snapshot,
113 uint32_t master_chns,
114 ARDOUR::AutoConnectOption input_connect,
115 ARDOUR::AutoConnectOption output_connect,
118 nframes_t initial_length);
119 bool session_is_new() const { return _session_is_new; }
121 ARDOUR::Session* the_session() { return session; }
123 bool will_create_new_session_automatically() const {
124 return _will_create_new_session_automatically;
127 void set_will_create_new_session_automatically (bool yn) {
128 _will_create_new_session_automatically = yn;
131 void new_session(std::string path = string());
132 gint cmdline_new_session (string path);
133 int unload_session ();
134 void close_session();
136 int save_state_canfail (string state_name = "");
137 void save_state (const string & state_name = "");
138 void restore_state (string state_name = "");
140 static double gain_to_slider_position (ARDOUR::gain_t g);
141 static ARDOUR::gain_t slider_position_to_gain (double pos);
143 static ARDOUR_UI *instance () { return theArdourUI; }
145 PublicEditor& the_editor(){return *editor;}
146 Mixer_UI* the_mixer() { return mixer; }
148 void toggle_location_window ();
149 void toggle_color_manager ();
150 void toggle_big_clock_window ();
151 void toggle_connection_editor ();
152 void toggle_route_params_window ();
153 void toggle_editing_space();
155 Gtk::Tooltips& tooltips() { return _tooltips; }
157 static sigc::signal<void,bool> Blink;
158 static sigc::signal<void> RapidScreenUpdate;
159 static sigc::signal<void> MidRapidScreenUpdate;
160 static sigc::signal<void> SuperRapidScreenUpdate;
161 static sigc::signal<void,nframes_t> Clock;
163 /* this is a helper function to centralize the (complex) logic for
164 blinking rec-enable buttons.
167 void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
169 void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
171 static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
173 XMLNode* editor_settings() const;
174 XMLNode* mixer_settings () const;
175 XMLNode* keyboard_settings () const;
177 void save_ardour_state ();
178 gboolean configure_handler (GdkEventConfigure* conf);
180 void do_transport_locate (nframes_t position);
181 void halt_on_xrun_message ();
183 AudioClock primary_clock;
184 AudioClock secondary_clock;
185 AudioClock preroll_clock;
186 AudioClock postroll_clock;
188 void store_clock_modes ();
189 void restore_clock_modes ();
193 void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
194 session_add_audio_route (true, input_channels, output_channels, mode, how_many);
197 void session_add_audio_bus (int input_channels, int32_t output_channels, uint32_t how_many) {
198 session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
201 void session_add_midi_track ();
203 void set_engine (ARDOUR::AudioEngine&);
204 gint start_engine ();
206 gint exit_on_main_window_close (GdkEventAny *);
208 void maximise_editing_space ();
209 void restore_editing_space ();
211 void set_native_file_header_format (ARDOUR::HeaderFormat sf);
212 void set_native_file_data_format (ARDOUR::SampleFormat sf);
214 void set_keybindings_path (std::string path);
215 void save_keybindings ();
218 friend class PublicEditor;
220 void toggle_clocking ();
221 void toggle_auto_play ();
222 void toggle_auto_input ();
223 void toggle_punch_in ();
224 void toggle_punch_out ();
225 void toggle_auto_return ();
226 void toggle_click ();
228 void toggle_session_auto_loop ();
230 void toggle_options_window ();
233 struct GlobalClickBox : public Gtk::VBox {
234 Gtkmm2ext::ClickBox *box;
237 vector<string> &strings;
238 Gtk::Adjustment adjustment;
240 static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
242 GlobalClickBox (const string &str, vector<string> &vs)
244 adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
245 box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
246 label.set_text (str);
247 label.set_name ("GlobalButtonLabel");
249 frame.set_shadow_type (Gtk::SHADOW_IN);
252 box->set_print_func (printer, this);
253 box->set_wrap (true);
257 ARDOUR::AudioEngine *engine;
258 ARDOUR::Session *session;
260 Gtk::Tooltips _tooltips;
262 void goto_editor_window ();
263 void goto_mixer_window ();
265 Gtk::Table adjuster_table;
266 Gtk::Frame adjuster_frame;
267 Gtk::Fixed adjuster_base;
269 GlobalClickBox *online_control_button;
270 vector<string> online_control_strings;
272 GlobalClickBox *crossfade_time_button;
273 vector<string> crossfade_time_strings;
275 GlobalClickBox *mmc_id_button;
276 vector<string> mmc_id_strings;
278 Gtk::ToggleButton preroll_button;
279 Gtk::ToggleButton postroll_button;
281 Gtk::Table transport_table;
282 Gtk::Table option_table;
284 int setup_windows ();
285 void setup_transport ();
287 void setup_adjustables ();
289 static ARDOUR_UI *theArdourUI;
295 int ask_about_saving_session (const string & why);
296 int save_the_session;
298 void queue_transport_change ();
299 void map_transport_state ();
300 int32_t do_engine_start ();
302 void engine_halted ();
303 void engine_stopped ();
304 void engine_running ();
308 static gint _blink (void *);
310 gint blink_timeout_tag;
312 void start_blinking ();
313 void stop_blinking ();
315 void control_methods_adjusted ();
316 void mmc_device_id_adjusted ();
318 void about_signal_response(int response);
321 Gtk::VBox top_packer;
323 sigc::connection clock_signal_connection;
324 void update_clocks ();
325 void start_clocking ();
326 void stop_clocking ();
328 void manage_window (Gtk::Window&);
330 AudioClock big_clock;
331 Gtk::Frame big_clock_frame;
332 Gtk::Window* big_clock_window;
334 void update_transport_clocks (nframes_t pos);
335 void record_state_changed ();
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 ();
374 void toggle_video_sync ();
376 Gtk::DrawingArea shuttle_box;
377 Gtk::EventBox speed_display_box;
378 Gtk::Label speed_display_label;
379 Gtk::Button shuttle_units_button;
380 Gtk::ComboBoxText shuttle_style_button;
381 Gtk::Menu* shuttle_unit_menu;
382 Gtk::Menu* shuttle_style_menu;
383 float shuttle_max_speed;
384 Gtk::Menu* shuttle_context_menu;
386 void build_shuttle_context_menu ();
387 void show_shuttle_context_menu ();
388 void shuttle_style_changed();
389 void shuttle_unit_clicked ();
390 void set_shuttle_max_speed (float);
391 void update_speed_display ();
392 float last_speed_displayed;
394 gint shuttle_box_button_press (GdkEventButton*);
395 gint shuttle_box_button_release (GdkEventButton*);
396 gint shuttle_box_scroll (GdkEventScroll*);
397 gint shuttle_box_motion (GdkEventMotion*);
398 gint shuttle_box_expose (GdkEventExpose*);
399 gint mouse_shuttle (double x, bool force);
400 void use_shuttle_fract (bool force);
402 bool shuttle_grabbed;
403 double shuttle_fract;
405 Gtk::ToggleButton punch_in_button;
406 Gtk::ToggleButton punch_out_button;
407 Gtk::ToggleButton auto_return_button;
408 Gtk::ToggleButton auto_play_button;
409 Gtk::ToggleButton auto_input_button;
410 Gtk::ToggleButton click_button;
411 Gtk::ToggleButton auditioning_alert_button;
412 Gtk::ToggleButton solo_alert_button;
416 void solo_blink (bool);
417 void audition_blink (bool);
419 void soloing_changed (bool);
420 void auditioning_changed (bool);
421 void _auditioning_changed (bool);
423 void solo_alert_toggle ();
424 void audition_alert_toggle ();
426 void primary_clock_value_changed ();
427 void secondary_clock_value_changed ();
429 /* called by Blink signal */
431 void transport_rec_enable_blink (bool onoff);
433 /* These change where we accept control from:
434 MMC, X (local) or both.
437 void allow_mmc_only ();
438 void allow_mmc_and_local ();
439 void allow_local_only ();
441 Gtk::Menu* session_popup_menu;
443 struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
444 RecentSessionModelColumns() {
448 Gtk::TreeModelColumn<Glib::ustring> visible_name;
449 Gtk::TreeModelColumn<Glib::ustring> fullpath;
452 RecentSessionModelColumns recent_session_columns;
453 Gtk::TreeView recent_session_display;
454 Glib::RefPtr<Gtk::TreeStore> recent_session_model;
456 ArdourDialog* session_selector_window;
457 Gtk::FileChooserDialog* open_session_selector;
459 void build_session_selector();
460 void redisplay_recent_sessions();
461 void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
463 struct RecentSessionsSorter {
464 bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
465 return cmp_nocase(a.first, b.first) == -1;
469 /* menu bar and associated stuff */
471 Gtk::MenuBar* menu_bar;
472 Gtk::EventBox menu_bar_base;
475 void build_menu_bar ();
476 void build_control_surface_menu ();
478 Gtk::Label wall_clock_label;
479 Gtk::EventBox wall_clock_box;
480 gint update_wall_clock ();
482 Gtk::Label disk_space_label;
483 Gtk::EventBox disk_space_box;
484 void update_disk_space ();
486 Gtk::Label cpu_load_label;
487 Gtk::EventBox cpu_load_box;
488 void update_cpu_load ();
490 Gtk::Label buffer_load_label;
491 Gtk::EventBox buffer_load_box;
492 void update_buffer_load ();
494 Gtk::Label sample_rate_label;
495 Gtk::EventBox sample_rate_box;
496 void update_sample_rate (nframes_t);
498 gint every_second ();
499 gint every_point_one_seconds ();
500 gint every_point_oh_five_seconds ();
501 gint every_point_zero_one_seconds ();
503 sigc::connection second_connection;
504 sigc::connection point_one_second_connection;
505 sigc::connection point_oh_five_second_connection;
506 sigc::connection point_zero_one_second_connection;
508 gint session_menu (GdkEventButton *);
510 bool _will_create_new_session_automatically;
512 NewSessionDialog* new_session_dialog;
514 void open_session ();
515 void open_recent_session ();
516 void save_template ();
518 void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
520 void set_transport_sensitivity (bool);
522 void remove_last_capture ();
524 void transport_goto_zero ();
525 void transport_goto_start ();
526 void transport_goto_end ();
527 void transport_stop ();
528 void transport_stop_and_forget_capture ();
529 void transport_record ();
530 void transport_roll ();
531 void transport_play_selection();
532 void transport_forward (int option);
533 void transport_rewind (int option);
534 void transport_loop ();
536 void transport_rolling ();
537 void transport_rewinding ();
538 void transport_forwarding ();
539 void transport_stopped ();
541 bool _session_is_new;
542 void connect_to_session (ARDOUR::Session *);
543 void connect_dependents_to_session (ARDOUR::Session *);
544 void we_have_dependents ();
546 std::string keybindings_path;
548 void setup_keybindings ();
549 void setup_session_options ();
551 guint32 last_key_press_time;
553 void snapshot_session ();
558 PublicEditor *editor;
559 int create_editor ();
561 RouteParams_UI *route_params;
562 int create_route_params ();
564 ConnectionEditor *connection_editor;
565 int create_connection_editor ();
567 LocationUI *location_ui;
568 int create_location_ui ();
569 void handle_locations_change (ARDOUR::Location*);
571 ColorManager* color_manager;
575 OptionEditor *option_editor;
579 AddRouteDialog *add_route_dialog;
581 /* Keyboard Handling */
585 /* Keymap handling */
587 void install_actions ();
588 void start_keyboard_prefix();
590 void toggle_record_enable (uint32_t);
592 uint32_t rec_enabled_streams;
593 void count_recenabled_streams (ARDOUR::Route&);
599 Gtk::MenuItem *cleanup_item;
601 void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
605 bool have_configure_timeout;
606 struct timeval last_configure_time;
607 gint configure_timeout ();
609 struct timeval last_peak_grab;
610 struct timeval last_shuttle_request;
612 bool have_disk_overrun_displayed;
613 bool have_disk_underrun_displayed;
615 void disk_overrun_message_gone ();
616 void disk_underrun_message_gone ();
617 void disk_overrun_handler ();
618 void disk_underrun_handler ();
620 int pending_state_dialog ();
622 void disconnect_from_jack ();
623 void reconnect_to_jack ();
624 void set_jack_buffer_size (nframes_t);
626 Gtk::MenuItem* jack_disconnect_item;
627 Gtk::MenuItem* jack_reconnect_item;
628 Gtk::Menu* jack_bufsize_menu;
630 int make_session_clean ();
631 bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
633 Glib::RefPtr<Gtk::ActionGroup> common_actions;
635 void editor_realized ();
637 std::vector<std::string> positional_sync_strings;
639 void toggle_send_midi_feedback ();
640 void toggle_use_mmc ();
641 void toggle_send_mmc ();
642 void toggle_use_midi_control();
643 void toggle_send_mtc ();
645 void set_input_auto_connect (ARDOUR::AutoConnectOption);
646 void set_output_auto_connect (ARDOUR::AutoConnectOption);
647 void set_solo_model (ARDOUR::SoloModel);
648 void set_monitor_model (ARDOUR::MonitorModel);
650 void toggle_StopPluginsWithTransport();
651 void toggle_DoNotRunPluginsWhileRecording();
652 void toggle_VerifyRemoveLastCapture();
653 void toggle_StopRecordingOnXrun();
654 void toggle_StopTransportAtEndOfSession();
655 void toggle_GainReduceFastTransport();
656 void toggle_LatchedSolo();
657 void toggle_LatchedRecordEnable ();
658 void toggle_RegionEquivalentsOverlap ();
660 void mtc_port_changed ();
661 void map_solo_model ();
662 void map_monitor_model ();
663 void map_file_header_format ();
664 void map_file_data_format ();
665 void map_input_auto_connect ();
666 void map_output_auto_connect ();
667 void parameter_changed (const char*);
669 void set_meter_hold (ARDOUR::MeterHold);
670 void set_meter_falloff (ARDOUR::MeterFalloff);
671 void map_meter_hold ();
672 void map_meter_falloff ();
674 void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
675 void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
677 bool can_save_keybindings;
681 #endif /* __ardour_gui_h__ */