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