summaryrefslogtreecommitdiffstats
path: root/src/3rdparty/phonon/mmf/effectfactory.cpp
blob: c5e33d5c7a4a9aa3346357b87dbb99377650a888 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*  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/>.

*/

#include <QObject>
#include <QCoreApplication>

#include <mdaaudiooutputstream.h>

#include "audioequalizer.h"
#include "bassboost.h"
#include "environmentalreverb.h"
#include "loudness.h"
#include "stereowidening.h"

#include "effectfactory.h"

QT_BEGIN_NAMESPACE

using namespace Phonon;
using namespace Phonon::MMF;

/*! \class MMF::EffectFactory
  \internal
*/

EffectFactory::EffectFactory(QObject *parent)
    :   QObject(parent)
    ,   m_initialized(false)
{

}

EffectFactory::~EffectFactory()
{

}

//-----------------------------------------------------------------------------
// Public functions
//-----------------------------------------------------------------------------

AbstractAudioEffect *EffectFactory::createAudioEffect(Type type,
                                                      QObject *parent)
{
    // Lazily initialize
    if (!m_initialized)
        initialize();

    Q_ASSERT(parent);

    const QList<EffectParameter>& parameters = data(type).m_parameters;

    AbstractAudioEffect *effect = 0;

    switch (type)
    {
    case TypeBassBoost:
        effect = new BassBoost(parent, parameters);
        break;
    case TypeAudioEqualizer:
        effect = new AudioEqualizer(parent, parameters);
        break;
    case TypeEnvironmentalReverb:
        effect = new EnvironmentalReverb(parent, parameters);
        break;
    case TypeLoudness:
        effect = new Loudness(parent, parameters);
        break;
    case TypeStereoWidening:
        effect = new StereoWidening(parent, parameters);
        break;

    // Not implemented
    case TypeDistanceAttenuation:
    case TypeListenerOrientation:
    case TypeSourceOrientation:
    // Fall through
    default:
        Q_ASSERT_X(false, Q_FUNC_INFO, "Unknown effect");
    }

    return effect;
}

QHash<QByteArray, QVariant> EffectFactory::audioEffectDescriptions(Type type)
{
    // Lazily initialize
    if (!m_initialized)
        initialize();

    return data(type).m_descriptions;
}

QList<int> EffectFactory::effectIndexes()
{
    // Lazily initialize
    if (!m_initialized)
        initialize();

    QList<int> result;

    QHash<Type, EffectData>::const_iterator i = m_effectData.begin();
    for ( ; i != m_effectData.end(); ++i)
        if (i.value().m_supported)
            result.append(i.key());

    return result;
}

//-----------------------------------------------------------------------------
// Private functions
//-----------------------------------------------------------------------------

#define INITIALIZE_EFFECT(Effect) \
    { \
    EffectData data = getData<Effect>(); \
    m_effectData.insert(Type##Effect, data); \
    }

void EffectFactory::initialize()
{
    Q_ASSERT_X(!m_initialized, Q_FUNC_INFO, "Already initialized");

    INITIALIZE_EFFECT(AudioEqualizer)
    INITIALIZE_EFFECT(BassBoost)
    INITIALIZE_EFFECT(EnvironmentalReverb)
    INITIALIZE_EFFECT(Loudness)
    INITIALIZE_EFFECT(StereoWidening)

    m_initialized = true;
}

// This class is just a wrapper which allows us to instantiate a
// CMdaAudioOutputStream object.  This is done in order to allow the
// effects API to query the DevSound implementation, to discover
// which effects are supported and what parameters they take.
// Ideally, we would use CMMFDevSound directly, but this class is not
// available in the public S60 SDK.
class OutputStreamFactory : public MMdaAudioOutputStreamCallback
{
public:
    CMdaAudioOutputStream* create()
    {
        CMdaAudioOutputStream* stream = 0;
        QT_TRAP_THROWING(stream = CMdaAudioOutputStream::NewL(*this));
        return stream;
    }
private:
    void MaoscOpenComplete(TInt /*aError*/) { }
    void MaoscBufferCopied(TInt /*aError*/, const TDesC8& /*aBuffer*/) { }
    void MaoscPlayComplete(TInt /*aError*/) { }
};

template<typename BackendNode>
EffectFactory::EffectData EffectFactory::getData()
{
    EffectData data;

    // Create a temporary CMdaAudioOutputStream object, so that the effects
    // API can query DevSound to discover which effects are supported.
    OutputStreamFactory streamFactory;
    QScopedPointer<CMdaAudioOutputStream> stream(streamFactory.create());

    EffectParameter param(
         /* parameterId */        AbstractAudioEffect::ParameterEnable,
         /* name */               tr("Enabled"),
         /* hints */              EffectParameter::ToggledHint,
         /* defaultValue */       QVariant(bool(true)));
    data.m_parameters.append(param);

    if (data.m_supported = BackendNode::getParameters
            (stream.data(), data.m_parameters)) {
        const QString description = QCoreApplication::translate
            ("Phonon::MMF::EffectFactory", BackendNode::description());
        data.m_descriptions.insert("name", description);
        data.m_descriptions.insert("description", description);
        data.m_descriptions.insert("available", true);
    }

    // Sanity check to ensure that all parameter IDs are unique
    QSet<int> ids;
    foreach (param, data.m_parameters) {
        Q_ASSERT_X(ids.find(param.id()) == ids.end(), Q_FUNC_INFO,
            "Parameter list contains duplicates");
        ids.insert(param.id());
    }

    return data;
}

const EffectFactory::EffectData& EffectFactory::data(Type type) const
{
    QHash<Type, EffectData>::const_iterator i = m_effectData.find(type);
    Q_ASSERT_X(i != m_effectData.end(), Q_FUNC_INFO, "Effect data not found");
    return i.value();
}

QT_END_NAMESPACE