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