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