1 /*
2  * Copyright (C) 2005-2018 Paul Davis <paul@linuxaudiosystems.com>
3  * Copyright (C) 2005 Karsten Wiese <fzuuzf@googlemail.com>
4  * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
5  * Copyright (C) 2006-2015 David Robillard <d@drobilla.net>
6  * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
7  * Copyright (C) 2007-2016 Tim Mayberry <mojofunk@gmail.com>
8  * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
9  * Copyright (C) 2014-2017 Nick Mainsbridge <mainsbridge@gmail.com>
10  * Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
11  * Copyright (C) 2015 Colin Fletcher <colin.m.fletcher@googlemail.com>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License along
24  * with this program; if not, write to the Free Software Foundation, Inc.,
25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26  */
27 
28 #ifndef __gtk_ardour_public_editor_h__
29 #define __gtk_ardour_public_editor_h__
30 
31 #ifdef WAF_BUILD
32 #include "gtk2ardour-config.h"
33 #endif
34 
35 #include <map>
36 
37 #include <string>
38 #include <glib.h>
39 #include <gdk/gdktypes.h>
40 #include <gtkmm/box.h>
41 #include <gtkmm/window.h>
42 #include <gtkmm/actiongroup.h>
43 #include <gtkmm/notebook.h>
44 #include <sigc++/signal.h>
45 
46 #include "pbd/statefuldestructible.h"
47 #include "pbd/g_atomic_compat.h"
48 
49 #include "temporal/beats.h"
50 
51 #include "evoral/Note.h"
52 
53 #include "ardour/session_handle.h"
54 
55 #include "canvas/fwd.h"
56 
57 #include "gtkmm2ext/actions.h"
58 #include "gtkmm2ext/bindings.h"
59 #include "gtkmm2ext/visibility_tracker.h"
60 
61 #include "widgets/tabbable.h"
62 
63 #include "axis_provider.h"
64 #include "editing.h"
65 #include "selection.h"
66 
67 namespace ARDOUR {
68 	class Session;
69 	class Region;
70 	class Playlist;
71 	class RouteGroup;
72 	class Trimmable;
73 	class Movable;
74 	class Stripable;
75 }
76 
77 namespace Gtk {
78 	class Container;
79 	class Menu;
80 }
81 
82 class AudioRegionView;
83 class AutomationLine;
84 class AutomationTimeAxisView;
85 class ControlPoint;
86 class DragManager;
87 class EditorCursor;
88 class ArdourMarker;
89 class MeterMarker;
90 class MixerStrip;
91 class MouseCursors;
92 class RegionView;
93 class RouteTimeAxisView;
94 class Selection;
95 class StripableTimeAxisView;
96 class TempoCurve;
97 class TempoMarker;
98 class TimeAxisView;
99 class VerboseCursor;
100 struct SelectionRect;
101 
102 class DisplaySuspender;
103 
104 namespace ARDOUR_UI_UTILS {
105 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
106 bool forward_key_press (GdkEventKey* ev);
107 }
108 
109 using ARDOUR::samplepos_t;
110 using ARDOUR::samplecnt_t;
111 
112 /// Representation of the interface of the Editor class
113 
114 /** This class contains just the public interface of the Editor class,
115  * in order to decouple it from the private implementation, so that callers
116  * of PublicEditor need not be recompiled if private methods or member variables
117  * change.
118  */
119 class PublicEditor : public ArdourWidgets::Tabbable,  public ARDOUR::SessionHandlePtr, public AxisViewProvider
120 {
121 public:
122 	PublicEditor (Gtk::Widget& content);
123 	virtual ~PublicEditor ();
124 
125 	/** @return Singleton PublicEditor instance */
instance()126 	static PublicEditor& instance () { return *_instance; }
127 
128 	virtual bool have_idled() const = 0;
129 	virtual void first_idle() = 0;
130 
131 	virtual void setup_tooltips() = 0;
132 
133 	/** Attach this editor to a Session.
134 	 * @param s Session to connect to.
135 	 */
136 	virtual void set_session (ARDOUR::Session* s) = 0;
137 
138 	/** Set the snap type.
139 	 * @param t Snap type (defined in editing_syms.h)
140 	 */
141 	virtual void set_grid_to (Editing::GridType t) = 0;
142 
143 	virtual Editing::GridType grid_type () const = 0;
144 	virtual Editing::SnapMode snap_mode () const = 0;
145 
146 	/** Set the snap mode.
147 	 * @param m Snap mode (defined in editing_syms.h)
148 	 */
149 	virtual void set_snap_mode (Editing::SnapMode m) = 0;
150 
151 	/**
152 	 * Snap a value according to the current snap setting.
153 	 * ensure_snap overrides SnapOff and magnetic snap
154 	 */
155 	virtual void snap_to (ARDOUR::MusicSample& first,
156 	                      ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
157 	                      ARDOUR::SnapPref    gpref = ARDOUR::SnapToAny_Visual,
158 	                      bool                ensure_snap = false) = 0;
159 
160 	/** Undo some transactions.
161 	 * @param n Number of transactions to undo.
162 	 */
163 
164 	virtual void undo (uint32_t n = 1) = 0;
165 
166 	/** Redo some transactions.
167 	 * @param n Number of transaction to redo.
168 	 */
169 	virtual void redo (uint32_t n = 1) = 0;
170 
171 	/** Set the mouse mode (gain, object, range, timefx etc.)
172 	 * @param m Mouse mode (defined in editing_syms.h)
173 	 * @param force Perform the effects of the change even if no change is required
174 	 * (ie even if the current mouse mode is equal to @param m)
175 	 */
176 	virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
177 
178 	/** Step the mouse mode onto the next or previous one.
179 	 * @param next true to move to the next, otherwise move to the previous
180 	 */
181 	virtual void step_mouse_mode (bool next) = 0;
182 
183 	/** @return The current mouse mode (gain, object, range, timefx etc.)
184 	 * (defined in editing_syms.h)
185 	 */
186 	virtual Editing::MouseMode current_mouse_mode () const = 0;
187 
188 	/** @return Whether the current mouse mode is an "internal" editing mode. */
189 	virtual bool internal_editing() const = 0;
190 
191 	/** Possibly start the audition of a region.
192 	 *
193 	 * If \p r is 0, or not an AudioRegion any current audition is cancelled.
194 	 * If we are currently auditioning \p r , the audition will be cancelled.
195 	 * Otherwise an audition of \p r will start.
196 	 *
197 	 * @param r Region to consider auditioning
198 	 */
199 	virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
200 
201 	/* import dialogs -> ardour-ui ?! */
202 	virtual void external_audio_dialog () = 0;
203 	virtual void session_import_dialog () = 0;
204 
205 	virtual void new_region_from_selection () = 0;
206 	virtual void separate_region_from_selection () = 0;
207 
208 	virtual void transition_to_rolling (bool fwd) = 0;
209 	virtual samplepos_t pixel_to_sample (double pixel) const = 0;
210 	virtual samplepos_t playhead_cursor_sample () const = 0;
211 	virtual double sample_to_pixel (samplepos_t sample) const = 0;
212 	virtual double sample_to_pixel_unrounded (samplepos_t sample) const = 0;
213 
214 	virtual Selection& get_selection () const = 0;
215 	virtual bool get_selection_extents (samplepos_t &start, samplepos_t &end) const = 0;
216 	virtual Selection& get_cut_buffer () const = 0;
217 
218 	virtual void set_selection (std::list<Selectable*>, Selection::Operation) = 0;
219 	virtual void set_selected_midi_region_view (MidiRegionView&) = 0;
220 
221 	virtual bool extend_selection_to_track (TimeAxisView&) = 0;
222 	virtual void play_solo_selection(bool restart) = 0;
223 	virtual void play_selection () = 0;
224 	virtual void play_with_preroll () = 0;
225 	virtual void rec_with_preroll () = 0;
226 	virtual void rec_with_count_in () = 0;
227 	virtual void maybe_locate_with_edit_preroll (samplepos_t location) = 0;
228 	virtual void goto_nth_marker (int nth) = 0;
229 	virtual void trigger_script (int nth) = 0;
230 	virtual void add_location_from_playhead_cursor () = 0;
231 	virtual void remove_location_at_playhead_cursor () = 0;
232 	virtual void add_location_mark (samplepos_t where) = 0;
233 	virtual void update_grid () = 0;
234 	virtual void remove_tracks () = 0;
235 	virtual void set_loop_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
236 	virtual void set_punch_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
237 
238 	virtual void jump_forward_to_mark () = 0;
239 	virtual void jump_backward_to_mark () = 0;
240 
241 	virtual void set_session_start_from_playhead () = 0;
242 	virtual void set_session_end_from_playhead () = 0;
243 
244 	virtual void toggle_location_at_playhead_cursor () = 0;
245 
246 	virtual void nudge_forward (bool next, bool force_playhead) = 0;
247 	virtual void nudge_backward (bool next, bool force_playhead) = 0;
248 
249 	virtual void playhead_forward_to_grid () = 0;
250 	virtual void playhead_backward_to_grid () = 0;
251 
252 	virtual void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
253 	virtual void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
254 
255 	virtual void set_punch_start_from_edit_point () = 0;
256 	virtual void set_punch_end_from_edit_point () = 0;
257 	virtual void set_loop_start_from_edit_point () = 0;
258 	virtual void set_loop_end_from_edit_point () = 0;
259 
260 	virtual Editing::MouseMode effective_mouse_mode () const = 0;
261 
262 	/** Import existing media */
263 	virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality,
264 	                        ARDOUR::MidiTrackNameSource, ARDOUR::MidiTempoMapDisposition, samplepos_t&,
265 	                        boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>(),
266 	                        bool with_markers = false) = 0;
267 	virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,
268 	                       samplepos_t&,
269 	                       boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
270 
271 	/** Open main export dialog */
272 	virtual void export_audio () = 0;
273 
274 	/** Open stem export dialog */
275 	virtual void stem_export () = 0;
276 
277 	/** Open export dialog with current selection pre-selected */
278 	virtual void export_selection () = 0;
279 
280 	/** Open export dialog with current range pre-selected */
281 	virtual void export_range () = 0;
282 
283 	virtual void loudness_assistant (bool) = 0;
284 
285 	virtual void register_actions () = 0;
286 	virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
287 	virtual Editing::ZoomFocus get_zoom_focus () const = 0;
288 	virtual samplecnt_t get_current_zoom () const = 0;
289 	virtual void reset_zoom (samplecnt_t) = 0;
290 	virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
291 	virtual void clear_grouped_playlists (RouteUI*) = 0;
292 
293 	virtual void new_playlists_for_all_tracks(bool copy) = 0;
294 	virtual void new_playlists_for_grouped_tracks(RouteUI* rui, bool copy) = 0;
295 	virtual void new_playlists_for_selected_tracks(bool copy) = 0;
296 	virtual void new_playlists_for_armed_tracks(bool copy) = 0;
297 
298 	virtual void select_all_visible_lanes () = 0;
299 	virtual void select_all_tracks () = 0;
300 	virtual void deselect_all () = 0;
301 	virtual void invert_selection () = 0;
302 	virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
303 	virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
304 	virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
305 	virtual void show_track_in_display (TimeAxisView* tv, bool move_into_view = false) = 0;
306 
307 	virtual void set_stationary_playhead (bool yn) = 0;
308 	virtual void toggle_stationary_playhead () = 0;
309 	virtual bool stationary_playhead() const = 0;
310 
311 	/** Set whether the editor should follow the playhead.
312 	 * @param yn true to follow playhead, otherwise false.
313 	 * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
314 	 */
315 	virtual void set_follow_playhead (bool yn, bool catch_up = true) = 0;
316 
317 	/** Toggle whether the editor is following the playhead */
318 	virtual void toggle_follow_playhead () = 0;
319 
320 	/** @return true if the editor is following the playhead */
321 	virtual bool follow_playhead () const = 0;
322 
323 	/** @return true if the playhead is currently being dragged, otherwise false */
324 	virtual bool dragging_playhead () const = 0;
325 	virtual samplepos_t leftmost_sample() const = 0;
326 	virtual samplecnt_t current_page_samples() const = 0;
327 	virtual double visible_canvas_height () const = 0;
328 	virtual void temporal_zoom_step (bool coarser) = 0;
329 	virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
330 	virtual void override_visible_track_count () = 0;
331 	virtual void scroll_tracks_down_line () = 0;
332 	virtual void scroll_tracks_up_line () = 0;
333 	virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
334 	virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
335 	virtual void select_topmost_track () = 0;
336 	virtual void cleanup_regions () = 0;
337 	virtual void prepare_for_cleanup () = 0;
338 	virtual void finish_cleanup () = 0;
339 	virtual void reset_x_origin (samplepos_t sample) = 0;
340 	virtual double get_y_origin () const = 0;
341 	virtual void reset_y_origin (double pos) = 0;
342 	virtual void set_visible_track_count (int32_t) = 0;
343 	virtual void fit_selection () = 0;
344 	virtual void remove_last_capture () = 0;
345 	virtual void maximise_editing_space () = 0;
346 	virtual void restore_editing_space () = 0;
347 	virtual samplepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
348 	virtual void toggle_meter_updating() = 0;
349 	virtual void split_regions_at (ARDOUR::MusicSample, RegionSelection&) = 0;
350 	virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
351 	virtual void mouse_add_new_marker (samplepos_t where, bool is_cd=false) = 0;
352 	virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
353 	virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
354 	virtual samplecnt_t get_nudge_distance (samplepos_t pos, samplecnt_t& next) = 0;
355 	virtual samplecnt_t get_paste_offset (samplepos_t pos, unsigned paste_count, samplecnt_t duration) = 0;
356 	virtual unsigned get_grid_beat_divisions(samplepos_t position) = 0;
357 	virtual Temporal::Beats get_grid_type_as_beats (bool& success, samplepos_t position) = 0;
358 	virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
359 	virtual void edit_notes (MidiRegionView*) = 0;
360 
361 	virtual void queue_visual_videotimeline_update () = 0;
362 	virtual void set_close_video_sensitive (bool) = 0;
363 	virtual void toggle_ruler_video (bool) = 0;
364 	virtual void toggle_xjadeo_proc (int) = 0;
365 	virtual void toggle_xjadeo_viewoption (int, int) = 0;
366 	virtual void set_xjadeo_sensitive (bool onoff) = 0;
367 	virtual int  get_videotl_bar_height () const = 0;
368 	virtual void set_video_timeline_height (const int h) = 0;
369 	virtual void embed_audio_from_video (std::string, samplepos_t n = 0, bool lock_position_to_video = true) = 0;
370 
371 	virtual bool track_selection_change_without_scroll () const = 0;
372 	virtual bool show_touched_automation () const = 0;
373 
374 	virtual StripableTimeAxisView* get_stripable_time_axis_by_id (const PBD::ID& id) const = 0;
375 
376 	virtual TimeAxisView* time_axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable> s) const = 0;
377 
378 	virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
379 	virtual RegionView* regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const = 0;
380 	virtual RouteTimeAxisView* rtav_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
381 
382 	sigc::signal<void> ZoomChanged;
383 	sigc::signal<void> Realized;
384 	sigc::signal<void,samplepos_t> UpdateAllTransportClocks;
385 
386 	virtual bool pending_locate_request() const = 0;
387 
388 	static sigc::signal<void> DropDownKeys;
389 
390 	struct RegionAction {
391 		Glib::RefPtr<Gtk::Action> action;
392 		Editing::RegionActionTarget target;
393 
RegionActionRegionAction394 		RegionAction (Glib::RefPtr<Gtk::Action> a, Editing::RegionActionTarget tgt)
395 			: action (a), target (tgt) {}
396 	};
397 
398 	std::map<std::string,RegionAction> region_action_map;
399 
400 	Glib::RefPtr<Gtk::ActionGroup> editor_actions;
401 	Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
402 	Glib::RefPtr<Gtk::ActionGroup> _region_actions;
403 	Glib::RefPtr<Gtk::ActionGroup> _midi_actions;
404 
405 	virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
406 	virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
407 	virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
408 	virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
409 	virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
410 	virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
411 	virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
412 	virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
413 	virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
414 	virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
415 	virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
416 	virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
417 	virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
418 	virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
419 	virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
420 	virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
421 	virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
422 	virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
423 	virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
424 	virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
425 	virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
426 	virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
427 	virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
428 	virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
429 	virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
430 
431 	virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
432 	virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
433 	virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
434 	virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
435 	virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
436 	virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
437 
438 	static const int window_border_width;
439 	static const int container_border_width;
440 	static const int vertical_spacing;
441 	static const int horizontal_spacing;
442 
443 	virtual ArdourCanvas::Container* get_trackview_group () const = 0;
444 	virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
445 	virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
446 	virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
447 	virtual ArdourCanvas::Container* get_drag_motion_group () const = 0;
448 
449 	virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
450 
451 	virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
452 	virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
453 
454 	virtual void center_screen (samplepos_t) = 0;
455 
456 	virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
457 	virtual TrackViewList const & get_track_views () const = 0;
458 
459 	virtual MixerStrip* get_current_mixer_strip () const = 0;
460 
461 	virtual DragManager* drags () const = 0;
462 	virtual bool drag_active () const = 0;
463 	virtual bool preview_video_drag_active () const = 0;
464 	virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
465 	virtual void stop_canvas_autoscroll () = 0;
466 	virtual bool autoscroll_active() const = 0;
467 
468 	virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
469 	virtual void commit_reversible_selection_op () = 0;
470 	virtual void begin_reversible_command (std::string cmd_name) = 0;
471 	virtual void begin_reversible_command (GQuark) = 0;
472 	virtual void abort_reversible_command () = 0;
473 	virtual void commit_reversible_command () = 0;
474 
475 	virtual void access_action (const std::string&, const std::string&) = 0;
476 	virtual void set_toggleaction (const std::string&, const std::string&, bool) = 0;
477 
478 	virtual MouseCursors const* cursors () const = 0;
479 	virtual VerboseCursor* verbose_cursor () const = 0;
480 
481 	virtual EditorCursor* playhead_cursor () const = 0;
482 	virtual EditorCursor* snapped_cursor () const = 0;
483 
484 	virtual bool get_smart_mode () const = 0;
485 
486 	virtual void get_pointer_position (double &, double &) const = 0;
487 
488 	virtual std::pair <samplepos_t, samplepos_t> session_gui_extents (bool use_extra = true) const = 0;
489 
490 	virtual ARDOUR::Location* find_location_from_marker (ArdourMarker*, bool&) const = 0;
491 	virtual ArdourMarker* find_marker_from_location_id (PBD::ID const&, bool) const = 0;
492 
493 	virtual void snap_to_with_modifier (ARDOUR::MusicSample& first,
494 	                                    GdkEvent const*      ev,
495 	                                    ARDOUR::RoundMode    direction = ARDOUR::RoundNearest,
496 	                                    ARDOUR::SnapPref     gpref = ARDOUR::SnapToAny_Visual) = 0;
497 
498 	virtual void set_snapped_cursor_position (samplepos_t pos) = 0;
499 
500 	virtual void get_regions_at (RegionSelection &, samplepos_t where, TrackViewList const &) const = 0;
501 	virtual void get_regions_after (RegionSelection&, samplepos_t where, const TrackViewList& ts) const = 0;
502 	virtual RegionSelection get_regions_from_selection_and_mouse (samplepos_t) = 0;
503 	virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
504 	virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > > >&) const = 0;
505 
506 	virtual void build_region_boundary_cache () = 0;
507 	virtual void mark_region_boundary_cache_dirty () = 0;
508 
509 	virtual void mouse_add_new_tempo_event (samplepos_t where) = 0;
510 	virtual void mouse_add_new_meter_event (samplepos_t where) = 0;
511 	virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
512 	virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
513 
514 	/// Singleton instance, set up by Editor::Editor()
515 
516 	static PublicEditor* _instance;
517 
518 	friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
519 	friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
520 
521 	PBD::Signal0<void> SnapChanged;
522 	PBD::Signal0<void> MouseModeChanged;
523 
524 	Gtkmm2ext::Bindings* bindings;
525 
526 protected:
527 	friend class DisplaySuspender;
528 	virtual void suspend_route_redisplay () = 0;
529 	virtual void resume_route_redisplay () = 0;
530 
531 	GATOMIC_QUAL gint _suspend_route_redisplay_counter;
532 };
533 
534 class DisplaySuspender {
535 	public:
DisplaySuspender()536 		DisplaySuspender() {
537 			if (g_atomic_int_add (&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
538 				PublicEditor::instance().suspend_route_redisplay ();
539 			}
540 		}
~DisplaySuspender()541 		~DisplaySuspender () {
542 			if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
543 				PublicEditor::instance().resume_route_redisplay ();
544 			}
545 		}
546 };
547 
548 class MainMenuDisabler {
549 public:
MainMenuDisabler()550 	MainMenuDisabler () {
551 		/* The global menu bar continues to be accessible to applications
552 		   with modal dialogs on mac, which means that we need to desensitize
553 		   all items in the menu bar.
554 		*/
555 		ActionManager::disable_active_actions ();
556 	}
557 
~MainMenuDisabler()558 	~MainMenuDisabler () {
559 		ActionManager::enable_active_actions ();
560 	}
561 };
562 
563 #endif // __gtk_ardour_public_editor_h__
564