Add session preferences dialog.
[ardour.git] / gtk2_ardour / ardour_ui.h
index b99c422dca1e9fa73de6d86b66705171063060b4..a1a36f3d99d602f6a8078e14273f77b0cd9d948c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 1999-2002 Paul Davis 
+    Copyright (C) 1999-2002 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -20,6 +20,8 @@
 #ifndef __ardour_gui_h__
 #define __ardour_gui_h__
 
+#include <time.h>
+
 /* need _BSD_SOURCE to get timersub macros */
 
 #ifdef _BSD_SOURCE
 #endif
 
 #include <list>
-
 #include <cmath>
 
 #include <libgnomecanvasmm/canvas.h>
 
-#include <pbd/xml++.h>
+#include "pbd/xml++.h"
+#include "pbd/controllable.h"
 #include <gtkmm/box.h>
 #include <gtkmm/frame.h>
 #include <gtkmm/label.h>
 #include <gtkmm/togglebutton.h>
 #include <gtkmm/treeview.h>
 #include <gtkmm/menubar.h>
+#include <gtkmm/textbuffer.h>
 #include <gtkmm/adjustment.h>
 #include <gtkmm2ext/gtk_ui.h>
 #include <gtkmm2ext/click_box.h>
 #include <gtkmm2ext/stateful_button.h>
 #include <gtkmm2ext/bindable_button.h>
-#include <ardour/ardour.h>
-#include <ardour/session.h>
+#include "ardour/ardour.h"
+#include "ardour/session.h"
+#include "ardour/types.h"
 
 #include "audio_clock.h"
 #include "ardour_dialog.h"
 #include "editing.h"
+#include "ui_config.h"
 
 class AudioClock;
 class PublicEditor;
 class Keyboard;
-class OptionEditor;
+class RCOptionEditor;
+class SessionOptionEditor;
+class KeyEditor;
 class Mixer_UI;
 class ConnectionEditor;
 class RouteParams_UI;
 class About;
+class Splash;
 class AddRouteDialog;
-class NewSessionDialog;
 class LocationUI;
-class ColorManager;
+class ThemeManager;
+class BundleManager;
+class ArdourStartup;
 
 namespace Gtkmm2ext {
        class TearOff;
@@ -93,22 +102,32 @@ namespace ALSA {
 
 #define FRAME_NAME "BaseFrame"
 
+extern sigc::signal<void>  ColorsChanged;
+extern sigc::signal<void>  DPIReset;
+
 class ARDOUR_UI : public Gtkmm2ext::UI
 {
   public:
-       ARDOUR_UI (int *argcp, char **argvp[], string rcfile);
+       ARDOUR_UI (int *argcp, char **argvp[]);
        ~ARDOUR_UI();
 
+       void run_startup (bool should_be_new);
+
        void show ();
        bool shown() { return shown_flag; }
-       
+
        void show_splash ();
        void hide_splash ();
-       
-       int load_session (const string & path, const string & snapshot, string* mix_template = 0);
+
+       void show_about ();
+       void hide_about ();
+
+       void finish();
+
+       int load_session (const Glib::ustring& path, const Glib::ustring& snapshot, Glib::ustring mix_template = Glib::ustring());
        bool session_loaded;
-       int build_session (const string & path, const string & snapshot, 
-                          uint32_t ctl_chns, 
+       int build_session (const Glib::ustring& path, const Glib::ustring& snapshot,
+                          uint32_t ctl_chns,
                           uint32_t master_chns,
                           ARDOUR::AutoConnectOption input_connect,
                           ARDOUR::AutoConnectOption output_connect,
@@ -126,28 +145,36 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void set_will_create_new_session_automatically (bool yn) {
                _will_create_new_session_automatically = yn;
        }
+       
+       int get_session_parameters (bool should_be_new = false);
+       void parse_cmdline_path (const Glib::ustring& cmdline_path, Glib::ustring& session_name, Glib::ustring& session_path, bool& existing_session);
+       int  load_cmdline_session (const Glib::ustring& session_name, const Glib::ustring& session_path, bool& existing_session);
+       int  build_session_from_nsd (const Glib::ustring& session_name, const Glib::ustring& session_path);
+       bool ask_about_loading_existing_session (const Glib::ustring& session_path);
 
-        bool new_session(std::string path = string());
-       gint cmdline_new_session (string path);
-       int  unload_session ();
-       void close_session(); 
+       /// @return true if session was successfully unloaded.
+       int unload_session (bool hide_stuff = false);
+       void close_session();
 
-       int  save_state_canfail (string state_name = "");
-       void save_state (const string & state_name = "");
-       void restore_state (string state_name = "");
+       int  save_state_canfail (std::string state_name = "");
+       void save_state (const std::string & state_name = "");
 
        static double gain_to_slider_position (ARDOUR::gain_t g);
-        static ARDOUR::gain_t slider_position_to_gain (double pos);
+       static ARDOUR::gain_t slider_position_to_gain (double pos);
 
        static ARDOUR_UI *instance () { return theArdourUI; }
+       static UIConfiguration *config () { return ui_config; }
 
        PublicEditor&     the_editor(){return *editor;}
        Mixer_UI* the_mixer() { return mixer; }
-       
+
+       ARDOUR::AudioEngine& the_engine() const { return *engine; }
+
+       void toggle_key_editor ();
        void toggle_location_window ();
-       void toggle_color_manager ();
+       void toggle_theme_manager ();
+       void toggle_bundle_manager ();
        void toggle_big_clock_window ();
-       void toggle_connection_editor ();
        void toggle_route_params_window ();
        void toggle_editing_space();
 
@@ -156,17 +183,9 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        static sigc::signal<void,bool> Blink;
        static sigc::signal<void>      RapidScreenUpdate;
        static sigc::signal<void>      SuperRapidScreenUpdate;
-       static sigc::signal<void,nframes_t> Clock;
-
-       /* this is a helper function to centralize the (complex) logic for
-          blinking rec-enable buttons.
-       */
+       static sigc::signal<void,nframes_t, bool, nframes_t> Clock;
 
-       void rec_enable_button_blink (bool onoff, ARDOUR::AudioDiskstream *, Gtk::Widget *w);
-
-       void name_io_setup (ARDOUR::AudioEngine&, string&, ARDOUR::IO& io, bool in);
-
-       static gint hide_and_quit (GdkEventAny *ev, ArdourDialog *);
+       void name_io_setup (ARDOUR::AudioEngine&, std::string&, ARDOUR::IO& io, bool in);
 
        XMLNode* editor_settings() const;
        XMLNode* mixer_settings () const;
@@ -177,6 +196,8 @@ class ARDOUR_UI : public Gtkmm2ext::UI
 
        void do_transport_locate (nframes_t position);
        void halt_on_xrun_message ();
+       void xrun_handler (nframes_t);
+       void create_xrun_marker (nframes_t);
 
        AudioClock primary_clock;
        AudioClock secondary_clock;
@@ -187,7 +208,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void restore_clock_modes ();
 
        void add_route (Gtk::Window* float_window);
-       
+
        void session_add_audio_track (int input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many) {
                session_add_audio_route (true, input_channels, output_channels, mode, how_many);
        }
@@ -196,10 +217,16 @@ class ARDOUR_UI : public Gtkmm2ext::UI
                session_add_audio_route (false, input_channels, output_channels, ARDOUR::Normal, how_many);
        }
 
-       void session_add_midi_track ();
+       void session_add_midi_track (uint32_t how_many) {
+               session_add_midi_route (true, how_many);
+       }
+
+       /*void session_add_midi_bus () {
+               session_add_midi_route (false);
+       }*/
 
-       void set_engine (ARDOUR::AudioEngine&);
-       gint start_engine ();
+       int  create_engine ();
+       void post_engine ();
 
        gint exit_on_main_window_close (GdkEventAny *);
 
@@ -209,10 +236,10 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void set_native_file_header_format (ARDOUR::HeaderFormat sf);
        void set_native_file_data_format (ARDOUR::SampleFormat sf);
 
-       void set_keybindings_path (std::string path);
-       void save_keybindings ();
-
        void setup_profile ();
+       void setup_theme ();
+
+       void set_shuttle_fract (double);
 
   protected:
        friend class PublicEditor;
@@ -220,78 +247,44 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void toggle_clocking ();
        void toggle_auto_play ();
        void toggle_auto_input ();
+       void toggle_punch ();
+       void unset_dual_punch ();
+       bool ignore_dual_punch;
        void toggle_punch_in ();
        void toggle_punch_out ();
        void toggle_auto_return ();
        void toggle_click ();
 
        void toggle_session_auto_loop ();
-       
-       void toggle_options_window ();
 
-  private:
-       struct GlobalClickBox : public Gtk::VBox {
-           Gtkmm2ext::ClickBox  *box;
-           Gtk::Frame      frame;
-           Gtk::Label      label;
-           vector<string> &strings;
-           Gtk::Adjustment adjustment;
-
-           static void printer (char buf[32], Gtk::Adjustment &adj, void *arg);
-
-           GlobalClickBox (const string &str, vector<string> &vs)
-                   : strings (vs),
-                     adjustment (0, 0, vs.size() - 1, 1, 1, 0) {
-                   box = new Gtkmm2ext::ClickBox (&adjustment, "ClickButton");
-                   label.set_text (str);
-                   label.set_name ("GlobalButtonLabel");
-                   frame.add (*box);
-                   frame.set_shadow_type (Gtk::SHADOW_IN);
-                   pack_start (label);
-                   pack_start (frame);
-                   box->set_print_func (printer, this);
-                   box->set_wrap (true);
-           };
-       };
-
-       ARDOUR::AudioEngine                 *engine;
-       ARDOUR::Session                     *session;
-
-       bool check_audioengine();
+       void toggle_rc_options_window ();
+       void toggle_session_options_window ();
 
-       Gtk::Tooltips          _tooltips;
-
-       void                     goto_editor_window ();
-       void                     goto_mixer_window ();
-       
-       Gtk::Table               adjuster_table;
-       Gtk::Frame               adjuster_frame;
-       Gtk::Fixed               adjuster_base;
-
-       GlobalClickBox     *online_control_button;
-       vector<string>      online_control_strings;
+  private:
+       ArdourStartup*      _startup;
+       ARDOUR::AudioEngine *engine;
+       ARDOUR::Session      *session;
+       Gtk::Tooltips        _tooltips;
 
-       GlobalClickBox    *crossfade_time_button;
-       vector<string>     crossfade_time_strings;
+       void                goto_editor_window ();
+       void                goto_mixer_window ();
+       void                toggle_editor_mixer_on_top ();
+       bool                _mixer_on_top;
 
        Gtk::ToggleButton   preroll_button;
        Gtk::ToggleButton   postroll_button;
 
-       Gtk::Table          transport_table;
-       Gtk::Table          option_table;
-
        int  setup_windows ();
        void setup_transport ();
        void setup_clock ();
 
        static ARDOUR_UI *theArdourUI;
 
+       void backend_audio_error (bool we_set_params, Gtk::Window* toplevel = 0);
        void startup ();
        void shutdown ();
 
-       void finish();
-       int  ask_about_saving_session (const string & why);
-       int  save_the_session;
+       int  ask_about_saving_session (const std::string & why);
 
        /* periodic safety backup, to be precise */
        gint autosave_session();
@@ -301,7 +294,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void queue_transport_change ();
        void map_transport_state ();
        int32_t do_engine_start ();
-       
+
        void engine_halted ();
        void engine_stopped ();
        void engine_running ();
@@ -326,11 +319,13 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void         stop_clocking ();
 
        void manage_window (Gtk::Window&);
-       
+
        AudioClock   big_clock;
-       Gtk::Frame   big_clock_frame;
        Gtk::Window* big_clock_window;
 
+       void float_big_clock (Gtk::Window* parent);
+       bool main_window_state_event_handler (GdkEventWindowState*, bool window_was_editor);
+
        void update_transport_clocks (nframes_t pos);
        void record_state_changed ();
 
@@ -366,27 +361,27 @@ class ARDOUR_UI : public Gtkmm2ext::UI
                    AutoLoop,
                    PlaySelection,
                    ShuttleControl
-                   
+
            };
-           
+
            TransportControllable (std::string name, ARDOUR_UI&, ToggleType);
            void set_value (float);
            float get_value (void) const;
-           
+
            void set_id (const std::string&);
-           
+
            ARDOUR_UI& ui;
            ToggleType type;
        };
 
-       TransportControllable roll_controllable;
-       TransportControllable stop_controllable;
-       TransportControllable goto_start_controllable;
-       TransportControllable goto_end_controllable;
-       TransportControllable auto_loop_controllable;
-       TransportControllable play_selection_controllable;
-       TransportControllable rec_controllable;
-       TransportControllable shuttle_controllable;
+       boost::shared_ptr<TransportControllable> roll_controllable;
+       boost::shared_ptr<TransportControllable> stop_controllable;
+       boost::shared_ptr<TransportControllable> goto_start_controllable;
+       boost::shared_ptr<TransportControllable> goto_end_controllable;
+       boost::shared_ptr<TransportControllable> auto_loop_controllable;
+       boost::shared_ptr<TransportControllable> play_selection_controllable;
+       boost::shared_ptr<TransportControllable> rec_controllable;
+       boost::shared_ptr<TransportControllable> shuttle_controllable;
        BindingProxy shuttle_controller_binding_proxy;
 
        void set_transport_controllable_state (const XMLNode&);
@@ -431,7 +426,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        gint shuttle_box_expose (GdkEventExpose*);
        gint mouse_shuttle (double x, bool force);
        void use_shuttle_fract (bool force);
-       void set_shuttle_fract (double);
 
        bool   shuttle_grabbed;
        double shuttle_fract;
@@ -448,7 +442,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        Gtk::ToggleButton solo_alert_button;
 
        Gtk::VBox alert_box;
-       
+
        void solo_blink (bool);
        void audition_blink (bool);
 
@@ -459,6 +453,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void solo_alert_toggle ();
        void audition_alert_toggle ();
 
+       void big_clock_value_changed ();
        void primary_clock_value_changed ();
        void secondary_clock_value_changed ();
 
@@ -469,7 +464,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        Gtk::Menu*        session_popup_menu;
 
        struct RecentSessionModelColumns : public Gtk::TreeModel::ColumnRecord {
-           RecentSessionModelColumns() { 
+           RecentSessionModelColumns() {
                    add (visible_name);
                    add (fullpath);
            }
@@ -483,13 +478,13 @@ class ARDOUR_UI : public Gtkmm2ext::UI
 
        ArdourDialog*     session_selector_window;
        Gtk::FileChooserDialog* open_session_selector;
-       
+
        void build_session_selector();
        void redisplay_recent_sessions();
        void recent_session_row_activated (const Gtk::TreePath& path, Gtk::TreeViewColumn* col);
 
        struct RecentSessionsSorter {
-           bool operator() (std::pair<string,string> a, std::pair<string,string> b) const {
+               bool operator() (std::pair<std::string,std::string> a, std::pair<std::string,std::string> b) const {
                    return cmp_nocase(a.first, b.first) == -1;
            }
        };
@@ -500,6 +495,7 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        Gtk::EventBox menu_bar_base;
        Gtk::HBox     menu_hbox;
 
+       void use_menubar_as_top_menubar ();
        void build_menu_bar ();
        void build_control_surface_menu ();
 
@@ -536,13 +532,15 @@ class ARDOUR_UI : public Gtkmm2ext::UI
 
        bool _will_create_new_session_automatically;
 
-       NewSessionDialog* new_session_dialog;
-       
        void open_session ();
        void open_recent_session ();
        void save_template ();
+       
+       void edit_metadata ();
+       void import_metadata ();
 
        void session_add_audio_route (bool disk, int32_t input_channels, int32_t output_channels, ARDOUR::TrackMode mode, uint32_t how_many);
+       void session_add_midi_route (bool disk, uint32_t how_many);
 
        void set_transport_sensitivity (bool);
 
@@ -551,11 +549,12 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void transport_goto_zero ();
        void transport_goto_start ();
        void transport_goto_end ();
+       void transport_goto_wallclock ();
        void transport_stop ();
        void transport_stop_and_forget_capture ();
-       void transport_record ();
+       void transport_record (bool roll);
        void transport_roll ();
-       void transport_play_selection(); 
+       void transport_play_selection();
        void transport_forward (int option);
        void transport_rewind (int option);
        void transport_loop ();
@@ -569,44 +568,48 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void connect_to_session (ARDOUR::Session *);
        void connect_dependents_to_session (ARDOUR::Session *);
        void we_have_dependents ();
-       
-       std::string keybindings_path;
 
-       void setup_keybindings ();
        void setup_session_options ();
-       
+
        guint32  last_key_press_time;
 
        void snapshot_session ();
 
        Mixer_UI   *mixer;
        int         create_mixer ();
-       
+
        PublicEditor     *editor;
        int         create_editor ();
 
        RouteParams_UI *route_params;
        int             create_route_params ();
 
-       ConnectionEditor *connection_editor;
-       int               create_connection_editor ();
+       BundleManager *bundle_manager;
+       void create_bundle_manager ();
 
        LocationUI *location_ui;
        int         create_location_ui ();
        void        handle_locations_change (ARDOUR::Location*);
 
-       ColorManager* color_manager;
+       static UIConfiguration *ui_config;
+       ThemeManager *theme_manager;
+
+       /* Key bindings editor */
+
+       KeyEditor *key_editor;
+
+       /* RC Options window */
+
+       RCOptionEditor *rc_option_editor;
+
+       SessionOptionEditor *session_option_editor;
 
-       /* Options window */
-       
-       OptionEditor *option_editor;
-       
        /* route dialog */
 
        AddRouteDialog *add_route_dialog;
-       
+
        /* Keyboard Handling */
-       
+
        Keyboard* keyboard;
 
        /* Keymap handling */
@@ -619,29 +622,47 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void count_recenabled_streams (ARDOUR::Route&);
 
        About* about;
+       Splash* splash;
+       void pop_back_splash ();
        bool shown_flag;
+
        /* cleanup */
 
        Gtk::MenuItem *cleanup_item;
 
-       void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const string & msg);
+       void display_cleanup_results (ARDOUR::Session::cleanup_report& rep, const gchar* list_title, const std::string & msg);
        void cleanup ();
        void flush_trash ();
 
        bool have_configure_timeout;
-       struct timeval last_configure_time;
+       ARDOUR::microseconds_t last_configure_time;
        gint configure_timeout ();
 
-       struct timeval last_peak_grab;
-       struct timeval last_shuttle_request;
+       ARDOUR::microseconds_t last_peak_grab;
+       ARDOUR::microseconds_t last_shuttle_request;
+
+       struct DiskBufferStat {
+           time_t when;
+           uint32_t capture;
+           uint32_t playback;
+
+           DiskBufferStat (time_t w, uint32_t c, uint32_t p) 
+           : when (w), capture (c), playback (p) {}
+       };
+       
+       std::list<DiskBufferStat> disk_buffer_stats;
+       void push_buffer_stats (uint32_t, uint32_t);
+       void write_buffer_stats ();
 
        bool have_disk_speed_dialog_displayed;
        void disk_speed_dialog_gone (int ignored_response, Gtk::MessageDialog*);
        void disk_overrun_handler ();
        void disk_underrun_handler ();
 
+       void session_dialog (std::string);
        int pending_state_dialog ();
-       
+       int sr_mismatch_dialog (nframes_t, nframes_t);
+
        void disconnect_from_jack ();
        void reconnect_to_jack ();
        void set_jack_buffer_size (nframes_t);
@@ -650,9 +671,6 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        Gtk::MenuItem* jack_reconnect_item;
        Gtk::Menu*     jack_bufsize_menu;
 
-       int make_session_clean ();
-       bool filter_ardour_session_dirs (const Gtk::FileFilter::Info&);
-
        Glib::RefPtr<Gtk::ActionGroup> common_actions;
 
        void editor_realized ();
@@ -663,36 +681,56 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void toggle_use_mmc ();
        void toggle_send_mmc ();
        void toggle_send_mtc ();
+       void toggle_send_midi_clock ();
 
        void toggle_use_osc ();
 
+       void toggle_denormal_protection ();
+
        void set_input_auto_connect (ARDOUR::AutoConnectOption);
        void set_output_auto_connect (ARDOUR::AutoConnectOption);
        void set_solo_model (ARDOUR::SoloModel);
        void set_monitor_model (ARDOUR::MonitorModel);
        void set_remote_model (ARDOUR::RemoteModel);
+       void set_denormal_model (ARDOUR::DenormalModel);
 
+       void toggle_sync_order_keys ();
+       void toggle_new_plugins_active();
        void toggle_StopPluginsWithTransport();
        void toggle_DoNotRunPluginsWhileRecording();
        void toggle_VerifyRemoveLastCapture();
        void toggle_PeriodicSafetyBackups();
        void toggle_StopRecordingOnXrun();
+       void toggle_CreateXrunMarker();
        void toggle_StopTransportAtEndOfSession();
        void toggle_GainReduceFastTransport();
        void toggle_LatchedSolo();
        void toggle_ShowSoloMutes();
+       void toggle_SoloMuteOverride();
        void toggle_LatchedRecordEnable ();
        void toggle_RegionEquivalentsOverlap ();
+       void toggle_PrimaryClockDeltaEditCursor ();
+       void toggle_SecondaryClockDeltaEditCursor ();
+       void toggle_ShowTrackMeters ();
+       void toggle_only_copy_imported_files ();
+       void toggle_use_narrow_ms();
+       void toggle_NameNewMarkers ();
+       void toggle_rubberbanding_snaps_to_grid ();
+       void toggle_auto_analyse_audio ();
+       void toggle_TapeMachineMode();
 
        void mtc_port_changed ();
        void map_solo_model ();
        void map_monitor_model ();
+       void map_denormal_model ();
+       void map_denormal_protection ();
        void map_remote_model ();
        void map_file_header_format ();
        void map_file_data_format ();
        void map_input_auto_connect ();
        void map_output_auto_connect ();
-       void parameter_changed (const char*);
+       void map_only_copy_imported_files ();
+       void parameter_changed (std::string);
 
        void set_meter_hold (ARDOUR::MeterHold);
        void set_meter_falloff (ARDOUR::MeterFalloff);
@@ -702,11 +740,25 @@ class ARDOUR_UI : public Gtkmm2ext::UI
        void toggle_control_protocol (ARDOUR::ControlProtocolInfo*);
        void toggle_control_protocol_feedback (ARDOUR::ControlProtocolInfo*, const char* group_name, std::string action_name);
 
-       bool can_save_keybindings;
        bool first_idle ();
 
        void no_memory_warning ();
        void check_memory_locking ();
+
+       bool check_audioengine();
+       void audioengine_setup ();
+
+       void display_message (const char *prefix, gint prefix_len,
+                             Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag, const char *msg);
+       Gtk::Label status_bar_label;
+       Gtk::ToggleButton error_log_button;
+
+       void loading_message (const std::string& msg);
+       void end_loading_messages ();
+
+       void platform_specific ();
+       void platform_setup ();
+       void fontconfig_dialog ();
 };
 
 #endif /* __ardour_gui_h__ */