add destructive outlines, more action usage and state fixups in GUI
[ardour.git] / gtk2_ardour / ardour_ui.h
1 /*
2     Copyright (C) 1999-2002 Paul Davis 
3
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.
8
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.
13
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.
17
18     $Id$
19 */
20
21 #ifndef __ardour_gui_h__
22 #define __ardour_gui_h__
23
24 /* need _BSD_SOURCE to get timersub macros */
25
26 #ifdef _BSD_SOURCE
27 #include <sys/time.h>
28 #else
29 #define _BSD_SOURCE
30 #include <sys/time.h>
31 #undef _BSD_SOURCE
32 #endif
33
34 #include <list>
35
36 #include <cmath>
37
38 #include <libgnomecanvasmm/canvas.h>
39
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>
60
61 #include "audio_clock.h"
62 #include "ardour_dialog.h"
63 #include "editing.h"
64 #include "glade_factory.h"
65
66 class AudioClock;
67 class PublicEditor;
68 class Keyboard;
69 class MeterBridge;
70 class OptionEditor;
71 class Mixer_UI;
72 class ConnectionEditor;
73 class RouteParams_UI;
74 class SoundFileBrowser;
75 class About;
76 class AddRouteDialog;
77 class NewSessionDialog;
78 class LocationUI;
79
80 namespace Gtkmm2ext {
81         class TearOff;
82 };
83
84 namespace ARDOUR {
85         class AudioEngine;
86         class Route;
87         class Port;
88         class IO;
89 };
90
91 namespace ALSA {
92         class MultiChannelDevice;
93 };
94
95 #define FRAME_NAME "BaseFrame"
96
97 class ARDOUR_UI : public Gtkmm2ext::UI
98 {
99   public:
100         ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
101         ~ARDOUR_UI();
102
103         void show ();
104         bool shown() { return shown_flag; }
105         
106         void show_splash ();
107         void hide_splash ();
108         
109         int load_session (const string & path, const string & snapshot, string* mix_template = 0);
110         bool session_loaded;
111         int build_session (const string & path, const string & snapshot, 
112                            uint32_t ctl_chns, 
113                            uint32_t master_chns,
114                            ARDOUR::Session::AutoConnectOption input_connect,
115                            ARDOUR::Session::AutoConnectOption output_connect,
116                            uint32_t nphysin,
117                            uint32_t nphysout,
118                            jack_nframes_t initial_length);
119         bool session_is_new() const { return _session_is_new; }
120
121         ARDOUR::Session* the_session() { return session; }
122
123         bool will_create_new_session_automatically() const {
124                 return _will_create_new_session_automatically;
125         }
126
127         void set_will_create_new_session_automatically (bool yn) {
128                 _will_create_new_session_automatically = yn;
129         }
130
131         void new_session(bool startup = false, std::string path = string());
132         gint cmdline_new_session (string path);
133         int  unload_session ();
134         void close_session() { unload_session(); }
135
136         int  save_state_canfail (string state_name = "");
137         void save_state (const string & state_name = "");
138         void restore_state (string state_name = "");
139
140         static double gain_to_slider_position (ARDOUR::gain_t g);
141         static ARDOUR::gain_t slider_position_to_gain (double pos);
142
143         static ARDOUR_UI *instance () { return theArdourUI; }
144
145         PublicEditor&     the_editor(){return *editor;}
146         Mixer_UI* the_mixer() { return mixer; }
147         
148         void toggle_location_window ();
149         void toggle_big_clock_window ();
150         void toggle_connection_editor ();
151         void toggle_route_params_window ();
152         void toggle_tempo_window ();
153
154         gint32 select_diskstream (GdkEventButton *ev);
155
156         Gtk::Tooltips& tooltips() { return _tooltips; }
157
158         static sigc::signal<void,bool> Blink;
159         static sigc::signal<void>      RapidScreenUpdate;
160         static sigc::signal<void>      SuperRapidScreenUpdate;
161         static sigc::signal<void,jack_nframes_t> Clock;
162
163         /* this is a helper function to centralize the (complex) logic for
164            blinking rec-enable buttons.
165         */
166
167         void rec_enable_button_blink (bool onoff, ARDOUR::DiskStream *, Gtk::Widget *w);
168
169         void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
170         void choose_io (ARDOUR::IO&, bool input);
171
172         static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
173
174         XMLNode* editor_settings() const;
175         XMLNode* mixer_settings () const;
176         XMLNode* keyboard_settings () const;
177
178         void save_ardour_state ();
179         gboolean configure_handler (GdkEventConfigure* conf);
180
181         void do_transport_locate (jack_nframes_t position);
182         void halt_on_xrun_message ();
183
184         AudioClock primary_clock;
185         AudioClock secondary_clock;
186         AudioClock preroll_clock;
187         AudioClock postroll_clock;
188
189         void add_route ();
190         
191         void session_add_audio_track (int input_channels, int32_t output_channels) {
192                 session_add_audio_route (true, input_channels, output_channels);
193         }
194
195         void session_add_audio_bus (int input_channels, int32_t output_channels) {
196                 session_add_audio_route (false, input_channels, output_channels);
197         }
198
199         void session_add_midi_track ();
200
201         void set_engine (ARDOUR::AudioEngine&);
202
203         gint exit_on_main_window_close (GdkEventAny *);
204
205   protected:
206         friend class PublicEditor;
207
208         void toggle_clocking ();
209         void toggle_auto_play ();
210         void toggle_auto_input ();
211         void toggle_punch_in ();
212         void toggle_punch_out ();
213         void toggle_auto_return ();
214         void toggle_click ();
215
216         void toggle_session_auto_loop ();
217         void toggle_session_punch_in ();
218         
219         void toggle_options_window ();
220
221   private:
222         struct GlobalClickBox : public Gtk::VBox {
223             Gtkmm2ext::ClickBox  *box;
224             Gtk::Frame      frame;
225             Gtk::Label      label;
226             vector<string> &strings;
227             Gtk::Adjustment adjustment;
228
229             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
230
231             GlobalClickBox (const string &str, vector<string> &vs)
232                     : strings (vs),
233                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
234                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
235                     label.set_text (str);
236                     label.set_name ("GlobalButtonLabel");
237                     frame.add (*box);
238                     frame.set_shadow_type (Gtk::SHADOW_IN);
239                     pack_start (label);
240                     pack_start (frame);
241                     box->set_print_func (printer, this);
242                     box->set_wrap (true);
243             };
244         };
245
246         ARDOUR::AudioEngine                 *engine;
247         ARDOUR::Session                     *session;
248
249         Gtk::Tooltips          _tooltips;
250
251         void                     goto_editor_window ();
252         void                     goto_mixer_window ();
253         
254         Gtk::Table               adjuster_table;
255         Gtk::Frame               adjuster_frame;
256         Gtk::Fixed               adjuster_base;
257
258         GlobalClickBox     *online_control_button;
259         vector<string>      online_control_strings;
260
261         GlobalClickBox    *crossfade_time_button;
262         vector<string>     crossfade_time_strings;
263
264         GlobalClickBox    *mmc_id_button;
265         vector<string>     mmc_id_strings;
266
267         Gtk::ToggleButton   preroll_button;
268         Gtk::ToggleButton   postroll_button;
269
270         Gtk::Table          transport_table;
271         Gtk::Table          option_table;
272
273         int  setup_windows ();
274         void setup_session_menu ();
275         void setup_transport ();
276         void setup_clock ();
277         void setup_session_info ();
278         void setup_adjustables ();
279
280         Gtk::MenuBar* make_menubar ();
281         
282         static ARDOUR_UI *theArdourUI;
283
284         void startup ();
285         void shutdown ();
286
287         void finish();
288         int  ask_about_saving_session (const string & why);
289         gint ask_about_save_deleted (GdkEventAny*);
290         void save_session_choice_made (int);
291         int  save_the_session;
292
293         void queue_transport_change ();
294         void map_transport_state ();
295         int32_t do_engine_start ();
296         gint start_engine ();
297         
298         void engine_halted ();
299         void engine_stopped ();
300         void engine_running ();
301
302         void clear_meters ();
303
304         static gint _blink  (void *);
305         void blink ();
306         gint blink_timeout_tag;
307         bool blink_on;
308         void start_blinking ();
309         void stop_blinking ();
310
311         void control_methods_adjusted ();
312         void mmc_device_id_adjusted ();
313
314   private:
315         Gtk::VBox     top_packer;
316
317         sigc::connection clock_signal_connection;
318         void         update_clocks ();
319         void         start_clocking ();
320         void         stop_clocking ();
321
322         void manage_window (Gtk::Window&);
323         
324         AudioClock   big_clock;
325         Gtk::Frame   big_clock_frame;
326         Gtk::Window* big_clock_window;
327
328         /* Transport Control */
329
330         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
331         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
332
333         Gtkmm2ext::TearOff*      transport_tearoff;
334         Gtk::Frame               transport_frame;
335         Gtk::HBox                transport_tearoff_hbox;
336         Gtk::HBox                transport_hbox;
337         Gtk::Fixed               transport_base;
338         Gtk::Fixed               transport_button_base;
339         Gtk::Frame               transport_button_frame;
340         Gtk::HBox                transport_button_hbox;
341         Gtk::VBox                transport_button_vbox;
342         Gtk::HBox                transport_option_button_hbox;
343         Gtk::VBox                transport_option_button_vbox;
344         Gtk::HBox                transport_clock_hbox;
345         Gtk::VBox                transport_clock_vbox;
346         Gtk::HBox                primary_clock_hbox;
347         Gtk::HBox                secondary_clock_hbox;
348
349         Gtkmm2ext::StatefulButton roll_button;
350         Gtkmm2ext::StatefulButton stop_button;
351         Gtkmm2ext::StatefulButton rewind_button;
352         Gtkmm2ext::StatefulButton forward_button;
353         Gtkmm2ext::StatefulButton goto_start_button;
354         Gtkmm2ext::StatefulButton goto_end_button;
355         Gtkmm2ext::StatefulButton auto_loop_button;
356         Gtkmm2ext::StatefulButton play_selection_button;
357
358         Gtkmm2ext::StatefulButton rec_button;
359
360         Gtk::ToggleButton time_master_button;
361         Gtk::ComboBoxText sync_option_combo;
362
363         void sync_option_changed ();
364         void toggle_time_master ();
365
366         enum ShuttleBehaviour {
367                 Sprung,
368                 Wheel
369         };
370
371         enum ShuttleUnits {
372                 Percentage,
373                 Semitones
374         };
375
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         ShuttleBehaviour  shuttle_behaviour;
384         ShuttleUnits      shuttle_units;
385
386         void shuttle_style_changed();
387         void shuttle_unit_clicked ();
388         void set_shuttle_behaviour (ShuttleBehaviour);
389         void set_shuttle_units (ShuttleUnits);
390         void update_speed_display ();
391         float last_speed_displayed;
392
393         gint shuttle_box_button_press (GdkEventButton*);
394         gint shuttle_box_button_release (GdkEventButton*);
395         gint shuttle_box_motion (GdkEventMotion*);
396         gint shuttle_box_expose (GdkEventExpose*);
397         gint mouse_shuttle (double x, bool force);
398         void use_shuttle_fract (bool force);
399
400         bool   shuttle_grabbed;
401         double shuttle_fract;
402
403         Gtk::ToggleButton punch_in_button;
404         Gtk::ToggleButton punch_out_button;
405         Gtk::ToggleButton auto_return_button;
406         Gtk::ToggleButton auto_play_button;
407         Gtk::ToggleButton auto_input_button;
408         Gtk::ToggleButton click_button;
409         Gtk::ToggleButton auditioning_alert_button;
410         Gtk::ToggleButton solo_alert_button;
411
412         Gtk::VBox alert_box;
413         
414         void solo_blink (bool);
415         void audition_blink (bool);
416
417         void soloing_changed (bool);
418         void auditioning_changed (bool);
419         void _auditioning_changed (bool);
420
421         void solo_alert_toggle ();
422         void audition_alert_toggle ();
423
424         void primary_clock_value_changed ();
425         void secondary_clock_value_changed ();
426
427         /* called by Blink signal */
428
429         void transport_rec_enable_blink (bool onoff);
430
431         /* These change where we accept control from:
432            MMC, X (local) or both.
433         */
434
435         void allow_mmc_only ();
436         void allow_mmc_and_local ();
437         void allow_local_only ();
438
439         static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
440
441         Gtk::Menu*        session_popup_menu;
442
443         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
444             RecentSessionModelColumns() { 
445                     add (visible_name);
446                     add (fullpath);
447             }
448             Gtk::TreeModelColumn<Glib::ustring> visible_name;
449             Gtk::TreeModelColumn<Glib::ustring> fullpath;
450         };
451
452         RecentSessionModelColumns    recent_session_columns;
453         Gtk::TreeView                recent_session_display;
454         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
455
456         ArdourDialog*     session_selector_window;
457         Gtk::FileChooserDialog* open_session_selector;
458         
459         void build_session_selector();
460         void recent_session_selection_changed ();
461         void redisplay_recent_sessions();
462
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;
466             }
467         };
468
469         /* menu bar and associated stuff */
470
471         Gtk::MenuBar* menu_bar;
472         Gtk::EventBox menu_bar_base;
473         Gtk::HBox     menu_hbox;
474
475         void build_menu_bar ();
476         void pack_toplevel_controls();
477
478         Gtk::Label   wall_clock_label;
479         Gtk::EventBox wall_clock_box;
480         gint update_wall_clock ();
481
482         Gtk::Label   disk_space_label;
483         Gtk::EventBox disk_space_box;
484         void update_disk_space ();
485
486         Gtk::Label   cpu_load_label;
487         Gtk::EventBox cpu_load_box;
488         void update_cpu_load ();
489
490         Gtk::Label   disk_rate_label;
491         Gtk::EventBox disk_rate_box;
492         void update_disk_rate();
493
494         Gtk::Label   buffer_load_label;
495         Gtk::EventBox buffer_load_box;
496         void update_buffer_load ();
497
498         Gtk::Label   sample_rate_label;
499         Gtk::EventBox sample_rate_box;
500         void update_sample_rate (jack_nframes_t);
501
502         gint every_second ();
503         gint every_point_one_seconds ();
504         gint every_point_zero_one_seconds ();
505
506         sigc::connection second_connection;
507         sigc::connection point_one_second_connection;
508         sigc::connection point_zero_one_second_connection;
509
510         void diskstream_added (ARDOUR::DiskStream*);
511
512         gint session_menu (GdkEventButton *);
513
514         bool _will_create_new_session_automatically;
515
516         GladeRef m_new_session_dialog_ref;
517         NewSessionDialog* m_new_session_dialog;
518         
519         void open_session ();
520         void open_recent_session ();
521         void open_ok_clicked ();
522
523         void save_template ();
524
525
526         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels);
527
528         void add_diskstream_to_menu (ARDOUR::DiskStream&);
529         void diskstream_selected (gint32);
530         Gtk::Menu *diskstream_menu;
531         gint32 selected_dstream;
532         
533         void set_transport_sensitivity (bool);
534
535         void remove_last_capture ();
536
537         void transport_goto_start ();
538         void transport_goto_end ();
539         void transport_stop ();
540         void transport_stop_and_forget_capture ();
541         void transport_record ();
542         void transport_roll ();
543         void transport_play_selection(); 
544         void transport_forward (int option);
545         void transport_rewind (int option);
546         void transport_loop ();
547
548         void transport_locating ();
549         void transport_rolling ();
550         void transport_rewinding ();
551         void transport_forwarding ();
552         void transport_stopped ();
553
554         void send_all_midi_feedback ();
555         
556         bool _session_is_new;
557         void connect_to_session (ARDOUR::Session *);
558         void connect_dependents_to_session (ARDOUR::Session *);
559         void we_have_dependents ();
560         void setup_keybindings ();
561         void setup_options ();
562         
563         guint32  last_key_press_time;
564
565         void snapshot_session ();
566
567         void map_record_state ();
568         void queue_map_record_state ();
569
570         Mixer_UI   *mixer;
571         int         create_mixer ();
572         
573         PublicEditor     *editor;
574         int         create_editor ();
575
576         RouteParams_UI *route_params;
577         int             create_route_params ();
578
579         ConnectionEditor *connection_editor;
580         int               create_connection_editor ();
581
582         LocationUI *location_ui;
583         int         create_location_ui ();
584
585         /* Options window */
586         
587         OptionEditor *option_editor;
588         
589         /* route dialog */
590
591         AddRouteDialog *add_route_dialog;
592         void add_route_dialog_done (int status);
593
594         /* SoundFile Browser */
595         SoundFileBrowser *sfdb;
596         void toggle_sound_file_browser ();
597         int create_sound_file_browser ();
598         
599         /* Keyboard Handling */
600         
601         Keyboard* keyboard;
602
603         /* Keymap handling */
604
605         void install_keybindings ();
606         Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
607         void install_actions ();
608         void test_binding_action (const char *);
609         void start_keyboard_prefix();
610
611         void toggle_record_enable (guint32);
612         void toggle_monitor_enable (guint32);
613
614         uint32_t rec_enabled_diskstreams;
615         void count_recenabled_diskstreams (ARDOUR::DiskStream&);
616
617         About* about;
618         bool shown_flag;
619         /* cleanup */
620
621         Gtk::MenuItem *cleanup_item;
622
623         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
624         void cleanup ();
625         void flush_trash ();
626
627         bool have_configure_timeout;
628         struct timeval last_configure_time;
629         gint configure_timeout ();
630
631         struct timeval last_peak_grab;
632         struct timeval last_shuttle_request;
633
634         void cannot_record_no_input (ARDOUR::DiskStream*);
635
636         void delete_sources_in_the_right_thread (list<ARDOUR::Source*>*);
637
638         void editor_display_control_changed (Editing::DisplayControl c);
639
640         bool have_disk_overrun_displayed;
641         bool have_disk_underrun_displayed;
642
643         void disk_overrun_message_gone ();
644         void disk_underrun_message_gone ();
645         void disk_overrun_handler ();
646         void disk_underrun_handler ();
647
648         int pending_state_dialog ();
649         
650         void disconnect_from_jack ();
651         void reconnect_to_jack ();
652         void set_jack_buffer_size (jack_nframes_t);
653
654         Gtk::MenuItem* jack_disconnect_item;
655         Gtk::MenuItem* jack_reconnect_item;
656         Gtk::Menu*     jack_bufsize_menu;
657
658         int make_session_clean ();
659         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
660
661         Glib::RefPtr<Gtk::ActionGroup> common_actions;
662
663         void editor_realized ();
664
665         std::vector<std::string> positional_sync_strings;
666
667         void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
668         void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
669         void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
670         void toggle_send_midi_feedback ();
671         void toggle_use_mmc ();
672         void toggle_send_mmc ();
673         void toggle_use_midi_control();
674         void toggle_send_mtc ();
675
676         void toggle_AutoConnectNewTrackInputsToHardware();
677         void toggle_AutoConnectNewTrackOutputsToHardware();
678         void toggle_AutoConnectNewTrackOutputsToMaster();
679         void toggle_ManuallyConnectNewTrackOutputs();
680         void toggle_UseHardwareMonitoring();
681         void toggle_UseSoftwareMonitoring();
682         void toggle_UseExternalMonitoring();
683         void toggle_StopPluginsWithTransport();
684         void toggle_RunPluginsWhileRecording();
685         void toggle_VerifyRemoveLastCapture();
686         void toggle_StopRecordingOnXrun();
687         void toggle_StopTransportAtEndOfSession();
688         void toggle_GainReduceFastTransport();
689         void toggle_LatchedSolo();
690         void toggle_SoloViaBus();
691         void toggle_AutomaticallyCreateCrossfades();
692         void toggle_UnmuteNewFullCrossfades();
693
694         void mtc_port_changed ();
695         void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
696         void queue_session_control_changed (ARDOUR::Session::ControlType t);
697         void session_control_changed (ARDOUR::Session::ControlType t);
698 };
699
700
701 #endif /* __ardour_gui_h__ */