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/Note.hpp"
38 #include "evoral/types.hpp"
40 #include "pbd/statefuldestructible.h"
42 #include "canvas/fwd.h"
44 #include "gtkmm2ext/actions.h"
45 #include "gtkmm2ext/visibility_tracker.h"
48 #include "selection.h"
68 class AudioRegionView;
70 class AutomationTimeAxisView;
77 class PlaylistSelector;
81 class RouteTimeAxisView;
85 class TimeAxisViewItem;
90 class DisplaySuspender;
92 namespace ARDOUR_UI_UTILS {
93 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
94 bool forward_key_press (GdkEventKey* ev);
97 using ARDOUR::framepos_t;
98 using ARDOUR::framecnt_t;
100 /// Representation of the interface of the Editor class
102 /** This class contains just the public interface of the Editor class,
103 * in order to decouple it from the private implementation, so that callers
104 * of PublicEditor need not be recompiled if private methods or member variables
107 class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, public Gtkmm2ext::VisibilityTracker {
110 virtual ~PublicEditor ();
112 /** @return Singleton PublicEditor instance */
113 static PublicEditor& instance () { return *_instance; }
115 virtual bool have_idled() const = 0;
116 virtual void first_idle() = 0;
118 virtual void setup_tooltips() = 0;
120 /** Attach this editor to a Session.
121 * @param s Session to connect to.
123 virtual void set_session (ARDOUR::Session* s) = 0;
125 /** @return The Session that we are editing, or 0 */
126 virtual ARDOUR::Session* session () const = 0;
128 /** Set the snap type.
129 * @param t Snap type (defined in editing_syms.h)
131 virtual void set_snap_to (Editing::SnapType t) = 0;
133 virtual Editing::SnapType snap_type () const = 0;
134 virtual Editing::SnapMode snap_mode () const = 0;
136 /** Set the snap mode.
137 * @param m Snap mode (defined in editing_syms.h)
139 virtual void set_snap_mode (Editing::SnapMode m) = 0;
141 /** Set the snap threshold.
142 * @param t Snap threshold in `units'.
144 virtual void set_snap_threshold (double t) = 0;
147 * Snap a value according to the current snap setting.
148 * ensure_snap overrides SnapOff and magnetic snap
150 virtual void snap_to (framepos_t& first,
151 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
152 bool for_mark = false,
153 bool ensure_snap = false) = 0;
155 /** Undo some transactions.
156 * @param n Number of transactions to undo.
159 virtual void undo (uint32_t n = 1) = 0;
161 /** Redo some transactions.
162 * @param n Number of transaction to redo.
164 virtual void redo (uint32_t n = 1) = 0;
166 /** Set the mouse mode (gain, object, range, timefx etc.)
167 * @param m Mouse mode (defined in editing_syms.h)
168 * @param force Perform the effects of the change even if no change is required
169 * (ie even if the current mouse mode is equal to @param m)
171 virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
173 /** Step the mouse mode onto the next or previous one.
174 * @param next true to move to the next, otherwise move to the previous
176 virtual void step_mouse_mode (bool next) = 0;
178 /** @return The current mouse mode (gain, object, range, timefx etc.)
179 * (defined in editing_syms.h)
181 virtual Editing::MouseMode current_mouse_mode () const = 0;
183 /** @return Whether the current mouse mode is an "internal" editing mode.
185 virtual bool internal_editing() const = 0;
187 /** Possibly start the audition of a region. If @param r is 0, or not an AudioRegion
188 * any current audition is cancelled. If we are currently auditioning @param r,
189 * the audition will be cancelled. Otherwise an audition of @param r will start.
190 * \param r Region to consider.
192 virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
194 virtual void new_region_from_selection () = 0;
195 virtual void separate_region_from_selection () = 0;
197 virtual void transition_to_rolling (bool fwd) = 0;
198 virtual framepos_t pixel_to_sample (double pixel) const = 0;
199 virtual double sample_to_pixel (framepos_t frame) const = 0;
200 virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
201 virtual Selection& get_selection () const = 0;
202 virtual Selection& get_cut_buffer () const = 0;
203 virtual void track_mixer_selection () = 0;
204 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
205 virtual void play_selection () = 0;
206 virtual void play_with_preroll () = 0;
207 virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
208 virtual void goto_nth_marker (int nth) = 0;
209 virtual void add_location_from_playhead_cursor () = 0;
210 virtual void remove_location_at_playhead_cursor () = 0;
211 virtual void set_show_measures (bool yn) = 0;
212 virtual bool show_measures () const = 0;
213 virtual void remove_tracks () = 0;
215 virtual Editing::MouseMode effective_mouse_mode () const = 0;
217 /** Import existing media */
218 virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
219 virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, framepos_t&, boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
221 /** Open main export dialog */
222 virtual void export_audio () = 0;
224 /** Open stem export dialog */
225 virtual void stem_export () = 0;
227 /** Open export dialog with current selection pre-selected */
228 virtual void export_selection () = 0;
230 /** Open export dialog with current range pre-selected */
231 virtual void export_range () = 0;
233 virtual void register_actions () = 0;
234 virtual void add_transport_frame (Gtk::Container&) = 0;
235 virtual void add_toplevel_menu (Gtk::Container&) = 0;
236 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
237 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
238 virtual framecnt_t get_current_zoom () const = 0;
239 virtual void reset_zoom (framecnt_t) = 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 deselect_all () = 0;
247 virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
248 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
249 virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
251 virtual void set_stationary_playhead (bool yn) = 0;
252 virtual void toggle_stationary_playhead () = 0;
253 virtual bool stationary_playhead() const = 0;
255 /** Set whether the editor should follow the playhead.
256 * @param yn true to follow playhead, otherwise false.
257 * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
259 virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
261 /** Toggle whether the editor is following the playhead */
262 virtual void toggle_follow_playhead () = 0;
264 /** @return true if the editor is following the playhead */
265 virtual bool follow_playhead () const = 0;
267 /** @return true if the playhead is currently being dragged, otherwise false */
268 virtual bool dragging_playhead () const = 0;
269 virtual void ensure_float (Gtk::Window&) = 0;
270 virtual void show_window () = 0;
271 virtual framepos_t leftmost_sample() const = 0;
272 virtual framecnt_t current_page_samples() const = 0;
273 virtual double visible_canvas_height () const = 0;
274 virtual void temporal_zoom_step (bool coarser) = 0;
275 virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
276 virtual void override_visible_track_count () = 0;
277 virtual void scroll_tracks_down_line () = 0;
278 virtual void scroll_tracks_up_line () = 0;
279 virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
280 virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
281 virtual void prepare_for_cleanup () = 0;
282 virtual void finish_cleanup () = 0;
283 virtual void reset_x_origin (framepos_t frame) = 0;
284 virtual double get_y_origin () const = 0;
285 virtual void reset_y_origin (double pos) = 0;
286 virtual void remove_last_capture () = 0;
287 virtual void maximise_editing_space () = 0;
288 virtual void restore_editing_space () = 0;
289 virtual void update_tearoff_visibility () = 0;
290 virtual void reattach_all_tearoffs () = 0;
291 virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
292 virtual void toggle_meter_updating() = 0;
293 virtual void split_regions_at (framepos_t, RegionSelection&) = 0;
294 virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
295 virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
296 virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
297 virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
298 virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
299 virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
300 virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
301 virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
302 virtual void edit_notes (MidiRegionView*) = 0;
304 virtual void queue_visual_videotimeline_update () = 0;
305 virtual void set_close_video_sensitive (bool) = 0;
306 virtual void toggle_ruler_video (bool) = 0;
307 virtual void toggle_xjadeo_proc (int) = 0;
308 virtual void toggle_xjadeo_viewoption (int, int) = 0;
309 virtual void set_xjadeo_sensitive (bool onoff) = 0;
310 virtual int get_videotl_bar_height () const = 0;
311 virtual void set_video_timeline_height (const int h) = 0;
312 virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
314 virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
316 virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
318 sigc::signal<void> ZoomChanged;
319 sigc::signal<void> Realized;
320 sigc::signal<void,framepos_t> UpdateAllTransportClocks;
322 static sigc::signal<void> DropDownKeys;
324 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
325 Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
326 Glib::RefPtr<Gtk::ActionGroup> _region_actions;
328 virtual void reset_focus () = 0;
330 virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
331 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
332 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
333 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
334 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
335 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
336 virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
337 virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
338 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
339 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
340 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
341 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
342 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
343 virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
344 virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
345 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
346 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
347 virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
348 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
349 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
350 virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
351 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
352 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
353 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
355 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
356 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
357 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
358 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
359 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
360 virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
362 static const int window_border_width;
363 static const int container_border_width;
364 static const int vertical_spacing;
365 static const int horizontal_spacing;
369 * This is needed for OS X primarily
370 * but also any other OS that uses a single
371 * top menubar instead of per window menus
373 virtual Gtk::HBox& get_status_bar_packer() = 0;
376 virtual ArdourCanvas::Container* get_trackview_group () const = 0;
377 virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
378 virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
379 virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
381 virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
383 virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
385 virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
386 virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
388 virtual void center_screen (framepos_t) = 0;
390 virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
391 virtual TrackViewList const & get_track_views () = 0;
393 virtual Gtkmm2ext::TearOff* mouse_mode_tearoff () const = 0;
394 virtual Gtkmm2ext::TearOff* tools_tearoff () const = 0;
396 virtual DragManager* drags () const = 0;
397 virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
398 virtual void stop_canvas_autoscroll () = 0;
399 virtual bool autoscroll_active() const = 0;
401 virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
402 virtual void commit_reversible_selection_op () = 0;
403 virtual void begin_reversible_command (std::string cmd_name) = 0;
404 virtual void begin_reversible_command (GQuark) = 0;
405 virtual void abort_reversible_command () = 0;
406 virtual void commit_reversible_command () = 0;
408 virtual MouseCursors const * cursors () const = 0;
409 virtual VerboseCursor * verbose_cursor () const = 0;
411 virtual bool get_smart_mode () const = 0;
413 virtual void get_pointer_position (double &, double &) const = 0;
415 virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
416 virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
418 virtual void snap_to_with_modifier (framepos_t & first,
420 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
421 bool for_mark = false) = 0;
423 virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
424 virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
425 virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
426 virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
427 virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
429 virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
430 virtual void mouse_add_new_meter_event (framepos_t where) = 0;
431 virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
432 virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
434 /// Singleton instance, set up by Editor::Editor()
436 static PublicEditor* _instance;
438 friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
439 friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
441 PBD::Signal0<void> SnapChanged;
442 PBD::Signal0<void> MouseModeChanged;
445 friend class DisplaySuspender;
446 virtual void suspend_route_redisplay () = 0;
447 virtual void resume_route_redisplay () = 0;
448 gint _suspend_route_redisplay_counter;
451 class DisplaySuspender {
454 if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
455 PublicEditor::instance().suspend_route_redisplay ();
458 ~DisplaySuspender () {
459 if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
460 PublicEditor::instance().resume_route_redisplay ();
465 class MainMenuDisabler {
467 MainMenuDisabler () {
468 /* The global menu bar continues to be accessible to applications
469 with modal dialogs on mac, which means that we need to desensitize
470 all items in the menu bar.
472 ActionManager::disable_active_actions ();
475 ~MainMenuDisabler () {
476 ActionManager::enable_active_actions ();
480 #endif // __gtk_ardour_public_editor_h__