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