gtk2_ardour/editor.h

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