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