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