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