Noatun API Documentation
	Overview Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files

vequalizer.h

/*
 * Copyright (c) 2003 Charles Samuels <charles@kde.org>
 *
 * This file is hereby licensed under the GNU General Public License version
 * 2 or later at your option.
 *
 * This file is licensed under the Qt Public License version 1 with the
 * condition that the licensed will be governed under the Laws of California
 * (USA) instead of Norway.  Disputes will be settled in Santa Clara county
 * courts.
 *
 * This file is licensed under the following additional license.  Be aware
 * that it is identical to the BSD license, except for the added clause 3:

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. By integrating this software into any other software codebase, you waive
    all rights to any patents associated with the stated codebase.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef NOATUN_VEQUALIZER_H
#define NOATUN_VEQUALIZER_H

#include <qptrlist.h>
#include <qobject.h>
#include <kurl.h>

class VBand;

class VBandsInterface
{
        friend class VBand;

public:
        VBandsInterface();
        virtual ~VBandsInterface();

        virtual int bands() const=0;
        virtual VBand band(int num)=0;
        VBand operator [] (int num);

private:
        virtual int level(int index) const=0;
        virtual void setLevel(int index, int level)=0;
};


class VInterpolation;
class VEqualizer;

class VBand
{
        friend class VInterpolation;
        friend class VEqualizer;

        struct Private;
        VBand::Private *d;

private:
        VBand(VBandsInterface *bands, int index, int start, int end);

public:
        ~VBand();

        VBand(const VBand &copy);
        VBand & operator =(const VBand &copy);

        int level() const;
        void setLevel(int l);

        int start() const;
        int end() const;

        int center() const;

        QString formatStart(bool withHz=true) const;
        QString formatEnd(bool withHz=true) const;
        QString format(bool withHz=true) const;
};


class VInterpolation : public QObject, public VBandsInterface
{
        Q_OBJECT
        struct Private;
        Private *d;
        friend class VBand;

public:
        VInterpolation(int bands);
        virtual ~VInterpolation();

        virtual int bands() const;
        virtual VBand band(int num);
        virtual int level(int index) const;
        virtual void setLevel(int index, int level);

signals:
        void changed();

private:
        void refresh();
        void getFrequencies(int num, int *high, int *low) const;
        double onSpline(int bandNum) const;
};

class VPreset;

class VEqualizer : public QObject, public VBandsInterface
{
        Q_OBJECT
        friend class VBand;
        friend class VPreset;
        friend class Engine;
        friend class NoatunApp;
        friend class VInterpolation;

        struct Private;
        Private *d;

        VEqualizer();
        ~VEqualizer();
        void init();

public:

        static QValueList<int> frequencies(int num);

        int bands() const;

        static int start();
        static int end();

        int maxBands() const;

        int minBands() const;

        VBand band(int num);

        bool isEnabled() const;

        int preamp() const;

public: // serialization
        bool save(const KURL &file, const QString &friendly) const;

        bool load(const KURL &file);

        QString toString(const QString &name="stored") const;

        bool fromString(const QString &str);

public: // presets
        VPreset createPreset(const QString &name, bool smart=true);

        QValueList<VPreset> presets() const;

        VPreset presetByName(const QString &name);

        VPreset presetByFile(const QString &file);

        bool presetExists(const QString &name) const;

signals:
        void changedBands();

        void changed();
        void modified();

        void preampChanged();
        void preampChanged(int);

        void enabled();
        void disabled();

        void enabled(bool e);

        void created(VPreset preset);

        void selected(VPreset preset);

        void renamed(VPreset preset);

        void removed(VPreset preset);
public slots:
        void setPreamp(int p);
        void enable();
        void disable();
        void setEnabled(bool e);
        void setBands(int bands);
        void setBands(int bands, bool interpolate);

private:
        virtual int level(int index) const;
        virtual void setLevel(int index, int level);
        void setLevels(const QValueList<int> &levels);

private:
        void update(bool full=false);
};

class VPreset
{
        friend class VEqualizer;

        struct Private;
        Private *d;

        void *_bc;
        VPreset(const QString &file);
public:
        VPreset();
        VPreset(const VPreset &copy);
        VPreset & operator=(const VPreset &copy);
        ~VPreset();
        bool operator ==(const VPreset &other) const;

        QString name() const;
        bool setName(const QString &name);

        QString file() const;

        bool isValid() const;
        bool isNull() const { return !isValid(); }
        operator bool() const { return isValid(); }

        void save();

        void load() const;

        void remove();
};

#endif

This file is part of the documentation for Noatun 2.6.0.

Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 23:49:45 2004 by doxygen 1.3.8-20040913 written by Dimitri van Heesch, © 1997-2003