gtk2_ardour/editor.h

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