2 Copyright (C) 2000-2007 Paul Davis
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.
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.
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.
20 #ifndef __gtk_ardour_public_editor_h__
21 #define __gtk_ardour_public_editor_h__
24 #include "gtk2ardour-config.h"
31 #include <gdk/gdktypes.h>
32 #include <gtkmm/box.h>
33 #include <gtkmm/window.h>
34 #include <gtkmm/actiongroup.h>
35 #include <sigc++/signal.h>
37 #include "evoral/types.hpp"
39 #include "pbd/statefuldestructible.h"
41 #include "canvas/fwd.h"
42 #include "gtkmm2ext/visibility_tracker.h"
45 #include "selection.h"
65 class AudioRegionView;
67 class AutomationTimeAxisView;
74 class PlaylistSelector;
78 class RouteTimeAxisView;
82 class TimeAxisViewItem;
87 namespace ARDOUR_UI_UTILS {
88 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
89 bool forward_key_press (GdkEventKey* ev);
92 using ARDOUR::framepos_t;
93 using ARDOUR::framecnt_t;
95 /// Representation of the interface of the Editor class
97 /** This class contains just the public interface of the Editor class,
98 * in order to decouple it from the private implementation, so that callers
99 * of PublicEditor need not be recompiled if private methods or member variables
102 class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, public Gtkmm2ext::VisibilityTracker {
105 virtual ~PublicEditor ();
107 /** @return Singleton PublicEditor instance */
108 static PublicEditor& instance () { return *_instance; }
110 virtual bool have_idled() const = 0;
111 virtual void first_idle() = 0;
113 virtual void setup_tooltips() = 0;
115 /** Attach this editor to a Session.
116 * @param s Session to connect to.
118 virtual void set_session (ARDOUR::Session* s) = 0;
120 /** @return The Session that we are editing, or 0 */
121 virtual ARDOUR::Session* session () const = 0;
123 /** Set the snap type.
124 * @param t Snap type (defined in editing_syms.h)
126 virtual void set_snap_to (Editing::SnapType t) = 0;
128 virtual Editing::SnapType snap_type () const = 0;
129 virtual Editing::SnapMode snap_mode () const = 0;
131 /** Set the snap mode.
132 * @param m Snap mode (defined in editing_syms.h)
134 virtual void set_snap_mode (Editing::SnapMode m) = 0;
136 /** Set the snap threshold.
137 * @param t Snap threshold in `units'.
139 virtual void set_snap_threshold (double t) = 0;
141 /** Snap a value according to the current snap setting. */
142 virtual void snap_to (framepos_t& first, int32_t direction = 0, bool for_mark = false) = 0;
144 /** Undo some transactions.
145 * @param n Number of transactions to undo.
148 virtual void undo (uint32_t n = 1) = 0;
150 /** Redo some transactions.
151 * @param n Number of transaction to redo.
153 virtual void redo (uint32_t n = 1) = 0;
155 /** Set the mouse mode (gain, object, range, timefx etc.)
156 * @param m Mouse mode (defined in editing_syms.h)
157 * @param force Perform the effects of the change even if no change is required
158 * (ie even if the current mouse mode is equal to @param m)
160 virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
162 /** Step the mouse mode onto the next or previous one.
163 * @param next true to move to the next, otherwise move to the previous
165 virtual void step_mouse_mode (bool next) = 0;
167 /** @return The current mouse mode (gain, object, range, timefx etc.)
168 * (defined in editing_syms.h)
170 virtual Editing::MouseMode current_mouse_mode () const = 0;
172 /** Switch into a mode in which editing is primarily focused on "within" regions,
173 rather than regions as black-box objects. For Ardour3, this is aimed at
174 editing MIDI regions but may expand in the future to other types of regions.
177 virtual void set_internal_edit (bool yn) = 0;
179 /** Driven by a double-click, switch in or out of a mode in which
180 editing is primarily focused on "within" regions, rather than
181 regions as black-box objects. For Ardour3, this is aimed at editing
182 MIDI regions but may expand in the future to other types of
186 virtual bool toggle_internal_editing_from_double_click (GdkEvent*) = 0;
188 /** @return Whether editing is currently in "internal" mode or not
191 virtual bool internal_editing() const = 0;
193 /** Possibly start the audition of a region. If @param r is 0, or not an AudioRegion
194 * any current audition is cancelled. If we are currently auditioning @param r,
195 * the audition will be cancelled. Otherwise an audition of @param r will start.
196 * \param r Region to consider.
198 virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
200 virtual void new_region_from_selection () = 0;
201 virtual void separate_region_from_selection () = 0;
203 virtual void transition_to_rolling (bool fwd) = 0;
204 virtual framepos_t pixel_to_sample (double pixel) const = 0;
205 virtual double sample_to_pixel (framepos_t frame) const = 0;
206 virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
207 virtual Selection& get_selection () const = 0;
208 virtual Selection& get_cut_buffer () const = 0;
209 virtual void track_mixer_selection () = 0;
210 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
211 virtual void play_selection () = 0;
212 virtual void play_with_preroll () = 0;
213 virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
214 virtual void set_show_measures (bool yn) = 0;
215 virtual bool show_measures () const = 0;
217 virtual Editing::MouseMode effective_mouse_mode () const = 0;
219 /** Import existing media */
220 virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&) = 0;
221 virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, framepos_t&) = 0;
223 /** Open main export dialog */
224 virtual void export_audio () = 0;
226 /** Open stem export dialog */
227 virtual void stem_export () = 0;
229 /** Open export dialog with current selection pre-selected */
230 virtual void export_selection () = 0;
232 /** Open export dialog with current range pre-selected */
233 virtual void export_range () = 0;
235 virtual void register_actions () = 0;
236 virtual void add_toplevel_controls (Gtk::Container&) = 0;
237 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
238 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
239 virtual framecnt_t get_current_zoom () const = 0;
240 virtual PlaylistSelector& playlist_selector() const = 0;
241 virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
242 virtual void new_playlists (TimeAxisView*) = 0;
243 virtual void copy_playlists (TimeAxisView*) = 0;
244 virtual void clear_playlists (TimeAxisView*) = 0;
245 virtual void select_all_tracks () = 0;
246 virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
247 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
248 virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
250 virtual void set_stationary_playhead (bool yn) = 0;
251 virtual void toggle_stationary_playhead () = 0;
252 virtual bool stationary_playhead() const = 0;
254 /** Set whether the editor should follow the playhead.
255 * @param yn true to follow playhead, otherwise false.
256 * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
258 virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
260 /** Toggle whether the editor is following the playhead */
261 virtual void toggle_follow_playhead () = 0;
263 /** @return true if the editor is following the playhead */
264 virtual bool follow_playhead () const = 0;
266 /** @return true if the playhead is currently being dragged, otherwise false */
267 virtual bool dragging_playhead () const = 0;
268 virtual void ensure_float (Gtk::Window&) = 0;
269 virtual void show_window () = 0;
270 virtual framepos_t leftmost_sample() const = 0;
271 virtual framecnt_t current_page_samples() const = 0;
272 virtual double visible_canvas_height () const = 0;
273 virtual void temporal_zoom_step (bool coarser) = 0;
274 virtual void ensure_time_axis_view_is_visible (const TimeAxisView& tav, bool at_top = false) {
275 _ensure_time_axis_view_is_visible (tav, at_top);
277 virtual void override_visible_track_count () = 0;
278 virtual void scroll_tracks_down_line () = 0;
279 virtual void scroll_tracks_up_line () = 0;
280 virtual bool scroll_down_one_track () = 0;
281 virtual bool scroll_up_one_track () = 0;
282 virtual void prepare_for_cleanup () = 0;
283 virtual void finish_cleanup () = 0;
284 virtual void reset_x_origin (framepos_t frame) = 0;
285 virtual void remove_last_capture () = 0;
286 virtual void maximise_editing_space () = 0;
287 virtual void restore_editing_space () = 0;
288 virtual void update_tearoff_visibility () = 0;
289 virtual framepos_t get_preferred_edit_position (bool ignore_playhead = false, bool from_context_menu = false) = 0;
290 virtual void toggle_meter_updating() = 0;
291 virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
292 virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false, bool is_xrun=false) = 0;
293 virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
294 virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
295 virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
296 virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, framepos_t position) = 0;
297 virtual void edit_notes (TimeAxisViewItem&) = 0;
299 virtual void queue_visual_videotimeline_update () = 0;
300 virtual void set_close_video_sensitive (bool) = 0;
301 virtual void toggle_ruler_video (bool) = 0;
302 virtual void toggle_xjadeo_proc (int) = 0;
303 virtual void toggle_xjadeo_viewoption (int, int) = 0;
304 virtual void set_xjadeo_sensitive (bool onoff) = 0;
305 virtual int get_videotl_bar_height () const = 0;
306 virtual void set_video_timeline_height (const int h) = 0;
307 virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
308 virtual void export_video (bool range = false) = 0;
310 virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
312 virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
314 sigc::signal<void> ZoomChanged;
315 sigc::signal<void> Realized;
316 sigc::signal<void,framepos_t> UpdateAllTransportClocks;
318 static sigc::signal<void> DropDownKeys;
320 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
321 Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
322 Glib::RefPtr<Gtk::ActionGroup> _region_actions;
324 virtual void reset_focus () = 0;
326 virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
327 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
328 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
329 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
330 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
331 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
332 virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
333 virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
334 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
335 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
336 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
337 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
338 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
339 virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
340 virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
341 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
342 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
343 virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
344 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
345 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
346 virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
347 virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
348 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
349 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
350 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
352 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
353 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
354 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
355 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
356 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
357 virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
359 static const int window_border_width;
360 static const int container_border_width;
361 static const int vertical_spacing;
362 static const int horizontal_spacing;
366 * This is needed for OS X primarily
367 * but also any other OS that uses a single
368 * top menubar instead of per window menus
370 virtual Gtk::HBox& get_status_bar_packer() = 0;
373 virtual ArdourCanvas::Container* get_trackview_group () const = 0;
374 virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
375 virtual ArdourCanvas::ScrollGroup* get_vscroll_group () const = 0;
376 virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
378 virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
380 virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
382 virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
383 virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
385 virtual void center_screen (framepos_t) = 0;
387 virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
388 virtual TrackViewList const & get_track_views () = 0;
390 virtual Gtkmm2ext::TearOff* mouse_mode_tearoff () const = 0;
391 virtual Gtkmm2ext::TearOff* tools_tearoff () const = 0;
393 virtual DragManager* drags () const = 0;
394 virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
395 virtual void stop_canvas_autoscroll () = 0;
396 virtual bool autoscroll_active() const = 0;
398 virtual MouseCursors const * cursors () const = 0;
399 virtual VerboseCursor * verbose_cursor () const = 0;
401 virtual bool get_smart_mode () const = 0;
403 virtual void get_pointer_position (double &, double &) const = 0;
405 virtual ARDOUR::Location* find_location_from_marker (Marker *, bool &) const = 0;
406 virtual Marker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
408 virtual void snap_to_with_modifier (framepos_t &, GdkEvent const *, int32_t direction = 0, bool for_mark = false) = 0;
410 virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
412 /// Singleton instance, set up by Editor::Editor()
414 static PublicEditor* _instance;
416 friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
417 friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
419 PBD::Signal0<void> SnapChanged;
420 PBD::Signal0<void> MouseModeChanged;
423 virtual void _ensure_time_axis_view_is_visible (const TimeAxisView& tav, bool at_top) = 0;
426 #endif // __gtk_ardour_public_editor_h__