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