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