gtk2_ardour/editor.h

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