Do not try to restore Route solo state after clearing all solo state
[ardour.git] / gtk2_ardour / public_editor.h
index af66415a6589fecdae0221183557f2680e5d9105..fb6da74dbf085788e516996988ba948b9c7438b6 100644 (file)
 #include <gtkmm/box.h>
 #include <gtkmm/window.h>
 #include <gtkmm/actiongroup.h>
+#include <gtkmm/notebook.h>
 #include <sigc++/signal.h>
 
-#include "evoral/types.hpp"
+#include "evoral/Beats.hpp"
+#include "evoral/Note.hpp"
 
 #include "pbd/statefuldestructible.h"
 
 #include "canvas/fwd.h"
+
+#include "gtkmm2ext/actions.h"
+#include "gtkmm2ext/bindings.h"
+#include "gtkmm2ext/tabbable.h"
 #include "gtkmm2ext/visibility_tracker.h"
 
 #include "editing.h"
@@ -51,6 +57,7 @@ namespace ARDOUR {
        class RouteGroup;
         class Trimmable;
         class Movable;
+        class Stripable;
 }
 
 namespace Gtk {
@@ -58,17 +65,13 @@ namespace Gtk {
        class Menu;
 }
 
-namespace Gtkmm2ext {
-        class TearOff;
-}
-
 class AudioRegionView;
 class AutomationLine;
 class AutomationTimeAxisView;
 class ControlPoint;
 class DragManager;
 class Editor;
-class Marker;
+class ArdourMarker;
 class MeterMarker;
 class MouseCursors;
 class PlaylistSelector;
@@ -77,6 +80,7 @@ class PluginUIWindow;
 class RegionView;
 class RouteTimeAxisView;
 class Selection;
+class TempoCurve;
 class TempoMarker;
 class TimeAxisView;
 class TimeAxisViewItem;
@@ -84,6 +88,13 @@ class VerboseCursor;
 class XMLNode;
 struct SelectionRect;
 
+class DisplaySuspender;
+
+namespace ARDOUR_UI_UTILS {
+bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
+bool forward_key_press (GdkEventKey* ev);
+}
+
 using ARDOUR::framepos_t;
 using ARDOUR::framecnt_t;
 
@@ -94,9 +105,9 @@ using ARDOUR::framecnt_t;
  * of PublicEditor need not be recompiled if private methods or member variables
  * change.
  */
-class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, public Gtkmm2ext::VisibilityTracker {
+class PublicEditor : public Gtkmm2ext::Tabbable {
   public:
-       PublicEditor ();
+       PublicEditor (Gtk::Widget& content);
        virtual ~PublicEditor ();
 
        /** @return Singleton PublicEditor instance */
@@ -133,8 +144,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
         */
        virtual void set_snap_threshold (double t) = 0;
 
-       /** Snap a value according to the current snap setting. */
-       virtual void snap_to (framepos_t& first, int32_t direction = 0, bool for_mark = false) = 0;
+       /**
+        * Snap a value according to the current snap setting.
+        * ensure_snap overrides SnapOff and magnetic snap
+        */
+       virtual void snap_to (framepos_t&       first,
+                             ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
+                             bool              for_mark  = false,
+                             bool              ensure_snap = false) = 0;
 
        /** Undo some transactions.
         * @param n Number of transactions to undo.
@@ -164,25 +181,8 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
         */
        virtual Editing::MouseMode current_mouse_mode () const = 0;
 
-       /** Switch into a mode in which editing is primarily focused on "within" regions,
-           rather than regions as black-box objects. For Ardour3, this is aimed at
-           editing MIDI regions but may expand in the future to other types of regions.
-       */
-
-       virtual void set_internal_edit (bool yn) = 0;
-
-       /** Driven by a double-click, switch in or out of a mode in which
-           editing is primarily focused on "within" regions, rather than
-           regions as black-box objects. For Ardour3, this is aimed at editing
-           MIDI regions but may expand in the future to other types of
-           regions.
-       */
-
-       virtual bool toggle_internal_editing_from_double_click (GdkEvent*) = 0;
-
-       /** @return Whether editing is currently in "internal" mode or not
+       /** @return Whether the current mouse mode is an "internal" editing mode.
         */
-
        virtual bool internal_editing() const = 0;
 
        /** Possibly start the audition of a region.  If @param r is 0, or not an AudioRegion
@@ -200,20 +200,28 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual double sample_to_pixel (framepos_t frame) const = 0;
        virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
        virtual Selection& get_selection () const = 0;
+       virtual bool get_selection_extents (framepos_t &start, framepos_t &end) const = 0;
        virtual Selection& get_cut_buffer () const = 0;
        virtual void track_mixer_selection () = 0;
        virtual bool extend_selection_to_track (TimeAxisView&) = 0;
        virtual void play_selection () = 0;
        virtual void play_with_preroll () = 0;
        virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
+       virtual void goto_nth_marker (int nth) = 0;
+       virtual void trigger_script (int nth) = 0;
+       virtual void add_location_from_playhead_cursor () = 0;
+       virtual void remove_location_at_playhead_cursor () = 0;
        virtual void set_show_measures (bool yn) = 0;
        virtual bool show_measures () const = 0;
+       virtual void remove_tracks () = 0;
+       virtual void set_loop_range (framepos_t start, framepos_t end, std::string cmd) = 0;
+       virtual void set_punch_range (framepos_t start, framepos_t end, std::string cmd) = 0;
 
        virtual Editing::MouseMode effective_mouse_mode () const = 0;
 
-        /** Import existing media */
-        virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&) = 0;
-        virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&) = 0;
+       /** Import existing media */
+       virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
+       virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
 
        /** Open main export dialog */
        virtual void export_audio () = 0;
@@ -228,16 +236,17 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual void export_range () = 0;
 
        virtual void register_actions () = 0;
-       virtual void add_toplevel_controls (Gtk::Container&) = 0;
        virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
        virtual Editing::ZoomFocus get_zoom_focus () const = 0;
        virtual framecnt_t get_current_zoom () const = 0;
+       virtual void reset_zoom (framecnt_t) = 0;
        virtual PlaylistSelector& playlist_selector() const = 0;
        virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
        virtual void new_playlists (TimeAxisView*) = 0;
        virtual void copy_playlists (TimeAxisView*) = 0;
        virtual void clear_playlists (TimeAxisView*) = 0;
        virtual void select_all_tracks () = 0;
+       virtual void deselect_all () = 0;
        virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
        virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
        virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
@@ -260,36 +269,37 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
 
        /** @return true if the playhead is currently being dragged, otherwise false */
        virtual bool dragging_playhead () const = 0;
-       virtual void ensure_float (Gtk::Window&) = 0;
-       virtual void show_window () = 0;
        virtual framepos_t leftmost_sample() const = 0;
        virtual framecnt_t current_page_samples() const = 0;
        virtual double visible_canvas_height () const = 0;
        virtual void temporal_zoom_step (bool coarser) = 0;
-        virtual void ensure_time_axis_view_is_visible (const TimeAxisView& tav, bool at_top = false) { 
-           _ensure_time_axis_view_is_visible (tav, at_top);
-       }
+        virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
         virtual void override_visible_track_count () = 0;
        virtual void scroll_tracks_down_line () = 0;
        virtual void scroll_tracks_up_line () = 0;
-        virtual bool scroll_down_one_track () = 0;
-        virtual bool scroll_up_one_track () = 0;
+        virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
+        virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
        virtual void prepare_for_cleanup () = 0;
        virtual void finish_cleanup () = 0;
        virtual void reset_x_origin (framepos_t frame) = 0;
+       virtual double get_y_origin () const = 0;
+       virtual void reset_y_origin (double pos) = 0;
        virtual void remove_last_capture () = 0;
        virtual void maximise_editing_space () = 0;
        virtual void restore_editing_space () = 0;
-       virtual void update_tearoff_visibility () = 0;
-       virtual framepos_t get_preferred_edit_position (bool ignore_playhead = false, bool from_context_menu = false) = 0;
+       virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
        virtual void toggle_meter_updating() = 0;
+       virtual void split_regions_at (framepos_t, RegionSelection&, const int32_t sub_num, bool snap) = 0;
        virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
-       virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false, bool is_xrun=false) = 0;
+       virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
        virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
        virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
        virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
-       virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, framepos_t position) = 0;
-        virtual void edit_notes (TimeAxisViewItem&) = 0;
+       virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
+       virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
+       virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
+       virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
+       virtual void edit_notes (MidiRegionView*) = 0;
 
        virtual void queue_visual_videotimeline_update () = 0;
        virtual void set_close_video_sensitive (bool) = 0;
@@ -300,7 +310,6 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual int  get_videotl_bar_height () const = 0;
        virtual void set_video_timeline_height (const int h) = 0;
        virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
-       virtual void export_video (bool range = false) = 0;
 
        virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
 
@@ -316,8 +325,6 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
        Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 
-       virtual void reset_focus () = 0;
-
        virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
        virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
        virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
@@ -331,15 +338,16 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
        virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
        virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
+       virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
        virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
-       virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
+       virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
        virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
-       virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
        virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
+       virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
        virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
        virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 
@@ -355,23 +363,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        static const int vertical_spacing;
        static const int horizontal_spacing;
 
-#ifdef TOP_MENUBAR
-       /*
-        * This is needed for OS X primarily
-        * but also any other OS that uses a single
-        * top menubar instead of per window menus
-        */
-       virtual Gtk::HBox& get_status_bar_packer() = 0;
-#endif
-
-       virtual ArdourCanvas::Group* get_trackview_group () const = 0;
-       virtual ArdourCanvas::Group* get_hscroll_group () const = 0;
-       virtual ArdourCanvas::Group* get_vscroll_group () const = 0;
-       virtual ArdourCanvas::Group* get_hvscroll_group () const = 0;
+       virtual ArdourCanvas::Container* get_trackview_group () const = 0;
+       virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
+       virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
+       virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
 
         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 
-       virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
+       virtual TimeAxisView* axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable>) const = 0;
 
         virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
         virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
@@ -381,14 +380,20 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
        virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
        virtual TrackViewList const & get_track_views () = 0;
 
-       virtual Gtkmm2ext::TearOff* mouse_mode_tearoff () const = 0;
-       virtual Gtkmm2ext::TearOff* tools_tearoff () const = 0;
-
        virtual DragManager* drags () const = 0;
         virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
        virtual void stop_canvas_autoscroll () = 0;
         virtual bool autoscroll_active() const = 0;
 
+       virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
+       virtual void commit_reversible_selection_op () = 0;
+       virtual void begin_reversible_command (std::string cmd_name) = 0;
+       virtual void begin_reversible_command (GQuark) = 0;
+       virtual void abort_reversible_command () = 0;
+       virtual void commit_reversible_command () = 0;
+
+       virtual void access_action (std::string,std::string) = 0;
+
        virtual MouseCursors const * cursors () const = 0;
        virtual VerboseCursor * verbose_cursor () const = 0;
 
@@ -396,25 +401,71 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, publi
 
        virtual void get_pointer_position (double &, double &) const = 0;
 
-       virtual ARDOUR::Location* find_location_from_marker (Marker *, bool &) const = 0;
-       virtual Marker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
+       virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
+       virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
 
-       virtual void snap_to_with_modifier (framepos_t &, GdkEvent const *, int32_t direction = 0, bool for_mark = false) = 0;
+       virtual void snap_to_with_modifier (framepos_t &      first,
+                                           GdkEvent const *  ev,
+                                           ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
+                                           bool              for_mark  = false) = 0;
 
        virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
+       virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
+       virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
+       virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
+       virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
+
+       virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
+       virtual void mouse_add_new_meter_event (framepos_t where) = 0;
+       virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
+       virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
 
        /// Singleton instance, set up by Editor::Editor()
 
        static PublicEditor* _instance;
 
-       friend bool relay_key_press (GdkEventKey*, Gtk::Window*);
-       friend bool forward_key_press (GdkEventKey*);
+       friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
+       friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
 
        PBD::Signal0<void> SnapChanged;
        PBD::Signal0<void> MouseModeChanged;
 
+       Gtkmm2ext::Bindings* bindings;
+
   protected:
-       virtual void _ensure_time_axis_view_is_visible (const TimeAxisView& tav, bool at_top) = 0;
+       friend class DisplaySuspender;
+       virtual void suspend_route_redisplay () = 0;
+       virtual void resume_route_redisplay () = 0;
+       gint _suspend_route_redisplay_counter;
+};
+
+class DisplaySuspender {
+       public:
+               DisplaySuspender() {
+                       if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
+                               PublicEditor::instance().suspend_route_redisplay ();
+                       }
+               }
+               ~DisplaySuspender () {
+                       if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
+                               PublicEditor::instance().resume_route_redisplay ();
+                       }
+               }
+};
+
+class MainMenuDisabler {
+public:
+       MainMenuDisabler () {
+               /* The global menu bar continues to be accessible to applications
+                  with modal dialogs on mac, which means that we need to desensitize
+                  all items in the menu bar.
+               */
+               ActionManager::disable_active_actions ();
+       }
+
+       ~MainMenuDisabler () {
+               ActionManager::enable_active_actions ();
+       }
 };
 
 #endif // __gtk_ardour_public_editor_h__