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