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