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