gtk2_ardour/editor.h

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