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