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