gtk2_ardour/automation_line.h

   1 /*
   2     Copyright (C) 2002 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 __ardour_automation_line_h__
  21 #define __ardour_automation_line_h__
  22
  23 #include <vector>
  24 #include <list>
  25 #include <string>
  26 #include <sys/types.h>
  27
  28 #include <libgnomecanvasmm/line.h>
  29 #include <sigc++/signal.h>
  30 #include "canvas.h"
  31 #include "simplerect.h"
  32
  33 #include "evoral/TimeConverter.hpp"
  34
  35 #include "pbd/undo.h"
  36 #include "pbd/statefuldestructible.h"
  37 #include "pbd/memento_command.h"
  38
  39 #include "ardour/automation_list.h"
  40 #include "ardour/types.h"
  41
  42 class AutomationLine;
  43 class ControlPoint;
  44 class PointSelection;
  45 class TimeAxisView;
  46 class AutomationTimeAxisView;
  47 class Selectable;
  48 class Selection;
  49
  50 namespace Gnome {
  51         namespace Canvas {
  52                 class SimpleRect;
  53         }
  54 }
  55
  56 /** A GUI representation of an ARDOUR::AutomationList */
  57 class AutomationLine : public sigc::trackable, public PBD::StatefulDestructible
  58 {
  59   public:
  60         AutomationLine (const std::string& name, TimeAxisView&, ArdourCanvas::Group&,
  61                         boost::shared_ptr<ARDOUR::AutomationList>,
  62                         const Evoral::TimeConverter<double, ARDOUR::framepos_t>* converter = 0);
  63         virtual ~AutomationLine ();
  64
  65         void queue_reset ();
  66         void reset ();
  67         void clear ();
  68
  69         std::list<ControlPoint*> point_selection_to_control_points (PointSelection const &);
  70         void set_selected_points (PointSelection&);
  71         void get_selectables (ARDOUR::framepos_t, ARDOUR::framepos_t, double, double, std::list<Selectable*>&);
  72         void get_inverted_selectables (Selection&, std::list<Selectable*>& results);
  73
  74         virtual void remove_point (ControlPoint&);
  75         bool control_points_adjacent (double xval, uint32_t& before, uint32_t& after);
  76
  77         /* dragging API */
  78         virtual void start_drag_single (ControlPoint*, double, float);
  79         virtual void start_drag_line (uint32_t, uint32_t, float);
  80         virtual void start_drag_multiple (std::list<ControlPoint*>, float, XMLNode *);
  81         virtual std::pair<double, float> drag_motion (double, float, bool, bool);
  82         virtual void end_drag ();
  83
  84         ControlPoint* nth (uint32_t);
  85         ControlPoint const * nth (uint32_t) const;
  86         uint32_t npoints() const { return control_points.size(); }
  87
  88         std::string  name()    const { return _name; }
  89         bool    visible() const { return _visible; }
  90         guint32 height()  const { return _height; }
  91
  92         void     set_line_color (uint32_t);
  93         uint32_t get_line_color() const { return _line_color; }
  94
  95         void    show ();
  96         void    hide ();
  97         void    set_height (guint32);
  98         void    set_uses_gain_mapping (bool yn);
  99         bool    get_uses_gain_mapping () const { return _uses_gain_mapping; }
 100
 101         TimeAxisView& trackview;
 102
 103         ArdourCanvas::Group& canvas_group() const { return *group; }
 104         ArdourCanvas::Item&  parent_group() const { return _parent_group; }
 105         ArdourCanvas::Item&  grab_item() const { return *line; }
 106
 107         std::string get_verbose_cursor_string (double) const;
 108         std::string fraction_to_string (double) const;
 109         double string_to_fraction (std::string const &) const;
 110         void   view_to_model_coord (double& x, double& y) const;
 111         void   view_to_model_coord_y (double &) const;
 112         void   model_to_view_coord (double& x, double& y) const;
 113
 114         void set_list(boost::shared_ptr<ARDOUR::AutomationList> list);
 115         boost::shared_ptr<ARDOUR::AutomationList> the_list() const { return alist; }
 116
 117         void show_all_control_points ();
 118         void hide_all_but_selected_control_points ();
 119
 120         void track_entered();
 121         void track_exited();
 122
 123         bool is_last_point (ControlPoint &);
 124         bool is_first_point (ControlPoint &);
 125
 126         XMLNode& get_state (void);
 127         int set_state (const XMLNode&, int version);
 128         void set_colors();
 129
 130         void modify_point_y (ControlPoint&, double);
 131
 132         void add_always_in_view (double);
 133         void clear_always_in_view ();
 134
 135         virtual MementoCommandBinder<ARDOUR::AutomationList>* memento_command_binder ();
 136
 137         const Evoral::TimeConverter<double, ARDOUR::framepos_t>& time_converter () const {
 138                 return _time_converter;
 139         }
 140
 141         std::pair<ARDOUR::framepos_t, ARDOUR::framepos_t> get_point_x_range () const;
 142
 143         void set_maximum_time (ARDOUR::framecnt_t);
 144         ARDOUR::framecnt_t maximum_time () const {
 145                 return _maximum_time;
 146         }
 147
 148         void set_offset (ARDOUR::framecnt_t);
 149         void set_width (ARDOUR::framecnt_t);
 150
 151   protected:
 152
 153         std::string    _name;
 154         guint32   _height;
 155         uint32_t  _line_color;
 156
 157         boost::shared_ptr<ARDOUR::AutomationList> alist;
 158
 159         bool    _visible                  : 1;
 160         bool    _uses_gain_mapping        : 1;
 161         bool    terminal_points_can_slide : 1;
 162         bool    update_pending            : 1;
 163         bool    no_draw                   : 1;
 164         bool    _is_boolean               : 1;
 165         bool    points_visible            : 1;
 166         bool    did_push;
 167
 168         ArdourCanvas::Group&        _parent_group;
 169         ArdourCanvas::Group*        group;
 170         ArdourCanvas::Line*         line; /* line */
 171         ArdourCanvas::Points        line_points; /* coordinates for canvas line */
 172         std::vector<ControlPoint*>  control_points; /* visible control points */
 173
 174         struct ALPoint {
 175             double x;
 176             double y;
 177             ALPoint (double xx, double yy) : x(xx), y(yy) {}
 178         };
 179
 180         typedef std::vector<ALPoint> ALPoints;
 181
 182         static void invalidate_point (ALPoints&, uint32_t index);
 183         static bool invalid_point (ALPoints&, uint32_t index);
 184
 185         void determine_visible_control_points (ALPoints&);
 186         void sync_model_with_view_point (ControlPoint&, bool, int64_t);
 187         void sync_model_with_view_points (std::list<ControlPoint*>, bool, int64_t);
 188         void start_drag_common (double, float);
 189
 190         virtual void change_model (ARDOUR::AutomationList::iterator, double x, double y);
 191
 192         void reset_callback (const Evoral::ControlList&);
 193         void list_changed ();
 194
 195         virtual bool event_handler (GdkEvent*);
 196
 197   private:
 198         std::list<ControlPoint*> _drag_points; ///< points we are dragging
 199         std::list<ControlPoint*> _push_points; ///< additional points we are dragging if "push" is enabled
 200         bool _drag_had_movement; ///< true if the drag has seen movement, otherwise false
 201         double _drag_x; ///< last x position of the drag, in units
 202         double _drag_distance; ///< total x movement of the drag, in units
 203         double _last_drag_fraction; ///< last y position of the drag, as a fraction
 204         std::list<double> _always_in_view;
 205         /** offset from the start of the automation list to the start of the line, so that
 206          *  a +ve offset means that the 0 on the line is at _offset in the list
 207          */
 208         ARDOUR::framecnt_t _offset;
 209
 210         const Evoral::TimeConverter<double, ARDOUR::framepos_t>& _time_converter;
 211
 212         void reset_line_coords (ControlPoint&);
 213         void add_visible_control_point (uint32_t, uint32_t, double, double, ARDOUR::AutomationList::iterator, uint32_t);
 214         double control_point_box_size ();
 215         void connect_to_list ();
 216         void interpolation_changed (ARDOUR::AutomationList::InterpolationStyle);
 217
 218         struct ModelRepresentation {
 219             ARDOUR::AutomationList::iterator start;
 220             ARDOUR::AutomationList::iterator end;
 221             double xpos;
 222             double ypos;
 223             double xmin;
 224             double ymin;
 225             double xmax;
 226             double ymax;
 227             double xval;
 228             double yval;
 229         };
 230
 231         void model_representation (ControlPoint&, ModelRepresentation&);
 232
 233         PBD::ScopedConnectionList _list_connections;
 234
 235         /** maximum time that a point on this line can be at, relative to the position of its region or start of its track */
 236         ARDOUR::framecnt_t _maximum_time;
 237
 238         friend class AudioRegionGainLine;
 239 };
 240
 241 #endif /* __ardour_automation_line_h__ */
 242