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