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