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