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
|
/***************************************************************************
* Copyright (C) 2008-2021 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 VISUAL_H
#define VISUAL_H
#include <QMutex>
#include <QStringList>
#include <QWidget>
#include <QHash>
#include <stddef.h>
#include "qmmp_export.h"
#define QMMP_VISUAL_NODE_SIZE 512 //samples
class VisualFactory;
class VisualBuffer;
/*! @brief The Visual class provides the base interface class of visualizations.
* @author Ilya Kotov <forkotov02@ya.ru>
*/
class QMMP_EXPORT Visual : public QWidget
{
Q_OBJECT
public:
/*!
* Object contsructor.
* @param parent Parent object.
* @param f Widget flags.
*/
Visual(QWidget *parent, Qt::WindowFlags f = Qt::WindowFlags());
/*!
* Destructor.
*/
virtual ~Visual();
/*!
* Returns a list of visual factories.
*/
static QList<VisualFactory*> factories();
/*!
* Returns plugin file path.
* @param factory Visual plugin factory.
*/
static QString file(const VisualFactory *factory);
/*!
* Sets whether the visual plugin is enabled.
* @param factory Visual plugin factory.
* @param enable Plugin enable state (\b true - enable, \b false - disable)
*/
static void setEnabled(VisualFactory *factory, bool enable = true);
/*!
* Returns \b true if visual plugin is enabled, otherwise returns \b false
* @param factory Effect plugin factory.
*/
static bool isEnabled(const VisualFactory *factory);
/*!
* Adds external visualization \b visual.
*/
static void add(Visual*visual);
/*!
* Removes external visualization \b visual.
*/
static void remove(Visual*);
/*!
* Prepares visual plugins for usage.
* @param parent Parent widget.
* @param receiver Receiver object.
* @param member A slot to receive changes of active visualizations list.
*/
static void initialize(QWidget *parent, QObject *receiver = nullptr, const char *member = nullptr);
/*!
* Returns a pointer to a list of created visual objects.
*/
static QList<Visual *> *visuals();
/*!
* Shows configuration dialog and updates settings automatically.
* @param factory Visual plugin factory.
* @param parent Parent widget.
*/
static void showSettings(VisualFactory *factory, QWidget *parent);
/*!
* Adds data for visualization.
* @param pcm Audio data.
* @param samples Number of samples.
* @param channels Number of channels.
* @param ts Elapsed time (in milliseconds).
* @param delay Audio output delay.
*/
static void addAudio(float *pcm, int samples, int channels, qint64 ts, qint64 delay);
/*!
* Clears visualization buffer.
*/
static void clearBuffer();
public slots:
/*!
* Starts visualization. Default implementation does nothing.
*/
virtual void start();
/*!
* Stops visualization. Default implementation does nothing.
*/
virtual void stop();
signals:
/*!
* Emitted when visual widget is closed by user.
*/
void closedByUser();
protected:
/*!
* QWidget's close event. Reimplementation should call base function.
* @param event QCloseEvent insatance.
*/
virtual void closeEvent (QCloseEvent *event) override;
/*!
* Takes visualization data. Caller should allocate \b QMMP_VISUAL_NODE_SIZE
* bytes for each channel. If buffer for right channel is not specified,
* this function will average data from left and right channels.
* @param left Left channel buffer.
* @param right Right channel buffer.
*/
bool takeData(float *left, float *right = nullptr);
private:
static QList<VisualFactory*> *m_factories;
static QHash <const VisualFactory*, QString> *m_files;
static void checkFactories();
static QList<Visual*> m_visuals;
static QHash<VisualFactory*, Visual*> m_vis_map; //internal visualization
static QWidget *m_parentWidget;
static QObject *m_receiver;
static const char *m_member;
static VisualBuffer m_buffer;
};
#endif
|
