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