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 "evoral/Beats.hpp"
39 #include "evoral/Note.hpp"
41 #include "pbd/statefuldestructible.h"
43 #include "canvas/fwd.h"
45 #include "gtkmm2ext/actions.h"
46 #include "gtkmm2ext/bindings.h"
47 #include "gtkmm2ext/tabbable.h"
48 #include "gtkmm2ext/visibility_tracker.h"
51 #include "selection.h"
68 class AudioRegionView;
70 class AutomationTimeAxisView;
77 class PlaylistSelector;
81 class RouteTimeAxisView;
86 class TimeAxisViewItem;
91 class DisplaySuspender;
93 namespace ARDOUR_UI_UTILS {
94 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
95 bool forward_key_press (GdkEventKey* ev);
98 using ARDOUR::framepos_t;
99 using ARDOUR::framecnt_t;
101 /// Representation of the interface of the Editor class
103 /** This class contains just the public interface of the Editor class,
104 * in order to decouple it from the private implementation, so that callers
105 * of PublicEditor need not be recompiled if private methods or member variables
108 class PublicEditor : public Gtkmm2ext::Tabbable {
110 PublicEditor (Gtk::Widget& content);
111 virtual ~PublicEditor ();
113 /** @return Singleton PublicEditor instance */
114 static PublicEditor& instance () { return *_instance; }
116 virtual bool have_idled() const = 0;
117 virtual void first_idle() = 0;
119 virtual void setup_tooltips() = 0;
121 /** Attach this editor to a Session.
122 * @param s Session to connect to.
124 virtual void set_session (ARDOUR::Session* s) = 0;
126 /** @return The Session that we are editing, or 0 */
127 virtual ARDOUR::Session* session () const = 0;
129 /** Set the snap type.
130 * @param t Snap type (defined in editing_syms.h)
132 virtual void set_snap_to (Editing::SnapType t) = 0;
134 virtual Editing::SnapType snap_type () const = 0;
135 virtual Editing::SnapMode snap_mode () const = 0;
137 /** Set the snap mode.
138 * @param m Snap mode (defined in editing_syms.h)
140 virtual void set_snap_mode (Editing::SnapMode m) = 0;
142 /** Set the snap threshold.
143 * @param t Snap threshold in `units'.
145 virtual void set_snap_threshold (double t) = 0;
148 * Snap a value according to the current snap setting.
149 * ensure_snap overrides SnapOff and magnetic snap
151 virtual void snap_to (ARDOUR::MusicFrame& first,
152 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
153 bool for_mark = false,
154 bool ensure_snap = false) = 0;
156 /** Undo some transactions.
157 * @param n Number of transactions to undo.
160 virtual void undo (uint32_t n = 1) = 0;
162 /** Redo some transactions.
163 * @param n Number of transaction to redo.
165 virtual void redo (uint32_t n = 1) = 0;
167 /** Set the mouse mode (gain, object, range, timefx etc.)
168 * @param m Mouse mode (defined in editing_syms.h)
169 * @param force Perform the effects of the change even if no change is required
170 * (ie even if the current mouse mode is equal to @param m)
172 virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
174 /** Step the mouse mode onto the next or previous one.
175 * @param next true to move to the next, otherwise move to the previous
177 virtual void step_mouse_mode (bool next) = 0;
179 /** @return The current mouse mode (gain, object, range, timefx etc.)
180 * (defined in editing_syms.h)
182 virtual Editing::MouseMode current_mouse_mode () const = 0;
184 /** @return Whether the current mouse mode is an "internal" editing mode.
186 virtual bool internal_editing() 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 /* import dialogs -> ardour-ui ?! */
196 virtual void external_audio_dialog () = 0;
197 virtual void session_import_dialog () = 0;
199 virtual void new_region_from_selection () = 0;
200 virtual void separate_region_from_selection () = 0;
202 virtual void transition_to_rolling (bool fwd) = 0;
203 virtual framepos_t pixel_to_sample (double pixel) const = 0;
204 virtual framepos_t playhead_cursor_sample () const = 0;
205 virtual double sample_to_pixel (framepos_t frame) const = 0;
206 virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
208 virtual Selection& get_selection () const = 0;
209 virtual bool get_selection_extents (framepos_t &start, framepos_t &end) const = 0;
210 virtual Selection& get_cut_buffer () const = 0;
212 virtual void set_selection (std::list<Selectable*>, Selection::Operation) = 0;
214 virtual bool extend_selection_to_track (TimeAxisView&) = 0;
215 virtual void play_selection () = 0;
216 virtual void play_with_preroll () = 0;
217 virtual void rec_with_preroll () = 0;
218 virtual void rec_with_count_in () = 0;
219 virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
220 virtual void goto_nth_marker (int nth) = 0;
221 virtual void trigger_script (int nth) = 0;
222 virtual void add_location_from_playhead_cursor () = 0;
223 virtual void remove_location_at_playhead_cursor () = 0;
224 virtual void set_show_measures (bool yn) = 0;
225 virtual bool show_measures () const = 0;
226 virtual void remove_tracks () = 0;
227 virtual void set_loop_range (framepos_t start, framepos_t end, std::string cmd) = 0;
228 virtual void set_punch_range (framepos_t start, framepos_t end, std::string cmd) = 0;
230 virtual void jump_forward_to_mark () = 0;
231 virtual void jump_backward_to_mark () = 0;
233 virtual void set_session_start_from_playhead () = 0;
234 virtual void set_session_end_from_playhead () = 0;
236 virtual void toggle_location_at_playhead_cursor () = 0;
238 virtual void nudge_forward (bool next, bool force_playhead) = 0;
239 virtual void nudge_backward (bool next, bool force_playhead) = 0;
241 virtual void playhead_forward_to_grid () = 0;
242 virtual void playhead_backward_to_grid () = 0;
244 virtual void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
245 virtual void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE) = 0;
247 virtual void set_punch_start_from_edit_point () = 0;
248 virtual void set_punch_end_from_edit_point () = 0;
249 virtual void set_loop_start_from_edit_point () = 0;
250 virtual void set_loop_end_from_edit_point () = 0;
252 virtual Editing::MouseMode effective_mouse_mode () const = 0;
254 /** Import existing media */
255 virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality,
256 ARDOUR::MidiTrackNameSource, ARDOUR::MidiTempoMapDisposition, framepos_t&,
257 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
258 virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,
260 boost::shared_ptr<ARDOUR::PluginInfo> instrument=boost::shared_ptr<ARDOUR::PluginInfo>()) = 0;
262 /** Open main export dialog */
263 virtual void export_audio () = 0;
265 /** Open stem export dialog */
266 virtual void stem_export () = 0;
268 /** Open export dialog with current selection pre-selected */
269 virtual void export_selection () = 0;
271 /** Open export dialog with current range pre-selected */
272 virtual void export_range () = 0;
274 virtual void register_actions () = 0;
275 virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
276 virtual Editing::ZoomFocus get_zoom_focus () const = 0;
277 virtual framecnt_t get_current_zoom () const = 0;
278 virtual void reset_zoom (framecnt_t) = 0;
279 virtual PlaylistSelector& playlist_selector() const = 0;
280 virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
281 virtual void new_playlists (TimeAxisView*) = 0;
282 virtual void copy_playlists (TimeAxisView*) = 0;
283 virtual void clear_playlists (TimeAxisView*) = 0;
284 virtual void select_all_tracks () = 0;
285 virtual void deselect_all () = 0;
286 virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
287 virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
288 virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = 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 = false) = 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 framepos_t leftmost_sample() const = 0;
309 virtual framecnt_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 prepare_for_cleanup () = 0;
319 virtual void finish_cleanup () = 0;
320 virtual void reset_x_origin (framepos_t frame) = 0;
321 virtual double get_y_origin () const = 0;
322 virtual void reset_y_origin (double pos) = 0;
323 virtual void remove_last_capture () = 0;
324 virtual void maximise_editing_space () = 0;
325 virtual void restore_editing_space () = 0;
326 virtual framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE, bool from_context_menu = false, bool from_outside_canvas = false) = 0;
327 virtual void toggle_meter_updating() = 0;
328 virtual void split_regions_at (ARDOUR::MusicFrame, RegionSelection&, bool snap) = 0;
329 virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
330 virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false) = 0;
331 virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
332 virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
333 virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
334 virtual framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration) = 0;
335 virtual unsigned get_grid_beat_divisions(framepos_t position) = 0;
336 virtual Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position) = 0;
337 virtual int32_t get_grid_music_divisions (uint32_t event_state) = 0;
338 virtual void edit_notes (MidiRegionView*) = 0;
340 virtual void queue_visual_videotimeline_update () = 0;
341 virtual void set_close_video_sensitive (bool) = 0;
342 virtual void toggle_ruler_video (bool) = 0;
343 virtual void toggle_xjadeo_proc (int) = 0;
344 virtual void toggle_xjadeo_viewoption (int, int) = 0;
345 virtual void set_xjadeo_sensitive (bool onoff) = 0;
346 virtual int get_videotl_bar_height () const = 0;
347 virtual void set_video_timeline_height (const int h) = 0;
348 virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
350 virtual bool track_selection_change_without_scroll () const = 0;
352 virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
354 virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
355 virtual RegionView* get_regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const = 0;
357 sigc::signal<void> ZoomChanged;
358 sigc::signal<void> Realized;
359 sigc::signal<void,framepos_t> UpdateAllTransportClocks;
361 static sigc::signal<void> DropDownKeys;
363 struct RegionAction {
364 Glib::RefPtr<Gtk::Action> action;
365 Editing::RegionActionTarget target;
367 RegionAction (Glib::RefPtr<Gtk::Action> a, Editing::RegionActionTarget tgt)
368 : action (a), target (tgt) {}
371 std::map<std::string,RegionAction> region_action_map;
373 Glib::RefPtr<Gtk::ActionGroup> editor_actions;
374 Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
375 Glib::RefPtr<Gtk::ActionGroup> _region_actions;
377 virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
378 virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
379 virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
380 virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
381 virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
382 virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
383 virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
384 virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
385 virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
386 virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
387 virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
388 virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
389 virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
390 virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
391 virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
392 virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
393 virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
394 virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
395 virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
396 virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, ArdourMarker*) = 0;
397 virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
398 virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
399 virtual bool canvas_tempo_curve_event (GdkEvent* event, ArdourCanvas::Item*, TempoCurve*) = 0;
400 virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
401 virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
403 virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
404 virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
405 virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
406 virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
407 virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
408 virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
410 static const int window_border_width;
411 static const int container_border_width;
412 static const int vertical_spacing;
413 static const int horizontal_spacing;
415 virtual ArdourCanvas::Container* get_trackview_group () const = 0;
416 virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
417 virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
418 virtual ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const = 0;
420 virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
422 virtual TimeAxisView* axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable>) const = 0;
424 virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
425 virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
427 virtual void center_screen (framepos_t) = 0;
429 virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
430 virtual TrackViewList const & get_track_views () = 0;
432 virtual DragManager* drags () const = 0;
433 virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
434 virtual void stop_canvas_autoscroll () = 0;
435 virtual bool autoscroll_active() const = 0;
437 virtual void begin_reversible_selection_op (std::string cmd_name) = 0;
438 virtual void commit_reversible_selection_op () = 0;
439 virtual void begin_reversible_command (std::string cmd_name) = 0;
440 virtual void begin_reversible_command (GQuark) = 0;
441 virtual void abort_reversible_command () = 0;
442 virtual void commit_reversible_command () = 0;
444 virtual void access_action (std::string,std::string) = 0;
446 virtual MouseCursors const * cursors () const = 0;
447 virtual VerboseCursor * verbose_cursor () const = 0;
449 virtual bool get_smart_mode () const = 0;
451 virtual void get_pointer_position (double &, double &) const = 0;
453 virtual ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool &) const = 0;
454 virtual ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
456 virtual void snap_to_with_modifier (ARDOUR::MusicFrame& first,
458 ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
459 bool for_mark = false) = 0;
461 virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
462 virtual void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const = 0;
463 virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
464 virtual void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const = 0;
465 virtual void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const = 0;
467 virtual void mouse_add_new_tempo_event (framepos_t where) = 0;
468 virtual void mouse_add_new_meter_event (framepos_t where) = 0;
469 virtual void edit_tempo_section (ARDOUR::TempoSection*) = 0;
470 virtual void edit_meter_section (ARDOUR::MeterSection*) = 0;
472 /// Singleton instance, set up by Editor::Editor()
474 static PublicEditor* _instance;
476 friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
477 friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
479 PBD::Signal0<void> SnapChanged;
480 PBD::Signal0<void> MouseModeChanged;
482 Gtkmm2ext::Bindings* bindings;
485 friend class DisplaySuspender;
486 virtual void suspend_route_redisplay () = 0;
487 virtual void resume_route_redisplay () = 0;
488 gint _suspend_route_redisplay_counter;
491 class DisplaySuspender {
494 if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
495 PublicEditor::instance().suspend_route_redisplay ();
498 ~DisplaySuspender () {
499 if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
500 PublicEditor::instance().resume_route_redisplay ();
505 class MainMenuDisabler {
507 MainMenuDisabler () {
508 /* The global menu bar continues to be accessible to applications
509 with modal dialogs on mac, which means that we need to desensitize
510 all items in the menu bar.
512 ActionManager::disable_active_actions ();
515 ~MainMenuDisabler () {
516 ActionManager::enable_active_actions ();
520 #endif // __gtk_ardour_public_editor_h__