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