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 <gtkmm/notebook.h>
36 #include <sigc++/signal.h>
38 #include "pbd/statefuldestructible.h"
40 #include "temporal/beats.h"
42 #include "evoral/Note.hpp"
44 #include "ardour/session_handle.h"
46 #include "canvas/fwd.h"
48 #include "gtkmm2ext/actions.h"
49 #include "gtkmm2ext/bindings.h"
50 #include "gtkmm2ext/visibility_tracker.h"
52 #include "widgets/tabbable.h"
54 #include "axis_provider.h"
56 #include "selection.h"
73 class AudioRegionView;
75 class AutomationTimeAxisView;
82 class PlaylistSelector;
86 class RouteTimeAxisView;
88 class StripableTimeAxisView;
92 class TimeAxisViewItem;
97 class DisplaySuspender;
99 namespace ARDOUR_UI_UTILS {
100 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
101 bool forward_key_press (GdkEventKey* ev);
104 using ARDOUR::samplepos_t;
105 using ARDOUR::samplecnt_t;
107 /// Representation of the interface of the Editor class
109 /** This class contains just the public interface of the Editor class,
110 * in order to decouple it from the private implementation, so that callers
111 * of PublicEditor need not be recompiled if private methods or member variables
114 class PublicEditor : public ArdourWidgets::Tabbable, public ARDOUR::SessionHandlePtr, public AxisViewProvider, public Gtkmm2ext::ActionMapOwner
117 PublicEditor (Gtk::Widget& content);
118 virtual ~PublicEditor ();
120 /** @return Singleton PublicEditor instance */
121 static PublicEditor& instance () { return *_instance; }
123 virtual bool have_idled() const = 0;
124 virtual void first_idle() = 0;
126 virtual void setup_tooltips() = 0;
128 /** Attach this editor to a Session.
129 * @param s Session to connect to.
131 virtual void set_session (ARDOUR::Session* s) = 0;
133 /** Set the snap type.
134 * @param t Snap type (defined in editing_syms.h)
136 virtual void set_grid_to (Editing::GridType t) = 0;
138 virtual Editing::GridType grid_type () const = 0;
139 virtual Editing::SnapMode snap_mode () const = 0;
141 /** Set the snap mode.
142 * @param m Snap mode (defined in editing_syms.h)
144 virtual void set_snap_mode (Editing::SnapMode m) = 0;
147 * Snap a value according to the current snap setting.
148 * ensure_snap overrides SnapOff and magnetic snap
150 virtual void snap_to (ARDOUR::MusicSample& first,
151 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
152 ARDOUR::SnapPref gpref = ARDOUR::SnapToAny_Visual,
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. */
184 virtual bool internal_editing() const = 0;
186 /** Possibly start the audition of a region. If @param r is 0, or not an AudioRegion
187 * any current audition is cancelled. If we are currently auditioning @param r,
188 * the audition will be cancelled. Otherwise an audition of @param r will start.
189 * \param r Region to consider.
191 virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
193 /* import dialogs -> ardour-ui ?! */
194 virtual void external_audio_dialog () = 0;
195 virtual void session_import_dialog () = 0;
197 virtual void new_region_from_selection () = 0;
198 virtual void separate_region_from_selection () = 0;
200 virtual void transition_to_rolling (bool fwd) = 0;
201 virtual samplepos_t pixel_to_sample (double pixel) const = 0;
202 virtual samplepos_t playhead_cursor_sample () const = 0;
203 virtual double sample_to_pixel (samplepos_t sample) const = 0;
204 virtual double sample_to_pixel_unrounded (samplepos_t sample) const = 0;
206 virtual Selection& get_selection () const = 0;
207 virtual bool get_selection_extents (samplepos_t &start, samplepos_t &end) const = 0;
208 virtual Selection& get_cut_buffer () const = 0;
210 virtual void set_selection (std::list<Selectable*>, Selection::Operation) = 0;
212 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
213 virtual void play_solo_selection(bool restart) = 0;
214 virtual void play_selection () = 0;
215 virtual void play_with_preroll () = 0;
216 virtual void rec_with_preroll () = 0;
217 virtual void rec_with_count_in () = 0;
218 virtual void maybe_locate_with_edit_preroll (samplepos_t location) = 0;
219 virtual void goto_nth_marker (int nth) = 0;
220 virtual void trigger_script (int nth) = 0;
221 virtual void add_location_from_playhead_cursor () = 0;
222 virtual void remove_location_at_playhead_cursor () = 0;
223 virtual void update_grid () = 0;
224 virtual void remove_tracks () = 0;
225 virtual void set_loop_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
226 virtual void set_punch_range (samplepos_t start, samplepos_t end, std::string cmd) = 0;
228 virtual void jump_forward_to_mark () = 0;
229 virtual void jump_backward_to_mark () = 0;
231 virtual void set_session_start_from_playhead () = 0;
232 virtual void set_session_end_from_playhead () = 0;
234 virtual void toggle_location_at_playhead_cursor () = 0;
236 virtual void nudge_forward (bool next, bool force_playhead) = 0;
237 virtual void nudge_backward (bool next, bool force_playhead) = 0;
239 virtual void playhead_forward_to_grid () = 0;
240 virtual void playhead_backward_to_grid () = 0;
242 virtual void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
243 virtual void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
245 virtual void set_punch_start_from_edit_point () = 0;
246 virtual void set_punch_end_from_edit_point () = 0;
247 virtual void set_loop_start_from_edit_point () = 0;
248 virtual void set_loop_end_from_edit_point () = 0;
250 virtual Editing::MouseMode effective_mouse_mode () const = 0;
252 /** Import existing media */
253 virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality,
254 ARDOUR::MidiTrackNameSource, ARDOUR::MidiTempoMapDisposition, samplepos_t&,
255 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
256 virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,
258 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
260 /** Open main export dialog */
261 virtual void export_audio () = 0;
263 /** Open stem export dialog */
264 virtual void stem_export () = 0;
266 /** Open export dialog with current selection pre-selected */
267 virtual void export_selection () = 0;
269 /** Open export dialog with current range pre-selected */
270 virtual void export_range () = 0;
272 virtual void register_actions () = 0;
273 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
274 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
275 virtual samplecnt_t get_current_zoom () const = 0;
276 virtual void reset_zoom (samplecnt_t) = 0;
277 virtual PlaylistSelector& playlist_selector() const = 0;
278 virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
279 virtual void new_playlists (TimeAxisView*) = 0;
280 virtual void copy_playlists (TimeAxisView*) = 0;
281 virtual void clear_playlists (TimeAxisView*) = 0;
282 virtual void select_all_tracks () = 0;
283 virtual void deselect_all () = 0;
284 virtual void invert_selection () = 0;
285 virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
286 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
287 virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
288 virtual void show_track_in_display (TimeAxisView* tv, bool move_into_view = false) = 0;
290 virtual void set_stationary_playhead (bool yn) = 0;
291 virtual void toggle_stationary_playhead () = 0;
292 virtual bool stationary_playhead() const = 0;
294 /** Set whether the editor should follow the playhead.
295 * @param yn true to follow playhead, otherwise false.
296 * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
298 virtual void set_follow_playhead (bool yn, bool catch_up = true) = 0;
300 /** Toggle whether the editor is following the playhead */
301 virtual void toggle_follow_playhead () = 0;
303 /** @return true if the editor is following the playhead */
304 virtual bool follow_playhead () const = 0;
306 /** @return true if the playhead is currently being dragged, otherwise false */
307 virtual bool dragging_playhead () const = 0;
308 virtual samplepos_t leftmost_sample() const = 0;
309 virtual samplecnt_t current_page_samples() const = 0;
310 virtual double visible_canvas_height () const = 0;
311 virtual void temporal_zoom_step (bool coarser) = 0;
312 virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
313 virtual void override_visible_track_count () = 0;
314 virtual void scroll_tracks_down_line () = 0;
315 virtual void scroll_tracks_up_line () = 0;
316 virtual bool scroll_down_one_track (bool skip_child_views = false) = 0;
317 virtual bool scroll_up_one_track (bool skip_child_views = false) = 0;
318 virtual void select_topmost_track () = 0;
319 virtual void prepare_for_cleanup () = 0;
320 virtual void finish_cleanup () = 0;
321 virtual void reset_x_origin (samplepos_t sample) = 0;
322 virtual double get_y_origin () const = 0;
323 virtual void reset_y_origin (double pos) = 0;
324 virtual void set_visible_track_count (int32_t) = 0;
325 virtual void fit_selection () = 0;
326 virtual void remove_last_capture () = 0;
327 virtual void maximise_editing_space () = 0;
328 virtual void restore_editing_space () = 0;
329 virtual samplepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
330 virtual void toggle_meter_updating() = 0;
331 virtual void split_regions_at (ARDOUR::MusicSample, RegionSelection&) = 0;
332 virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
333 virtual void mouse_add_new_marker (samplepos_t where, bool is_cd=false) = 0;
334 virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
335 virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
336 virtual samplecnt_t get_nudge_distance (samplepos_t pos, samplecnt_t& next) = 0;
337 virtual samplecnt_t get_paste_offset (samplepos_t pos, unsigned paste_count, samplecnt_t duration) = 0;
338 virtual unsigned get_grid_beat_divisions(samplepos_t position) = 0;
339 virtual Temporal::Beats get_grid_type_as_beats (bool& success, samplepos_t position) = 0;
340 virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
341 virtual void edit_notes (MidiRegionView*) = 0;
343 virtual void queue_visual_videotimeline_update () = 0;
344 virtual void set_close_video_sensitive (bool) = 0;
345 virtual void toggle_ruler_video (bool) = 0;
346 virtual void toggle_xjadeo_proc (int) = 0;
347 virtual void toggle_xjadeo_viewoption (int, int) = 0;
348 virtual void set_xjadeo_sensitive (bool onoff) = 0;
349 virtual int get_videotl_bar_height () const = 0;
350 virtual void set_video_timeline_height (const int h) = 0;
351 virtual void embed_audio_from_video (std::string, samplepos_t n = 0, bool lock_position_to_video = true) = 0;
353 virtual bool track_selection_change_without_scroll () const = 0;
355 virtual StripableTimeAxisView* get_stripable_time_axis_by_id (const PBD::ID& id) const = 0;
357 virtual TimeAxisView* time_axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable> s) const = 0;
359 virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
360 virtual RegionView* regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const = 0;
361 virtual RouteTimeAxisView* rtav_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
363 sigc::signal<void> ZoomChanged;
364 sigc::signal<void> Realized;
365 sigc::signal<void,samplepos_t> UpdateAllTransportClocks;
367 static sigc::signal<void> DropDownKeys;
369 struct RegionAction {
370 Glib::RefPtr<Gtk::Action> action;
371 Editing::RegionActionTarget target;
373 RegionAction (Glib::RefPtr<Gtk::Action> a, Editing::RegionActionTarget tgt)
374 : action (a), target (tgt) {}
377 std::map<std::string,RegionAction> region_action_map;
379 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
380 Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
381 Glib::RefPtr<Gtk::ActionGroup> _region_actions;
383 virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
384 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
385 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
386 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
387 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
388 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
389 virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
390 virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
391 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
392 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
393 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
394 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
395 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
396 virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
397 virtual bool canvas_sample_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
398 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
399 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
400 virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
401 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
402 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
403 virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
404 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
405 virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
406 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
407 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
409 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
410 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
411 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
412 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
413 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
414 virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
416 static const int window_border_width;
417 static const int container_border_width;
418 static const int vertical_spacing;
419 static const int horizontal_spacing;
421 virtual ArdourCanvas::Container* get_trackview_group () const = 0;
422 virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
423 virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
424 virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
425 virtual ArdourCanvas::Container* get_drag_motion_group () const = 0;
427 virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
429 virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
430 virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
432 virtual void center_screen (samplepos_t) = 0;
434 virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
435 virtual TrackViewList const & get_track_views () const = 0;
437 virtual DragManager* drags () const = 0;
438 virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
439 virtual void stop_canvas_autoscroll () = 0;
440 virtual bool autoscroll_active() const = 0;
442 virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
443 virtual void commit_reversible_selection_op () = 0;
444 virtual void begin_reversible_command (std::string cmd_name) = 0;
445 virtual void begin_reversible_command (GQuark) = 0;
446 virtual void abort_reversible_command () = 0;
447 virtual void commit_reversible_command () = 0;
449 virtual void access_action (const std::string&, const std::string&) = 0;
450 virtual void set_toggleaction (const std::string&, const std::string&, bool) = 0;
452 virtual MouseCursors const * cursors () const = 0;
453 virtual VerboseCursor * verbose_cursor () const = 0;
455 virtual bool get_smart_mode () const = 0;
457 virtual void get_pointer_position (double &, double &) const = 0;
459 virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
460 virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
462 virtual void snap_to_with_modifier (ARDOUR::MusicSample& first,
464 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
465 ARDOUR::SnapPref gpref = ARDOUR::SnapToAny_Visual) = 0;
467 virtual void set_snapped_cursor_position (samplepos_t pos) = 0;
469 virtual void get_regions_at (RegionSelection &, samplepos_t where, TrackViewList const &) const = 0;
470 virtual void get_regions_after (RegionSelection&, samplepos_t where, const TrackViewList& ts) const = 0;
471 virtual RegionSelection get_regions_from_selection_and_mouse (samplepos_t) = 0;
472 virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
473 virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Temporal::Beats> > > > >&) const = 0;
475 virtual void build_region_boundary_cache () = 0;
476 virtual void mark_region_boundary_cache_dirty () = 0;
478 virtual void mouse_add_new_tempo_event (samplepos_t where) = 0;
479 virtual void mouse_add_new_meter_event (samplepos_t where) = 0;
480 virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
481 virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
483 /// Singleton instance, set up by Editor::Editor()
485 static PublicEditor* _instance;
487 friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
488 friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
490 PBD::Signal0<void> SnapChanged;
491 PBD::Signal0<void> MouseModeChanged;
493 Gtkmm2ext::Bindings* bindings;
496 friend class DisplaySuspender;
497 virtual void suspend_route_redisplay () = 0;
498 virtual void resume_route_redisplay () = 0;
499 gint _suspend_route_redisplay_counter;
502 class DisplaySuspender {
505 if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
506 PublicEditor::instance().suspend_route_redisplay ();
509 ~DisplaySuspender () {
510 if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
511 PublicEditor::instance().resume_route_redisplay ();
516 class MainMenuDisabler {
518 MainMenuDisabler () {
519 /* The global menu bar continues to be accessible to applications
520 with modal dialogs on mac, which means that we need to desensitize
521 all items in the menu bar.
523 ActionManager::disable_active_actions ();
526 ~MainMenuDisabler () {
527 ActionManager::enable_active_actions ();
531 #endif // __gtk_ardour_public_editor_h__