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