OSC: make remote port setting possible, add default surface variables
[ardour.git] / gtk2_ardour / automation_line.h
index e922de6c8075e229e84093d4e0d112f819141de0..d51e437bdd7fea04607c9524f9bed7775241860c 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2002 Paul Davis 
+    Copyright (C) 2002 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_automation_line_h__
 #include <string>
 #include <sys/types.h>
 
-#include <libgnomecanvasmm/line.h>
 #include <sigc++/signal.h>
-#include "canvas.h"
-#include "simplerect.h"
-#include <pbd/undo.h>
 
-#include <ardour/automation_event.h>
+#include "evoral/TimeConverter.hpp"
 
+#include "pbd/undo.h"
+#include "pbd/statefuldestructible.h"
+#include "pbd/memento_command.h"
 
-using std::vector;
-using std::string;
+#include "ardour/automation_list.h"
+#include "ardour/parameter_descriptor.h"
+#include "ardour/types.h"
+
+#include "canvas/types.h"
+#include "canvas/container.h"
+#include "canvas/poly_line.h"
 
 class AutomationLine;
 class ControlPoint;
@@ -45,190 +48,198 @@ class TimeAxisView;
 class AutomationTimeAxisView;
 class Selectable;
 class Selection;
+class PublicEditor;
 
-namespace Gnome {
-       namespace Canvas {
-               class SimpleRect;
-       }
-}
 
-class ControlPoint 
+/** A GUI representation of an ARDOUR::AutomationList */
+class AutomationLine : public sigc::trackable, public PBD::StatefulDestructible
 {
-  public:
-        ControlPoint (AutomationLine& al);
-       ControlPoint (const ControlPoint&, bool dummy_arg_to_force_special_copy_constructor);
-       virtual ~ControlPoint ();
-
-       enum ShapeType {
-               Full,
-               Start,
-               End
+public:
+       enum VisibleAspects {
+               Line = 0x1,
+               ControlPoints = 0x2,
+               SelectedControlPoints = 0x4
        };
-       
-       void move_to (double x, double y, ShapeType);
-       void reset (double x, double y, ARDOUR::AutomationList::iterator, uint32_t, ShapeType);
-       double get_x() const { return _x; }
-       double get_y() const { return _y; }
-
-       void hide (); 
-       void show ();
-       void show_color (bool entered, bool hide_too);
-
-       void set_size (double);
-       void set_visible (bool);
-
-       ArdourCanvas::SimpleRect* item;
-       AutomationLine& line;
-       uint32_t view_index;
-       ARDOUR::AutomationList::iterator model;
-       bool can_slide;
-       bool selected;
-       
-  protected:
-       virtual bool event_handler (GdkEvent*);
 
-  private:
-       double _x;
-       double _y;
-       double _size;
-       ShapeType _shape;
-};
+       AutomationLine (const std::string&                                 name,
+                       TimeAxisView&                                      tv,
+                       ArdourCanvas::Item&                                parent,
+                       boost::shared_ptr<ARDOUR::AutomationList>          al,
+                       const ARDOUR::ParameterDescriptor&                 desc,
+                       Evoral::TimeConverter<double, ARDOUR::framepos_t>* converter = 0);
 
-class AutomationLine : public sigc::trackable
-{
-  public:
-        AutomationLine (const string & name, TimeAxisView&, ArdourCanvas::Group&, ARDOUR::AutomationList&);
        virtual ~AutomationLine ();
 
        void queue_reset ();
        void reset ();
-       void clear();
+       void clear ();
+       void set_fill (bool f) { _fill = f; } // owner needs to call set_height
 
-       void set_selected_points (PointSelection&);
-       void get_selectables (jack_nframes_t& start, jack_nframes_t& end,
-                             double botfrac, double topfrac, 
-                             list<Selectable*>& results);
-       void get_inverted_selectables (Selection&, list<Selectable*>& results);
+       void set_selected_points (PointSelection const &);
+       void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
+       void get_inverted_selectables (Selection&, std::list<Selectable*>& results);
 
        virtual void remove_point (ControlPoint&);
        bool control_points_adjacent (double xval, uint32_t& before, uint32_t& after);
-       
-       /* dragging API */
 
-       virtual void start_drag (ControlPoint*, float fraction);
-       virtual void point_drag(ControlPoint&, jack_nframes_t x, float, bool with_push);
-       virtual void end_drag (ControlPoint*);
-       virtual void line_drag(uint32_t i1, uint32_t i2, float, bool with_push);
+       /* dragging API */
+       virtual void start_drag_single (ControlPoint*, double, float);
+       virtual void start_drag_line (uint32_t, uint32_t, float);
+       virtual void start_drag_multiple (std::list<ControlPoint*>, float, XMLNode *);
+       virtual std::pair<double, float> drag_motion (double, float, bool, bool with_push, uint32_t& final_index);
+       virtual void end_drag (bool with_push, uint32_t final_index);
 
        ControlPoint* nth (uint32_t);
+       ControlPoint const * nth (uint32_t) const;
        uint32_t npoints() const { return control_points.size(); }
 
-       string  name() const { return _name; }
-       bool    visible() const { return _visible; }
-       guint32 height() const { return _height; }
+       std::string  name()    const { return _name; }
+       bool    visible() const { return _visible != VisibleAspects(0); }
+       guint32 height()  const { return _height; }
 
-       void         set_line_color (uint32_t);
+       void     set_line_color (uint32_t);
        uint32_t get_line_color() const { return _line_color; }
 
-       void    show ();
-       void    hide ();
-       void    set_height (guint32);
-       void    set_verbose_cursor_uses_gain_mapping (bool yn);
+       void set_visibility (VisibleAspects);
+       void add_visibility (VisibleAspects);
+       void remove_visibility (VisibleAspects);
+
+       void hide ();
+       void set_height (guint32);
+       void set_uses_gain_mapping (bool yn);
+       bool get_uses_gain_mapping () const { return _uses_gain_mapping; }
 
        TimeAxisView& trackview;
 
-       ArdourCanvas::Group& canvas_group() const { return *group; }
+       ArdourCanvas::Container& canvas_group() const { return *group; }
        ArdourCanvas::Item&  parent_group() const { return _parent_group; }
        ArdourCanvas::Item&  grab_item() const { return *line; }
 
-       void show_selection();
-       void hide_selection ();
-
-       void set_point_size (double size);
+       virtual std::string get_verbose_cursor_string (double) const;
+       std::string get_verbose_cursor_relative_string (double, double) const;
+       std::string fraction_to_string (double) const;
+       std::string fraction_to_relative_string (double, double) const;
+       double string_to_fraction (std::string const &) const;
+       void   view_to_model_coord (double& x, double& y) const;
+       void   view_to_model_coord_y (double &) const;
+       void   model_to_view_coord (double& x, double& y) const;
+       void   model_to_view_coord_y (double &) const;
 
-       virtual string  get_verbose_cursor_string (float);
-       virtual void view_to_model_y (double&) = 0;
-       virtual void model_to_view_y (double&) = 0;
+       void set_list(boost::shared_ptr<ARDOUR::AutomationList> list);
+       boost::shared_ptr<ARDOUR::AutomationList> the_list() const { return alist; }
 
-       ARDOUR::AutomationList& the_list() const { return alist; }
-
-       void show_all_control_points ();
-       void hide_all_but_selected_control_points ();
+       void track_entered();
+       void track_exited();
 
        bool is_last_point (ControlPoint &);
        bool is_first_point (ControlPoint &);
 
-  protected:
-       string _name;
-       guint32 _height;
-       uint32_t _line_color;
-       ARDOUR::AutomationList& alist;
-
-       bool    _visible  : 1;
-       bool    _vc_uses_gain_mapping : 1;
-       bool    terminal_points_can_slide : 1;
-       bool    update_pending : 1;
-       bool    no_draw : 1;
-       bool    points_visible : 1;
-       
-       ArdourCanvas::Group&  _parent_group;
-       ArdourCanvas::Group*   group;
-       ArdourCanvas::Line*   line; /* line */
-       ArdourCanvas::Points  line_points; /* coordinates for canvas line */
-       vector<ControlPoint*>  control_points; /* visible control points */
-
-       struct ALPoint {
-           double x;
-           double y;
-           ALPoint (double xx, double yy) : x(xx), y(yy) {}
+       XMLNode& get_state (void);
+       int set_state (const XMLNode&, int version);
+       void set_colors();
+
+       void modify_point_y (ControlPoint&, double);
+
+       virtual MementoCommandBinder<ARDOUR::AutomationList>* memento_command_binder ();
+
+       const Evoral::TimeConverter<double, ARDOUR::framepos_t>& time_converter () const {
+               return *_time_converter;
+       }
+
+       std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> get_point_x_range () const;
+
+       void set_maximum_time (ARDOUR::framecnt_t);
+       ARDOUR::framecnt_t maximum_time () const {
+               return _maximum_time;
+       }
+
+       void set_offset (ARDOUR::framecnt_t);
+       void set_width (ARDOUR::framecnt_t);
+
+       framepos_t session_position (ARDOUR::AutomationList::const_iterator) const;
+
+protected:
+
+       std::string    _name;
+       guint32   _height;
+       uint32_t  _line_color;
+
+       boost::shared_ptr<ARDOUR::AutomationList> alist;
+       Evoral::TimeConverter<double, ARDOUR::framepos_t>* _time_converter;
+       /** true if _time_converter belongs to us (ie we should delete it on destruction) */
+       bool _our_time_converter;
+
+       VisibleAspects _visible;
+
+       bool    _uses_gain_mapping;
+       bool    terminal_points_can_slide;
+       bool    update_pending;
+       bool    have_timeout;
+       bool    no_draw;
+       bool    _is_boolean;
+       /** true if we did a push at any point during the current drag */
+       bool    did_push;
+
+       ArdourCanvas::Item&        _parent_group;
+       ArdourCanvas::Container*       group;
+       ArdourCanvas::PolyLine*     line; /* line */
+       ArdourCanvas::Points        line_points; /* coordinates for canvas line */
+       std::vector<ControlPoint*>  control_points; /* visible control points */
+
+       class ContiguousControlPoints : public std::list<ControlPoint*> {
+public:
+               ContiguousControlPoints (AutomationLine& al);
+               double clamp_dx (double dx);
+               void move (double dx, double dy);
+               void compute_x_bounds (PublicEditor& e);
+private:
+               AutomationLine& line;
+               double before_x;
+               double after_x;
        };
 
-       typedef std::vector<ALPoint> ALPoints;
+       friend class ContiguousControlPoints;
 
-       static void invalidate_point (ALPoints&, uint32_t index);
-       static bool invalid_point (ALPoints&, uint32_t index);
-       
-       void determine_visible_control_points (ALPoints&);
-       void sync_model_from (ControlPoint&);
-       void sync_model_with_view_point (ControlPoint&);
-       void sync_model_with_view_line (uint32_t, uint32_t);
-       void modify_view (ControlPoint&, double, double, bool with_push);
-       
-       virtual void change_model (ARDOUR::AutomationList::iterator, double x, double y);
-       virtual void change_model_range (ARDOUR::AutomationList::iterator,ARDOUR::AutomationList::iterator, double delta, float ydelta);
+       typedef boost::shared_ptr<ContiguousControlPoints> CCP;
+       std::vector<CCP> contiguous_points;
 
-       void reset_callback (const ARDOUR::AutomationList&);
-       void list_changed (ARDOUR::Change);
+       bool sync_model_with_view_point (ControlPoint&);
+       bool sync_model_with_view_points (std::list<ControlPoint*>);
+       void start_drag_common (double, float);
 
-       UndoAction get_memento();
+       void reset_callback (const Evoral::ControlList&);
+       void list_changed ();
 
        virtual bool event_handler (GdkEvent*);
-       
-  private:
-       uint32_t drags;
-       double   first_drag_fraction;
-       double   last_drag_fraction;
-       uint32_t line_drag_cp1;
-       uint32_t line_drag_cp2;
-
-       void modify_view_point(ControlPoint&, double, double, bool with_push);
+
+private:
+       std::list<ControlPoint*> _drag_points; ///< points we are dragging
+       std::list<ControlPoint*> _push_points; ///< additional points we are dragging if "push" is enabled
+       bool _drag_had_movement; ///< true if the drag has seen movement, otherwise false
+       double _drag_x; ///< last x position of the drag, in units
+       double _drag_distance; ///< total x movement of the drag, in canvas units
+       double _last_drag_fraction; ///< last y position of the drag, as a fraction
+       /** offset from the start of the automation list to the start of the line, so that
+        *  a +ve offset means that the 0 on the line is at _offset in the list
+        */
+       ARDOUR::framecnt_t _offset;
+
+       bool is_stepped() const;
+       void update_visibility ();
        void reset_line_coords (ControlPoint&);
-       void update_line ();
-
-       struct ModelRepresentation {
-           ARDOUR::AutomationList::iterator start;
-           ARDOUR::AutomationList::iterator end;
-           jack_nframes_t xpos;
-           double ypos;
-           jack_nframes_t xmin;
-           double ymin;
-           jack_nframes_t xmax;
-           double ymax;
-           jack_nframes_t xval;
-           double yval;
-       };
+       void add_visible_control_point (uint32_t, uint32_t, double, double, ARDOUR::AutomationList::iterator, uint32_t);
+       double control_point_box_size ();
+       void connect_to_list ();
+       void interpolation_changed (ARDOUR::AutomationList::InterpolationStyle);
+
+       PBD::ScopedConnectionList _list_connections;
+
+       /** maximum time that a point on this line can be at, relative to the position of its region or start of its track */
+       ARDOUR::framecnt_t _maximum_time;
+
+       bool _fill;
 
-       void model_representation (ControlPoint&, ModelRepresentation&);
+       const ARDOUR::ParameterDescriptor _desc;
 
        friend class AudioRegionGainLine;
 };