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