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