src/qmmp/effect.h



2a9a78ddd
3a9f8bcb3
41c8a60a2
2a9a78ddd


a8bf072ec
2a9a78ddd


2a9a78ddd

76c9d2a12
76f436c36
435f1da1d
90ba1eae5
2a9a78ddd
6d45a1621
ac579e12d

41c8a60a2
4161760f0
998118b15
2a9a78ddd
2a9a78ddd
ac579e12d

ac579e12d
648d09c5c
ac579e12d


2a9a78ddd
ac579e12d
435f1da1d
2a9a78ddd

435f1da1d
ac579e12d
1f0e403c9
ac579e12d
196ec0a9a
76f436c36
ac579e12d
260e607f9
2a9a78ddd
0e860ae0b
2a9a78ddd
76f436c36
2a9a78ddd
1f0e403c9
2a9a78ddd
76f436c36


2a9a78ddd
196ec0a9a

76c9d2a12
196ec0a9a


76c9d2a12
ac579e12d
fce26b0f1

ac579e12d
fce26b0f1
ac579e12d


6d45a1621


ac579e12d
cfe1ebf0f

ac579e12d
e3c013c70
ac579e12d


683a9a9f7
ac579e12d
e3c013c70
ac579e12d
683a9a9f7
ac579e12d

e3c013c70
fc595e1a3


b3463bee9

2a9a78ddd
76c9d2a12
07ae1ec8c
76f436c36

6d45a1621


2a9a78ddd


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

                                                                            
/***************************************************************************
 *   Copyright (C) 2007-2020 by Ilya Kotov                                 *
 *   forkotov02@ya.ru                                                      *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
 ***************************************************************************/
#ifndef EFFECT_H
#define EFFECT_H

#include <QList>
#include <QStringList>
#include "audioparameters.h"
#include "channelmap.h"
#include "buffer.h"
#include "effectfactory.h"

class QmmpPluginCache;

/*! @brief The Effect class provides the base interface class of audio effects.
 * @author Ilya Kotov <forkotov02@ya.ru>
 */
class QMMP_EXPORT Effect
{
public:
    /*!
     * Object contsructor.
     */
    Effect();
    /*!
     * Destructor.
     */
    virtual ~Effect();
    /*!
     * Adds audio effect to the buffer \b b.
     * Subclass should implement this function.
     */
    virtual void applyEffect(Buffer *b) = 0;
    /*!
     * Prepares object for usage.
     * Subclasses that reimplement this function must call the base implementation.
     * @param srate Sample rate.
     * @param map Map of channels.
     */
    virtual void configure(quint32 srate, ChannelMap map);
    /*!
     * Returns samplerate.
     */
    quint32 sampleRate() const;
    /*!
     * Returns channels number.
     */
    int channels() const;
    /*!
     * Returns map of channels
     */
     const ChannelMap channelMap() const;
    /*!
     * Returns audio parameters for output data.
     */
    const AudioParameters audioParameters() const;
    /*!
     * Returns assigned factory object.
     */
    EffectFactory* factory() const;
    /*!
     * Creates effect object from \b factory. Returns effect objects if factory is enabled,
     * otherwise returns \b 0.
     */
    static Effect* create(EffectFactory *factory);
    /*!
     * Returns a list of effect factories.
     */
    static QList<EffectFactory*> factories();
    /*!
     * Returns a list of enabled effect factories.
     */
    static QList<EffectFactory*> enabledFactories();
    /*!
     * Returns plugin file path.
     * @param factory Effect plugin factory.
     */
    static QString file(const EffectFactory *factory);
    /*!
     * Sets whether the effect plugin is enabled.
     * @param factory Effect plugin factory.
     * @param enable Plugin enable state (\b true - enable, \b false - disable)
     */