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__
27 #include <gdk/gdktypes.h>
28 #include <gtkmm/window.h>
29 #include <gtkmm/actiongroup.h>
30 #include <jack/types.h>
31 #include <sigc++/signal.h>
33 #include <pbd/statefuldestructible.h>
37 #include "selection.h"
41 class ExportSpecification;
53 class TimeAxisViewItem;
57 class PlaylistSelector;
64 class RouteTimeAxisView;
66 class AudioRegionView;
70 class AutomationTimeAxisView;
73 class ImageFrameTimeAxis;
76 /// Representation of the interface of the Editor class
78 /** This class contains just the public interface of the Editor class,
79 * in order to decouple it from the private implementation, so that callers
80 * of PublicEditor need not be recompiled if private methods or member variables
83 class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway {
86 virtual ~PublicEditor ();
88 typedef TrackSelection TrackViewList;
90 /** @return Singleton PublicEditor instance */
91 static PublicEditor& instance () { return *_instance; }
93 virtual bool have_idled() const = 0;
94 virtual void first_idle() = 0;
96 /** Attach this editor to a Session.
97 * @param s Session to connect to.
99 virtual void connect_to_session (ARDOUR::Session* s) = 0;
101 /** @return The Session that we are editing, or 0 */
102 virtual ARDOUR::Session* current_session () const = 0;
104 /** Set the snap type.
105 * @param t Snap type (defined in editing_syms.h)
107 virtual void set_snap_to (Editing::SnapType t) = 0;
109 /** Set the snap mode.
110 * @param m Snap mode (defined in editing_syms.h)
112 virtual void set_snap_mode (Editing::SnapMode m) = 0;
114 /** Set the snap threshold.
115 * @param t Snap threshold in `units'.
117 virtual void set_snap_threshold (double t) = 0;
119 /** Snap a value according to the current snap setting. */
120 virtual void snap_to (nframes_t& first, int32_t direction = 0, bool for_mark = false) = 0;
122 /** Get the current snap value in beats */
123 virtual double snap_length_beats (nframes_t start) = 0;
125 /** Undo some transactions.
126 * @param n Number of transactions to undo.
128 virtual void undo (uint32_t n = 1) = 0;
130 /** Redo some transactions.
131 * @param n Number of transaction to redo.
133 virtual void redo (uint32_t n = 1) = 0;
135 /** Set the mouse mode (gain, object, range, timefx etc.)
136 * @param m Mouse mode (defined in editing_syms.h)
137 * @param force Perform the effects of the change even if no change is required
138 * (ie even if the current mouse mode is equal to \ref m)
140 virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
142 /** Step the mouse mode onto the next or previous one.
143 * @param next true to move to the next, otherwise move to the previous
145 virtual void step_mouse_mode (bool next) = 0;
147 /** @return The current mouse mode (gain, object, range, timefx etc.)
148 * (defined in editing_syms.h)
150 virtual Editing::MouseMode current_mouse_mode () const = 0;
152 /** Set the midi edit mode (pencil, select, eraser, etc.)
153 * @param m Midi edit mode (defined in editing_syms.h)
154 * @param force Perform the effects of the change even if no change is required
155 * (ie even if the current midi edit mode is equal to \ref m)
157 virtual void set_midi_edit_mode (Editing::MidiEditMode m, bool force = false) = 0;
159 /** @return The current mouse mode (gain, object, range, timefx etc.)
160 * (defined in editing_syms.h)
162 virtual Editing::MidiEditMode current_midi_edit_mode () const = 0;
164 /** Possibly start the audition of a region. If \ref r is 0, or not an AudioRegion
165 * any current audition is cancelled. If we are currently auditioning \ref r,
166 * the audition will be cancelled. Otherwise an audition of \ref r will start.
167 * \param r Region to consider.
169 virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
171 /** Set whether waveforms should be shown for audio tracks.
172 * @param yn true to show waveforms, otherwise false.
174 virtual void set_show_waveforms (bool yn) = 0;
176 /** @return true if waveforms are being shown, otherwise false */
177 virtual bool show_waveforms () const = 0;
179 /** Set whether waveforms should be shown while recording audio tracks.
180 * @param yn true to show waveforms, otherwise false.
182 virtual void set_show_waveforms_recording (bool yn) = 0;
184 /** @return true if waveforms are being shown while recording, otherwise false */
185 virtual bool show_waveforms_recording () const = 0;
186 virtual void new_region_from_selection () = 0;
187 virtual void separate_region_from_selection () = 0;
189 virtual void toggle_playback (bool with_abort) = 0;
190 virtual void transition_to_rolling (bool fwd) = 0;
191 virtual nframes_t unit_to_frame (double unit) const = 0;
192 virtual double frame_to_unit (nframes_t frame) const = 0;
193 virtual double frame_to_unit (double frame) const = 0;
194 virtual nframes64_t pixel_to_frame (double pixel) const = 0;
195 virtual gulong frame_to_pixel (nframes64_t frame) const = 0;
196 virtual Selection& get_selection () const = 0;
197 virtual Selection& get_cut_buffer () const = 0;
198 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
199 virtual void play_selection () = 0;
200 virtual void set_show_measures (bool yn) = 0;
201 virtual bool show_measures () const = 0;
202 virtual bool redraw_measures () = 0;
204 /** Open an export dialogue for the whole session */
205 virtual void export_session () = 0;
207 /** Open an export dialogue for currently selected time range, if there
208 * is one; if not an error is displayed to the user.
210 virtual void export_selection () = 0;
212 /** Open an export dialogue for marked ranges */
213 virtual void export_range_markers () = 0;
214 virtual void register_actions () = 0;
215 virtual void add_toplevel_controls (Gtk::Container&) = 0;
216 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
217 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
218 virtual gdouble get_current_zoom () const = 0;
219 virtual PlaylistSelector& playlist_selector() const = 0;
220 virtual void route_name_changed (TimeAxisView *) = 0;
221 virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
222 virtual void new_playlists (TimeAxisView*) = 0;
223 virtual void copy_playlists (TimeAxisView*) = 0;
224 virtual void clear_playlists (TimeAxisView*) = 0;
225 virtual void select_all_tracks () = 0;
226 virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
227 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
228 virtual void hide_track_in_display (TimeAxisView& tv) = 0;
229 virtual void show_track_in_display (TimeAxisView& tv) = 0;
231 /** Set whether the editor should follow the playhead.
232 * @param yn true to follow playhead, otherwise false.
234 virtual void set_follow_playhead (bool yn) = 0;
236 /** Toggle whether the editor is following the playhead */
237 virtual void toggle_follow_playhead () = 0;
239 /** @return true if the editor is following the playhead */
240 virtual bool follow_playhead () const = 0;
242 /** @return true if the playhead is currently being dragged, otherwise false */
243 virtual bool dragging_playhead () const = 0;
244 virtual void ensure_float (Gtk::Window&) = 0;
245 virtual void show_window () = 0;
246 virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
247 virtual nframes_t leftmost_position () const = 0;
248 virtual nframes_t current_page_frames () const = 0;
249 virtual void temporal_zoom_step (bool coarser) = 0;
250 virtual void scroll_tracks_down_line () = 0;
251 virtual void scroll_tracks_up_line () = 0;
252 virtual bool new_regionviews_display_gain () = 0;
253 virtual void prepare_for_cleanup () = 0;
254 virtual void reset_x_origin (nframes_t frame) = 0;
255 virtual void remove_last_capture () = 0;
256 virtual void maximise_editing_space () = 0;
257 virtual void restore_editing_space () = 0;
258 virtual nframes64_t get_preferred_edit_position (bool ignore_playhead = false) = 0;
259 virtual void toggle_meter_updating() = 0;
260 virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret) = 0;
261 virtual void mouse_add_new_marker (nframes_t where, bool is_cd=false, bool is_xrun=false) = 0;
262 virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
265 virtual void add_imageframe_time_axis(const std::string & track_name, void*) = 0;
266 virtual void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*) = 0;
267 virtual void connect_to_image_compositor() = 0;
268 virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item) = 0;
269 virtual TimeAxisView* get_named_time_axis(const std::string & name) = 0;
272 virtual RouteTimeAxisView* get_route_view_by_id (PBD::ID& id) = 0;
274 virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&) const = 0;
276 sigc::signal<void> ZoomFocusChanged;
277 sigc::signal<void> ZoomChanged;
278 sigc::signal<void> Resized;
279 sigc::signal<void> Realized;
280 sigc::signal<void,nframes_t> UpdateAllTransportClocks;
282 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
284 virtual void reset_focus () = 0;
286 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
287 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
288 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
289 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
290 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
291 virtual bool canvas_crossfade_view_event (GdkEvent* event, ArdourCanvas::Item*, CrossfadeView*) = 0;
292 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
293 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
294 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
295 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
296 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
297 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
298 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
299 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
300 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
301 virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
302 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
303 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
304 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
306 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
307 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
308 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
309 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
310 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
313 virtual bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
314 virtual bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*) = 0;
315 virtual bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
316 virtual bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
317 virtual bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*) = 0;
318 virtual bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
319 virtual bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
320 virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
323 /// Singleton instance, set up by Editor::Editor()
324 static PublicEditor* _instance;
326 friend class PluginUIWindow;
329 #endif // __gtk_ardour_public_editor_h__