Attempt to fix some confusions caused by bundles containing
[ardour.git] / gtk2_ardour / public_editor.h
index ea9ef9dfad8cb71b10e0229e711903d0e3ade581..f5d7dad522a2130825c1bd130b5c61578e02c28f 100644 (file)
 #ifndef __gtk_ardour_public_editor_h__
 #define __gtk_ardour_public_editor_h__
 
+#ifdef WAF_BUILD
+#include "gtk2ardour-config.h"
+#endif
+
 #include <map>
 
 #include <string>
@@ -45,6 +49,8 @@ namespace ARDOUR {
        class Region;
        class Playlist;
        class RouteGroup;
+        class Trimmable;
+        class Movable;
 }
 
 namespace Gtk {
@@ -52,7 +58,7 @@ namespace Gtk {
        class Menu;
 }
 
-namespace Gtkmm2ext { 
+namespace Gtkmm2ext {
         class TearOff;
 }
 
@@ -80,6 +86,11 @@ class ImageFrameView;
 class ImageFrameTimeAxis;
 class MarkerView;
 class DragManager;
+class MouseCursors;
+class VerboseCursor;
+
+using ARDOUR::framepos_t;
+using ARDOUR::framecnt_t;
 
 /// Representation of the interface of the Editor class
 
@@ -128,7 +139,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        virtual void set_snap_threshold (double t) = 0;
 
        /** Snap a value according to the current snap setting. */
-       virtual void snap_to (nframes64_t& first, int32_t direction = 0, bool for_mark = false) = 0;
+       virtual void snap_to (framepos_t& first, int32_t direction = 0, bool for_mark = false) = 0;
 
        /** Undo some transactions.
         * @param n Number of transactions to undo.
@@ -185,15 +196,11 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        virtual void separate_region_from_selection () = 0;
 
        virtual void transition_to_rolling (bool fwd) = 0;
-       virtual nframes64_t unit_to_frame (double unit) const = 0;
-       // XXX remove me when libardour goes nframes64_t
-       double frame_to_unit (nframes_t frame) const {
-               return frame_to_unit ((nframes64_t) frame);
-       }
-       virtual double frame_to_unit (nframes64_t frame) const = 0;
+       virtual framepos_t unit_to_frame (double unit) const = 0;
+       virtual double frame_to_unit (framepos_t frame) const = 0;
        virtual double frame_to_unit (double frame) const = 0;
-       virtual nframes64_t pixel_to_frame (double pixel) const = 0;
-       virtual gulong frame_to_pixel (nframes64_t frame) const = 0;
+       virtual framepos_t pixel_to_frame (double pixel) const = 0;
+       virtual gulong frame_to_pixel (framepos_t frame) const = 0;
        virtual Selection& get_selection () const = 0;
        virtual Selection& get_cut_buffer () const = 0;
        virtual bool extend_selection_to_track (TimeAxisView&) = 0;
@@ -205,6 +212,9 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        /** Open main export dialog */
        virtual void export_audio () = 0;
 
+       /** Open stem export dialog */
+       virtual void stem_export () = 0;
+
        /** Open export dialog with current selection pre-selected */
        virtual void export_selection () = 0;
 
@@ -224,7 +234,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        virtual void select_all_tracks () = 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 temporary = false) = 0;
+       virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
 
         virtual void set_stationary_playhead (bool yn) = 0;
         virtual void toggle_stationary_playhead () = 0;
@@ -232,8 +242,9 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
 
        /** Set whether the editor should follow the playhead.
         * @param yn true to follow playhead, otherwise false.
+        * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
         */
-       virtual void set_follow_playhead (bool yn) = 0;
+       virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
 
        /** Toggle whether the editor is following the playhead */
        virtual void toggle_follow_playhead () = 0;
@@ -243,28 +254,29 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
 
        /** @return true if the playhead is currently being dragged, otherwise false */
        virtual bool dragging_playhead () const = 0;
-       virtual double get_physical_screen_width() const = 0;
        virtual void ensure_float (Gtk::Window&) = 0;
        virtual void show_window () = 0;
-       virtual nframes64_t leftmost_position() const = 0;
-       virtual nframes64_t current_page_frames() const = 0;
+       virtual framepos_t leftmost_position() const = 0;
+       virtual framecnt_t current_page_frames() const = 0;
+       virtual double canvas_height () const = 0;
        virtual void temporal_zoom_step (bool coarser) = 0;
+       virtual void ensure_time_axis_view_is_visible (const TimeAxisView& tav) = 0;
        virtual void scroll_tracks_down_line () = 0;
        virtual void scroll_tracks_up_line () = 0;
        virtual void prepare_for_cleanup () = 0;
        virtual void finish_cleanup () = 0;
-       virtual void reset_x_origin (nframes64_t frame) = 0;
+       virtual void reset_x_origin (framepos_t frame) = 0;
        virtual void remove_last_capture () = 0;
        virtual void maximise_editing_space () = 0;
        virtual void restore_editing_space () = 0;
-       virtual nframes64_t get_preferred_edit_position (bool ignore_playhead = false) = 0;
+       virtual framepos_t get_preferred_edit_position (bool ignore_playhead = false) = 0;
        virtual void toggle_meter_updating() = 0;
-       virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret) = 0;
-       virtual void mouse_add_new_marker (nframes64_t where, bool is_cd=false, bool is_xrun=false) = 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 foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
        virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
-       virtual nframes64_t get_nudge_distance (nframes64_t pos, nframes64_t& next) = 0;
-       virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, nframes64_t position) = 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;
 
 #ifdef WITH_CMT
        virtual void connect_to_image_compositor()  = 0;
@@ -274,19 +286,20 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        virtual TimeAxisView* get_named_time_axis(const std::string & name)  = 0;
 #endif
 
-       virtual RouteTimeAxisView* get_route_view_by_id (PBD::ID& id) = 0;
+       virtual RouteTimeAxisView* get_route_view_by_route_id (PBD::ID& id) const = 0;
 
        virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
 
-       sigc::signal<void> ZoomFocusChanged;
        sigc::signal<void> ZoomChanged;
-       sigc::signal<void> Resized;
+       /** Emitted when the horizontal position of the editor view changes */
+       sigc::signal<void> HorizontalPositionChanged;
        sigc::signal<void> Realized;
-       sigc::signal<void,nframes64_t> UpdateAllTransportClocks;
+       sigc::signal<void,framepos_t> UpdateAllTransportClocks;
 
         static sigc::signal<void> DropDownKeys;
-        
+
        Glib::RefPtr<Gtk::ActionGroup> editor_actions;
+       Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 
        virtual void reset_focus () = 0;
 
@@ -345,20 +358,20 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
 #endif
 
        virtual gdouble get_trackview_group_vertical_offset () const = 0;
-       virtual gdouble get_canvas_timebars_vsize () const = 0;
-       virtual ArdourCanvas::Group* get_background_group () const = 0;
+       virtual double get_canvas_timebars_vsize () const = 0;
        virtual ArdourCanvas::Group* get_trackview_group () const = 0;
+       virtual ArdourCanvas::Group* get_background_group () const = 0;
 
        virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
 
-       virtual void show_verbose_canvas_cursor_with (const std::string& txt) = 0;
-       virtual void hide_verbose_canvas_cursor() = 0;
+        virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
+        virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
 
-       virtual void center_screen (nframes64_t) = 0;
+       virtual void center_screen (framepos_t) = 0;
 
        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;
 
@@ -366,6 +379,14 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        virtual void maybe_autoscroll (bool, bool) = 0;
        virtual void stop_canvas_autoscroll () = 0;
 
+       virtual MouseCursors const * cursors () const = 0;
+       virtual VerboseCursor * verbose_cursor () const = 0;
+
+       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;
+
        /// Singleton instance, set up by Editor::Editor()
 
        static PublicEditor* _instance;
@@ -374,6 +395,7 @@ class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible {
        friend bool forward_key_press (GdkEventKey*);
 
        PBD::Signal0<void> SnapChanged;
+       PBD::Signal0<void> MouseModeChanged;
 };
 
 #endif // __gtk_ardour_public_editor_h__