src/3rdparty/phonon/mmf/audioequalizer.h
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 23:40:16 +0200
branchRCL_3
changeset 4 3b1da2848fc7
parent 0 1918ee327afb
permissions -rw-r--r--
Revision: 201003 Kit: 201007

/*  This file is part of the KDE project.

Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

This library is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 2.1 or 3 of the License.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef PHONON_MMF_AUDIOEQUALIZER_H
#define PHONON_MMF_AUDIOEQUALIZER_H

#include "abstractaudioeffect.h"

class CAudioEqualizer;

QT_BEGIN_NAMESPACE

namespace Phonon
{
namespace MMF
{
/**
 * @short A classic equalizer.
 *
 * The equalizer has a number of bands, and each band has a frequency, and a
 * volume. With Phonon's API, this is modeled such that each band is one
 * Phonon::EffectParameter, where Phonon::EffectParameter::id() is the band
 * number, and the setting is the volume level.
 */
class AudioEqualizer : public AbstractAudioEffect
{
    Q_OBJECT
public:
    AudioEqualizer(QObject *parent, const QList<EffectParameter> &parameters);

    // Static interface required by EffectFactory
    static const char* description();
    static bool getParameters(CMdaAudioOutputStream *stream,
        QList<EffectParameter>& parameters);

protected:
    // AbstractAudioEffect
    virtual void createEffect(AudioPlayer::NativePlayer *player);
    virtual int effectParameterChanged(const EffectParameter &param,
                                       const QVariant &value);

private:
    CAudioEqualizer *concreteEffect();

};
}
}

QT_END_NAMESPACE

#endif