remove varispeed control; shuttle controller now has a context menu with max speed...
[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 class ColorManager;
80
81 namespace Gtkmm2ext {
82         class TearOff;
83 };
84
85 namespace ARDOUR {
86         class AudioEngine;
87         class Route;
88         class Port;
89         class IO;
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() { unload_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::DiskStream *, 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   protected:
212         friend class PublicEditor;
213
214         void toggle_clocking ();
215         void toggle_auto_play ();
216         void toggle_auto_input ();
217         void toggle_punch_in ();
218         void toggle_punch_out ();
219         void toggle_auto_return ();
220         void toggle_click ();
221
222         void toggle_session_auto_loop ();
223         void toggle_session_punch_in ();
224         
225         void toggle_options_window ();
226
227   private:
228         struct GlobalClickBox : public Gtk::VBox {
229             Gtkmm2ext::ClickBox  *box;
230             Gtk::Frame      frame;
231             Gtk::Label      label;
232             vector<string> &strings;
233             Gtk::Adjustment adjustment;
234
235             static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
236
237             GlobalClickBox (const string &str, vector<string> &vs)
238                     : strings (vs),
239                       adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
240                     box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
241                     label.set_text (str);
242                     label.set_name ("GlobalButtonLabel");
243                     frame.add (*box);
244                     frame.set_shadow_type (Gtk::SHADOW_IN);
245                     pack_start (label);
246                     pack_start (frame);
247                     box->set_print_func (printer, this);
248                     box->set_wrap (true);
249             };
250         };
251
252         ARDOUR::AudioEngine                 *engine;
253         ARDOUR::Session                     *session;
254
255         Gtk::Tooltips          _tooltips;
256
257         void                     goto_editor_window ();
258         void                     goto_mixer_window ();
259         
260         Gtk::Table               adjuster_table;
261         Gtk::Frame               adjuster_frame;
262         Gtk::Fixed               adjuster_base;
263
264         GlobalClickBox     *online_control_button;
265         vector<string>      online_control_strings;
266
267         GlobalClickBox    *crossfade_time_button;
268         vector<string>     crossfade_time_strings;
269
270         GlobalClickBox    *mmc_id_button;
271         vector<string>     mmc_id_strings;
272
273         Gtk::ToggleButton   preroll_button;
274         Gtk::ToggleButton   postroll_button;
275
276         Gtk::Table          transport_table;
277         Gtk::Table          option_table;
278
279         int  setup_windows ();
280         void setup_session_menu ();
281         void setup_transport ();
282         void setup_clock ();
283         void setup_session_info ();
284         void setup_adjustables ();
285
286         Gtk::MenuBar* make_menubar ();
287         
288         static ARDOUR_UI *theArdourUI;
289
290         void startup ();
291         void shutdown ();
292
293         void finish();
294         int  ask_about_saving_session (const string & why);
295         gint ask_about_save_deleted (GdkEventAny*);
296         void save_session_choice_made (int);
297         int  save_the_session;
298
299         void queue_transport_change ();
300         void map_transport_state ();
301         int32_t do_engine_start ();
302         gint start_engine ();
303         
304         void engine_halted ();
305         void engine_stopped ();
306         void engine_running ();
307
308         void clear_meters ();
309
310         static gint _blink  (void *);
311         void blink ();
312         gint blink_timeout_tag;
313         bool blink_on;
314         void start_blinking ();
315         void stop_blinking ();
316
317         void control_methods_adjusted ();
318         void mmc_device_id_adjusted ();
319
320   private:
321         Gtk::VBox     top_packer;
322
323         sigc::connection clock_signal_connection;
324         void         update_clocks ();
325         void         start_clocking ();
326         void         stop_clocking ();
327
328         void manage_window (Gtk::Window&);
329         
330         AudioClock   big_clock;
331         Gtk::Frame   big_clock_frame;
332         Gtk::Window* big_clock_window;
333
334         /* Transport Control */
335
336         void detach_tearoff (Gtk::Box* parent, Gtk::Widget* contents);
337         void reattach_tearoff (Gtk::Box* parent, Gtk::Widget* contents, int32_t order);
338
339         Gtkmm2ext::TearOff*      transport_tearoff;
340         Gtk::Frame               transport_frame;
341         Gtk::HBox                transport_tearoff_hbox;
342         Gtk::HBox                transport_hbox;
343         Gtk::Fixed               transport_base;
344         Gtk::Fixed               transport_button_base;
345         Gtk::Frame               transport_button_frame;
346         Gtk::HBox                transport_button_hbox;
347         Gtk::VBox                transport_button_vbox;
348         Gtk::HBox                transport_option_button_hbox;
349         Gtk::VBox                transport_option_button_vbox;
350         Gtk::HBox                transport_clock_hbox;
351         Gtk::VBox                transport_clock_vbox;
352         Gtk::HBox                primary_clock_hbox;
353         Gtk::HBox                secondary_clock_hbox;
354
355         Gtkmm2ext::StatefulButton roll_button;
356         Gtkmm2ext::StatefulButton stop_button;
357         Gtkmm2ext::StatefulButton rewind_button;
358         Gtkmm2ext::StatefulButton forward_button;
359         Gtkmm2ext::StatefulButton goto_start_button;
360         Gtkmm2ext::StatefulButton goto_end_button;
361         Gtkmm2ext::StatefulButton auto_loop_button;
362         Gtkmm2ext::StatefulButton play_selection_button;
363
364         Gtkmm2ext::StatefulButton rec_button;
365
366         Gtk::ToggleButton time_master_button;
367         Gtk::ComboBoxText sync_option_combo;
368
369         void sync_option_changed ();
370         void toggle_time_master ();
371
372         enum ShuttleBehaviour {
373                 Sprung,
374                 Wheel
375         };
376
377         enum ShuttleUnits {
378                 Percentage,
379                 Semitones
380         };
381
382         Gtk::DrawingArea  shuttle_box;
383         Gtk::EventBox     speed_display_box;
384         Gtk::Label        speed_display_label;
385         Gtk::Button       shuttle_units_button;
386         Gtk::ComboBoxText shuttle_style_button;
387         Gtk::Menu*        shuttle_unit_menu;
388         Gtk::Menu*        shuttle_style_menu;
389         ShuttleBehaviour  shuttle_behaviour;
390         ShuttleUnits      shuttle_units;
391         float             shuttle_max_speed;
392         Gtk::Menu*        shuttle_context_menu;
393
394         void build_shuttle_context_menu ();
395         void show_shuttle_context_menu ();
396         void shuttle_style_changed();
397         void shuttle_unit_clicked ();
398         void set_shuttle_behaviour (ShuttleBehaviour);
399         void set_shuttle_units (ShuttleUnits);
400         void set_shuttle_max_speed (float);
401         void update_speed_display ();
402         float last_speed_displayed;
403
404         gint shuttle_box_button_press (GdkEventButton*);
405         gint shuttle_box_button_release (GdkEventButton*);
406         gint shuttle_box_motion (GdkEventMotion*);
407         gint shuttle_box_expose (GdkEventExpose*);
408         gint mouse_shuttle (double x, bool force);
409         void use_shuttle_fract (bool force);
410
411         bool   shuttle_grabbed;
412         double shuttle_fract;
413
414         Gtk::ToggleButton punch_in_button;
415         Gtk::ToggleButton punch_out_button;
416         Gtk::ToggleButton auto_return_button;
417         Gtk::ToggleButton auto_play_button;
418         Gtk::ToggleButton auto_input_button;
419         Gtk::ToggleButton click_button;
420         Gtk::ToggleButton auditioning_alert_button;
421         Gtk::ToggleButton solo_alert_button;
422
423         Gtk::VBox alert_box;
424         
425         void solo_blink (bool);
426         void audition_blink (bool);
427
428         void soloing_changed (bool);
429         void auditioning_changed (bool);
430         void _auditioning_changed (bool);
431
432         void solo_alert_toggle ();
433         void audition_alert_toggle ();
434
435         void primary_clock_value_changed ();
436         void secondary_clock_value_changed ();
437
438         /* called by Blink signal */
439
440         void transport_rec_enable_blink (bool onoff);
441
442         /* These change where we accept control from:
443            MMC, X (local) or both.
444         */
445
446         void allow_mmc_only ();
447         void allow_mmc_and_local ();
448         void allow_local_only ();
449
450         static void rate_printer (char buf[32], Gtk::Adjustment &, void *);
451
452         Gtk::Menu*        session_popup_menu;
453
454         struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
455             RecentSessionModelColumns() { 
456                     add (visible_name);
457                     add (fullpath);
458             }
459             Gtk::TreeModelColumn<Glib::ustring> visible_name;
460             Gtk::TreeModelColumn<Glib::ustring> fullpath;
461         };
462
463         RecentSessionModelColumns    recent_session_columns;
464         Gtk::TreeView                recent_session_display;
465         Glib::RefPtr<Gtk::TreeStore> recent_session_model;
466
467         ArdourDialog*     session_selector_window;
468         Gtk::FileChooserDialog* open_session_selector;
469         
470         void build_session_selector();
471         void recent_session_selection_changed ();
472         void redisplay_recent_sessions();
473
474         struct RecentSessionsSorter {
475             bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
476                     return cmp_nocase(a.first, b.first) == -1;
477             }
478         };
479
480         /* menu bar and associated stuff */
481
482         Gtk::MenuBar* menu_bar;
483         Gtk::EventBox menu_bar_base;
484         Gtk::HBox     menu_hbox;
485
486         void build_menu_bar ();
487         void pack_toplevel_controls();
488
489         Gtk::Label   wall_clock_label;
490         Gtk::EventBox wall_clock_box;
491         gint update_wall_clock ();
492
493         Gtk::Label   disk_space_label;
494         Gtk::EventBox disk_space_box;
495         void update_disk_space ();
496
497         Gtk::Label   cpu_load_label;
498         Gtk::EventBox cpu_load_box;
499         void update_cpu_load ();
500
501         Gtk::Label   disk_rate_label;
502         Gtk::EventBox disk_rate_box;
503         void update_disk_rate();
504
505         Gtk::Label   buffer_load_label;
506         Gtk::EventBox buffer_load_box;
507         void update_buffer_load ();
508
509         Gtk::Label   sample_rate_label;
510         Gtk::EventBox sample_rate_box;
511         void update_sample_rate (jack_nframes_t);
512
513         gint every_second ();
514         gint every_point_one_seconds ();
515         gint every_point_zero_one_seconds ();
516
517         sigc::connection second_connection;
518         sigc::connection point_one_second_connection;
519         sigc::connection point_zero_one_second_connection;
520
521         void diskstream_added (ARDOUR::DiskStream*);
522
523         gint session_menu (GdkEventButton *);
524
525         bool _will_create_new_session_automatically;
526
527         GladeRef m_new_session_dialog_ref;
528         NewSessionDialog* m_new_session_dialog;
529         
530         void open_session ();
531         void open_recent_session ();
532         void open_ok_clicked ();
533
534         void save_template ();
535
536
537         void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode);
538
539         void add_diskstream_to_menu (ARDOUR::DiskStream&);
540         void diskstream_selected (gint32);
541         Gtk::Menu *diskstream_menu;
542         gint32 selected_dstream;
543         
544         void set_transport_sensitivity (bool);
545
546         void remove_last_capture ();
547
548         void transport_goto_zero ();
549         void transport_goto_start ();
550         void transport_goto_end ();
551         void transport_stop ();
552         void transport_stop_and_forget_capture ();
553         void transport_record ();
554         void transport_roll ();
555         void transport_play_selection(); 
556         void transport_forward (int option);
557         void transport_rewind (int option);
558         void transport_loop ();
559
560         void transport_locating ();
561         void transport_rolling ();
562         void transport_rewinding ();
563         void transport_forwarding ();
564         void transport_stopped ();
565
566         void send_all_midi_feedback ();
567         
568         bool _session_is_new;
569         void connect_to_session (ARDOUR::Session *);
570         void connect_dependents_to_session (ARDOUR::Session *);
571         void we_have_dependents ();
572         void setup_keybindings ();
573         void setup_options ();
574         
575         guint32  last_key_press_time;
576
577         void snapshot_session ();
578
579         void map_record_state ();
580         void queue_map_record_state ();
581
582         Mixer_UI   *mixer;
583         int         create_mixer ();
584         
585         PublicEditor     *editor;
586         int         create_editor ();
587
588         RouteParams_UI *route_params;
589         int             create_route_params ();
590
591         ConnectionEditor *connection_editor;
592         int               create_connection_editor ();
593
594         LocationUI *location_ui;
595         int         create_location_ui ();
596         void        handle_locations_change (ARDOUR::Location*);
597
598         ColorManager* color_manager;
599
600         /* Options window */
601         
602         OptionEditor *option_editor;
603         
604         /* route dialog */
605
606         AddRouteDialog *add_route_dialog;
607         void add_route_dialog_done (int status);
608
609         /* SoundFile Browser */
610         SoundFileBrowser *sfdb;
611         void toggle_sound_file_browser ();
612         int create_sound_file_browser ();
613         
614         /* Keyboard Handling */
615         
616         Keyboard* keyboard;
617
618         /* Keymap handling */
619
620         void install_keybindings ();
621         Glib::RefPtr<Gtk::ActionGroup> get_common_actions();
622         void install_actions ();
623         void test_binding_action (const char *);
624         void start_keyboard_prefix();
625
626         void toggle_record_enable (guint32);
627         void toggle_monitor_enable (guint32);
628
629         uint32_t rec_enabled_diskstreams;
630         void count_recenabled_diskstreams (ARDOUR::DiskStream&);
631
632         About* about;
633         bool shown_flag;
634         /* cleanup */
635
636         Gtk::MenuItem *cleanup_item;
637
638         void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
639         void cleanup ();
640         void flush_trash ();
641
642         bool have_configure_timeout;
643         struct timeval last_configure_time;
644         gint configure_timeout ();
645
646         struct timeval last_peak_grab;
647         struct timeval last_shuttle_request;
648
649         void cannot_record_no_input (ARDOUR::DiskStream*);
650
651         void delete_sources_in_the_right_thread (list<ARDOUR::Source*>*);
652
653         void editor_display_control_changed (Editing::DisplayControl c);
654
655         bool have_disk_overrun_displayed;
656         bool have_disk_underrun_displayed;
657
658         void disk_overrun_message_gone ();
659         void disk_underrun_message_gone ();
660         void disk_overrun_handler ();
661         void disk_underrun_handler ();
662
663         int pending_state_dialog ();
664         
665         void disconnect_from_jack ();
666         void reconnect_to_jack ();
667         void set_jack_buffer_size (jack_nframes_t);
668
669         Gtk::MenuItem* jack_disconnect_item;
670         Gtk::MenuItem* jack_reconnect_item;
671         Gtk::Menu*     jack_bufsize_menu;
672
673         int make_session_clean ();
674         bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
675
676         Glib::RefPtr<Gtk::ActionGroup> common_actions;
677
678         void editor_realized ();
679
680         std::vector<std::string> positional_sync_strings;
681
682         void toggle_config_state (const char* group, const char* action, void (ARDOUR::Configuration::*set)(bool));
683         void toggle_session_state (const char* group, const char* action, void (ARDOUR::Session::*set)(bool), bool (ARDOUR::Session::*get)(void) const);
684         void toggle_session_state (const char* group, const char* action, sigc::slot<void> theSlot);
685         void toggle_send_midi_feedback ();
686         void toggle_use_mmc ();
687         void toggle_send_mmc ();
688         void toggle_use_midi_control();
689         void toggle_send_mtc ();
690
691         void toggle_AutoConnectNewTrackInputsToHardware();
692         void toggle_AutoConnectNewTrackOutputsToHardware();
693         void toggle_AutoConnectNewTrackOutputsToMaster();
694         void toggle_ManuallyConnectNewTrackOutputs();
695         void toggle_UseHardwareMonitoring();
696         void toggle_UseSoftwareMonitoring();
697         void toggle_UseExternalMonitoring();
698         void toggle_StopPluginsWithTransport();
699         void toggle_DoNotRunPluginsWhileRecording();
700         void toggle_VerifyRemoveLastCapture();
701         void toggle_StopRecordingOnXrun();
702         void toggle_StopTransportAtEndOfSession();
703         void toggle_GainReduceFastTransport();
704         void toggle_LatchedSolo();
705         void toggle_SoloViaBus();
706         void toggle_AutomaticallyCreateCrossfades();
707         void toggle_UnmuteNewFullCrossfades();
708         void toggle_LatchedRecordEnable ();
709
710         void mtc_port_changed ();
711         void map_some_session_state (const char* group, const char* action, bool (ARDOUR::Session::*get)() const);
712         void queue_session_control_changed (ARDOUR::Session::ControlType t);
713         void session_control_changed (ARDOUR::Session::ControlType t);
714         
715 };
716
717
718 #endif /* __ardour_gui_h__ */