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/window.h>
  29 #include <gtkmm/actiongroup.h>
  30 #include <jack/types.h>
  31 #include <sigc++/signal.h>
  32
  33 #include <pbd/statefuldestructible.h>
  34
  35 #include "editing.h"
  36 #include "canvas.h"
  37 #include "selection.h"
  38
  39 namespace ARDOUR {
  40         class Session;
  41         class AudioExportSpecification;
  42         class Region;
  43         class Playlist;
  44         class RouteGroup;
  45 }
  46
  47 namespace Gtk {
  48         class Container;
  49         class Menu;
  50 }
  51
  52 class Editor;
  53 class TimeAxisViewItem;
  54 class TimeAxisView;
  55 class PluginUIWindow;
  56 class PluginSelector;
  57 class PlaylistSelector;
  58 class XMLNode;
  59 class Selection;
  60 class AutomationLine;
  61 class ControlPoint;
  62 class SelectionRect;
  63 class CrossfadeView;
  64 class RouteTimeAxisView;
  65 class RegionView;
  66 class AudioRegionView;
  67 class TempoMarker;
  68 class MeterMarker;
  69 class Marker;
  70 class AutomationTimeAxisView;
  71 class MarkerTimeAxis;
  72 class ImageFrameView;
  73 class ImageFrameTimeAxis;
  74 class MarkerView;
  75
  76 /// Representation of the interface of the Editor class
  77
  78 /** This class contains just the public interface of the Editor class,
  79  * in order to decouple it from the private implementation, so that callers
  80  * of PublicEditor need not be recompiled if private methods or member variables
  81  * change.
  82  */
  83 class PublicEditor : public Gtk::Window, public PBD::StatefulThingWithGoingAway {
  84   public:
  85         PublicEditor ();
  86         virtual ~PublicEditor ();
  87
  88         typedef list<TimeAxisView *> TrackViewList;
  89
  90         /** @return Singleton PublicEditor instance */
  91         static PublicEditor& instance () { return *_instance; }
  92
  93         /** Attach this editor to a Session.
  94          * @param s Session to connect to.
  95          */
  96         virtual void connect_to_session (ARDOUR::Session* s) = 0;
  97
  98         /** @return The Session that we are editing, or 0 */
  99         virtual ARDOUR::Session* current_session () const = 0;
 100
 101         /** Set the snap type.
 102          * @param t Snap type (defined in editing_syms.h)
 103          */
 104         virtual void set_snap_to (Editing::SnapType t) = 0;
 105
 106         /** Set the snap mode.
 107          * @param m Snap mode (defined in editing_syms.h)
 108          */
 109         virtual void set_snap_mode (Editing::SnapMode m) = 0;
 110
 111         /** Set the snap threshold.
 112          * @param t Snap threshold in `units'.
 113          */
 114         virtual void set_snap_threshold (double t) = 0;
 115
 116         /** Undo some transactions.
 117          * @param n Number of transactions to undo.
 118          */
 119         virtual void undo (uint32_t n = 1) = 0;
 120
 121         /** Redo some transactions.
 122          * @param n Number of transaction to redo.
 123          */
 124         virtual void redo (uint32_t n = 1) = 0;
 125
 126         /** Set the mouse mode (gain, object, range, timefx etc.)
 127          * @param m Mouse mode (defined in editing_syms.h)
 128          * @param force Perform the effects of the change even if no change is required
 129          * (ie even if the current mouse mode is equal to \ref m)
 130          */
 131         virtual void set_mouse_mode (Editing::MouseMode m, bool force = false) = 0;
 132
 133         /** Step the mouse mode onto the next or previous one.
 134          * @param next true to move to the next, otherwise move to the previous
 135          */
 136         virtual void step_mouse_mode (bool next) = 0;
 137
 138         /** @return The current mouse mode (gain, object, range, timefx etc.)
 139          * (defined in editing_syms.h)
 140          */
 141         virtual Editing::MouseMode current_mouse_mode () const = 0;
 142
 143         /** Possibly start the audition of a region.  If \ref r is 0, or not an AudioRegion
 144          * any current audition is cancelled.  If we are currently auditioning \ref r,
 145          * the audition will be cancelled.  Otherwise an audition of \ref r will start.
 146          * \param r Region to consider.
 147          */
 148         virtual void consider_auditioning (boost::shared_ptr<ARDOUR::Region> r) = 0;
 149
 150         /** Set whether waveforms should be shown for audio tracks.
 151          * @param yn true to show waveforms, otherwise false.
 152          */
 153         virtual void set_show_waveforms (bool yn) = 0;
 154
 155         /** @return true if waveforms are being shown, otherwise false */
 156         virtual bool show_waveforms () const = 0;
 157
 158         /** Set whether waveforms should be shown while recording audio tracks.
 159          * @param yn true to show waveforms, otherwise false.
 160          */
 161         virtual void set_show_waveforms_recording (bool yn) = 0;
 162
 163         /** @return true if waveforms are being shown while recording, otherwise false */
 164         virtual bool show_waveforms_recording () const = 0;
 165         virtual void new_region_from_selection () = 0;
 166         virtual void separate_region_from_selection () = 0;
 167
 168         virtual void toggle_playback (bool with_abort) = 0;
 169         virtual void transition_to_rolling (bool fwd) = 0;
 170         virtual nframes_t unit_to_frame (double unit) = 0;
 171         virtual double frame_to_unit (nframes_t frame) = 0;
 172         virtual double frame_to_unit (double frame) = 0;
 173         virtual nframes_t pixel_to_frame (double pixel) = 0;
 174         virtual gulong frame_to_pixel (nframes_t frame) = 0;
 175         virtual Selection& get_selection () const = 0;
 176         virtual Selection& get_cut_buffer () const = 0;
 177         virtual bool extend_selection_to_track (TimeAxisView&) = 0;
 178         virtual void play_selection () = 0;
 179         virtual void set_show_measures (bool yn) = 0;
 180         virtual bool show_measures () const = 0;
 181
 182         /** Open an export dialogue for the whole session */
 183         virtual void export_session () = 0;
 184
 185         /** Open an export dialogue for currently selected time range, if there
 186          * is one; if not an error is displayed to the user.
 187          */
 188         virtual void export_selection () = 0;
 189
 190         /** Open an export dialogue for marked ranges */
 191         virtual void export_range_markers () = 0;
 192         virtual void register_actions () = 0;
 193         virtual void add_toplevel_controls (Gtk::Container&) = 0;
 194         virtual void set_zoom_focus (Editing::ZoomFocus) = 0;
 195         virtual Editing::ZoomFocus get_zoom_focus () const = 0;
 196         virtual gdouble get_current_zoom () = 0;
 197         virtual PlaylistSelector& playlist_selector () const = 0;
 198         virtual void route_name_changed (TimeAxisView *) = 0;
 199         virtual void clear_playlist (boost::shared_ptr<ARDOUR::Playlist>) = 0;
 200         virtual void new_playlists () = 0;
 201         virtual void copy_playlists () = 0;
 202         virtual void clear_playlists () = 0;
 203         virtual void select_all_tracks () = 0;
 204         virtual bool set_selected_track (TimeAxisView&, Selection::Operation op = Selection::Set, bool no_remove = false) = 0;
 205         virtual void set_selected_mixer_strip (TimeAxisView&) = 0;
 206         virtual void hide_track_in_display (TimeAxisView& tv) = 0;
 207         virtual void show_track_in_display (TimeAxisView& tv) = 0;
 208
 209         /** Set whether the editor should follow the playhead.
 210          * @param yn true to follow playhead, otherwise false.
 211          */
 212         virtual void set_follow_playhead (bool yn) = 0;
 213
 214         /** Toggle whether the editor is following the playhead */
 215         virtual void toggle_follow_playhead () = 0;
 216
 217         /** @return true if the editor is following the playhead */
 218         virtual bool follow_playhead () const = 0;
 219
 220         /** @return true if the playhead is currently being dragged, otherwise false */
 221         virtual bool dragging_playhead () const = 0;
 222         virtual void ensure_float (Gtk::Window&) = 0;
 223         virtual void show_window () = 0;
 224         virtual TrackViewList* get_valid_views (TimeAxisView*, ARDOUR::RouteGroup* grp = 0) = 0;
 225         virtual nframes_t leftmost_position () const = 0;
 226         virtual nframes_t current_page_frames () const = 0;
 227         virtual void temporal_zoom_step (bool coarser) = 0;
 228         virtual void scroll_tracks_down_line () = 0;
 229         virtual void scroll_tracks_up_line () = 0;
 230         virtual bool new_regionviews_display_gain () = 0;
 231         virtual void prepare_for_cleanup () = 0;
 232         virtual void reset_x_origin (nframes_t frame) = 0;
 233         virtual void remove_last_capture () = 0;
 234         virtual void maximise_editing_space () = 0;
 235         virtual void restore_editing_space () = 0;
 236         virtual nframes_t edit_cursor_position (bool sync) = 0;
 237
 238 #ifdef WITH_CMT
 239         virtual void add_imageframe_time_axis(const std::string & track_name, void*)  = 0;
 240         virtual void add_imageframe_marker_time_axis(const std::string & track_name, TimeAxisView* marked_track, void*)  = 0;
 241         virtual void connect_to_image_compositor()  = 0;
 242         virtual void scroll_timeaxis_to_imageframe_item(const TimeAxisViewItem* item)  = 0;
 243         virtual TimeAxisView* get_named_time_axis(const std::string & name)  = 0;
 244 #endif
 245
 246         sigc::signal<void> ZoomFocusChanged;
 247         sigc::signal<void> ZoomChanged;
 248         sigc::signal<void> Resized;
 249         sigc::signal<void> Realized;
 250         sigc::signal<void,nframes_t> UpdateAllTransportClocks;
 251
 252         Glib::RefPtr<Gtk::ActionGroup> editor_actions;
 253
 254         virtual void reset_focus () = 0;
 255
 256         virtual bool canvas_control_point_event (GdkEvent* event, ArdourCanvas::Item*, ControlPoint*) = 0;
 257         virtual bool canvas_line_event (GdkEvent* event, ArdourCanvas::Item*, AutomationLine*) = 0;
 258         virtual bool canvas_selection_rect_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 259         virtual bool canvas_selection_start_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 260         virtual bool canvas_selection_end_trim_event (GdkEvent* event, ArdourCanvas::Item*, SelectionRect*) = 0;
 261         virtual bool canvas_crossfade_view_event (GdkEvent* event, ArdourCanvas::Item*, CrossfadeView*) = 0;
 262         virtual bool canvas_fade_in_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 263         virtual bool canvas_fade_in_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 264         virtual bool canvas_fade_out_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 265         virtual bool canvas_fade_out_handle_event (GdkEvent* event, ArdourCanvas::Item*, AudioRegionView*) = 0;
 266         virtual bool canvas_region_view_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 267         virtual bool canvas_region_view_name_highlight_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 268         virtual bool canvas_region_view_name_event (GdkEvent* event, ArdourCanvas::Item*, RegionView*) = 0;
 269         virtual bool canvas_stream_view_event (GdkEvent* event, ArdourCanvas::Item*, RouteTimeAxisView*) = 0;
 270         virtual bool canvas_marker_event (GdkEvent* event, ArdourCanvas::Item*, Marker*) = 0;
 271         virtual bool canvas_zoom_rect_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 272         virtual bool canvas_tempo_marker_event (GdkEvent* event, ArdourCanvas::Item*, TempoMarker*) = 0;
 273         virtual bool canvas_meter_marker_event (GdkEvent* event, ArdourCanvas::Item*, MeterMarker*) = 0;
 274         virtual bool canvas_automation_track_event(GdkEvent* event, ArdourCanvas::Item*, AutomationTimeAxisView*) = 0;
 275
 276         virtual bool canvas_tempo_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 277         virtual bool canvas_meter_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 278         virtual bool canvas_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 279         virtual bool canvas_range_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 280         virtual bool canvas_transport_marker_bar_event (GdkEvent* event, ArdourCanvas::Item*) = 0;
 281
 282 #ifdef WITH_CMT
 283         virtual bool canvas_imageframe_item_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 284         virtual bool canvas_imageframe_view_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameTimeAxis*) = 0;
 285         virtual bool canvas_imageframe_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 286         virtual bool canvas_imageframe_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,ImageFrameView*) = 0;
 287         virtual bool canvas_marker_time_axis_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerTimeAxis*) = 0;
 288         virtual bool canvas_markerview_item_view_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 289         virtual bool canvas_markerview_start_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 290         virtual bool canvas_markerview_end_handle_event(GdkEvent* event, ArdourCanvas::Item*,MarkerView*) = 0;
 291 #endif
 292
 293         /// Singleton instance, set up by Editor::Editor()
 294         static PublicEditor* _instance;
 295
 296         friend class PluginUIWindow;
 297 };
 298
 299 #endif // __gtk_ardour_public_editor_h__