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 <jack/types.h>
36 #include <sigc++/signal.h>
38 #include "evoral/types.hpp"
39 #include "ardour/route_group.h"
41 #include "pbd/statefuldestructible.h"
45 #include "selection.h"
66 class TimeAxisViewItem
;
70 class PlaylistSelector
;
77 class RouteTimeAxisView
;
79 class AudioRegionView
;
83 class AutomationTimeAxisView
;
86 class ImageFrameTimeAxis
;
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
{
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 /** @return Whether editing is currently in "internal" mode or not
182 virtual bool internal_editing() const = 0;
184 /** @return Sound edited notes in MIDI regions while editing
186 virtual bool sound_notes () const = 0;
188 /** Possibly start the audition of a region. If @param r is 0, or not an AudioRegion
189 * any current audition is cancelled. If we are currently auditioning @param r,
190 * the audition will be cancelled. Otherwise an audition of @param r will start.
191 * \param r Region to consider.
193 virtual void consider_auditioning (boost::shared_ptr
<ARDOUR::Region
> r
) = 0;
195 virtual void new_region_from_selection () = 0;
196 virtual void separate_region_from_selection () = 0;
198 virtual void transition_to_rolling (bool fwd
) = 0;
199 virtual framepos_t
unit_to_frame (double unit
) const = 0;
200 virtual double frame_to_unit (framepos_t frame
) const = 0;
201 virtual double frame_to_unit (double frame
) const = 0;
202 virtual framepos_t
pixel_to_frame (double pixel
) const = 0;
203 virtual gulong
frame_to_pixel (framepos_t frame
) const = 0;
204 virtual Selection
& get_selection () const = 0;
205 virtual Selection
& get_cut_buffer () const = 0;
206 virtual bool extend_selection_to_track (TimeAxisView
&) = 0;
207 virtual void play_selection () = 0;
208 virtual void set_show_measures (bool yn
) = 0;
209 virtual bool show_measures () const = 0;
210 virtual bool redraw_measures () = 0;
212 /** Open main export dialog */
213 virtual void export_audio () = 0;
215 /** Open stem export dialog */
216 virtual void stem_export () = 0;
218 /** Open export dialog with current selection pre-selected */
219 virtual void export_selection () = 0;
221 /** Open export dialog with current range pre-selected */
222 virtual void export_range () = 0;
224 virtual void register_actions () = 0;
225 virtual void add_toplevel_controls (Gtk::Container
&) = 0;
226 virtual void set_zoom_focus (Editing::ZoomFocus
) = 0;
227 virtual Editing::ZoomFocus
get_zoom_focus () const = 0;
228 virtual gdouble
get_current_zoom () const = 0;
229 virtual PlaylistSelector
& playlist_selector() const = 0;
230 virtual void clear_playlist (boost::shared_ptr
<ARDOUR::Playlist
>) = 0;
231 virtual void new_playlists (TimeAxisView
*) = 0;
232 virtual void copy_playlists (TimeAxisView
*) = 0;
233 virtual void clear_playlists (TimeAxisView
*) = 0;
234 virtual void select_all_tracks () = 0;
235 virtual void set_selected_track (TimeAxisView
&, Selection::Operation op
= Selection::Set
, bool no_remove
= false) = 0;
236 virtual void set_selected_mixer_strip (TimeAxisView
&) = 0;
237 virtual void hide_track_in_display (TimeAxisView
* tv
, bool apply_to_selection
= false) = 0;
239 virtual void set_stationary_playhead (bool yn
) = 0;
240 virtual void toggle_stationary_playhead () = 0;
241 virtual bool stationary_playhead() const = 0;
243 /** Set whether the editor should follow the playhead.
244 * @param yn true to follow playhead, otherwise false.
245 * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
247 virtual void set_follow_playhead (bool yn
, bool catch_up
= false) = 0;
249 /** Toggle whether the editor is following the playhead */
250 virtual void toggle_follow_playhead () = 0;
252 /** @return true if the editor is following the playhead */
253 virtual bool follow_playhead () const = 0;
255 /** @return true if the playhead is currently being dragged, otherwise false */
256 virtual bool dragging_playhead () const = 0;
257 virtual void ensure_float (Gtk::Window
&) = 0;
258 virtual void show_window () = 0;
259 virtual framepos_t
leftmost_position() const = 0;
260 virtual framecnt_t
current_page_frames() const = 0;
261 virtual void temporal_zoom_step (bool coarser
) = 0;
262 virtual void scroll_tracks_down_line () = 0;
263 virtual void scroll_tracks_up_line () = 0;
264 virtual void prepare_for_cleanup () = 0;
265 virtual void finish_cleanup () = 0;
266 virtual void reset_x_origin (framepos_t frame
) = 0;
267 virtual void remove_last_capture () = 0;
268 virtual void maximise_editing_space () = 0;
269 virtual void restore_editing_space () = 0;
270 virtual framepos_t
get_preferred_edit_position (bool ignore_playhead
= false) = 0;
271 virtual void toggle_meter_updating() = 0;
272 virtual void split_region_at_points (boost::shared_ptr
<ARDOUR::Region
>, ARDOUR::AnalysisFeatureList
&, bool can_ferret
, bool select_new
= false) = 0;
273 virtual void mouse_add_new_marker (framepos_t where
, bool is_cd
=false, bool is_xrun
=false) = 0;
274 virtual void foreach_time_axis_view (sigc::slot
<void,TimeAxisView
&>) = 0;
275 virtual void add_to_idle_resize (TimeAxisView
*, int32_t) = 0;
276 virtual framecnt_t
get_nudge_distance (framepos_t pos
, framecnt_t
& next
) = 0;
277 virtual Evoral::MusicalTime
get_grid_type_as_beats (bool& success
, framepos_t position
) = 0;
280 virtual void connect_to_image_compositor() = 0;
281 virtual void add_imageframe_time_axis(const std::string
& track_name
, void*) = 0;
282 virtual void add_imageframe_marker_time_axis(const std::string
& track_name
, TimeAxisView
* marked_track
, void*) = 0;
283 virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem
* item
) = 0;
284 virtual TimeAxisView
* get_named_time_axis(const std::string
& name
) = 0;
287 virtual RouteTimeAxisView
* get_route_view_by_route_id (PBD::ID
& id
) const = 0;
289 virtual void get_equivalent_regions (RegionView
* rv
, std::vector
<RegionView
*>&, PBD::PropertyID
) const = 0;
291 sigc::signal
<void> ZoomChanged
;
292 /** Emitted when the horizontal position of the editor view changes */
293 sigc::signal
<void> HorizontalPositionChanged
;
294 sigc::signal
<void> Realized
;
295 sigc::signal
<void,framepos_t
> UpdateAllTransportClocks
;
297 static sigc::signal
<void> DropDownKeys
;
299 Glib::RefPtr
<Gtk::ActionGroup
> editor_actions
;
300 Glib::RefPtr
<Gtk::ActionGroup
> _region_actions
;
302 virtual void reset_focus () = 0;
304 virtual bool canvas_control_point_event (GdkEvent
* event
, ArdourCanvas::Item
*, ControlPoint
*) = 0;
305 virtual bool canvas_line_event (GdkEvent
* event
, ArdourCanvas::Item
*, AutomationLine
*) = 0;
306 virtual bool canvas_selection_rect_event (GdkEvent
* event
, ArdourCanvas::Item
*, SelectionRect
*) = 0;
307 virtual bool canvas_selection_start_trim_event (GdkEvent
* event
, ArdourCanvas::Item
*, SelectionRect
*) = 0;
308 virtual bool canvas_selection_end_trim_event (GdkEvent
* event
, ArdourCanvas::Item
*, SelectionRect
*) = 0;
309 virtual bool canvas_crossfade_view_event (GdkEvent
* event
, ArdourCanvas::Item
*, CrossfadeView
*) = 0;
310 virtual bool canvas_fade_in_event (GdkEvent
* event
, ArdourCanvas::Item
*, AudioRegionView
*) = 0;
311 virtual bool canvas_fade_in_handle_event (GdkEvent
* event
, ArdourCanvas::Item
*, AudioRegionView
*) = 0;
312 virtual bool canvas_fade_out_event (GdkEvent
* event
, ArdourCanvas::Item
*, AudioRegionView
*) = 0;
313 virtual bool canvas_fade_out_handle_event (GdkEvent
* event
, ArdourCanvas::Item
*, AudioRegionView
*) = 0;
314 virtual bool canvas_region_view_event (GdkEvent
* event
, ArdourCanvas::Item
*, RegionView
*) = 0;
315 virtual bool canvas_frame_handle_event (GdkEvent
* event
, ArdourCanvas::Item
*, RegionView
*) = 0;
316 virtual bool canvas_region_view_name_highlight_event (GdkEvent
* event
, ArdourCanvas::Item
*, RegionView
*) = 0;
317 virtual bool canvas_region_view_name_event (GdkEvent
* event
, ArdourCanvas::Item
*, RegionView
*) = 0;
318 virtual bool canvas_feature_line_event (GdkEvent
* event
, ArdourCanvas::Item
*, RegionView
*) = 0;
319 virtual bool canvas_stream_view_event (GdkEvent
* event
, ArdourCanvas::Item
*, RouteTimeAxisView
*) = 0;
320 virtual bool canvas_marker_event (GdkEvent
* event
, ArdourCanvas::Item
*, Marker
*) = 0;
321 virtual bool canvas_zoom_rect_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
322 virtual bool canvas_tempo_marker_event (GdkEvent
* event
, ArdourCanvas::Item
*, TempoMarker
*) = 0;
323 virtual bool canvas_meter_marker_event (GdkEvent
* event
, ArdourCanvas::Item
*, MeterMarker
*) = 0;
324 virtual bool canvas_automation_track_event(GdkEvent
* event
, ArdourCanvas::Item
*, AutomationTimeAxisView
*) = 0;
326 virtual bool canvas_tempo_bar_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
327 virtual bool canvas_meter_bar_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
328 virtual bool canvas_marker_bar_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
329 virtual bool canvas_range_marker_bar_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
330 virtual bool canvas_transport_marker_bar_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
331 virtual bool canvas_note_event (GdkEvent
* event
, ArdourCanvas::Item
*) = 0;
334 virtual bool canvas_imageframe_item_view_event(GdkEvent
* event
, ArdourCanvas::Item
*,ImageFrameView
*) = 0;
335 virtual bool canvas_imageframe_view_event(GdkEvent
* event
, ArdourCanvas::Item
*,ImageFrameTimeAxis
*) = 0;
336 virtual bool canvas_imageframe_start_handle_event(GdkEvent
* event
, ArdourCanvas::Item
*,ImageFrameView
*) = 0;
337 virtual bool canvas_imageframe_end_handle_event(GdkEvent
* event
, ArdourCanvas::Item
*,ImageFrameView
*) = 0;
338 virtual bool canvas_marker_time_axis_view_event(GdkEvent
* event
, ArdourCanvas::Item
*,MarkerTimeAxis
*) = 0;
339 virtual bool canvas_markerview_item_view_event(GdkEvent
* event
, ArdourCanvas::Item
*,MarkerView
*) = 0;
340 virtual bool canvas_markerview_start_handle_event(GdkEvent
* event
, ArdourCanvas::Item
*,MarkerView
*) = 0;
341 virtual bool canvas_markerview_end_handle_event(GdkEvent
* event
, ArdourCanvas::Item
*,MarkerView
*) = 0;
344 static const int window_border_width
;
345 static const int container_border_width
;
346 static const int vertical_spacing
;
347 static const int horizontal_spacing
;
351 * This is needed for OS X primarily
352 * but also any other OS that uses a single
353 * top menubar instead of per window menus
355 virtual Gtk::HBox
& get_status_bar_packer() = 0;
358 virtual gdouble
get_trackview_group_vertical_offset () const = 0;
359 virtual double get_canvas_timebars_vsize () const = 0;
360 virtual ArdourCanvas::Group
* get_trackview_group () const = 0;
361 virtual ArdourCanvas::Group
* get_background_group () const = 0;
363 virtual TimeAxisView
* axis_view_from_route (boost::shared_ptr
<ARDOUR::Route
>) const = 0;
365 virtual void set_current_trimmable (boost::shared_ptr
<ARDOUR::Trimmable
>) = 0;
366 virtual void set_current_movable (boost::shared_ptr
<ARDOUR::Movable
>) = 0;
368 virtual void center_screen (framepos_t
) = 0;
370 virtual TrackViewList
axis_views_from_routes (boost::shared_ptr
<ARDOUR::RouteList
>) const = 0;
371 virtual TrackViewList
const & get_track_views () = 0;
373 virtual Gtkmm2ext::TearOff
* mouse_mode_tearoff () const = 0;
374 virtual Gtkmm2ext::TearOff
* tools_tearoff () const = 0;
376 virtual DragManager
* drags () const = 0;
377 virtual void maybe_autoscroll (bool, bool) = 0;
378 virtual void stop_canvas_autoscroll () = 0;
380 virtual MouseCursors
const * cursors () const = 0;
381 virtual VerboseCursor
* verbose_cursor () const = 0;
383 virtual void get_pointer_position (double &, double &) const = 0;
385 /// Singleton instance, set up by Editor::Editor()
387 static PublicEditor
* _instance
;
389 friend bool relay_key_press (GdkEventKey
*, Gtk::Window
*);
390 friend bool forward_key_press (GdkEventKey
*);
392 PBD::Signal0
<void> SnapChanged
;
393 PBD::Signal0
<void> MouseModeChanged
;
396 #endif // __gtk_ardour_public_editor_h__