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