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