change event propagation to be based on parent/child lineage, not z-axis stacking...
[ardour.git] / libs / canvas / canvas / wave_view.h
index 97753c597d123d98086997ac606966210799f669..05bd00f5adea8944fb96a76efdbedd20867d0931 100644 (file)
@@ -20,6 +20,7 @@
 
 #include <boost/shared_ptr.hpp>
 #include <boost/shared_array.hpp>
+#include <boost/scoped_array.hpp>
 
 #include "pbd/properties.h"
 
@@ -46,23 +47,72 @@ namespace ArdourCanvas {
 class WaveView : virtual public Item, public Outline, public Fill
 {
 public:
+        enum Shape { 
+               Normal,
+               Rectified,
+        };
+
+    /* Displays a single channel of waveform data for the given Region.
+
+       x = 0 in the waveview corresponds to the first waveform datum taken
+       from region->start() samples into the source data.
+
+       x = N in the waveview corresponds to the (N * spp)'th sample 
+       measured from region->start() into the source data.
+
+       when drawing, we will map the zeroth-pixel of the waveview
+       into a window. 
+
+       The waveview itself contains a set of pre-rendered Cairo::ImageSurfaces
+       that cache sections of the display. This is filled on-demand and
+       never cleared until something explicitly marks the cache invalid
+       (such as a change in samples_per_pixel, the log scaling, rectified or
+       other view parameters).
+    */
+
+
        WaveView (Group *, boost::shared_ptr<ARDOUR::AudioRegion>);
+       ~WaveView ();
 
        void render (Rect const & area, Cairo::RefPtr<Cairo::Context>) const;
        void compute_bounding_box () const;
-
-       XMLNode* get_state () const;
-       void set_state (XMLNode const *);
-
-       void set_frames_per_pixel (double);
+    
+       void set_samples_per_pixel (double);
        void set_height (Distance);
        void set_channel (int);
        void set_region_start (ARDOUR::frameoffset_t);
+
+        void set_fill_color (Color);
+        void set_outline_color (Color);
        
        void region_resized ();
-
-       /* XXX */
-       void rebuild () {}
+        void gain_changed ();
+
+        void set_show_zero_line (bool);
+        bool show_zero_line() const { return _show_zero; }
+        void set_zero_color (Color);
+        void set_clip_color (Color);
+        void set_logscaled (bool);
+        void set_gradient_depth (double);
+        double gradient_depth() const { return _gradient_depth; }
+        void set_shape (Shape);
+
+        /* currently missing because we don't need them (yet):
+          set_shape_independent();
+          set_logscaled_independent()
+        */
+
+        static void set_global_gradient_depth (double);
+        static void set_global_logscaled (bool);
+        static void set_global_shape (Shape);
+        static void set_global_show_waveform_clipping (bool);
+    
+        static double  global_gradient_depth()  { return _global_gradient_depth; }
+        static bool    global_logscaled()  { return _global_logscaled; }
+        static Shape   global_shape()  { return _global_shape; }
+
+        void set_amplitude_above_axis (double v);
+        double amplitude_above_axis () const { return _amplitude_above_axis; }
 
 #ifdef CANVAS_COMPATIBILITY    
        void*& property_gain_src () {
@@ -71,79 +121,55 @@ public:
        void*& property_gain_function () {
                return _foo_void;
        }
-       bool& property_rectified () {
-               return _foo_bool;
-       }
-       bool& property_logscaled () {
-               return _foo_bool;
-       }
-       double& property_amplitude_above_axis () {
-               return _foo_double;
-       }
-       Color& property_clip_color () {
-               return _foo_uint;
-       }
-       Color& property_zero_color () {
-               return _foo_uint;
-       }
-
 private:
        void* _foo_void;
-       bool _foo_bool;
-       int _foo_int;
-       Color _foo_uint;
-       double _foo_double;
+
 #endif
 
-       class CacheEntry
-       {
-       public:
-               CacheEntry (WaveView const *, int, int);
-               ~CacheEntry ();
+        friend class ::WaveViewTest;
 
-               int start () const {
-                       return _start;
-               }
+       void invalidate_image ();
 
-               int end () const {
-                       return _end;
-               }
+       boost::shared_ptr<ARDOUR::AudioRegion> _region;
+       int    _channel;
+       double _samples_per_pixel;
+       Coord  _height;
+       Color  _wave_color;
+        bool   _show_zero;
+        Color  _zero_color;
+        Color  _clip_color;
+        bool   _logscaled;
+        Shape  _shape;
+        double _gradient_depth;
+        bool   _shape_independent;
+        bool   _logscaled_independent;
+        bool   _gradient_depth_independent;
+        double _amplitude_above_axis;
 
-               boost::shared_array<ARDOUR::PeakData> peaks () const {
-                       return _peaks;
-               }
+       /** The `start' value to use for the region; we can't use the region's
+        *  value as the crossfade editor needs to alter it.
+        */
+       ARDOUR::frameoffset_t _region_start;
+    
+    
+        mutable ARDOUR::framepos_t _sample_start; 
+        mutable ARDOUR::framepos_t _sample_end; 
+        mutable Cairo::RefPtr<Cairo::ImageSurface> _image;
 
-                Cairo::RefPtr<Cairo::ImageSurface> image();
-               void clear_image ();
+        PBD::ScopedConnection invalidation_connection;
 
-       private:
-               Coord position (float) const;
-               
-               WaveView const * _wave_view;
-               int _start;
-               int _end;
-               int _n_peaks;
-               boost::shared_array<ARDOUR::PeakData> _peaks;
-               Cairo::RefPtr<Cairo::ImageSurface> _image;
-       };
+        static double _global_gradient_depth;
+        static bool   _global_logscaled;
+        static Shape  _global_shape;
+        static bool   _global_show_waveform_clipping;
 
-       friend class CacheEntry;
-       friend class ::WaveViewTest;
+        static PBD::Signal0<void> VisualPropertiesChanged;
 
-       void invalidate_whole_cache ();
-       void invalidate_image_cache ();
+        void handle_visual_property_change ();
 
-       boost::shared_ptr<ARDOUR::AudioRegion> _region;
-       int _channel;
-       double _frames_per_pixel;
-       Coord _height;
-       Color _wave_color;
-       /** The `start' value to use for the region; we can't use the region's
-        *  value as the crossfade editor needs to alter it.
-        */
-       ARDOUR::frameoffset_t _region_start;
-       
-       mutable std::list<CacheEntry*> _cache;
+        void ensure_cache (ARDOUR::framepos_t sample_start, ARDOUR::framepos_t sample_end) const;
+        ArdourCanvas::Coord position (double) const;
+        void draw_image (ARDOUR::PeakData*, int npeaks) const;
 };
 
 }