namespace ArdourCanvas {
-class LIBCANVAS_API WaveView : public Item
+struct LIBCANVAS_API WaveViewThreadRequest
{
-public:
-
- enum Shape {
- Normal,
- Rectified
+ public:
+ enum RequestType {
+ Quit,
+ Cancel,
+ Draw
};
+
+ WaveViewThreadRequest () : stop (0) {}
+
+ bool should_stop () const { return (bool) g_atomic_int_get (&stop); }
+ void cancel() { g_atomic_int_set (&stop, 1); }
+
+ RequestType type;
+ framepos_t start;
+ framepos_t end;
+ double width;
+ double height;
+ double samples_per_pixel;
+ uint16_t channel;
+ double region_amplitude;
+ Color fill_color;
+ boost::weak_ptr<const ARDOUR::Region> region;
+
+ /* resulting image, after request has been satisfied */
+
+ Cairo::RefPtr<Cairo::ImageSurface> image;
+
+ private:
+ gint stop; /* intended for atomic access */
+};
+
+class LIBCANVAS_API WaveView;
+
+class LIBCANVAS_API WaveViewCache
+{
+ public:
+ WaveViewCache();
+ ~WaveViewCache();
+
+ struct Entry {
+
+ /* these properties define the cache entry as unique.
+
+ If an image is in use by a WaveView and any of these
+ properties are modified on the WaveView, the image can no
+ longer be used (or may no longer be usable for start/end
+ parameters). It will remain in the cache until flushed for
+ some reason (typically the cache is full).
+ */
- struct CacheEntry {
int channel;
Coord height;
float amplitude;
Color fill_color;
+ double samples_per_pixel;
framepos_t start;
framepos_t end;
+
+ /* the actual image referred to by the cache entry */
+
Cairo::RefPtr<Cairo::ImageSurface> image;
- CacheEntry(int chan, Coord hght, float amp, Color fcl, framepos_t strt, framepos_t ed, Cairo::RefPtr<Cairo::ImageSurface> img) :
+ /* last time the cache entry was used */
+ uint64_t timestamp;
- channel (chan), height (hght), amplitude (amp), fill_color (fcl),
- start (strt), end (ed), image (img) {}
+ Entry (int chan, Coord hght, float amp, Color fcl, double spp, framepos_t strt, framepos_t ed,
+ Cairo::RefPtr<Cairo::ImageSurface> img)
+ : channel (chan)
+ , height (hght)
+ , amplitude (amp)
+ , fill_color (fcl)
+ , samples_per_pixel (spp)
+ , start (strt)
+ , end (ed)
+ , image (img) {}
};
- /* final ImageSurface rendered with colours */
- Cairo::RefPtr<Cairo::ImageSurface> _image;
+ uint64_t image_cache_threshold () const { return _image_cache_threshold; }
+ void set_image_cache_threshold (uint64_t);
- /* Displays a single channel of waveform data for the given Region.
+ void add (boost::shared_ptr<ARDOUR::AudioSource>, boost::shared_ptr<Entry>);
+ void use (boost::shared_ptr<ARDOUR::AudioSource>, boost::shared_ptr<Entry>);
+
+ void consolidate_image_cache (boost::shared_ptr<ARDOUR::AudioSource>,
+ int channel,
+ Coord height,
+ float amplitude,
+ Color fill_color,
+ double samples_per_pixel);
+
+ boost::shared_ptr<Entry> lookup_image (boost::shared_ptr<ARDOUR::AudioSource>,
+ framepos_t start, framepos_t end,
+ int _channel,
+ Coord height,
+ float amplitude,
+ Color fill_color,
+ double samples_per_pixel);
+
+ private:
+ /* an unsorted, unindexd collection of cache entries associated with
+ a particular AudioSource. All cache Entries in the collection
+ share the AudioSource in common, but represent different parameter
+ settings (e.g. height, color, samples per pixel etc.)
+ */
+ typedef std::vector<boost::shared_ptr<Entry> > CacheLine;
+ /* Indexed, non-sortable structure used to lookup images associated
+ * with a particular AudioSource
+ */
+ typedef std::map <boost::shared_ptr<ARDOUR::AudioSource>,CacheLine> ImageCache;
+ ImageCache cache_map;
+
+ /* Linear, sortable structure used when we need to do a timestamp-based
+ * flush of entries from the cache.
+ */
+ typedef std::pair<boost::shared_ptr<ARDOUR::AudioSource>,boost::shared_ptr<Entry> > ListEntry;
+ typedef std::vector<ListEntry> CacheList;
+ CacheList cache_list;
+
+ struct SortByTimestamp {
+ bool operator() (const WaveViewCache::ListEntry& a, const WaveViewCache::ListEntry& b) {
+ return a.second->timestamp < b.second->timestamp;
+ }
+ };
+ friend struct SortByTimestamp;
+
+ uint64_t image_cache_size;
+ uint64_t _image_cache_threshold;
+
+ uint64_t compute_image_cache_size ();
+ void cache_flush ();
+ bool cache_full ();
+};
- x = 0 in the waveview corresponds to the first waveform datum taken
- from region->start() samples into the source data.
+class LIBCANVAS_API WaveView : public Item, public sigc::trackable
+{
+public:
- x = N in the waveview corresponds to the (N * spp)'th sample
- measured from region->start() into the source data.
+ enum Shape {
+ Normal,
+ Rectified
+ };
- when drawing, we will map the zeroth-pixel of the waveview
- into a window.
+ std::string debug_name() const;
- 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).
- */
+ /* final ImageSurface rendered with colours */
+ Cairo::RefPtr<Cairo::ImageSurface> _image;
+ PBD::Signal0<void> ImageReady;
+
+ /* 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 (Canvas *, boost::shared_ptr<ARDOUR::AudioRegion>);
WaveView (Item*, boost::shared_ptr<ARDOUR::AudioRegion>);
static void set_clip_level (double dB);
static PBD::Signal0<void> ClipLevelChanged;
+ static void start_drawing_thread ();
+ static void stop_drawing_thread ();
+
#ifdef CANVAS_COMPATIBILITY
void*& property_gain_src () {
return _foo_void;
void*& property_gain_function () {
return _foo_void;
}
-private:
+ private:
void* _foo_void;
#endif
+ private:
friend class ::WaveViewTest;
+ friend class WaveViewThreadClient;
- static std::map <boost::shared_ptr<ARDOUR::AudioSource>, std::vector <CacheEntry> > _image_cache;
- void consolidate_image_cache () const;
- void invalidate_source (boost::weak_ptr<ARDOUR::AudioSource>);
- void invalidate_image_cache ();
+ void invalidate_image_cache ();
boost::shared_ptr<ARDOUR::AudioRegion> _region;
int _channel;
*/
ARDOUR::frameoffset_t _region_start;
+ /** Under almost conditions, this is going to return _region->length(),
+ * but if _region_start has been reset, then we need
+ * to use this modified computation.
+ */
+ ARDOUR::framecnt_t region_length() const;
+ /** Under almost conditions, this is going to return _region->start() +
+ * _region->length(), but if _region_start has been reset, then we need
+ * to use this modified computation.
+ */
+ ARDOUR::framepos_t region_end() const;
+
+ /** If true, calls to get_image() will render a missing wave image
+ in the calling thread. Generally set to false, but true after a
+ call to set_height().
+ */
+ mutable bool get_image_in_thread;
+
+ /** Set to true by render(). Used so that we know if the wave view
+ * has actually been displayed on screen. ::set_height() when this
+ * is true does not use get_image_in_thread, because it implies
+ * that the height is being set BEFORE the waveview is drawn.
+ */
+ mutable bool rendered;
+
PBD::ScopedConnectionList invalidation_connection;
- PBD::ScopedConnection _source_invalidated_connection;
+ PBD::ScopedConnection image_ready_connection;
static double _global_gradient_depth;
static bool _global_logscaled;
void handle_visual_property_change ();
void handle_clip_level_change ();
- void get_image (Cairo::RefPtr<Cairo::ImageSurface>& image, framepos_t start, framepos_t end, double& image_offset) const;
-
+ boost::shared_ptr<WaveViewCache::Entry> get_image (framepos_t start, framepos_t end) const;
+ boost::shared_ptr<WaveViewCache::Entry> get_image_from_cache (framepos_t start, framepos_t end) const;
+
ArdourCanvas::Coord y_extent (double, bool) const;
+ void draw_image (Cairo::RefPtr<Cairo::ImageSurface>&, ARDOUR::PeakData*, int n_peaks, boost::shared_ptr<WaveViewThreadRequest>) const;
void draw_absent_image (Cairo::RefPtr<Cairo::ImageSurface>&, ARDOUR::PeakData*, int) const;
- void draw_image (Cairo::RefPtr<Cairo::ImageSurface>&, ARDOUR::PeakData*, int) const;
+
+ void cancel_my_render_request () const;
+
+ void queue_get_image (boost::shared_ptr<const ARDOUR::Region> region, framepos_t start, framepos_t end) const;
+ void generate_image (boost::shared_ptr<WaveViewThreadRequest>, bool in_render_thread) const;
+ boost::shared_ptr<WaveViewCache::Entry> cache_request_result (boost::shared_ptr<WaveViewThreadRequest> req) const;
+
+ void image_ready ();
+
+ mutable boost::shared_ptr<WaveViewCache::Entry> _current_image;
+
+ mutable boost::shared_ptr<WaveViewThreadRequest> current_request;
+ void send_request (boost::shared_ptr<WaveViewThreadRequest>) const;
+ bool idle_send_request (boost::shared_ptr<WaveViewThreadRequest>) const;
+
+ static WaveViewCache* images;
+
+ static void drawing_thread ();
+
+ static gint drawing_thread_should_quit;
+ static Glib::Threads::Mutex request_queue_lock;
+ static Glib::Threads::Cond request_cond;
+ static Glib::Threads::Thread* _drawing_thread;
+ typedef std::set<WaveView const *> DrawingRequestQueue;
+ static DrawingRequestQueue request_queue;
};
}
#include <cmath>
#include <cairomm/cairomm.h>
+#include <glibmm/threads.h>
+
#include "gtkmm2ext/utils.h"
+#include "gtkmm2ext/gui_thread.h"
+#include "pbd/base_ui.h"
#include "pbd/compose.h"
+#include "pbd/convert.h"
#include "pbd/signals.h"
#include "pbd/stacktrace.h"
#include "ardour/dB.h"
#include "ardour/lmath.h"
#include "ardour/audioregion.h"
+#include "ardour/audiosource.h"
#include "canvas/wave_view.h"
#include "canvas/utils.h"
using namespace ARDOUR;
using namespace ArdourCanvas;
-#define CACHE_HIGH_WATER (2)
-
-std::map <boost::shared_ptr<AudioSource>, std::vector<WaveView::CacheEntry> > WaveView::_image_cache;
double WaveView::_global_gradient_depth = 0.6;
bool WaveView::_global_logscaled = false;
WaveView::Shape WaveView::_global_shape = WaveView::Normal;
bool WaveView::_global_show_waveform_clipping = true;
double WaveView::_clip_level = 0.98853;
+WaveViewCache* WaveView::images = 0;
+gint WaveView::drawing_thread_should_quit = 0;
+Glib::Threads::Mutex WaveView::request_queue_lock;
+Glib::Threads::Cond WaveView::request_cond;
+Glib::Threads::Thread* WaveView::_drawing_thread = 0;
+WaveView::DrawingRequestQueue WaveView::request_queue;
+
PBD::Signal0<void> WaveView::VisualPropertiesChanged;
PBD::Signal0<void> WaveView::ClipLevelChanged;
, _logscaled_independent (false)
, _gradient_depth_independent (false)
, _amplitude_above_axis (1.0)
- , _region_amplitude (_region->scale_amplitude ())
+ , _region_amplitude (region->scale_amplitude ())
, _start_shift (0.0)
, _region_start (region->start())
+ , get_image_in_thread (false)
+ , rendered (false)
{
- _region->DropReferences.connect (_source_invalidated_connection, MISSING_INVALIDATOR,
- boost::bind (&ArdourCanvas::WaveView::invalidate_source,
- this, boost::weak_ptr<AudioSource>(_region->audio_source())), gui_context());
-
VisualPropertiesChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_visual_property_change, this));
ClipLevelChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_clip_level_change, this));
+
+ ImageReady.connect (image_ready_connection, MISSING_INVALIDATOR, boost::bind (&WaveView::image_ready, this), gui_context());
}
WaveView::WaveView (Item* parent, boost::shared_ptr<ARDOUR::AudioRegion> region)
, _logscaled_independent (false)
, _gradient_depth_independent (false)
, _amplitude_above_axis (1.0)
- , _region_amplitude (_region->scale_amplitude ())
+ , _region_amplitude (region->scale_amplitude ())
, _region_start (region->start())
+ , get_image_in_thread (false)
+ , rendered (false)
{
- _region->DropReferences.connect (_source_invalidated_connection, MISSING_INVALIDATOR,
- boost::bind (&ArdourCanvas::WaveView::invalidate_source,
- this, boost::weak_ptr<AudioSource>(_region->audio_source())), gui_context());
-
VisualPropertiesChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_visual_property_change, this));
ClipLevelChanged.connect_same_thread (invalidation_connection, boost::bind (&WaveView::handle_clip_level_change, this));
+
+ ImageReady.connect (image_ready_connection, MISSING_INVALIDATOR, boost::bind (&WaveView::image_ready, this), gui_context());
}
WaveView::~WaveView ()
{
- _source_invalidated_connection.disconnect();
invalidate_image_cache ();
}
+string
+WaveView::debug_name() const
+{
+ return _region->name() + string (":") + PBD::to_string (_channel+1, std::dec);
+}
+
+void
+WaveView::image_ready ()
+{
+ redraw ();
+}
+
void
WaveView::handle_visual_property_change ()
{
}
}
-static inline double
-window_to_image (double wave_origin, double image_start)
-{
- return image_start - wave_origin;
-}
-
static inline float
_log_meter (float power, double lower_db, double upper_db, double non_linearity)
{
}
}
-void
-WaveView::invalidate_source (boost::weak_ptr<AudioSource> src)
-{
- if (boost::shared_ptr<AudioSource> source = src.lock()) {
-
- std::map <boost::shared_ptr<ARDOUR::AudioSource>, std::vector <CacheEntry> >::iterator i;
- for (i = _image_cache.begin (); i != _image_cache.end (); ++i) {
- if (i->first == source) {
- for (uint32_t n = 0; n < i->second.size (); ++n) {
- i->second[n].image.clear ();
- }
- i->second.clear ();
- _image_cache.erase (i->first);
- }
- }
- }
-}
-
void
WaveView::invalidate_image_cache ()
{
- vector <uint32_t> deletion_list;
- vector <CacheEntry> caches;
-
- /* The source may have disappeared.*/
-
- if (_region->n_channels() == 0) {
- return;
- }
-
- if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
- caches = _image_cache.find (_region->audio_source ())->second;
- } else {
- return;
- }
-
- for (uint32_t i = 0; i < caches.size (); ++i) {
-
- if (_channel != caches[i].channel
- || _height != caches[i].height
- || _region_amplitude != caches[i].amplitude
- || _fill_color != caches[i].fill_color) {
-
- continue;
- }
-
- deletion_list.push_back (i);
- }
-
- while (deletion_list.size() > 0) {
- caches[deletion_list.back ()].image.clear ();
- caches.erase (caches.begin() + deletion_list.back());
- deletion_list.pop_back();
- }
-
- if (caches.size () == 0) {
- _image_cache.erase(_region->audio_source ());
- } else {
- _image_cache[_region->audio_source ()] = caches;
- }
-}
-
-void
-WaveView::consolidate_image_cache () const
-{
- list <uint32_t> deletion_list;
- vector <CacheEntry> caches;
- uint32_t other_entries = 0;
-
- if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
- caches = _image_cache.find (_region->audio_source ())->second;
- }
-
- for (uint32_t i = 0; i < caches.size (); ++i) {
-
- if (_channel != caches[i].channel
- || _height != caches[i].height
- || _region_amplitude != caches[i].amplitude
- || _fill_color != caches[i].fill_color) {
-
- other_entries++;
- continue;
- }
-
- framepos_t segment_start = caches[i].start;
- framepos_t segment_end = caches[i].end;
-
- for (uint32_t j = i; j < caches.size (); ++j) {
-
- if (i == j || _channel != caches[j].channel
- || _height != caches[i].height
- || _region_amplitude != caches[i].amplitude
- || _fill_color != caches[i].fill_color) {
-
- continue;
- }
-
- if (caches[j].start >= segment_start && caches[j].end <= segment_end) {
-
- deletion_list.push_back (j);
- }
- }
- }
-
- deletion_list.sort ();
- deletion_list.unique ();
-
- while (deletion_list.size() > 0) {
- caches[deletion_list.back ()].image.clear ();
- caches.erase (caches.begin() + deletion_list.back ());
- deletion_list.pop_back();
- }
-
- /* We don't care if this channel/height/amplitude has anything in the cache - just drop the Last Added entries
- until we reach a size where there is a maximum of CACHE_HIGH_WATER + other entries.
- */
-
- while (caches.size() > CACHE_HIGH_WATER + other_entries) {
- caches.front ().image.clear ();
- caches.erase(caches.begin ());
- }
-
- if (caches.size () == 0) {
- _image_cache.erase (_region->audio_source ());
- } else {
- _image_cache[_region->audio_source ()] = caches;
- }
+ cancel_my_render_request ();
+ _current_image.reset ();
}
Coord
* up a pixel down. and a value of -1.0 (ideally y = _height-1)
* currently is on the bottom separator line :(
* So to make the complete waveform appear centered in
- * a region, we translate by +1.5 (instead of -.5)
- * and scale to height - 2.5 (if we scale to height - 2.0
- * then the bottom most pixel may bleed into the selection rect
- * by 0.5 px)
+ * a region, we translate by +.5 (instead of -.5)
+ * and waste two pixel of height: -4 (instad of -2)
*
+ * This needs fixing in canvas/rectangle the intersect
+ * functions and probably a couple of other places as well...
*/
Coord pos;
- pos = floor ((1.0 - s) * .5 * (_height - 2.5));
-
- return min (_height - 2.5, (max (0.0, pos)));
+ if (s < 0) {
+ pos = ceil ((1.0 - s) * .5 * (_height - 4.0));
+ } else {
+ pos = floor ((1.0 - s) * .5 * (_height - 4.0));
+ }
+ return min (_height - 4.0, (max (0.0, pos)));
}
}
};
void
-WaveView::draw_image (Cairo::RefPtr<Cairo::ImageSurface>& image, PeakData* _peaks, int n_peaks) const
+WaveView::draw_image (Cairo::RefPtr<Cairo::ImageSurface>& image, PeakData* _peaks, int n_peaks, boost::shared_ptr<WaveViewThreadRequest> req) const
{
ImageSet images;
}
}
+
+ if (req->should_stop()) {
+ return;
+ }
+
Color alpha_one = rgba_to_color (0, 0, 0, 1.0);
set_source_rgba (wave_context, alpha_one);
zero_context->stroke ();
}
+ if (req->should_stop()) {
+ return;
+ }
+
Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (image);
/* Here we set a source colour and use the various components as a mask. */
set_source_rgba (context, _fill_color);
}
+ if (req->should_stop()) {
+ return;
+ }
+
context->mask (images.wave, 0, 0);
context->fill ();
set_source_rgba (context, _zero_color);
context->mask (images.zero, 0, 0);
context->fill ();
-
}
-void
-WaveView::get_image (Cairo::RefPtr<Cairo::ImageSurface>& image, framepos_t start, framepos_t end, double& image_offset) const
+boost::shared_ptr<WaveViewCache::Entry>
+WaveView::cache_request_result (boost::shared_ptr<WaveViewThreadRequest> req) const
{
- vector <CacheEntry> caches;
+ boost::shared_ptr<WaveViewCache::Entry> ret (new WaveViewCache::Entry (req->channel,
+ req->height,
+ req->region_amplitude,
+ req->fill_color,
+ req->samples_per_pixel,
+ req->start,
+ req->end,
+ req->image));
+ if (!images) {
+ images = new WaveViewCache;
+ }
- if (_image_cache.find (_region->audio_source ()) != _image_cache.end ()) {
+ images->add (_region->audio_source (_channel), ret);
+
+ /* consolidate cache first (removes fully-contained
+ * duplicate images)
+ */
+
+ images->consolidate_image_cache (_region->audio_source (_channel),
+ _channel, _height, _region_amplitude,
+ _fill_color, _samples_per_pixel);
- caches = _image_cache.find (_region->audio_source ())->second;
- }
+ return ret;
+}
- /* Find a suitable ImageSurface.
+boost::shared_ptr<WaveViewCache::Entry>
+WaveView::get_image (framepos_t start, framepos_t end) const
+{
+ boost::shared_ptr<WaveViewCache::Entry> ret;
+
+ /* this is called from a ::render() call, when we need an image to
+ draw with.
*/
- for (uint32_t i = 0; i < caches.size (); ++i) {
- if (_channel != caches[i].channel
- || _height != caches[i].height
- || _region_amplitude != caches[i].amplitude
- || _fill_color != caches[i].fill_color) {
+ {
+ Glib::Threads::Mutex::Lock lmq (request_queue_lock);
- continue;
+ /* if there's a draw request outstanding, check to see if we
+ * have an image there. if so, use it (and put it in the cache
+ * while we're here.
+ */
+
+ if (current_request && !current_request->should_stop() && current_request->image) {
+
+ /* put the image into the cache so that other
+ * WaveViews can use it if it is useful
+ */
+
+ if (current_request->start <= start && current_request->end >= end) {
+
+ cerr << "grabbing new image from request for " << debug_name() << endl;
+
+ ret.reset (new WaveViewCache::Entry (current_request->channel,
+ current_request->height,
+ current_request->region_amplitude,
+ current_request->fill_color,
+ current_request->samples_per_pixel,
+ current_request->start,
+ current_request->end,
+ current_request->image));
+
+ cache_request_result (current_request);
+
+ } else {
+ cerr << debug_name() << " ignoring stale request\n";
+ }
+
+ /* drop our handle on the current request */
+ current_request.reset ();
}
+ }
- framepos_t segment_start = caches[i].start;
- framepos_t segment_end = caches[i].end;
+ if (!ret) {
- if (end <= segment_end && start >= segment_start) {
- image_offset = (segment_start - _region_start) / _samples_per_pixel;
- image = caches[i].image;
+ /* no current image draw request, so look in the cache */
+
+ ret = get_image_from_cache (start, end);
- return;
- }
}
- consolidate_image_cache ();
+ if (!ret) {
- /* sample position is canonical here, and we want to generate
- * an image that spans about twice the canvas width
- */
+ if (get_image_in_thread) {
- const framepos_t center = start + ((end - start) / 2);
- const framecnt_t canvas_samples = _canvas->visible_area().width() * _samples_per_pixel; /* one canvas width */
+ boost::shared_ptr<WaveViewThreadRequest> req (new WaveViewThreadRequest);
- /* we can request data from anywhere in the Source, between 0 and its length
- */
+ req->type = WaveViewThreadRequest::Draw;
+ req->start = start;
+ req->end = end;
+ req->samples_per_pixel = _samples_per_pixel;
+ req->region = _region; /* weak ptr, to avoid storing a reference in the request queue */
+ req->channel = _channel;
+ req->width = _canvas->visible_area().width();
+ req->height = _height;
+ req->fill_color = _fill_color;
+ req->region_amplitude = _region_amplitude;
- framepos_t sample_start = max ((framepos_t) 0, (center - canvas_samples));
- framepos_t sample_end = min (center + canvas_samples, _region->source_length (0));
+ /* draw image in this (the GUI thread) */
+
+ generate_image (req, false);
- const int n_peaks = llrintf ((sample_end - sample_start)/ (double) _samples_per_pixel);
+ /* cache the result */
- boost::scoped_array<ARDOUR::PeakData> peaks (new PeakData[n_peaks]);
+ ret = cache_request_result (req);
- framecnt_t peaks_read;
- peaks_read = _region->read_peaks (peaks.get(), n_peaks,
- sample_start, sample_end - sample_start,
- _channel,
- _samples_per_pixel);
-
- // apply waveform amplitude zoom multiplier
- for (int i = 0; i < n_peaks; ++i) {
- peaks[i].max *= _amplitude_above_axis;
- peaks[i].min *= _amplitude_above_axis;
+ /* reset this so that future missing images are
+ * generated in a a worker thread.
+ */
+
+ get_image_in_thread = false;
+
+ } else {
+ queue_get_image (_region, start, end);
+ }
}
-
- image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, n_peaks, _height);
- if (peaks_read > 0) {
- draw_image (image, peaks.get(), n_peaks);
- } else {
- draw_absent_image (image, peaks.get(), n_peaks);
+
+ return ret;
+}
+
+boost::shared_ptr<WaveViewCache::Entry>
+WaveView::get_image_from_cache (framepos_t start, framepos_t end) const
+{
+ if (!images) {
+ return boost::shared_ptr<WaveViewCache::Entry>();
}
- _image_cache[_region->audio_source ()].push_back (CacheEntry (_channel, _height, _region_amplitude, _fill_color, sample_start, sample_end, image));
+ return images->lookup_image (_region->audio_source (_channel), start, end, _channel,
+ _height, _region_amplitude, _fill_color, _samples_per_pixel);
+}
+
+void
+WaveView::queue_get_image (boost::shared_ptr<const ARDOUR::Region> region, framepos_t start, framepos_t end) const
+{
+ boost::shared_ptr<WaveViewThreadRequest> req (new WaveViewThreadRequest);
+
+ req->type = WaveViewThreadRequest::Draw;
+ req->start = start;
+ req->end = end;
+ req->samples_per_pixel = _samples_per_pixel;
+ req->region = _region; /* weak ptr, to avoid storing a reference in the request queue */
+ req->channel = _channel;
+ req->width = _canvas->visible_area().width();
+ req->height = _height;
+ req->fill_color = _fill_color;
+ req->region_amplitude = _region_amplitude;
+
+ send_request (req);
+}
+
+void
+WaveView::generate_image (boost::shared_ptr<WaveViewThreadRequest> req, bool in_render_thread) const
+{
+ if (!req->should_stop()) {
- image_offset = (sample_start - _region->start()) / _samples_per_pixel;
+ cerr << name << " Generating image in " << (in_render_thread ? " RENDER " : " GUI ") << "thread\n";
- //cerr << "_image_cache size is : " << _image_cache.size() << " entries for this audiosource : " << _image_cache.find (_region->audio_source ())->second.size() << endl;
+ /* sample position is canonical here, and we want to generate
+ * an image that spans about twice the canvas width
+ */
+
+ const framepos_t center = req->start + ((req->end - req->start) / 2);
+ const framecnt_t image_samples = req->width * req->samples_per_pixel; /* one canvas width */
+
+ /* we can request data from anywhere in the Source, between 0 and its length
+ */
+
+ framepos_t sample_start = max (_region_start, (center - image_samples));
+ framepos_t sample_end = min (center + image_samples, region_end());
+
+ const int n_peaks = llrintf ((sample_end - sample_start)/ (req->samples_per_pixel));
+
+ boost::scoped_array<ARDOUR::PeakData> peaks (new PeakData[n_peaks]);
+
+ /* Note that Region::read_peaks() takes a start position based on an
+ offset into the Region's **SOURCE**, rather than an offset into
+ the Region itself.
+ */
+
+ _region->read_peaks (peaks.get(), n_peaks,
+ sample_start, sample_end - sample_start,
+ req->channel,
+ req->samples_per_pixel);
+
+
+ // apply waveform amplitude zoom multiplier
+ for (int i = 0; i < n_peaks; ++i) {
+ peaks[i].max *= _amplitude_above_axis;
+ peaks[i].min *= _amplitude_above_axis;
+ }
+
+ req->image = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, n_peaks, req->height);
+
+ /* make sure we record the sample positions that were actually used */
+
+ req->start = sample_start;
+ req->end = sample_end;
+
+ draw_image (req->image, peaks.get(), n_peaks, req);
+ }
+
+ if (in_render_thread && !req->should_stop()) {
+ const_cast<WaveView*>(this)->ImageReady (); /* emit signal */
+ }
+
return;
}
+/** Given a waveform that starts at window x-coordinate @param wave_origin
+ * and the first pixel that we will actually draw @param draw_start, return
+ * the offset into an image of the entire waveform that we will need to use.
+ *
+ * Note: most of our cached images are NOT of the entire waveform, this is just
+ * computationally useful when determining which the sample range span for
+ * the image we need.
+ */
+static inline double
+window_to_image (double wave_origin, double image_start)
+{
+ return image_start - wave_origin;
+}
+
void
WaveView::render (Rect const & area, Cairo::RefPtr<Cairo::Context> context) const
{
assert (_samples_per_pixel != 0);
+ rendered = true; /* comments in header file */
+
if (!_region) {
return;
}
- Rect self = item_to_window (Rect (0.0, 0.0, _region->length() / _samples_per_pixel, _height));
+ /* a WaveView is intimately connected to an AudioRegion. It will
+ * display the waveform within the region, anywhere from the start of
+ * the region to its end.
+ *
+ * the area we've been aked to render may overlap with area covered
+ * by the region in any of the normal ways:
+ *
+ * - it may begin and end within the area covered by the region
+ * - it may start before and end after the area covered by region
+ * - it may start before and end within the area covered by the region
+ * - it may start within and end after the area covered by the region
+ * - it may be precisely coincident with the area covered by region.
+ *
+ * So let's start by determining the area covered by the region, in
+ * window coordinates. It begins at zero (in item coordinates for this
+ * waveview, and extends to region_length() / _samples_per_pixel.
+ */
+
+ Rect self = item_to_window (Rect (0.0, 0.0, region_length() / _samples_per_pixel, _height));
+
+ /* Now lets get the intersection with the area we've been asked to draw */
+
boost::optional<Rect> d = self.intersection (area);
if (!d) {
Rect draw = d.get();
+ /* "draw" is now a rectangle that defines the rectangle we need to
+ * update/render the waveview into, in window coordinate space.
+ */
+
/* window coordinates - pixels where x=0 is the left edge of the canvas
* window. We round down in case we were asked to
* draw "between" pixels at the start and/or end.
double draw_start = floor (draw.x0);
const double draw_end = floor (draw.x1);
- // cerr << "Need to draw " << draw_start << " .. " << draw_end << endl;
-
+ // cerr << "Need to draw " << draw_start << " .. " << draw_end << " vs. " << area << " and self = " << self << endl;
+
/* image coordnates: pixels where x=0 is the start of this waveview,
* wherever it may be positioned. thus image_start=N means "an image
- * that beings N pixels after the start of region that this waveview is
+ * that begins N pixels after the start of region that this waveview is
* representing.
*/
const framepos_t image_start = window_to_image (self.x0, draw_start);
const framepos_t image_end = window_to_image (self.x0, draw_end);
-
+
// cerr << "Image/WV space: " << image_start << " .. " << image_end << endl;
- /* sample coordinates - note, these are not subject to rounding error */
+ /* sample coordinates - note, these are not subject to rounding error
+ *
+ * "sample_start = N" means "the first sample we need to represent is N
+ * samples after the first sample of the region"
+ */
+
framepos_t sample_start = _region_start + (image_start * _samples_per_pixel);
framepos_t sample_end = _region_start + (image_end * _samples_per_pixel);
+
+ // cerr << "Sample space: " << sample_start << " .. " << sample_end << " @ " << _samples_per_pixel << " rs = " << _region_start << endl;
+
+ /* sample_start and sample_end are bounded by the region
+ * limits. sample_start, because of the was just computed, must already
+ * be greater than or equal to the _region_start value.
+ */
+
+ sample_end = min (region_end(), sample_end);
- // cerr << "Sample space: " << sample_start << " .. " << sample_end << endl;
+ // cerr << debug_name() << " will need image spanning " << sample_start << " .. " << sample_end << " region spans " << _region_start << " .. " << region_end() << endl;
+
+ double image_offset;
+
+ if (_current_image) {
+
+ /* check it covers the right sample range */
+
+ if (_current_image->start > sample_start || _current_image->end < sample_end) {
+ /* doesn't cover the area we need ... reset */
+ _current_image.reset ();
+ } else {
+ /* timestamp our continuing use of this image/cache entry */
+ images->use (_region->audio_source (_channel), _current_image);
+ }
+ }
+
+ if (!_current_image) {
- Cairo::RefPtr<Cairo::ImageSurface> image;
- double image_offset = 0;
+ /* look it up */
+
+ _current_image = get_image (sample_start, sample_end);
- get_image (image, sample_start, sample_end, image_offset);
+ if (!_current_image) {
+ /* image not currently available. A redraw will be scheduled
+ when it is ready.
+ */
+ cerr << debug_name() << " nothing to draw with\n";
+ return;
+ }
+ }
+ cerr << name << " image ? " << _current_image << endl;
+
+ /* fix up offset: returned value is the first sample of the returned image */
+
+ image_offset = (_current_image->start - _region_start) / _samples_per_pixel;
+
// cerr << "Offset into image to place at zero: " << image_offset << endl;
if (_start_shift && (sample_start == _region_start) && (self.x0 == draw.x0)) {
y = round (y);
context->device_to_user (x, y);
- context->set_source (image, x, y);
+ context->set_source (_current_image->image, x, y);
context->fill ();
}
WaveView::compute_bounding_box () const
{
if (_region) {
- _bounding_box = Rect (0.0, 0.0, _region->length() / _samples_per_pixel, _height);
+ _bounding_box = Rect (0.0, 0.0, region_length() / _samples_per_pixel, _height);
} else {
_bounding_box = boost::optional<Rect> ();
}
invalidate_image_cache ();
_height = height;
-
+ get_image_in_thread = true;
+
_bounding_box_dirty = true;
end_change ();
}
}
}
+framecnt_t
+WaveView::region_length() const
+{
+ return _region->length() - (_region_start - _region->start());
+}
+
+framepos_t
+WaveView::region_end() const
+{
+ return _region_start + region_length();
+}
+
void
WaveView::set_region_start (frameoffset_t start)
{
end_visual_change ();
}
+
+void
+WaveView::cancel_my_render_request () const
+{
+ if (!images) {
+ return;
+ }
+
+ /* try to stop any current rendering of the request, or prevent it from
+ * ever starting up.
+ */
+
+ if (current_request) {
+ current_request->cancel ();
+ }
+
+ Glib::Threads::Mutex::Lock lm (request_queue_lock);
+
+ /* now remove it from the queue and reset our request pointer so that
+ have no outstanding request (that we know about)
+ */
+
+ request_queue.erase (this);
+ current_request.reset ();
+}
+
+void
+WaveView::send_request (boost::shared_ptr<WaveViewThreadRequest> req) const
+{
+ if (req->type == WaveViewThreadRequest::Draw && current_request) {
+ /* this will stop rendering in progress (which might otherwise
+ be long lived) for any current request.
+ */
+ current_request->cancel ();
+ }
+
+ start_drawing_thread ();
+
+ Glib::signal_idle().connect (sigc::bind (sigc::mem_fun (this, &WaveView::idle_send_request), req));
+}
+
+bool
+WaveView::idle_send_request (boost::shared_ptr<WaveViewThreadRequest> req) const
+{
+ {
+ Glib::Threads::Mutex::Lock lm (request_queue_lock);
+ /* swap requests (protected by lock) */
+ current_request = req;
+ request_queue.insert (this);
+ }
+
+ request_cond.signal (); /* wake thread */
+
+ return false; /* do not call from idle again */
+}
+
+/*-------------------------------------------------*/
+
+void
+WaveView::start_drawing_thread ()
+{
+ if (!_drawing_thread) {
+ _drawing_thread = Glib::Threads::Thread::create (sigc::ptr_fun (WaveView::drawing_thread));
+ }
+}
+
+void
+WaveView::stop_drawing_thread ()
+{
+ if (_drawing_thread) {
+ Glib::Threads::Mutex::Lock lm (request_queue_lock);
+ g_atomic_int_set (&drawing_thread_should_quit, 1);
+ request_cond.signal ();
+ }
+}
+
+void
+WaveView::drawing_thread ()
+{
+ using namespace Glib::Threads;
+
+ WaveView const * requestor;
+ Mutex::Lock lm (request_queue_lock);
+ bool run = true;
+
+ while (run) {
+
+ /* remember that we hold the lock at this point, no matter what */
+
+ if (g_atomic_int_get (&drawing_thread_should_quit)) {
+ break;
+ }
+
+ if (request_queue.empty()) {
+ request_cond.wait (request_queue_lock);
+ }
+
+ /* remove the request from the queue (remember: the "request"
+ * is just a pointer to a WaveView object)
+ */
+
+ requestor = *(request_queue.begin());
+ request_queue.erase (request_queue.begin());
+
+ boost::shared_ptr<WaveViewThreadRequest> req = requestor->current_request;
+
+ if (!req) {
+ cerr << requestor->debug_name() << " no current request\n";
+ continue;
+ }
+
+ /* Generate an image. Unlock the request queue lock
+ * while we do this, so that other things can happen
+ * as we do rendering.
+ */
+
+ request_queue_lock.unlock (); /* some RAII would be good here */
+
+ try {
+ requestor->generate_image (req, true);
+ } catch (...) {
+ req->image.clear(); /* just in case it was set before the exception, whatever it was */
+ }
+
+ request_queue_lock.lock ();
+
+ req.reset (); /* drop/delete request as appropriate */
+ }
+
+ /* thread is vanishing */
+ _drawing_thread = 0;
+}
+
+/*-------------------------------------------------*/
+
+WaveViewCache::WaveViewCache ()
+ : image_cache_size (0)
+ , _image_cache_threshold (100 * 1048576) /* bytes */
+{
+}
+
+WaveViewCache::~WaveViewCache ()
+{
+}
+
+
+boost::shared_ptr<WaveViewCache::Entry>
+WaveViewCache::lookup_image (boost::shared_ptr<ARDOUR::AudioSource> src,
+ framepos_t start, framepos_t end,
+ int channel,
+ Coord height,
+ float amplitude,
+ Color fill_color,
+ double samples_per_pixel)
+{
+ ImageCache::iterator x;
+
+ if ((x = cache_map.find (src)) == cache_map.end ()) {
+ /* nothing in the cache for this audio source at all */
+ return boost::shared_ptr<WaveViewCache::Entry> ();
+ }
+
+ CacheLine& caches = x->second;
+
+ /* Find a suitable ImageSurface, if it exists.
+ */
+
+ for (CacheLine::iterator c = caches.begin(); c != caches.end(); ++c) {
+
+ boost::shared_ptr<Entry> e (*c);
+
+ if (channel != e->channel
+ || height != e->height
+ || amplitude != e->amplitude
+ || samples_per_pixel != e->samples_per_pixel
+ || fill_color != e->fill_color) {
+ continue;
+ }
+
+ if (end <= e->end && start >= e->start) {
+ /* found an image that covers the range we need */
+ use (src, e);
+ return e;
+ }
+ }
+
+ return boost::shared_ptr<Entry> ();
+}
+
+void
+WaveViewCache::consolidate_image_cache (boost::shared_ptr<ARDOUR::AudioSource> src,
+ int channel,
+ Coord height,
+ float amplitude,
+ Color fill_color,
+ double samples_per_pixel)
+{
+ list <uint32_t> deletion_list;
+ uint32_t other_entries = 0;
+ ImageCache::iterator x;
+
+ /* MUST BE CALLED FROM (SINGLE) GUI THREAD */
+
+ if ((x = cache_map.find (src)) == cache_map.end ()) {
+ return;
+ }
+
+ CacheLine& caches = x->second;
+
+ for (CacheLine::iterator c1 = caches.begin(); c1 != caches.end(); ) {
+
+ CacheLine::iterator nxt = c1;
+ ++nxt;
+
+ boost::shared_ptr<Entry> e1 (*c1);
+
+ if (channel != e1->channel
+ || height != e1->height
+ || amplitude != e1->amplitude
+ || samples_per_pixel != e1->samples_per_pixel
+ || fill_color != e1->fill_color) {
+
+ /* doesn't match current properties, ignore and move on
+ * to the next one.
+ */
+
+ other_entries++;
+ c1 = nxt;
+ continue;
+ }
+
+ /* c1 now points to a cached image entry that matches current
+ * properties. Check all subsequent cached imaged entries to
+ * see if there are others that also match but represent
+ * subsets of the range covered by this one.
+ */
+
+ for (CacheLine::iterator c2 = c1; c2 != caches.end(); ) {
+
+ CacheLine::iterator nxt2 = c2;
+ ++nxt2;
+
+ boost::shared_ptr<Entry> e2 (*c2);
+
+ if (e1 == e2 || channel != e2->channel
+ || height != e2->height
+ || amplitude != e2->amplitude
+ || samples_per_pixel != e2->samples_per_pixel
+ || fill_color != e2->fill_color) {
+
+ /* properties do not match, ignore for the
+ * purposes of consolidation.
+ */
+ c2 = nxt2;
+ continue;
+ }
+
+ if (e2->start >= e1->start && e2->end <= e1->end) {
+ /* c2 is fully contained by c1, so delete it */
+ c2 = caches.erase (c2);
+ continue;
+ }
+
+ c2 = nxt2;
+ }
+
+ c1 = nxt;
+ }
+}
+
+void
+WaveViewCache::use (boost::shared_ptr<ARDOUR::AudioSource> src, boost::shared_ptr<Entry> ce)
+{
+ ce->timestamp = g_get_monotonic_time ();
+}
+
+void
+WaveViewCache::add (boost::shared_ptr<ARDOUR::AudioSource> src, boost::shared_ptr<Entry> ce)
+{
+ /* MUST BE CALLED FROM (SINGLE) GUI THREAD */
+
+ Cairo::RefPtr<Cairo::ImageSurface> img (ce->image);
+
+ image_cache_size += img->get_height() * img->get_width () * 4; /* 4 = bytes per FORMAT_ARGB32 pixel */
+
+ if (cache_full()) {
+ cache_flush ();
+ }
+
+ ce->timestamp = g_get_monotonic_time ();
+
+ cache_map[src].push_back (ce);
+ cache_list.push_back (make_pair (src, ce));
+}
+
+uint64_t
+WaveViewCache::compute_image_cache_size()
+{
+ uint64_t total = 0;
+ for (ImageCache::iterator s = cache_map.begin(); s != cache_map.end(); ++s) {
+ CacheLine& per_source_cache (s->second);
+ for (CacheLine::iterator c = per_source_cache.begin(); c != per_source_cache.end(); ++c) {
+ Cairo::RefPtr<Cairo::ImageSurface> img ((*c)->image);
+ total += img->get_height() * img->get_width() * 4; /* 4 = bytes per FORMAT_ARGB32 pixel */
+ }
+ }
+ return total;
+}
+
+bool
+WaveViewCache::cache_full()
+{
+ return image_cache_size > _image_cache_threshold;
+}
+
+void
+WaveViewCache::cache_flush ()
+{
+ SortByTimestamp sorter;
+
+ /* sort list in LRU order */
+
+ sort (cache_list.begin(), cache_list.end(), sorter);
+
+ while (image_cache_size > _image_cache_threshold) {
+
+ ListEntry& le (cache_list.front());
+
+ ImageCache::iterator x;
+
+ if ((x = cache_map.find (le.first)) == cache_map.end ()) {
+ /* wierd ... no entry for this AudioSource */
+ continue;
+ }
+
+ CacheLine& cl = x->second;
+
+ for (CacheLine::iterator c = cl.begin(); c != cl.end(); ++c) {
+
+ if (*c == le.second) {
+
+ /* Remove this entry from this cache line */
+ cl.erase (c);
+
+ if (cl.empty()) {
+ /* remove cache line from main cache: no more entries */
+ cache_map.erase (x);
+ }
+
+ break;
+ }
+ }
+
+ Cairo::RefPtr<Cairo::ImageSurface> img (le.second->image);
+ uint64_t size = img->get_height() * img->get_width() * 4; /* 4 = bytes per FORMAT_ARGB32 pixel */
+
+ if (image_cache_size > size) {
+ image_cache_size -= size;
+ } else {
+ image_cache_size = 0;
+ }
+
+ /* Remove from the linear list */
+ cache_list.erase (cache_list.begin());
+ }
+}
+
+void
+WaveViewCache::set_image_cache_threshold (uint64_t sz)
+{
+ _image_cache_threshold = sz;
+ cache_flush ();
+}
projects / ardour.git / commitdiff