#include <SonagramPlugin.h>

Inheritance diagram for Kwave::SonagramPlugin:

Collaboration diagram for Kwave::SonagramPlugin:

Classes
struct	Slice

Signals
void	sliceAvailable (Kwave::SonagramPlugin::Slice *slice)

Signals inherited from Kwave::Plugin
void	sigRunning (Kwave::Plugin *plugin)

void	sigDone (Kwave::Plugin *plugin)

void	sigClosed (Kwave::Plugin *p)

void	sigCommand (const QString &command)

void	setProgressText (const QString &text)

Public Member Functions
	SonagramPlugin (QObject *parent, const QVariantList &args)

virtual	~SonagramPlugin () Q_DECL_OVERRIDE

virtual QStringList *	setup (QStringList &previous_params) Q_DECL_OVERRIDE

virtual int	start (QStringList &params) Q_DECL_OVERRIDE

virtual void	run (QStringList params) Q_DECL_OVERRIDE

Public Member Functions inherited from Kwave::Plugin
	Plugin (QObject *parent, const QVariantList &args)

virtual	~Plugin () Q_DECL_OVERRIDE

virtual QString	name () const

virtual QString	description () const

virtual QString	progressText ()

virtual bool	canClose () const

bool	isRunning () const

bool	shouldStop () const

virtual void	load (QStringList &params)

virtual void	unload ()

virtual int	stop ()

Kwave::PluginManager &	manager () const

Kwave::SignalManager &	signalManager ()

QWidget *	parentWidget () const

QString	signalName ()

virtual sample_index_t	signalLength ()

virtual double	signalRate ()

virtual const QList< unsigned int >	selectedTracks ()

virtual sample_index_t	selection (QList< unsigned int > tracks=Q_NULLPTR, sample_index_t left=Q_NULLPTR, sample_index_t *right=Q_NULLPTR, bool expand_if_empty=false)

virtual void	selectRange (sample_index_t offset, sample_index_t length)

virtual void	migrateToActiveContext ()

Public Member Functions inherited from Kwave::Runnable
virtual	~Runnable ()

Protected Member Functions
int	interpreteParameters (QStringList &params)

Protected Member Functions inherited from Kwave::Plugin
int	execute (QStringList &params)

void	emitCommand (const QString &command)

void	use ()

void	setPluginManager (Kwave::PluginManager *new_plugin_manager)

virtual void	run_wrapper (const QVariant &params) Q_DECL_OVERRIDE

Private Slots
void	validate ()

void	windowDestroyed ()

void	insertSlice (Kwave::SonagramPlugin::Slice *slice)

void	refreshOverview ()

void	slotTrackInserted (const QUuid &track_id)

void	slotTrackDeleted (const QUuid &track_id)

void	slotInvalidated (const QUuid *track_id, sample_index_t first, sample_index_t last)

Private Member Functions
void	makeAllValid ()

void	requestValidation ()

void	calculateSlice (Kwave::SonagramPlugin::Slice *slice)

void	createNewImage (const unsigned int width, const unsigned int height)

Private Attributes
Kwave::SonagramWindow *	m_sonagram_window

Kwave::SelectionTracker *	m_selection

unsigned int	m_slices

unsigned int	m_fft_points

Kwave::window_function_t	m_window_type

bool	m_color

bool	m_track_changes

bool	m_follow_selection

QImage	m_image

Kwave::OverViewCache *	m_overview_cache

Kwave::FixedPool< MAX_FFT_JOBS, Slice >	m_slice_pool

QBitArray	m_valid

QReadWriteLock	m_pending_jobs

QMutex	m_lock_job_list

QFuture< void >	m_future

QTimer	m_repaint_timer

Additional Inherited Members
Public Slots inherited from Kwave::Plugin
virtual void	setProgressDialogEnabled (bool enable)

virtual void	updateProgress (qreal progress)

virtual void	cancel ()

virtual void	close ()

void	release ()

Detailed Description

plugin that shows a sonagram window

Definition at line 64 of file SonagramPlugin.h.

Constructor & Destructor Documentation

◆ SonagramPlugin()

Kwave::SonagramPlugin::SonagramPlugin	(	QObject *	parent,
		const QVariantList &	args
	)

Constructor

Parameters

parent	reference to our plugin manager
args	argument list [unused]

Definition at line 62 of file SonagramPlugin.cpp.

References Kwave::connect(), insertSlice(), m_repaint_timer, sliceAvailable(), and validate().

     :Kwave::Plugin(parent, args),
      m_sonagram_window(Q_NULLPTR),
      m_selection(Q_NULLPTR),
      m_slices(0), m_fft_points(0),
      m_window_type(Kwave::WINDOW_FUNC_NONE), m_color(true),
      m_track_changes(true), m_follow_selection(false), m_image(),
      m_overview_cache(Q_NULLPTR), m_slice_pool(), m_valid(MAX_SLICES, false),
      m_pending_jobs(), m_lock_job_list(QMutex::Recursive), m_future(),
      m_repaint_timer()
 {
     i18n("Sonagram");
 
     // connect the output ouf the sonagram worker thread
     connect(this, SIGNAL(sliceAvailable(Kwave::SonagramPlugin::Slice*)),
             this, SLOT(insertSlice(Kwave::SonagramPlugin::Slice*)),
             Qt::QueuedConnection);
 
     // connect repaint timer
     connect(&m_repaint_timer, SIGNAL(timeout()),
             this, SLOT(validate()));
 }

Here is the call graph for this function:

◆ ~SonagramPlugin()

Kwave::SonagramPlugin::~SonagramPlugin ( )

virtual

Destructor

Definition at line 87 of file SonagramPlugin.cpp.

References m_repaint_timer, m_selection, and m_sonagram_window.

 {
     m_repaint_timer.stop();
 
     if (m_sonagram_window) delete m_sonagram_window;
     m_sonagram_window = Q_NULLPTR;
 
     if (m_selection) delete m_selection;
     m_selection = Q_NULLPTR;
 }

Member Function Documentation

◆ calculateSlice()

void Kwave::SonagramPlugin::calculateSlice ( Kwave::SonagramPlugin::Slice * slice )

private

do the FFT calculation on a slice

Parameters

slice structure with the input data and output buffer

Definition at line 399 of file SonagramPlugin.cpp.

References m_fft_points, Kwave::SonagramPlugin::Slice::m_input, Kwave::SonagramPlugin::Slice::m_output, Kwave::SonagramPlugin::Slice::m_result, and sliceAvailable().

Referenced by makeAllValid().

 {
     fftw_plan p;
 
     // prepare for a 1-dimensional real-to-complex DFT
     {
         Kwave::GlobalLock _lock; // libfftw is not threadsafe!
         p = fftw_plan_dft_r2c_1d(
             m_fft_points,
             &(slice->m_input[0]),
             &(slice->m_output[0]),
             FFTW_ESTIMATE
         );
     }
     Q_ASSERT(p);
     if (!p) return;
 
     // calculate the fft (according to the specs, this is the one and only
     // libfft function that is threadsafe!)
     fftw_execute(p);
 
     // norm all values to [0...254] and use them as pixel value
     const double scale = static_cast<double>(m_fft_points) / 254.0;
     for (unsigned int j = 0; j < m_fft_points / 2; j++) {
         // get singal energy and scale to [0 .. 254]
         double rea = slice->m_output[j][0];
         double ima = slice->m_output[j][1];
         double a = ((rea * rea) + (ima * ima)) / scale;
 
         slice->m_result[j] = static_cast<unsigned char>(qMin(a, double(254.0)));
     }
 
     // free the allocated FFT resources
     {
         Kwave::GlobalLock _lock; // libfftw is not threadsafe!
         fftw_destroy_plan(p);
     }
 
     // emit the slice data to be synchronously inserted into
     // the current image in the context of the main thread
     // (Qt does the queuing for us)
     emit sliceAvailable(slice);
 }

Here is the caller graph for this function:

◆ createNewImage()

void Kwave::SonagramPlugin::createNewImage	(	const unsigned int	width,
		const unsigned int	height
	)

private

Creates a new image for the current processing. If an old image exists, it will be deleted first, a new image will not be created if either width or height is zero. The image will get 8 bits depth and use a color or a greyscale palette.

Parameters

width	number of horizontal pixels (slices = signal length / fft points, rounded up) [1..32767]
height	number of vertical pixels (= fft points / 2) [1..32767]

Definition at line 469 of file SonagramPlugin.cpp.

References m_image, m_sonagram_window, and Kwave::SonagramWindow::setImage().

Referenced by start().

 {
     // delete the previous image
     m_image = QImage();
     if (m_sonagram_window) m_sonagram_window->setImage(m_image);
 
     // do not create a new image if one dimension is zero!
     Q_ASSERT(width);
     Q_ASSERT(height);
     if (!width || !height) return;
 
     // also do not create if the image size is out of range
     Q_ASSERT(width <= 32767);
     Q_ASSERT(height <= 32767);
     if ((width >= 32767) || (height >= 32767)) return;
 
     // create the new image object
     m_image = QImage(width, height, QImage::Format_Indexed8);
     Q_ASSERT(!m_image.isNull());
     if (m_image.isNull()) return;
 
     // initialize the image's palette with transparecy
     m_image.setColorCount(256);
     for (int i = 0; i < 256; i++) {
         m_image.setColor(i, 0x00000000);
     }
 
     // fill the image with "empty" (transparent)
     m_image.fill(0xFF);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertSlice

void Kwave::SonagramPlugin::insertSlice ( Kwave::SonagramPlugin::Slice * slice )

privateslot

Internally used to synchronously insert the data of one sonagram slice int the current image and refresh the display.

Note: DO NOT CALL DIRECTLY!

Parameters

slice a slice data container, including result

Definition at line 444 of file SonagramPlugin.cpp.

References Kwave::SonagramWindow::insertSlice(), m_fft_points, Kwave::SonagramPlugin::Slice::m_index, m_pending_jobs, Kwave::SonagramPlugin::Slice::m_result, m_slice_pool, and m_sonagram_window.

Referenced by SonagramPlugin().

 {
     // check: this must be called from the GUI thread only!
     Q_ASSERT(this->thread() == QThread::currentThread());
     Q_ASSERT(this->thread() == qApp->thread());
 
     Q_ASSERT(slice);
     if (!slice) return;
 
     QByteArray result;
     result.setRawData(reinterpret_cast<char *>(&(slice->m_result[0])),
                       m_fft_points / 2);
     unsigned int nr = slice->m_index;
 
     // forward the slice to the window to display it
     if (m_sonagram_window) m_sonagram_window->insertSlice(nr, result);
 
     // return the slice into the pool
     m_slice_pool.release(slice);
 
     // job is done
     m_pending_jobs.unlock();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpreteParameters()

int Kwave::SonagramPlugin::interpreteParameters ( QStringList & params )

protected

interpretes a given parameter list and sets up internal coordinates accordingly

Parameters

params reference to a QStringList with parameters

Returns: 0 if ok, or an error code if failed

Definition at line 126 of file SonagramPlugin.cpp.

References Kwave::WindowFunction::findFromName(), m_color, m_fft_points, m_follow_selection, m_track_changes, m_window_type, and MAX_FFT_POINTS.

Referenced by setup(), and start().

 {
     bool ok;
     QString param;
 
     // evaluate the parameter list
     if (params.count() != 5) return -EINVAL;
 
     param = params[0];
     m_fft_points = param.toUInt(&ok);
     if (!ok) return -EINVAL;
     if (m_fft_points > MAX_FFT_POINTS) m_fft_points = MAX_FFT_POINTS;
 
     param = params[1];
     m_window_type = Kwave::WindowFunction::findFromName(param);
     if (!ok) return -EINVAL;
 
     param = params[2];
     m_color = (param.toUInt(&ok) != 0);
     if (!ok) return -EINVAL;
 
     param = params[3];
     m_track_changes = (param.toUInt(&ok) != 0);
     if (!ok) return -EINVAL;
 
     param = params[4];
     m_follow_selection = (param.toUInt(&ok) != 0);
     if (!ok) return -EINVAL;
 
     return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeAllValid()

void Kwave::SonagramPlugin::makeAllValid ( )

private

will be run in a background thread to make all stripes valid.

Definition at line 271 of file SonagramPlugin.cpp.

References Kwave::SelectionTracker::allTracks(), Kwave::SignalManager::allTracks(), calculateSlice(), Kwave::MultiTrackReader::eof(), Kwave::SelectionTracker::first(), Kwave::SelectionTracker::last(), Kwave::SelectionTracker::length(), m_fft_points, m_lock_job_list, m_pending_jobs, m_selection, m_slice_pool, m_slices, m_valid, m_window_type, Kwave::WindowFunction::points(), sample2double(), Kwave::MultiTrackReader::seek(), Kwave::Plugin::shouldStop(), Kwave::Plugin::signalManager(), Kwave::SinglePassForward, sliceAvailable(), and Kwave::toInt().

Referenced by run(), and validate().

 {
     unsigned int             fft_points;
     unsigned int             slices;
     Kwave::window_function_t window_type;
     sample_index_t           first_sample;
     sample_index_t           last_sample;
     QBitArray                valid;
     QList<unsigned int>      track_list;
 
     {
         QMutexLocker _lock(&m_lock_job_list);
 
         if (!m_selection) return;
         if (!m_selection->length() || (m_fft_points < 4)) return;
 
         fft_points   = m_fft_points;
         slices       = m_slices;
         window_type  = m_window_type;
         first_sample = m_selection->first();
         last_sample  = m_selection->last();
         valid        = m_valid;
         m_valid.fill(true);
 
         const QList<QUuid> selected_tracks(m_selection->allTracks());
         foreach (unsigned int track, signalManager().allTracks())
             if (selected_tracks.contains(signalManager().uuidOfTrack(track)))
                 track_list.append(track);
     }
     const unsigned int tracks = track_list.count();
 
     Kwave::WindowFunction func(window_type);
     const QVector<double> windowfunction = func.points(fft_points);
     Q_ASSERT(windowfunction.count() == Kwave::toInt(fft_points));
     if (windowfunction.count() != Kwave::toInt(fft_points)) return;
 
     Kwave::MultiTrackReader source(Kwave::SinglePassForward,
         signalManager(), track_list, first_sample, last_sample);
 
 //     qDebug("SonagramPlugin[%p]::makeAllValid() [%llu .. %llu]",
 //      static_cast<void *>(this), first_sample, last_sample);
 
     QFutureSynchronizer<void> synchronizer;
     for (unsigned int slice_nr = 0; slice_nr < slices; slice_nr++) {
 //      qDebug("SonagramPlugin::run(): calculating slice %d of %d",
 //             slice_nr, m_slices);
 
         if (valid[slice_nr]) continue;
 
         // determine start of the stripe
         sample_index_t pos = first_sample + (slice_nr * fft_points);
 
         // get a new slice from the pool and initialize it
         Kwave::SonagramPlugin::Slice *slice = m_slice_pool.allocate();
         Q_ASSERT(slice);
 
         slice->m_index = slice_nr;
         memset(slice->m_input,  0x00, sizeof(slice->m_input));
         memset(slice->m_output, 0x00, sizeof(slice->m_output));
 
         if ((pos <= last_sample) && (tracks)) {
             // initialize result with zeroes
             memset(slice->m_result, 0x00, sizeof(slice->m_result));
 
             // seek to the start of the slice
             source.seek(pos);
 
             // we have a new slice, now fill it's input buffer
             double *in = slice->m_input;
             for (unsigned int j = 0; j < fft_points; j++) {
                 double value = 0.0;
                 if (!(source.eof())) {
                     for (unsigned int t = 0; t < tracks; t++) {
                         sample_t s = 0;
                         Kwave::SampleReader *reader = source[t];
                         Q_ASSERT(reader);
                         if (reader) *reader >> s;
                         value += sample2double(s);
                     }
                     value /= tracks;
                 }
                 in[j] = value * windowfunction[j];
             }
 
             // a background job is running soon
             // (for counterpart, see insertSlice(...) below [main thread])
             m_pending_jobs.lockForRead();
 
             // run the FFT in a background thread
             synchronizer.addFuture(QtConcurrent::run(
                 this, &Kwave::SonagramPlugin::calculateSlice, slice)
             );
         } else {
             // range has been deleted -> fill with "empty"
             memset(slice->m_result, 0xFF, sizeof(slice->m_result));
             m_pending_jobs.lockForRead();
             emit sliceAvailable(slice);
         }
 
         if (shouldStop()) break;
     }
 
 //     qDebug("SonagramPlugin::makeAllValid(): waiting for background jobs...");
 
     // wait for all worker threads
     synchronizer.waitForFinished();
 
     // wait for queued signals
     m_pending_jobs.lockForWrite();
     m_pending_jobs.unlock();
 
 //     qDebug("SonagramPlugin::makeAllValid(): done.");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshOverview

void Kwave::SonagramPlugin::refreshOverview ( )

privateslot

Updates the overview image under the sonagram

Definition at line 502 of file SonagramPlugin.cpp.

References Kwave::OverViewCache::getOverView(), m_overview_cache, m_sonagram_window, Kwave::SonagramWindow::setOverView(), and SONAGRAM_OVERVIEW_HEIGHT.

Referenced by start().

 {
     if (!m_overview_cache || !m_sonagram_window) return;
 
     QColor fg = m_sonagram_window->palette().light().color();
     QColor bg = m_sonagram_window->palette().mid().color();
     QImage overview = m_overview_cache->getOverView(
        m_sonagram_window->width(), SONAGRAM_OVERVIEW_HEIGHT, fg, bg);
 
     m_sonagram_window->setOverView(overview);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestValidation()

void Kwave::SonagramPlugin::requestValidation ( )

private

Requests an update of the sonagram or portions of it

Definition at line 515 of file SonagramPlugin.cpp.

References m_repaint_timer, and REPAINT_INTERVAL.

Referenced by slotInvalidated(), slotTrackDeleted(), slotTrackInserted(), and validate().

 {
     // only re-start the repaint timer, this hides some GUI update artifacts
     if (!m_repaint_timer.isActive()) {
         m_repaint_timer.stop();
         m_repaint_timer.setSingleShot(true);
         m_repaint_timer.start(REPAINT_INTERVAL);
     }
 }

Here is the caller graph for this function:

◆ run()

void Kwave::SonagramPlugin::run ( QStringList params )

virtual

Runns once until all slices of the sonagram are calculated.

Parameters

params list of strings with parameters

See also: Kwave::Plugin::run()

Reimplemented from Kwave::Plugin.

Definition at line 386 of file SonagramPlugin.cpp.

References m_lock_job_list, m_valid, and makeAllValid().

 {
     qDebug("SonagramPlugin::run()");
     Q_UNUSED(params);
     {
         // invalidate all slices
         QMutexLocker _lock(&m_lock_job_list);
         m_valid.fill(false);
     }
     makeAllValid();
 }

Here is the call graph for this function:

◆ setup()

QStringList * Kwave::SonagramPlugin::setup ( QStringList & previous_params )

virtual

See also: Kwave::Plugin::setup()

Reimplemented from Kwave::Plugin.

Definition at line 99 of file SonagramPlugin.cpp.

References interpreteParameters(), m_color, m_follow_selection, m_track_changes, m_window_type, Kwave::SonagramDialog::parameters(), Kwave::SonagramDialog::setColorMode(), Kwave::SonagramDialog::setFollowSelection(), Kwave::SonagramDialog::setTrackChanges(), and Kwave::SonagramDialog::setWindowFunction().

 {
     QStringList *result = Q_NULLPTR;
 
     // try to interprete the list of previous parameters, ignore errors
     if (previous_params.count()) interpreteParameters(previous_params);
 
     Kwave::SonagramDialog *dlg = new(std::nothrow) Kwave::SonagramDialog(*this);
     Q_ASSERT(dlg);
     if (!dlg) return Q_NULLPTR;
 
     dlg->setWindowFunction(m_window_type);
     dlg->setColorMode(m_color ? 1 : 0);
     dlg->setTrackChanges(m_track_changes);
     dlg->setFollowSelection(m_follow_selection);
 
     if (dlg->exec() == QDialog::Accepted) {
         result = new QStringList();
         Q_ASSERT(result);
         if (result) dlg->parameters(*result);
     };
 
     delete dlg;
     return result;
 }

Here is the call graph for this function:

◆ sliceAvailable

void Kwave::SonagramPlugin::sliceAvailable ( Kwave::SonagramPlugin::Slice * slice )

signal

emitted when a new slice has been calculated in calculateSlice()

Parameters

slice the slice data container, including result

Referenced by calculateSlice(), makeAllValid(), and SonagramPlugin().

Here is the caller graph for this function:

◆ slotInvalidated

void Kwave::SonagramPlugin::slotInvalidated	(	const QUuid *	track_id,
		sample_index_t	first,
		sample_index_t	last
	)

privateslot

Connected to the selection tracker's sigInvalidated.

Parameters

track_id	UUID of the track or null for "all tracks"
first	index of the first invalidated sample
last	index of the last invalidated sample

Definition at line 569 of file SonagramPlugin.cpp.

References m_fft_points, m_lock_job_list, m_selection, m_slices, m_track_changes, m_valid, Kwave::SelectionTracker::offset(), requestValidation(), Kwave::round_up(), SAMPLE_INDEX_MAX, and Kwave::toUint().

Referenced by start().

 {
     QMutexLocker lock(&m_lock_job_list);
 
     Q_UNUSED(track_id);
 //     qDebug("SonagramPlugin[%p]::slotInvalidated(%s, %llu, %llu)",
 //          static_cast<void *>(this),
 //         (track_id) ? DBG(track_id->toString()) : "*", first, last);
 
     // check for "track changes" mode
     if (!m_track_changes) return;
 
     // adjust offsets, absolute -> relative
     sample_index_t offset = (m_selection) ? m_selection->offset() : 0;
     Q_ASSERT(first >= offset);
     Q_ASSERT(last  >= offset);
     Q_ASSERT(last  >= first);
     first -= offset;
     last  -= offset;
 
     unsigned int first_idx = Kwave::toUint(first / m_fft_points);
     unsigned int last_idx;
     if (last >= (SAMPLE_INDEX_MAX - (m_fft_points - 1)))
         last_idx = m_slices - 1;
     else
         last_idx = Kwave::toUint(qMin(Kwave::round_up(last,
             static_cast<sample_index_t>(m_fft_points)) / m_fft_points,
             static_cast<sample_index_t>(m_slices - 1))
         );
 
     m_valid.fill(false, first_idx, last_idx + 1);
     requestValidation();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slotTrackDeleted

void Kwave::SonagramPlugin::slotTrackDeleted ( const QUuid & track_id )

privateslot

Connected to the selection tracker's sigTrackInserted.

Parameters

track_id unique ID of the track

See also: SelectionTracker::sigTrackDeleted

Definition at line 554 of file SonagramPlugin.cpp.

References m_lock_job_list, m_slices, m_track_changes, m_valid, and requestValidation().

Referenced by start().

 {
     QMutexLocker _lock(&m_lock_job_list);
 
     Q_UNUSED(track_id);
 
     // check for "track changes" mode
     if (!m_track_changes) return;
 
     // invalidate complete signal
     m_valid.fill(false, m_slices);
     requestValidation();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slotTrackInserted

void Kwave::SonagramPlugin::slotTrackInserted ( const QUuid & track_id )

privateslot

Connected to the selection tracker's sigTrackInserted.

Parameters

track_id unique ID of the track

See also: SelectionTracker::sigTrackInserted

Definition at line 539 of file SonagramPlugin.cpp.

References m_lock_job_list, m_slices, m_track_changes, m_valid, and requestValidation().

Referenced by start().

 {
     QMutexLocker _lock(&m_lock_job_list);
 
     Q_UNUSED(track_id);
 
     // check for "track changes" mode
     if (!m_track_changes) return;
 
     // invalidate complete signal
     m_valid.fill(false, m_slices);
     requestValidation();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ start()

int Kwave::SonagramPlugin::start ( QStringList & params )

virtual

See also: Kwave::Plugin::start()

Reimplemented from Kwave::Plugin.

Definition at line 159 of file SonagramPlugin.cpp.

References Kwave::Plugin::close(), Kwave::connect(), createNewImage(), Kwave::MessageBox::error(), interpreteParameters(), m_color, m_fft_points, m_image, m_overview_cache, m_selection, m_slices, m_sonagram_window, m_track_changes, Kwave::Plugin::manager(), MAX_SLICES, Kwave::Plugin::parentWidget(), refreshOverview(), Kwave::Plugin::selection(), Kwave::SonagramWindow::setColorMode(), Kwave::SonagramWindow::setImage(), Kwave::SonagramWindow::setPoints(), Kwave::SonagramWindow::setRate(), Kwave::Plugin::sigClosed(), Kwave::Plugin::signalManager(), Kwave::Plugin::signalName(), Kwave::Plugin::signalRate(), slotInvalidated(), slotTrackDeleted(), slotTrackInserted(), Kwave::toUint(), Kwave::Plugin::use(), and windowDestroyed().

 {
     // clean up leftovers from last run
     if (m_sonagram_window) delete m_sonagram_window;
     m_sonagram_window = Q_NULLPTR;
     if (m_selection)       delete m_selection;
     m_selection = Q_NULLPTR;
     if (m_overview_cache)  delete m_overview_cache;
     m_overview_cache = Q_NULLPTR;
 
     Kwave::SignalManager &sig_mgr = signalManager();
 
     // interprete parameter list and abort if it contains invalid data
     int result = interpreteParameters(params);
     if (result) return result;
 
     // create an empty sonagram window
     m_sonagram_window = new(std::nothrow)
         Kwave::SonagramWindow(parentWidget(), signalName());
     Q_ASSERT(m_sonagram_window);
     if (!m_sonagram_window) return -ENOMEM;
 
     // if the signal closes, close the sonagram window too
     QObject::connect(&manager(), SIGNAL(sigClosed()),
                      m_sonagram_window, SLOT(close()));
 
     // get the current selection
     QList<unsigned int> selected_channels;
     sample_index_t offset = 0;
     sample_index_t length = 0;
     length = selection(&selected_channels, &offset, Q_NULLPTR, true);
 
     // abort if nothing is selected
     if (!length || selected_channels.isEmpty())
         return -EINVAL;
 
     // calculate the number of slices (width of image)
     m_slices = Kwave::toUint(ceil(static_cast<double>(length) /
                                   static_cast<double>(m_fft_points)));
     if (m_slices > MAX_SLICES) m_slices = MAX_SLICES;
 
     /* limit selection to INT_MAX samples (limitation of the cache index) */
     if ((length / m_fft_points) >= INT_MAX) {
         Kwave::MessageBox::error(parentWidget(),
                                  i18n("File or selection too large"));
         return -EFBIG;
     }
 
     // create a selection tracker
     m_selection = new(std::nothrow) Kwave::SelectionTracker(
         &sig_mgr, offset, length, &selected_channels);
     Q_ASSERT(m_selection);
     if (!m_selection) return -ENOMEM;
 
     connect(m_selection, SIGNAL(sigTrackInserted(QUuid)),
             this,        SLOT(slotTrackInserted(QUuid)));
     connect(m_selection, SIGNAL(sigTrackDeleted(QUuid)),
             this,        SLOT(slotTrackDeleted(QUuid)));
     connect(
         m_selection,
         SIGNAL(sigInvalidated(const QUuid*,sample_index_t,sample_index_t)),
         this,
         SLOT(slotInvalidated(const QUuid*,sample_index_t,sample_index_t))
     );
 
     // create a new empty image
     createNewImage(m_slices, m_fft_points / 2);
 
     // set the overview
     m_overview_cache = new(std::nothrow)
         Kwave::OverViewCache(sig_mgr, offset, length, &selected_channels);
     Q_ASSERT(m_overview_cache);
     if (!m_overview_cache) return -ENOMEM;
 
     refreshOverview(); // <- this needs the m_overview_cache
 
     if (m_track_changes) {
         // stay informed about changes in the signal
         connect(m_overview_cache, SIGNAL(changed()),
                 this, SLOT(refreshOverview()));
     } else {
         // overview cache is no longer needed
         delete m_overview_cache;
         m_overview_cache = Q_NULLPTR;
     }
 
     // connect all needed signals
     connect(m_sonagram_window, SIGNAL(destroyed()),
             this, SLOT(windowDestroyed()));
 
     // activate the window with an initial image
     // and all necessary information
     m_sonagram_window->setColorMode((m_color) ? 1 : 0);
     m_sonagram_window->setImage(m_image);
     m_sonagram_window->setPoints(m_fft_points);
     m_sonagram_window->setRate(signalRate());
     m_sonagram_window->show();
 
     if (m_track_changes) {
         QObject::connect(static_cast<QObject*>(&(manager())),
             SIGNAL(sigSignalNameChanged(QString)),
             m_sonagram_window, SLOT(setName(QString)));
     }
 
     // increment the usage counter and release the plugin when the
     // sonagram window closed
     use();
 
     return 0;
 }

Here is the call graph for this function:

◆ validate

void Kwave::SonagramPlugin::validate ( )

privateslot

validate the sonagram by calling makeAllValid in a background thread

Definition at line 526 of file SonagramPlugin.cpp.

References m_future, makeAllValid(), and requestValidation().

Referenced by SonagramPlugin().

 {
     // wait for previously running jobs to finish
     if (m_future.isRunning()) {
         requestValidation();
         return; // job is still running, come back later...
     }
 
     // queue a background thread for updates
     m_future = QtConcurrent::run(this, &Kwave::SonagramPlugin::makeAllValid);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ windowDestroyed

void Kwave::SonagramPlugin::windowDestroyed ( )

privateslot

Connected to the SonagramWindow's "destroyed()" signal.

See also: class SonagramWindow

Definition at line 606 of file SonagramPlugin.cpp.

References Kwave::Plugin::cancel(), m_overview_cache, m_selection, m_sonagram_window, and Kwave::Plugin::release().

Referenced by start().

 {
     cancel();
 
     m_sonagram_window = Q_NULLPTR; // closes itself !
 
     if (m_selection) delete m_selection;
     m_selection = Q_NULLPTR;
 
     if (m_overview_cache) delete m_overview_cache;
     m_overview_cache = Q_NULLPTR;
 
     release();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_color

bool Kwave::SonagramPlugin::m_color

private

if true, use color display, else use greyscale

Definition at line 230 of file SonagramPlugin.h.

Referenced by interpreteParameters(), setup(), and start().

◆ m_fft_points

unsigned int Kwave::SonagramPlugin::m_fft_points

private

number of fft points

Definition at line 224 of file SonagramPlugin.h.

Referenced by calculateSlice(), insertSlice(), interpreteParameters(), makeAllValid(), slotInvalidated(), and start().

◆ m_follow_selection

bool Kwave::SonagramPlugin::m_follow_selection

private

if true, update the sonagram if the selection changed

Definition at line 236 of file SonagramPlugin.h.

Referenced by interpreteParameters(), and setup().

◆ m_future

QFuture<void> Kwave::SonagramPlugin::m_future

private

the currently running background job

Definition at line 257 of file SonagramPlugin.h.

Referenced by validate().

◆ m_image

QImage Kwave::SonagramPlugin::m_image

private

stores the image that is currently in process

Definition at line 239 of file SonagramPlugin.h.

Referenced by createNewImage(), and start().

◆ m_lock_job_list

QMutex Kwave::SonagramPlugin::m_lock_job_list

private

lock to protect the job list (m_valid)

Definition at line 254 of file SonagramPlugin.h.

Referenced by makeAllValid(), run(), slotInvalidated(), slotTrackDeleted(), and slotTrackInserted().

◆ m_overview_cache

Kwave::OverViewCache* Kwave::SonagramPlugin::m_overview_cache

private

cache with the current signal overview

Definition at line 242 of file SonagramPlugin.h.

Referenced by refreshOverview(), start(), and windowDestroyed().

◆ m_pending_jobs

QReadWriteLock Kwave::SonagramPlugin::m_pending_jobs

private

lock used for tracking running background jobs

Definition at line 251 of file SonagramPlugin.h.

Referenced by insertSlice(), and makeAllValid().

◆ m_repaint_timer

QTimer Kwave::SonagramPlugin::m_repaint_timer

private

timer for refreshing the sonagram

Definition at line 260 of file SonagramPlugin.h.

Referenced by requestValidation(), SonagramPlugin(), and ~SonagramPlugin().

◆ m_selection

Kwave::SelectionTracker* Kwave::SonagramPlugin::m_selection

private

selection tracker

Definition at line 218 of file SonagramPlugin.h.

Referenced by makeAllValid(), slotInvalidated(), start(), windowDestroyed(), and ~SonagramPlugin().

◆ m_slice_pool

Kwave::FixedPool<MAX_FFT_JOBS, Slice> Kwave::SonagramPlugin::m_slice_pool

private

pool of slices

Definition at line 245 of file SonagramPlugin.h.

Referenced by insertSlice(), and makeAllValid().

◆ m_slices

unsigned int Kwave::SonagramPlugin::m_slices

private

number of slices (= width of the image in pixels)

Definition at line 221 of file SonagramPlugin.h.

Referenced by makeAllValid(), slotInvalidated(), slotTrackDeleted(), slotTrackInserted(), and start().

◆ m_sonagram_window

Kwave::SonagramWindow* Kwave::SonagramPlugin::m_sonagram_window

private

the main view of the plugin, a SonagramWindow

Definition at line 215 of file SonagramPlugin.h.

Referenced by createNewImage(), insertSlice(), refreshOverview(), start(), windowDestroyed(), and ~SonagramPlugin().

◆ m_track_changes

bool Kwave::SonagramPlugin::m_track_changes

private

if true, update the sonagram if the signal changes

Definition at line 233 of file SonagramPlugin.h.

Referenced by interpreteParameters(), setup(), slotInvalidated(), slotTrackDeleted(), slotTrackInserted(), and start().

◆ m_valid

QBitArray Kwave::SonagramPlugin::m_valid

private

bit field with "is valid" a flag for each stripe

Definition at line 248 of file SonagramPlugin.h.

Referenced by makeAllValid(), run(), slotInvalidated(), slotTrackDeleted(), and slotTrackInserted().

◆ m_window_type

Kwave::window_function_t Kwave::SonagramPlugin::m_window_type

private

index of the window function

Definition at line 227 of file SonagramPlugin.h.

Referenced by interpreteParameters(), makeAllValid(), and setup().

The documentation for this class was generated from the following files:

plugins/sonagram/SonagramPlugin.h
plugins/sonagram/SonagramPlugin.cpp

Classes

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SonagramPlugin()

◆ ~SonagramPlugin()

Member Function Documentation

◆ calculateSlice()

◆ createNewImage()

◆ insertSlice

◆ interpreteParameters()

◆ makeAllValid()

◆ refreshOverview

◆ requestValidation()

◆ run()

◆ setup()

◆ sliceAvailable

◆ slotInvalidated

◆ slotTrackDeleted

◆ slotTrackInserted

◆ start()

◆ validate

◆ windowDestroyed

Member Data Documentation

◆ m_color

◆ m_fft_points

◆ m_follow_selection

◆ m_future

◆ m_image

◆ m_lock_job_list

◆ m_overview_cache

◆ m_pending_jobs

◆ m_repaint_timer

◆ m_selection

◆ m_slice_pool

◆ m_slices

◆ m_sonagram_window

◆ m_track_changes

◆ m_valid

◆ m_window_type