SonagramPlugin.h

Go to the documentation of this file.

/***************************************************************************
       SonagramPlugin.h  -  plugin that shows a sonagram window
                             -------------------
    begin                : Fri Jul 28 2000
    copyright            : (C) 2000 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef SONAGRAM_PLUGIN_H
#define SONAGRAM_PLUGIN_H

#include "config.h"

#include <complex>
#include <fftw3.h>

#include <QBitArray>
#include <QByteArray>
#include <QFuture>
#include <QList>
#include <QMutex>
#include <QQueue>
#include <QReadWriteLock>
#include <QString>
#include <QTimer>
#include <QUuid>

#include "libkwave/FixedPool.h"
#include "libkwave/Plugin.h"
#include "libkwave/WindowFunction.h"

class QImage;
class QStringList;

#define MAX_FFT_POINTS 32767

#define MAX_FFT_JOBS 256

#define MAX_SLICES 32767

namespace Kwave
{
    class MultiTrackReader;
    class OverViewCache;
    class PluginContext;
    class SelectionTracker;
    class SonagramWindow;

    class SonagramPlugin: public Kwave::Plugin
    {
        Q_OBJECT
    public:

        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;

    private:

        typedef struct {
            unsigned int m_index;

            double m_input[MAX_FFT_POINTS];

            fftw_complex m_output[MAX_FFT_POINTS];

            unsigned char m_result[MAX_FFT_POINTS];
        } Slice;

    signals:

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

    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);

    protected:

        int interpreteParameters(QStringList &params);

    private:

        void makeAllValid();

        void requestValidation();

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

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

    private:

        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;
    };
}

#endif /* SONAGRAM_PLUGIN_H */

//***************************************************************************
//***************************************************************************