gtk2_ardour/public_editor.h

   1 /*
   2     Copyright (C) 2000-2007 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 __gtk_ardour_public_editor_h__
  21 #define __gtk_ardour_public_editor_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "gtk2ardour-config.h"
  25 #endif
  26
  27 #include <map>
  28
  29 #include <string>
  30 #include <glib.h>
  31 #include <gdk/gdktypes.h>
  32 #include <gtkmm/box.h>
  33 #include <gtkmm/window.h>
  34 #include <gtkmm/actiongroup.h>
  35 #include <sigc++/signal.h>
  36
  37 #include "evoral/types.hpp"
  38
  39 #include "pbd/statefuldestructible.h"
  40
  41 #include "canvas/fwd.h"
  42 #include "gtkmm2ext/visibility_tracker.h"
  43
  44 #include "editing.h"
  45 #include "selection.h"
  46
  47 namespace ARDOUR {
  48         class Session;
  49         class Region;
  50         class Playlist;
  51         class RouteGroup;
  52         class Trimmable;
  53         class Movable;
  54 }
  55
  56 namespace Gtk {
  57         class Container;
  58         class Menu;
  59 }
  60
  61 namespace Gtkmm2ext {
  62         class TearOff;
  63 }
  64
  65 class AudioRegionView;
  66 class AutomationLine;
  67 class AutomationTimeAxisView;
  68 class ControlPoint;
  69 class DragManager;
  70 class Editor;
  71 class Marker;
  72 class MeterMarker;
  73 class MouseCursors;
  74 class PlaylistSelector;
  75 class PluginSelector;
  76 class PluginUIWindow;
  77 class RegionView;
  78 class RouteTimeAxisView;
  79 class Selection;
  80 class TempoMarker;
  81 class TimeAxisView;
  82 class TimeAxisViewItem;
  83 class VerboseCursor;
  84 class XMLNode;
  85 struct SelectionRect;
  86
  87 class DisplaySuspender;
  88
  89 namespace ARDOUR_UI_UTILS {
  90 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
  91 bool forward_key_press (GdkEventKey* ev);
  92 }
  93
  94 using ARDOUR::framepos_t;
  95 using ARDOUR::framecnt_t;
  96
  97 /// Representation of the interface of the Editor class
  98
  99 /** This class contains just the public interface of the Editor class,
 100  * in order to decouple it from the private implementation, so that callers
 101  * of PublicEditor need not be recompiled if private methods or member variables
 102  * change.
 103  */
 104 class PublicEditor : public Gtk::Window, public PBD::StatefulDestructible, public Gtkmm2ext::VisibilityTracker {
 105   public:
 106         PublicEditor ();
 107         virtual ~PublicEditor ();
 108
 109         /** @return Singleton PublicEditor instance */
 110         static PublicEditor& instance () { return *_instance; }
 111
 112         virtual bool have_idled() const = 0;
 113         virtual void first_idle() = 0;
 114
 115         virtual void setup_tooltips() = 0;
 116
 117         /** Attach this editor to a Session.
 118          * @param s Session to connect to.
 119          */
 120         virtual void set_session (ARDOUR::Session* s) = 0;
 121
 122         /** @return The Session that we are editing, or 0 */
 123         virtual ARDOUR::Session* session () const = 0;
 124
 125         /** Set the snap type.
 126          * @param t Snap type (defined in editing_syms.h)
 127          */
 128         virtual void set_snap_to (Editing::SnapType t) = 0;
 129
 130         virtual Editing::SnapType snap_type () const = 0;
 131         virtual Editing::SnapMode snap_mode () const = 0;
 132
 133         /** Set the snap mode.
 134          * @param m Snap mode (defined in editing_syms.h)
 135          */
 136         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 137
 138         /** Set the snap threshold.
 139          * @param t Snap threshold in `units'.
 140          */
 141         virtual void set_snap_threshold (double t) = 0;
 142
 143         /** Snap a value according to the current snap setting. */
 144         virtual void snap_to (framepos_t& first, int32_t direction = 0, bool for_mark = false) = 0;
 145
 146         /** Undo some transactions.
 147          * @param n Number of transactions to undo.
 148          */
 149
 150         virtual void undo (uint32_t n = 1) = 0;
 151
 152         /** Redo some transactions.
 153          * @param n Number of transaction to redo.
 154          */
 155         virtual void redo (uint32_t n = 1) = 0;
 156
 157         /** Set the mouse mode (gain, object, range, timefx etc.)
 158          * @param m Mouse mode (defined in editing_syms.h)
 159          * @param force Perform the effects of the change even if no change is required
 160          * (ie even if the current mouse mode is equal to @param m)
 161          */
 162         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 163
 164         /** Step the mouse mode onto the next or previous one.
 165          * @param next true to move to the next, otherwise move to the previous
 166          */
 167         virtual void step_mouse_mode (bool next) = 0;
 168
 169         /** @return The current mouse mode (gain, object, range, timefx etc.)
 170          * (defined in editing_syms.h)
 171          */
 172         virtual Editing::MouseMode current_mouse_mode () const = 0;
 173
 174         /** Switch into a mode in which editing is primarily focused on "within" regions,
 175             rather than regions as black-box objects. For Ardour3, this is aimed at
 176             editing MIDI regions but may expand in the future to other types of regions.
 177         */
 178
 179         virtual void set_internal_edit (bool yn) = 0;
 180
 181         /** Driven by a double-click, switch in or out of a mode in which
 182             editing is primarily focused on "within" regions, rather than
 183             regions as black-box objects. For Ardour3, this is aimed at editing
 184             MIDI regions but may expand in the future to other types of
 185             regions.
 186         */
 187
 188         virtual bool toggle_internal_editing_from_double_click (GdkEvent*) = 0;
 189
 190         /** @return Whether editing is currently in "internal" mode or not
 191          */
 192
 193         virtual bool internal_editing() const = 0;
 194
 195         /** Possibly start the audition of a region.  If @param r is 0, or not an AudioRegion
 196          * any current audition is cancelled.  If we are currently auditioning @param r,
 197          * the audition will be cancelled.  Otherwise an audition of @param r will start.
 198          * \param r Region to consider.
 199          */
 200         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 201
 202         virtual void new_region_from_selection () = 0;
 203         virtual void separate_region_from_selection () = 0;
 204
 205         virtual void transition_to_rolling (bool fwd) = 0;
 206         virtual framepos_t pixel_to_sample (double pixel) const = 0;
 207         virtual double sample_to_pixel (framepos_t frame) const = 0;
 208         virtual double sample_to_pixel_unrounded (framepos_t frame) const = 0;
 209         virtual Selection& get_selection () const = 0;
 210         virtual Selection& get_cut_buffer () const = 0;
 211         virtual void track_mixer_selection () = 0;
 212         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 213         virtual void play_selection () = 0;
 214         virtual void play_with_preroll () = 0;
 215         virtual void maybe_locate_with_edit_preroll (framepos_t location) = 0;
 216         virtual void goto_nth_marker (int nth) = 0;
 217         virtual void add_location_from_playhead_cursor () = 0;
 218         virtual void remove_location_at_playhead_cursor () = 0;
 219         virtual void set_show_measures (bool yn) = 0;
 220         virtual bool show_measures () const = 0;
 221
 222         virtual Editing::MouseMode effective_mouse_mode () const = 0;
 223
 224         /** Import existing media */
 225         virtual void do_import (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode, ARDOUR::SrcQuality, framepos_t&) = 0;
 226         virtual void do_embed (std::vector<std::string> paths, Editing::ImportDisposition, Editing::ImportMode mode,  framepos_t&) = 0;
 227
 228         /** Open main export dialog */
 229         virtual void export_audio () = 0;
 230
 231         /** Open stem export dialog */
 232         virtual void stem_export () = 0;
 233
 234         /** Open export dialog with current selection pre-selected */
 235         virtual void export_selection () = 0;
 236
 237         /** Open export dialog with current range pre-selected */
 238         virtual void export_range () = 0;
 239
 240         virtual void register_actions () = 0;
 241         virtual void add_transport_frame (Gtk::Container&) = 0;
 242         virtual void add_toplevel_menu (Gtk::Container&) = 0;
 243         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 244         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 245         virtual framecnt_t get_current_zoom () const = 0;
 246         virtual PlaylistSelector& playlist_selector() const = 0;
 247         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 248         virtual void new_playlists (TimeAxisView*) = 0;
 249         virtual void copy_playlists (TimeAxisView*) = 0;
 250         virtual void clear_playlists (TimeAxisView*) = 0;
 251         virtual void select_all_tracks () = 0;
 252         virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 253         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 254         virtual void hide_track_in_display (TimeAxisView* tv, bool apply_to_selection = false) = 0;
 255
 256         virtual void set_stationary_playhead (bool yn) = 0;
 257         virtual void toggle_stationary_playhead () = 0;
 258         virtual bool stationary_playhead() const = 0;
 259
 260         /** Set whether the editor should follow the playhead.
 261          * @param yn true to follow playhead, otherwise false.
 262          * @param catch_up true to reset the editor view to show the playhead (if yn == true), otherwise false.
 263          */
 264         virtual void set_follow_playhead (bool yn, bool catch_up = false) = 0;
 265
 266         /** Toggle whether the editor is following the playhead */
 267         virtual void toggle_follow_playhead () = 0;
 268
 269         /** @return true if the editor is following the playhead */
 270         virtual bool follow_playhead () const = 0;
 271
 272         /** @return true if the playhead is currently being dragged, otherwise false */
 273         virtual bool dragging_playhead () const = 0;
 274         virtual void ensure_float (Gtk::Window&) = 0;
 275         virtual void show_window () = 0;
 276         virtual framepos_t leftmost_sample() const = 0;
 277         virtual framecnt_t current_page_samples() const = 0;
 278         virtual double visible_canvas_height () const = 0;
 279         virtual void temporal_zoom_step (bool coarser) = 0;
 280         virtual void ensure_time_axis_view_is_visible (TimeAxisView const & tav, bool at_top = false) = 0;
 281         virtual void override_visible_track_count () = 0;
 282         virtual void scroll_tracks_down_line () = 0;
 283         virtual void scroll_tracks_up_line () = 0;
 284         virtual bool scroll_down_one_track () = 0;
 285         virtual bool scroll_up_one_track () = 0;
 286         virtual void prepare_for_cleanup () = 0;
 287         virtual void finish_cleanup () = 0;
 288         virtual void reset_x_origin (framepos_t frame) = 0;
 289         virtual void remove_last_capture () = 0;
 290         virtual void maximise_editing_space () = 0;
 291         virtual void restore_editing_space () = 0;
 292         virtual void update_tearoff_visibility () = 0;
 293         virtual framepos_t get_preferred_edit_position (bool ignore_playhead = false, bool from_context_menu = false) = 0;
 294         virtual void toggle_meter_updating() = 0;
 295         virtual void split_regions_at (framepos_t, RegionSelection&) = 0;
 296         virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret, bool select_new = false) = 0;
 297         virtual void mouse_add_new_marker (framepos_t where, bool is_cd=false, bool is_xrun=false) = 0;
 298         virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
 299         virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
 300         virtual framecnt_t get_nudge_distance (framepos_t pos, framecnt_t& next) = 0;
 301         virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, framepos_t position) = 0;
 302         virtual void edit_notes (TimeAxisViewItem&) = 0;
 303
 304         virtual void queue_visual_videotimeline_update () = 0;
 305         virtual void set_close_video_sensitive (bool) = 0;
 306         virtual void toggle_ruler_video (bool) = 0;
 307         virtual void toggle_xjadeo_proc (int) = 0;
 308         virtual void toggle_xjadeo_viewoption (int, int) = 0;
 309         virtual void set_xjadeo_sensitive (bool onoff) = 0;
 310         virtual int  get_videotl_bar_height () const = 0;
 311         virtual void set_video_timeline_height (const int h) = 0;
 312         virtual void embed_audio_from_video (std::string, framepos_t n = 0, bool lock_position_to_video = true) = 0;
 313         virtual void export_video (bool range = false) = 0;
 314
 315         virtual RouteTimeAxisView* get_route_view_by_route_id (const PBD::ID& id) const = 0;
 316
 317         virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, PBD::PropertyID) const = 0;
 318
 319         sigc::signal<void> ZoomChanged;
 320         sigc::signal<void> Realized;
 321         sigc::signal<void,framepos_t> UpdateAllTransportClocks;
 322
 323         static sigc::signal<void> DropDownKeys;
 324
 325         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 326         Glib::RefPtr<Gtk::ActionGroup> editor_menu_actions;
 327         Glib::RefPtr<Gtk::ActionGroup> _region_actions;
 328
 329         virtual void reset_focus () = 0;
 330
 331         virtual bool canvas_scroll_event (GdkEventScroll* event, bool from_canvas) = 0;
 332         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 333         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 334         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 335         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 336         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 337         virtual bool canvas_start_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 338         virtual bool canvas_end_xfade_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 339         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 340         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 341         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 342         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*, bool) = 0;
 343         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 344         virtual bool canvas_wave_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 345         virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 346         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 347         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 348         virtual bool canvas_feature_line_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 349         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 350         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
 351         virtual bool canvas_videotl_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 352         virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 353         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 354         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 355         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 356
 357         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 358         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 359         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 360         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 361         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 362         virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 363
 364         static const int window_border_width;
 365         static const int container_border_width;
 366         static const int vertical_spacing;
 367         static const int horizontal_spacing;
 368
 369 #ifdef TOP_MENUBAR
 370         /*
 371          * This is needed for OS X primarily
 372          * but also any other OS that uses a single
 373          * top menubar instead of per window menus
 374          */
 375         virtual Gtk::HBox& get_status_bar_packer() = 0;
 376 #endif
 377
 378         virtual ArdourCanvas::Container* get_trackview_group () const = 0;
 379         virtual ArdourCanvas::ScrollGroup* get_hscroll_group () const = 0;
 380         virtual ArdourCanvas::ScrollGroup* get_vscroll_group () const = 0;
 381         virtual ArdourCanvas::ScrollGroup* get_hvscroll_group () const = 0;
 382
 383         virtual ArdourCanvas::GtkCanvasViewport* get_track_canvas() const = 0;
 384
 385         virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
 386
 387         virtual void set_current_trimmable (boost::shared_ptr<ARDOUR::Trimmable>) = 0;
 388         virtual void set_current_movable (boost::shared_ptr<ARDOUR::Movable>) = 0;
 389
 390         virtual void center_screen (framepos_t) = 0;
 391
 392         virtual TrackViewList axis_views_from_routes (boost::shared_ptr<ARDOUR::RouteList>) const = 0;
 393         virtual TrackViewList const & get_track_views () = 0;
 394
 395         virtual Gtkmm2ext::TearOff* mouse_mode_tearoff () const = 0;
 396         virtual Gtkmm2ext::TearOff* tools_tearoff () const = 0;
 397
 398         virtual DragManager* drags () const = 0;
 399         virtual void maybe_autoscroll (bool, bool, bool from_headers) = 0;
 400         virtual void stop_canvas_autoscroll () = 0;
 401         virtual bool autoscroll_active() const = 0;
 402
 403         virtual MouseCursors const * cursors () const = 0;
 404         virtual VerboseCursor * verbose_cursor () const = 0;
 405
 406         virtual bool get_smart_mode () const = 0;
 407
 408         virtual void get_pointer_position (double &, double &) const = 0;
 409
 410         virtual ARDOUR::Location* find_location_from_marker (Marker *, bool &) const = 0;
 411         virtual Marker* find_marker_from_location_id (PBD::ID const &, bool) const = 0;
 412
 413         virtual void snap_to_with_modifier (framepos_t &, GdkEvent const *, int32_t direction = 0, bool for_mark = false) = 0;
 414
 415         virtual void get_regions_at (RegionSelection &, framepos_t where, TrackViewList const &) const = 0;
 416         virtual RegionSelection get_regions_from_selection_and_mouse (framepos_t) = 0;
 417
 418         /// Singleton instance, set up by Editor::Editor()
 419
 420         static PublicEditor* _instance;
 421
 422         friend bool ARDOUR_UI_UTILS::relay_key_press (GdkEventKey*, Gtk::Window*);
 423         friend bool ARDOUR_UI_UTILS::forward_key_press (GdkEventKey*);
 424
 425         PBD::Signal0<void> SnapChanged;
 426         PBD::Signal0<void> MouseModeChanged;
 427
 428   protected:
 429         friend class DisplaySuspender;
 430         virtual void suspend_route_redisplay () = 0;
 431         virtual void resume_route_redisplay () = 0;
 432         gint _suspend_route_redisplay_counter;
 433 };
 434
 435 class DisplaySuspender {
 436         public:
 437                 DisplaySuspender() {
 438                         if (g_atomic_int_add(&PublicEditor::instance()._suspend_route_redisplay_counter, 1) == 0) {
 439                                 PublicEditor::instance().suspend_route_redisplay ();
 440                         }
 441                 }
 442                 ~DisplaySuspender () {
 443                         if (g_atomic_int_dec_and_test (&PublicEditor::instance()._suspend_route_redisplay_counter)) {
 444                                 PublicEditor::instance().resume_route_redisplay ();
 445                         }
 446                 }
 447 };
 448
 449 #endif // __gtk_ardour_public_editor_h__