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