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