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