/usr/include/qmmp/effect.h is in libqmmp-dev 0.7.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /***************************************************************************
* Copyright (C) 2007-2009 by Ilya Kotov *
* forkotov02@hotmail.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 <QHash>
#include "audioparameters.h"
#include "buffer.h"
class EffectFactory;
/*! @brief The Effect class provides the base interface class of audio effects.
* @author Ilya Kotov <forkotov02@hotmail.ru>
*/
class 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 chan Number of channels.
* @param f Audio format.
*/
virtual void configure(quint32 srate = 44100, int chan = 2, Qmmp::AudioFormat f = Qmmp::PCM_S16LE);
/*!
* Returns samplerate.
*/
quint32 sampleRate();
/*!
* Returns channels number.
*/
int channels();
/*!
* Returns audio format.
*/
Qmmp::AudioFormat format();
/*!
* 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 plugin file path.
* @param factory Effect plugin factory.
*/
static QString file(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)
*/
static void setEnabled(EffectFactory* factory, bool enable = true);
/*!
* Returns \b true if input plugin is enabled, otherwise returns \b false
* @param factory Effect plugin factory.
*/
static bool isEnabled(EffectFactory* factory);
private:
EffectFactory *m_factory;
quint32 m_freq;
int m_chan;
Qmmp::AudioFormat m_format;
static void checkFactories();
static QList<EffectFactory*> *m_factories;
static QHash <EffectFactory*, QString> *m_files;
};
#endif
|