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