Add API to query editor's playhead cursor position
[ardour.git] / gtk2_ardour / editor.h
1 /*
2     Copyright (C) 2000-2003 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #ifndef __ardour_editor_h__
21 #define __ardour_editor_h__
22
23 #include <sys/time.h>
24
25 #include <cmath>
26 #include <list>
27 #include <map>
28 #include <set>
29 #include <string>
30 #include <vector>
31
32 #include <boost/optional.hpp>
33
34 #include <gtkmm/comboboxtext.h>
35 #include <gtkmm/layout.h>
36
37 #include "gtkmm2ext/bindings.h"
38 #include "gtkmm2ext/click_box.h"
39 #include "gtkmm2ext/dndtreeview.h"
40 #include "gtkmm2ext/pane.h"
41 #include "gtkmm2ext/selector.h"
42 #include "gtkmm2ext/stateful_button.h"
43
44 #include "pbd/stateful.h"
45 #include "pbd/signals.h"
46
47 #include "ardour/import_status.h"
48 #include "ardour/tempo.h"
49 #include "ardour/location.h"
50 #include "ardour/types.h"
51
52 #include "canvas/fwd.h"
53 #include "canvas/ruler.h"
54
55 #include "ardour_button.h"
56 #include "ardour_dialog.h"
57 #include "ardour_dropdown.h"
58 #include "public_editor.h"
59 #include "editing.h"
60 #include "enums.h"
61 #include "editor_items.h"
62 #include "region_selection.h"
63 #include "selection_memento.h"
64 #include "tempo_curve.h"
65
66 namespace Gtkmm2ext {
67         class Bindings;
68 }
69
70 namespace Evoral {
71         class SMF;
72 }
73
74 namespace ARDOUR {
75         class AudioPlaylist;
76         class AudioRegion;
77         class AudioTrack;
78         class ChanCount;
79         class Filter;
80         class Location;
81         class MidiOperator;
82         class MidiRegion;
83         class MidiTrack;
84         class Playlist;
85         class Region;
86         class RouteGroup;
87         class Session;
88         class TempoSection;
89         class Track;
90 }
91
92 namespace LADSPA {
93         class Plugin;
94 }
95
96 class AnalysisWindow;
97 class AudioClock;
98 class AudioRegionView;
99 class AudioStreamView;
100 class AudioTimeAxisView;
101 class AutomationLine;
102 class AutomationSelection;
103 class AutomationTimeAxisView;
104 class BundleManager;
105 class ButtonJoiner;
106 class ControlPoint;
107 class CursorContext;
108 class DragManager;
109 class EditNoteDialog;
110 class EditorCursor;
111 class EditorGroupTabs;
112 class EditorLocations;
113 class EditorRegions;
114 class EditorRoutes;
115 class EditorRouteGroups;
116 class EditorSnapshots;
117 class EditorSummary;
118 class GroupedButtons;
119 class GUIObjectState;
120 class ArdourMarker;
121 class MidiRegionView;
122 class MidiExportDialog;
123 class MixerStrip;
124 class MouseCursors;
125 class NoteBase;
126 class PlaylistSelector;
127 class PluginSelector;
128 class ProgressReporter;
129 class QuantizeDialog;
130 class RhythmFerret;
131 class RulerDialog;
132 class Selection;
133 class SoundFileOmega;
134 class StreamView;
135 class TempoLines;
136 class TimeAxisView;
137 class TimeFXDialog;
138 class TimeSelection;
139 class RegionLayeringOrderEditor;
140 class VerboseCursor;
141
142 class Editor : public PublicEditor, public PBD::ScopedConnectionList, public ARDOUR::SessionHandlePtr
143 {
144  public:
145         Editor ();
146         ~Editor ();
147
148         void             set_session (ARDOUR::Session *);
149         ARDOUR::Session* session() const { return _session; }
150
151         Gtk::Window* use_own_window (bool and_fill_it);
152
153         void             first_idle ();
154         virtual bool     have_idled () const { return _have_idled; }
155
156         framepos_t leftmost_sample() const { return leftmost_frame; }
157
158         framecnt_t current_page_samples() const {
159                 return (framecnt_t) _visible_canvas_width * samples_per_pixel;
160         }
161
162         double visible_canvas_height () const {
163                 return _visible_canvas_height;
164         }
165         double trackviews_height () const;
166
167         void cycle_snap_mode ();
168         void next_snap_choice ();
169         void next_snap_choice_music_only ();
170         void next_snap_choice_music_and_time ();
171         void prev_snap_choice ();
172         void prev_snap_choice_music_only ();
173         void prev_snap_choice_music_and_time ();
174         void set_snap_to (Editing::SnapType);
175         void set_snap_mode (Editing::SnapMode);
176         void set_snap_threshold (double pixel_distance) {snap_threshold = pixel_distance;}
177
178         Editing::SnapMode  snap_mode () const;
179         Editing::SnapType  snap_type () const;
180         bool  snap_musical () const;
181
182         void undo (uint32_t n = 1);
183         void redo (uint32_t n = 1);
184
185         XMLNode& get_state ();
186         int set_state (const XMLNode&, int version);
187
188         void set_mouse_mode (Editing::MouseMode, bool force=true);
189         void step_mouse_mode (bool next);
190         Editing::MouseMode current_mouse_mode () const { return mouse_mode; }
191         Editing::MidiEditMode current_midi_edit_mode () const;
192         void remove_midi_note (ArdourCanvas::Item *, GdkEvent *);
193
194         bool internal_editing() const;
195
196         void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>);
197         void add_to_idle_resize (TimeAxisView*, int32_t);
198
199         RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const;
200
201         void consider_auditioning (boost::shared_ptr<ARDOUR::Region>);
202         void hide_a_region (boost::shared_ptr<ARDOUR::Region>);
203         void show_a_region (boost::shared_ptr<ARDOUR::Region>);
204
205 #ifdef USE_RUBBERBAND
206         std::vector<std::string> rb_opt_strings;
207         int rb_current_opt;
208 #endif
209
210         /* things that need to be public to be used in the main menubar */
211
212         void new_region_from_selection ();
213         void separate_regions_between (const TimeSelection&);
214         void separate_region_from_selection ();
215         void separate_under_selected_regions ();
216         void separate_region_from_punch ();
217         void separate_region_from_loop ();
218         void separate_regions_using_location (ARDOUR::Location&);
219         void transition_to_rolling (bool forward);
220
221         /* NOTE: these functions assume that the "pixel" coordinate is
222            in canvas coordinates. These coordinates already take into
223            account any scrolling offsets.
224         */
225
226         framepos_t pixel_to_sample_from_event (double pixel) const {
227
228                 /* pixel can be less than zero when motion events
229                    are processed. since we've already run the world->canvas
230                    affine, that means that the location *really* is "off
231                    to the right" and thus really is "before the start".
232                 */
233
234                 if (pixel >= 0) {
235                         return pixel * samples_per_pixel;
236                 } else {
237                         return 0;
238                 }
239         }
240
241         framepos_t pixel_to_sample (double pixel) const {
242                 return pixel * samples_per_pixel;
243         }
244
245         double sample_to_pixel (framepos_t sample) const {
246                 return round (sample / (double) samples_per_pixel);
247         }
248
249         double sample_to_pixel_unrounded (framepos_t sample) const {
250                 return sample / (double) samples_per_pixel;
251         }
252
253         /* selection */
254
255         Selection& get_selection() const { return *selection; }
256         bool get_selection_extents (framepos_t &start, framepos_t &end) const;  // the time extents of the current selection, whether Range, Region(s), Control Points, or Notes
257         Selection& get_cut_buffer() const { return *cut_buffer; }
258         void track_mixer_selection ();
259
260         bool extend_selection_to_track (TimeAxisView&);
261
262         void play_selection ();
263         framepos_t get_preroll ();
264         void maybe_locate_with_edit_preroll (framepos_t);
265         void play_with_preroll ();
266         void select_all_in_track (Selection::Operation op);
267         void select_all_objects (Selection::Operation op);
268         void invert_selection_in_track ();
269         void invert_selection ();
270         void deselect_all ();
271         long select_range (framepos_t, framepos_t);
272
273         void set_selected_regionview_from_region_list (boost::shared_ptr<ARDOUR::Region> region, Selection::Operation op = Selection::Set);
274
275         void remove_tracks ();
276
277         /* tempo */
278
279         void set_show_measures (bool yn);
280         bool show_measures () const { return _show_measures; }
281
282         /* analysis window */
283
284         void loudness_analyze_region_selection();
285         void loudness_analyze_range_selection();
286
287         void spectral_analyze_region_selection();
288         void spectral_analyze_range_selection();
289
290         /* export */
291
292         void export_audio ();
293         void stem_export ();
294         void export_selection ();
295         void export_range ();
296         void export_region ();
297
298         bool process_midi_export_dialog (MidiExportDialog& dialog, boost::shared_ptr<ARDOUR::MidiRegion> midi_region);
299
300         void               set_zoom_focus (Editing::ZoomFocus);
301         Editing::ZoomFocus get_zoom_focus () const { return zoom_focus; }
302         framecnt_t         get_current_zoom () const { return samples_per_pixel; }
303         void               cycle_zoom_focus ();
304         void temporal_zoom_step (bool zoom_out);
305         void temporal_zoom_step_scale (bool zoom_out, double scale);
306         void temporal_zoom_step_mouse_focus (bool zoom_out);
307         void temporal_zoom_step_mouse_focus_scale (bool zoom_out, double scale);
308         void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top);
309         void tav_zoom_step (bool coarser);
310         void tav_zoom_smooth (bool coarser, bool force_all);
311
312         /* stuff that AudioTimeAxisView and related classes use */
313
314         PlaylistSelector& playlist_selector() const;
315         void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>);
316
317         void new_playlists (TimeAxisView* v);
318         void copy_playlists (TimeAxisView* v);
319         void clear_playlists (TimeAxisView* v);
320
321         void get_onscreen_tracks (TrackViewList&);
322
323         Width editor_mixer_strip_width;
324         void maybe_add_mixer_strip_width (XMLNode&);
325         void show_editor_mixer (bool yn);
326         void create_editor_mixer ();
327         void show_editor_list (bool yn);
328         void set_selected_mixer_strip (TimeAxisView&);
329         void mixer_strip_width_changed ();
330         void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false);
331
332         /* nudge is initiated by transport controls owned by ARDOUR_UI */
333
334         framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next);
335         framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration);
336         unsigned get_grid_beat_divisions(framepos_t position);
337         Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position);
338
339         int32_t get_grid_music_divisions (uint32_t event_state);
340
341         void nudge_forward (bool next, bool force_playhead);
342         void nudge_backward (bool next, bool force_playhead);
343
344         /* nudge initiated from context menu */
345
346         void nudge_forward_capture_offset ();
347         void nudge_backward_capture_offset ();
348
349         void sequence_regions ();
350
351         /* playhead/screen stuff */
352
353         void set_stationary_playhead (bool yn);
354         void toggle_stationary_playhead ();
355         bool stationary_playhead() const { return _stationary_playhead; }
356
357         void set_follow_playhead (bool yn, bool catch_up = true);
358         void toggle_follow_playhead ();
359         bool follow_playhead() const { return _follow_playhead; }
360         bool dragging_playhead () const { return _dragging_playhead; }
361
362         void toggle_zero_line_visibility ();
363         void set_summary ();
364         void set_group_tabs ();
365         void toggle_measure_visibility ();
366
367         /* fades */
368
369         void toggle_region_fades (int dir);
370         void update_region_fade_visibility ();
371
372         /* redirect shared ops menu. caller must free returned menu */
373
374         Gtk::Menu* redirect_menu ();
375
376         /* floating windows/transient */
377
378         void ensure_float (Gtk::Window&);
379
380         void scroll_tracks_down_line ();
381         void scroll_tracks_up_line ();
382
383         bool scroll_up_one_track (bool skip_child_views = false);
384         bool scroll_down_one_track (bool skip_child_views = false);
385
386         void scroll_left_step ();
387         void scroll_right_step ();
388
389         void scroll_left_half_page ();
390         void scroll_right_half_page ();
391
392         void prepare_for_cleanup ();
393         void finish_cleanup ();
394
395         void maximise_editing_space();
396         void restore_editing_space();
397
398         double get_y_origin () const;
399         void reset_x_origin (framepos_t);
400         void reset_x_origin_to_follow_playhead ();
401         void reset_y_origin (double);
402         void reset_zoom (framecnt_t);
403         void reposition_and_zoom (framepos_t, double);
404
405         framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE,
406                                                 bool use_context_click = false,
407                                                 bool from_outside_canvas = false);
408
409         bool update_mouse_speed ();
410         bool decelerate_mouse_speed ();
411
412         void toggle_meter_updating();
413
414         void show_rhythm_ferret();
415
416         void goto_visual_state (uint32_t);
417         void save_visual_state (uint32_t);
418
419         void queue_draw_resize_line (int at);
420         void start_resize_line_ops ();
421         void end_resize_line_ops ();
422
423         TrackViewList const & get_track_views () {
424                 return track_views;
425         }
426
427         int get_regionview_count_from_region_list (boost::shared_ptr<ARDOUR::Region>);
428
429         void do_ptimport(std::string path, ARDOUR::SrcQuality quality);
430
431         void do_import (std::vector<std::string>              paths,
432                         Editing::ImportDisposition            disposition,
433                         Editing::ImportMode                   mode,
434                         ARDOUR::SrcQuality                    quality,
435                         ARDOUR::MidiTrackNameSource           mts,
436                         ARDOUR::MidiTempoMapDisposition       mtd,
437                         framepos_t&                           pos,
438                         boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
439
440         void do_embed (std::vector<std::string>              paths,
441                        Editing::ImportDisposition            disposition,
442                        Editing::ImportMode                   mode,
443                        framepos_t&                           pos,
444                        boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
445
446         void get_regions_corresponding_to (boost::shared_ptr<ARDOUR::Region> region, std::vector<RegionView*>& regions, bool src_comparison);
447
448         void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const;
449         void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const;
450
451         void center_screen (framepos_t);
452
453         TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const;
454
455         void snap_to (framepos_t&       first,
456                       ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
457                       bool              for_mark  = false,
458                       bool              ensure_snap = false);
459
460         void snap_to_with_modifier (framepos_t&       first,
461                                     GdkEvent const *  ev,
462                                     ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
463                                     bool              for_mark  = false);
464
465         void snap_to (framepos_t&       first,
466                       framepos_t&       last,
467                       ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
468                       bool              for_mark  = false);
469
470         void begin_selection_op_history ();
471         void begin_reversible_selection_op (std::string cmd_name);
472         void commit_reversible_selection_op ();
473         void undo_selection_op ();
474         void redo_selection_op ();
475         void begin_reversible_command (std::string cmd_name);
476         void begin_reversible_command (GQuark);
477         void abort_reversible_command ();
478         void commit_reversible_command ();
479
480         DragManager* drags () const {
481                 return _drags;
482         }
483
484         void maybe_autoscroll (bool, bool, bool);
485         bool autoscroll_active() const;
486
487         Gdk::Cursor* get_canvas_cursor () const;
488
489         void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>);
490         void set_current_movable (boost::shared_ptr<ARDOUR::Movable>);
491
492         MouseCursors const * cursors () const {
493                 return _cursors;
494         }
495
496         VerboseCursor* verbose_cursor () const {
497                 return _verbose_cursor;
498         }
499
500         double clamp_verbose_cursor_x (double);
501         double clamp_verbose_cursor_y (double);
502
503         void get_pointer_position (double &, double &) const;
504
505         /** Context for mouse entry (stored in a stack). */
506         struct EnterContext {
507                 ItemType                         item_type;
508                 boost::shared_ptr<CursorContext> cursor_ctx;
509         };
510
511         /** Get the topmost enter context for the given item type.
512          *
513          * This is used to change the cursor associated with a given enter context,
514          * which may not be on the top of the stack.
515          */
516         EnterContext* get_enter_context(ItemType type);
517
518         TimeAxisView* stepping_axis_view () {
519                 return _stepping_axis_view;
520         }
521
522         void set_stepping_axis_view (TimeAxisView* v) {
523                 _stepping_axis_view = v;
524         }
525
526         ArdourCanvas::Container* get_trackview_group () const { return _trackview_group; }
527         ArdourCanvas::Container* get_noscroll_group () const { return no_scroll_group; }
528         ArdourCanvas::ScrollGroup* get_hscroll_group () const { return h_scroll_group; }
529         ArdourCanvas::ScrollGroup* get_hvscroll_group () const { return hv_scroll_group; }
530         ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const { return cursor_scroll_group; }
531
532         ArdourCanvas::GtkCanvasViewport* get_track_canvas () const;
533
534         void override_visible_track_count ();
535
536         /* Ruler metrics methods */
537
538         void metric_get_timecode (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
539         void metric_get_bbt (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
540         void metric_get_samples (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
541         void metric_get_minsec (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
542
543         /* editing operations that need to be public */
544         void mouse_add_new_marker (framepos_t where, bool is_cd=false);
545         void split_regions_at (framepos_t, RegionSelection&, const int32_t sub_num, bool snap = true);
546         void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false);
547         RegionSelection get_regions_from_selection_and_mouse (framepos_t);
548
549         void mouse_add_new_tempo_event (framepos_t where);
550         void mouse_add_new_meter_event (framepos_t where);
551         void edit_tempo_section (ARDOUR::TempoSection*);
552         void edit_meter_section (ARDOUR::MeterSection*);
553
554   protected:
555         void map_transport_state ();
556         void map_position_change (framepos_t);
557
558         void on_realize();
559
560         void suspend_route_redisplay ();
561         void resume_route_redisplay ();
562
563   private:
564
565         void color_handler ();
566
567         bool                 constructed;
568
569         // to keep track of the playhead position for control_scroll
570         boost::optional<framepos_t> _control_scroll_target;
571
572         PlaylistSelector* _playlist_selector;
573
574         typedef std::pair<TimeAxisView*,XMLNode*> TAVState;
575
576         struct VisualState {
577             VisualState (bool with_tracks);
578             ~VisualState ();
579             double              y_position;
580             framecnt_t          samples_per_pixel;
581             framepos_t          leftmost_frame;
582             Editing::ZoomFocus  zoom_focus;
583             GUIObjectState*     gui_state;
584         };
585
586         std::list<VisualState*> undo_visual_stack;
587         std::list<VisualState*> redo_visual_stack;
588         VisualState* current_visual_state (bool with_tracks = true);
589         void undo_visual_state ();
590         void redo_visual_state ();
591         void use_visual_state (VisualState&);
592         bool no_save_visual;
593         void swap_visual_state ();
594
595         std::vector<VisualState*> visual_states;
596         void start_visual_state_op (uint32_t n);
597         void cancel_visual_state_op (uint32_t n);
598
599         framepos_t         leftmost_frame;
600         framecnt_t         samples_per_pixel;
601         Editing::ZoomFocus zoom_focus;
602
603         void set_samples_per_pixel (framecnt_t);
604
605         Editing::MouseMode mouse_mode;
606         Editing::SnapType  pre_internal_snap_type;
607         Editing::SnapMode  pre_internal_snap_mode;
608         Editing::SnapType  internal_snap_type;
609         Editing::SnapMode  internal_snap_mode;
610         Editing::MouseMode effective_mouse_mode () const;
611
612         enum JoinObjectRangeState {
613                 JOIN_OBJECT_RANGE_NONE,
614                 /** `join object/range' mode is active and the mouse is over a place where object mode should happen */
615                 JOIN_OBJECT_RANGE_OBJECT,
616                 /** `join object/range' mode is active and the mouse is over a place where range mode should happen */
617                 JOIN_OBJECT_RANGE_RANGE
618         };
619
620         JoinObjectRangeState _join_object_range_state;
621
622         void update_join_object_range_location (double);
623
624         boost::optional<float>  pre_notebook_shrink_pane_width;
625
626         Gtk::Notebook _the_notebook;
627         bool _notebook_shrunk;
628         void add_notebook_page (std::string const &, Gtk::Widget &);
629         bool notebook_tab_clicked (GdkEventButton *, Gtk::Widget *);
630
631         Gtkmm2ext::HPane   edit_pane;
632         Gtkmm2ext::VPane   editor_summary_pane;
633
634         Gtk::EventBox meter_base;
635         Gtk::HBox     meter_box;
636         Gtk::EventBox marker_base;
637         Gtk::HBox     marker_box;
638         Gtk::VBox     scrollers_rulers_markers_box;
639
640         void location_changed (ARDOUR::Location *);
641         void location_flags_changed (ARDOUR::Location *);
642         void refresh_location_display ();
643         void refresh_location_display_internal (const ARDOUR::Locations::LocationList&);
644         void add_new_location (ARDOUR::Location *);
645         ArdourCanvas::Container* add_new_location_internal (ARDOUR::Location *);
646         void location_gone (ARDOUR::Location *);
647         void remove_marker (ArdourCanvas::Item&, GdkEvent*);
648         gint really_remove_marker (ARDOUR::Location* loc);
649         void goto_nth_marker (int nth);
650         void trigger_script (int nth);
651         void toggle_marker_lines ();
652         void set_marker_line_visibility (bool);
653
654         uint32_t location_marker_color;
655         uint32_t location_range_color;
656         uint32_t location_loop_color;
657         uint32_t location_punch_color;
658         uint32_t location_cd_marker_color;
659
660         struct LocationMarkers {
661                 ArdourMarker* start;
662                 ArdourMarker* end;
663                 bool    valid;
664
665                 LocationMarkers () : start(0), end(0), valid (true) {}
666
667                 ~LocationMarkers ();
668
669                 void hide ();
670                 void show ();
671
672                 void set_show_lines (bool);
673                 void set_selected (bool);
674                 void canvas_height_set (double);
675                 void setup_lines ();
676
677                 void set_name (const std::string&);
678                 void set_position (framepos_t start, framepos_t end = 0);
679                 void set_color_rgba (uint32_t);
680         };
681
682         LocationMarkers  *find_location_markers (ARDOUR::Location *) const;
683         ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool& is_start) const;
684         ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const;
685         ArdourMarker* entered_marker;
686         bool _show_marker_lines;
687
688         typedef std::map<ARDOUR::Location*,LocationMarkers *> LocationMarkerMap;
689         LocationMarkerMap location_markers;
690
691         void update_marker_labels ();
692         void update_marker_labels (ArdourCanvas::Container *);
693         void check_marker_label (ArdourMarker *);
694
695         /** A set of lists of Markers that are in each of the canvas groups
696          *  for the marker sections at the top of the editor.  These lists
697          *  are kept sorted in time order between marker movements, so that after
698          *  a marker has moved we can decide whether we need to update the labels
699          *  for all markers or for just a few.
700          */
701         std::map<ArdourCanvas::Container *, std::list<ArdourMarker *> > _sorted_marker_lists;
702         void remove_sorted_marker (ArdourMarker *);
703
704         void hide_marker (ArdourCanvas::Item*, GdkEvent*);
705         void clear_marker_display ();
706         void mouse_add_new_range (framepos_t);
707         void mouse_add_new_loop (framepos_t);
708         void mouse_add_new_punch (framepos_t);
709         bool choose_new_marker_name(std::string &name);
710         void update_cd_marker_display ();
711         void ensure_cd_marker_updated (LocationMarkers * lam, ARDOUR::Location * location);
712
713         TimeAxisView*      clicked_axisview;
714         RouteTimeAxisView* clicked_routeview;
715         /** The last RegionView that was clicked on, or 0 if the last click was not
716          * on a RegionView.  This is set up by the canvas event handlers in
717          * editor_canvas_events.cc
718          */
719         RegionView*        clicked_regionview;
720         RegionSelection    latest_regionviews;
721         uint32_t           clicked_selection;
722         ControlPoint*      clicked_control_point;
723
724         void sort_track_selection (TrackViewList&);
725
726         void get_equivalent_regions (RegionView* rv, std::vector<RegionView*> &, PBD::PropertyID) const;
727         RegionSelection get_equivalent_regions (RegionSelection &, PBD::PropertyID) const;
728         void mapover_tracks (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
729         void mapover_tracks_with_unique_playlists (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
730
731         /* functions to be passed to mapover_tracks(), possibly with sigc::bind()-supplied arguments */
732         void mapped_get_equivalent_regions (RouteTimeAxisView&, uint32_t, RegionView *, std::vector<RegionView*>*) const;
733         void mapped_use_new_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
734         void mapped_use_copy_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
735         void mapped_clear_playlist (RouteTimeAxisView&, uint32_t);
736
737         void button_selection (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type);
738         bool button_release_can_deselect;
739         bool _mouse_changed_selection;
740
741         void catch_vanishing_regionview (RegionView *);
742
743         void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove=false);
744         void select_all_tracks ();
745         bool select_all_internal_edit (Selection::Operation);
746
747         bool set_selected_control_point_from_click (bool press, Selection::Operation op = Selection::Set);
748         void set_selected_track_from_click (bool press, Selection::Operation op = Selection::Set, bool no_remove=false);
749         void set_selected_track_as_side_effect (Selection::Operation op);
750         bool set_selected_regionview_from_click (bool press, Selection::Operation op = Selection::Set);
751
752         bool set_selected_regionview_from_map_event (GdkEventAny*, StreamView*, boost::weak_ptr<ARDOUR::Region>);
753         void collect_new_region_view (RegionView *);
754         void collect_and_select_new_region_view (RegionView *);
755
756         Gtk::Menu track_context_menu;
757         Gtk::Menu track_region_context_menu;
758         Gtk::Menu track_selection_context_menu;
759
760         Gtk::MenuItem* region_edit_menu_split_item;
761         Gtk::MenuItem* region_edit_menu_split_multichannel_item;
762         Gtk::Menu * track_region_edit_playlist_menu;
763         Gtk::Menu * track_edit_playlist_submenu;
764         Gtk::Menu * track_selection_edit_playlist_submenu;
765
766         GdkEvent context_click_event;
767
768         void popup_track_context_menu (int, int, ItemType, bool);
769         Gtk::Menu* build_track_context_menu ();
770         Gtk::Menu* build_track_bus_context_menu ();
771         Gtk::Menu* build_track_region_context_menu ();
772         Gtk::Menu* build_track_selection_context_menu ();
773         void add_dstream_context_items (Gtk::Menu_Helpers::MenuList&);
774         void add_bus_context_items (Gtk::Menu_Helpers::MenuList&);
775         void add_region_context_items (Gtk::Menu_Helpers::MenuList&, boost::shared_ptr<ARDOUR::Track>);
776         void add_selection_context_items (Gtk::Menu_Helpers::MenuList&);
777         Gtk::MenuItem* _popup_region_menu_item;
778
779         void popup_control_point_context_menu (ArdourCanvas::Item *, GdkEvent *);
780         Gtk::Menu _control_point_context_menu;
781
782         void popup_note_context_menu (ArdourCanvas::Item *, GdkEvent *);
783         Gtk::Menu _note_context_menu;
784
785         void add_stripables (ARDOUR::StripableList&);
786         void add_routes (ARDOUR::RouteList&);
787         void timeaxisview_deleted (TimeAxisView *);
788         void add_vcas (ARDOUR::VCAList&);
789
790         Gtk::HBox global_hpacker;
791         Gtk::VBox global_vpacker;
792
793         /* Cursor stuff.  Do not use directly, use via CursorContext. */
794         friend class CursorContext;
795         std::vector<Gdk::Cursor*> _cursor_stack;
796         void set_canvas_cursor (Gdk::Cursor*);
797         size_t push_canvas_cursor (Gdk::Cursor*);
798         void pop_canvas_cursor ();
799
800         Gdk::Cursor* which_grabber_cursor () const;
801         Gdk::Cursor* which_track_cursor () const;
802         Gdk::Cursor* which_mode_cursor () const;
803         Gdk::Cursor* which_trim_cursor (bool left_side) const;
804         Gdk::Cursor* which_canvas_cursor (ItemType type) const;
805
806         /** Push the appropriate enter/cursor context on item entry. */
807         void choose_canvas_cursor_on_entry (ItemType);
808
809         /** Update all enter cursors based on current settings. */
810         void update_all_enter_cursors ();
811
812         ArdourCanvas::GtkCanvas* _track_canvas;
813         ArdourCanvas::GtkCanvasViewport* _track_canvas_viewport;
814
815         bool within_track_canvas;
816
817         friend class VerboseCursor;
818         VerboseCursor* _verbose_cursor;
819
820         void parameter_changed (std::string);
821         void ui_parameter_changed (std::string);
822
823         Gtk::EventBox             time_bars_event_box;
824         Gtk::VBox                 time_bars_vbox;
825
826         ArdourCanvas::Container      *tempo_group;
827         ArdourCanvas::Container      *meter_group;
828         ArdourCanvas::Container      *marker_group;
829         ArdourCanvas::Container      *range_marker_group;
830         ArdourCanvas::Container      *transport_marker_group;
831         ArdourCanvas::Container*      cd_marker_group;
832
833         /* parent for groups which themselves contain time markers */
834         ArdourCanvas::Container*     _time_markers_group;
835
836         /* The group containing all other groups that are scrolled vertically
837            and horizontally.
838         */
839         ArdourCanvas::ScrollGroup* hv_scroll_group;
840
841         /* The group containing all other groups that are scrolled horizontally ONLY
842         */
843         ArdourCanvas::ScrollGroup* h_scroll_group;
844
845         /* Scroll group for cursors, scrolled horizontally, above everything else
846         */
847         ArdourCanvas::ScrollGroup* cursor_scroll_group;
848
849         /* The group containing all trackviews. */
850         ArdourCanvas::Container* no_scroll_group;
851
852         /* The group containing all trackviews. */
853         ArdourCanvas::Container* _trackview_group;
854
855         /* The group holding things (mostly regions) while dragging so they
856          * are on top of everything else
857          */
858         ArdourCanvas::Container* _drag_motion_group;
859
860         /* a rect that sits at the bottom of all tracks to act as a drag-no-drop/clickable
861          * target area.
862          */
863         ArdourCanvas::Rectangle* _canvas_drop_zone;
864         bool canvas_drop_zone_event (GdkEvent* event);
865
866         enum RulerType {
867                 ruler_metric_timecode = 0,
868                 ruler_metric_bbt = 1,
869                 ruler_metric_samples = 2,
870                 ruler_metric_minsec = 3,
871
872                 ruler_time_tempo = 4,
873                 ruler_time_meter = 5,
874                 ruler_time_marker = 6,
875                 ruler_time_range_marker = 7,
876                 ruler_time_transport_marker = 8,
877                 ruler_time_cd_marker = 9,
878                 ruler_video_timeline = 10,
879         };
880
881         Glib::RefPtr<Gtk::ToggleAction> ruler_timecode_action;
882         Glib::RefPtr<Gtk::ToggleAction> ruler_bbt_action;
883         Glib::RefPtr<Gtk::ToggleAction> ruler_samples_action;
884         Glib::RefPtr<Gtk::ToggleAction> ruler_minsec_action;
885         Glib::RefPtr<Gtk::ToggleAction> ruler_tempo_action;
886         Glib::RefPtr<Gtk::ToggleAction> ruler_meter_action;
887         Glib::RefPtr<Gtk::ToggleAction> ruler_marker_action;
888         Glib::RefPtr<Gtk::ToggleAction> ruler_range_action;
889         Glib::RefPtr<Gtk::ToggleAction> ruler_loop_punch_action;
890         Glib::RefPtr<Gtk::ToggleAction> ruler_cd_marker_action;
891         bool                            no_ruler_shown_update;
892
893         Gtk::Widget * ruler_grabbed_widget;
894
895         RulerDialog* ruler_dialog;
896
897         void initialize_rulers ();
898         void update_just_timecode ();
899         void compute_fixed_ruler_scale (); //calculates the RulerScale of the fixed rulers
900         void update_fixed_rulers ();
901         void update_tempo_based_rulers ();
902         void popup_ruler_menu (framepos_t where = 0, ItemType type = RegionItem);
903         void update_ruler_visibility ();
904         void set_ruler_visible (RulerType, bool);
905         void toggle_ruler_visibility (RulerType rt);
906         void ruler_toggled (int);
907         bool ruler_label_button_release (GdkEventButton*);
908         void store_ruler_visibility ();
909         void restore_ruler_visibility ();
910
911
912
913                 enum MinsecRulerScale {
914                 minsec_show_msecs,
915                 minsec_show_seconds,
916                 minsec_show_minutes,
917                 minsec_show_hours,
918                 minsec_show_many_hours
919         };
920
921         MinsecRulerScale minsec_ruler_scale;
922
923         framecnt_t minsec_mark_interval;
924         gint minsec_mark_modulo;
925         gint minsec_nmarks;
926         void set_minsec_ruler_scale (framepos_t, framepos_t);
927
928         enum TimecodeRulerScale {
929                 timecode_show_bits,
930                 timecode_show_frames,
931                 timecode_show_seconds,
932                 timecode_show_minutes,
933                 timecode_show_hours,
934                 timecode_show_many_hours
935         };
936
937         TimecodeRulerScale timecode_ruler_scale;
938
939         gint timecode_mark_modulo;
940         gint timecode_nmarks;
941         void set_timecode_ruler_scale (framepos_t, framepos_t);
942
943         framecnt_t _samples_ruler_interval;
944         void set_samples_ruler_scale (framepos_t, framepos_t);
945
946         enum BBTRulerScale {
947                 bbt_show_many,
948                 bbt_show_64,
949                 bbt_show_16,
950                 bbt_show_4,
951                 bbt_show_1,
952                 bbt_show_beats,
953                 bbt_show_ticks,
954                 bbt_show_ticks_detail,
955                 bbt_show_ticks_super_detail
956         };
957
958         BBTRulerScale bbt_ruler_scale;
959
960         uint32_t bbt_bars;
961         gint bbt_nmarks;
962         uint32_t bbt_bar_helper_on;
963         uint32_t bbt_accent_modulo;
964         void compute_bbt_ruler_scale (framepos_t lower, framepos_t upper);
965
966         ArdourCanvas::Ruler* timecode_ruler;
967         ArdourCanvas::Ruler* bbt_ruler;
968         ArdourCanvas::Ruler* samples_ruler;
969         ArdourCanvas::Ruler* minsec_ruler;
970
971         static double timebar_height;
972         guint32 visible_timebars;
973         Gtk::Menu          *editor_ruler_menu;
974
975         ArdourCanvas::Rectangle* tempo_bar;
976         ArdourCanvas::Rectangle* meter_bar;
977         ArdourCanvas::Rectangle* marker_bar;
978         ArdourCanvas::Rectangle* range_marker_bar;
979         ArdourCanvas::Rectangle* transport_marker_bar;
980         ArdourCanvas::Rectangle* cd_marker_bar;
981
982         Gtk::Label  minsec_label;
983         Gtk::Label  bbt_label;
984         Gtk::Label  timecode_label;
985         Gtk::Label  samples_label;
986         Gtk::Label  tempo_label;
987         Gtk::Label  meter_label;
988         Gtk::Label  mark_label;
989         Gtk::Label  range_mark_label;
990         Gtk::Label  transport_mark_label;
991         Gtk::Label  cd_mark_label;
992
993         /* videtimline related actions */
994         Gtk::Label                videotl_label;
995         ArdourCanvas::Container*      videotl_group;
996         Glib::RefPtr<Gtk::ToggleAction> ruler_video_action;
997         Glib::RefPtr<Gtk::ToggleAction> xjadeo_proc_action;
998         Glib::RefPtr<Gtk::ToggleAction> xjadeo_ontop_action;
999         Glib::RefPtr<Gtk::ToggleAction> xjadeo_timecode_action;
1000         Glib::RefPtr<Gtk::ToggleAction> xjadeo_frame_action;
1001         Glib::RefPtr<Gtk::ToggleAction> xjadeo_osdbg_action;
1002         Glib::RefPtr<Gtk::ToggleAction> xjadeo_fullscreen_action;
1003         Glib::RefPtr<Gtk::ToggleAction> xjadeo_letterbox_action;
1004         Glib::RefPtr<Gtk::Action> xjadeo_zoom_100;
1005         void set_xjadeo_proc ();
1006         void toggle_xjadeo_proc (int state=-1);
1007         void set_close_video_sensitive (bool onoff);
1008         void set_xjadeo_sensitive (bool onoff);
1009         void set_xjadeo_viewoption (int);
1010         void toggle_xjadeo_viewoption (int what, int state=-1);
1011         void toggle_ruler_video (bool onoff) {ruler_video_action->set_active(onoff);}
1012         int videotl_bar_height; /* in units of timebar_height; default: 4 */
1013         int get_videotl_bar_height () const { return videotl_bar_height; }
1014         void toggle_region_video_lock ();
1015
1016         friend class EditorCursor;
1017
1018         EditorCursor* playhead_cursor;
1019         framepos_t playhead_cursor_sample () const;
1020
1021         framepos_t get_region_boundary (framepos_t pos, int32_t dir, bool with_selection, bool only_onscreen);
1022
1023         void    cursor_to_region_boundary (bool with_selection, int32_t dir);
1024         void    cursor_to_next_region_boundary (bool with_selection);
1025         void    cursor_to_previous_region_boundary (bool with_selection);
1026         void    cursor_to_next_region_point (EditorCursor*, ARDOUR::RegionPoint);
1027         void    cursor_to_previous_region_point (EditorCursor*, ARDOUR::RegionPoint);
1028         void    cursor_to_region_point (EditorCursor*, ARDOUR::RegionPoint, int32_t dir);
1029         void    cursor_to_selection_start (EditorCursor *);
1030         void    cursor_to_selection_end   (EditorCursor *);
1031
1032         void    selected_marker_to_region_boundary (bool with_selection, int32_t dir);
1033         void    selected_marker_to_next_region_boundary (bool with_selection);
1034         void    selected_marker_to_previous_region_boundary (bool with_selection);
1035         void    selected_marker_to_next_region_point (ARDOUR::RegionPoint);
1036         void    selected_marker_to_previous_region_point (ARDOUR::RegionPoint);
1037         void    selected_marker_to_region_point (ARDOUR::RegionPoint, int32_t dir);
1038         void    selected_marker_to_selection_start ();
1039         void    selected_marker_to_selection_end   ();
1040
1041         void    select_all_selectables_using_cursor (EditorCursor *, bool);
1042         void    select_all_selectables_using_edit (bool, bool);
1043         void    select_all_selectables_between (bool within);
1044         void    select_range_between ();
1045
1046         boost::shared_ptr<ARDOUR::Region> find_next_region (ARDOUR::framepos_t, ARDOUR::RegionPoint, int32_t dir, TrackViewList&, TimeAxisView ** = 0);
1047         ARDOUR::framepos_t find_next_region_boundary (ARDOUR::framepos_t, int32_t dir, const TrackViewList&);
1048
1049         std::vector<ARDOUR::framepos_t> region_boundary_cache;
1050         void build_region_boundary_cache ();
1051
1052         Gtk::HBox           toplevel_hpacker;
1053
1054         Gtk::HBox           top_hbox;
1055         Gtk::HBox           bottom_hbox;
1056
1057         Gtk::Table          edit_packer;
1058
1059         /** the adjustment that controls the overall editor vertical scroll position */
1060         Gtk::Adjustment     vertical_adjustment;
1061         Gtk::Adjustment     horizontal_adjustment;
1062
1063         Gtk::Adjustment     unused_adjustment; // yes, really; Gtk::Layout constructor requires refs
1064         Gtk::Layout         controls_layout;
1065         bool control_layout_scroll (GdkEventScroll* ev);
1066         void reset_controls_layout_width ();
1067         void reset_controls_layout_height (int32_t height);
1068
1069         enum Direction {
1070                 LEFT,
1071                 RIGHT,
1072                 UP,
1073                 DOWN
1074         };
1075
1076         bool scroll_press (Direction);
1077         void scroll_release ();
1078         sigc::connection _scroll_connection;
1079         int _scroll_callbacks;
1080
1081         double _visible_canvas_width;
1082         double _visible_canvas_height; ///< height of the visible area of the track canvas
1083         double _full_canvas_height;    ///< full height of the canvas
1084
1085         bool track_canvas_map_handler (GdkEventAny*);
1086
1087         bool edit_controls_button_release (GdkEventButton*);
1088         Gtk::Menu *edit_controls_left_menu;
1089         Gtk::Menu *edit_controls_right_menu;
1090
1091         Gtk::VBox           track_canvas_vbox;
1092         Gtk::VBox           edit_controls_vbox;
1093         Gtk::HBox           edit_controls_hbox;
1094
1095         void control_vertical_zoom_in_all ();
1096         void control_vertical_zoom_out_all ();
1097         void control_vertical_zoom_in_selected ();
1098         void control_vertical_zoom_out_selected ();
1099         void control_step_tracks_up ();
1100         void control_step_tracks_down ();
1101         void control_view (uint32_t);
1102         void control_scroll (float);
1103         void control_select (boost::shared_ptr<ARDOUR::Stripable>, Selection::Operation);
1104         void control_unselect ();
1105         void access_action (std::string,std::string);
1106         bool deferred_control_scroll (framepos_t);
1107         sigc::connection control_scroll_connection;
1108
1109         void tie_vertical_scrolling ();
1110         void set_horizontal_position (double);
1111         double horizontal_position () const;
1112
1113         struct VisualChange {
1114                 enum Type {
1115                         TimeOrigin = 0x1,
1116                         ZoomLevel = 0x2,
1117                         YOrigin = 0x4
1118                 };
1119
1120                 Type       pending;
1121                 framepos_t time_origin;
1122                 framecnt_t samples_per_pixel;
1123                 double     y_origin;
1124
1125                 int idle_handler_id;
1126                 /** true if we are currently in the idle handler */
1127                 bool being_handled;
1128
1129                 VisualChange() : pending ((VisualChange::Type) 0), time_origin (0), samples_per_pixel (0), idle_handler_id (-1), being_handled (false) {}
1130                 void add (Type t) {
1131                         pending = Type (pending | t);
1132                 }
1133         };
1134
1135         VisualChange pending_visual_change;
1136
1137         static int _idle_visual_changer (void *arg);
1138         int idle_visual_changer ();
1139         void visual_changer (const VisualChange&);
1140         void ensure_visual_change_idle_handler ();
1141
1142         /* track views */
1143         TrackViewList track_views;
1144         std::pair<TimeAxisView*, double> trackview_by_y_position (double, bool trackview_relative_offset = true) const;
1145         TimeAxisView* axis_view_from_stripable (boost::shared_ptr<ARDOUR::Stripable>) const;
1146
1147         TrackViewList get_tracks_for_range_action () const;
1148
1149         sigc::connection super_rapid_screen_update_connection;
1150         framepos_t last_update_frame;
1151         void center_screen_internal (framepos_t, float);
1152
1153         void super_rapid_screen_update ();
1154
1155         void session_going_away ();
1156
1157         framepos_t cut_buffer_start;
1158         framecnt_t cut_buffer_length;
1159
1160         boost::shared_ptr<CursorContext> _press_cursor_ctx;  ///< Button press cursor context
1161
1162         boost::weak_ptr<ARDOUR::Trimmable> _trimmable;
1163         boost::weak_ptr<ARDOUR::Movable> _movable;
1164
1165         bool typed_event (ArdourCanvas::Item*, GdkEvent*, ItemType);
1166         bool button_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1167         bool button_press_handler_1 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1168         bool button_press_handler_2 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1169         bool button_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1170         bool button_double_click_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1171         bool button_press_dispatch (GdkEventButton*);
1172         bool button_release_dispatch (GdkEventButton*);
1173         bool motion_handler (ArdourCanvas::Item*, GdkEvent*, bool from_autoscroll = false);
1174         bool enter_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1175         bool leave_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1176         bool key_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1177         bool key_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1178
1179         Gtkmm2ext::Bindings* button_bindings;
1180         XMLNode* button_settings () const;
1181
1182         /* KEYMAP HANDLING */
1183
1184         void register_actions ();
1185         void register_region_actions ();
1186
1187         void load_bindings ();
1188
1189         /* CUT/COPY/PASTE */
1190
1191         framepos_t last_paste_pos;
1192         unsigned   paste_count;
1193
1194         void cut_copy (Editing::CutCopyOp);
1195         bool can_cut_copy () const;
1196         void cut_copy_points (Editing::CutCopyOp, Evoral::Beats earliest=Evoral::Beats(), bool midi=false);
1197         void cut_copy_regions (Editing::CutCopyOp, RegionSelection&);
1198         void cut_copy_ranges (Editing::CutCopyOp);
1199         void cut_copy_midi (Editing::CutCopyOp);
1200
1201         void mouse_paste ();
1202         void paste_internal (framepos_t position, float times, const int32_t sub_num);
1203
1204         /* EDITING OPERATIONS */
1205
1206         void reset_point_selection ();
1207         void toggle_region_lock ();
1208         void toggle_opaque_region ();
1209         void toggle_record_enable ();
1210         void toggle_solo ();
1211         void toggle_solo_isolate ();
1212         void toggle_mute ();
1213         void toggle_region_lock_style ();
1214
1215         enum LayerOperation {
1216                 Raise,
1217                 RaiseToTop,
1218                 Lower,
1219                 LowerToBottom
1220         };
1221
1222         void do_layer_operation (LayerOperation);
1223         void raise_region ();
1224         void raise_region_to_top ();
1225         void change_region_layering_order (bool from_context_menu);
1226         void lower_region ();
1227         void lower_region_to_bottom ();
1228         void split_region_at_transients ();
1229         void crop_region_to_selection ();
1230         void crop_region_to (framepos_t start, framepos_t end);
1231         void set_sync_point (framepos_t, const RegionSelection&);
1232         void set_region_sync_position ();
1233         void remove_region_sync();
1234         void align_regions (ARDOUR::RegionPoint);
1235         void align_regions_relative (ARDOUR::RegionPoint point);
1236         void align_region (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1237         void align_region_internal (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1238         void remove_selected_regions ();
1239         void remove_clicked_region ();
1240         void show_region_properties ();
1241         void show_midi_list_editor ();
1242         void rename_region ();
1243         void duplicate_some_regions (RegionSelection&, float times);
1244         void duplicate_selection (float times);
1245         void region_fill_selection ();
1246         void combine_regions ();
1247         void uncombine_regions ();
1248
1249         void region_fill_track ();
1250         void audition_playlist_region_standalone (boost::shared_ptr<ARDOUR::Region>);
1251         void split_multichannel_region();
1252         void reverse_region ();
1253         void strip_region_silence ();
1254         void normalize_region ();
1255         void reset_region_scale_amplitude ();
1256         void adjust_region_gain (bool up);
1257         void quantize_region ();
1258         void quantize_regions (const RegionSelection& rs);
1259         void legatize_region (bool shrink_only);
1260         void legatize_regions (const RegionSelection& rs, bool shrink_only);
1261         void transform_region ();
1262         void transform_regions (const RegionSelection& rs);
1263         void transpose_region ();
1264         void transpose_regions (const RegionSelection& rs);
1265         void insert_patch_change (bool from_context);
1266         void fork_region ();
1267
1268         void do_insert_time ();
1269         void insert_time (framepos_t, framecnt_t, Editing::InsertTimeOption, bool, bool, bool, bool, bool, bool);
1270
1271         void do_remove_time ();
1272         void remove_time (framepos_t pos, framecnt_t distance, Editing::InsertTimeOption opt, bool ignore_music_glue, bool markers_too,
1273                         bool glued_markers_too, bool locked_markers_too, bool tempo_too);
1274
1275         void tab_to_transient (bool forward);
1276
1277         void set_tempo_from_region ();
1278         void use_range_as_bar ();
1279
1280         void define_one_bar (framepos_t start, framepos_t end);
1281
1282         void audition_region_from_region_list ();
1283         void hide_region_from_region_list ();
1284         void show_region_in_region_list ();
1285
1286         void naturalize_region ();
1287
1288         void split_region ();
1289
1290         void delete_ ();
1291         void cut ();
1292         void copy ();
1293         void paste (float times, bool from_context_menu);
1294
1295         void place_transient ();
1296         void remove_transient (ArdourCanvas::Item* item);
1297         void snap_regions_to_grid ();
1298         void close_region_gaps ();
1299
1300         void keyboard_paste ();
1301
1302         void region_from_selection ();
1303         void create_region_from_selection (std::vector<boost::shared_ptr<ARDOUR::Region> >&);
1304
1305         void play_from_start ();
1306         void play_from_edit_point ();
1307         void play_from_edit_point_and_return ();
1308         void play_selected_region ();
1309         void play_edit_range ();
1310         void play_location (ARDOUR::Location&);
1311         void loop_location (ARDOUR::Location&);
1312
1313         void calc_extra_zoom_edges(framepos_t &start, framepos_t &end);
1314         void temporal_zoom_selection (Editing::ZoomAxis);
1315         void temporal_zoom_session ();
1316         void temporal_zoom (framecnt_t samples_per_pixel);
1317         void temporal_zoom_by_frame (framepos_t start, framepos_t end);
1318         void temporal_zoom_to_frame (bool coarser, framepos_t frame);
1319
1320         void insert_region_list_selection (float times);
1321
1322         /* PT import */
1323         void external_pt_dialog ();
1324         typedef struct ptflookup {
1325                 uint16_t index1;
1326                 uint16_t index2;
1327                 PBD::ID  id;
1328
1329                 bool operator ==(const struct ptflookup& other) {
1330                         return (this->index1 == other.index1);
1331                 }
1332         } ptflookup_t;
1333
1334         /* import & embed */
1335
1336         void add_external_audio_action (Editing::ImportMode);
1337         void external_audio_dialog ();
1338         void session_import_dialog ();
1339
1340         int  check_whether_and_how_to_import(std::string, bool all_or_nothing = true);
1341         bool check_multichannel_status (const std::vector<std::string>& paths);
1342
1343         SoundFileOmega* sfbrowser;
1344
1345         void bring_in_external_audio (Editing::ImportMode mode,  framepos_t& pos);
1346
1347         bool  idle_drop_paths  (std::vector<std::string> paths, framepos_t frame, double ypos, bool copy);
1348         void  drop_paths_part_two  (const std::vector<std::string>& paths, framepos_t frame, double ypos, bool copy);
1349
1350         int import_sndfiles (std::vector<std::string>              paths,
1351                              Editing::ImportDisposition            disposition,
1352                              Editing::ImportMode                   mode,
1353                              ARDOUR::SrcQuality                    quality,
1354                              framepos_t&                           pos,
1355                              int                                   target_regions,
1356                              int                                   target_tracks,
1357                              boost::shared_ptr<ARDOUR::Track>&     track,
1358                              bool                                  replace,
1359                              boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1360
1361         int embed_sndfiles (std::vector<std::string>              paths,
1362                             bool                                  multiple_files,
1363                             bool&                                 check_sample_rate,
1364                             Editing::ImportDisposition            disposition,
1365                             Editing::ImportMode                   mode,
1366                             framepos_t&                           pos,
1367                             int                                   target_regions,
1368                             int                                   target_tracks,
1369                             boost::shared_ptr<ARDOUR::Track>&     track,
1370                             boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1371
1372         int add_sources (std::vector<std::string>              paths,
1373                          ARDOUR::SourceList&                   sources,
1374                          framepos_t&                           pos,
1375                          Editing::ImportDisposition            disposition,
1376                          Editing::ImportMode                   mode,
1377                          int                                   target_regions,
1378                          int                                   target_tracks,
1379                          boost::shared_ptr<ARDOUR::Track>&     track,
1380                          bool                                  add_channel_suffix,
1381                          boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
1382
1383         int finish_bringing_in_material (boost::shared_ptr<ARDOUR::Region>     region,
1384                                          uint32_t                              in_chans,
1385                                          uint32_t                              out_chans,
1386                                          framepos_t&                           pos,
1387                                          Editing::ImportMode                   mode,
1388                                          boost::shared_ptr<ARDOUR::Track>&     existing_track,
1389                                          const std::string&                    new_track_name,
1390                                          boost::shared_ptr<ARDOUR::PluginInfo> instrument);
1391
1392         boost::shared_ptr<ARDOUR::AudioTrack> get_nth_selected_audio_track (int nth) const;
1393         boost::shared_ptr<ARDOUR::MidiTrack> get_nth_selected_midi_track (int nth) const;
1394
1395         void toggle_midi_input_active (bool flip_others);
1396
1397         ARDOUR::InterThreadInfo* current_interthread_info;
1398
1399         AnalysisWindow* analysis_window;
1400
1401         /* import specific info */
1402
1403         struct EditorImportStatus : public ARDOUR::ImportStatus {
1404             Editing::ImportMode mode;
1405             framepos_t pos;
1406             int target_tracks;
1407             int target_regions;
1408             boost::shared_ptr<ARDOUR::Track> track;
1409             bool replace;
1410         };
1411
1412         EditorImportStatus import_status;
1413         static void *_import_thread (void *);
1414         void* import_thread ();
1415         void finish_import ();
1416
1417         /* to support this ... */
1418
1419         void import_audio (bool as_tracks);
1420         void do_import (std::vector<std::string> paths, bool split, bool as_tracks);
1421         void import_smf_tempo_map (Evoral::SMF const &);
1422         void move_to_start ();
1423         void move_to_end ();
1424         void center_playhead ();
1425         void center_edit_point ();
1426         void playhead_forward_to_grid ();
1427         void playhead_backward_to_grid ();
1428         void scroll_playhead (bool forward);
1429         void scroll_backward (float pages=0.8f);
1430         void scroll_forward (float pages=0.8f);
1431         void scroll_tracks_down ();
1432         void scroll_tracks_up ();
1433         void set_mark ();
1434         void clear_markers ();
1435         void clear_ranges ();
1436         void clear_locations ();
1437         void unhide_markers ();
1438         void unhide_ranges ();
1439         void jump_forward_to_mark ();
1440         void jump_backward_to_mark ();
1441         void cursor_align (bool playhead_to_edit);
1442         void toggle_skip_playback ();
1443
1444         void remove_last_capture ();
1445         void select_all_selectables_using_time_selection ();
1446         void select_all_selectables_using_loop();
1447         void select_all_selectables_using_punch();
1448         void set_selection_from_range (ARDOUR::Location&);
1449         void set_selection_from_punch ();
1450         void set_selection_from_loop ();
1451         void set_selection_from_region ();
1452
1453         void add_location_mark (framepos_t where);
1454         void add_location_from_region ();
1455         void add_locations_from_region ();
1456         void add_location_from_selection ();
1457         void set_loop_from_selection (bool play);
1458         void set_punch_from_selection ();
1459         void set_punch_from_region ();
1460         void set_auto_punch_range();
1461
1462         void set_session_start_from_playhead ();
1463         void set_session_end_from_playhead ();
1464         void set_session_extents_from_selection ();
1465
1466         void set_loop_from_region (bool play);
1467
1468         void set_loop_range (framepos_t start, framepos_t end, std::string cmd);
1469         void set_punch_range (framepos_t start, framepos_t end, std::string cmd);
1470
1471         void toggle_location_at_playhead_cursor ();
1472         void add_location_from_playhead_cursor ();
1473         bool do_remove_location_at_playhead_cursor ();
1474         void remove_location_at_playhead_cursor ();
1475         bool select_new_marker;
1476
1477         void reverse_selection ();
1478         void edit_envelope ();
1479
1480         double last_scrub_x;
1481         int scrubbing_direction;
1482         int scrub_reversals;
1483         int scrub_reverse_distance;
1484         void scrub (framepos_t, double);
1485
1486         void set_punch_start_from_edit_point ();
1487         void set_punch_end_from_edit_point ();
1488         void set_loop_start_from_edit_point ();
1489         void set_loop_end_from_edit_point ();
1490
1491         void keyboard_selection_begin ( Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE );
1492         void keyboard_selection_finish (bool add, Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE);
1493         bool have_pending_keyboard_selection;
1494         framepos_t pending_keyboard_selection_start;
1495
1496         void move_range_selection_start_or_end_to_region_boundary (bool, bool);
1497
1498         Editing::SnapType _snap_type;
1499         Editing::SnapMode _snap_mode;
1500
1501         /// Snap threshold in pixels
1502         double snap_threshold;
1503
1504         bool ignore_gui_changes;
1505
1506         DragManager* _drags;
1507
1508         void escape ();
1509         void lock ();
1510         void unlock ();
1511         Gtk::Dialog* lock_dialog;
1512
1513         struct timeval last_event_time;
1514         bool generic_event_handler (GdkEvent*);
1515         bool lock_timeout_callback ();
1516         void start_lock_event_timing ();
1517
1518         Gtk::Menu fade_context_menu;
1519
1520         Gtk::Menu xfade_in_context_menu;
1521         Gtk::Menu xfade_out_context_menu;
1522         void popup_xfade_in_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1523         void popup_xfade_out_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1524         void fill_xfade_menu (Gtk::Menu_Helpers::MenuList& items, bool start);
1525
1526         void set_fade_in_shape (ARDOUR::FadeShape);
1527         void set_fade_out_shape (ARDOUR::FadeShape);
1528
1529         void set_fade_length (bool in);
1530         void set_fade_in_active (bool);
1531         void set_fade_out_active (bool);
1532
1533         void fade_range ();
1534
1535         std::set<boost::shared_ptr<ARDOUR::Playlist> > motion_frozen_playlists;
1536
1537         bool _dragging_playhead;
1538         bool _dragging_edit_point;
1539
1540         void marker_drag_motion_callback (GdkEvent*);
1541         void marker_drag_finished_callback (GdkEvent*);
1542
1543         gint mouse_rename_region (ArdourCanvas::Item*, GdkEvent*);
1544
1545         void add_region_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1546         void start_create_region_grab (ArdourCanvas::Item*, GdkEvent*);
1547         void add_region_copy_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1548         void add_region_brush_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1549         void start_selection_grab (ArdourCanvas::Item*, GdkEvent*);
1550
1551         void region_view_item_click (AudioRegionView&, GdkEventButton*);
1552
1553         bool can_remove_control_point (ArdourCanvas::Item *);
1554         void remove_control_point (ArdourCanvas::Item *);
1555
1556         void mouse_brush_insert_region (RegionView*, framepos_t pos);
1557
1558         /* Canvas event handlers */
1559
1560         bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas);
1561         bool canvas_control_point_event (GdkEvent* event,ArdourCanvas::Item*, ControlPoint*);
1562         bool canvas_line_event (GdkEvent* event,ArdourCanvas::Item*, AutomationLine*);
1563         bool canvas_selection_rect_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1564         bool canvas_selection_start_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1565         bool canvas_selection_end_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1566         bool canvas_start_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1567         bool canvas_end_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1568         bool canvas_fade_in_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1569         bool canvas_fade_in_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*, bool trim = false);
1570         bool canvas_fade_out_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1571         bool canvas_fade_out_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*, bool trim = false);
1572         bool canvas_region_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1573         bool canvas_wave_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1574         bool canvas_frame_handle_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1575         bool canvas_region_view_name_highlight_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1576         bool canvas_region_view_name_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1577         bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*);
1578         bool canvas_stream_view_event (GdkEvent* event,ArdourCanvas::Item*, RouteTimeAxisView*);
1579         bool canvas_marker_event (GdkEvent* event,ArdourCanvas::Item*, ArdourMarker*);
1580         bool canvas_tempo_marker_event (GdkEvent* event,ArdourCanvas::Item*, TempoMarker*);
1581         bool canvas_tempo_curve_event (GdkEvent* event,ArdourCanvas::Item*, TempoCurve*);
1582         bool canvas_meter_marker_event (GdkEvent* event,ArdourCanvas::Item*, MeterMarker*);
1583         bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*);
1584         bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item *);
1585
1586         bool canvas_ruler_event (GdkEvent* event, ArdourCanvas::Item *, ItemType);
1587         bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1588         bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1589         bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1590         bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1591         bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1592         bool canvas_cd_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1593
1594         bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1595         void update_video_timeline (bool flush = false);
1596         void set_video_timeline_height (const int);
1597         bool is_video_timeline_locked ();
1598         void toggle_video_timeline_locked ();
1599         void set_video_timeline_locked (const bool);
1600         void queue_visual_videotimeline_update ();
1601         void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true);
1602
1603         PBD::Signal0<void> EditorFreeze;
1604         PBD::Signal0<void> EditorThaw;
1605
1606   private:
1607         friend class DragManager;
1608         friend class EditorRouteGroups;
1609         friend class EditorRegions;
1610
1611         /* non-public event handlers */
1612
1613         bool canvas_playhead_cursor_event (GdkEvent* event, ArdourCanvas::Item*);
1614         bool track_canvas_scroll (GdkEventScroll* event);
1615
1616         bool track_canvas_button_press_event (GdkEventButton* event);
1617         bool track_canvas_button_release_event (GdkEventButton* event);
1618         bool track_canvas_motion_notify_event (GdkEventMotion* event);
1619
1620         Gtk::Allocation _canvas_viewport_allocation;
1621         void track_canvas_viewport_allocate (Gtk::Allocation alloc);
1622         void track_canvas_viewport_size_allocated ();
1623         bool track_canvas_drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int, int, guint);
1624         bool track_canvas_key_press (GdkEventKey *);
1625         bool track_canvas_key_release (GdkEventKey *);
1626
1627         void set_playhead_cursor ();
1628
1629         void toggle_region_mute ();
1630
1631         void initialize_canvas ();
1632
1633         void set_script_action_name (int i, const std::string&);
1634
1635         /* display control */
1636
1637         bool _show_measures;
1638         /// true if the editor should follow the playhead, otherwise false
1639         bool _follow_playhead;
1640         /// true if we scroll the tracks rather than the playhead
1641         bool _stationary_playhead;
1642         /// true if we are in fullscreen mode
1643         bool _maximised;
1644
1645         TempoLines* tempo_lines;
1646
1647         ArdourCanvas::Container* global_rect_group;
1648         ArdourCanvas::Container* time_line_group;
1649
1650         void hide_measures ();
1651         void draw_measures (std::vector<ARDOUR::TempoMap::BBTPoint>&);
1652
1653         void new_tempo_section ();
1654
1655
1656         void remove_tempo_marker (ArdourCanvas::Item*);
1657         void remove_meter_marker (ArdourCanvas::Item*);
1658         gint real_remove_tempo_marker (ARDOUR::TempoSection*);
1659         gint real_remove_meter_marker (ARDOUR::MeterSection*);
1660
1661         void edit_tempo_marker (TempoMarker&);
1662         void edit_meter_marker (MeterMarker&);
1663         void edit_control_point (ArdourCanvas::Item*);
1664         void edit_notes (MidiRegionView*);
1665         void edit_region (RegionView*);
1666
1667         void edit_current_meter ();
1668         void edit_current_tempo ();
1669
1670         void marker_menu_edit ();
1671         void marker_menu_remove ();
1672         void marker_menu_rename ();
1673         void rename_marker (ArdourMarker *marker);
1674         void toggle_marker_lock_style ();
1675         void toggle_tempo_type ();
1676         void toggle_marker_menu_lock ();
1677         void toggle_marker_menu_glue ();
1678         void marker_menu_hide ();
1679         void marker_menu_loop_range ();
1680         void marker_menu_select_all_selectables_using_range ();
1681         void marker_menu_select_using_range ();
1682         void marker_menu_separate_regions_using_location ();
1683         void marker_menu_play_from ();
1684         void marker_menu_play_range ();
1685         void marker_menu_set_playhead ();
1686         void marker_menu_set_from_playhead ();
1687         void marker_menu_set_from_selection (bool force_regions);
1688         void marker_menu_range_to_next ();
1689         void marker_menu_zoom_to_range ();
1690         void new_transport_marker_menu_set_loop ();
1691         void new_transport_marker_menu_set_punch ();
1692         void update_loop_range_view ();
1693         void update_punch_range_view ();
1694         void new_transport_marker_menu_popdown ();
1695         void marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1696         void tempo_or_meter_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1697         void new_transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1698         void build_range_marker_menu (bool, bool);
1699         void build_marker_menu (ARDOUR::Location *);
1700         void build_tempo_marker_menu (TempoMarker *, bool);
1701         void build_meter_marker_menu (MeterMarker *, bool);
1702         void build_new_transport_marker_menu ();
1703         void dynamic_cast_marker_object (void*, MeterMarker**, TempoMarker**) const;
1704
1705         Gtk::Menu* tempo_marker_menu;
1706         Gtk::Menu* meter_marker_menu;
1707         Gtk::Menu* marker_menu;
1708         Gtk::Menu* range_marker_menu;
1709         Gtk::Menu* transport_marker_menu;
1710         Gtk::Menu* new_transport_marker_menu;
1711         Gtk::Menu* cd_marker_menu;
1712         ArdourCanvas::Item* marker_menu_item;
1713
1714         typedef std::list<ArdourMarker*> Marks;
1715         Marks metric_marks;
1716
1717         typedef std::list<TempoCurve*> Curves;
1718         Curves tempo_curves;
1719
1720         void remove_metric_marks ();
1721         void draw_metric_marks (const ARDOUR::Metrics& metrics);
1722
1723         void compute_current_bbt_points (std::vector<ARDOUR::TempoMap::BBTPoint>& grid, framepos_t left, framepos_t right);
1724
1725         void tempo_map_changed (const PBD::PropertyChange&);
1726         void marker_position_changed ();
1727         void redisplay_tempo (bool immediate_redraw);
1728
1729         uint32_t bbt_beat_subdivision;
1730
1731         /* toolbar */
1732
1733         Gtk::ToggleButton editor_mixer_button;
1734         Gtk::ToggleButton editor_list_button;
1735         void editor_mixer_button_toggled ();
1736         void editor_list_button_toggled ();
1737
1738         ArdourButton              zoom_in_button;
1739         ArdourButton              zoom_out_button;
1740         ArdourButton              zoom_out_full_button;
1741
1742         ArdourButton              tav_expand_button;
1743         ArdourButton              tav_shrink_button;
1744         ArdourDropdown            visible_tracks_selector;
1745         ArdourDropdown            zoom_preset_selector;
1746
1747         int32_t                   _visible_track_count;
1748         void build_track_count_menu ();
1749         void set_visible_track_count (int32_t);
1750
1751         void set_zoom_preset(int64_t);
1752
1753         Gtk::VBox                toolbar_clock_vbox;
1754         Gtk::VBox                toolbar_selection_clock_vbox;
1755         Gtk::Table               toolbar_selection_clock_table;
1756         Gtk::Label               toolbar_selection_cursor_label;
1757
1758         ArdourButton mouse_select_button;
1759         ArdourButton mouse_draw_button;
1760         ArdourButton mouse_move_button;
1761         ArdourButton mouse_timefx_button;
1762         ArdourButton mouse_content_button;
1763         ArdourButton mouse_audition_button;
1764         ArdourButton mouse_cut_button;
1765
1766         ArdourButton smart_mode_button;
1767         Glib::RefPtr<Gtk::ToggleAction> smart_mode_action;
1768
1769         void                     mouse_mode_toggled (Editing::MouseMode m);
1770         void                     mouse_mode_object_range_toggled ();
1771         bool                     ignore_mouse_mode_toggle;
1772
1773         bool                     mouse_select_button_release (GdkEventButton*);
1774
1775         Gtk::VBox                automation_box;
1776         Gtk::Button              automation_mode_button;
1777
1778         //edit mode menu stuff
1779         ArdourDropdown  edit_mode_selector;
1780         void edit_mode_selection_done ( ARDOUR::EditMode m );
1781         void build_edit_mode_menu ();
1782         Gtk::VBox         edit_mode_box;
1783
1784         void set_edit_mode (ARDOUR::EditMode);
1785         void cycle_edit_mode ();
1786
1787         ArdourDropdown snap_type_selector;
1788         void build_snap_type_menu ();
1789
1790         ArdourDropdown snap_mode_selector;
1791         void build_snap_mode_menu ();
1792         Gtk::HBox         snap_box;
1793
1794         std::vector<std::string> snap_type_strings;
1795         std::vector<std::string> snap_mode_strings;
1796
1797         void snap_type_selection_done (Editing::SnapType);
1798         void snap_mode_selection_done (Editing::SnapMode);
1799         void snap_mode_chosen (Editing::SnapMode);
1800         void snap_type_chosen (Editing::SnapType);
1801
1802         Glib::RefPtr<Gtk::RadioAction> snap_type_action (Editing::SnapType);
1803         Glib::RefPtr<Gtk::RadioAction> snap_mode_action (Editing::SnapMode);
1804
1805         //zoom focus meu stuff
1806         ArdourDropdown  zoom_focus_selector;
1807         void zoom_focus_selection_done ( Editing::ZoomFocus f );
1808         void build_zoom_focus_menu ();
1809         std::vector<std::string> zoom_focus_strings;
1810
1811         void zoom_focus_chosen (Editing::ZoomFocus);
1812
1813         Glib::RefPtr<Gtk::RadioAction> zoom_focus_action (Editing::ZoomFocus);
1814
1815         Gtk::HBox           _zoom_box;
1816         void                zoom_adjustment_changed();
1817
1818         void setup_toolbar ();
1819
1820         void setup_tooltips ();
1821
1822         Gtk::HBox                toolbar_hbox;
1823         Gtk::EventBox            toolbar_base;
1824         Gtk::Frame               toolbar_frame;
1825         Gtk::Viewport           _toolbar_viewport;
1826
1827         void setup_midi_toolbar ();
1828
1829         /* selection process */
1830
1831         Selection* selection;
1832         Selection* cut_buffer;
1833         SelectionMemento* _selection_memento;
1834
1835         void time_selection_changed ();
1836         void update_time_selection_display ();
1837         void track_selection_changed ();
1838         void region_selection_changed ();
1839         sigc::connection editor_regions_selection_changed_connection;
1840         void sensitize_all_region_actions (bool);
1841         void sensitize_the_right_region_actions ();
1842         bool _all_region_actions_sensitized;
1843         /** Flag to block region action handlers from doing what they normally do;
1844          *  I tried Gtk::Action::block_activate() but this doesn't work (ie it doesn't
1845          *  block) when setting a ToggleAction's active state.
1846          */
1847         bool _ignore_region_action;
1848         bool _last_region_menu_was_main;
1849         void point_selection_changed ();
1850         void marker_selection_changed ();
1851
1852         bool _ignore_follow_edits;
1853
1854         void cancel_selection ();
1855         void cancel_time_selection ();
1856
1857         bool get_smart_mode() const;
1858
1859         bool audio_region_selection_covers (framepos_t where);
1860
1861         /* transport range select process */
1862
1863         ArdourCanvas::Rectangle*  cd_marker_bar_drag_rect;
1864         ArdourCanvas::Rectangle*  range_bar_drag_rect;
1865         ArdourCanvas::Rectangle*  transport_bar_drag_rect;
1866         ArdourCanvas::Rectangle     *transport_bar_range_rect;
1867         ArdourCanvas::Rectangle     *transport_bar_preroll_rect;
1868         ArdourCanvas::Rectangle     *transport_bar_postroll_rect;
1869         ArdourCanvas::Rectangle     *transport_loop_range_rect;
1870         ArdourCanvas::Rectangle     *transport_punch_range_rect;
1871         ArdourCanvas::Line     *transport_punchin_line;
1872         ArdourCanvas::Line     *transport_punchout_line;
1873         ArdourCanvas::Rectangle     *transport_preroll_rect;
1874         ArdourCanvas::Rectangle     *transport_postroll_rect;
1875
1876         ARDOUR::Location*  transport_loop_location();
1877         ARDOUR::Location*  transport_punch_location();
1878
1879         ARDOUR::Location   *temp_location;
1880
1881         /* object rubberband select process */
1882
1883         void select_all_within (framepos_t, framepos_t, double, double, TrackViewList const &, Selection::Operation, bool);
1884
1885         ArdourCanvas::Rectangle   *rubberband_rect;
1886
1887         EditorRouteGroups* _route_groups;
1888         EditorRoutes* _routes;
1889         EditorRegions* _regions;
1890         EditorSnapshots* _snapshots;
1891         EditorLocations* _locations;
1892
1893         /* diskstream/route display management */
1894         Glib::RefPtr<Gdk::Pixbuf> rec_enabled_icon;
1895         Glib::RefPtr<Gdk::Pixbuf> rec_disabled_icon;
1896
1897         Glib::RefPtr<Gtk::TreeSelection> route_display_selection;
1898
1899         bool sync_track_view_list_and_routes ();
1900
1901         Gtk::VBox           list_vpacker;
1902
1903         /* autoscrolling */
1904
1905         sigc::connection autoscroll_connection;
1906         bool autoscroll_horizontal_allowed;
1907         bool autoscroll_vertical_allowed;
1908         uint32_t autoscroll_cnt;
1909         Gtk::Widget* autoscroll_widget;
1910         ArdourCanvas::Rect autoscroll_boundary;
1911
1912         bool autoscroll_canvas ();
1913         void start_canvas_autoscroll (bool allow_horiz, bool allow_vert, const ArdourCanvas::Rect& boundary);
1914         void stop_canvas_autoscroll ();
1915
1916         /* trimming */
1917         void point_trim (GdkEvent *, framepos_t);
1918
1919         void trim_region_front();
1920         void trim_region_back();
1921         void trim_region (bool front);
1922
1923         void trim_region_to_loop ();
1924         void trim_region_to_punch ();
1925         void trim_region_to_location (const ARDOUR::Location&, const char* cmd);
1926
1927         void trim_to_region(bool forward);
1928         void trim_region_to_previous_region_end();
1929         void trim_region_to_next_region_start();
1930
1931         bool show_gain_after_trim;
1932
1933         /* Drag-n-Drop */
1934
1935         int convert_drop_to_paths (
1936                 std::vector<std::string>&           paths,
1937                 const Glib::RefPtr<Gdk::DragContext>& context,
1938                 gint                                  x,
1939                 gint                                  y,
1940                 const Gtk::SelectionData&             data,
1941                 guint                                 info,
1942                 guint                                 time);
1943
1944         void track_canvas_drag_data_received (
1945                 const Glib::RefPtr<Gdk::DragContext>& context,
1946                 gint                                  x,
1947                 gint                                  y,
1948                 const Gtk::SelectionData&             data,
1949                 guint                                 info,
1950                 guint                                 time);
1951
1952         void drop_paths (
1953                 const Glib::RefPtr<Gdk::DragContext>& context,
1954                 gint                                  x,
1955                 gint                                  y,
1956                 const Gtk::SelectionData&             data,
1957                 guint                                 info,
1958                 guint                                 time);
1959
1960         void drop_regions (
1961                 const Glib::RefPtr<Gdk::DragContext>& context,
1962                 gint                                  x,
1963                 gint                                  y,
1964                 const Gtk::SelectionData&             data,
1965                 guint                                 info,
1966                 guint                                 time);
1967
1968         void drop_routes (
1969                 const Glib::RefPtr<Gdk::DragContext>& context,
1970                 gint                x,
1971                 gint                y,
1972                 const Gtk::SelectionData& data,
1973                 guint               info,
1974                 guint               time);
1975
1976         /* audio export */
1977
1978         int  write_region_selection(RegionSelection&);
1979         bool write_region (std::string path, boost::shared_ptr<ARDOUR::AudioRegion>);
1980         void bounce_region_selection (bool with_processing);
1981         void bounce_range_selection (bool replace, bool enable_processing);
1982         void external_edit_region ();
1983
1984         int write_audio_selection (TimeSelection&);
1985         bool write_audio_range (ARDOUR::AudioPlaylist&, const ARDOUR::ChanCount& channels, std::list<ARDOUR::AudioRange>&);
1986
1987         void write_selection ();
1988
1989         uint32_t selection_op_cmd_depth;
1990         uint32_t selection_op_history_it;
1991
1992         std::list<XMLNode *> selection_op_history; /* used in *_reversible_selection_op */
1993         std::list<XMLNode *> before; /* used in *_reversible_command */
1994
1995         void update_title ();
1996         void update_title_s (const std::string & snapshot_name);
1997
1998         void instant_save ();
1999         bool no_save_instant;
2000
2001         boost::shared_ptr<ARDOUR::AudioRegion> last_audition_region;
2002
2003         /* freeze operations */
2004
2005         ARDOUR::InterThreadInfo freeze_status;
2006         static void* _freeze_thread (void*);
2007         void* freeze_thread ();
2008
2009         void freeze_route ();
2010         void unfreeze_route ();
2011
2012         /* duplication */
2013
2014         void duplicate_range (bool with_dialog);
2015         void duplicate_regions (float times);
2016
2017         /** computes the timeline frame (sample) of an event whose coordinates
2018          * are in canvas units (pixels, scroll offset included).
2019          */
2020         framepos_t canvas_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
2021
2022         /** computes the timeline frame (sample) of an event whose coordinates
2023          * are in window units (pixels, no scroll offset).
2024          */
2025         framepos_t window_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
2026
2027         /* returns false if mouse pointer is not in track or marker canvas
2028          */
2029         bool mouse_frame (framepos_t&, bool& in_track_canvas) const;
2030
2031         TimeFXDialog* current_timefx;
2032         static void* timefx_thread (void *arg);
2033         void do_timefx ();
2034
2035         int time_stretch (RegionSelection&, float fraction);
2036         int pitch_shift (RegionSelection&, float cents);
2037         void pitch_shift_region ();
2038
2039         /* editor-mixer strip */
2040
2041         MixerStrip *current_mixer_strip;
2042         bool show_editor_mixer_when_tracks_arrive;
2043         Gtk::VBox current_mixer_strip_vbox;
2044         void cms_new (boost::shared_ptr<ARDOUR::Route>);
2045         void current_mixer_strip_hidden ();
2046
2047 #ifdef __APPLE__
2048         void ensure_all_elements_drawn ();
2049 #endif
2050         /* nudging tracks */
2051
2052         void nudge_track (bool use_edit_point, bool forwards);
2053
2054         static const int32_t default_width = 995;
2055         static const int32_t default_height = 765;
2056
2057         /* nudge */
2058
2059         ArdourButton      nudge_forward_button;
2060         ArdourButton      nudge_backward_button;
2061         Gtk::HBox        nudge_hbox;
2062         Gtk::VBox        nudge_vbox;
2063         AudioClock*       nudge_clock;
2064
2065         bool nudge_forward_release (GdkEventButton*);
2066         bool nudge_backward_release (GdkEventButton*);
2067
2068         /* audio filters */
2069
2070         void apply_filter (ARDOUR::Filter&, std::string cmd, ProgressReporter* progress = 0);
2071
2072         Command* apply_midi_note_edit_op_to_region (ARDOUR::MidiOperator& op, MidiRegionView& mrv);
2073         void apply_midi_note_edit_op (ARDOUR::MidiOperator& op, const RegionSelection& rs);
2074
2075         /* handling cleanup */
2076
2077         int playlist_deletion_dialog (boost::shared_ptr<ARDOUR::Playlist>);
2078
2079         PBD::ScopedConnectionList session_connections;
2080
2081         /* tracking step changes of track height */
2082
2083         TimeAxisView* current_stepping_trackview;
2084         ARDOUR::microseconds_t last_track_height_step_timestamp;
2085         gint track_height_step_timeout();
2086         sigc::connection step_timeout;
2087
2088         TimeAxisView* entered_track;
2089         /** If the mouse is over a RegionView or one of its child canvas items, this is set up
2090             to point to the RegionView.  Otherwise it is 0.
2091         */
2092         RegionView*   entered_regionview;
2093
2094         std::vector<EnterContext> _enter_stack;
2095
2096         bool clear_entered_track;
2097         bool left_track_canvas (GdkEventCrossing*);
2098         bool entered_track_canvas (GdkEventCrossing*);
2099         void set_entered_track (TimeAxisView*);
2100         void set_entered_regionview (RegionView*);
2101         gint left_automation_track ();
2102
2103         void reset_canvas_action_sensitivity (bool);
2104         void set_gain_envelope_visibility ();
2105         void set_region_gain_visibility (RegionView*);
2106         void toggle_gain_envelope_active ();
2107         void reset_region_gain_envelopes ();
2108
2109         void session_state_saved (std::string);
2110
2111         Glib::RefPtr<Gtk::Action>              undo_action;
2112         Glib::RefPtr<Gtk::Action>              redo_action;
2113         Glib::RefPtr<Gtk::Action>              alternate_redo_action;
2114         Glib::RefPtr<Gtk::Action>              alternate_alternate_redo_action;
2115         Glib::RefPtr<Gtk::Action>              selection_undo_action;
2116         Glib::RefPtr<Gtk::Action>              selection_redo_action;
2117
2118         void history_changed ();
2119
2120         Editing::EditPoint _edit_point;
2121
2122         ArdourDropdown edit_point_selector;
2123         void build_edit_point_menu();
2124
2125         void set_edit_point_preference (Editing::EditPoint ep, bool force = false);
2126         void cycle_edit_point (bool with_marker);
2127         void set_edit_point ();
2128         void edit_point_selection_done (Editing::EditPoint);
2129         void edit_point_chosen (Editing::EditPoint);
2130         Glib::RefPtr<Gtk::RadioAction> edit_point_action (Editing::EditPoint);
2131         std::vector<std::string> edit_point_strings;
2132         std::vector<std::string> edit_mode_strings;
2133
2134         void selected_marker_moved (ARDOUR::Location*);
2135
2136         bool get_edit_op_range (framepos_t& start, framepos_t& end) const;
2137
2138         void get_regions_at (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2139         void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2140
2141         RegionSelection get_regions_from_selection_and_edit_point ();
2142         RegionSelection get_regions_from_selection_and_entered () const;
2143
2144         void start_updating_meters ();
2145         void stop_updating_meters ();
2146         bool meters_running;
2147
2148         void select_next_route ();
2149         void select_prev_route ();
2150
2151         void snap_to_internal (framepos_t&       first,
2152                                ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
2153                                bool              for_mark  = false,
2154                                bool              ensure_snap = false);
2155
2156         void timecode_snap_to_internal (framepos_t&       first,
2157                                         ARDOUR::RoundMode direction = ARDOUR::RoundNearest,
2158                                         bool              for_mark  = false);
2159
2160         RhythmFerret* rhythm_ferret;
2161
2162         void fit_tracks (TrackViewList &);
2163         void fit_selection ();
2164         void set_track_height (Height);
2165
2166         void _remove_tracks ();
2167         bool idle_remove_tracks ();
2168         void toggle_tracks_active ();
2169
2170         bool _have_idled;
2171         int resize_idle_id;
2172         static gboolean _idle_resize (gpointer);
2173         bool idle_resize();
2174         int32_t _pending_resize_amount;
2175         TimeAxisView* _pending_resize_view;
2176
2177         void visible_order_range (int*, int*) const;
2178
2179         void located ();
2180
2181         /** true if we've made a locate request that hasn't yet been processed */
2182         bool _pending_locate_request;
2183
2184         /** if true, there is a pending Session locate which is the initial one when loading a session;
2185             we need to know this so that we don't (necessarily) set the viewport to show the playhead
2186             initially.
2187         */
2188         bool _pending_initial_locate;
2189
2190         Gtk::HBox _summary_hbox;
2191         EditorSummary* _summary;
2192
2193         void region_view_added (RegionView *);
2194         void region_view_removed ();
2195
2196         EditorGroupTabs* _group_tabs;
2197         void fit_route_group (ARDOUR::RouteGroup *);
2198
2199         void step_edit_status_change (bool);
2200         void start_step_editing ();
2201         void stop_step_editing ();
2202         bool check_step_edit ();
2203         sigc::connection step_edit_connection;
2204
2205         double _last_motion_y;
2206
2207         RegionLayeringOrderEditor* layering_order_editor;
2208         void update_region_layering_order_editor ();
2209
2210         /** Track that was the source for the last cut/copy operation.  Used as a place
2211             to paste things iff there is no selected track.
2212         */
2213         TimeAxisView* _last_cut_copy_source_track;
2214
2215         /** true if a change in Selection->regions should change the selection in the region list.
2216             See EditorRegions::selection_changed.
2217         */
2218         bool _region_selection_change_updates_region_list;
2219
2220         void setup_fade_images ();
2221         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_in_images;
2222         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_out_images;
2223         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_in_images;
2224         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_out_images;
2225
2226         Gtk::MenuItem& action_menu_item (std::string const &);
2227         void action_pre_activated (Glib::RefPtr<Gtk::Action> const &);
2228
2229         MouseCursors* _cursors;
2230
2231         void follow_mixer_selection ();
2232         bool _following_mixer_selection;
2233
2234         int time_fx (ARDOUR::RegionList&, float val, bool pitching);
2235         void note_edit_done (int, EditNoteDialog*);
2236         void toggle_sound_midi_notes ();
2237
2238         /** Flag for a bit of a hack wrt control point selection; see set_selected_control_point_from_click */
2239         bool _control_point_toggled_on_press;
2240
2241         /** This is used by TimeAxisView to keep a track of the TimeAxisView that is currently being
2242             stepped in height using ScrollZoomVerticalModifier+Scrollwheel.  When a scroll event
2243             occurs, we do the step on this _stepping_axis_view if it is non-0 (and we set up this
2244             _stepping_axis_view with the TimeAxisView underneath the mouse if it is 0).  Then Editor
2245             resets _stepping_axis_view when the modifier key is released.  In this (hacky) way,
2246             pushing the modifier key and moving the scroll wheel will operate on the same track
2247             until the key is released (rather than skipping about to whatever happens to be
2248             underneath the mouse at the time).
2249         */
2250         TimeAxisView* _stepping_axis_view;
2251         void zoom_vertical_modifier_released();
2252
2253         void bring_in_callback (Gtk::Label*, uint32_t n, uint32_t total, std::string name);
2254         void update_bring_in_message (Gtk::Label* label, uint32_t n, uint32_t total, std::string name);
2255         void bring_all_sources_into_session ();
2256
2257         QuantizeDialog* quantize_dialog;
2258         MainMenuDisabler* _main_menu_disabler;
2259
2260         /* private helper functions to help with registering axis */
2261
2262         Glib::RefPtr<Gtk::Action> reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2263         void toggle_reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2264         void radio_reg_sens (Glib::RefPtr<Gtk::ActionGroup> action_group, Gtk::RadioAction::Group& radio_group, char const * name, char const * label, sigc::slot<void> slot);
2265
2266         Gtkmm2ext::ActionMap myactions;
2267
2268         friend class Drag;
2269         friend class RegionCutDrag;
2270         friend class RegionDrag;
2271         friend class RegionMoveDrag;
2272         friend class RegionSpliceDrag;
2273         friend class RegionRippleDrag;
2274         friend class TrimDrag;
2275         friend class BBTRulerDrag;
2276         friend class MeterMarkerDrag;
2277         friend class TempoMarkerDrag;
2278         friend class CursorDrag;
2279         friend class FadeInDrag;
2280         friend class FadeOutDrag;
2281         friend class MarkerDrag;
2282         friend class RegionGainDrag;
2283         friend class ControlPointDrag;
2284         friend class LineDrag;
2285         friend class RubberbandSelectDrag;
2286         friend class RulerZoomDrag;
2287         friend class EditorRubberbandSelectDrag;
2288         friend class TimeFXDrag;
2289         friend class ScrubDrag;
2290         friend class SelectionDrag;
2291         friend class RangeMarkerBarDrag;
2292         friend class MouseZoomDrag;
2293         friend class RegionCreateDrag;
2294         friend class RegionMotionDrag;
2295         friend class RegionInsertDrag;
2296         friend class VideoTimeLineDrag;
2297
2298         friend class EditorSummary;
2299         friend class EditorGroupTabs;
2300
2301         friend class EditorRoutes;
2302         friend class RhythmFerret;
2303 };
2304
2305 #endif /* __ardour_editor_h__ */