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 AudioExportSpecification;
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 list<TimeAxisView *> TrackViewList;
90 /** @return Singleton PublicEditor instance */
91 static PublicEditor& instance () { return *_instance; }
93 /** Attach this editor to a Session.
94 * @param s Session to connect to.
96 virtual void connect_to_session (ARDOUR::Session* s) = 0;
98 /** @return The Session that we are editing, or 0 */
99 virtual ARDOUR::Session* current_session () const = 0;
101 /** Set the snap type.
102 * @param t Snap type (defined in editing_syms.h)
104 virtual void set_snap_to (Editing::SnapType t) = 0;
106 /** Set the snap mode.
107 * @param m Snap mode (defined in editing_syms.h)
109 virtual void set_snap_mode (Editing::SnapMode m) = 0;
111 /** Set the snap threshold.
112 * @param t Snap threshold in `units'.
114 virtual void set_snap_threshold (double t) = 0;
116 /** Snap a value according to the current snap setting. */
117 virtual void snap_to (nframes_t& first, int32_t direction = 0, bool for_mark = false) = 0;
119 /** Undo some transactions.
120 * @param n Number of transactions to undo.
122 virtual void undo (uint32_t n = 1) = 0;
124 /** Redo some transactions.
125 * @param n Number of transaction to redo.
127 virtual void redo (uint32_t n = 1) = 0;
129 /** Set the mouse mode (gain, object, range, timefx etc.)
130 * @param m Mouse mode (defined in editing_syms.h)
131 * @param force Perform the effects of the change even if no change is required
132 * (ie even if the current mouse mode is equal to \ref m)
134 virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
136 /** Step the mouse mode onto the next or previous one.
137 * @param next true to move to the next, otherwise move to the previous
139 virtual void step_mouse_mode (bool next) = 0;
141 /** @return The current mouse mode (gain, object, range, timefx etc.)
142 * (defined in editing_syms.h)
144 virtual Editing::MouseMode current_mouse_mode () const = 0;
146 /** Possibly start the audition of a region. If \ref r is 0, or not an AudioRegion
147 * any current audition is cancelled. If we are currently auditioning \ref r,
148 * the audition will be cancelled. Otherwise an audition of \ref r will start.
149 * \param r Region to consider.
151 virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
153 /** Set whether waveforms should be shown for audio tracks.
154 * @param yn true to show waveforms, otherwise false.
156 virtual void set_show_waveforms (bool yn) = 0;
158 /** @return true if waveforms are being shown, otherwise false */
159 virtual bool show_waveforms () const = 0;
161 /** Set whether waveforms should be shown while recording audio tracks.
162 * @param yn true to show waveforms, otherwise false.
164 virtual void set_show_waveforms_recording (bool yn) = 0;
166 /** @return true if waveforms are being shown while recording, otherwise false */
167 virtual bool show_waveforms_recording () const = 0;
168 virtual void new_region_from_selection () = 0;
169 virtual void separate_region_from_selection () = 0;
171 virtual void toggle_playback (bool with_abort) = 0;
172 virtual void transition_to_rolling (bool fwd) = 0;
173 virtual nframes_t unit_to_frame (double unit) = 0;
174 virtual double frame_to_unit (nframes_t frame) = 0;
175 virtual double frame_to_unit (double frame) = 0;
176 virtual nframes_t pixel_to_frame (double pixel) = 0;
177 virtual gulong frame_to_pixel (nframes_t frame) = 0;
178 virtual Selection& get_selection () const = 0;
179 virtual Selection& get_cut_buffer () const = 0;
180 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
181 virtual void play_selection () = 0;
182 virtual void set_show_measures (bool yn) = 0;
183 virtual bool show_measures () const = 0;
184 virtual bool redraw_measures () = 0;
186 /** Open an export dialogue for the whole session */
187 virtual void export_session () = 0;
189 /** Open an export dialogue for currently selected time range, if there
190 * is one; if not an error is displayed to the user.
192 virtual void export_selection () = 0;
194 /** Open an export dialogue for marked ranges */
195 virtual void export_range_markers () = 0;
196 virtual void register_actions () = 0;
197 virtual void add_toplevel_controls (Gtk::Container&) = 0;
198 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
199 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
200 virtual gdouble get_current_zoom () = 0;
201 virtual PlaylistSelector& playlist_selector () const = 0;
202 virtual void route_name_changed (TimeAxisView *) = 0;
203 virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
204 virtual void new_playlists () = 0;
205 virtual void copy_playlists () = 0;
206 virtual void clear_playlists () = 0;
207 virtual void select_all_tracks () = 0;
208 virtual bool set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
209 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
210 virtual void hide_track_in_display (TimeAxisView& tv) = 0;
211 virtual void show_track_in_display (TimeAxisView& tv) = 0;
213 /** Set whether the editor should follow the playhead.
214 * @param yn true to follow playhead, otherwise false.
216 virtual void set_follow_playhead (bool yn) = 0;
218 /** Toggle whether the editor is following the playhead */
219 virtual void toggle_follow_playhead () = 0;
221 /** @return true if the editor is following the playhead */
222 virtual bool follow_playhead () const = 0;
224 /** @return true if the playhead is currently being dragged, otherwise false */
225 virtual bool dragging_playhead () const = 0;
226 virtual void ensure_float (Gtk::Window&) = 0;
227 virtual void show_window () = 0;
228 virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
229 virtual nframes_t leftmost_position () const = 0;
230 virtual nframes_t current_page_frames () const = 0;
231 virtual void temporal_zoom_step (bool coarser) = 0;
232 virtual void scroll_tracks_down_line () = 0;
233 virtual void scroll_tracks_up_line () = 0;
234 virtual bool new_regionviews_display_gain () = 0;
235 virtual void prepare_for_cleanup () = 0;
236 virtual void reset_x_origin (nframes_t frame) = 0;
237 virtual void remove_last_capture () = 0;
238 virtual void maximise_editing_space () = 0;
239 virtual void restore_editing_space () = 0;
240 virtual nframes_t edit_cursor_position (bool sync) = 0;
243 virtual void add_imageframe_time_axis(const std::string & track_name, void*) = 0;
244 virtual void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*) = 0;
245 virtual void connect_to_image_compositor() = 0;
246 virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item) = 0;
247 virtual TimeAxisView* get_named_time_axis(const std::string & name) = 0;
250 sigc::signal<void> ZoomFocusChanged;
251 sigc::signal<void> ZoomChanged;
252 sigc::signal<void> Resized;
253 sigc::signal<void> Realized;
254 sigc::signal<void,nframes_t> UpdateAllTransportClocks;
256 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
258 virtual void reset_focus () = 0;
260 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
261 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
262 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
263 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
264 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
265 virtual bool canvas_crossfade_view_event (GdkEvent* event, ArdourCanvas::Item*, CrossfadeView*) = 0;
266 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
267 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
268 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
269 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
270 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
271 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
272 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
273 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
274 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
275 virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
276 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
277 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
278 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
280 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
281 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
282 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
283 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
284 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
287 virtual bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
288 virtual bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*) = 0;
289 virtual bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
290 virtual bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
291 virtual bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*) = 0;
292 virtual bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
293 virtual bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
294 virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
297 /// Singleton instance, set up by Editor::Editor()
298 static PublicEditor* _instance;
300 friend class PluginUIWindow;
303 #endif // __gtk_ardour_public_editor_h__