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