The Visual class provides the base interface class of visualizations. More...

#include <visual.h>

Inheritance diagram for Visual:

Public Slots
virtual void	start ()

virtual void	stop ()

void	updateVisual ()

void	changeFullScreen (bool state)

Signals
void	closedByUser ()

void	fullscreenByUser (QWidget *widget, bool state)

Public Member Functions
	Visual (QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())

virtual	~Visual ()

Static Public Member Functions
static QList< VisualFactory * >	factories ()

static QString	file (const VisualFactory *factory)

static void	setEnabled (VisualFactory *factory, bool enable=true)

static bool	isEnabled (const VisualFactory *factory)

static void	add (Visual *visual)

static void	remove (Visual *)

static void	initialize (QWidget parent, QObject receiver=nullptr, const char *member=nullptr)

static QList< Visual * > *	visuals ()

static void	addAudio (float *pcm, int samples, int channels, qint64 ts, qint64 delay)

static void	clearBuffer ()

Protected Member Functions
virtual void	showEvent (QShowEvent *event) override

virtual void	hideEvent (QHideEvent *event) override

virtual void	closeEvent (QCloseEvent *event) overridefinal

bool	takeData (float left, float right=nullptr)

virtual void	processData (float left, float right)=0

virtual void	processState (bool v)

void	clear ()

Protected Attributes
QTimer *	m_timer = nullptr

bool	m_running = false

int	m_rows = 0

int	m_cols = 0

int *	m_visualData = nullptr

QAction *	m_screenAction = nullptr

Static Private Member Functions
static void	checkFactories ()

static void	createVisualization (VisualFactory factory, QWidget parent)

Static Private Attributes
static QList< VisualFactory * > *	m_factories

static QHash< const VisualFactory , QString >	m_files

static QList< Visual * >	m_visuals

static QHash< VisualFactory , Visual >	m_visualMap

static QWidget *	m_parentClass

static QObject *	m_receiver

static const char *	m_member

static VisualBuffer	m_buffer

Detailed Description

The Visual class provides the base interface class of visualizations.

Author: Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Definition at line 37 of file visual.h.

Constructor & Destructor Documentation

Visual::Visual	(	QWidget *	parent,
		Qt::WindowFlags	f = `Qt::WindowFlags()`
	)

explicit

Object contsructor.

Parameters

parent	Parent object.
f	Widget flags.

virtual Visual::~Visual ( )

virtual

Destructor.

Member Function Documentation

static void Visual::add ( Visual * visual )

static

Adds external visualization visual.

static void Visual::addAudio	(	float *	pcm,
		int	samples,
		int	channels,
		qint64	ts,
		qint64	delay
	)

static

Adds data for visualization.

Parameters

pcm	Audio data.
samples	Number of samples.
channels	Number of channels.
ts	Elapsed time (in milliseconds).
delay	Audio output delay.

void Visual::changeFullScreen ( bool state )

slot

Menu fullscreen changed.

static void Visual::checkFactories ( )

staticprivate

void Visual::clear ( )

protected

Clear current visual data.

static void Visual::clearBuffer ( )

static

Clears visualization buffer.

void Visual::closedByUser ( )

signal

Emitted when visual widget is closed by user.

virtual void Visual::closeEvent ( QCloseEvent * event )

finaloverrideprotectedvirtual

QWidget's close event. Reimplementation should call base function.

Parameters

event QCloseEvent instance.

static void Visual::createVisualization	(	VisualFactory *	factory,
		QWidget *	parent
	)

staticprivate

static QList<VisualFactory*> Visual::factories ( )

static

Returns a list of visual factories.

Referenced by TTK::TTKQmmp::enabledVisualPlugin(), and MusicQmmpPluginWidget::loadPluginsInfo().

static QString Visual::file ( const VisualFactory * factory )

static

Returns plugin file path.

Parameters

factory Visual plugin factory.

Referenced by MusicQmmpPluginWidget::loadPluginsInfo().

void Visual::fullscreenByUser	(	QWidget *	widget,
		bool	state
	)

signal

Emitted when visual widget is show fullscreen by user.

virtual void Visual::hideEvent ( QHideEvent * event )

overrideprotectedvirtual

QWidget's close event. Reimplementation should call base function.

Parameters

event QCloseEvent insatance.

Reimplemented in Florid.

static void Visual::initialize	(	QWidget *	parent,
		QObject *	receiver = `nullptr`,
		const char *	member = `nullptr`
	)

static

Prepares visual plugins for usage.

Parameters

parent	Parent widget.
receiver	Receiver object.
member	A slot to receive changes of active visualizations list.

Referenced by MusicTopAreaWidget::MusicTopAreaWidget().

static bool Visual::isEnabled ( const VisualFactory * factory )

static

Returns true if visual plugin is enabled, otherwise returns false

Parameters

factory Effect plugin factory.

Referenced by MusicQmmpPluginItem::MusicQmmpPluginItem().

virtual void Visual::processData	(	float *	left,
		float *	right
	)

protectedpure virtual

Process current visual data.

virtual void Visual::processState ( bool v )

protectedvirtual

Process current visual data by state.

Reimplemented in Florid.

static void Visual::remove ( Visual * )

static

Removes external visualization visual.

static void Visual::setEnabled	(	VisualFactory *	factory,
		bool	enable = `true`
	)

static

Sets whether the visual plugin is enabled.

Parameters

factory	Visual plugin factory.
enable	Plugin enable state (true - enable, false - disable)

Referenced by TTK::TTKQmmp::enabledVisualPlugin().

virtual void Visual::showEvent ( QShowEvent * event )

overrideprotectedvirtual

QWidget's close event. Reimplementation should call base function.

Parameters

event QCloseEvent insatance.

Reimplemented in Florid.

virtual void Visual::start ( )

virtualslot

Starts visualization.

Referenced by MusicBlurSpecturmModule::update().

virtual void Visual::stop ( )

virtualslot

Stops visualization.

bool Visual::takeData	(	float *	left,
		float *	right = `nullptr`
	)

protected

Takes visualization data. Caller should allocate QMMP_VISUAL_NODE_SIZE samples for each channel. If buffer for right channel is not specified, this function will average data from left and right channels.

Parameters

left	Left channel buffer.
right	Right channel buffer.

void Visual::updateVisual ( )

slot

Update current visual data.

static QList<Visual *>* Visual::visuals ( )

static

Returns a pointer to a list of created visual objects.

Referenced by MusicSpectrumWidget::createModuleWidget(), MusicSpectrumWidget::createSpectrumWidget(), MusicRemoteWidgetForRipple::createVisualWidget(), and MusicBlurSpecturmModule::show().

Member Data Documentation

VisualBuffer Visual::m_buffer

staticprivate

Definition at line 188 of file visual.h.

int Visual::m_cols = 0

protected

Definition at line 173 of file visual.h.

QList<VisualFactory*>* Visual::m_factories

staticprivate

Definition at line 181 of file visual.h.

QHash<const VisualFactory*, QString>* Visual::m_files

staticprivate

Definition at line 182 of file visual.h.

const char* Visual::m_member

staticprivate

Definition at line 187 of file visual.h.

QWidget* Visual::m_parentClass

staticprivate

Definition at line 185 of file visual.h.

QObject* Visual::m_receiver

staticprivate

Definition at line 186 of file visual.h.

int Visual::m_rows = 0

protected

Definition at line 173 of file visual.h.

bool Visual::m_running = false

protected

Definition at line 172 of file visual.h.

QAction* Visual::m_screenAction = nullptr

protected

Definition at line 175 of file visual.h.

QTimer* Visual::m_timer = nullptr

protected

Definition at line 171 of file visual.h.

int* Visual::m_visualData = nullptr

protected

Definition at line 174 of file visual.h.

QHash<VisualFactory*, Visual*> Visual::m_visualMap

staticprivate

Definition at line 184 of file visual.h.

QList<Visual*> Visual::m_visuals

staticprivate

Definition at line 183 of file visual.h.

The documentation for this class was generated from the following file:

TTKThirdParty/TTKqmmp/qmmp/visual.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation