b43beff9bc4c0818d680f7ec70804a46c391ae38
[ardour.git] / gtk2_ardour / editor.h
1 /*
2     Copyright (C) 2000-2003 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef __ardour_editor_h__
21 #define __ardour_editor_h__
22
23 #include <sys/time.h>
24
25 #include <cmath>
26 #include <list>
27 #include <map>
28 #include <set>
29 #include <string>
30 #include <vector>
31
32 #include <boost/optional.hpp>
33
34 #include <gtkmm/comboboxtext.h>
35 #include <gtkmm/layout.h>
36
37 #include "gtkmm2ext/bindings.h"
38 #include "gtkmm2ext/dndtreeview.h"
39
40 #include "pbd/stateful.h"
41 #include "pbd/signals.h"
42
43 #include "ardour/import_status.h"
44 #include "ardour/tempo.h"
45 #include "ardour/location.h"
46 #include "ardour/types.h"
47
48 #include "canvas/fwd.h"
49 #include "canvas/ruler.h"
50
51 #include "widgets/ardour_button.h"
52 #include "widgets/ardour_dropdown.h"
53 #include "widgets/pane.h"
54
55 #include "ardour_dialog.h"
56 #include "public_editor.h"
57 #include "editing.h"
58 #include "enums.h"
59 #include "editor_items.h"
60 #include "region_selection.h"
61 #include "selection_memento.h"
62 #include "tempo_curve.h"
63
64 namespace Gtkmm2ext {
65         class Bindings;
66 }
67
68 namespace Evoral {
69         class SMF;
70 }
71
72 namespace ARDOUR {
73         class AudioPlaylist;
74         class AudioRegion;
75         class AudioTrack;
76         class ChanCount;
77         class Filter;
78         class Location;
79         class MidiOperator;
80         class MidiRegion;
81         class MidiTrack;
82         class Playlist;
83         class Region;
84         class RouteGroup;
85         class Session;
86         class TempoSection;
87         class Track;
88 }
89
90 namespace LADSPA {
91         class Plugin;
92 }
93
94 class AnalysisWindow;
95 class AudioClock;
96 class AudioRegionView;
97 class AudioStreamView;
98 class AudioTimeAxisView;
99 class AutomationLine;
100 class AutomationSelection;
101 class AutomationTimeAxisView;
102 class BundleManager;
103 class ControlPoint;
104 class CursorContext;
105 class DragManager;
106 class EditNoteDialog;
107 class EditorCursor;
108 class EditorGroupTabs;
109 class EditorLocations;
110 class EditorRegions;
111 class EditorRoutes;
112 class EditorRouteGroups;
113 class EditorSnapshots;
114 class EditorSummary;
115 class GUIObjectState;
116 class ArdourMarker;
117 class MidiRegionView;
118 class MidiExportDialog;
119 class MixerStrip;
120 class MouseCursors;
121 class NoteBase;
122 class PlaylistSelector;
123 class PluginSelector;
124 class ProgressReporter;
125 class QuantizeDialog;
126 class RhythmFerret;
127 class RulerDialog;
128 class Selection;
129 class SoundFileOmega;
130 class StreamView;
131 class TempoLines;
132 class TimeAxisView;
133 class TimeInfoBox;
134 class TimeFXDialog;
135 class TimeSelection;
136 class RegionLayeringOrderEditor;
137 class VerboseCursor;
138
139 class Editor : public PublicEditor, public PBD::ScopedConnectionList
140 {
141 public:
142         Editor ();
143         ~Editor ();
144
145         void             set_session (ARDOUR::Session *);
146
147         Gtk::Window* use_own_window (bool and_fill_it);
148
149         void             first_idle ();
150         virtual bool     have_idled () const { return _have_idled; }
151
152         framepos_t leftmost_sample() const { return leftmost_frame; }
153
154         framecnt_t current_page_samples() const {
155                 return (framecnt_t) _visible_canvas_width * samples_per_pixel;
156         }
157
158         double visible_canvas_height () const {
159                 return _visible_canvas_height;
160         }
161         double trackviews_height () const;
162
163         void cycle_snap_mode ();
164         void next_snap_choice ();
165         void next_snap_choice_music_only ();
166         void next_snap_choice_music_and_time ();
167         void prev_snap_choice ();
168         void prev_snap_choice_music_only ();
169         void prev_snap_choice_music_and_time ();
170         void set_snap_to (Editing::SnapType);
171         void set_snap_mode (Editing::SnapMode);
172         void set_snap_threshold (double pixel_distance) {snap_threshold = pixel_distance;}
173
174         Editing::SnapMode  snap_mode () const;
175         Editing::SnapType  snap_type () const;
176         bool  snap_musical () const;
177
178         void undo (uint32_t n = 1);
179         void redo (uint32_t n = 1);
180
181         XMLNode& get_state ();
182         int set_state (const XMLNode&, int version);
183
184         void set_mouse_mode (Editing::MouseMode, bool force=true);
185         void step_mouse_mode (bool next);
186         Editing::MouseMode current_mouse_mode () const { return mouse_mode; }
187         Editing::MidiEditMode current_midi_edit_mode () const;
188         void remove_midi_note (ArdourCanvas::Item *, GdkEvent *);
189
190         bool internal_editing() const;
191
192         void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>);
193         void add_to_idle_resize (TimeAxisView*, int32_t);
194
195         StripableTimeAxisView* get_stripable_time_axis_by_id (const PBD::ID& id) const;
196
197         void consider_auditioning (boost::shared_ptr<ARDOUR::Region>);
198         void hide_a_region (boost::shared_ptr<ARDOUR::Region>);
199         void show_a_region (boost::shared_ptr<ARDOUR::Region>);
200
201 #ifdef USE_RUBBERBAND
202         std::vector<std::string> rb_opt_strings;
203         int rb_current_opt;
204 #endif
205
206         /* things that need to be public to be used in the main menubar */
207
208         void new_region_from_selection ();
209         void separate_regions_between (const TimeSelection&);
210         void separate_region_from_selection ();
211         void separate_under_selected_regions ();
212         void separate_region_from_punch ();
213         void separate_region_from_loop ();
214         void separate_regions_using_location (ARDOUR::Location&);
215         void transition_to_rolling (bool forward);
216
217         /* NOTE: these functions assume that the "pixel" coordinate is
218            in canvas coordinates. These coordinates already take into
219            account any scrolling offsets.
220         */
221
222         framepos_t pixel_to_sample_from_event (double pixel) const {
223
224                 /* pixel can be less than zero when motion events
225                    are processed. since we've already run the world->canvas
226                    affine, that means that the location *really* is "off
227                    to the right" and thus really is "before the start".
228                 */
229
230                 if (pixel >= 0) {
231                         return pixel * samples_per_pixel;
232                 } else {
233                         return 0;
234                 }
235         }
236
237         framepos_t pixel_to_sample (double pixel) const {
238                 return pixel * samples_per_pixel;
239         }
240
241         double sample_to_pixel (framepos_t sample) const {
242                 return round (sample / (double) samples_per_pixel);
243         }
244
245         double sample_to_pixel_unrounded (framepos_t sample) const {
246                 return sample / (double) samples_per_pixel;
247         }
248
249         /* selection */
250
251         Selection& get_selection() const { return *selection; }
252         bool get_selection_extents (framepos_t &start, framepos_t &end) const;  // the time extents of the current selection, whether Range, Region(s), Control Points, or Notes
253         Selection& get_cut_buffer() const { return *cut_buffer; }
254
255         void set_selection (std::list<Selectable*>, Selection::Operation);
256
257         bool extend_selection_to_track (TimeAxisView&);
258
259         void play_selection ();
260         void maybe_locate_with_edit_preroll (framepos_t);
261         void play_with_preroll ();
262         void rec_with_preroll ();
263         void rec_with_count_in ();
264         void select_all_in_track (Selection::Operation op);
265         void select_all_objects (Selection::Operation op);
266         void invert_selection_in_track ();
267         void invert_selection ();
268         void deselect_all ();
269         long select_range (framepos_t, framepos_t);
270
271         void set_selected_regionview_from_region_list (boost::shared_ptr<ARDOUR::Region> region, Selection::Operation op = Selection::Set);
272
273         void remove_tracks ();
274
275         /* tempo */
276
277         void set_show_measures (bool yn);
278         bool show_measures () const { return _show_measures; }
279
280         /* analysis window */
281
282         void loudness_analyze_region_selection();
283         void loudness_analyze_range_selection();
284
285         void spectral_analyze_region_selection();
286         void spectral_analyze_range_selection();
287
288         /* export */
289
290         void export_audio ();
291         void stem_export ();
292         void export_selection ();
293         void export_range ();
294         void export_region ();
295
296         bool process_midi_export_dialog (MidiExportDialog& dialog, boost::shared_ptr<ARDOUR::MidiRegion> midi_region);
297
298         void               set_zoom_focus (Editing::ZoomFocus);
299         Editing::ZoomFocus get_zoom_focus () const { return zoom_focus; }
300         framecnt_t         get_current_zoom () const { return samples_per_pixel; }
301         void               cycle_zoom_focus ();
302         void temporal_zoom_step (bool zoom_out);
303         void temporal_zoom_step_scale (bool zoom_out, double scale);
304         void temporal_zoom_step_mouse_focus (bool zoom_out);
305         void temporal_zoom_step_mouse_focus_scale (bool zoom_out, double scale);
306         void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top);
307         void tav_zoom_step (bool coarser);
308         void tav_zoom_smooth (bool coarser, bool force_all);
309
310         /* stuff that AudioTimeAxisView and related classes use */
311
312         PlaylistSelector& playlist_selector() const;
313         void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>);
314
315         void new_playlists (TimeAxisView* v);
316         void copy_playlists (TimeAxisView* v);
317         void clear_playlists (TimeAxisView* v);
318
319         void get_onscreen_tracks (TrackViewList&);
320
321         Width editor_mixer_strip_width;
322         void maybe_add_mixer_strip_width (XMLNode&);
323         void show_editor_mixer (bool yn);
324         void create_editor_mixer ();
325         void show_editor_list (bool yn);
326         void set_selected_mixer_strip (TimeAxisView&);
327         void mixer_strip_width_changed ();
328         void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false);
329         void show_track_in_display (TimeAxisView* tv, bool move_into_view = false);
330         void tempo_curve_selected (ARDOUR::TempoSection* ts, bool yn);
331
332         /* nudge is initiated by transport controls owned by ARDOUR_UI */
333
334         framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next);
335         framecnt_t get_paste_offset (framepos_t pos, unsigned paste_count, framecnt_t duration);
336         unsigned get_grid_beat_divisions(framepos_t position);
337         Evoral::Beats get_grid_type_as_beats (bool& success, framepos_t position);
338
339         int32_t get_grid_music_divisions (uint32_t event_state);
340
341         void nudge_forward (bool next, bool force_playhead);
342         void nudge_backward (bool next, bool force_playhead);
343
344         /* nudge initiated from context menu */
345
346         void nudge_forward_capture_offset ();
347         void nudge_backward_capture_offset ();
348
349         void sequence_regions ();
350
351         /* playhead/screen stuff */
352
353         void set_stationary_playhead (bool yn);
354         void toggle_stationary_playhead ();
355         bool stationary_playhead() const { return _stationary_playhead; }
356
357         void set_follow_playhead (bool yn, bool catch_up = true);
358         void toggle_follow_playhead ();
359         bool follow_playhead() const { return _follow_playhead; }
360         bool dragging_playhead () const { return _dragging_playhead; }
361
362         void toggle_zero_line_visibility ();
363         void set_summary ();
364         void set_group_tabs ();
365         void toggle_measure_visibility ();
366
367         /* returns the left-most and right-most time that the gui should allow the user to scroll to */
368         std::pair <framepos_t,framepos_t> session_gui_extents() const; 
369
370         /* fades */
371
372         void toggle_region_fades (int dir);
373         void update_region_fade_visibility ();
374
375         /* redirect shared ops menu. caller must free returned menu */
376
377         Gtk::Menu* redirect_menu ();
378
379         /* floating windows/transient */
380
381         void ensure_float (Gtk::Window&);
382
383         void scroll_tracks_down_line ();
384         void scroll_tracks_up_line ();
385
386         bool scroll_up_one_track (bool skip_child_views = false);
387         bool scroll_down_one_track (bool skip_child_views = false);
388
389         void scroll_left_step ();
390         void scroll_right_step ();
391
392         void scroll_left_half_page ();
393         void scroll_right_half_page ();
394
395         void select_topmost_track ();
396
397         void prepare_for_cleanup ();
398         void finish_cleanup ();
399
400         void maximise_editing_space();
401         void restore_editing_space();
402
403         double get_y_origin () const;
404         void reset_x_origin (framepos_t);
405         void reset_x_origin_to_follow_playhead ();
406         void reset_y_origin (double);
407         void reset_zoom (framecnt_t);
408         void reposition_and_zoom (framepos_t, double);
409
410         framepos_t get_preferred_edit_position (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE,
411                                                 bool use_context_click = false,
412                                                 bool from_outside_canvas = false);
413
414         bool update_mouse_speed ();
415         bool decelerate_mouse_speed ();
416
417         void toggle_meter_updating();
418
419         void show_rhythm_ferret();
420
421         void goto_visual_state (uint32_t);
422         void save_visual_state (uint32_t);
423
424         void queue_draw_resize_line (int at);
425         void start_resize_line_ops ();
426         void end_resize_line_ops ();
427
428         TrackViewList const & get_track_views () const {
429                 return track_views;
430         }
431
432         int get_regionview_count_from_region_list (boost::shared_ptr<ARDOUR::Region>);
433
434         void do_ptimport(std::string path, ARDOUR::SrcQuality quality);
435
436         void do_import (std::vector<std::string>              paths,
437                         Editing::ImportDisposition            disposition,
438                         Editing::ImportMode                   mode,
439                         ARDOUR::SrcQuality                    quality,
440                         ARDOUR::MidiTrackNameSource           mts,
441                         ARDOUR::MidiTempoMapDisposition       mtd,
442                         framepos_t&                           pos,
443                         boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
444
445         void do_embed (std::vector<std::string>              paths,
446                        Editing::ImportDisposition            disposition,
447                        Editing::ImportMode                   mode,
448                        framepos_t&                           pos,
449                        boost::shared_ptr<ARDOUR::PluginInfo> instrument = boost::shared_ptr<ARDOUR::PluginInfo>());
450
451         void get_regions_corresponding_to (boost::shared_ptr<ARDOUR::Region> region, std::vector<RegionView*>& regions, bool src_comparison);
452
453         void get_regionviews_by_id (PBD::ID const id, RegionSelection & regions) const;
454         void get_per_region_note_selection (std::list<std::pair<PBD::ID, std::set<boost::shared_ptr<Evoral::Note<Evoral::Beats> > > > >&) const;
455
456         void center_screen (framepos_t);
457
458         TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const;
459
460         void snap_to (ARDOUR::MusicFrame& first,
461                       ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
462                       bool                for_mark  = false,
463                       bool                ensure_snap = false);
464
465         void snap_to_with_modifier (ARDOUR::MusicFrame& first,
466                                     GdkEvent const *    ev,
467                                     ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
468                                     bool                for_mark  = false);
469
470         void snap_to (ARDOUR::MusicFrame& first,
471                       ARDOUR::MusicFrame& last,
472                       ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
473                       bool                for_mark  = false);
474
475         void begin_selection_op_history ();
476         void begin_reversible_selection_op (std::string cmd_name);
477         void commit_reversible_selection_op ();
478         void undo_selection_op ();
479         void redo_selection_op ();
480         void begin_reversible_command (std::string cmd_name);
481         void begin_reversible_command (GQuark);
482         void abort_reversible_command ();
483         void commit_reversible_command ();
484
485         DragManager* drags () const {
486                 return _drags;
487         }
488
489         void maybe_autoscroll (bool, bool, bool);
490         bool autoscroll_active() const;
491
492         Gdk::Cursor* get_canvas_cursor () const;
493
494         void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>);
495         void set_current_movable (boost::shared_ptr<ARDOUR::Movable>);
496
497         MouseCursors const * cursors () const {
498                 return _cursors;
499         }
500
501         VerboseCursor* verbose_cursor () const {
502                 return _verbose_cursor;
503         }
504
505         double clamp_verbose_cursor_x (double);
506         double clamp_verbose_cursor_y (double);
507
508         void get_pointer_position (double &, double &) const;
509
510         /** Context for mouse entry (stored in a stack). */
511         struct EnterContext {
512                 ItemType                         item_type;
513                 boost::shared_ptr<CursorContext> cursor_ctx;
514         };
515
516         /** Get the topmost enter context for the given item type.
517          *
518          * This is used to change the cursor associated with a given enter context,
519          * which may not be on the top of the stack.
520          */
521         EnterContext* get_enter_context(ItemType type);
522
523         TimeAxisView* stepping_axis_view () {
524                 return _stepping_axis_view;
525         }
526
527         void set_stepping_axis_view (TimeAxisView* v) {
528                 _stepping_axis_view = v;
529         }
530
531         ArdourCanvas::Container* get_trackview_group () const { return _trackview_group; }
532         ArdourCanvas::Container* get_noscroll_group () const { return no_scroll_group; }
533         ArdourCanvas::ScrollGroup* get_hscroll_group () const { return h_scroll_group; }
534         ArdourCanvas::ScrollGroup* get_hvscroll_group () const { return hv_scroll_group; }
535         ArdourCanvas::ScrollGroup* get_cursor_scroll_group () const { return cursor_scroll_group; }
536
537         ArdourCanvas::GtkCanvasViewport* get_track_canvas () const;
538
539         void override_visible_track_count ();
540
541         /* Ruler metrics methods */
542
543         void metric_get_timecode (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
544         void metric_get_bbt (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
545         void metric_get_samples (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
546         void metric_get_minsec (std::vector<ArdourCanvas::Ruler::Mark>&, gdouble, gdouble, gint);
547
548         /* editing operations that need to be public */
549         void mouse_add_new_marker (framepos_t where, bool is_cd=false);
550         void split_regions_at (ARDOUR::MusicFrame, RegionSelection&, bool snap = true);
551         void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false);
552         RegionSelection get_regions_from_selection_and_mouse (framepos_t);
553
554         void mouse_add_new_tempo_event (framepos_t where);
555         void mouse_add_new_meter_event (framepos_t where);
556         void edit_tempo_section (ARDOUR::TempoSection*);
557         void edit_meter_section (ARDOUR::MeterSection*);
558
559 protected:
560         void map_transport_state ();
561         void map_position_change (framepos_t);
562         void transport_looped ();
563
564         void on_realize();
565
566         void suspend_route_redisplay ();
567         void resume_route_redisplay ();
568
569 private:
570
571         void color_handler ();
572
573         bool                 constructed;
574
575         // to keep track of the playhead position for control_scroll
576         boost::optional<framepos_t> _control_scroll_target;
577
578         PlaylistSelector* _playlist_selector;
579
580         TimeInfoBox*      _time_info_box;
581
582         typedef std::pair<TimeAxisView*,XMLNode*> TAVState;
583
584         struct VisualState {
585                 VisualState (bool with_tracks);
586                 ~VisualState ();
587                 double              y_position;
588                 framecnt_t          samples_per_pixel;
589                 framepos_t          leftmost_frame;
590                 Editing::ZoomFocus  zoom_focus;
591                 GUIObjectState*     gui_state;
592         };
593
594         std::list<VisualState*> undo_visual_stack;
595         std::list<VisualState*> redo_visual_stack;
596         VisualState* current_visual_state (bool with_tracks = true);
597         void undo_visual_state ();
598         void redo_visual_state ();
599         void use_visual_state (VisualState&);
600         bool no_save_visual;
601         void swap_visual_state ();
602
603         std::vector<VisualState*> visual_states;
604         void start_visual_state_op (uint32_t n);
605         void cancel_visual_state_op (uint32_t n);
606
607         framepos_t         leftmost_frame;
608         framecnt_t         samples_per_pixel;
609         Editing::ZoomFocus zoom_focus;
610
611         void set_samples_per_pixel (framecnt_t);
612         void on_samples_per_pixel_changed ();
613
614         Editing::MouseMode mouse_mode;
615         Editing::SnapType  pre_internal_snap_type;
616         Editing::SnapMode  pre_internal_snap_mode;
617         Editing::SnapType  internal_snap_type;
618         Editing::SnapMode  internal_snap_mode;
619         Editing::MouseMode effective_mouse_mode () const;
620
621         enum JoinObjectRangeState {
622                 JOIN_OBJECT_RANGE_NONE,
623                 /** `join object/range' mode is active and the mouse is over a place where object mode should happen */
624                 JOIN_OBJECT_RANGE_OBJECT,
625                 /** `join object/range' mode is active and the mouse is over a place where range mode should happen */
626                 JOIN_OBJECT_RANGE_RANGE
627         };
628
629         JoinObjectRangeState _join_object_range_state;
630
631         void update_join_object_range_location (double);
632
633         boost::optional<float>  pre_notebook_shrink_pane_width;
634
635         Gtk::VBox _editor_list_vbox;
636         Gtk::Notebook _the_notebook;
637         bool _notebook_shrunk;
638         void add_notebook_page (std::string const &, Gtk::Widget &);
639         bool notebook_tab_clicked (GdkEventButton *, Gtk::Widget *);
640
641         ArdourWidgets::HPane edit_pane;
642         ArdourWidgets::VPane editor_summary_pane;
643
644         Gtk::EventBox meter_base;
645         Gtk::HBox     meter_box;
646         Gtk::EventBox marker_base;
647         Gtk::HBox     marker_box;
648         Gtk::VBox     scrollers_rulers_markers_box;
649
650         void location_changed (ARDOUR::Location *);
651         void location_flags_changed (ARDOUR::Location *);
652         void refresh_location_display ();
653         void refresh_location_display_internal (const ARDOUR::Locations::LocationList&);
654         void add_new_location (ARDOUR::Location *);
655         ArdourCanvas::Container* add_new_location_internal (ARDOUR::Location *);
656         void location_gone (ARDOUR::Location *);
657         void remove_marker (ArdourCanvas::Item&, GdkEvent*);
658         gint really_remove_marker (ARDOUR::Location* loc);
659         void goto_nth_marker (int nth);
660         void trigger_script (int nth);
661         void toggle_marker_lines ();
662         void set_marker_line_visibility (bool);
663
664         void jump_forward_to_mark ();
665         void jump_backward_to_mark ();
666
667         uint32_t location_marker_color;
668         uint32_t location_range_color;
669         uint32_t location_loop_color;
670         uint32_t location_punch_color;
671         uint32_t location_cd_marker_color;
672
673         struct LocationMarkers {
674                 ArdourMarker* start;
675                 ArdourMarker* end;
676                 bool    valid;
677
678                 LocationMarkers () : start(0), end(0), valid (true) {}
679
680                 ~LocationMarkers ();
681
682                 void hide ();
683                 void show ();
684
685                 void set_show_lines (bool);
686                 void set_selected (bool);
687                 void canvas_height_set (double);
688                 void setup_lines ();
689
690                 void set_name (const std::string&);
691                 void set_position (framepos_t start, framepos_t end = 0);
692                 void set_color_rgba (uint32_t);
693         };
694
695         LocationMarkers  *find_location_markers (ARDOUR::Location *) const;
696         ARDOUR::Location* find_location_from_marker (ArdourMarker *, bool& is_start) const;
697         ArdourMarker* find_marker_from_location_id (PBD::ID const &, bool) const;
698         ArdourMarker* entered_marker;
699         bool _show_marker_lines;
700
701         typedef std::map<ARDOUR::Location*,LocationMarkers *> LocationMarkerMap;
702         LocationMarkerMap location_markers;
703
704         void update_marker_labels ();
705         void update_marker_labels (ArdourCanvas::Container *);
706         void check_marker_label (ArdourMarker *);
707
708         /** A set of lists of Markers that are in each of the canvas groups
709          *  for the marker sections at the top of the editor.  These lists
710          *  are kept sorted in time order between marker movements, so that after
711          *  a marker has moved we can decide whether we need to update the labels
712          *  for all markers or for just a few.
713          */
714         std::map<ArdourCanvas::Container *, std::list<ArdourMarker *> > _sorted_marker_lists;
715         void remove_sorted_marker (ArdourMarker *);
716
717         void hide_marker (ArdourCanvas::Item*, GdkEvent*);
718         void clear_marker_display ();
719         void mouse_add_new_range (framepos_t);
720         void mouse_add_new_loop (framepos_t);
721         void mouse_add_new_punch (framepos_t);
722         bool choose_new_marker_name(std::string &name);
723         void update_cd_marker_display ();
724         void ensure_cd_marker_updated (LocationMarkers * lam, ARDOUR::Location * location);
725
726         TimeAxisView*      clicked_axisview;
727         RouteTimeAxisView* clicked_routeview;
728         /** The last RegionView that was clicked on, or 0 if the last click was not
729          * on a RegionView.  This is set up by the canvas event handlers in
730          * editor_canvas_events.cc
731          */
732         RegionView*        clicked_regionview;
733         RegionSelection    latest_regionviews;
734         uint32_t           clicked_selection;
735         ControlPoint*      clicked_control_point;
736
737         void sort_track_selection (TrackViewList&);
738
739         void get_equivalent_regions (RegionView* rv, std::vector<RegionView*> &, PBD::PropertyID) const;
740         RegionSelection get_equivalent_regions (RegionSelection &, PBD::PropertyID) const;
741         RegionView* regionview_from_region (boost::shared_ptr<ARDOUR::Region>) const;
742         RouteTimeAxisView* rtav_from_route (boost::shared_ptr<ARDOUR::Route>) const;
743
744         void mapover_tracks (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
745         void mapover_tracks_with_unique_playlists (sigc::slot<void,RouteTimeAxisView&,uint32_t> sl, TimeAxisView*, PBD::PropertyID) const;
746
747         /* functions to be passed to mapover_tracks(), possibly with sigc::bind()-supplied arguments */
748         void mapped_get_equivalent_regions (RouteTimeAxisView&, uint32_t, RegionView *, std::vector<RegionView*>*) const;
749         void mapped_use_new_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
750         void mapped_use_copy_playlist (RouteTimeAxisView&, uint32_t, std::vector<boost::shared_ptr<ARDOUR::Playlist> > const &);
751         void mapped_clear_playlist (RouteTimeAxisView&, uint32_t);
752
753         void button_selection (ArdourCanvas::Item* item, GdkEvent* event, ItemType item_type);
754         bool button_release_can_deselect;
755         bool _mouse_changed_selection;
756
757         void catch_vanishing_regionview (RegionView *);
758
759         void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove=false);
760         void select_all_tracks ();
761         bool select_all_internal_edit (Selection::Operation);
762
763         bool set_selected_control_point_from_click (bool press, Selection::Operation op = Selection::Set);
764         void set_selected_track_from_click (bool press, Selection::Operation op = Selection::Set, bool no_remove=false);
765         void set_selected_track_as_side_effect (Selection::Operation op);
766         bool set_selected_regionview_from_click (bool press, Selection::Operation op = Selection::Set);
767
768         bool set_selected_regionview_from_map_event (GdkEventAny*, StreamView*, boost::weak_ptr<ARDOUR::Region>);
769         void collect_new_region_view (RegionView *);
770         void collect_and_select_new_region_view (RegionView *);
771
772         Gtk::Menu track_context_menu;
773         Gtk::Menu track_region_context_menu;
774         Gtk::Menu track_selection_context_menu;
775
776         Gtk::MenuItem* region_edit_menu_split_item;
777         Gtk::MenuItem* region_edit_menu_split_multichannel_item;
778         Gtk::Menu * track_region_edit_playlist_menu;
779         Gtk::Menu * track_edit_playlist_submenu;
780         Gtk::Menu * track_selection_edit_playlist_submenu;
781
782         GdkEvent context_click_event;
783
784         void popup_track_context_menu (int, int, ItemType, bool);
785         Gtk::Menu* build_track_context_menu ();
786         Gtk::Menu* build_track_bus_context_menu ();
787         Gtk::Menu* build_track_region_context_menu ();
788         Gtk::Menu* build_track_selection_context_menu ();
789         void add_dstream_context_items (Gtk::Menu_Helpers::MenuList&);
790         void add_bus_context_items (Gtk::Menu_Helpers::MenuList&);
791         void add_region_context_items (Gtk::Menu_Helpers::MenuList&, boost::shared_ptr<ARDOUR::Track>);
792         void add_selection_context_items (Gtk::Menu_Helpers::MenuList&);
793         Gtk::MenuItem* _popup_region_menu_item;
794
795         void popup_control_point_context_menu (ArdourCanvas::Item *, GdkEvent *);
796         Gtk::Menu _control_point_context_menu;
797
798         void popup_note_context_menu (ArdourCanvas::Item *, GdkEvent *);
799         Gtk::Menu _note_context_menu;
800
801         void add_stripables (ARDOUR::StripableList&);
802         void add_routes (ARDOUR::RouteList&);
803         void timeaxisview_deleted (TimeAxisView *);
804         void add_vcas (ARDOUR::VCAList&);
805
806         Gtk::HBox global_hpacker;
807         Gtk::VBox global_vpacker;
808
809         /* Cursor stuff.  Do not use directly, use via CursorContext. */
810         friend class CursorContext;
811         std::vector<Gdk::Cursor*> _cursor_stack;
812         void set_canvas_cursor (Gdk::Cursor*);
813         size_t push_canvas_cursor (Gdk::Cursor*);
814         void pop_canvas_cursor ();
815
816         Gdk::Cursor* which_grabber_cursor () const;
817         Gdk::Cursor* which_track_cursor () const;
818         Gdk::Cursor* which_mode_cursor () const;
819         Gdk::Cursor* which_trim_cursor (bool left_side) const;
820         Gdk::Cursor* which_canvas_cursor (ItemType type) const;
821
822         /** Push the appropriate enter/cursor context on item entry. */
823         void choose_canvas_cursor_on_entry (ItemType);
824
825         /** Update all enter cursors based on current settings. */
826         void update_all_enter_cursors ();
827
828         ArdourCanvas::GtkCanvas* _track_canvas;
829         ArdourCanvas::GtkCanvasViewport* _track_canvas_viewport;
830
831         bool within_track_canvas;
832
833         friend class VerboseCursor;
834         VerboseCursor* _verbose_cursor;
835
836         void parameter_changed (std::string);
837         void ui_parameter_changed (std::string);
838
839         Gtk::EventBox             time_bars_event_box;
840         Gtk::VBox                 time_bars_vbox;
841
842         ArdourCanvas::Container      *tempo_group;
843         ArdourCanvas::Container      *meter_group;
844         ArdourCanvas::Container      *marker_group;
845         ArdourCanvas::Container      *range_marker_group;
846         ArdourCanvas::Container      *transport_marker_group;
847         ArdourCanvas::Container*      cd_marker_group;
848
849         /* parent for groups which themselves contain time markers */
850         ArdourCanvas::Container*     _time_markers_group;
851
852         /* The group containing all other groups that are scrolled vertically
853            and horizontally.
854         */
855         ArdourCanvas::ScrollGroup* hv_scroll_group;
856
857         /* The group containing all other groups that are scrolled horizontally ONLY
858         */
859         ArdourCanvas::ScrollGroup* h_scroll_group;
860
861         /* Scroll group for cursors, scrolled horizontally, above everything else
862         */
863         ArdourCanvas::ScrollGroup* cursor_scroll_group;
864
865         /* The group containing all trackviews. */
866         ArdourCanvas::Container* no_scroll_group;
867
868         /* The group containing all trackviews. */
869         ArdourCanvas::Container* _trackview_group;
870
871         /* The group holding things (mostly regions) while dragging so they
872          * are on top of everything else
873          */
874         ArdourCanvas::Container* _drag_motion_group;
875
876         /* a rect that sits at the bottom of all tracks to act as a drag-no-drop/clickable
877          * target area.
878          */
879         ArdourCanvas::Rectangle* _canvas_drop_zone;
880         bool canvas_drop_zone_event (GdkEvent* event);
881
882         enum RulerType {
883                 ruler_metric_timecode = 0,
884                 ruler_metric_bbt = 1,
885                 ruler_metric_samples = 2,
886                 ruler_metric_minsec = 3,
887
888                 ruler_time_tempo = 4,
889                 ruler_time_meter = 5,
890                 ruler_time_marker = 6,
891                 ruler_time_range_marker = 7,
892                 ruler_time_transport_marker = 8,
893                 ruler_time_cd_marker = 9,
894                 ruler_video_timeline = 10,
895         };
896
897         Glib::RefPtr<Gtk::ToggleAction> ruler_timecode_action;
898         Glib::RefPtr<Gtk::ToggleAction> ruler_bbt_action;
899         Glib::RefPtr<Gtk::ToggleAction> ruler_samples_action;
900         Glib::RefPtr<Gtk::ToggleAction> ruler_minsec_action;
901         Glib::RefPtr<Gtk::ToggleAction> ruler_tempo_action;
902         Glib::RefPtr<Gtk::ToggleAction> ruler_meter_action;
903         Glib::RefPtr<Gtk::ToggleAction> ruler_marker_action;
904         Glib::RefPtr<Gtk::ToggleAction> ruler_range_action;
905         Glib::RefPtr<Gtk::ToggleAction> ruler_loop_punch_action;
906         Glib::RefPtr<Gtk::ToggleAction> ruler_cd_marker_action;
907         bool                            no_ruler_shown_update;
908
909         Gtk::Widget * ruler_grabbed_widget;
910
911         RulerDialog* ruler_dialog;
912
913         void initialize_rulers ();
914         void update_just_timecode ();
915         void compute_fixed_ruler_scale (); //calculates the RulerScale of the fixed rulers
916         void update_fixed_rulers ();
917         void update_tempo_based_rulers ();
918         void popup_ruler_menu (framepos_t where = 0, ItemType type = RegionItem);
919         void update_ruler_visibility ();
920         void set_ruler_visible (RulerType, bool);
921         void toggle_ruler_visibility (RulerType rt);
922         void ruler_toggled (int);
923         bool ruler_label_button_release (GdkEventButton*);
924         void store_ruler_visibility ();
925         void restore_ruler_visibility ();
926
927
928
929                 enum MinsecRulerScale {
930                 minsec_show_msecs,
931                 minsec_show_seconds,
932                 minsec_show_minutes,
933                 minsec_show_hours,
934                 minsec_show_many_hours
935         };
936
937         MinsecRulerScale minsec_ruler_scale;
938
939         framecnt_t minsec_mark_interval;
940         gint minsec_mark_modulo;
941         gint minsec_nmarks;
942         void set_minsec_ruler_scale (framepos_t, framepos_t);
943
944         enum TimecodeRulerScale {
945                 timecode_show_bits,
946                 timecode_show_frames,
947                 timecode_show_seconds,
948                 timecode_show_minutes,
949                 timecode_show_hours,
950                 timecode_show_many_hours
951         };
952
953         TimecodeRulerScale timecode_ruler_scale;
954
955         gint timecode_mark_modulo;
956         gint timecode_nmarks;
957         void set_timecode_ruler_scale (framepos_t, framepos_t);
958
959         framecnt_t _samples_ruler_interval;
960         void set_samples_ruler_scale (framepos_t, framepos_t);
961
962         enum BBTRulerScale {
963                 bbt_show_many,
964                 bbt_show_64,
965                 bbt_show_16,
966                 bbt_show_4,
967                 bbt_show_1,
968                 bbt_show_beats,
969                 bbt_show_ticks,
970                 bbt_show_ticks_detail,
971                 bbt_show_ticks_super_detail
972         };
973
974         BBTRulerScale bbt_ruler_scale;
975
976         uint32_t bbt_bars;
977         gint bbt_nmarks;
978         uint32_t bbt_bar_helper_on;
979         uint32_t bbt_accent_modulo;
980         void compute_bbt_ruler_scale (framepos_t lower, framepos_t upper);
981
982         ArdourCanvas::Ruler* timecode_ruler;
983         ArdourCanvas::Ruler* bbt_ruler;
984         ArdourCanvas::Ruler* samples_ruler;
985         ArdourCanvas::Ruler* minsec_ruler;
986
987         static double timebar_height;
988         guint32 visible_timebars;
989         Gtk::Menu          *editor_ruler_menu;
990
991         ArdourCanvas::Rectangle* tempo_bar;
992         ArdourCanvas::Rectangle* meter_bar;
993         ArdourCanvas::Rectangle* marker_bar;
994         ArdourCanvas::Rectangle* range_marker_bar;
995         ArdourCanvas::Rectangle* transport_marker_bar;
996         ArdourCanvas::Rectangle* cd_marker_bar;
997
998         Gtk::Label  minsec_label;
999         Gtk::Label  bbt_label;
1000         Gtk::Label  timecode_label;
1001         Gtk::Label  samples_label;
1002         Gtk::Label  tempo_label;
1003         Gtk::Label  meter_label;
1004         Gtk::Label  mark_label;
1005         Gtk::Label  range_mark_label;
1006         Gtk::Label  transport_mark_label;
1007         Gtk::Label  cd_mark_label;
1008
1009         /* videtimline related actions */
1010         Gtk::Label                videotl_label;
1011         ArdourCanvas::Container*      videotl_group;
1012         Glib::RefPtr<Gtk::ToggleAction> ruler_video_action;
1013         Glib::RefPtr<Gtk::ToggleAction> xjadeo_proc_action;
1014         Glib::RefPtr<Gtk::ToggleAction> xjadeo_ontop_action;
1015         Glib::RefPtr<Gtk::ToggleAction> xjadeo_timecode_action;
1016         Glib::RefPtr<Gtk::ToggleAction> xjadeo_frame_action;
1017         Glib::RefPtr<Gtk::ToggleAction> xjadeo_osdbg_action;
1018         Glib::RefPtr<Gtk::ToggleAction> xjadeo_fullscreen_action;
1019         Glib::RefPtr<Gtk::ToggleAction> xjadeo_letterbox_action;
1020         Glib::RefPtr<Gtk::Action> xjadeo_zoom_100;
1021         void set_xjadeo_proc ();
1022         void toggle_xjadeo_proc (int state=-1);
1023         void set_close_video_sensitive (bool onoff);
1024         void set_xjadeo_sensitive (bool onoff);
1025         void set_xjadeo_viewoption (int);
1026         void toggle_xjadeo_viewoption (int what, int state=-1);
1027         void toggle_ruler_video (bool onoff) {ruler_video_action->set_active(onoff);}
1028         int videotl_bar_height; /* in units of timebar_height; default: 4 */
1029         int get_videotl_bar_height () const { return videotl_bar_height; }
1030         void toggle_region_video_lock ();
1031
1032         friend class EditorCursor;
1033
1034         EditorCursor* playhead_cursor;
1035         framepos_t playhead_cursor_sample () const;
1036
1037         framepos_t get_region_boundary (framepos_t pos, int32_t dir, bool with_selection, bool only_onscreen);
1038
1039         void    cursor_to_region_boundary (bool with_selection, int32_t dir);
1040         void    cursor_to_next_region_boundary (bool with_selection);
1041         void    cursor_to_previous_region_boundary (bool with_selection);
1042         void    cursor_to_next_region_point (EditorCursor*, ARDOUR::RegionPoint);
1043         void    cursor_to_previous_region_point (EditorCursor*, ARDOUR::RegionPoint);
1044         void    cursor_to_region_point (EditorCursor*, ARDOUR::RegionPoint, int32_t dir);
1045         void    cursor_to_selection_start (EditorCursor *);
1046         void    cursor_to_selection_end   (EditorCursor *);
1047
1048         void    selected_marker_to_region_boundary (bool with_selection, int32_t dir);
1049         void    selected_marker_to_next_region_boundary (bool with_selection);
1050         void    selected_marker_to_previous_region_boundary (bool with_selection);
1051         void    selected_marker_to_next_region_point (ARDOUR::RegionPoint);
1052         void    selected_marker_to_previous_region_point (ARDOUR::RegionPoint);
1053         void    selected_marker_to_region_point (ARDOUR::RegionPoint, int32_t dir);
1054         void    selected_marker_to_selection_start ();
1055         void    selected_marker_to_selection_end   ();
1056
1057         void    select_all_selectables_using_cursor (EditorCursor *, bool);
1058         void    select_all_selectables_using_edit (bool, bool);
1059         void    select_all_selectables_between (bool within);
1060         void    select_range_between ();
1061
1062         boost::shared_ptr<ARDOUR::Region> find_next_region (ARDOUR::framepos_t, ARDOUR::RegionPoint, int32_t dir, TrackViewList&, TimeAxisView ** = 0);
1063         ARDOUR::framepos_t find_next_region_boundary (ARDOUR::framepos_t, int32_t dir, const TrackViewList&);
1064
1065         std::vector<ARDOUR::framepos_t> region_boundary_cache;
1066         void build_region_boundary_cache ();
1067
1068         Gtk::HBox           toplevel_hpacker;
1069
1070         Gtk::HBox           bottom_hbox;
1071
1072         Gtk::Table          edit_packer;
1073
1074         /** the adjustment that controls the overall editor vertical scroll position */
1075         Gtk::Adjustment     vertical_adjustment;
1076         Gtk::Adjustment     horizontal_adjustment;
1077
1078         Gtk::Adjustment     unused_adjustment; // yes, really; Gtk::Layout constructor requires refs
1079         Gtk::Layout         controls_layout;
1080         bool control_layout_scroll (GdkEventScroll* ev);
1081         void reset_controls_layout_width ();
1082         void reset_controls_layout_height (int32_t height);
1083
1084         enum Direction {
1085                 LEFT,
1086                 RIGHT,
1087                 UP,
1088                 DOWN
1089         };
1090
1091         bool scroll_press (Direction);
1092         void scroll_release ();
1093         sigc::connection _scroll_connection;
1094         int _scroll_callbacks;
1095
1096         double _visible_canvas_width;
1097         double _visible_canvas_height; ///< height of the visible area of the track canvas
1098         double _full_canvas_height;    ///< full height of the canvas
1099
1100         bool track_canvas_map_handler (GdkEventAny*);
1101
1102         bool edit_controls_button_release (GdkEventButton*);
1103         Gtk::Menu *edit_controls_left_menu;
1104         Gtk::Menu *edit_controls_right_menu;
1105
1106         Gtk::VBox           track_canvas_vbox;
1107         Gtk::VBox           edit_controls_vbox;
1108         Gtk::HBox           edit_controls_hbox;
1109
1110         void control_vertical_zoom_in_all ();
1111         void control_vertical_zoom_out_all ();
1112         void control_vertical_zoom_in_selected ();
1113         void control_vertical_zoom_out_selected ();
1114         void control_step_tracks_up ();
1115         void control_step_tracks_down ();
1116         void control_view (uint32_t);
1117         void control_scroll (float);
1118         void control_select (boost::shared_ptr<ARDOUR::Stripable>, Selection::Operation);
1119         void control_unselect ();
1120         void access_action (const std::string&, const std::string&);
1121         void set_toggleaction (const std::string&, const std::string&, bool);
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 ramp_to_next_tempo ();
1709         void toggle_marker_menu_lock ();
1710         void toggle_marker_menu_glue ();
1711         void marker_menu_hide ();
1712         void marker_menu_loop_range ();
1713         void marker_menu_select_all_selectables_using_range ();
1714         void marker_menu_select_using_range ();
1715         void marker_menu_separate_regions_using_location ();
1716         void marker_menu_play_from ();
1717         void marker_menu_play_range ();
1718         void marker_menu_set_playhead ();
1719         void marker_menu_set_from_playhead ();
1720         void marker_menu_set_from_selection (bool force_regions);
1721         void marker_menu_range_to_next ();
1722         void marker_menu_zoom_to_range ();
1723         void new_transport_marker_menu_set_loop ();
1724         void new_transport_marker_menu_set_punch ();
1725         void update_loop_range_view ();
1726         void update_punch_range_view ();
1727         void new_transport_marker_menu_popdown ();
1728         void marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1729         void tempo_or_meter_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1730         void new_transport_marker_context_menu (GdkEventButton*, ArdourCanvas::Item*);
1731         void build_range_marker_menu (ARDOUR::Location *, bool, bool);
1732         void build_marker_menu (ARDOUR::Location *);
1733         void build_tempo_marker_menu (TempoMarker *, bool);
1734         void build_meter_marker_menu (MeterMarker *, bool);
1735         void build_new_transport_marker_menu ();
1736         void dynamic_cast_marker_object (void*, MeterMarker**, TempoMarker**) const;
1737
1738         Gtk::Menu* tempo_marker_menu;
1739         Gtk::Menu* meter_marker_menu;
1740         Gtk::Menu* marker_menu;
1741         Gtk::Menu* range_marker_menu;
1742         Gtk::Menu* transport_marker_menu;
1743         Gtk::Menu* new_transport_marker_menu;
1744         Gtk::Menu* cd_marker_menu;
1745         ArdourCanvas::Item* marker_menu_item;
1746
1747         typedef std::list<ArdourMarker*> Marks;
1748         Marks metric_marks;
1749
1750         typedef std::list<TempoCurve*> Curves;
1751         Curves tempo_curves;
1752
1753         void remove_metric_marks ();
1754         void draw_metric_marks (const ARDOUR::Metrics& metrics);
1755
1756         void compute_current_bbt_points (std::vector<ARDOUR::TempoMap::BBTPoint>& grid, framepos_t left, framepos_t right);
1757
1758         void tempo_map_changed (const PBD::PropertyChange&);
1759         void tempometric_position_changed (const PBD::PropertyChange&);
1760         void redisplay_tempo (bool immediate_redraw);
1761
1762         uint32_t bbt_beat_subdivision;
1763
1764         /* toolbar */
1765
1766         Gtk::ToggleButton editor_mixer_button;
1767         Gtk::ToggleButton editor_list_button;
1768         void editor_mixer_button_toggled ();
1769         void editor_list_button_toggled ();
1770
1771         ArdourWidgets::ArdourButton   zoom_in_button;
1772         ArdourWidgets::ArdourButton   zoom_out_button;
1773         ArdourWidgets::ArdourButton   zoom_out_full_button;
1774
1775         ArdourWidgets::ArdourButton   tav_expand_button;
1776         ArdourWidgets::ArdourButton   tav_shrink_button;
1777         ArdourWidgets::ArdourDropdown visible_tracks_selector;
1778         ArdourWidgets::ArdourDropdown zoom_preset_selector;
1779
1780         int32_t                   _visible_track_count;
1781         void build_track_count_menu ();
1782         void set_visible_track_count (int32_t);
1783
1784         void set_zoom_preset(int64_t);
1785
1786         Gtk::VBox                toolbar_clock_vbox;
1787         Gtk::VBox                toolbar_selection_clock_vbox;
1788         Gtk::Table               toolbar_selection_clock_table;
1789         Gtk::Label               toolbar_selection_cursor_label;
1790
1791         ArdourWidgets::ArdourButton mouse_select_button;
1792         ArdourWidgets::ArdourButton mouse_draw_button;
1793         ArdourWidgets::ArdourButton mouse_move_button;
1794         ArdourWidgets::ArdourButton mouse_timefx_button;
1795         ArdourWidgets::ArdourButton mouse_content_button;
1796         ArdourWidgets::ArdourButton mouse_audition_button;
1797         ArdourWidgets::ArdourButton mouse_cut_button;
1798
1799         ArdourWidgets::ArdourButton smart_mode_button;
1800         Glib::RefPtr<Gtk::ToggleAction> smart_mode_action;
1801
1802         void                     mouse_mode_toggled (Editing::MouseMode m);
1803         void                     mouse_mode_object_range_toggled ();
1804         bool                     ignore_mouse_mode_toggle;
1805
1806         bool                     mouse_select_button_release (GdkEventButton*);
1807
1808         Gtk::VBox                automation_box;
1809         Gtk::Button              automation_mode_button;
1810
1811         //edit mode menu stuff
1812         ArdourWidgets::ArdourDropdown   edit_mode_selector;
1813         void edit_mode_selection_done (ARDOUR::EditMode);
1814         void build_edit_mode_menu ();
1815         Gtk::VBox edit_mode_box;
1816
1817         void set_edit_mode (ARDOUR::EditMode);
1818         void cycle_edit_mode ();
1819
1820         ArdourWidgets::ArdourDropdown snap_type_selector;
1821         void build_snap_type_menu ();
1822
1823         ArdourWidgets::ArdourDropdown snap_mode_selector;
1824         void build_snap_mode_menu ();
1825         Gtk::HBox snap_box;
1826
1827         std::vector<std::string> snap_type_strings;
1828         std::vector<std::string> snap_mode_strings;
1829
1830         void snap_type_selection_done (Editing::SnapType);
1831         void snap_mode_selection_done (Editing::SnapMode);
1832         void snap_mode_chosen (Editing::SnapMode);
1833         void snap_type_chosen (Editing::SnapType);
1834
1835         Glib::RefPtr<Gtk::RadioAction> snap_type_action (Editing::SnapType);
1836         Glib::RefPtr<Gtk::RadioAction> snap_mode_action (Editing::SnapMode);
1837
1838         //zoom focus meu stuff
1839         ArdourWidgets::ArdourDropdown   zoom_focus_selector;
1840         void zoom_focus_selection_done (Editing::ZoomFocus);
1841         void build_zoom_focus_menu ();
1842         std::vector<std::string> zoom_focus_strings;
1843
1844         void zoom_focus_chosen (Editing::ZoomFocus);
1845
1846         Glib::RefPtr<Gtk::RadioAction> zoom_focus_action (Editing::ZoomFocus);
1847
1848         Gtk::HBox _track_box;
1849
1850         Gtk::HBox _zoom_box;
1851         void zoom_adjustment_changed();
1852
1853         void setup_toolbar ();
1854
1855         void setup_tooltips ();
1856
1857         Gtk::HBox toolbar_hbox;
1858
1859         void setup_midi_toolbar ();
1860
1861         /* selection process */
1862
1863         Selection* selection;
1864         Selection* cut_buffer;
1865         SelectionMemento* _selection_memento;
1866
1867         void time_selection_changed ();
1868         void update_time_selection_display ();
1869         void presentation_info_changed (PBD::PropertyChange const &);
1870         void region_selection_changed ();
1871         sigc::connection editor_regions_selection_changed_connection;
1872         void sensitize_all_region_actions (bool);
1873         void sensitize_the_right_region_actions (bool because_canvas_crossing);
1874         bool _all_region_actions_sensitized;
1875         /** Flag to block region action handlers from doing what they normally do;
1876          *  I tried Gtk::Action::block_activate() but this doesn't work (ie it doesn't
1877          *  block) when setting a ToggleAction's active state.
1878          */
1879         bool _ignore_region_action;
1880         bool _last_region_menu_was_main;
1881         void point_selection_changed ();
1882         void marker_selection_changed ();
1883
1884         bool _track_selection_change_without_scroll;
1885
1886         void cancel_selection ();
1887         void cancel_time_selection ();
1888
1889         bool get_smart_mode() const;
1890
1891         bool audio_region_selection_covers (framepos_t where);
1892
1893         /* transport range select process */
1894
1895         ArdourCanvas::Rectangle* cd_marker_bar_drag_rect;
1896         ArdourCanvas::Rectangle* range_bar_drag_rect;
1897         ArdourCanvas::Rectangle* transport_bar_drag_rect;
1898         ArdourCanvas::Rectangle* transport_bar_range_rect;
1899         ArdourCanvas::Rectangle* transport_bar_preroll_rect;
1900         ArdourCanvas::Rectangle* transport_bar_postroll_rect;
1901         ArdourCanvas::Rectangle* transport_loop_range_rect;
1902         ArdourCanvas::Rectangle* transport_punch_range_rect;
1903         ArdourCanvas::Line*      transport_punchin_line;
1904         ArdourCanvas::Line*      transport_punchout_line;
1905         ArdourCanvas::Rectangle* transport_preroll_rect;
1906         ArdourCanvas::Rectangle* transport_postroll_rect;
1907
1908         ARDOUR::Location* transport_loop_location();
1909         ARDOUR::Location* transport_punch_location();
1910
1911         ARDOUR::Location* temp_location;
1912
1913         /* object rubberband select process */
1914
1915         void select_all_within (framepos_t, framepos_t, double, double, TrackViewList const &, Selection::Operation, bool);
1916
1917         ArdourCanvas::Rectangle* rubberband_rect;
1918
1919         EditorRouteGroups* _route_groups;
1920         EditorRoutes*      _routes;
1921         EditorRegions*     _regions;
1922         EditorSnapshots*   _snapshots;
1923         EditorLocations*   _locations;
1924
1925         /* diskstream/route display management */
1926         Glib::RefPtr<Gdk::Pixbuf> rec_enabled_icon;
1927         Glib::RefPtr<Gdk::Pixbuf> rec_disabled_icon;
1928
1929         Glib::RefPtr<Gtk::TreeSelection> route_display_selection;
1930
1931         bool sync_track_view_list_and_routes ();
1932
1933         Gtk::VBox list_vpacker;
1934
1935         /* autoscrolling */
1936
1937         sigc::connection autoscroll_connection;
1938         bool autoscroll_horizontal_allowed;
1939         bool autoscroll_vertical_allowed;
1940         uint32_t autoscroll_cnt;
1941         Gtk::Widget* autoscroll_widget;
1942         ArdourCanvas::Rect autoscroll_boundary;
1943
1944         bool autoscroll_canvas ();
1945         void start_canvas_autoscroll (bool allow_horiz, bool allow_vert, const ArdourCanvas::Rect& boundary);
1946         void stop_canvas_autoscroll ();
1947
1948         /* trimming */
1949         void point_trim (GdkEvent *, framepos_t);
1950
1951         void trim_region_front();
1952         void trim_region_back();
1953         void trim_region (bool front);
1954
1955         void trim_region_to_loop ();
1956         void trim_region_to_punch ();
1957         void trim_region_to_location (const ARDOUR::Location&, const char* cmd);
1958
1959         void trim_to_region(bool forward);
1960         void trim_region_to_previous_region_end();
1961         void trim_region_to_next_region_start();
1962
1963         bool show_gain_after_trim;
1964
1965         /* Drag-n-Drop */
1966
1967         int convert_drop_to_paths (
1968                 std::vector<std::string>&           paths,
1969                 const Glib::RefPtr<Gdk::DragContext>& context,
1970                 gint                                  x,
1971                 gint                                  y,
1972                 const Gtk::SelectionData&             data,
1973                 guint                                 info,
1974                 guint                                 time);
1975
1976         void track_canvas_drag_data_received (
1977                 const Glib::RefPtr<Gdk::DragContext>& context,
1978                 gint                                  x,
1979                 gint                                  y,
1980                 const Gtk::SelectionData&             data,
1981                 guint                                 info,
1982                 guint                                 time);
1983
1984         void drop_paths (
1985                 const Glib::RefPtr<Gdk::DragContext>& context,
1986                 gint                                  x,
1987                 gint                                  y,
1988                 const Gtk::SelectionData&             data,
1989                 guint                                 info,
1990                 guint                                 time);
1991
1992         void drop_regions (
1993                 const Glib::RefPtr<Gdk::DragContext>& context,
1994                 gint                                  x,
1995                 gint                                  y,
1996                 const Gtk::SelectionData&             data,
1997                 guint                                 info,
1998                 guint                                 time);
1999
2000         void drop_routes (
2001                 const Glib::RefPtr<Gdk::DragContext>& context,
2002                 gint                x,
2003                 gint                y,
2004                 const Gtk::SelectionData& data,
2005                 guint               info,
2006                 guint               time);
2007
2008         /* audio export */
2009
2010         int  write_region_selection(RegionSelection&);
2011         bool write_region (std::string path, boost::shared_ptr<ARDOUR::AudioRegion>);
2012         void bounce_region_selection (bool with_processing);
2013         void bounce_range_selection (bool replace, bool enable_processing);
2014         void external_edit_region ();
2015
2016         int write_audio_selection (TimeSelection&);
2017         bool write_audio_range (ARDOUR::AudioPlaylist&, const ARDOUR::ChanCount& channels, std::list<ARDOUR::AudioRange>&);
2018
2019         void write_selection ();
2020
2021         uint32_t selection_op_cmd_depth;
2022         uint32_t selection_op_history_it;
2023
2024         std::list<XMLNode *> selection_op_history; /* used in *_reversible_selection_op */
2025         std::list<XMLNode *> before; /* used in *_reversible_command */
2026
2027         void update_title ();
2028         void update_title_s (const std::string & snapshot_name);
2029
2030         void instant_save ();
2031         bool no_save_instant;
2032
2033         boost::shared_ptr<ARDOUR::AudioRegion> last_audition_region;
2034
2035         /* freeze operations */
2036
2037         ARDOUR::InterThreadInfo freeze_status;
2038         static void* _freeze_thread (void*);
2039         void* freeze_thread ();
2040
2041         void freeze_route ();
2042         void unfreeze_route ();
2043
2044         /* duplication */
2045
2046         void duplicate_range (bool with_dialog);
2047         void duplicate_regions (float times);
2048
2049         /** computes the timeline frame (sample) of an event whose coordinates
2050          * are in canvas units (pixels, scroll offset included).
2051          */
2052         framepos_t canvas_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
2053
2054         /** computes the timeline frame (sample) of an event whose coordinates
2055          * are in window units (pixels, no scroll offset).
2056          */
2057         framepos_t window_event_sample (GdkEvent const *, double* px = 0, double* py = 0) const;
2058
2059         /* returns false if mouse pointer is not in track or marker canvas
2060          */
2061         bool mouse_frame (framepos_t&, bool& in_track_canvas) const;
2062
2063         TimeFXDialog* current_timefx;
2064         static void* timefx_thread (void *arg);
2065         void do_timefx ();
2066
2067         int time_stretch (RegionSelection&, float fraction);
2068         int pitch_shift (RegionSelection&, float cents);
2069         void pitch_shift_region ();
2070
2071         /* editor-mixer strip */
2072
2073         MixerStrip *current_mixer_strip;
2074         bool show_editor_mixer_when_tracks_arrive;
2075         Gtk::VBox current_mixer_strip_vbox;
2076         void cms_new (boost::shared_ptr<ARDOUR::Route>);
2077         void current_mixer_strip_hidden ();
2078
2079 #ifdef __APPLE__
2080         void ensure_all_elements_drawn ();
2081 #endif
2082         /* nudging tracks */
2083
2084         void nudge_track (bool use_edit_point, bool forwards);
2085
2086         static const int32_t default_width = 995;
2087         static const int32_t default_height = 765;
2088
2089         /* nudge */
2090
2091         ArdourWidgets::ArdourButton      nudge_forward_button;
2092         ArdourWidgets::ArdourButton      nudge_backward_button;
2093         Gtk::HBox        nudge_hbox;
2094         Gtk::VBox        nudge_vbox;
2095         AudioClock*       nudge_clock;
2096
2097         bool nudge_forward_release (GdkEventButton*);
2098         bool nudge_backward_release (GdkEventButton*);
2099
2100         /* audio filters */
2101
2102         void apply_filter (ARDOUR::Filter&, std::string cmd, ProgressReporter* progress = 0);
2103
2104         Command* apply_midi_note_edit_op_to_region (ARDOUR::MidiOperator& op, MidiRegionView& mrv);
2105         void apply_midi_note_edit_op (ARDOUR::MidiOperator& op, const RegionSelection& rs);
2106
2107         /* handling cleanup */
2108
2109         int playlist_deletion_dialog (boost::shared_ptr<ARDOUR::Playlist>);
2110
2111         PBD::ScopedConnectionList session_connections;
2112
2113         /* tracking step changes of track height */
2114
2115         TimeAxisView* current_stepping_trackview;
2116         ARDOUR::microseconds_t last_track_height_step_timestamp;
2117         gint track_height_step_timeout();
2118         sigc::connection step_timeout;
2119
2120         TimeAxisView* entered_track;
2121         /** If the mouse is over a RegionView or one of its child canvas items, this is set up
2122             to point to the RegionView.  Otherwise it is 0.
2123         */
2124         RegionView*   entered_regionview;
2125
2126         std::vector<EnterContext> _enter_stack;
2127
2128         bool clear_entered_track;
2129         bool left_track_canvas (GdkEventCrossing*);
2130         bool entered_track_canvas (GdkEventCrossing*);
2131         void set_entered_track (TimeAxisView*);
2132         void set_entered_regionview (RegionView*);
2133         gint left_automation_track ();
2134
2135         void reset_canvas_action_sensitivity (bool);
2136         void set_gain_envelope_visibility ();
2137         void set_region_gain_visibility (RegionView*);
2138         void toggle_gain_envelope_active ();
2139         void reset_region_gain_envelopes ();
2140
2141         void session_state_saved (std::string);
2142
2143         Glib::RefPtr<Gtk::Action>              undo_action;
2144         Glib::RefPtr<Gtk::Action>              redo_action;
2145         Glib::RefPtr<Gtk::Action>              alternate_redo_action;
2146         Glib::RefPtr<Gtk::Action>              alternate_alternate_redo_action;
2147         Glib::RefPtr<Gtk::Action>              selection_undo_action;
2148         Glib::RefPtr<Gtk::Action>              selection_redo_action;
2149
2150         void history_changed ();
2151
2152         Editing::EditPoint _edit_point;
2153
2154         ArdourWidgets::ArdourDropdown edit_point_selector;
2155         void build_edit_point_menu();
2156
2157         void set_edit_point_preference (Editing::EditPoint ep, bool force = false);
2158         void cycle_edit_point (bool with_marker);
2159         void set_edit_point ();
2160         void edit_point_selection_done (Editing::EditPoint);
2161         void edit_point_chosen (Editing::EditPoint);
2162         Glib::RefPtr<Gtk::RadioAction> edit_point_action (Editing::EditPoint);
2163         std::vector<std::string> edit_point_strings;
2164         std::vector<std::string> edit_mode_strings;
2165
2166         void selected_marker_moved (ARDOUR::Location*);
2167
2168         bool get_edit_op_range (framepos_t& start, framepos_t& end) const;
2169
2170         void get_regions_at (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2171         void get_regions_after (RegionSelection&, framepos_t where, const TrackViewList& ts) const;
2172
2173         RegionSelection get_regions_from_selection_and_edit_point (Editing::EditIgnoreOption = Editing::EDIT_IGNORE_NONE,
2174                                                                    bool use_context_click = false,
2175                                                                    bool from_outside_canvas = false);
2176         RegionSelection get_regions_from_selection_and_entered () const;
2177
2178         void start_updating_meters ();
2179         void stop_updating_meters ();
2180         bool meters_running;
2181
2182         void select_next_stripable (bool routes_only = true);
2183         void select_prev_stripable (bool routes_only = true);
2184
2185         void snap_to_internal (ARDOUR::MusicFrame& first,
2186                                ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
2187                                bool                for_mark  = false,
2188                                bool                ensure_snap = false);
2189
2190         void timecode_snap_to_internal (ARDOUR::MusicFrame& first,
2191                                         ARDOUR::RoundMode   direction = ARDOUR::RoundNearest,
2192                                         bool                for_mark  = false);
2193
2194         RhythmFerret* rhythm_ferret;
2195
2196         void fit_tracks (TrackViewList &);
2197         void fit_selection ();
2198         void set_track_height (Height);
2199
2200         void _remove_tracks ();
2201         bool idle_remove_tracks ();
2202         void toggle_tracks_active ();
2203
2204         bool _have_idled;
2205         int resize_idle_id;
2206         static gboolean _idle_resize (gpointer);
2207         bool idle_resize();
2208         int32_t _pending_resize_amount;
2209         TimeAxisView* _pending_resize_view;
2210
2211         void visible_order_range (int*, int*) const;
2212
2213         void located ();
2214
2215         /** true if we've made a locate request that hasn't yet been processed */
2216         bool _pending_locate_request;
2217
2218         /** if true, there is a pending Session locate which is the initial one when loading a session;
2219             we need to know this so that we don't (necessarily) set the viewport to show the playhead
2220             initially.
2221         */
2222         bool _pending_initial_locate;
2223
2224         Gtk::HBox _summary_hbox;
2225         EditorSummary* _summary;
2226
2227         void region_view_added (RegionView *);
2228         void region_view_removed ();
2229
2230         EditorGroupTabs* _group_tabs;
2231         void fit_route_group (ARDOUR::RouteGroup *);
2232
2233         void step_edit_status_change (bool);
2234         void start_step_editing ();
2235         void stop_step_editing ();
2236         bool check_step_edit ();
2237         sigc::connection step_edit_connection;
2238
2239         double _last_motion_y;
2240
2241         RegionLayeringOrderEditor* layering_order_editor;
2242         void update_region_layering_order_editor ();
2243
2244         /** Track that was the source for the last cut/copy operation.  Used as a place
2245             to paste things iff there is no selected track.
2246         */
2247         TimeAxisView* _last_cut_copy_source_track;
2248
2249         /** true if a change in Selection->regions should change the selection in the region list.
2250             See EditorRegions::selection_changed.
2251         */
2252         bool _region_selection_change_updates_region_list;
2253
2254         void setup_fade_images ();
2255         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_in_images;
2256         std::map<ARDOUR::FadeShape, Gtk::Image*> _xfade_out_images;
2257
2258         Gtk::MenuItem& action_menu_item (std::string const &);
2259         void action_pre_activated (Glib::RefPtr<Gtk::Action> const &);
2260
2261         MouseCursors* _cursors;
2262
2263         void follow_mixer_selection ();
2264         bool _following_mixer_selection;
2265
2266         int time_fx (ARDOUR::RegionList&, float val, bool pitching);
2267         void note_edit_done (int, EditNoteDialog*);
2268         void toggle_sound_midi_notes ();
2269
2270         /** Flag for a bit of a hack wrt control point selection; see set_selected_control_point_from_click */
2271         bool _control_point_toggled_on_press;
2272
2273         /** This is used by TimeAxisView to keep a track of the TimeAxisView that is currently being
2274             stepped in height using ScrollZoomVerticalModifier+Scrollwheel.  When a scroll event
2275             occurs, we do the step on this _stepping_axis_view if it is non-0 (and we set up this
2276             _stepping_axis_view with the TimeAxisView underneath the mouse if it is 0).  Then Editor
2277             resets _stepping_axis_view when the modifier key is released.  In this (hacky) way,
2278             pushing the modifier key and moving the scroll wheel will operate on the same track
2279             until the key is released (rather than skipping about to whatever happens to be
2280             underneath the mouse at the time).
2281         */
2282         TimeAxisView* _stepping_axis_view;
2283         void zoom_vertical_modifier_released();
2284
2285         void bring_in_callback (Gtk::Label*, uint32_t n, uint32_t total, std::string name);
2286         void update_bring_in_message (Gtk::Label* label, uint32_t n, uint32_t total, std::string name);
2287         void bring_all_sources_into_session ();
2288
2289         QuantizeDialog* quantize_dialog;
2290         MainMenuDisabler* _main_menu_disabler;
2291
2292         /* private helper functions to help with registering region actions */
2293
2294         Glib::RefPtr<Gtk::Action> register_region_action (Glib::RefPtr<Gtk::ActionGroup> group, Editing::RegionActionTarget, char const * name, char const * label, sigc::slot<void> slot);
2295         void register_toggle_region_action (Glib::RefPtr<Gtk::ActionGroup> group, Editing::RegionActionTarget, char const * name, char const * label, sigc::slot<void> slot);
2296
2297         Glib::RefPtr<Gtk::Action> reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2298         void toggle_reg_sens (Glib::RefPtr<Gtk::ActionGroup> group, char const * name, char const * label, sigc::slot<void> slot);
2299         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);
2300
2301         Gtkmm2ext::ActionMap myactions;
2302
2303         friend class Drag;
2304         friend class RegionCutDrag;
2305         friend class RegionDrag;
2306         friend class RegionMoveDrag;
2307         friend class RegionSpliceDrag;
2308         friend class RegionRippleDrag;
2309         friend class TrimDrag;
2310         friend class BBTRulerDrag;
2311         friend class MeterMarkerDrag;
2312         friend class TempoMarkerDrag;
2313         friend class CursorDrag;
2314         friend class FadeInDrag;
2315         friend class FadeOutDrag;
2316         friend class MarkerDrag;
2317         friend class RegionGainDrag;
2318         friend class ControlPointDrag;
2319         friend class LineDrag;
2320         friend class RubberbandSelectDrag;
2321         friend class EditorRubberbandSelectDrag;
2322         friend class TimeFXDrag;
2323         friend class ScrubDrag;
2324         friend class SelectionDrag;
2325         friend class RangeMarkerBarDrag;
2326         friend class MouseZoomDrag;
2327         friend class RegionCreateDrag;
2328         friend class RegionMotionDrag;
2329         friend class RegionInsertDrag;
2330         friend class VideoTimeLineDrag;
2331
2332         friend class EditorSummary;
2333         friend class EditorGroupTabs;
2334
2335         friend class EditorRoutes;
2336         friend class RhythmFerret;
2337 };
2338
2339 #endif /* __ardour_editor_h__ */