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