Separate route list code from Editor into its own object, EditorRouteList. Hopefully...
[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 <string>
27 #include <sys/time.h>
28 #include <bitset>
29
30 #include <glibmm/ustring.h>
31
32 #include <boost/optional.hpp>
33
34 #include <libgnomecanvasmm/canvas.h>
35 #include <libgnomecanvasmm/group.h>
36 #include <libgnomecanvasmm/line.h>
37 #include <libgnomecanvasmm/pixbuf.h>
38
39 #include <cmath>
40
41 #include <gtkmm/layout.h>
42 #include <gtkmm/comboboxtext.h>
43
44 #include <gtkmm2ext/selector.h>
45 #include <gtkmm2ext/click_box.h>
46 #include <gtkmm2ext/dndtreeview.h>
47
48 #include "pbd/stateful.h"
49 #include "ardour/session.h"
50 #include "ardour/tempo.h"
51 #include "ardour/stretch.h"
52 #include "ardour/location.h"
53 #include "ardour/audioregion.h"
54 #include "ardour/track.h"
55 #include "ardour/types.h"
56 #include "ardour/route_group.h"
57
58 #include "audio_clock.h"
59 #include "gtk-custom-ruler.h"
60 #include "ardour_dialog.h"
61 #include "public_editor.h"
62 #include "editing.h"
63 #include "enums.h"
64 #include "editor_items.h"
65 #include "region_selection.h"
66 #include "canvas.h"
67 #include "editor_summary.h"
68
69 namespace Gtkmm2ext {
70         class TearOff;
71 }
72
73 namespace ARDOUR {
74         class AudioDiskstream;
75         class RouteGroup;
76         class Playlist;
77         class AudioPlaylist;
78         class Region;
79         class Location;
80         class TempoSection;
81         class NamedSelection;
82         class Session;
83         class Filter;
84         class Crossfade;
85         class ChanCount;
86 }
87
88 namespace LADSPA {
89         class Plugin;
90 }
91
92 class AnalysisWindow;
93 class AudioRegionView;
94 class AudioStreamView;
95 class AudioTimeAxisView;
96 class AutomationLine;
97 class AutomationSelection;
98 class AutomationTimeAxisView;
99 class BundleManager;
100 class ControlPoint;
101 class CrossfadeView;
102 class Drag;
103 class GlobalPortMatrixWindow;
104 class GroupedButtons;
105 class Marker;
106 class MixerStrip;
107 class PlaylistSelector;
108 class PluginSelector;
109 class RhythmFerret;
110 class Selection;
111 class SoundFileOmega;
112 class StreamView;
113 class TempoLines;
114 class TimeAxisView;
115 class TimeFXDialog;
116 class TimeSelection;
117 class TrackSelection;
118 class EditorGroupTabs;
119 class EditorRouteList;
120
121 /* <CMT Additions> */
122 class ImageFrameView;
123 class ImageFrameTimeAxisView;
124 class ImageFrameTimeAxis;
125 class MarkerTimeAxis ;
126 class MarkerView ;
127 class ImageFrameSocketHandler ;
128 class TimeAxisViewItem ;
129 /* </CMT Additions> */
130
131 struct EditorCursor {
132         Editor&               editor;
133         ArdourCanvas::Points  points;
134         ArdourCanvas::Line    canvas_item;
135         nframes64_t           current_frame;
136         double            length;
137         
138         EditorCursor (Editor&, bool (Editor::*)(GdkEvent*,ArdourCanvas::Item*));
139         ~EditorCursor ();
140         
141         void set_position (nframes64_t);
142         void set_length (double units);
143         void set_y_axis (double position);
144
145         sigc::signal<void, nframes64_t> PositionChanged;
146 };
147
148 class Editor : public PublicEditor
149 {
150   public:
151         Editor ();
152         ~Editor ();
153         
154         void             connect_to_session (ARDOUR::Session *);
155         ARDOUR::Session* current_session() const { return session; }
156         void             first_idle ();
157         virtual bool     have_idled () const { return _have_idled; }
158
159         nframes64_t leftmost_position() const { return leftmost_frame; }
160
161         nframes64_t current_page_frames() const {
162                 return (nframes64_t) floor (_canvas_width * frames_per_unit);
163         }
164         
165         double canvas_height () const {
166                 return _canvas_height;
167         }
168
169         void cycle_snap_mode ();
170         void cycle_snap_choice ();
171         void set_snap_to (Editing::SnapType);
172         void set_snap_mode (Editing::SnapMode);
173         void set_snap_threshold (double pixel_distance) {snap_threshold = pixel_distance;}
174
175         void undo (uint32_t n = 1);
176         void redo (uint32_t n = 1);
177
178         XMLNode& get_state ();
179         int set_state (const XMLNode& );
180
181         void set_mouse_mode (Editing::MouseMode, bool force=true);
182         void step_mouse_mode (bool next);
183         Editing::MouseMode current_mouse_mode () const { return mouse_mode; }
184         
185         void set_midi_edit_cursor (Editing::MidiEditMode);
186         void set_midi_edit_mode (Editing::MidiEditMode, bool force=true);
187         Editing::MidiEditMode current_midi_edit_mode () const { return midi_edit_mode; }
188
189 #ifdef WITH_CMT
190         void add_imageframe_time_axis(const std::string & track_name, void*) ;
191         void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*) ;
192         void connect_to_image_compositor() ;
193         void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item) ;
194 #endif
195
196         TimeAxisView* get_named_time_axis(const std::string & name) ;
197         void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>);
198         void add_to_idle_resize (TimeAxisView*, int32_t);
199
200         RouteTimeAxisView* get_route_view_by_id (PBD::ID& id);
201
202         void consider_auditioning (boost::shared_ptr<ARDOUR::Region>);
203         void hide_a_region (boost::shared_ptr<ARDOUR::Region>);
204         void remove_a_region (boost::shared_ptr<ARDOUR::Region>);
205
206 #ifdef USE_RUBBERBAND
207         std::vector<std::string> rb_opt_strings;
208 #endif
209
210         /* option editor-access */
211
212         void set_show_waveforms_recording (bool yn);
213         bool show_waveforms_recording() const { return _show_waveforms_recording; }
214         
215         /* things that need to be public to be used in the main menubar */
216
217         void new_region_from_selection ();
218         void separate_regions_between (const TimeSelection&);
219         void separate_region_from_selection ();
220         void separate_region_from_punch ();
221         void separate_region_from_loop ();
222         void separate_regions_using_location (ARDOUR::Location&);
223         void toggle_playback (bool with_abort);
224         void transition_to_rolling (bool forward);
225
226         /* undo related */
227
228         nframes64_t unit_to_frame (double unit) const {
229                 return (nframes64_t) rint (unit * frames_per_unit);
230         }
231         
232         double frame_to_unit (nframes64_t frame) const {
233                 return rint ((double) frame / (double) frames_per_unit);
234         }
235
236         double frame_to_unit (double frame) const {
237                 return rint (frame / frames_per_unit);
238         }
239
240         /* NOTE: these functions assume that the "pixel" coordinate is
241            the result of using the world->canvas affine transform on a
242            world coordinate. These coordinates already take into
243            account any scrolling carried out by adjusting the
244            xscroll_adjustment.  
245         */
246
247         nframes64_t pixel_to_frame (double pixel) const {
248                 
249                 /* pixel can be less than zero when motion events
250                    are processed. since we've already run the world->canvas
251                    affine, that means that the location *really* is "off
252                    to the right" and thus really is "before the start".
253                 */
254
255                 if (pixel >= 0) {
256                         return (nframes64_t) rint (pixel * frames_per_unit * GNOME_CANVAS(track_canvas->gobj())->pixels_per_unit);
257                 } else {
258                         return 0;
259                 }
260         }
261
262         gulong frame_to_pixel (nframes64_t frame) const {
263                 return (gulong) rint ((frame / (frames_per_unit * GNOME_CANVAS(track_canvas->gobj())->pixels_per_unit)));
264         }
265
266         void flush_canvas ();
267
268         /* selection */
269
270         Selection& get_selection() const { return *selection; }
271         Selection& get_cut_buffer() const { return *cut_buffer; }
272
273         bool extend_selection_to_track (TimeAxisView&);
274
275         void play_selection ();
276         void select_all_in_track (Selection::Operation op);
277         void select_all (Selection::Operation op);
278         void invert_selection_in_track ();
279         void invert_selection ();
280         void deselect_all ();
281
282         /* tempo */
283
284         void set_show_measures (bool yn);
285         bool show_measures () const { return _show_measures; }
286
287         /* analysis window */
288
289         void analyze_region_selection();
290         void analyze_range_selection();
291
292         /* export */
293         
294         void export_audio ();
295         void export_selection ();
296         void export_range ();
297         void export_region ();
298
299         void add_toplevel_controls (Gtk::Container&);
300         Gtk::HBox& get_status_bar_packer()  { return status_bar_hpacker; }
301
302         void               set_zoom_focus (Editing::ZoomFocus);
303         Editing::ZoomFocus get_zoom_focus () const { return zoom_focus; }
304         double             get_current_zoom () const { return frames_per_unit; }
305
306         void temporal_zoom_step (bool coarser);
307
308         /* stuff that AudioTimeAxisView and related classes use */
309
310         PlaylistSelector& playlist_selector() const;
311         void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>);
312
313         void new_playlists (TimeAxisView* v);
314         void copy_playlists (TimeAxisView* v);
315         void clear_playlists (TimeAxisView* v);
316
317         TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0);
318         void get_onscreen_tracks (TrackViewList&);
319
320         Width editor_mixer_strip_width;
321         void maybe_add_mixer_strip_width (XMLNode&);
322         void show_editor_mixer (bool yn);
323         void create_editor_mixer ();
324         void show_editor_list (bool yn);
325         void set_selected_mixer_strip (TimeAxisView&);
326         void hide_track_in_display (TimeAxisView& tv, bool temporary = false);
327
328         /* nudge is initiated by transport controls owned by ARDOUR_UI */
329
330         void nudge_forward (bool next, bool force_playhead);
331         void nudge_backward (bool next, bool force_playhead);
332
333         /* nudge initiated from context menu */
334
335         void nudge_forward_capture_offset ();
336         void nudge_backward_capture_offset ();
337
338         /* playhead/screen stuff */
339         
340         void set_follow_playhead (bool yn);
341         void toggle_follow_playhead ();
342         bool follow_playhead() const { return _follow_playhead; }
343         bool dragging_playhead () const { return _dragging_playhead; }
344
345         void toggle_zero_line_visibility ();
346         void toggle_waveforms_while_recording ();
347         void set_summary ();
348         void set_group_tabs ();
349         void toggle_measure_visibility ();
350         void toggle_logo_visibility ();
351
352         double get_physical_screen_width () const { return physical_screen_width; };
353         double physical_screen_width;
354         double physical_screen_height;
355
356         /* fades/xfades */
357
358         void toggle_selected_region_fades (int dir);
359         void update_region_fade_visibility ();
360         bool xfade_visibility() const { return _xfade_visibility; }
361         void update_xfade_visibility ();
362
363         /* redirect shared ops menu. caller must free returned menu */
364
365         Gtk::Menu* redirect_menu ();
366
367         /* floating windows/transient */
368
369         void ensure_float (Gtk::Window&);
370
371         void show_window ();
372
373         void scroll_tracks_down_line ();
374         void scroll_tracks_up_line ();
375
376         bool new_regionviews_display_gain () { return _new_regionviews_show_envelope; }
377         void prepare_for_cleanup ();
378         void finish_cleanup ();
379
380         void maximise_editing_space();
381         void restore_editing_space();
382
383         void reset_x_origin (nframes64_t);
384         void reset_y_origin (double);
385         void reset_zoom (double);
386         void reposition_and_zoom (nframes64_t, double);
387
388         nframes64_t get_preferred_edit_position (bool ignore_playhead = false);
389
390         bool update_mouse_speed ();
391         bool decelerate_mouse_speed ();
392
393         void toggle_meter_updating();
394
395         void show_rhythm_ferret();
396         void show_bundle_manager ();
397         void show_global_port_matrix (ARDOUR::DataType);
398
399         void goto_visual_state (uint32_t);
400         void save_visual_state (uint32_t);
401
402   protected:
403         void map_transport_state ();
404         void map_position_change (nframes64_t);
405
406         void on_realize();
407
408   private:
409
410         /// The session that we are editing, or 0
411         void color_handler ();
412         ARDOUR::Session     *session;
413         bool                 constructed;
414
415         // to keep track of the playhead position for control_scroll
416         boost::optional<nframes64_t> _control_scroll_target;
417  
418         PlaylistSelector* _playlist_selector;
419
420         typedef std::pair<TimeAxisView*,XMLNode*> TAVState;
421
422         struct VisualState {
423             double              y_position;
424             double              frames_per_unit;
425             nframes64_t         leftmost_frame;
426             Editing::ZoomFocus  zoom_focus;
427             bool                zoomed_to_region;
428             std::list<TAVState> track_states;
429         };
430         
431         std::list<VisualState*> undo_visual_stack;
432         std::list<VisualState*> redo_visual_stack;
433         VisualState* current_visual_state (bool with_tracks = true);
434         void undo_visual_state ();
435         void redo_visual_state ();
436         void use_visual_state (VisualState&);
437         bool no_save_visual;
438         void swap_visual_state ();
439         
440         std::vector<VisualState*> visual_states;
441         sigc::connection visual_state_op_connection;
442         void start_visual_state_op (uint32_t n);
443         void cancel_visual_state_op (uint32_t n);
444         bool end_visual_state_op (uint32_t n);
445
446         nframes64_t leftmost_frame;
447         double      frames_per_unit;
448         Editing::ZoomFocus zoom_focus;
449
450         void set_frames_per_unit (double);
451         void post_zoom ();
452
453         Editing::MouseMode mouse_mode;
454         Editing::MidiEditMode midi_edit_mode;
455
456         int  post_maximal_editor_width;
457         int  post_maximal_pane_position;
458         int  pre_maximal_pane_position;
459         int  pre_maximal_editor_width;
460         void pane_allocation_handler (Gtk::Allocation&, Gtk::Paned*);
461
462         Gtk::Notebook the_notebook;
463         Gtk::HPaned   edit_pane;
464
465         Gtk::EventBox meter_base;
466         Gtk::HBox     meter_box;
467         Gtk::EventBox marker_base;
468         Gtk::HBox     marker_box;
469         Gtk::VBox     scrollers_rulers_markers_box;
470
471         void location_changed (ARDOUR::Location *);
472         void location_flags_changed (ARDOUR::Location *, void *);
473         void refresh_location_display ();
474         void refresh_location_display_s (ARDOUR::Change);
475         void refresh_location_display_internal (ARDOUR::Locations::LocationList&);
476         void add_new_location (ARDOUR::Location *);
477         void location_gone (ARDOUR::Location *);
478         void remove_marker (ArdourCanvas::Item&, GdkEvent*);
479         gint really_remove_marker (ARDOUR::Location* loc);
480         void goto_nth_marker (int nth);
481
482         uint32_t location_marker_color;
483         uint32_t location_range_color;
484         uint32_t location_loop_color;
485         uint32_t location_punch_color;
486         uint32_t location_cd_marker_color;
487
488         struct LocationMarkers {
489             Marker* start;
490             Marker* end;
491             bool    valid;
492
493             LocationMarkers () : start(0), end(0), valid (true) {}
494             
495             ~LocationMarkers ();
496
497             void hide();
498             void show ();
499             void set_name (const std::string&);
500             void set_position (nframes64_t start, nframes64_t end = 0);
501             void set_color_rgba (uint32_t);
502         };
503
504         LocationMarkers  *find_location_markers (ARDOUR::Location *) const;
505         ARDOUR::Location* find_location_from_marker (Marker *, bool& is_start) const;
506         Marker* entered_marker;
507
508         typedef std::map<ARDOUR::Location*,LocationMarkers *> LocationMarkerMap;
509         LocationMarkerMap location_markers;
510
511         void hide_marker (ArdourCanvas::Item*, GdkEvent*);
512         void clear_marker_display ();
513         void mouse_add_new_marker (nframes64_t where, bool is_cd=false, bool is_xrun=false);
514         bool choose_new_marker_name(std::string &name);
515         void update_cd_marker_display ();
516         void ensure_cd_marker_updated (LocationMarkers * lam, ARDOUR::Location * location);
517
518         TimeAxisView*      clicked_axisview;
519         RouteTimeAxisView* clicked_routeview;
520         /** The last RegionView that was clicked on, or 0 if the last click was not
521          * on a RegionView.  This is set up by the canvas event handlers in
522          * editor_canvas_events.cc
523          */
524         RegionView*        clicked_regionview;
525         RegionSelection    latest_regionviews;
526         uint32_t           clicked_selection;
527         CrossfadeView*     clicked_crossfadeview;
528         ControlPoint*      clicked_control_point;
529
530         void sort_track_selection (TrackSelection* sel = 0);
531
532         void get_relevant_tracks (std::set<RouteTimeAxisView*>& relevant_tracks) const;
533         void get_equivalent_tracks (RouteTimeAxisView*, std::set<RouteTimeAxisView*> &, ARDOUR::RouteGroup::Property) const;
534         void get_equivalent_regions (RegionView* rv, std::vector<RegionView*> &, ARDOUR::RouteGroup::Property) const;
535         RegionSelection get_equivalent_regions (RegionSelection &, ARDOUR::RouteGroup::Property) const;
536         void mapover_tracks (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, ARDOUR::RouteGroup::Property) const;
537
538         /* functions to be passed to mapover_tracks(), possibly with sigc::bind()-supplied arguments */
539
540         void mapped_get_equivalent_regions (RouteTimeAxisView&, uint32_t, RegionView *, std::vector<RegionView*>*) const;
541         void mapped_use_new_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
542         void mapped_use_copy_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
543         void mapped_clear_playlist (RouteTimeAxisView&, uint32_t);
544
545         /* end */
546
547         void button_selection (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type);
548         bool button_release_can_deselect;
549
550         void catch_vanishing_regionview (RegionView *);
551
552         void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove=false);
553         void select_all_tracks ();
554         
555         int get_regionview_count_from_region_list (boost::shared_ptr<ARDOUR::Region> region);
556         
557         bool set_selected_control_point_from_click (Selection::Operation op = Selection::Set, bool no_remove=false);
558         void set_selected_track_from_click (bool press, Selection::Operation op = Selection::Set, bool no_remove=false);
559         void set_selected_track_as_side_effect (bool force = false);
560         bool set_selected_regionview_from_click (bool press, Selection::Operation op = Selection::Set, bool no_track_remove=false);
561
562         void set_selected_regionview_from_region_list (boost::shared_ptr<ARDOUR::Region> region, Selection::Operation op = Selection::Set);
563         bool set_selected_regionview_from_map_event (GdkEventAny*, StreamView*, boost::weak_ptr<ARDOUR::Region>);
564         void collect_new_region_view (RegionView *);
565         void collect_and_select_new_region_view (RegionView *);
566         
567         Gtk::Menu track_context_menu;
568         Gtk::Menu track_region_context_menu;
569         Gtk::Menu track_selection_context_menu;
570         Gtk::Menu track_crossfade_context_menu;
571
572         Gtk::MenuItem* region_edit_menu_split_item;
573         Gtk::MenuItem* region_edit_menu_split_multichannel_item;
574         Gtk::Menu * track_region_edit_playlist_menu;
575         Gtk::Menu * track_edit_playlist_submenu;
576         Gtk::Menu * track_selection_edit_playlist_submenu;
577
578         void popup_track_context_menu (int, int, ItemType, bool, nframes64_t);
579         Gtk::Menu* build_track_context_menu (nframes64_t);
580         Gtk::Menu* build_track_bus_context_menu (nframes64_t);
581         Gtk::Menu* build_track_region_context_menu (nframes64_t frame);
582         Gtk::Menu* build_track_crossfade_context_menu (nframes64_t);
583         Gtk::Menu* build_track_selection_context_menu (nframes64_t);
584         void add_dstream_context_items (Gtk::Menu_Helpers::MenuList&);
585         void add_bus_context_items (Gtk::Menu_Helpers::MenuList&);
586         void add_region_context_items (StreamView*, boost::shared_ptr<ARDOUR::Region>, Gtk::Menu_Helpers::MenuList&);
587         void add_crossfade_context_items (AudioStreamView*, boost::shared_ptr<ARDOUR::Crossfade>, Gtk::Menu_Helpers::MenuList&, bool many);
588         void add_selection_context_items (Gtk::Menu_Helpers::MenuList&);
589
590         void add_item_with_sensitivity (Gtk::Menu_Helpers::MenuList&, Gtk::Menu_Helpers::MenuElem, bool) const;
591
592         void handle_new_route (ARDOUR::RouteList&);
593         void remove_route (TimeAxisView *);
594         bool route_removal;
595
596         Gtk::HBox           global_hpacker;
597         Gtk::VBox           global_vpacker;
598         Gtk::VBox           vpacker;
599
600         Gdk::Cursor*          current_canvas_cursor;
601         void set_canvas_cursor ();
602         Gdk::Cursor* which_grabber_cursor ();
603
604         ArdourCanvas::Canvas* track_canvas;
605
606         ArdourCanvas::Text* verbose_canvas_cursor;
607         bool                 verbose_cursor_visible;
608
609         void parameter_changed (std::string);
610         
611         bool track_canvas_motion (GdkEvent*);
612
613         void set_verbose_canvas_cursor (const std::string &, double x, double y);
614         void set_verbose_canvas_cursor_text (const std::string &);
615         void show_verbose_canvas_cursor();
616         void hide_verbose_canvas_cursor();
617
618         bool verbose_cursor_on; // so far unused
619
620         Gtk::EventBox             time_canvas_event_box;
621         Gtk::EventBox             track_canvas_event_box;
622         Gtk::EventBox             time_button_event_box;
623         Gtk::EventBox             ruler_label_event_box;
624
625         ArdourCanvas::Group      *minsec_group;
626         ArdourCanvas::Pixbuf     *logo_item;
627         ArdourCanvas::Group      *bbt_group;
628         ArdourCanvas::Group      *smpte_group;
629         ArdourCanvas::Group      *frame_group;
630         ArdourCanvas::Group      *tempo_group;
631         ArdourCanvas::Group      *meter_group;
632         ArdourCanvas::Group      *marker_group;
633         ArdourCanvas::Group      *range_marker_group;
634         ArdourCanvas::Group      *transport_marker_group;
635         ArdourCanvas::Group*      cd_marker_group;
636
637         ArdourCanvas::Group*      timebar_group;
638
639         /* These bars never need to be scrolled */
640         ArdourCanvas::Group*      meter_bar_group;
641         ArdourCanvas::Group*      tempo_bar_group;
642         ArdourCanvas::Group*      marker_bar_group;
643         ArdourCanvas::Group*      range_marker_bar_group;
644         ArdourCanvas::Group*      transport_marker_bar_group;
645         ArdourCanvas::Group*      cd_marker_bar_group;
646
647         /** The group containing all items that require horizontal scrolling. */
648         ArdourCanvas::Group* _background_group;
649         /* 
650            The _master_group is the group containing all items
651            that require horizontal scrolling..
652            It is primarily used to separate canvas items 
653            that require horizontal scrolling from those that do not. 
654         */
655         ArdourCanvas::Group* _master_group;
656
657         /* The group containing all trackviews.  Only scrolled vertically. */
658         ArdourCanvas::Group* _trackview_group;
659         
660         /* The group used for region motion.  Sits on top of _trackview_group */
661         ArdourCanvas::Group* _region_motion_group;
662         
663         enum RulerType {
664                 ruler_metric_smpte = 0,
665                 ruler_metric_bbt = 1,
666                 ruler_metric_frames = 2,
667                 ruler_metric_minsec = 3,
668
669                 ruler_time_tempo = 4,
670                 ruler_time_meter = 5,
671                 ruler_time_marker = 6,
672                 ruler_time_range_marker = 7,
673                 ruler_time_transport_marker = 8,
674                 ruler_time_cd_marker = 9,
675         };
676
677         static GtkCustomMetric ruler_metrics[4];
678         Glib::RefPtr<Gtk::ToggleAction> ruler_timecode_action;
679         Glib::RefPtr<Gtk::ToggleAction> ruler_bbt_action;
680         Glib::RefPtr<Gtk::ToggleAction> ruler_samples_action;
681         Glib::RefPtr<Gtk::ToggleAction> ruler_minsec_action;
682         Glib::RefPtr<Gtk::ToggleAction> ruler_tempo_action;
683         Glib::RefPtr<Gtk::ToggleAction> ruler_meter_action;
684         Glib::RefPtr<Gtk::ToggleAction> ruler_marker_action;
685         Glib::RefPtr<Gtk::ToggleAction> ruler_range_action;
686         Glib::RefPtr<Gtk::ToggleAction> ruler_loop_punch_action;
687         Glib::RefPtr<Gtk::ToggleAction> ruler_cd_marker_action;
688         bool                            no_ruler_shown_update;
689         
690         gint ruler_button_press (GdkEventButton*);
691         gint ruler_button_release (GdkEventButton*);
692         gint ruler_mouse_motion (GdkEventMotion*);
693         bool ruler_scroll (GdkEventScroll* event);
694
695         Gtk::Widget * ruler_grabbed_widget;
696         
697         void initialize_rulers ();
698         void update_just_smpte ();
699         void compute_fixed_ruler_scale (); //calculates the RulerScale of the fixed rulers
700         void update_fixed_rulers ();
701         void update_tempo_based_rulers (); 
702         void popup_ruler_menu (nframes64_t where = 0, ItemType type = RegionItem);
703         void update_ruler_visibility ();
704         void set_ruler_visible (RulerType, bool);
705         void toggle_ruler_visibility (RulerType rt);
706         void ruler_toggled (int);
707         gint ruler_label_button_release (GdkEventButton*);
708         void store_ruler_visibility ();
709         void restore_ruler_visibility ();
710         
711         static gint _metric_get_smpte (GtkCustomRulerMark **, gdouble, gdouble, gint);
712         static gint _metric_get_bbt (GtkCustomRulerMark **, gdouble, gdouble, gint);
713         static gint _metric_get_frames (GtkCustomRulerMark **, gdouble, gdouble, gint);
714         static gint _metric_get_minsec (GtkCustomRulerMark **, gdouble, gdouble, gint);
715         
716         enum MinsecRulerScale {
717                 minsec_show_seconds,
718                 minsec_show_minutes,
719                 minsec_show_hours,
720                 minsec_show_frames
721         };
722
723         MinsecRulerScale minsec_ruler_scale;
724
725         nframes_t minsec_mark_interval;
726         gint minsec_mark_modulo;
727         gint minsec_nmarks;
728         void set_minsec_ruler_scale (gdouble lower, gdouble upper);
729
730         enum SMPTERulerScale {
731                 smpte_show_bits,
732                 smpte_show_frames,
733                 smpte_show_seconds,
734                 smpte_show_minutes,
735                 smpte_show_hours
736         };
737
738         SMPTERulerScale smpte_ruler_scale;
739
740         nframes_t smpte_mark_interval;
741         gint smpte_mark_modulo;
742         gint smpte_nmarks;
743         void set_smpte_ruler_scale (gdouble lower, gdouble upper);
744
745         enum BBTRulerScale {
746                 bbt_over,
747                 bbt_show_64,
748                 bbt_show_16,
749                 bbt_show_4,
750                 bbt_show_1,
751                 bbt_show_beats,
752                 bbt_show_ticks,
753                 bbt_show_ticks_detail,
754                 bbt_show_ticks_super_detail
755         };
756
757         BBTRulerScale bbt_ruler_scale;
758
759         uint32_t bbt_bars;
760         gint bbt_nmarks;
761         uint32_t bbt_bar_helper_on;
762         uint32_t bbt_accent_modulo;
763         void compute_bbt_ruler_scale (nframes64_t lower, nframes64_t upper);
764
765         gint metric_get_smpte (GtkCustomRulerMark **, gdouble, gdouble, gint);
766         gint metric_get_bbt (GtkCustomRulerMark **, gdouble, gdouble, gint);
767         gint metric_get_frames (GtkCustomRulerMark **, gdouble, gdouble, gint);
768         gint metric_get_minsec (GtkCustomRulerMark **, gdouble, gdouble, gint);
769
770         Gtk::Widget        *_ruler_separator;
771         GtkWidget          *_smpte_ruler;
772         GtkWidget          *_bbt_ruler;
773         GtkWidget          *_frames_ruler;
774         GtkWidget          *_minsec_ruler;
775         Gtk::Widget        *smpte_ruler;
776         Gtk::Widget        *bbt_ruler;
777         Gtk::Widget        *frames_ruler;
778         Gtk::Widget        *minsec_ruler;
779         static Editor      *ruler_editor;
780
781         static const double timebar_height;
782         guint32 visible_timebars;
783         gdouble canvas_timebars_vsize;
784         gdouble get_canvas_timebars_vsize () const { return canvas_timebars_vsize; }
785         Gtk::Menu          *editor_ruler_menu;
786         
787         ArdourCanvas::SimpleRect* tempo_bar;
788         ArdourCanvas::SimpleRect* meter_bar;
789         ArdourCanvas::SimpleRect* marker_bar;
790         ArdourCanvas::SimpleRect* range_marker_bar;
791         ArdourCanvas::SimpleRect* transport_marker_bar;
792         ArdourCanvas::SimpleRect* cd_marker_bar;
793         
794         Gtk::Label  minsec_label;
795         Gtk::Label  bbt_label;
796         Gtk::Label  smpte_label;
797         Gtk::Label  frame_label;
798         Gtk::Label  tempo_label;
799         Gtk::Label  meter_label;
800         Gtk::Label  mark_label;
801         Gtk::Label  range_mark_label;
802         Gtk::Label  transport_mark_label;
803         Gtk::Label  cd_mark_label;
804
805         Gtk::VBox          time_button_vbox;
806         Gtk::HBox          time_button_hbox;
807
808         friend class EditorCursor;
809         
810         EditorCursor*        playhead_cursor;
811         ArdourCanvas::Group* cursor_group;
812
813         nframes64_t get_region_boundary (nframes64_t pos, int32_t dir, bool with_selection, bool only_onscreen);
814
815         void    cursor_to_region_boundary (bool with_selection, int32_t dir);
816         void    cursor_to_next_region_boundary (bool with_selection);
817         void    cursor_to_previous_region_boundary (bool with_selection);
818         void    cursor_to_next_region_point (EditorCursor*, ARDOUR::RegionPoint);
819         void    cursor_to_previous_region_point (EditorCursor*, ARDOUR::RegionPoint);
820         void    cursor_to_region_point (EditorCursor*, ARDOUR::RegionPoint, int32_t dir);
821         void    cursor_to_selection_start (EditorCursor *);
822         void    cursor_to_selection_end   (EditorCursor *);
823
824         void    selected_marker_to_region_boundary (bool with_selection, int32_t dir);
825         void    selected_marker_to_next_region_boundary (bool with_selection);
826         void    selected_marker_to_previous_region_boundary (bool with_selection);
827         void    selected_marker_to_next_region_point (ARDOUR::RegionPoint);
828         void    selected_marker_to_previous_region_point (ARDOUR::RegionPoint);
829         void    selected_marker_to_region_point (ARDOUR::RegionPoint, int32_t dir);
830         void    selected_marker_to_selection_start ();
831         void    selected_marker_to_selection_end   ();
832
833         void    select_all_selectables_using_cursor (EditorCursor *, bool);
834         void    select_all_selectables_using_edit (bool);
835         void    select_all_selectables_between (bool within);
836         void    select_range_between ();
837
838         boost::shared_ptr<ARDOUR::Region> find_next_region (nframes64_t, ARDOUR::RegionPoint, int32_t dir, TrackViewList&, TimeAxisView ** = 0);
839         nframes64_t find_next_region_boundary (nframes64_t, int32_t dir, const TrackViewList&);
840
841         std::vector<nframes64_t> region_boundary_cache;
842         void build_region_boundary_cache ();
843
844         Gtk::HBox           top_hbox;
845         Gtk::HBox           bottom_hbox;
846         
847         Gtk::Table          edit_packer;
848         Gtk::VScrollbar     edit_vscrollbar;
849
850         Gtk::Adjustment     vertical_adjustment;
851         Gtk::Adjustment     horizontal_adjustment;
852
853         Gtk::Layout         controls_layout;
854         bool control_layout_scroll (GdkEventScroll* ev);
855         void controls_layout_size_request (Gtk::Requisition*);
856         sigc::connection controls_layout_size_request_connection;
857
858         Gtk::HScrollbar     edit_hscrollbar;
859         bool                _dragging_hscrollbar;
860
861         void reset_hscrollbar_stepping ();
862         
863         bool hscrollbar_button_press (GdkEventButton*);
864         bool hscrollbar_button_release (GdkEventButton*);
865         void hscrollbar_allocate (Gtk::Allocation &alloc);
866
867         double _canvas_width;
868         double _canvas_height;
869         double full_canvas_height;
870
871         bool track_canvas_map_handler (GdkEventAny*);
872
873         gint edit_controls_button_release (GdkEventButton*);
874         Gtk::Menu *edit_controls_left_menu;
875         Gtk::Menu *edit_controls_right_menu;
876
877         Gtk::VBox           ruler_label_vbox;
878         Gtk::VBox           track_canvas_vbox;
879         Gtk::VBox           time_canvas_vbox;
880         Gtk::VBox           edit_controls_vbox;
881         Gtk::HBox           edit_controls_hbox;
882
883         void control_scroll (float);
884         void access_action (std::string,std::string);
885         bool deferred_control_scroll (nframes64_t);
886         sigc::connection control_scroll_connection;
887
888         gdouble get_trackview_group_vertical_offset () const { return vertical_adjustment.get_value () - canvas_timebars_vsize;}
889         
890         ArdourCanvas::Group* get_background_group () const { return _background_group; }
891         ArdourCanvas::Group* get_trackview_group () const { return _trackview_group; }
892         double last_trackview_group_vertical_offset;
893         void tie_vertical_scrolling ();
894         void scroll_canvas_horizontally ();
895         void scroll_canvas_vertically ();
896
897         struct VisualChange {
898                 enum Type { 
899                         TimeOrigin = 0x1,
900                         ZoomLevel = 0x2,
901                         YOrigin = 0x4
902                 };
903                 
904                 Type pending;
905                 nframes64_t time_origin;
906                 double frames_per_unit;
907                 double y_origin;
908                 
909                 int idle_handler_id;
910                 
911                 VisualChange() : pending ((VisualChange::Type) 0), time_origin (0), frames_per_unit (0), idle_handler_id (-1) {}
912                 void add (Type t) {
913                         pending = Type (pending | t);
914                 }
915         };
916
917
918         VisualChange pending_visual_change;
919
920         static int _idle_visual_changer (void *arg);
921         int idle_visual_changer ();
922
923         void queue_visual_change (nframes64_t);
924         void queue_visual_change (double);
925         void queue_visual_change_y (double);
926         void ensure_visual_change_idle_handler ();
927
928         void end_location_changed (ARDOUR::Location*);
929
930         struct RegionListDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
931             RegionListDisplayModelColumns() {
932                         add (name);
933                     add (region);
934                     add (color_);
935                     add (start);
936                     add (end);
937                     add (length);
938                         add (sync);
939                         add (fadein);
940                         add (fadeout);
941                         add (locked);
942                         add (glued);
943                         add (muted);
944                         add (opaque);
945                         add (used);
946                     add (path);
947             }
948             Gtk::TreeModelColumn<Glib::ustring> name;
949             Gtk::TreeModelColumn<boost::shared_ptr<ARDOUR::Region> > region;
950             Gtk::TreeModelColumn<Gdk::Color> color_;
951             Gtk::TreeModelColumn<Glib::ustring> start;
952             Gtk::TreeModelColumn<Glib::ustring> end;
953             Gtk::TreeModelColumn<Glib::ustring> length;
954             Gtk::TreeModelColumn<Glib::ustring> sync;
955             Gtk::TreeModelColumn<Glib::ustring> fadein;
956             Gtk::TreeModelColumn<Glib::ustring> fadeout;
957             Gtk::TreeModelColumn<bool> locked;
958             Gtk::TreeModelColumn<bool> glued;
959             Gtk::TreeModelColumn<bool> muted;
960             Gtk::TreeModelColumn<bool> opaque;
961             Gtk::TreeModelColumn<Glib::ustring> used;
962             Gtk::TreeModelColumn<Glib::ustring> path;
963         };
964             
965         RegionListDisplayModelColumns          region_list_columns;
966         Gtkmm2ext::DnDTreeView<boost::shared_ptr<ARDOUR::Region> > region_list_display;
967         
968         Glib::RefPtr<Gtk::TreeStore>           region_list_model;
969         Glib::RefPtr<Gtk::ToggleAction>        toggle_full_region_list_action;
970         Glib::RefPtr<Gtk::ToggleAction>        toggle_show_auto_regions_action;
971
972         void region_list_region_changed (ARDOUR::Change, boost::weak_ptr<ARDOUR::Region>);
973         void region_list_selection_changed ();
974         sigc::connection region_list_change_connection;
975         void set_selected_in_region_list(RegionSelection&);
976         bool set_selected_in_region_list_subrow(boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::Row const &, int);
977         bool region_list_selection_filter (const Glib::RefPtr<Gtk::TreeModel>& model, const Gtk::TreeModel::Path& path, bool yn);
978         void region_name_edit (const Glib::ustring&, const Glib::ustring&);
979         void get_regions_corresponding_to (boost::shared_ptr<ARDOUR::Region> region, std::vector<RegionView*>& regions);
980
981         Gtk::Menu          *region_list_menu;
982         Gtk::ScrolledWindow region_list_scroller;
983         Gtk::Frame          region_list_frame;
984
985         bool region_list_display_key_press (GdkEventKey *);
986         bool region_list_display_key_release (GdkEventKey *);
987         bool region_list_display_button_press (GdkEventButton *);
988         bool region_list_display_button_release (GdkEventButton *);
989         void region_list_clear ();
990         void region_list_selection_mapover (sigc::slot<void,boost::shared_ptr<ARDOUR::Region> >);
991         void build_region_list_menu ();
992         void show_region_list_display_context_menu (int button, int time);
993
994         bool show_automatic_regions_in_region_list;
995         Editing::RegionListSortType region_list_sort_type;
996
997         void reset_region_list_sort_direction (bool);
998         void reset_region_list_sort_type (Editing::RegionListSortType);
999
1000         void toggle_full_region_list ();
1001         void toggle_show_auto_regions ();
1002
1003         int region_list_sorter (Gtk::TreeModel::iterator, Gtk::TreeModel::iterator);
1004
1005         /* snapshots */
1006
1007         Gtk::ScrolledWindow snapshot_display_scroller;
1008         struct SnapshotDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
1009             SnapshotDisplayModelColumns() { 
1010                     add (visible_name);
1011                     add (real_name);
1012             }
1013             Gtk::TreeModelColumn<Glib::ustring> visible_name;
1014             Gtk::TreeModelColumn<Glib::ustring> real_name;
1015         };
1016
1017         SnapshotDisplayModelColumns snapshot_display_columns;
1018         Glib::RefPtr<Gtk::ListStore> snapshot_display_model;
1019         Gtk::TreeView snapshot_display;
1020         Gtk::Menu snapshot_context_menu;
1021
1022         bool snapshot_display_button_press (GdkEventButton*);
1023         void snapshot_display_selection_changed ();
1024         void redisplay_snapshots();
1025         void popup_snapshot_context_menu (int, int32_t, Glib::ustring);
1026
1027         /* named selections */
1028
1029         struct NamedSelectionDisplayModelColumns : public Gtk::TreeModel::ColumnRecord {
1030             NamedSelectionDisplayModelColumns() { 
1031                     add (text);
1032                     add (selection);
1033             }
1034             Gtk::TreeModelColumn<Glib::ustring>  text;
1035             Gtk::TreeModelColumn<ARDOUR::NamedSelection*>    selection;
1036         };
1037
1038         NamedSelectionDisplayModelColumns named_selection_columns;
1039         Glib::RefPtr<Gtk::TreeStore>     named_selection_model;
1040
1041         Gtkmm2ext::DnDTreeView<ARDOUR::NamedSelection*> named_selection_display;
1042         Gtk::ScrolledWindow    named_selection_scroller;
1043
1044         void create_named_selection ();
1045         void paste_named_selection (float times);
1046         void remove_selected_named_selections ();
1047         void remove_snapshot (Glib::ustring);
1048         void rename_snapshot (Glib::ustring);
1049
1050         void handle_new_named_selection ();
1051         void add_named_selection_to_named_selection_display (ARDOUR::NamedSelection&);
1052         void redisplay_named_selections ();
1053
1054         bool named_selection_display_button_release (GdkEventButton *ev);
1055         bool named_selection_display_key_release (GdkEventKey *ev);
1056         void named_selection_display_selection_changed ();
1057
1058         /* track views */
1059         TrackViewList track_views;
1060         std::pair<TimeAxisView*, ARDOUR::layer_t> trackview_by_y_position (double);
1061         TrackSelection axis_views_from_routes (std::list<ARDOUR::Route *>) const;
1062
1063         static Gdk::Cursor* cross_hair_cursor;
1064         static Gdk::Cursor* trimmer_cursor;
1065         static Gdk::Cursor* selector_cursor;
1066         static Gdk::Cursor* grabber_cursor;
1067         static Gdk::Cursor* grabber_edit_point_cursor;
1068         static Gdk::Cursor* zoom_cursor;
1069         static Gdk::Cursor* time_fx_cursor;
1070         static Gdk::Cursor* fader_cursor;
1071         static Gdk::Cursor* speaker_cursor;
1072         static Gdk::Cursor* midi_pencil_cursor;
1073         static Gdk::Cursor* midi_select_cursor;
1074         static Gdk::Cursor* midi_resize_cursor;
1075         static Gdk::Cursor* midi_erase_cursor;
1076         static Gdk::Cursor* wait_cursor;
1077         static Gdk::Cursor* timebar_cursor;
1078         static Gdk::Cursor* transparent_cursor;
1079
1080         static void build_cursors ();
1081
1082         sigc::connection scroll_connection;
1083         nframes64_t last_update_frame;
1084         void center_screen (nframes64_t);
1085         void center_screen_internal (nframes64_t, float);
1086         
1087         void update_current_screen ();
1088         
1089         void session_going_away ();
1090
1091         nframes64_t cut_buffer_start;
1092         nframes64_t cut_buffer_length;
1093
1094         bool typed_event (ArdourCanvas::Item*, GdkEvent*, ItemType);
1095         bool button_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1096         bool button_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1097         bool motion_handler (ArdourCanvas::Item*, GdkEvent*, bool from_autoscroll = false);
1098         bool enter_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1099         bool leave_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1100         
1101         /* KEYMAP HANDLING */
1102
1103         void register_actions ();
1104
1105         int ensure_cursor (nframes64_t* pos);
1106
1107         void handle_new_region (boost::weak_ptr<ARDOUR::Region>);
1108         void handle_new_regions (std::vector<boost::weak_ptr<ARDOUR::Region> >& );
1109         void handle_region_removed (boost::weak_ptr<ARDOUR::Region>);
1110         void add_region_to_region_display (boost::shared_ptr<ARDOUR::Region>);
1111         void add_regions_to_region_display (std::vector<boost::weak_ptr<ARDOUR::Region> > & );
1112         void region_hidden (boost::shared_ptr<ARDOUR::Region>);
1113         void redisplay_regions ();
1114         void populate_row (boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::Row const &);
1115         void update_region_row (boost::shared_ptr<ARDOUR::Region>);
1116         bool update_region_subrows (boost::shared_ptr<ARDOUR::Region>, Gtk::TreeModel::Row const &, int);
1117         void update_all_region_rows ();
1118         void update_all_region_subrows (Gtk::TreeModel::Row const &, int);
1119         bool no_region_list_redisplay;
1120         void insert_into_tmp_regionlist(boost::shared_ptr<ARDOUR::Region>);
1121
1122         std::list<boost::shared_ptr<ARDOUR::Region> > tmp_region_list;
1123
1124         void cut_copy (Editing::CutCopyOp);
1125         bool can_cut_copy () const;
1126         void cut_copy_points (Editing::CutCopyOp);
1127         void cut_copy_regions (Editing::CutCopyOp, RegionSelection&);
1128         void cut_copy_ranges (Editing::CutCopyOp);
1129
1130         void mouse_paste ();
1131         void paste_internal (nframes64_t position, float times);
1132
1133         /* EDITING OPERATIONS */
1134         
1135         void reset_point_selection ();
1136         void toggle_region_mute ();
1137         void toggle_region_lock ();
1138         void toggle_region_opaque ();
1139         void toggle_record_enable ();
1140         void set_region_lock_style (ARDOUR::Region::PositionLockStyle);
1141         void raise_region ();
1142         void raise_region_to_top ();
1143         void lower_region ();
1144         void lower_region_to_bottom ();
1145         void split_region ();
1146         void split_regions_at (nframes64_t, RegionSelection&);
1147         void split_region_at_transients ();
1148         void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret);
1149         void crop_region_to_selection ();
1150         void crop_region_to (nframes64_t start, nframes64_t end);
1151         void set_sync_point (nframes64_t, const RegionSelection&);
1152         void set_region_sync_from_edit_point ();
1153         void remove_region_sync();
1154         void align_selection (ARDOUR::RegionPoint, nframes64_t position, const RegionSelection&);
1155         void align_selection_relative (ARDOUR::RegionPoint point, nframes64_t position, const RegionSelection&);
1156         void align_region (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, nframes64_t position);
1157         void align_region_internal (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, nframes64_t position);
1158         void remove_selected_regions ();
1159         void remove_clicked_region ();
1160         void edit_region ();
1161         void rename_region ();
1162         void duplicate_some_regions (RegionSelection&, float times);
1163         void duplicate_selection (float times);
1164         void region_fill_selection ();
1165
1166         void region_fill_track ();
1167         void audition_playlist_region_standalone (boost::shared_ptr<ARDOUR::Region>);
1168         void audition_playlist_region_via_route (boost::shared_ptr<ARDOUR::Region>, ARDOUR::Route&);
1169         void split_multichannel_region();
1170         void reverse_region ();
1171         void strip_region_silence ();
1172         void normalize_region ();
1173         double _last_normalization_value;
1174         void denormalize_region ();
1175         void adjust_region_scale_amplitude (bool up);
1176         void quantize_region ();
1177
1178         void do_insert_time ();
1179         void insert_time (nframes64_t, nframes64_t, Editing::InsertTimeOption, bool, bool, bool);
1180
1181         void tab_to_transient (bool forward);
1182
1183         void use_region_as_bar ();
1184         void use_range_as_bar ();
1185
1186         void define_one_bar (nframes64_t start, nframes64_t end);
1187
1188         void audition_region_from_region_list ();
1189         void hide_region_from_region_list ();
1190         void remove_region_from_region_list ();
1191
1192         void align (ARDOUR::RegionPoint);
1193         void align_relative (ARDOUR::RegionPoint);
1194         void naturalize ();
1195
1196         void reset_focus ();
1197
1198         void split ();
1199
1200         void cut ();
1201         void copy ();
1202         void paste (float times);
1203
1204         int  get_prefix (float&, bool&);
1205
1206         void keyboard_paste ();
1207         void keyboard_insert_region_list_selection ();
1208
1209         void region_from_selection ();
1210         void create_region_from_selection (std::vector<boost::shared_ptr<ARDOUR::Region> >&);
1211
1212         void play_from_start ();
1213         void play_from_edit_point ();
1214         void play_from_edit_point_and_return ();
1215         void play_selected_region ();
1216         void play_edit_range ();
1217         void loop_selected_region ();
1218         void play_location (ARDOUR::Location&);
1219         void loop_location (ARDOUR::Location&);
1220
1221         void temporal_zoom_selection ();
1222         void temporal_zoom_region (bool both_axes);
1223         void toggle_zoom_region (bool both_axes);
1224         bool zoomed_to_region;
1225         void temporal_zoom_session ();
1226         void temporal_zoom (gdouble scale);
1227         void temporal_zoom_by_frame (nframes64_t start, nframes64_t end, const std::string & op);
1228         void temporal_zoom_to_frame (bool coarser, nframes64_t frame);
1229
1230         void amplitude_zoom (gdouble scale);
1231         void amplitude_zoom_step (bool in);
1232
1233         void insert_region_list_drag (boost::shared_ptr<ARDOUR::Region>, int x, int y);
1234         void insert_region_list_selection (float times);
1235
1236         void insert_route_list_drag (boost::shared_ptr<ARDOUR::Route>, int x, int y);
1237
1238         /* import & embed */
1239         
1240         void add_external_audio_action (Editing::ImportMode);
1241         void external_audio_dialog ();
1242         void session_import_dialog ();
1243
1244         int  check_whether_and_how_to_import(std::string, bool all_or_nothing = true);
1245         bool check_multichannel_status (const std::vector<Glib::ustring>& paths);
1246
1247         SoundFileOmega* sfbrowser;
1248         
1249         void bring_in_external_audio (Editing::ImportMode mode,  nframes64_t& pos);
1250
1251         bool  idle_drop_paths  (std::vector<Glib::ustring> paths, nframes64_t frame, double ypos);
1252         void  drop_paths_part_two  (const std::vector<Glib::ustring>& paths, nframes64_t frame, double ypos);
1253         
1254         void do_import (std::vector<Glib::ustring> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, nframes64_t&);
1255         void do_embed (std::vector<Glib::ustring> paths, Editing::ImportDisposition, Editing::ImportMode mode,  nframes64_t&);
1256
1257         int  import_sndfiles (std::vector<Glib::ustring> paths, Editing::ImportMode mode,  ARDOUR::SrcQuality, nframes64_t& pos,
1258                               int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>, bool, uint32_t total);
1259         int  embed_sndfiles (std::vector<Glib::ustring> paths, bool multiple_files, bool& check_sample_rate, Editing::ImportMode mode, 
1260                              nframes64_t& pos, int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>&);
1261
1262         int add_sources (std::vector<Glib::ustring> paths, ARDOUR::SourceList& sources, nframes64_t& pos, Editing::ImportMode,
1263                          int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>&, bool add_channel_suffix);
1264         int finish_bringing_in_material (boost::shared_ptr<ARDOUR::Region> region, uint32_t, uint32_t,  nframes64_t& pos, Editing::ImportMode mode,
1265                                       boost::shared_ptr<ARDOUR::Track>& existing_track);
1266
1267         boost::shared_ptr<ARDOUR::AudioTrack> get_nth_selected_audio_track (int nth) const;
1268         boost::shared_ptr<ARDOUR::MidiTrack> get_nth_selected_midi_track (int nth) const;
1269
1270         /* generic interthread progress window */
1271         
1272         ArdourDialog* interthread_progress_window;
1273         Gtk::Label interthread_progress_label;
1274         Gtk::VBox interthread_progress_vbox;
1275         Gtk::ProgressBar interthread_progress_bar;
1276         Gtk::Button interthread_cancel_button;
1277         Gtk::Label interthread_cancel_label;
1278         sigc::connection  interthread_progress_connection;
1279         void interthread_cancel_clicked ();
1280         void build_interthread_progress_window ();
1281         ARDOUR::InterThreadInfo* current_interthread_info;
1282
1283         AnalysisWindow* analysis_window;
1284
1285         /* import specific info */
1286
1287         struct EditorImportStatus : public ARDOUR::Session::ImportStatus {
1288             Editing::ImportMode mode;
1289             nframes64_t pos;
1290             int target_tracks;
1291             int target_regions;
1292             boost::shared_ptr<ARDOUR::Track> track;
1293             bool replace;
1294         };
1295
1296         EditorImportStatus import_status;
1297         gint import_progress_timeout (void *);
1298         static void *_import_thread (void *);
1299         void* import_thread ();
1300         void finish_import ();
1301
1302         /* to support this ... */
1303
1304         void import_audio (bool as_tracks);
1305         void do_import (std::vector<Glib::ustring> paths, bool split, bool as_tracks);
1306
1307         void move_to_start ();
1308         void move_to_end ();
1309         void goto_frame ();
1310         void center_playhead ();
1311         void center_edit_point ();
1312         void edit_cursor_backward ();
1313         void edit_cursor_forward ();
1314         void playhead_forward_to_grid ();
1315         void playhead_backward_to_grid ();
1316         void playhead_backward ();
1317         void playhead_forward ();
1318         void scroll_playhead (bool forward);
1319         void scroll_backward (float pages=0.8f);
1320         void scroll_forward (float pages=0.8f);
1321         void scroll_tracks_down ();
1322         void scroll_tracks_up ();
1323         void delete_sample_forward ();
1324         void delete_sample_backward ();
1325         void delete_screen ();
1326         void search_backwards ();
1327         void search_forwards ();
1328         void set_mark ();
1329         void clear_markers ();
1330         void clear_ranges ();
1331         void clear_locations ();
1332         void unhide_markers ();
1333         void unhide_ranges ();
1334         void jump_forward_to_mark ();
1335         void jump_backward_to_mark ();
1336         void cursor_align (bool playhead_to_edit);
1337
1338         void remove_last_capture ();
1339         void select_all_selectables_using_time_selection ();
1340         void select_all_selectables_using_loop();
1341         void select_all_selectables_using_punch();
1342         void set_selection_from_range (ARDOUR::Location&);
1343         void set_selection_from_punch ();
1344         void set_selection_from_loop ();
1345         void set_selection_from_region ();
1346
1347         void add_location_mark (nframes64_t where);
1348         void add_location_from_audio_region ();
1349         void add_locations_from_audio_region ();
1350         void add_location_from_selection ();
1351         void set_loop_from_selection (bool play);
1352         void set_punch_from_selection ();
1353         void set_punch_from_region ();
1354
1355         void set_loop_from_edit_range (bool play);
1356         void set_loop_from_region (bool play);
1357         void set_punch_from_edit_range ();
1358
1359         void set_loop_range (nframes64_t start, nframes64_t end, std::string cmd);
1360         void set_punch_range (nframes64_t start, nframes64_t end, std::string cmd);
1361
1362         void add_location_from_playhead_cursor ();
1363         bool select_new_marker;
1364
1365         void reverse_selection ();
1366         void edit_envelope ();
1367
1368         void start_scrolling ();
1369         void stop_scrolling ();
1370
1371         double last_scrub_x;
1372         int scrubbing_direction;
1373         int scrub_reversals;
1374         int scrub_reverse_distance;
1375         void scrub ();
1376
1377         void keyboard_selection_begin ();
1378         void keyboard_selection_finish (bool add);
1379         bool have_pending_keyboard_selection;
1380         nframes64_t pending_keyboard_selection_start;
1381
1382         boost::shared_ptr<ARDOUR::Region> select_region_for_operation (int dir, TimeAxisView **tv);
1383         void extend_selection_to_end_of_region (bool next);
1384         void extend_selection_to_start_of_region (bool previous);
1385
1386         Editing::SnapType snap_type;
1387         Editing::SnapMode snap_mode;
1388
1389         /// Snap threshold in pixels
1390         double snap_threshold;
1391
1392         bool ignore_gui_changes;
1393
1394         Drag* _drag;
1395
1396         void break_drag ();
1397
1398         Gtk::Menu fade_context_menu;
1399         void popup_fade_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1400
1401         void set_fade_in_shape (ARDOUR::AudioRegion::FadeShape);
1402         void set_fade_out_shape (ARDOUR::AudioRegion::FadeShape);
1403         
1404         void set_fade_length (bool in);
1405         void toggle_fade_active (bool in);
1406         void set_fade_in_active (bool);
1407         void set_fade_out_active (bool);
1408         
1409         std::set<boost::shared_ptr<ARDOUR::Playlist> > motion_frozen_playlists;
1410         RegionSelection pre_drag_region_selection;
1411
1412         bool _dragging_playhead;
1413         bool _dragging_edit_point;
1414
1415         void marker_drag_motion_callback (GdkEvent*);
1416         void marker_drag_finished_callback (GdkEvent*);
1417
1418         gint mouse_rename_region (ArdourCanvas::Item*, GdkEvent*);
1419
1420         void start_region_grab (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1421         void start_create_region_grab (ArdourCanvas::Item*, GdkEvent*);
1422         void start_region_copy_grab (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1423         void start_region_brush_grab (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1424         void start_selection_grab (ArdourCanvas::Item*, GdkEvent*);
1425
1426         void region_view_item_click (AudioRegionView&, GdkEventButton*);
1427
1428         void remove_gain_control_point (ArdourCanvas::Item*, GdkEvent*);
1429         void remove_control_point (ArdourCanvas::Item*, GdkEvent*);
1430
1431         void mouse_brush_insert_region (RegionView*, nframes64_t pos);
1432         void brush (nframes64_t);
1433
1434         void show_verbose_time_cursor (nframes64_t frame, double offset = 0, double xpos=-1, double ypos=-1);
1435         void show_verbose_duration_cursor (nframes64_t start, nframes64_t end, double offset = 0, double xpos=-1, double ypos=-1);
1436         double clamp_verbose_cursor_x (double);
1437         double clamp_verbose_cursor_y (double);
1438
1439         /* Canvas event handlers */
1440
1441         bool canvas_control_point_event (GdkEvent* event,ArdourCanvas::Item*, ControlPoint*);
1442         bool canvas_line_event (GdkEvent* event,ArdourCanvas::Item*, AutomationLine*);
1443         bool canvas_selection_rect_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1444         bool canvas_selection_start_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1445         bool canvas_selection_end_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1446         bool canvas_crossfade_view_event (GdkEvent* event,ArdourCanvas::Item*, CrossfadeView*);
1447         bool canvas_fade_in_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1448         bool canvas_fade_in_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1449         bool canvas_fade_out_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1450         bool canvas_fade_out_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1451         
1452
1453         // These variables are used to detect a feedback loop and break it to avoid a gui hang
1454 private:
1455         ArdourCanvas::Item *last_item_entered;
1456         int last_item_entered_n;
1457 public:
1458
1459         bool canvas_region_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1460         bool canvas_region_view_name_highlight_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1461         bool canvas_region_view_name_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1462         bool canvas_stream_view_event (GdkEvent* event,ArdourCanvas::Item*, RouteTimeAxisView*);
1463         bool canvas_marker_event (GdkEvent* event,ArdourCanvas::Item*, Marker*);
1464         bool canvas_zoom_rect_event (GdkEvent* event,ArdourCanvas::Item*);
1465         bool canvas_tempo_marker_event (GdkEvent* event,ArdourCanvas::Item*, TempoMarker*);
1466         bool canvas_meter_marker_event (GdkEvent* event,ArdourCanvas::Item*, MeterMarker*);
1467         bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) ;
1468
1469         bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1470         bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1471         bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1472         bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1473         bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1474         bool canvas_cd_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1475
1476         bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1477         bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*);
1478         bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1479         bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1480         bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*);
1481         bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1482         bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1483         bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1484
1485         /* non-public event handlers */
1486
1487         bool canvas_playhead_cursor_event (GdkEvent* event, ArdourCanvas::Item*);
1488         bool track_canvas_scroll (GdkEventScroll* event);
1489
1490         bool track_canvas_scroll_event (GdkEventScroll* event);
1491         bool track_canvas_button_press_event (GdkEventButton* event);
1492         bool track_canvas_button_release_event (GdkEventButton* event);
1493         bool track_canvas_motion_notify_event (GdkEventMotion* event);
1494
1495         Gtk::Allocation canvas_allocation;
1496         void track_canvas_allocate (Gtk::Allocation alloc);
1497         bool track_canvas_size_allocated ();
1498         bool track_canvas_drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int, int, guint);
1499
1500         void set_playhead_cursor ();
1501
1502         void kbd_driver (sigc::slot<void,GdkEvent*>, bool use_track_canvas = true, bool use_time_canvas = true, bool can_select = true);
1503         void kbd_mute_unmute_region ();
1504         void kbd_brush ();
1505
1506         void kbd_do_brush (GdkEvent*);
1507         void kbd_do_audition (GdkEvent*);
1508
1509         void handle_new_duration ();
1510         void initialize_canvas ();
1511
1512         /* display control */
1513         
1514         bool _show_measures;
1515         /// true if the editor should follow the playhead, otherwise false
1516         bool _follow_playhead;
1517         /// true if waveforms should be shown while recording audio tracks, otherwise false
1518         bool _show_waveforms_recording;
1519         
1520         ARDOUR::TempoMap::BBTPointList *current_bbt_points;
1521         
1522         TempoLines* tempo_lines;
1523
1524         ArdourCanvas::Group* time_line_group;
1525
1526         void hide_measures ();
1527         void draw_measures ();
1528         bool redraw_measures ();
1529
1530         void new_tempo_section ();
1531
1532         void mouse_add_new_tempo_event (nframes64_t where);
1533         void mouse_add_new_meter_event (nframes64_t where);
1534
1535         void remove_tempo_marker (ArdourCanvas::Item*);
1536         void remove_meter_marker (ArdourCanvas::Item*);
1537         gint real_remove_tempo_marker (ARDOUR::TempoSection*);
1538         gint real_remove_meter_marker (ARDOUR::MeterSection*);
1539         
1540         void edit_tempo_section (ARDOUR::TempoSection*);
1541         void edit_meter_section (ARDOUR::MeterSection*);
1542         void edit_tempo_marker (ArdourCanvas::Item*);
1543         void edit_meter_marker (ArdourCanvas::Item*);
1544         void edit_control_point (ArdourCanvas::Item*);
1545         
1546         void marker_menu_edit ();
1547         void marker_menu_remove ();
1548         void marker_menu_rename ();
1549         void marker_menu_lock (bool yn);
1550         void marker_menu_hide ();
1551         void marker_menu_loop_range ();
1552         void marker_menu_select_all_selectables_using_range ();
1553         void marker_menu_select_using_range ();
1554         void marker_menu_separate_regions_using_location ();
1555         void marker_menu_play_from ();
1556         void marker_menu_play_range ();
1557         void marker_menu_set_playhead ();
1558         void marker_menu_set_from_playhead ();
1559         void marker_menu_set_from_selection ();
1560         void marker_menu_range_to_next ();
1561         void new_transport_marker_menu_set_loop ();
1562         void new_transport_marker_menu_set_punch ();
1563         void update_loop_range_view (bool visibility=false);
1564         void update_punch_range_view (bool visibility=false);
1565         void new_transport_marker_menu_popdown ();
1566         void marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1567         void tm_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1568         void transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1569         void new_transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1570         void build_range_marker_menu (bool loop_or_punch);
1571         void build_marker_menu (bool start_or_end);
1572         void build_tm_marker_menu ();
1573         void build_new_transport_marker_menu ();
1574
1575         Gtk::Menu* tm_marker_menu;
1576         Gtk::Menu* marker_menu;
1577         Gtk::Menu* start_end_marker_menu;
1578         Gtk::Menu* range_marker_menu;
1579         Gtk::Menu* transport_marker_menu;
1580         Gtk::Menu* new_transport_marker_menu;
1581         Gtk::Menu* cd_marker_menu;
1582         ArdourCanvas::Item* marker_menu_item;
1583
1584         typedef std::list<Marker*> Marks;
1585         Marks metric_marks;
1586
1587         void remove_metric_marks ();
1588         void draw_metric_marks (const ARDOUR::Metrics& metrics);
1589
1590         void compute_current_bbt_points (nframes_t left, nframes_t right);
1591         void tempo_map_changed (ARDOUR::Change);
1592         void redisplay_tempo (bool immediate_redraw);
1593         
1594         void snap_to (nframes64_t& first, int32_t direction = 0, bool for_mark = false);
1595         void snap_to (nframes64_t& first, nframes64_t& last, int32_t direction = 0, bool for_mark = false);
1596
1597         double snap_length_beats (nframes64_t start);
1598
1599         uint32_t bbt_beat_subdivision;
1600
1601         /* toolbar */
1602
1603         Gtk::ToggleButton editor_mixer_button;
1604         Gtk::ToggleButton editor_list_button;
1605         void editor_mixer_button_toggled ();
1606         void editor_list_button_toggled ();
1607
1608         AudioClock               edit_point_clock;
1609         AudioClock               zoom_range_clock;
1610         Gtk::Button              zoom_in_button;
1611         Gtk::Button              zoom_out_button;
1612         Gtk::Button              zoom_out_full_button;
1613         Gtk::Button              zoom_onetoone_button;
1614
1615         Gtk::VBox                toolbar_clock_vbox;
1616         Gtk::VBox                toolbar_selection_clock_vbox; 
1617         Gtk::Table               toolbar_selection_clock_table;
1618         Gtk::Label               toolbar_selection_cursor_label;
1619         
1620         Gtk::HBox                mouse_mode_button_box;
1621         Gtkmm2ext::TearOff*      mouse_mode_tearoff;
1622         Gtk::ToggleButton        mouse_select_button;
1623         Gtk::ToggleButton        mouse_move_button;
1624         Gtk::ToggleButton        mouse_gain_button;
1625         Gtk::ToggleButton        mouse_zoom_button;
1626         Gtk::ToggleButton        mouse_timefx_button;
1627         Gtk::ToggleButton        mouse_audition_button;
1628         Gtk::ToggleButton        mouse_note_button;
1629         GroupedButtons          *mouse_mode_button_set;
1630         void                     mouse_mode_toggled (Editing::MouseMode m);
1631         bool                     ignore_mouse_mode_toggle;
1632
1633         gint                     mouse_select_button_release (GdkEventButton*);
1634
1635         Gtk::VBox                automation_box;
1636         Gtk::Button              automation_mode_button;
1637         Gtk::ToggleButton        global_automation_button;
1638
1639         Gtk::ComboBoxText edit_mode_selector;
1640         Gtk::VBox         edit_mode_box;
1641
1642         void set_edit_mode (ARDOUR::EditMode);
1643         void cycle_edit_mode ();
1644         void edit_mode_selection_done ();
1645
1646         Gtk::ComboBoxText snap_type_selector;
1647         Gtk::ComboBoxText snap_mode_selector;
1648         Gtk::HBox         snap_box;
1649
1650         std::vector<std::string> snap_type_strings;
1651         std::vector<std::string> snap_mode_strings;
1652
1653         void snap_type_selection_done ();
1654         void snap_mode_selection_done ();
1655         void snap_mode_chosen (Editing::SnapMode);
1656         void snap_type_chosen (Editing::SnapType);
1657
1658         Glib::RefPtr<Gtk::RadioAction> snap_type_action (Editing::SnapType);
1659         Glib::RefPtr<Gtk::RadioAction> snap_mode_action (Editing::SnapMode);
1660
1661         Gtk::ComboBoxText zoom_focus_selector;
1662         Gtk::VBox         zoom_focus_box;
1663
1664         std::vector<std::string> zoom_focus_strings;
1665         
1666         void zoom_focus_selection_done ();
1667         void zoom_focus_chosen (Editing::ZoomFocus);
1668
1669         Glib::RefPtr<Gtk::RadioAction> zoom_focus_action (Editing::ZoomFocus);
1670
1671         Gtk::HBox           zoom_box;
1672         Gtk::VBox           zoom_vbox;
1673
1674         void                zoom_adjustment_changed();
1675
1676         void                edit_point_clock_changed();
1677         
1678         void setup_toolbar ();
1679
1680         Gtkmm2ext::TearOff*      tools_tearoff;
1681         Gtk::HBox                toolbar_hbox;
1682         Gtk::EventBox            toolbar_base;
1683         Gtk::Frame               toolbar_frame;
1684
1685         /* midi toolbar */
1686
1687         Gtk::HBox                midi_tool_button_box;
1688         Gtk::ToggleButton        midi_tool_pencil_button;
1689         Gtk::ToggleButton        midi_tool_select_button;
1690         Gtk::ToggleButton        midi_tool_resize_button;
1691         Gtk::ToggleButton        midi_tool_erase_button;
1692         Gtk::Button              midi_panic_button;
1693         Gtk::ToggleButton        midi_sound_notes;
1694         GroupedButtons          *midi_tool_button_set;
1695         void                     midi_edit_mode_toggled (Editing::MidiEditMode m);
1696         void                     midi_panic_button_pressed ();
1697         bool                     sound_notes () const { return midi_sound_notes.get_active(); }
1698         
1699         bool                     ignore_midi_edit_mode_toggle;
1700
1701         Gtkmm2ext::TearOff* midi_tools_tearoff;
1702         Gtk::HBox           midi_toolbar_hbox;
1703         Gtk::EventBox       midi_toolbar_base;
1704         Gtk::Frame          midi_toolbar_frame;
1705         
1706         void setup_midi_toolbar ();
1707
1708         /* selection process */
1709
1710         Selection* selection;
1711         Selection* cut_buffer;
1712
1713         void time_selection_changed ();
1714         void track_selection_changed ();
1715         void region_selection_changed ();
1716         sigc::connection editor_regions_selection_changed_connection;
1717         void sensitize_the_right_region_actions (bool have_selected_regions);
1718         void point_selection_changed ();
1719         void marker_selection_changed ();
1720
1721         void cancel_selection ();
1722
1723         void region_selection_op (void (ARDOUR::Region::*pmf)(void));
1724         void region_selection_op (void (ARDOUR::Region::*pmf)(void*), void*);
1725         void region_selection_op (void (ARDOUR::Region::*pmf)(bool), bool);
1726
1727         bool audio_region_selection_covers (nframes64_t where);
1728
1729         /* transport range select process */
1730
1731         ArdourCanvas::SimpleRect*  cd_marker_bar_drag_rect;
1732         ArdourCanvas::SimpleRect*  range_bar_drag_rect;
1733         ArdourCanvas::SimpleRect*  transport_bar_drag_rect;
1734
1735 #ifdef GTKOSX
1736         ArdourCanvas::SimpleRect     *bogus_background_rect;
1737 #endif
1738         ArdourCanvas::SimpleRect     *transport_bar_range_rect;
1739         ArdourCanvas::SimpleRect     *transport_bar_preroll_rect;
1740         ArdourCanvas::SimpleRect     *transport_bar_postroll_rect;
1741         ArdourCanvas::SimpleRect     *transport_loop_range_rect;
1742         ArdourCanvas::SimpleRect     *transport_punch_range_rect;
1743         ArdourCanvas::SimpleLine     *transport_punchin_line;
1744         ArdourCanvas::SimpleLine     *transport_punchout_line;
1745         ArdourCanvas::SimpleRect     *transport_preroll_rect;
1746         ArdourCanvas::SimpleRect     *transport_postroll_rect;
1747
1748         ARDOUR::Location*  transport_loop_location();
1749         ARDOUR::Location*  transport_punch_location();
1750
1751         ARDOUR::Location   *temp_location;
1752         
1753         /* object rubberband select process */
1754         
1755         bool select_all_within (nframes64_t start, nframes64_t end, gdouble topy, gdouble boty, const TrackViewList&, Selection::Operation op);
1756         
1757         ArdourCanvas::SimpleRect   *rubberband_rect;
1758         
1759         /* mouse zoom process */
1760
1761         ArdourCanvas::SimpleRect   *zoom_rect;
1762         void reposition_zoom_rect (nframes64_t start, nframes64_t end);
1763
1764         EditorRouteList* _route_list;
1765         
1766         /* diskstream/route display management */
1767         Glib::RefPtr<Gdk::Pixbuf> rec_enabled_icon;
1768         Glib::RefPtr<Gdk::Pixbuf> rec_disabled_icon;
1769
1770         Glib::RefPtr<Gtk::TreeSelection> route_display_selection;
1771
1772         bool sync_track_view_list_and_route_list ();
1773
1774         /* edit group management */
1775
1776         struct GroupListModelColumns : public Gtk::TreeModel::ColumnRecord {
1777
1778                 GroupListModelColumns () {
1779                         add (is_visible);
1780                         add (gain);
1781                         add (record);
1782                         add (mute);
1783                         add (solo);
1784                         add (select);
1785                         add (edits);
1786                         add (text);
1787                         add (routegroup);
1788                 }
1789
1790                 Gtk::TreeModelColumn<bool> is_visible;
1791                 Gtk::TreeModelColumn<bool> gain;
1792                 Gtk::TreeModelColumn<bool> record;
1793                 Gtk::TreeModelColumn<bool> mute;
1794                 Gtk::TreeModelColumn<bool> solo;
1795                 Gtk::TreeModelColumn<bool> select;
1796                 Gtk::TreeModelColumn<bool> edits;
1797                 Gtk::TreeModelColumn<std::string> text;
1798                 Gtk::TreeModelColumn<ARDOUR::RouteGroup*> routegroup;
1799         };
1800
1801         GroupListModelColumns group_columns;
1802
1803         Glib::RefPtr<Gtk::ListStore> group_model;
1804         Glib::RefPtr<Gtk::TreeSelection> group_selection;
1805
1806         Gtk::TreeView          route_group_display;
1807         Gtk::ScrolledWindow    route_group_display_scroller;
1808         Gtk::Menu*             route_group_menu;
1809
1810         void build_route_group_menu (ARDOUR::RouteGroup *);
1811         void activate_all_route_groups ();
1812         void disable_all_route_groups ();
1813         void subgroup_route_group (ARDOUR::RouteGroup*);
1814         void unsubgroup_route_group (ARDOUR::RouteGroup*);
1815
1816         bool in_route_group_row_change;
1817         void route_group_row_change (const Gtk::TreeModel::Path&,const Gtk::TreeModel::iterator&);
1818         void route_group_name_edit (const Glib::ustring&, const Glib::ustring&);
1819         void new_route_group ();
1820         void new_route_group_from_selection ();
1821         void new_route_group_from_rec_enabled ();
1822         void new_route_group_from_soloed ();
1823         void edit_route_group (ARDOUR::RouteGroup *);
1824         void fit_route_group (ARDOUR::RouteGroup *);
1825         void route_group_list_button_clicked ();
1826         gint route_group_list_button_press_event (GdkEventButton* ev);
1827         void add_route_group (ARDOUR::RouteGroup* group);
1828         void remove_selected_route_group ();
1829         void route_groups_changed ();
1830         void group_flags_changed (void*, ARDOUR::RouteGroup*);
1831
1832         Gtk::VBox           list_vpacker;
1833
1834         /* autoscrolling */
1835
1836         bool autoscroll_active;
1837         int autoscroll_timeout_tag;
1838         int autoscroll_x;
1839         int autoscroll_y;
1840         int last_autoscroll_x;
1841         int last_autoscroll_y;
1842         uint32_t autoscroll_cnt;
1843         nframes64_t autoscroll_x_distance;
1844         double autoscroll_y_distance;
1845
1846         static gint _autoscroll_canvas (void *);
1847         bool autoscroll_canvas ();
1848         void start_canvas_autoscroll (int x, int y);
1849         void stop_canvas_autoscroll ();
1850         void maybe_autoscroll (GdkEventMotion*, bool);
1851         bool allow_vertical_scroll;
1852
1853         /* trimming */
1854         void point_trim (GdkEvent*);
1855         void single_contents_trim (RegionView&, nframes64_t, bool, bool, bool);
1856         void single_start_trim (RegionView&, nframes64_t, bool, bool, bool);
1857         void single_end_trim (RegionView&, nframes64_t, bool, bool, bool);
1858
1859         void thaw_region_after_trim (RegionView& rv);
1860
1861         void trim_region_front();
1862         void trim_region_back();
1863         void trim_region (bool front);
1864
1865         void trim_region_to_edit_point ();
1866         void trim_region_from_edit_point ();
1867         void trim_region_to_loop ();
1868         void trim_region_to_punch ();
1869         void trim_region_to_location (const ARDOUR::Location&, const char* cmd);
1870
1871         void trim_to_region(bool forward);
1872         void trim_region_to_previous_region_end();
1873         void trim_region_to_next_region_start();
1874
1875         bool show_gain_after_trim;
1876
1877         /* Drag-n-Drop */
1878
1879         int convert_drop_to_paths (
1880                         std::vector<Glib::ustring>&           paths,
1881                         const Glib::RefPtr<Gdk::DragContext>& context,
1882                         gint                                  x,
1883                         gint                                  y,
1884                         const Gtk::SelectionData&             data,
1885                         guint                                 info,
1886                         guint                                 time);
1887
1888         void track_canvas_drag_data_received (
1889                         const Glib::RefPtr<Gdk::DragContext>& context,
1890                         gint                                  x,
1891                         gint                                  y,
1892                         const Gtk::SelectionData&             data,
1893                         guint                                 info,
1894                         guint                                 time);
1895         
1896         void region_list_display_drag_data_received (
1897                         const Glib::RefPtr<Gdk::DragContext>& context,
1898                         gint                                  x,
1899                         gint                                  y,
1900                         const Gtk::SelectionData&             data,
1901                         guint                                 info,
1902                         guint                                 time);
1903
1904         void drop_paths (
1905                         const Glib::RefPtr<Gdk::DragContext>& context,
1906                         gint                                  x,
1907                         gint                                  y,
1908                         const Gtk::SelectionData&             data,
1909                         guint                                 info,
1910                         guint                                 time);
1911
1912         void drop_regions (
1913                         const Glib::RefPtr<Gdk::DragContext>& context,
1914                         gint                                  x,
1915                         gint                                  y,
1916                         const Gtk::SelectionData&             data,
1917                         guint                                 info,
1918                         guint                                 time);
1919
1920         void drop_routes (
1921                         const Glib::RefPtr<Gdk::DragContext>& context,
1922                         gint                x,
1923                         gint                y,
1924                         const Gtk::SelectionData& data,
1925                         guint               info,
1926                         guint               time);
1927
1928         /* audio export */
1929
1930         int  write_region_selection(RegionSelection&);
1931         bool write_region (std::string path, boost::shared_ptr<ARDOUR::AudioRegion>);
1932         void bounce_region_selection ();
1933         void bounce_range_selection (bool replace, bool enable_processing);
1934         void external_edit_region ();
1935
1936         int write_audio_selection (TimeSelection&);
1937         bool write_audio_range (ARDOUR::AudioPlaylist&, const ARDOUR::ChanCount& channels, std::list<ARDOUR::AudioRange>&);
1938
1939         void write_selection ();
1940
1941         XMLNode *before; /* used in *_reversible_command */
1942
1943         void begin_reversible_command (std::string cmd_name);
1944         void commit_reversible_command ();
1945
1946         void update_title ();   
1947         void update_title_s (const std::string & snapshot_name);
1948
1949         struct State {
1950             Selection* selection;
1951             double frames_per_unit;
1952
1953             State (PublicEditor const * e);
1954             ~State ();
1955         };
1956
1957         void store_state (State&) const;
1958         void restore_state (State *);
1959
1960         void instant_save ();
1961
1962         boost::shared_ptr<ARDOUR::AudioRegion> last_audition_region;
1963         
1964         /* freeze operations */
1965
1966         ARDOUR::InterThreadInfo freeze_status;
1967         gint freeze_progress_timeout (void *);
1968         static void* _freeze_thread (void*);
1969         void* freeze_thread ();
1970
1971         void freeze_route ();
1972         void unfreeze_route ();
1973
1974         /* route-group solo + mute */
1975
1976         void set_route_group_solo (ARDOUR::Route&, bool);
1977         void set_route_group_mute (ARDOUR::Route&, bool);
1978
1979         /* duplication */
1980
1981         void duplicate_dialog (bool with_dialog);
1982         
1983         nframes64_t event_frame (GdkEvent const *, double* px = 0, double* py = 0) const;
1984
1985         /* returns false if mouse pointer is not in track or marker canvas
1986          */
1987         bool mouse_frame (nframes64_t&, bool& in_track_canvas) const;
1988
1989         /* "whats mine is yours" */
1990
1991         TimeFXDialog* current_timefx;
1992
1993         static void* timefx_thread (void *arg);
1994         void do_timefx (TimeFXDialog&);
1995
1996         int time_stretch (RegionSelection&, float fraction);
1997         int pitch_shift (RegionSelection&, float cents);
1998         void pitch_shift_regions ();
1999         int time_fx (RegionSelection&, float val, bool pitching);
2000
2001         /* editor-mixer strip */
2002
2003         MixerStrip *current_mixer_strip;
2004         bool show_editor_mixer_when_tracks_arrive;
2005         Gtk::VBox current_mixer_strip_vbox;
2006         void cms_new (boost::shared_ptr<ARDOUR::Route>);
2007         void cms_deleted ();
2008         void current_mixer_strip_hidden ();
2009         void current_mixer_strip_removed ();
2010
2011         void detach_tearoff (Gtk::Box* b, Gtk::Window* w);
2012         void reattach_tearoff (Gtk::Box* b, Gtk::Window* w, int32_t n);
2013 #ifdef GTKOSX
2014         void ensure_all_elements_drawn ();
2015 #endif
2016         /* nudging tracks */
2017
2018         void nudge_track (bool use_edit_point, bool forwards);
2019
2020         /* xfades */
2021
2022         bool _xfade_visibility;
2023         
2024 #ifdef WITH_CMT
2025         void handle_new_imageframe_time_axis_view(const std::string & track_name, void* src) ;
2026         void handle_new_imageframe_marker_time_axis_view(const std::string & track_name, TimeAxisView* marked_track) ;
2027
2028         void start_imageframe_grab(ArdourCanvas::Item*, GdkEvent*) ;
2029         void start_markerview_grab(ArdourCanvas::Item*, GdkEvent*) ;
2030
2031         void imageframe_drag_motion_callback(ArdourCanvas::Item*, GdkEvent*) ;
2032         void markerview_drag_motion_callback(ArdourCanvas::Item*, GdkEvent*) ;
2033         void timeaxis_item_drag_finished_callback(ArdourCanvas::Item*, GdkEvent*) ;
2034
2035         gint canvas_imageframe_item_view_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
2036         gint canvas_imageframe_view_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameTimeAxis* ifta);
2037         gint canvas_imageframe_start_handle_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
2038         gint canvas_imageframe_end_handle_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
2039
2040         gint canvas_marker_time_axis_view_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerTimeAxis* mta);
2041         gint canvas_markerview_item_view_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
2042         gint canvas_markerview_start_handle_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
2043         gint canvas_markerview_end_handle_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
2044
2045         void imageframe_start_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
2046         void imageframe_end_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
2047         void imageframe_start_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
2048         void imageframe_start_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
2049         void imageframe_end_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
2050         void imageframe_end_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
2051         
2052         void markerview_item_start_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
2053         void markerview_item_end_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
2054         void markerview_start_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
2055         void markerview_start_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
2056         void markerview_end_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
2057         void markerview_end_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
2058
2059         void popup_imageframe_edit_menu(int button, int32_t time, ArdourCanvas::Item* ifv, bool with_frame) ;
2060         void popup_marker_time_axis_edit_menu(int button, int32_t time, ArdourCanvas::Item* ifv, bool with_frame) ;
2061
2062         ImageFrameSocketHandler* image_socket_listener ;
2063 #endif
2064
2065         void toggle_xfade_active (boost::weak_ptr<ARDOUR::Crossfade>);
2066         void toggle_xfade_length (boost::weak_ptr<ARDOUR::Crossfade>);
2067         void edit_xfade (boost::weak_ptr<ARDOUR::Crossfade>);
2068         void xfade_edit_left_region ();
2069         void xfade_edit_right_region ();
2070
2071         static const int32_t default_width = 995;
2072         static const int32_t default_height = 765;
2073
2074         /* nudge */
2075
2076         Gtk::Button      nudge_forward_button;
2077         Gtk::Button      nudge_backward_button;
2078         Gtk::HBox        nudge_hbox;
2079         Gtk::VBox        nudge_vbox;
2080         AudioClock       nudge_clock;
2081
2082         nframes64_t get_nudge_distance (nframes64_t pos, nframes64_t& next);
2083
2084         bool nudge_forward_release (GdkEventButton*);
2085         bool nudge_backward_release (GdkEventButton*);
2086         
2087         /* audio filters */
2088
2089         void apply_filter (ARDOUR::Filter&, std::string cmd);
2090
2091         /* handling cleanup */
2092
2093         int playlist_deletion_dialog (boost::shared_ptr<ARDOUR::Playlist>);
2094
2095         std::vector<sigc::connection> session_connections;
2096
2097         /* tracking step changes of track height */
2098
2099         TimeAxisView* current_stepping_trackview;
2100         ARDOUR::microseconds_t last_track_height_step_timestamp;
2101         gint track_height_step_timeout();
2102         sigc::connection step_timeout;
2103
2104         TimeAxisView* entered_track;
2105         RegionView*   entered_regionview;
2106
2107
2108         void ensure_entered_track_selected (bool op_acts_on_objects = false);
2109         bool clear_entered_track;
2110         bool left_track_canvas (GdkEventCrossing*);
2111         bool entered_track_canvas (GdkEventCrossing*);
2112         void set_entered_track (TimeAxisView*);
2113         void set_entered_regionview (RegionView*);
2114         void ensure_track_visible (TimeAxisView*);
2115         gint left_automation_track ();
2116
2117         bool _new_regionviews_show_envelope;
2118
2119         void reset_canvas_action_sensitivity (bool);
2120         void toggle_gain_envelope_visibility ();
2121         void toggle_gain_envelope_active ();
2122         void reset_region_gain_envelopes ();
2123
2124         bool on_key_press_event (GdkEventKey*);
2125         bool on_key_release_event (GdkEventKey*);
2126
2127         void session_state_saved (std::string);
2128
2129         Glib::RefPtr<Gtk::Action>              undo_action;
2130         Glib::RefPtr<Gtk::Action>              redo_action;
2131
2132         void history_changed ();
2133
2134         Gtk::HBox      status_bar_hpacker;
2135
2136         Editing::EditPoint _edit_point;
2137
2138         Gtk::ComboBoxText edit_point_selector;
2139
2140         void set_edit_point_preference (Editing::EditPoint ep, bool force = false);
2141         void cycle_edit_point (bool with_marker);
2142         void set_edit_point ();
2143         void edit_point_selection_done ();
2144         void edit_point_chosen (Editing::EditPoint);
2145         Glib::RefPtr<Gtk::RadioAction> edit_point_action (Editing::EditPoint);
2146         std::vector<std::string> edit_point_strings;
2147
2148         void selected_marker_moved (ARDOUR::Location*);
2149         sigc::connection edit_point_clock_connection_a;
2150         sigc::connection edit_point_clock_connection_b;
2151
2152         bool get_edit_op_range (nframes64_t& start, nframes64_t& end) const;
2153
2154         void get_regions_at (RegionSelection&, nframes64_t where, const TrackSelection& ts) const;
2155         void get_regions_after (RegionSelection&, nframes64_t where, const TrackSelection& ts) const;
2156         
2157         void get_regions_for_action (RegionSelection&, bool allowed_entered_regionview = false);
2158
2159         sigc::connection fast_screen_update_connection;
2160         gint start_updating ();
2161         gint stop_updating ();
2162         void fast_update_strips ();
2163         bool meters_running;
2164
2165         void select_next_route ();
2166         void select_prev_route ();
2167
2168         void snap_to_internal (nframes64_t& first, int32_t direction = 0, bool for_mark = false);
2169
2170         RhythmFerret* rhythm_ferret;
2171         BundleManager* _bundle_manager;
2172         GlobalPortMatrixWindow* _global_port_matrix[ARDOUR::DataType::num_types];
2173
2174         void fit_tracks (TrackSelection &);
2175         void fit_selected_tracks ();
2176         void set_track_height (uint32_t h);
2177
2178         void remove_tracks ();
2179         void toggle_tracks_active ();
2180
2181         bool _have_idled;
2182         int resize_idle_id;
2183         bool idle_resize();
2184         friend gboolean _idle_resize (gpointer);
2185         int32_t _pending_resize_amount;
2186         TimeAxisView* _pending_resize_view;
2187
2188         void visible_order_range (int*, int*) const;
2189
2190         void located ();
2191         bool _pending_locate_request;
2192
2193         EditorSummary* _summary;
2194         void region_view_added (RegionView *);
2195
2196         void update_canvas_now ();
2197         void streamview_height_changed ();
2198
2199         EditorGroupTabs* _group_tabs;
2200
2201         void set_route_group_activation (ARDOUR::RouteGroup *, bool);
2202
2203         friend class Drag;
2204         friend class RegionDrag;
2205         friend class RegionMoveDrag;
2206         friend class RegionSpliceDrag;
2207         friend class TrimDrag;
2208         friend class MeterMarkerDrag;
2209         friend class TempoMarkerDrag;
2210         friend class CursorDrag;
2211         friend class FadeInDrag;
2212         friend class FadeOutDrag;
2213         friend class MarkerDrag;
2214         friend class RegionGainDrag;
2215         friend class ControlPointDrag;
2216         friend class LineDrag;
2217         friend class RubberbandSelectDrag;
2218         friend class TimeFXDrag;
2219         friend class ScrubDrag;
2220         friend class SelectionDrag;
2221         friend class RangeMarkerBarDrag;
2222         friend class MouseZoomDrag;
2223         friend class RegionCreateDrag;
2224         friend class RegionMotionDrag;
2225         friend class RegionInsertDrag;
2226
2227         friend class EditorSummary;
2228         friend class EditorGroupTabs;
2229
2230         friend class EditorRouteList;
2231 };
2232
2233 #endif /* __ardour_editor_h__ */