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