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