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                 ruler_video_timeline = 10,
790         };
791
792         static GtkCustomMetric ruler_metrics[4];
793         Glib::RefPtr<Gtk::ToggleAction> ruler_timecode_action;
794         Glib::RefPtr<Gtk::ToggleAction> ruler_bbt_action;
795         Glib::RefPtr<Gtk::ToggleAction> ruler_samples_action;
796         Glib::RefPtr<Gtk::ToggleAction> ruler_minsec_action;
797         Glib::RefPtr<Gtk::ToggleAction> ruler_tempo_action;
798         Glib::RefPtr<Gtk::ToggleAction> ruler_meter_action;
799         Glib::RefPtr<Gtk::ToggleAction> ruler_marker_action;
800         Glib::RefPtr<Gtk::ToggleAction> ruler_range_action;
801         Glib::RefPtr<Gtk::ToggleAction> ruler_loop_punch_action;
802         Glib::RefPtr<Gtk::ToggleAction> ruler_cd_marker_action;
803         bool                            no_ruler_shown_update;
804
805         bool ruler_button_press (GdkEventButton*);
806         bool ruler_button_release (GdkEventButton*);
807         bool ruler_mouse_motion (GdkEventMotion*);
808         bool ruler_scroll (GdkEventScroll* event);
809
810         Gtk::Widget * ruler_grabbed_widget;
811
812         void initialize_rulers ();
813         void update_just_timecode ();
814         void compute_fixed_ruler_scale (); //calculates the RulerScale of the fixed rulers
815         void update_fixed_rulers ();
816         void update_tempo_based_rulers (ARDOUR::TempoMap::BBTPointList::const_iterator& begin,
817                                         ARDOUR::TempoMap::BBTPointList::const_iterator& end);
818         void popup_ruler_menu (framepos_t where = 0, ItemType type = RegionItem);
819         void update_ruler_visibility ();
820         void set_ruler_visible (RulerType, bool);
821         void toggle_ruler_visibility (RulerType rt);
822         void ruler_toggled (int);
823         bool ruler_label_button_release (GdkEventButton*);
824         void store_ruler_visibility ();
825         void restore_ruler_visibility ();
826
827         static gint _metric_get_timecode (GtkCustomRulerMark **, gdouble, gdouble, gint);
828         static gint _metric_get_bbt (GtkCustomRulerMark **, gdouble, gdouble, gint);
829         static gint _metric_get_samples (GtkCustomRulerMark **, gdouble, gdouble, gint);
830         static gint _metric_get_minsec (GtkCustomRulerMark **, gdouble, gdouble, gint);
831
832         enum MinsecRulerScale {
833                 minsec_show_seconds,
834                 minsec_show_minutes,
835                 minsec_show_hours,
836                 minsec_show_frames
837         };
838
839         MinsecRulerScale minsec_ruler_scale;
840
841         framecnt_t minsec_mark_interval;
842         gint minsec_mark_modulo;
843         gint minsec_nmarks;
844         void set_minsec_ruler_scale (framepos_t, framepos_t);
845
846         enum TimecodeRulerScale {
847                 timecode_show_bits,
848                 timecode_show_frames,
849                 timecode_show_seconds,
850                 timecode_show_minutes,
851                 timecode_show_hours
852         };
853
854         TimecodeRulerScale timecode_ruler_scale;
855
856         gint timecode_mark_modulo;
857         gint timecode_nmarks;
858         void set_timecode_ruler_scale (framepos_t, framepos_t);
859
860         framecnt_t _samples_ruler_interval;
861         void set_samples_ruler_scale (framepos_t, framepos_t);
862
863         enum BBTRulerScale {
864                 bbt_over,
865                 bbt_show_64,
866                 bbt_show_16,
867                 bbt_show_4,
868                 bbt_show_1,
869                 bbt_show_beats,
870                 bbt_show_ticks,
871                 bbt_show_ticks_detail,
872                 bbt_show_ticks_super_detail
873         };
874
875         BBTRulerScale bbt_ruler_scale;
876
877         uint32_t bbt_bars;
878         gint bbt_nmarks;
879         uint32_t bbt_bar_helper_on;
880         uint32_t bbt_accent_modulo;
881         void compute_bbt_ruler_scale (framepos_t lower, framepos_t upper,
882                                       ARDOUR::TempoMap::BBTPointList::const_iterator current_bbt_points_begin,
883                                       ARDOUR::TempoMap::BBTPointList::const_iterator current_bbt_points_end);
884
885         gint metric_get_timecode (GtkCustomRulerMark **, gdouble, gdouble, gint);
886         gint metric_get_bbt (GtkCustomRulerMark **, gdouble, gdouble, gint);
887         gint metric_get_samples (GtkCustomRulerMark **, gdouble, gdouble, gint);
888         gint metric_get_minsec (GtkCustomRulerMark **, gdouble, gdouble, gint);
889
890         Gtk::Widget        *_ruler_separator;
891         GtkWidget          *_timecode_ruler;
892         GtkWidget          *_bbt_ruler;
893         GtkWidget          *_samples_ruler;
894         GtkWidget          *_minsec_ruler;
895         Gtk::Widget        *timecode_ruler;
896         Gtk::Widget        *bbt_ruler;
897         Gtk::Widget        *samples_ruler;
898         Gtk::Widget        *minsec_ruler;
899         static Editor      *ruler_editor;
900
901         static const double timebar_height;
902         guint32 visible_timebars;
903         Gtk::Menu          *editor_ruler_menu;
904
905         ArdourCanvas::Rectangle* tempo_bar;
906         ArdourCanvas::Rectangle* meter_bar;
907         ArdourCanvas::Rectangle* marker_bar;
908         ArdourCanvas::Rectangle* range_marker_bar;
909         ArdourCanvas::Rectangle* transport_marker_bar;
910         ArdourCanvas::Rectangle* cd_marker_bar;
911
912         Gtk::Label  minsec_label;
913         Gtk::Label  bbt_label;
914         Gtk::Label  timecode_label;
915         Gtk::Label  samples_label;
916         Gtk::Label  tempo_label;
917         Gtk::Label  meter_label;
918         Gtk::Label  mark_label;
919         Gtk::Label  range_mark_label;
920         Gtk::Label  transport_mark_label;
921         Gtk::Label  cd_mark_label;
922
923         /* videtimline related actions */
924         ArdourCanvas::Rectangle*  videotl_bar;
925         Gtk::Label                videotl_label;
926         ArdourCanvas::Group*      videotl_bar_group;
927         ArdourCanvas::Group*      videotl_group;
928         Glib::RefPtr<Gtk::ToggleAction> ruler_video_action;
929         Glib::RefPtr<Gtk::ToggleAction> xjadeo_proc_action;
930         Glib::RefPtr<Gtk::ToggleAction> xjadeo_ontop_action;
931         Glib::RefPtr<Gtk::ToggleAction> xjadeo_timecode_action;
932         Glib::RefPtr<Gtk::ToggleAction> xjadeo_frame_action;
933         Glib::RefPtr<Gtk::ToggleAction> xjadeo_osdbg_action;
934         Glib::RefPtr<Gtk::ToggleAction> xjadeo_fullscreen_action;
935         Glib::RefPtr<Gtk::ToggleAction> xjadeo_letterbox_action;
936         Glib::RefPtr<Gtk::Action> xjadeo_zoom_100;
937         void set_xjadeo_proc ();
938         void toggle_xjadeo_proc (int state=-1);
939         void set_xjadeo_sensitive (bool onoff);
940         void set_xjadeo_viewoption (int);
941         void toggle_xjadeo_viewoption (int what, int state=-1);
942         void toggle_ruler_video (bool onoff) {ruler_video_action->set_active(onoff);}
943         int videotl_bar_height; /* in units of timebar_height; default: 4 */
944         int get_videotl_bar_height () const { return videotl_bar_height; }
945         void export_video ();
946         void toggle_region_video_lock ();
947
948         Gtk::VBox          time_bars_vbox;
949
950         friend class EditorCursor;
951
952         EditorCursor*        playhead_cursor;
953
954         framepos_t get_region_boundary (framepos_t pos, int32_t dir, bool with_selection, bool only_onscreen);
955
956         void    cursor_to_region_boundary (bool with_selection, int32_t dir);
957         void    cursor_to_next_region_boundary (bool with_selection);
958         void    cursor_to_previous_region_boundary (bool with_selection);
959         void    cursor_to_next_region_point (EditorCursor*, ARDOUR::RegionPoint);
960         void    cursor_to_previous_region_point (EditorCursor*, ARDOUR::RegionPoint);
961         void    cursor_to_region_point (EditorCursor*, ARDOUR::RegionPoint, int32_t dir);
962         void    cursor_to_selection_start (EditorCursor *);
963         void    cursor_to_selection_end   (EditorCursor *);
964
965         void    selected_marker_to_region_boundary (bool with_selection, int32_t dir);
966         void    selected_marker_to_next_region_boundary (bool with_selection);
967         void    selected_marker_to_previous_region_boundary (bool with_selection);
968         void    selected_marker_to_next_region_point (ARDOUR::RegionPoint);
969         void    selected_marker_to_previous_region_point (ARDOUR::RegionPoint);
970         void    selected_marker_to_region_point (ARDOUR::RegionPoint, int32_t dir);
971         void    selected_marker_to_selection_start ();
972         void    selected_marker_to_selection_end   ();
973
974         void    select_all_selectables_using_cursor (EditorCursor *, bool);
975         void    select_all_selectables_using_edit (bool);
976         void    select_all_selectables_between (bool within);
977         void    select_range_between ();
978
979         boost::shared_ptr<ARDOUR::Region> find_next_region (ARDOUR::framepos_t, ARDOUR::RegionPoint, int32_t dir, TrackViewList&, TimeAxisView ** = 0);
980         ARDOUR::framepos_t find_next_region_boundary (ARDOUR::framepos_t, int32_t dir, const TrackViewList&);
981
982         std::vector<ARDOUR::framepos_t> region_boundary_cache;
983         void build_region_boundary_cache ();
984
985         Gtk::HBox           top_hbox;
986         Gtk::HBox           bottom_hbox;
987
988         Gtk::Table          edit_packer;
989
990         /** the adjustment that controls the overall editor vertical scroll position */
991         Gtk::Adjustment     vertical_adjustment;
992
993         Gtk::Layout         controls_layout;
994         bool control_layout_scroll (GdkEventScroll* ev);
995         void reset_controls_layout_width ();
996         void reset_controls_layout_height (int32_t height);
997
998         enum Direction {
999                 LEFT,
1000                 RIGHT,
1001                 UP,
1002                 DOWN
1003         };
1004
1005         bool scroll_press (Direction);
1006         void scroll_release ();
1007         sigc::connection _scroll_connection;
1008         int _scroll_callbacks;
1009
1010         double _visible_canvas_width;
1011         double _visible_canvas_height; ///< height of the visible area of the track canvas
1012         double _full_canvas_height;    ///< full height of the canvas
1013
1014         bool track_canvas_map_handler (GdkEventAny*);
1015
1016         bool edit_controls_button_release (GdkEventButton*);
1017         Gtk::Menu *edit_controls_left_menu;
1018         Gtk::Menu *edit_controls_right_menu;
1019
1020         Gtk::VBox           ruler_label_vbox;
1021         Gtk::VBox           track_canvas_vbox;
1022         Gtk::VBox           time_canvas_vbox;
1023         Gtk::VBox           edit_controls_vbox;
1024         Gtk::HBox           edit_controls_hbox;
1025
1026         void control_vertical_zoom_in_all ();
1027         void control_vertical_zoom_out_all ();
1028         void control_vertical_zoom_in_selected ();
1029         void control_vertical_zoom_out_selected ();
1030         void control_step_tracks_up ();
1031         void control_step_tracks_down ();
1032         void control_view (uint32_t);
1033         void control_scroll (float);
1034         void control_select (uint32_t rid, Selection::Operation);
1035         void control_unselect ();
1036         void access_action (std::string,std::string);
1037         bool deferred_control_scroll (framepos_t);
1038         sigc::connection control_scroll_connection;
1039
1040         gdouble get_trackview_group_vertical_offset () const { return vertical_adjustment.get_value (); }
1041
1042         ArdourCanvas::Group* get_background_group () const { return _background_group; }
1043         ArdourCanvas::Group* get_trackview_group () const { return _trackview_group; }
1044         void tie_vertical_scrolling ();
1045         void set_horizontal_position (double);
1046         double horizontal_position () const;
1047
1048         struct VisualChange {
1049                 enum Type {
1050                         TimeOrigin = 0x1,
1051                         ZoomLevel = 0x2,
1052                         YOrigin = 0x4
1053                 };
1054
1055                 Type pending;
1056                 framepos_t time_origin;
1057                 double frames_per_pixel;
1058                 double y_origin;
1059
1060                 int idle_handler_id;
1061                 /** true if we are currently in the idle handler */
1062                 bool being_handled;
1063
1064                 VisualChange() : pending ((VisualChange::Type) 0), time_origin (0), frames_per_pixel (0), idle_handler_id (-1), being_handled (false) {}
1065                 void add (Type t) {
1066                         pending = Type (pending | t);
1067                 }
1068         };
1069
1070         VisualChange pending_visual_change;
1071
1072         static int _idle_visual_changer (void *arg);
1073         int idle_visual_changer ();
1074         void ensure_visual_change_idle_handler ();
1075
1076         /* track views */
1077         TrackViewList track_views;
1078         std::pair<TimeAxisView*, double> trackview_by_y_position (double);
1079         TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const;
1080
1081         TrackViewList get_tracks_for_range_action () const;
1082
1083         sigc::connection super_rapid_screen_update_connection;
1084         framepos_t last_update_frame;
1085         void center_screen_internal (framepos_t, float);
1086
1087         void super_rapid_screen_update ();
1088
1089         void session_going_away ();
1090
1091         framepos_t cut_buffer_start;
1092         framecnt_t cut_buffer_length;
1093
1094         Gdk::Cursor* pre_press_cursor;
1095         boost::weak_ptr<ARDOUR::Trimmable> _trimmable;
1096         boost::weak_ptr<ARDOUR::Movable> _movable;
1097
1098         bool typed_event (ArdourCanvas::Item*, GdkEvent*, ItemType);
1099         bool button_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1100         bool button_press_handler_1 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1101         bool button_press_handler_2 (ArdourCanvas::Item *, GdkEvent *, ItemType);
1102         bool button_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1103         bool button_press_dispatch (GdkEventButton*);
1104         bool button_release_dispatch (GdkEventButton*);
1105         bool motion_handler (ArdourCanvas::Item*, GdkEvent*, bool from_autoscroll = false);
1106         bool enter_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1107         bool leave_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1108         bool key_press_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1109         bool key_release_handler (ArdourCanvas::Item*, GdkEvent*, ItemType);
1110
1111         Gtkmm2ext::Bindings* button_bindings;
1112         XMLNode* button_settings () const;
1113
1114         /* KEYMAP HANDLING */
1115
1116         void register_actions ();
1117         void register_region_actions ();
1118
1119         void load_bindings ();
1120         Gtkmm2ext::ActionMap editor_action_map;
1121         Gtkmm2ext::Bindings  key_bindings;
1122
1123         int ensure_cursor (framepos_t* pos);
1124
1125         void cut_copy (Editing::CutCopyOp);
1126         bool can_cut_copy () const;
1127         void cut_copy_points (Editing::CutCopyOp);
1128         void cut_copy_regions (Editing::CutCopyOp, RegionSelection&);
1129         void cut_copy_ranges (Editing::CutCopyOp);
1130         void cut_copy_midi (Editing::CutCopyOp);
1131
1132         void mouse_paste ();
1133         void paste_internal (framepos_t position, float times);
1134
1135         /* EDITING OPERATIONS */
1136
1137         void reset_point_selection ();
1138         void toggle_region_lock ();
1139         void toggle_opaque_region ();
1140         void toggle_record_enable ();
1141         void toggle_solo ();
1142         void toggle_solo_isolate ();
1143         void toggle_mute ();
1144         void toggle_region_lock_style ();
1145
1146         enum LayerOperation {
1147                 Raise,
1148                 RaiseToTop,
1149                 Lower,
1150                 LowerToBottom
1151         };
1152
1153         void do_layer_operation (LayerOperation);
1154         void raise_region ();
1155         void raise_region_to_top ();
1156         void change_region_layering_order (bool from_context_menu);
1157         void lower_region ();
1158         void lower_region_to_bottom ();
1159         void split_regions_at (framepos_t, RegionSelection&);
1160         void split_region_at_transients ();
1161         void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false);
1162         void crop_region_to_selection ();
1163         void crop_region_to (framepos_t start, framepos_t end);
1164         void set_sync_point (framepos_t, const RegionSelection&);
1165         void set_region_sync_position ();
1166         void remove_region_sync();
1167         void align_regions (ARDOUR::RegionPoint);
1168         void align_regions_relative (ARDOUR::RegionPoint point);
1169         void align_region (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1170         void align_region_internal (boost::shared_ptr<ARDOUR::Region>, ARDOUR::RegionPoint point, framepos_t position);
1171         void remove_selected_regions ();
1172         void remove_clicked_region ();
1173         void show_region_properties ();
1174         void show_midi_list_editor ();
1175         void rename_region ();
1176         void duplicate_some_regions (RegionSelection&, float times);
1177         void duplicate_selection (float times);
1178         void region_fill_selection ();
1179         void combine_regions ();
1180         void uncombine_regions ();
1181
1182         void region_fill_track ();
1183         void audition_playlist_region_standalone (boost::shared_ptr<ARDOUR::Region>);
1184         void audition_playlist_region_via_route (boost::shared_ptr<ARDOUR::Region>, ARDOUR::Route&);
1185         void split_multichannel_region();
1186         void reverse_region ();
1187         void strip_region_silence ();
1188         void normalize_region ();
1189         void reset_region_scale_amplitude ();
1190         void adjust_region_gain (bool up);
1191         void quantize_region ();
1192         void insert_patch_change (bool from_context);
1193         void fork_region ();
1194
1195         void do_insert_time ();
1196         void insert_time (framepos_t, framecnt_t, Editing::InsertTimeOption, bool, bool, bool, bool, bool, bool);
1197
1198         void tab_to_transient (bool forward);
1199
1200         void set_tempo_from_region ();
1201         void use_range_as_bar ();
1202
1203         void define_one_bar (framepos_t start, framepos_t end);
1204
1205         void audition_region_from_region_list ();
1206         void hide_region_from_region_list ();
1207         void show_region_in_region_list ();
1208
1209         void naturalize_region ();
1210
1211         void reset_focus ();
1212
1213         void split_region ();
1214
1215         void delete_ ();
1216         void cut ();
1217         void copy ();
1218         void paste (float times, bool from_context_menu = false);
1219
1220         void place_transient ();
1221         void remove_transient (ArdourCanvas::Item* item);
1222         void snap_regions_to_grid ();
1223         void close_region_gaps ();
1224
1225         void keyboard_paste ();
1226
1227         void region_from_selection ();
1228         void create_region_from_selection (std::vector<boost::shared_ptr<ARDOUR::Region> >&);
1229
1230         void play_from_start ();
1231         void play_from_edit_point ();
1232         void play_from_edit_point_and_return ();
1233         void play_selected_region ();
1234         void play_edit_range ();
1235         void play_location (ARDOUR::Location&);
1236         void loop_location (ARDOUR::Location&);
1237
1238         void temporal_zoom_selection ();
1239         void temporal_zoom_region (bool both_axes);
1240         void zoom_to_region (bool both_axes);
1241         void temporal_zoom_session ();
1242         void temporal_zoom (double scale);
1243         void temporal_zoom_by_frame (framepos_t start, framepos_t end);
1244         void temporal_zoom_to_frame (bool coarser, framepos_t frame);
1245
1246         void insert_region_list_drag (boost::shared_ptr<ARDOUR::Region>, int x, int y);
1247         void insert_region_list_selection (float times);
1248
1249         void insert_route_list_drag (boost::shared_ptr<ARDOUR::Route>, int x, int y);
1250
1251         /* import & embed */
1252
1253         void add_external_audio_action (Editing::ImportMode);
1254         void external_audio_dialog ();
1255         void session_import_dialog ();
1256
1257         int  check_whether_and_how_to_import(std::string, bool all_or_nothing = true);
1258         bool check_multichannel_status (const std::vector<std::string>& paths);
1259
1260         SoundFileOmega* sfbrowser;
1261
1262         void bring_in_external_audio (Editing::ImportMode mode,  framepos_t& pos);
1263
1264         bool  idle_drop_paths  (std::vector<std::string> paths, framepos_t frame, double ypos, bool copy);
1265         void  drop_paths_part_two  (const std::vector<std::string>& paths, framepos_t frame, double ypos, bool copy);
1266
1267         int  import_sndfiles (std::vector<std::string> paths, Editing::ImportMode mode,  ARDOUR::SrcQuality, framepos_t& pos,
1268                               int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>&, bool);
1269         int  embed_sndfiles (std::vector<std::string> paths, bool multiple_files, bool& check_sample_rate, Editing::ImportMode mode,
1270                              framepos_t& pos, int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>&);
1271
1272         int add_sources (std::vector<std::string> paths, ARDOUR::SourceList& sources, framepos_t& pos, Editing::ImportMode,
1273                          int target_regions, int target_tracks, boost::shared_ptr<ARDOUR::Track>&, bool add_channel_suffix);
1274         int finish_bringing_in_material (boost::shared_ptr<ARDOUR::Region> region, uint32_t, uint32_t,  framepos_t& pos, Editing::ImportMode mode,
1275                                       boost::shared_ptr<ARDOUR::Track>& existing_track);
1276
1277         boost::shared_ptr<ARDOUR::AudioTrack> get_nth_selected_audio_track (int nth) const;
1278         boost::shared_ptr<ARDOUR::MidiTrack> get_nth_selected_midi_track (int nth) const;
1279
1280         void toggle_midi_input_active (bool flip_others);
1281
1282         ARDOUR::InterThreadInfo* current_interthread_info;
1283
1284         AnalysisWindow* analysis_window;
1285
1286         /* import specific info */
1287
1288         struct EditorImportStatus : public ARDOUR::ImportStatus {
1289             Editing::ImportMode mode;
1290             framepos_t pos;
1291             int target_tracks;
1292             int target_regions;
1293             boost::shared_ptr<ARDOUR::Track> track;
1294             bool replace;
1295         };
1296
1297         EditorImportStatus import_status;
1298         static void *_import_thread (void *);
1299         void* import_thread ();
1300         void finish_import ();
1301
1302         /* to support this ... */
1303
1304         void import_audio (bool as_tracks);
1305         void do_import (std::vector<std::string> paths, bool split, bool as_tracks);
1306
1307         void move_to_start ();
1308         void move_to_end ();
1309         void center_playhead ();
1310         void center_edit_point ();
1311         void playhead_forward_to_grid ();
1312         void playhead_backward_to_grid ();
1313         void scroll_playhead (bool forward);
1314         void scroll_backward (float pages=0.8f);
1315         void scroll_forward (float pages=0.8f);
1316         void scroll_tracks_down ();
1317         void scroll_tracks_up ();
1318         void set_mark ();
1319         void clear_markers ();
1320         void clear_ranges ();
1321         void clear_locations ();
1322         void unhide_markers ();
1323         void unhide_ranges ();
1324         void jump_forward_to_mark ();
1325         void jump_backward_to_mark ();
1326         void cursor_align (bool playhead_to_edit);
1327
1328         void remove_last_capture ();
1329         void select_all_selectables_using_time_selection ();
1330         void select_all_selectables_using_loop();
1331         void select_all_selectables_using_punch();
1332         void set_selection_from_range (ARDOUR::Location&);
1333         void set_selection_from_punch ();
1334         void set_selection_from_loop ();
1335         void set_selection_from_region ();
1336
1337         void add_location_mark (framepos_t where);
1338         void add_location_from_region ();
1339         void add_locations_from_region ();
1340         void add_location_from_selection ();
1341         void set_loop_from_selection (bool play);
1342         void set_punch_from_selection ();
1343         void set_punch_from_region ();
1344
1345         void set_loop_from_edit_range (bool play);
1346         void set_loop_from_region (bool play);
1347         void set_punch_from_edit_range ();
1348
1349         void set_loop_range (framepos_t start, framepos_t end, std::string cmd);
1350         void set_punch_range (framepos_t start, framepos_t end, std::string cmd);
1351
1352         void add_location_from_playhead_cursor ();
1353         bool select_new_marker;
1354
1355         void reverse_selection ();
1356         void edit_envelope ();
1357
1358         double last_scrub_x;
1359         int scrubbing_direction;
1360         int scrub_reversals;
1361         int scrub_reverse_distance;
1362         void scrub (framepos_t, double);
1363
1364         void keyboard_selection_begin ();
1365         void keyboard_selection_finish (bool add);
1366         bool have_pending_keyboard_selection;
1367         framepos_t pending_keyboard_selection_start;
1368
1369         void move_range_selection_start_or_end_to_region_boundary (bool, bool);
1370
1371         Editing::SnapType _snap_type;
1372         Editing::SnapMode _snap_mode;
1373
1374         /// Snap threshold in pixels
1375         double snap_threshold;
1376
1377         bool ignore_gui_changes;
1378
1379         DragManager* _drags;
1380
1381         void escape ();
1382
1383         Gtk::Menu fade_context_menu;
1384         void popup_fade_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1385
1386         Gtk::Menu xfade_in_context_menu;
1387         Gtk::Menu xfade_out_context_menu;
1388         void popup_xfade_in_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1389         void popup_xfade_out_context_menu (int, int, ArdourCanvas::Item*, ItemType);
1390         void fill_xfade_menu (Gtk::Menu_Helpers::MenuList& items, bool start);
1391
1392         void set_fade_in_shape (ARDOUR::FadeShape);
1393         void set_fade_out_shape (ARDOUR::FadeShape);
1394
1395         void set_fade_length (bool in);
1396         void set_fade_in_active (bool);
1397         void set_fade_out_active (bool);
1398
1399         std::set<boost::shared_ptr<ARDOUR::Playlist> > motion_frozen_playlists;
1400
1401         bool _dragging_playhead;
1402         bool _dragging_edit_point;
1403
1404         void marker_drag_motion_callback (GdkEvent*);
1405         void marker_drag_finished_callback (GdkEvent*);
1406
1407         gint mouse_rename_region (ArdourCanvas::Item*, GdkEvent*);
1408
1409         void add_region_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1410         void start_create_region_grab (ArdourCanvas::Item*, GdkEvent*);
1411         void add_region_copy_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1412         void add_region_brush_drag (ArdourCanvas::Item*, GdkEvent*, RegionView*);
1413         void start_selection_grab (ArdourCanvas::Item*, GdkEvent*);
1414
1415         void region_view_item_click (AudioRegionView&, GdkEventButton*);
1416
1417         bool can_remove_control_point (ArdourCanvas::Item *);
1418         void remove_control_point (ArdourCanvas::Item *);
1419
1420         void mouse_brush_insert_region (RegionView*, framepos_t pos);
1421
1422         /* Canvas event handlers */
1423
1424         bool canvas_control_point_event (GdkEvent* event,ArdourCanvas::Item*, ControlPoint*);
1425         bool canvas_line_event (GdkEvent* event,ArdourCanvas::Item*, AutomationLine*);
1426         bool canvas_selection_rect_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1427         bool canvas_selection_start_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1428         bool canvas_selection_end_trim_event (GdkEvent* event,ArdourCanvas::Item*, SelectionRect*);
1429         bool canvas_start_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1430         bool canvas_end_xfade_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1431         bool canvas_fade_in_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1432         bool canvas_fade_in_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1433         bool canvas_fade_out_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1434         bool canvas_fade_out_handle_event (GdkEvent* event,ArdourCanvas::Item*, AudioRegionView*);
1435         bool canvas_region_view_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1436         bool canvas_frame_handle_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1437         bool canvas_region_view_name_highlight_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1438         bool canvas_region_view_name_event (GdkEvent* event,ArdourCanvas::Item*, RegionView*);
1439         bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*);
1440         bool canvas_stream_view_event (GdkEvent* event,ArdourCanvas::Item*, RouteTimeAxisView*);
1441         bool canvas_marker_event (GdkEvent* event,ArdourCanvas::Item*, Marker*);
1442         bool canvas_zoom_rect_event (GdkEvent* event,ArdourCanvas::Item*);
1443         bool canvas_tempo_marker_event (GdkEvent* event,ArdourCanvas::Item*, TempoMarker*);
1444         bool canvas_meter_marker_event (GdkEvent* event,ArdourCanvas::Item*, MeterMarker*);
1445         bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*);
1446         bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item *);
1447
1448         bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1449         bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1450         bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1451         bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1452         bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1453         bool canvas_cd_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1454
1455         bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*);
1456         void update_video_timeline (bool flush = false);
1457         void set_video_timeline_height (const int);
1458         bool is_video_timeline_locked ();
1459         void toggle_video_timeline_locked ();
1460         void set_video_timeline_locked (const bool);
1461         void queue_visual_videotimeline_update ();
1462         void embed_audio_from_video (std::string, framepos_t n = 0);
1463
1464         bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1465         bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*);
1466         bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1467         bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*);
1468         bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*);
1469         bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1470         bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1471         bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*);
1472
1473         PBD::Signal0<void> EditorFreeze;
1474         PBD::Signal0<void> EditorThaw;
1475
1476   private:
1477         friend class DragManager;
1478         friend class EditorRouteGroups;
1479         friend class EditorRegions;
1480
1481         /** true if the mouse is over a place where region trim can happen */
1482         bool _over_region_trim_target;
1483
1484         /* non-public event handlers */
1485
1486         bool canvas_playhead_cursor_event (GdkEvent* event, ArdourCanvas::Item*);
1487         bool track_canvas_scroll (GdkEventScroll* event);
1488
1489         bool track_canvas_scroll_event (GdkEventScroll* event);
1490         bool track_canvas_button_press_event (GdkEventButton* event);
1491         bool track_canvas_button_release_event (GdkEventButton* event);
1492         bool track_canvas_motion_notify_event (GdkEventMotion* event);
1493
1494         Gtk::Allocation _canvas_viewport_allocation;
1495         void track_canvas_viewport_allocate (Gtk::Allocation alloc);
1496         bool track_canvas_viewport_size_allocated ();
1497         bool track_canvas_drag_motion (Glib::RefPtr<Gdk::DragContext> const &, int, int, guint);
1498         bool track_canvas_key_press (GdkEventKey *);
1499         bool track_canvas_key_release (GdkEventKey *);
1500
1501         void set_playhead_cursor ();
1502
1503         void toggle_region_mute ();
1504
1505         void initialize_canvas ();
1506
1507         /* display control */
1508
1509         bool _show_measures;
1510         /// true if the editor should follow the playhead, otherwise false
1511         bool _follow_playhead;
1512         /// true if we scroll the tracks rather than the playhead
1513         bool _stationary_playhead;
1514         /// true if we are in fullscreen mode
1515         bool _maximised;
1516
1517         TempoLines* tempo_lines;
1518
1519         ArdourCanvas::Group* time_line_group;
1520
1521         void hide_measures ();
1522         void draw_measures (ARDOUR::TempoMap::BBTPointList::const_iterator& begin,
1523                             ARDOUR::TempoMap::BBTPointList::const_iterator& end);
1524         bool redraw_measures ();
1525
1526         void new_tempo_section ();
1527
1528         void mouse_add_new_tempo_event (framepos_t where);
1529         void mouse_add_new_meter_event (framepos_t where);
1530
1531         void remove_tempo_marker (ArdourCanvas::Item*);
1532         void remove_meter_marker (ArdourCanvas::Item*);
1533         gint real_remove_tempo_marker (ARDOUR::TempoSection*);
1534         gint real_remove_meter_marker (ARDOUR::MeterSection*);
1535
1536         void edit_tempo_section (ARDOUR::TempoSection*);
1537         void edit_meter_section (ARDOUR::MeterSection*);
1538         void edit_tempo_marker (ArdourCanvas::Item*);
1539         void edit_meter_marker (ArdourCanvas::Item*);
1540         void edit_control_point (ArdourCanvas::Item*);
1541         void edit_notes (std::set<NoteBase*> const & s);
1542
1543         void marker_menu_edit ();
1544         void marker_menu_remove ();
1545         void marker_menu_rename ();
1546         void toggle_marker_menu_lock ();
1547         void toggle_marker_menu_glue ();
1548         void marker_menu_hide ();
1549         void marker_menu_loop_range ();
1550         void marker_menu_select_all_selectables_using_range ();
1551         void marker_menu_select_using_range ();
1552         void marker_menu_separate_regions_using_location ();
1553         void marker_menu_play_from ();
1554         void marker_menu_play_range ();
1555         void marker_menu_set_playhead ();
1556         void marker_menu_set_from_playhead ();
1557         void marker_menu_set_from_selection (bool force_regions);
1558         void marker_menu_range_to_next ();
1559         void marker_menu_zoom_to_range ();
1560         void new_transport_marker_menu_set_loop ();
1561         void new_transport_marker_menu_set_punch ();
1562         void update_loop_range_view (bool visibility=false);
1563         void update_punch_range_view (bool visibility=false);
1564         void new_transport_marker_menu_popdown ();
1565         void marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1566         void tempo_or_meter_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1567         void new_transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1568         void build_range_marker_menu (bool, bool);
1569         void build_marker_menu (ARDOUR::Location *);
1570         void build_tempo_or_meter_marker_menu (bool);
1571         void build_new_transport_marker_menu ();
1572         void dynamic_cast_marker_object (void*, MeterMarker**, TempoMarker**) const;
1573
1574         Gtk::Menu* tempo_or_meter_marker_menu;
1575         Gtk::Menu* marker_menu;
1576         Gtk::Menu* range_marker_menu;
1577         Gtk::Menu* transport_marker_menu;
1578         Gtk::Menu* new_transport_marker_menu;
1579         Gtk::Menu* cd_marker_menu;
1580         ArdourCanvas::Item* marker_menu_item;
1581
1582         typedef std::list<Marker*> Marks;
1583         Marks metric_marks;
1584
1585         void remove_metric_marks ();
1586         void draw_metric_marks (const ARDOUR::Metrics& metrics);
1587
1588         void compute_current_bbt_points (framepos_t left, framepos_t right, 
1589                                          ARDOUR::TempoMap::BBTPointList::const_iterator& begin,
1590                                          ARDOUR::TempoMap::BBTPointList::const_iterator& end);
1591
1592         void tempo_map_changed (const PBD::PropertyChange&);
1593         void redisplay_tempo (bool immediate_redraw);
1594
1595         uint32_t bbt_beat_subdivision;
1596
1597         /* toolbar */
1598
1599         Gtk::ToggleButton editor_mixer_button;
1600         Gtk::ToggleButton editor_list_button;
1601         void editor_mixer_button_toggled ();
1602         void editor_list_button_toggled ();
1603
1604         AudioClock*               zoom_range_clock;
1605
1606         ArdourButton              zoom_in_button;
1607         ArdourButton              zoom_out_button;
1608         ArdourButton              zoom_out_full_button;
1609
1610         ArdourButton              tav_expand_button;
1611         ArdourButton              tav_shrink_button;
1612
1613         Gtk::VBox                toolbar_clock_vbox;
1614         Gtk::VBox                toolbar_selection_clock_vbox;
1615         Gtk::Table               toolbar_selection_clock_table;
1616         Gtk::Label               toolbar_selection_cursor_label;
1617
1618         Gtkmm2ext::TearOff*      _mouse_mode_tearoff;
1619         ArdourButton mouse_select_button;
1620         ArdourButton mouse_draw_button;
1621         ArdourButton mouse_move_button;
1622         ArdourButton mouse_gain_button;
1623         ArdourButton mouse_zoom_button;
1624         ArdourButton mouse_timefx_button;
1625         ArdourButton mouse_audition_button;
1626
1627         ArdourButton smart_mode_button;
1628         Glib::RefPtr<Gtk::ToggleAction> smart_mode_action;
1629
1630         void                     mouse_mode_toggled (Editing::MouseMode m);
1631         void                     mouse_mode_object_range_toggled ();
1632         bool                     ignore_mouse_mode_toggle;
1633
1634         ArdourButton internal_edit_button;
1635         void         toggle_internal_editing ();
1636
1637         bool                     mouse_select_button_release (GdkEventButton*);
1638
1639         Gtk::VBox                automation_box;
1640         Gtk::Button              automation_mode_button;
1641
1642         Gtk::ComboBoxText edit_mode_selector;
1643         Gtk::VBox         edit_mode_box;
1644         std::vector<std::string> edit_mode_strings;
1645
1646         void set_edit_mode (ARDOUR::EditMode);
1647         void cycle_edit_mode ();
1648         void edit_mode_selection_done ();
1649
1650         Gtk::ComboBoxText snap_type_selector;
1651         Gtk::ComboBoxText snap_mode_selector;
1652         Gtk::HBox         snap_box;
1653
1654         std::vector<std::string> snap_type_strings;
1655         std::vector<std::string> snap_mode_strings;
1656
1657         void snap_type_selection_done ();
1658         void snap_mode_selection_done ();
1659         void snap_mode_chosen (Editing::SnapMode);
1660         void snap_type_chosen (Editing::SnapType);
1661
1662         Glib::RefPtr<Gtk::RadioAction> snap_type_action (Editing::SnapType);
1663         Glib::RefPtr<Gtk::RadioAction> snap_mode_action (Editing::SnapMode);
1664
1665         Gtk::ComboBoxText zoom_focus_selector;
1666         Gtk::VBox         zoom_focus_box;
1667
1668         std::vector<std::string> zoom_focus_strings;
1669
1670         void zoom_focus_selection_done ();
1671         void zoom_focus_chosen (Editing::ZoomFocus);
1672
1673         Glib::RefPtr<Gtk::RadioAction> zoom_focus_action (Editing::ZoomFocus);
1674
1675         Gtk::HBox           _zoom_box;
1676         Gtkmm2ext::TearOff* _zoom_tearoff;
1677         void                zoom_adjustment_changed();
1678
1679         void setup_toolbar ();
1680
1681         void setup_tooltips ();
1682
1683         Gtkmm2ext::TearOff*     _tools_tearoff;
1684         Gtk::HBox                toolbar_hbox;
1685         Gtk::EventBox            toolbar_base;
1686         Gtk::Frame               toolbar_frame;
1687         Gtk::Viewport           _toolbar_viewport;
1688
1689         /* midi toolbar */
1690
1691         Gtk::HBox                panic_box;
1692
1693         void setup_midi_toolbar ();
1694
1695         /* selection process */
1696
1697         Selection* selection;
1698         Selection* cut_buffer;
1699
1700         void time_selection_changed ();
1701         void track_selection_changed ();
1702         void region_selection_changed ();
1703         sigc::connection editor_regions_selection_changed_connection;
1704         void sensitize_all_region_actions (bool);
1705         void sensitize_the_right_region_actions ();
1706         bool _all_region_actions_sensitized;
1707         /** Flag to block region action handlers from doing what they normally do;
1708          *  I tried Gtk::Action::block_activate() but this doesn't work (ie it doesn't
1709          *  block) when setting a ToggleAction's active state.
1710          */
1711         bool _ignore_region_action;
1712         bool _last_region_menu_was_main;
1713         void point_selection_changed ();
1714         void marker_selection_changed ();
1715
1716         void cancel_selection ();
1717         void cancel_time_selection ();
1718
1719         bool get_smart_mode() const;
1720
1721         bool audio_region_selection_covers (framepos_t where);
1722
1723         /* transport range select process */
1724
1725         ArdourCanvas::Rectangle*  cd_marker_bar_drag_rect;
1726         ArdourCanvas::Rectangle*  range_bar_drag_rect;
1727         ArdourCanvas::Rectangle*  transport_bar_drag_rect;
1728
1729 #ifdef GTKOSX
1730         ArdourCanvas::Rectangle     *bogus_background_rect;
1731 #endif
1732         ArdourCanvas::Rectangle     *transport_bar_range_rect;
1733         ArdourCanvas::Rectangle     *transport_bar_preroll_rect;
1734         ArdourCanvas::Rectangle     *transport_bar_postroll_rect;
1735         ArdourCanvas::Rectangle     *transport_loop_range_rect;
1736         ArdourCanvas::Rectangle     *transport_punch_range_rect;
1737         ArdourCanvas::Line     *transport_punchin_line;
1738         ArdourCanvas::Line     *transport_punchout_line;
1739         ArdourCanvas::Rectangle     *transport_preroll_rect;
1740         ArdourCanvas::Rectangle     *transport_postroll_rect;
1741
1742         ARDOUR::Location*  transport_loop_location();
1743         ARDOUR::Location*  transport_punch_location();
1744
1745         ARDOUR::Location   *temp_location;
1746
1747         /* object rubberband select process */
1748
1749         void select_all_within (framepos_t, framepos_t, double, double, TrackViewList const &, Selection::Operation, bool);
1750
1751         ArdourCanvas::Rectangle   *rubberband_rect;
1752
1753         /* mouse zoom process */
1754
1755         ArdourCanvas::Rectangle   *zoom_rect;
1756         void reposition_zoom_rect (framepos_t start, framepos_t end);
1757
1758         EditorRouteGroups* _route_groups;
1759         EditorRoutes* _routes;
1760         EditorRegions* _regions;
1761         EditorSnapshots* _snapshots;
1762         EditorLocations* _locations;
1763
1764         /* diskstream/route display management */
1765         Glib::RefPtr<Gdk::Pixbuf> rec_enabled_icon;
1766         Glib::RefPtr<Gdk::Pixbuf> rec_disabled_icon;
1767
1768         Glib::RefPtr<Gtk::TreeSelection> route_display_selection;
1769
1770         bool sync_track_view_list_and_routes ();
1771
1772         Gtk::VBox           list_vpacker;
1773
1774         /* autoscrolling */
1775
1776         bool autoscroll_active;
1777         int autoscroll_timeout_tag;
1778         int autoscroll_x;
1779         int autoscroll_y;
1780         int last_autoscroll_x;
1781         int last_autoscroll_y;
1782         uint32_t autoscroll_cnt;
1783         framecnt_t autoscroll_x_distance;
1784         double autoscroll_y_distance;
1785
1786         bool _autoscroll_fudging;
1787         int autoscroll_fudge_threshold () const;
1788
1789         static gint _autoscroll_canvas (void *);
1790         bool autoscroll_canvas ();
1791         void start_canvas_autoscroll (int x, int y);
1792         void stop_canvas_autoscroll ();
1793
1794         /* trimming */
1795         void point_trim (GdkEvent *, framepos_t);
1796
1797         void trim_region_front();
1798         void trim_region_back();
1799         void trim_region (bool front);
1800
1801         void trim_region_to_loop ();
1802         void trim_region_to_punch ();
1803         void trim_region_to_location (const ARDOUR::Location&, const char* cmd);
1804
1805         void trim_to_region(bool forward);
1806         void trim_region_to_previous_region_end();
1807         void trim_region_to_next_region_start();
1808
1809         bool show_gain_after_trim;
1810
1811         /* Drag-n-Drop */
1812
1813         int convert_drop_to_paths (
1814                 std::vector<std::string>&           paths,
1815                 const Glib::RefPtr<Gdk::DragContext>& context,
1816                 gint                                  x,
1817                 gint                                  y,
1818                 const Gtk::SelectionData&             data,
1819                 guint                                 info,
1820                 guint                                 time);
1821
1822         void track_canvas_drag_data_received (
1823                 const Glib::RefPtr<Gdk::DragContext>& context,
1824                 gint                                  x,
1825                 gint                                  y,
1826                 const Gtk::SelectionData&             data,
1827                 guint                                 info,
1828                 guint                                 time);
1829
1830         void drop_paths (
1831                 const Glib::RefPtr<Gdk::DragContext>& context,
1832                 gint                                  x,
1833                 gint                                  y,
1834                 const Gtk::SelectionData&             data,
1835                 guint                                 info,
1836                 guint                                 time);
1837
1838         void drop_regions (
1839                 const Glib::RefPtr<Gdk::DragContext>& context,
1840                 gint                                  x,
1841                 gint                                  y,
1842                 const Gtk::SelectionData&             data,
1843                 guint                                 info,
1844                 guint                                 time);
1845
1846         void drop_routes (
1847                 const Glib::RefPtr<Gdk::DragContext>& context,
1848                 gint                x,
1849                 gint                y,
1850                 const Gtk::SelectionData& data,
1851                 guint               info,
1852                 guint               time);
1853
1854         /* audio export */
1855
1856         int  write_region_selection(RegionSelection&);
1857         bool write_region (std::string path, boost::shared_ptr<ARDOUR::AudioRegion>);
1858         void bounce_region_selection (bool with_processing);
1859         void bounce_range_selection (bool replace, bool enable_processing);
1860         void external_edit_region ();
1861
1862         int write_audio_selection (TimeSelection&);
1863         bool write_audio_range (ARDOUR::AudioPlaylist&, const ARDOUR::ChanCount& channels, std::list<ARDOUR::AudioRange>&);
1864
1865         void write_selection ();
1866
1867         XMLNode *before; /* used in *_reversible_command */
1868
1869         void update_title ();
1870         void update_title_s (const std::string & snapshot_name);
1871
1872         void instant_save ();
1873
1874         boost::shared_ptr<ARDOUR::AudioRegion> last_audition_region;
1875
1876         /* freeze operations */
1877
1878         ARDOUR::InterThreadInfo freeze_status;
1879         static void* _freeze_thread (void*);
1880         void* freeze_thread ();
1881
1882         void freeze_route ();
1883         void unfreeze_route ();
1884
1885         /* duplication */
1886
1887         void duplicate_range (bool with_dialog);
1888
1889         framepos_t event_frame (GdkEvent const *, double* px = 0, double* py = 0) const;
1890
1891         /* returns false if mouse pointer is not in track or marker canvas
1892          */
1893         bool mouse_frame (framepos_t&, bool& in_track_canvas) const;
1894
1895         TimeFXDialog* current_timefx;
1896         static void* timefx_thread (void *arg);
1897         void do_timefx ();
1898
1899         int time_stretch (RegionSelection&, float fraction);
1900         int pitch_shift (RegionSelection&, float cents);
1901         void pitch_shift_region ();
1902
1903         void transpose_region ();
1904
1905         /* editor-mixer strip */
1906
1907         MixerStrip *current_mixer_strip;
1908         bool show_editor_mixer_when_tracks_arrive;
1909         Gtk::VBox current_mixer_strip_vbox;
1910         void cms_new (boost::shared_ptr<ARDOUR::Route>);
1911         void current_mixer_strip_hidden ();
1912
1913         void detach_tearoff (Gtk::Box* b, Gtk::Window* w);
1914         void reattach_tearoff (Gtk::Box* b, Gtk::Window* w, int32_t n);
1915 #ifdef GTKOSX
1916         void ensure_all_elements_drawn ();
1917 #endif
1918         /* nudging tracks */
1919
1920         void nudge_track (bool use_edit_point, bool forwards);
1921
1922 #ifdef WITH_CMT
1923         void handle_new_imageframe_time_axis_view(const std::string & track_name, void* src) ;
1924         void handle_new_imageframe_marker_time_axis_view(const std::string & track_name, TimeAxisView* marked_track) ;
1925
1926         void start_imageframe_grab(ArdourCanvas::Item*, GdkEvent*) ;
1927         void start_markerview_grab(ArdourCanvas::Item*, GdkEvent*) ;
1928
1929         void imageframe_drag_motion_callback(ArdourCanvas::Item*, GdkEvent*) ;
1930         void markerview_drag_motion_callback(ArdourCanvas::Item*, GdkEvent*) ;
1931         void timeaxis_item_drag_finished_callback(ArdourCanvas::Item*, GdkEvent*) ;
1932
1933         gint canvas_imageframe_item_view_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
1934         gint canvas_imageframe_view_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameTimeAxis* ifta);
1935         gint canvas_imageframe_start_handle_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
1936         gint canvas_imageframe_end_handle_event(ArdourCanvas::Item* item, GdkEvent* event, ImageFrameView* ifv);
1937
1938         gint canvas_marker_time_axis_view_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerTimeAxis* mta);
1939         gint canvas_markerview_item_view_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
1940         gint canvas_markerview_start_handle_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
1941         gint canvas_markerview_end_handle_event(ArdourCanvas::Item* item, GdkEvent* event, MarkerView* mv);
1942
1943         void imageframe_start_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
1944         void imageframe_end_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
1945         void imageframe_start_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
1946         void imageframe_start_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
1947         void imageframe_end_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
1948         void imageframe_end_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
1949
1950         void markerview_item_start_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
1951         void markerview_item_end_handle_op(ArdourCanvas::Item* item, GdkEvent* event) ;
1952         void markerview_start_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
1953         void markerview_start_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
1954         void markerview_end_handle_trim_motion(ArdourCanvas::Item* item, GdkEvent* event) ;
1955         void markerview_end_handle_end_trim(ArdourCanvas::Item* item, GdkEvent* event) ;
1956
1957         void popup_imageframe_edit_menu(int button, int32_t time, ArdourCanvas::Item* ifv, bool with_frame) ;
1958         void popup_marker_time_axis_edit_menu(int button, int32_t time, ArdourCanvas::Item* ifv, bool with_frame) ;
1959
1960         ImageFrameSocketHandler* image_socket_listener ;
1961 #endif
1962
1963         static const int32_t default_width = 995;
1964         static const int32_t default_height = 765;
1965
1966         /* nudge */
1967
1968         ArdourButton      nudge_forward_button;
1969         ArdourButton      nudge_backward_button;
1970         Gtk::HBox        nudge_hbox;
1971         Gtk::VBox        nudge_vbox;
1972         AudioClock*       nudge_clock;
1973
1974         bool nudge_forward_release (GdkEventButton*);
1975         bool nudge_backward_release (GdkEventButton*);
1976
1977         /* audio filters */
1978
1979         void apply_filter (ARDOUR::Filter&, std::string cmd, ProgressReporter* progress = 0);
1980
1981         Command* apply_midi_note_edit_op_to_region (ARDOUR::MidiOperator& op, MidiRegionView& mrv);
1982         void apply_midi_note_edit_op (ARDOUR::MidiOperator& op);
1983
1984         /* handling cleanup */
1985
1986         int playlist_deletion_dialog (boost::shared_ptr<ARDOUR::Playlist>);
1987
1988         PBD::ScopedConnectionList session_connections;
1989
1990         /* tracking step changes of track height */
1991
1992         TimeAxisView* current_stepping_trackview;
1993         ARDOUR::microseconds_t last_track_height_step_timestamp;
1994         gint track_height_step_timeout();
1995         sigc::connection step_timeout;
1996
1997         TimeAxisView* entered_track;
1998         /** If the mouse is over a RegionView or one of its child canvas items, this is set up
1999             to point to the RegionView.  Otherwise it is 0.
2000         */
2001         RegionView*   entered_regionview;
2002
2003         bool clear_entered_track;
2004         bool left_track_canvas (GdkEventCrossing*);
2005         bool entered_track_canvas (GdkEventCrossing*);
2006         void set_entered_track (TimeAxisView*);
2007         void set_entered_regionview (RegionView*);
2008         void ensure_track_visible (TimeAxisView*);
2009         gint left_automation_track ();
2010
2011         void reset_canvas_action_sensitivity (bool);
2012         void set_gain_envelope_visibility ();
2013         void set_region_gain_visibility (RegionView*);
2014         void toggle_gain_envelope_active ();
2015         void reset_region_gain_envelopes ();
2016
2017         bool on_key_press_event (GdkEventKey*);
2018         bool on_key_release_event (GdkEventKey*);
2019
2020         void session_state_saved (std::string);
2021
2022         Glib::RefPtr<Gtk::Action>              undo_action;
2023         Glib::RefPtr<Gtk::Action>              redo_action;
2024
2025         void history_changed ();
2026
2027         Gtk::HBox      status_bar_hpacker;
2028
2029         Editing::EditPoint _edit_point;
2030
2031         Gtk::ComboBoxText edit_point_selector;
2032
2033         void set_edit_point_preference (Editing::EditPoint ep, bool force = false);
2034         void cycle_edit_point (bool with_marker);
2035         void set_edit_point ();
2036         void edit_point_selection_done ();
2037         void edit_point_chosen (Editing::EditPoint);
2038         Glib::RefPtr<Gtk::RadioAction> edit_point_action (Editing::EditPoint);
2039         std::vector<std::string> edit_point_strings;
2040
2041         void selected_marker_moved (ARDOUR::Location*);
2042
2043         bool get_edit_op_range (framepos_t& start, framepos_t& end) const;
2044
2045         void get_regions_at (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2046         void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2047
2048         RegionSelection get_regions_from_selection_and_edit_point ();
2049         RegionSelection get_regions_from_selection_and_entered ();
2050
2051         void start_updating_meters ();
2052         void stop_updating_meters ();
2053         bool meters_running;
2054
2055         void select_next_route ();
2056         void select_prev_route ();
2057
2058         void snap_to_internal (framepos_t& first, int32_t direction = 0, bool for_mark = false);
2059         void timecode_snap_to_internal (framepos_t& first, int32_t direction = 0, bool for_mark = false);
2060
2061         RhythmFerret* rhythm_ferret;
2062
2063         void fit_tracks (TrackViewList &);
2064         void fit_selected_tracks ();
2065         void set_track_height (Height);
2066
2067         void remove_tracks ();
2068         void toggle_tracks_active ();
2069
2070         bool _have_idled;
2071         int resize_idle_id;
2072         static gboolean _idle_resize (gpointer);
2073         bool idle_resize();
2074         int32_t _pending_resize_amount;
2075         TimeAxisView* _pending_resize_view;
2076
2077         void visible_order_range (int*, int*) const;
2078
2079         void located ();
2080
2081         /** true if we've made a locate request that hasn't yet been processed */
2082         bool _pending_locate_request;
2083
2084         /** if true, there is a pending Session locate which is the initial one when loading a session;
2085             we need to know this so that we don't (necessarily) set the viewport to show the playhead
2086             initially.
2087         */
2088         bool _pending_initial_locate;
2089
2090         Gtk::HBox _summary_hbox;
2091         EditorSummary* _summary;
2092
2093         void region_view_added (RegionView *);
2094         void region_view_removed ();
2095
2096         void update_canvas_now ();
2097
2098         EditorGroupTabs* _group_tabs;
2099         void fit_route_group (ARDOUR::RouteGroup *);
2100
2101         void step_edit_status_change (bool);
2102         void start_step_editing ();
2103         void stop_step_editing ();
2104         bool check_step_edit ();
2105         sigc::connection step_edit_connection;
2106
2107         double _last_motion_y;
2108
2109         RegionLayeringOrderEditor* layering_order_editor;
2110         void update_region_layering_order_editor ();
2111
2112         /** Track that was the source for the last cut/copy operation.  Used as a place
2113             to paste things iff there is no selected track.
2114         */
2115         TimeAxisView* _last_cut_copy_source_track;
2116
2117         /** true if a change in Selection->regions should change the selection in the region list.
2118             See EditorRegions::selection_changed.
2119         */
2120         bool _region_selection_change_updates_region_list;
2121
2122         void setup_fade_images ();
2123         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_in_images;
2124         std::map<ARDOUR::FadeShape, Gtk::Image*> _fade_out_images;
2125         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_in_images;
2126         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_out_images;
2127
2128         Gtk::MenuItem& action_menu_item (std::string const &);
2129         void action_pre_activated (Glib::RefPtr<Gtk::Action> const &);
2130
2131         void set_canvas_cursor_for_region_view (double, RegionView *);
2132
2133         MouseCursors* _cursors;
2134
2135         void follow_mixer_selection ();
2136         bool _following_mixer_selection;
2137
2138         int time_fx (ARDOUR::RegionList&, float val, bool pitching);
2139
2140         void toggle_sound_midi_notes ();
2141
2142         /** Flag for a bit of a hack wrt control point selection; see set_selected_control_point_from_click */
2143         bool _control_point_toggled_on_press;
2144
2145         /** This is used by TimeAxisView to keep a track of the TimeAxisView that is currently being
2146             stepped in height using Shift-Scrollwheel.  When a scroll event occurs, we do the step on
2147             this _stepping_axis_view if it is non-0 (and we set up this _stepping_axis_view with the
2148             TimeAxisView underneath the mouse if it is 0).  Then Editor resets _stepping_axis_view when
2149             the shift key is released.  In this (hacky) way, pushing shift and moving the scroll wheel
2150             will operate on the same track until shift is released (rather than skipping about to whatever
2151             happens to be underneath the mouse at the time).
2152         */
2153         TimeAxisView* _stepping_axis_view;
2154         void shift_key_released ();
2155
2156         friend class Drag;
2157         friend class RegionDrag;
2158         friend class RegionMoveDrag;
2159         friend class RegionSpliceDrag;
2160         friend class TrimDrag;
2161         friend class MeterMarkerDrag;
2162         friend class TempoMarkerDrag;
2163         friend class CursorDrag;
2164         friend class FadeInDrag;
2165         friend class FadeOutDrag;
2166         friend class MarkerDrag;
2167         friend class RegionGainDrag;
2168         friend class ControlPointDrag;
2169         friend class LineDrag;
2170         friend class RubberbandSelectDrag;
2171         friend class EditorRubberbandSelectDrag;
2172         friend class TimeFXDrag;
2173         friend class ScrubDrag;
2174         friend class SelectionDrag;
2175         friend class RangeMarkerBarDrag;
2176         friend class MouseZoomDrag;
2177         friend class RegionCreateDrag;
2178         friend class RegionMotionDrag;
2179         friend class RegionInsertDrag;
2180         friend class VideoTimeLineDrag;
2181
2182         friend class EditorSummary;
2183         friend class EditorGroupTabs;
2184
2185         friend class EditorRoutes;
2186         friend class RhythmFerret;
2187 };
2188
2189 #endif /* __ardour_editor_h__ */