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