gtk2_ardour/editor.h

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