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 #include <map>
  24
  25 #include <string>
  26 #include <glib.h>
  27 #include <gdk/gdktypes.h>
  28 #include <gtkmm/box.h>
  29 #include <gtkmm/window.h>
  30 #include <gtkmm/actiongroup.h>
  31 #include <jack/types.h>
  32 #include <sigc++/signal.h>
  33
  34 #include "evoral/types.hpp"
  35 #include "ardour/route_group.h"
  36
  37 #include "pbd/statefuldestructible.h"
  38
  39 #include "editing.h"
  40 #include "canvas.h"
  41 #include "selection.h"
  42
  43 namespace ARDOUR {
  44         class Session;
  45         class Region;
  46         class Playlist;
  47         class RouteGroup;
  48 }
  49
  50 namespace Gtk {
  51         class Container;
  52         class Menu;
  53 }
  54
  55 class Editor;
  56 class TimeAxisViewItem;
  57 class TimeAxisView;
  58 class PluginUIWindow;
  59 class PluginSelector;
  60 class PlaylistSelector;
  61 class XMLNode;
  62 class Selection;
  63 class AutomationLine;
  64 class ControlPoint;
  65 class SelectionRect;
  66 class CrossfadeView;
  67 class RouteTimeAxisView;
  68 class RegionView;
  69 class AudioRegionView;
  70 class TempoMarker;
  71 class MeterMarker;
  72 class Marker;
  73 class AutomationTimeAxisView;
  74 class MarkerTimeAxis;
  75 class ImageFrameView;
  76 class ImageFrameTimeAxis;
  77 class MarkerView;
  78
  79 /// Representation of the interface of the Editor class
  80
  81 /** This class contains just the public interface of the Editor class,
  82  * in order to decouple it from the private implementation, so that callers
  83  * of PublicEditor need not be recompiled if private methods or member variables
  84  * change.
  85  */
  86 class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway {
  87   public:
  88         PublicEditor ();
  89         virtual ~PublicEditor ();
  90
  91         typedef TrackSelection TrackViewList;
  92
  93         /** @return Singleton PublicEditor instance */
  94         static PublicEditor& instance () { return *_instance; }
  95
  96         virtual bool have_idled() const = 0;
  97         virtual void first_idle() = 0;
  98
  99         /** Attach this editor to a Session.
 100          * @param s Session to connect to.
 101          */
 102         virtual void connect_to_session (ARDOUR::Session* s) = 0;
 103
 104         /** @return The Session that we are editing, or 0 */
 105         virtual ARDOUR::Session* current_session () const = 0;
 106
 107         /** Set the snap type.
 108          * @param t Snap type (defined in editing_syms.h)
 109          */
 110         virtual void set_snap_to (Editing::SnapType t) = 0;
 111
 112         virtual Editing::SnapType snap_type () const = 0;
 113         virtual Editing::SnapMode snap_mode () const = 0;
 114
 115         /** Set the snap mode.
 116          * @param m Snap mode (defined in editing_syms.h)
 117          */
 118         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 119
 120         /** Set the snap threshold.
 121          * @param t Snap threshold in `units'.
 122          */
 123         virtual void set_snap_threshold (double t) = 0;
 124
 125         /** Snap a value according to the current snap setting. */
 126         virtual void snap_to (nframes64_t& first, int32_t direction = 0, bool for_mark = false) = 0;
 127
 128         /** Undo some transactions.
 129          * @param n Number of transactions to undo.
 130          */
 131
 132         virtual void undo (uint32_t n = 1) = 0;
 133
 134         /** Redo some transactions.
 135          * @param n Number of transaction to redo.
 136          */
 137         virtual void redo (uint32_t n = 1) = 0;
 138
 139         /** Set the mouse mode (gain, object, range, timefx etc.)
 140          * @param m Mouse mode (defined in editing_syms.h)
 141          * @param force Perform the effects of the change even if no change is required
 142          * (ie even if the current mouse mode is equal to \ref m)
 143          */
 144         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 145
 146         /** Step the mouse mode onto the next or previous one.
 147          * @param next true to move to the next, otherwise move to the previous
 148          */
 149         virtual void step_mouse_mode (bool next) = 0;
 150
 151         /** @return The current mouse mode (gain, object, range, timefx etc.)
 152          * (defined in editing_syms.h)
 153          */
 154         virtual Editing::MouseMode current_mouse_mode () const = 0;
 155
 156         /** Switch into a mode in which editing is primarily focused on "within" regions,
 157             rather than regions as black-box objects. For Ardour3, this is aimed at
 158             editing MIDI regions but may expand in the future to other types of regions.
 159         */
 160
 161         virtual void set_internal_edit (bool yn) = 0;
 162
 163         /** @return Whether editing is currently in "internal" mode or not
 164          */
 165
 166         virtual bool internal_editing() const = 0;
 167
 168         /** @return Sound edited notes in MIDI regions while editing
 169          */
 170         virtual bool sound_notes () const = 0;
 171
 172         /** Possibly start the audition of a region.  If \ref r is 0, or not an AudioRegion
 173          * any current audition is cancelled.  If we are currently auditioning \ref r,
 174          * the audition will be cancelled.  Otherwise an audition of \ref r will start.
 175          * \param r Region to consider.
 176          */
 177         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 178
 179         /** Set whether waveforms should be shown while recording audio tracks.
 180          * @param yn true to show waveforms, otherwise false.
 181          */
 182         virtual void set_show_waveforms_recording (bool yn) = 0;
 183
 184         /** @return true if waveforms are being shown while recording, otherwise false */
 185         virtual bool show_waveforms_recording () const = 0;
 186         virtual void new_region_from_selection () = 0;
 187         virtual void separate_region_from_selection () = 0;
 188
 189         virtual void transition_to_rolling (bool fwd) = 0;
 190         virtual nframes64_t unit_to_frame (double unit) const = 0;
 191         // XXX remove me when libardour goes nframes64_t
 192         double frame_to_unit (nframes_t frame) const {
 193                 return frame_to_unit ((nframes64_t) frame);
 194         }
 195         virtual double frame_to_unit (nframes64_t frame) const = 0;
 196         virtual double frame_to_unit (double frame) const = 0;
 197         virtual nframes64_t pixel_to_frame (double pixel) const = 0;
 198         virtual gulong frame_to_pixel (nframes64_t frame) const = 0;
 199         virtual Selection& get_selection () const = 0;
 200         virtual Selection& get_cut_buffer () const = 0;
 201         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 202         virtual void play_selection () = 0;
 203         virtual void set_show_measures (bool yn) = 0;
 204         virtual bool show_measures () const = 0;
 205         virtual bool redraw_measures () = 0;
 206
 207         /** Open main export dialog */
 208         virtual void export_audio () = 0;
 209
 210         /** Open export dialog with current selection pre-selected */
 211         virtual void export_selection () = 0;
 212
 213         /** Open export dialog with current range pre-selected */
 214         virtual void export_range () = 0;
 215
 216         virtual void register_actions () = 0;
 217         virtual void add_toplevel_controls (Gtk::Container&) = 0;
 218         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 219         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 220         virtual gdouble   get_current_zoom () const = 0;
 221         virtual PlaylistSelector& playlist_selector() const = 0;
 222         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 223         virtual void new_playlists (TimeAxisView*) = 0;
 224         virtual void copy_playlists (TimeAxisView*) = 0;
 225         virtual void clear_playlists (TimeAxisView*) = 0;
 226         virtual void select_all_tracks () = 0;
 227         virtual void set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 228         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 229         virtual void hide_track_in_display (TimeAxisView& tv, bool temporary = false) = 0;
 230
 231         /** Set whether the editor should follow the playhead.
 232          * @param yn true to follow playhead, otherwise false.
 233          */
 234         virtual void set_follow_playhead (bool yn) = 0;
 235
 236         /** Toggle whether the editor is following the playhead */
 237         virtual void toggle_follow_playhead () = 0;
 238
 239         /** @return true if the editor is following the playhead */
 240         virtual bool follow_playhead () const = 0;
 241
 242         /** @return true if the playhead is currently being dragged, otherwise false */
 243         virtual bool dragging_playhead () const = 0;
 244         virtual double get_physical_screen_width() const = 0;
 245         virtual void ensure_float (Gtk::Window&) = 0;
 246         virtual void show_window () = 0;
 247         virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
 248         virtual nframes64_t leftmost_position() const = 0;
 249         virtual nframes64_t current_page_frames() const = 0;
 250         virtual void temporal_zoom_step (bool coarser) = 0;
 251         virtual void scroll_tracks_down_line () = 0;
 252         virtual void scroll_tracks_up_line () = 0;
 253         virtual bool new_regionviews_display_gain () = 0;
 254         virtual void prepare_for_cleanup () = 0;
 255         virtual void finish_cleanup () = 0;
 256         virtual void reset_x_origin (nframes64_t frame) = 0;
 257         virtual void remove_last_capture () = 0;
 258         virtual void maximise_editing_space () = 0;
 259         virtual void restore_editing_space () = 0;
 260         virtual nframes64_t get_preferred_edit_position (bool ignore_playhead = false) = 0;
 261         virtual void toggle_meter_updating() = 0;
 262         virtual void split_region_at_points (boost::shared_ptr<ARDOUR::Region>, ARDOUR::AnalysisFeatureList&, bool can_ferret) = 0;
 263         virtual void mouse_add_new_marker (nframes64_t where, bool is_cd=false, bool is_xrun=false) = 0;
 264         virtual void foreach_time_axis_view (sigc::slot<void,TimeAxisView&>) = 0;
 265         virtual void add_to_idle_resize (TimeAxisView*, int32_t) = 0;
 266         virtual nframes64_t get_nudge_distance (nframes64_t pos, nframes64_t& next) = 0;
 267         virtual Evoral::MusicalTime get_grid_type_as_beats (bool& success, nframes64_t position) = 0;
 268
 269 #ifdef WITH_CMT
 270         virtual void connect_to_image_compositor()  = 0;
 271         virtual void add_imageframe_time_axis(const std::string & track_name, void*)  = 0;
 272         virtual void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*)  = 0;
 273         virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item)  = 0;
 274         virtual TimeAxisView* get_named_time_axis(const std::string & name)  = 0;
 275 #endif
 276
 277         virtual RouteTimeAxisView* get_route_view_by_id (PBD::ID& id) = 0;
 278
 279         virtual void get_equivalent_regions (RegionView* rv, std::vector<RegionView*>&, ARDOUR::RouteGroup::Property) const = 0;
 280
 281         sigc::signal<void> ZoomFocusChanged;
 282         sigc::signal<void> ZoomChanged;
 283         sigc::signal<void> Resized;
 284         sigc::signal<void> Realized;
 285         sigc::signal<void,nframes64_t> UpdateAllTransportClocks;
 286
 287         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 288
 289         virtual void reset_focus () = 0;
 290
 291         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 292         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 293         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 294         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 295         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 296         virtual bool canvas_crossfade_view_event (GdkEvent* event, ArdourCanvas::Item*, CrossfadeView*) = 0;
 297         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 298         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 299         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 300         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 301         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 302         virtual bool canvas_frame_handle_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 303         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 304         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 305         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 306         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
 307         virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 308         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 309         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 310         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 311
 312         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 313         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 314         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 315         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 316         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 317         virtual bool canvas_note_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 318
 319 #ifdef WITH_CMT
 320         virtual bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 321         virtual bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*) = 0;
 322         virtual bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 323         virtual bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 324         virtual bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*) = 0;
 325         virtual bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 326         virtual bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 327         virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 328 #endif
 329
 330         static const int window_border_width;
 331         static const int container_border_width;
 332         static const int vertical_spacing;
 333         static const int horizontal_spacing;
 334
 335 #ifdef TOP_MENUBAR
 336         /*
 337          * This is needed for OS X primarily
 338          * but also any other OS that uses a single
 339          * top menubar instead of per window menus
 340          */
 341         virtual Gtk::HBox& get_status_bar_packer() = 0;
 342 #endif
 343
 344         virtual gdouble get_trackview_group_vertical_offset () const = 0;
 345         virtual gdouble get_canvas_timebars_vsize () const = 0;
 346         virtual ArdourCanvas::Group* get_background_group () const = 0;
 347         virtual ArdourCanvas::Group* get_trackview_group () const = 0;
 348
 349         virtual TimeAxisView* axis_view_from_route (boost::shared_ptr<ARDOUR::Route>) const = 0;
 350
 351         virtual void show_verbose_canvas_cursor_with (const std::string& txt) = 0;
 352         virtual void hide_verbose_canvas_cursor() = 0;
 353
 354         virtual void center_screen (nframes64_t) = 0;
 355
 356         /// Singleton instance, set up by Editor::Editor()
 357
 358         static PublicEditor* _instance;
 359
 360         friend bool relay_key_press (GdkEventKey*, Gtk::Window*);
 361 };
 362
 363 #endif // __gtk_ardour_public_editor_h__