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