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